linux/include/net/cfg80211.h
<<
>>
Prefs
   1#ifndef __NET_CFG80211_H
   2#define __NET_CFG80211_H
   3/*
   4 * 802.11 device and configuration interface
   5 *
   6 * Copyright 2006-2010  Johannes Berg <johannes@sipsolutions.net>
   7 * Copyright 2013-2014 Intel Mobile Communications GmbH
   8 * Copyright 2015       Intel Deutschland GmbH
   9 *
  10 * This program is free software; you can redistribute it and/or modify
  11 * it under the terms of the GNU General Public License version 2 as
  12 * published by the Free Software Foundation.
  13 */
  14
  15#include <linux/netdevice.h>
  16#include <linux/debugfs.h>
  17#include <linux/list.h>
  18#include <linux/bug.h>
  19#include <linux/netlink.h>
  20#include <linux/skbuff.h>
  21#include <linux/nl80211.h>
  22#include <linux/if_ether.h>
  23#include <linux/ieee80211.h>
  24#include <linux/net.h>
  25#include <net/regulatory.h>
  26
  27/**
  28 * DOC: Introduction
  29 *
  30 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
  31 * userspace and drivers, and offers some utility functionality associated
  32 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
  33 * by all modern wireless drivers in Linux, so that they offer a consistent
  34 * API through nl80211. For backward compatibility, cfg80211 also offers
  35 * wireless extensions to userspace, but hides them from drivers completely.
  36 *
  37 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
  38 * use restrictions.
  39 */
  40
  41
  42/**
  43 * DOC: Device registration
  44 *
  45 * In order for a driver to use cfg80211, it must register the hardware device
  46 * with cfg80211. This happens through a number of hardware capability structs
  47 * described below.
  48 *
  49 * The fundamental structure for each device is the 'wiphy', of which each
  50 * instance describes a physical wireless device connected to the system. Each
  51 * such wiphy can have zero, one, or many virtual interfaces associated with
  52 * it, which need to be identified as such by pointing the network interface's
  53 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
  54 * the wireless part of the interface, normally this struct is embedded in the
  55 * network interface's private data area. Drivers can optionally allow creating
  56 * or destroying virtual interfaces on the fly, but without at least one or the
  57 * ability to create some the wireless device isn't useful.
  58 *
  59 * Each wiphy structure contains device capability information, and also has
  60 * a pointer to the various operations the driver offers. The definitions and
  61 * structures here describe these capabilities in detail.
  62 */
  63
  64struct wiphy;
  65
  66/*
  67 * wireless hardware capability structures
  68 */
  69
  70/**
  71 * enum ieee80211_band - supported frequency bands
  72 *
  73 * The bands are assigned this way because the supported
  74 * bitrates differ in these bands.
  75 *
  76 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
  77 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
  78 * @IEEE80211_BAND_60GHZ: around 60 GHz band (58.32 - 64.80 GHz)
  79 * @IEEE80211_NUM_BANDS: number of defined bands
  80 */
  81enum ieee80211_band {
  82        IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
  83        IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
  84        IEEE80211_BAND_60GHZ = NL80211_BAND_60GHZ,
  85
  86        /* keep last */
  87        IEEE80211_NUM_BANDS
  88};
  89
  90/**
  91 * enum ieee80211_channel_flags - channel flags
  92 *
  93 * Channel flags set by the regulatory control code.
  94 *
  95 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
  96 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
  97 *      sending probe requests or beaconing.
  98 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
  99 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
 100 *      is not permitted.
 101 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
 102 *      is not permitted.
 103 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
 104 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
 105 *      this flag indicates that an 80 MHz channel cannot use this
 106 *      channel as the control or any of the secondary channels.
 107 *      This may be due to the driver or due to regulatory bandwidth
 108 *      restrictions.
 109 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
 110 *      this flag indicates that an 160 MHz channel cannot use this
 111 *      channel as the control or any of the secondary channels.
 112 *      This may be due to the driver or due to regulatory bandwidth
 113 *      restrictions.
 114 * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
 115 * @IEEE80211_CHAN_IR_CONCURRENT: see %NL80211_FREQUENCY_ATTR_IR_CONCURRENT
 116 * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
 117 *      on this channel.
 118 * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
 119 *      on this channel.
 120 *
 121 */
 122enum ieee80211_channel_flags {
 123        IEEE80211_CHAN_DISABLED         = 1<<0,
 124        IEEE80211_CHAN_NO_IR            = 1<<1,
 125        /* hole at 1<<2 */
 126        IEEE80211_CHAN_RADAR            = 1<<3,
 127        IEEE80211_CHAN_NO_HT40PLUS      = 1<<4,
 128        IEEE80211_CHAN_NO_HT40MINUS     = 1<<5,
 129        IEEE80211_CHAN_NO_OFDM          = 1<<6,
 130        IEEE80211_CHAN_NO_80MHZ         = 1<<7,
 131        IEEE80211_CHAN_NO_160MHZ        = 1<<8,
 132        IEEE80211_CHAN_INDOOR_ONLY      = 1<<9,
 133        IEEE80211_CHAN_IR_CONCURRENT    = 1<<10,
 134        IEEE80211_CHAN_NO_20MHZ         = 1<<11,
 135        IEEE80211_CHAN_NO_10MHZ         = 1<<12,
 136};
 137
 138#define IEEE80211_CHAN_NO_HT40 \
 139        (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
 140
 141#define IEEE80211_DFS_MIN_CAC_TIME_MS           60000
 142#define IEEE80211_DFS_MIN_NOP_TIME_MS           (30 * 60 * 1000)
 143
 144/**
 145 * struct ieee80211_channel - channel definition
 146 *
 147 * This structure describes a single channel for use
 148 * with cfg80211.
 149 *
 150 * @center_freq: center frequency in MHz
 151 * @hw_value: hardware-specific value for the channel
 152 * @flags: channel flags from &enum ieee80211_channel_flags.
 153 * @orig_flags: channel flags at registration time, used by regulatory
 154 *      code to support devices with additional restrictions
 155 * @band: band this channel belongs to.
 156 * @max_antenna_gain: maximum antenna gain in dBi
 157 * @max_power: maximum transmission power (in dBm)
 158 * @max_reg_power: maximum regulatory transmission power (in dBm)
 159 * @beacon_found: helper to regulatory code to indicate when a beacon
 160 *      has been found on this channel. Use regulatory_hint_found_beacon()
 161 *      to enable this, this is useful only on 5 GHz band.
 162 * @orig_mag: internal use
 163 * @orig_mpwr: internal use
 164 * @dfs_state: current state of this channel. Only relevant if radar is required
 165 *      on this channel.
 166 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
 167 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
 168 */
 169struct ieee80211_channel {
 170        enum ieee80211_band band;
 171        u16 center_freq;
 172        u16 hw_value;
 173        u32 flags;
 174        int max_antenna_gain;
 175        int max_power;
 176        int max_reg_power;
 177        bool beacon_found;
 178        u32 orig_flags;
 179        int orig_mag, orig_mpwr;
 180        enum nl80211_dfs_state dfs_state;
 181        unsigned long dfs_state_entered;
 182        unsigned int dfs_cac_ms;
 183};
 184
 185/**
 186 * enum ieee80211_rate_flags - rate flags
 187 *
 188 * Hardware/specification flags for rates. These are structured
 189 * in a way that allows using the same bitrate structure for
 190 * different bands/PHY modes.
 191 *
 192 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
 193 *      preamble on this bitrate; only relevant in 2.4GHz band and
 194 *      with CCK rates.
 195 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
 196 *      when used with 802.11a (on the 5 GHz band); filled by the
 197 *      core code when registering the wiphy.
 198 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
 199 *      when used with 802.11b (on the 2.4 GHz band); filled by the
 200 *      core code when registering the wiphy.
 201 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
 202 *      when used with 802.11g (on the 2.4 GHz band); filled by the
 203 *      core code when registering the wiphy.
 204 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
 205 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
 206 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
 207 */
 208enum ieee80211_rate_flags {
 209        IEEE80211_RATE_SHORT_PREAMBLE   = 1<<0,
 210        IEEE80211_RATE_MANDATORY_A      = 1<<1,
 211        IEEE80211_RATE_MANDATORY_B      = 1<<2,
 212        IEEE80211_RATE_MANDATORY_G      = 1<<3,
 213        IEEE80211_RATE_ERP_G            = 1<<4,
 214        IEEE80211_RATE_SUPPORTS_5MHZ    = 1<<5,
 215        IEEE80211_RATE_SUPPORTS_10MHZ   = 1<<6,
 216};
 217
 218/**
 219 * enum ieee80211_bss_type - BSS type filter
 220 *
 221 * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
 222 * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
 223 * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
 224 * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
 225 * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
 226 */
 227enum ieee80211_bss_type {
 228        IEEE80211_BSS_TYPE_ESS,
 229        IEEE80211_BSS_TYPE_PBSS,
 230        IEEE80211_BSS_TYPE_IBSS,
 231        IEEE80211_BSS_TYPE_MBSS,
 232        IEEE80211_BSS_TYPE_ANY
 233};
 234
 235/**
 236 * enum ieee80211_privacy - BSS privacy filter
 237 *
 238 * @IEEE80211_PRIVACY_ON: privacy bit set
 239 * @IEEE80211_PRIVACY_OFF: privacy bit clear
 240 * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
 241 */
 242enum ieee80211_privacy {
 243        IEEE80211_PRIVACY_ON,
 244        IEEE80211_PRIVACY_OFF,
 245        IEEE80211_PRIVACY_ANY
 246};
 247
 248#define IEEE80211_PRIVACY(x)    \
 249        ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
 250
 251/**
 252 * struct ieee80211_rate - bitrate definition
 253 *
 254 * This structure describes a bitrate that an 802.11 PHY can
 255 * operate with. The two values @hw_value and @hw_value_short
 256 * are only for driver use when pointers to this structure are
 257 * passed around.
 258 *
 259 * @flags: rate-specific flags
 260 * @bitrate: bitrate in units of 100 Kbps
 261 * @hw_value: driver/hardware value for this rate
 262 * @hw_value_short: driver/hardware value for this rate when
 263 *      short preamble is used
 264 */
 265struct ieee80211_rate {
 266        u32 flags;
 267        u16 bitrate;
 268        u16 hw_value, hw_value_short;
 269};
 270
 271/**
 272 * struct ieee80211_sta_ht_cap - STA's HT capabilities
 273 *
 274 * This structure describes most essential parameters needed
 275 * to describe 802.11n HT capabilities for an STA.
 276 *
 277 * @ht_supported: is HT supported by the STA
 278 * @cap: HT capabilities map as described in 802.11n spec
 279 * @ampdu_factor: Maximum A-MPDU length factor
 280 * @ampdu_density: Minimum A-MPDU spacing
 281 * @mcs: Supported MCS rates
 282 */
 283struct ieee80211_sta_ht_cap {
 284        u16 cap; /* use IEEE80211_HT_CAP_ */
 285        bool ht_supported;
 286        u8 ampdu_factor;
 287        u8 ampdu_density;
 288        struct ieee80211_mcs_info mcs;
 289};
 290
 291/**
 292 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
 293 *
 294 * This structure describes most essential parameters needed
 295 * to describe 802.11ac VHT capabilities for an STA.
 296 *
 297 * @vht_supported: is VHT supported by the STA
 298 * @cap: VHT capabilities map as described in 802.11ac spec
 299 * @vht_mcs: Supported VHT MCS rates
 300 */
 301struct ieee80211_sta_vht_cap {
 302        bool vht_supported;
 303        u32 cap; /* use IEEE80211_VHT_CAP_ */
 304        struct ieee80211_vht_mcs_info vht_mcs;
 305};
 306
 307/**
 308 * struct ieee80211_supported_band - frequency band definition
 309 *
 310 * This structure describes a frequency band a wiphy
 311 * is able to operate in.
 312 *
 313 * @channels: Array of channels the hardware can operate in
 314 *      in this band.
 315 * @band: the band this structure represents
 316 * @n_channels: Number of channels in @channels
 317 * @bitrates: Array of bitrates the hardware can operate with
 318 *      in this band. Must be sorted to give a valid "supported
 319 *      rates" IE, i.e. CCK rates first, then OFDM.
 320 * @n_bitrates: Number of bitrates in @bitrates
 321 * @ht_cap: HT capabilities in this band
 322 * @vht_cap: VHT capabilities in this band
 323 */
 324struct ieee80211_supported_band {
 325        struct ieee80211_channel *channels;
 326        struct ieee80211_rate *bitrates;
 327        enum ieee80211_band band;
 328        int n_channels;
 329        int n_bitrates;
 330        struct ieee80211_sta_ht_cap ht_cap;
 331        struct ieee80211_sta_vht_cap vht_cap;
 332};
 333
 334/*
 335 * Wireless hardware/device configuration structures and methods
 336 */
 337
 338/**
 339 * DOC: Actions and configuration
 340 *
 341 * Each wireless device and each virtual interface offer a set of configuration
 342 * operations and other actions that are invoked by userspace. Each of these
 343 * actions is described in the operations structure, and the parameters these
 344 * operations use are described separately.
 345 *
 346 * Additionally, some operations are asynchronous and expect to get status
 347 * information via some functions that drivers need to call.
 348 *
 349 * Scanning and BSS list handling with its associated functionality is described
 350 * in a separate chapter.
 351 */
 352
 353/**
 354 * struct vif_params - describes virtual interface parameters
 355 * @use_4addr: use 4-address frames
 356 * @macaddr: address to use for this virtual interface.
 357 *      If this parameter is set to zero address the driver may
 358 *      determine the address as needed.
 359 *      This feature is only fully supported by drivers that enable the
 360 *      %NL80211_FEATURE_MAC_ON_CREATE flag.  Others may support creating
 361 **     only p2p devices with specified MAC.
 362 */
 363struct vif_params {
 364       int use_4addr;
 365       u8 macaddr[ETH_ALEN];
 366};
 367
 368/**
 369 * struct key_params - key information
 370 *
 371 * Information about a key
 372 *
 373 * @key: key material
 374 * @key_len: length of key material
 375 * @cipher: cipher suite selector
 376 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
 377 *      with the get_key() callback, must be in little endian,
 378 *      length given by @seq_len.
 379 * @seq_len: length of @seq.
 380 */
 381struct key_params {
 382        const u8 *key;
 383        const u8 *seq;
 384        int key_len;
 385        int seq_len;
 386        u32 cipher;
 387};
 388
 389/**
 390 * struct cfg80211_chan_def - channel definition
 391 * @chan: the (control) channel
 392 * @width: channel width
 393 * @center_freq1: center frequency of first segment
 394 * @center_freq2: center frequency of second segment
 395 *      (only with 80+80 MHz)
 396 */
 397struct cfg80211_chan_def {
 398        struct ieee80211_channel *chan;
 399        enum nl80211_chan_width width;
 400        u32 center_freq1;
 401        u32 center_freq2;
 402};
 403
 404/**
 405 * cfg80211_get_chandef_type - return old channel type from chandef
 406 * @chandef: the channel definition
 407 *
 408 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
 409 * chandef, which must have a bandwidth allowing this conversion.
 410 */
 411static inline enum nl80211_channel_type
 412cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
 413{
 414        switch (chandef->width) {
 415        case NL80211_CHAN_WIDTH_20_NOHT:
 416                return NL80211_CHAN_NO_HT;
 417        case NL80211_CHAN_WIDTH_20:
 418                return NL80211_CHAN_HT20;
 419        case NL80211_CHAN_WIDTH_40:
 420                if (chandef->center_freq1 > chandef->chan->center_freq)
 421                        return NL80211_CHAN_HT40PLUS;
 422                return NL80211_CHAN_HT40MINUS;
 423        default:
 424                WARN_ON(1);
 425                return NL80211_CHAN_NO_HT;
 426        }
 427}
 428
 429/**
 430 * cfg80211_chandef_create - create channel definition using channel type
 431 * @chandef: the channel definition struct to fill
 432 * @channel: the control channel
 433 * @chantype: the channel type
 434 *
 435 * Given a channel type, create a channel definition.
 436 */
 437void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
 438                             struct ieee80211_channel *channel,
 439                             enum nl80211_channel_type chantype);
 440
 441/**
 442 * cfg80211_chandef_identical - check if two channel definitions are identical
 443 * @chandef1: first channel definition
 444 * @chandef2: second channel definition
 445 *
 446 * Return: %true if the channels defined by the channel definitions are
 447 * identical, %false otherwise.
 448 */
 449static inline bool
 450cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
 451                           const struct cfg80211_chan_def *chandef2)
 452{
 453        return (chandef1->chan == chandef2->chan &&
 454                chandef1->width == chandef2->width &&
 455                chandef1->center_freq1 == chandef2->center_freq1 &&
 456                chandef1->center_freq2 == chandef2->center_freq2);
 457}
 458
 459/**
 460 * cfg80211_chandef_compatible - check if two channel definitions are compatible
 461 * @chandef1: first channel definition
 462 * @chandef2: second channel definition
 463 *
 464 * Return: %NULL if the given channel definitions are incompatible,
 465 * chandef1 or chandef2 otherwise.
 466 */
 467const struct cfg80211_chan_def *
 468cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
 469                            const struct cfg80211_chan_def *chandef2);
 470
 471/**
 472 * cfg80211_chandef_valid - check if a channel definition is valid
 473 * @chandef: the channel definition to check
 474 * Return: %true if the channel definition is valid. %false otherwise.
 475 */
 476bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
 477
 478/**
 479 * cfg80211_chandef_usable - check if secondary channels can be used
 480 * @wiphy: the wiphy to validate against
 481 * @chandef: the channel definition to check
 482 * @prohibited_flags: the regulatory channel flags that must not be set
 483 * Return: %true if secondary channels are usable. %false otherwise.
 484 */
 485bool cfg80211_chandef_usable(struct wiphy *wiphy,
 486                             const struct cfg80211_chan_def *chandef,
 487                             u32 prohibited_flags);
 488
 489/**
 490 * cfg80211_chandef_dfs_required - checks if radar detection is required
 491 * @wiphy: the wiphy to validate against
 492 * @chandef: the channel definition to check
 493 * @iftype: the interface type as specified in &enum nl80211_iftype
 494 * Returns:
 495 *      1 if radar detection is required, 0 if it is not, < 0 on error
 496 */
 497int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
 498                                  const struct cfg80211_chan_def *chandef,
 499                                  enum nl80211_iftype iftype);
 500
 501/**
 502 * ieee80211_chandef_rate_flags - returns rate flags for a channel
 503 *
 504 * In some channel types, not all rates may be used - for example CCK
 505 * rates may not be used in 5/10 MHz channels.
 506 *
 507 * @chandef: channel definition for the channel
 508 *
 509 * Returns: rate flags which apply for this channel
 510 */
 511static inline enum ieee80211_rate_flags
 512ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
 513{
 514        switch (chandef->width) {
 515        case NL80211_CHAN_WIDTH_5:
 516                return IEEE80211_RATE_SUPPORTS_5MHZ;
 517        case NL80211_CHAN_WIDTH_10:
 518                return IEEE80211_RATE_SUPPORTS_10MHZ;
 519        default:
 520                break;
 521        }
 522        return 0;
 523}
 524
 525/**
 526 * ieee80211_chandef_max_power - maximum transmission power for the chandef
 527 *
 528 * In some regulations, the transmit power may depend on the configured channel
 529 * bandwidth which may be defined as dBm/MHz. This function returns the actual
 530 * max_power for non-standard (20 MHz) channels.
 531 *
 532 * @chandef: channel definition for the channel
 533 *
 534 * Returns: maximum allowed transmission power in dBm for the chandef
 535 */
 536static inline int
 537ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
 538{
 539        switch (chandef->width) {
 540        case NL80211_CHAN_WIDTH_5:
 541                return min(chandef->chan->max_reg_power - 6,
 542                           chandef->chan->max_power);
 543        case NL80211_CHAN_WIDTH_10:
 544                return min(chandef->chan->max_reg_power - 3,
 545                           chandef->chan->max_power);
 546        default:
 547                break;
 548        }
 549        return chandef->chan->max_power;
 550}
 551
 552/**
 553 * enum survey_info_flags - survey information flags
 554 *
 555 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
 556 * @SURVEY_INFO_IN_USE: channel is currently being used
 557 * @SURVEY_INFO_TIME: active time (in ms) was filled in
 558 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
 559 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
 560 * @SURVEY_INFO_TIME_RX: receive time was filled in
 561 * @SURVEY_INFO_TIME_TX: transmit time was filled in
 562 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
 563 *
 564 * Used by the driver to indicate which info in &struct survey_info
 565 * it has filled in during the get_survey().
 566 */
 567enum survey_info_flags {
 568        SURVEY_INFO_NOISE_DBM           = BIT(0),
 569        SURVEY_INFO_IN_USE              = BIT(1),
 570        SURVEY_INFO_TIME                = BIT(2),
 571        SURVEY_INFO_TIME_BUSY           = BIT(3),
 572        SURVEY_INFO_TIME_EXT_BUSY       = BIT(4),
 573        SURVEY_INFO_TIME_RX             = BIT(5),
 574        SURVEY_INFO_TIME_TX             = BIT(6),
 575        SURVEY_INFO_TIME_SCAN           = BIT(7),
 576};
 577
 578/**
 579 * struct survey_info - channel survey response
 580 *
 581 * @channel: the channel this survey record reports, may be %NULL for a single
 582 *      record to report global statistics
 583 * @filled: bitflag of flags from &enum survey_info_flags
 584 * @noise: channel noise in dBm. This and all following fields are
 585 *      optional
 586 * @time: amount of time in ms the radio was turn on (on the channel)
 587 * @time_busy: amount of time the primary channel was sensed busy
 588 * @time_ext_busy: amount of time the extension channel was sensed busy
 589 * @time_rx: amount of time the radio spent receiving data
 590 * @time_tx: amount of time the radio spent transmitting data
 591 * @time_scan: amount of time the radio spent for scanning
 592 *
 593 * Used by dump_survey() to report back per-channel survey information.
 594 *
 595 * This structure can later be expanded with things like
 596 * channel duty cycle etc.
 597 */
 598struct survey_info {
 599        struct ieee80211_channel *channel;
 600        u64 time;
 601        u64 time_busy;
 602        u64 time_ext_busy;
 603        u64 time_rx;
 604        u64 time_tx;
 605        u64 time_scan;
 606        u32 filled;
 607        s8 noise;
 608};
 609
 610/**
 611 * struct cfg80211_crypto_settings - Crypto settings
 612 * @wpa_versions: indicates which, if any, WPA versions are enabled
 613 *      (from enum nl80211_wpa_versions)
 614 * @cipher_group: group key cipher suite (or 0 if unset)
 615 * @n_ciphers_pairwise: number of AP supported unicast ciphers
 616 * @ciphers_pairwise: unicast key cipher suites
 617 * @n_akm_suites: number of AKM suites
 618 * @akm_suites: AKM suites
 619 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
 620 *      sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
 621 *      required to assume that the port is unauthorized until authorized by
 622 *      user space. Otherwise, port is marked authorized by default.
 623 * @control_port_ethertype: the control port protocol that should be
 624 *      allowed through even on unauthorized ports
 625 * @control_port_no_encrypt: TRUE to prevent encryption of control port
 626 *      protocol frames.
 627 */
 628struct cfg80211_crypto_settings {
 629        u32 wpa_versions;
 630        u32 cipher_group;
 631        int n_ciphers_pairwise;
 632        u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
 633        int n_akm_suites;
 634        u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
 635        bool control_port;
 636        __be16 control_port_ethertype;
 637        bool control_port_no_encrypt;
 638};
 639
 640/**
 641 * struct cfg80211_beacon_data - beacon data
 642 * @head: head portion of beacon (before TIM IE)
 643 *      or %NULL if not changed
 644 * @tail: tail portion of beacon (after TIM IE)
 645 *      or %NULL if not changed
 646 * @head_len: length of @head
 647 * @tail_len: length of @tail
 648 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
 649 * @beacon_ies_len: length of beacon_ies in octets
 650 * @proberesp_ies: extra information element(s) to add into Probe Response
 651 *      frames or %NULL
 652 * @proberesp_ies_len: length of proberesp_ies in octets
 653 * @assocresp_ies: extra information element(s) to add into (Re)Association
 654 *      Response frames or %NULL
 655 * @assocresp_ies_len: length of assocresp_ies in octets
 656 * @probe_resp_len: length of probe response template (@probe_resp)
 657 * @probe_resp: probe response template (AP mode only)
 658 */
 659struct cfg80211_beacon_data {
 660        const u8 *head, *tail;
 661        const u8 *beacon_ies;
 662        const u8 *proberesp_ies;
 663        const u8 *assocresp_ies;
 664        const u8 *probe_resp;
 665
 666        size_t head_len, tail_len;
 667        size_t beacon_ies_len;
 668        size_t proberesp_ies_len;
 669        size_t assocresp_ies_len;
 670        size_t probe_resp_len;
 671};
 672
 673struct mac_address {
 674        u8 addr[ETH_ALEN];
 675};
 676
 677/**
 678 * struct cfg80211_acl_data - Access control list data
 679 *
 680 * @acl_policy: ACL policy to be applied on the station's
 681 *      entry specified by mac_addr
 682 * @n_acl_entries: Number of MAC address entries passed
 683 * @mac_addrs: List of MAC addresses of stations to be used for ACL
 684 */
 685struct cfg80211_acl_data {
 686        enum nl80211_acl_policy acl_policy;
 687        int n_acl_entries;
 688
 689        /* Keep it last */
 690        struct mac_address mac_addrs[];
 691};
 692
 693/**
 694 * struct cfg80211_ap_settings - AP configuration
 695 *
 696 * Used to configure an AP interface.
 697 *
 698 * @chandef: defines the channel to use
 699 * @beacon: beacon data
 700 * @beacon_interval: beacon interval
 701 * @dtim_period: DTIM period
 702 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
 703 *      user space)
 704 * @ssid_len: length of @ssid
 705 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
 706 * @crypto: crypto settings
 707 * @privacy: the BSS uses privacy
 708 * @auth_type: Authentication type (algorithm)
 709 * @smps_mode: SMPS mode
 710 * @inactivity_timeout: time in seconds to determine station's inactivity.
 711 * @p2p_ctwindow: P2P CT Window
 712 * @p2p_opp_ps: P2P opportunistic PS
 713 * @acl: ACL configuration used by the drivers which has support for
 714 *      MAC address based access control
 715 */
 716struct cfg80211_ap_settings {
 717        struct cfg80211_chan_def chandef;
 718
 719        struct cfg80211_beacon_data beacon;
 720
 721        int beacon_interval, dtim_period;
 722        const u8 *ssid;
 723        size_t ssid_len;
 724        enum nl80211_hidden_ssid hidden_ssid;
 725        struct cfg80211_crypto_settings crypto;
 726        bool privacy;
 727        enum nl80211_auth_type auth_type;
 728        enum nl80211_smps_mode smps_mode;
 729        int inactivity_timeout;
 730        u8 p2p_ctwindow;
 731        bool p2p_opp_ps;
 732        const struct cfg80211_acl_data *acl;
 733};
 734
 735/**
 736 * struct cfg80211_csa_settings - channel switch settings
 737 *
 738 * Used for channel switch
 739 *
 740 * @chandef: defines the channel to use after the switch
 741 * @beacon_csa: beacon data while performing the switch
 742 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
 743 * @counter_offsets_presp: offsets of the counters within the probe response
 744 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
 745 * @n_counter_offsets_presp: number of csa counters in the probe response
 746 * @beacon_after: beacon data to be used on the new channel
 747 * @radar_required: whether radar detection is required on the new channel
 748 * @block_tx: whether transmissions should be blocked while changing
 749 * @count: number of beacons until switch
 750 */
 751struct cfg80211_csa_settings {
 752        struct cfg80211_chan_def chandef;
 753        struct cfg80211_beacon_data beacon_csa;
 754        const u16 *counter_offsets_beacon;
 755        const u16 *counter_offsets_presp;
 756        unsigned int n_counter_offsets_beacon;
 757        unsigned int n_counter_offsets_presp;
 758        struct cfg80211_beacon_data beacon_after;
 759        bool radar_required;
 760        bool block_tx;
 761        u8 count;
 762};
 763
 764/**
 765 * enum station_parameters_apply_mask - station parameter values to apply
 766 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
 767 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
 768 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
 769 *
 770 * Not all station parameters have in-band "no change" signalling,
 771 * for those that don't these flags will are used.
 772 */
 773enum station_parameters_apply_mask {
 774        STATION_PARAM_APPLY_UAPSD = BIT(0),
 775        STATION_PARAM_APPLY_CAPABILITY = BIT(1),
 776        STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
 777};
 778
 779/**
 780 * struct station_parameters - station parameters
 781 *
 782 * Used to change and create a new station.
 783 *
 784 * @vlan: vlan interface station should belong to
 785 * @supported_rates: supported rates in IEEE 802.11 format
 786 *      (or NULL for no change)
 787 * @supported_rates_len: number of supported rates
 788 * @sta_flags_mask: station flags that changed
 789 *      (bitmask of BIT(NL80211_STA_FLAG_...))
 790 * @sta_flags_set: station flags values
 791 *      (bitmask of BIT(NL80211_STA_FLAG_...))
 792 * @listen_interval: listen interval or -1 for no change
 793 * @aid: AID or zero for no change
 794 * @plink_action: plink action to take
 795 * @plink_state: set the peer link state for a station
 796 * @ht_capa: HT capabilities of station
 797 * @vht_capa: VHT capabilities of station
 798 * @uapsd_queues: bitmap of queues configured for uapsd. same format
 799 *      as the AC bitmap in the QoS info field
 800 * @max_sp: max Service Period. same format as the MAX_SP in the
 801 *      QoS info field (but already shifted down)
 802 * @sta_modify_mask: bitmap indicating which parameters changed
 803 *      (for those that don't have a natural "no change" value),
 804 *      see &enum station_parameters_apply_mask
 805 * @local_pm: local link-specific mesh power save mode (no change when set
 806 *      to unknown)
 807 * @capability: station capability
 808 * @ext_capab: extended capabilities of the station
 809 * @ext_capab_len: number of extended capabilities
 810 * @supported_channels: supported channels in IEEE 802.11 format
 811 * @supported_channels_len: number of supported channels
 812 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
 813 * @supported_oper_classes_len: number of supported operating classes
 814 * @opmode_notif: operating mode field from Operating Mode Notification
 815 * @opmode_notif_used: information if operating mode field is used
 816 */
 817struct station_parameters {
 818        const u8 *supported_rates;
 819        struct net_device *vlan;
 820        u32 sta_flags_mask, sta_flags_set;
 821        u32 sta_modify_mask;
 822        int listen_interval;
 823        u16 aid;
 824        u8 supported_rates_len;
 825        u8 plink_action;
 826        u8 plink_state;
 827        const struct ieee80211_ht_cap *ht_capa;
 828        const struct ieee80211_vht_cap *vht_capa;
 829        u8 uapsd_queues;
 830        u8 max_sp;
 831        enum nl80211_mesh_power_mode local_pm;
 832        u16 capability;
 833        const u8 *ext_capab;
 834        u8 ext_capab_len;
 835        const u8 *supported_channels;
 836        u8 supported_channels_len;
 837        const u8 *supported_oper_classes;
 838        u8 supported_oper_classes_len;
 839        u8 opmode_notif;
 840        bool opmode_notif_used;
 841};
 842
 843/**
 844 * struct station_del_parameters - station deletion parameters
 845 *
 846 * Used to delete a station entry (or all stations).
 847 *
 848 * @mac: MAC address of the station to remove or NULL to remove all stations
 849 * @subtype: Management frame subtype to use for indicating removal
 850 *      (10 = Disassociation, 12 = Deauthentication)
 851 * @reason_code: Reason code for the Disassociation/Deauthentication frame
 852 */
 853struct station_del_parameters {
 854        const u8 *mac;
 855        u8 subtype;
 856        u16 reason_code;
 857};
 858
 859/**
 860 * enum cfg80211_station_type - the type of station being modified
 861 * @CFG80211_STA_AP_CLIENT: client of an AP interface
 862 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
 863 *      unassociated (update properties for this type of client is permitted)
 864 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
 865 *      the AP MLME in the device
 866 * @CFG80211_STA_AP_STA: AP station on managed interface
 867 * @CFG80211_STA_IBSS: IBSS station
 868 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
 869 *      while TDLS setup is in progress, it moves out of this state when
 870 *      being marked authorized; use this only if TDLS with external setup is
 871 *      supported/used)
 872 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
 873 *      entry that is operating, has been marked authorized by userspace)
 874 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
 875 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
 876 */
 877enum cfg80211_station_type {
 878        CFG80211_STA_AP_CLIENT,
 879        CFG80211_STA_AP_CLIENT_UNASSOC,
 880        CFG80211_STA_AP_MLME_CLIENT,
 881        CFG80211_STA_AP_STA,
 882        CFG80211_STA_IBSS,
 883        CFG80211_STA_TDLS_PEER_SETUP,
 884        CFG80211_STA_TDLS_PEER_ACTIVE,
 885        CFG80211_STA_MESH_PEER_KERNEL,
 886        CFG80211_STA_MESH_PEER_USER,
 887};
 888
 889/**
 890 * cfg80211_check_station_change - validate parameter changes
 891 * @wiphy: the wiphy this operates on
 892 * @params: the new parameters for a station
 893 * @statype: the type of station being modified
 894 *
 895 * Utility function for the @change_station driver method. Call this function
 896 * with the appropriate station type looking up the station (and checking that
 897 * it exists). It will verify whether the station change is acceptable, and if
 898 * not will return an error code. Note that it may modify the parameters for
 899 * backward compatibility reasons, so don't use them before calling this.
 900 */
 901int cfg80211_check_station_change(struct wiphy *wiphy,
 902                                  struct station_parameters *params,
 903                                  enum cfg80211_station_type statype);
 904
 905/**
 906 * enum station_info_rate_flags - bitrate info flags
 907 *
 908 * Used by the driver to indicate the specific rate transmission
 909 * type for 802.11n transmissions.
 910 *
 911 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
 912 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
 913 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
 914 * @RATE_INFO_FLAGS_60G: 60GHz MCS
 915 */
 916enum rate_info_flags {
 917        RATE_INFO_FLAGS_MCS                     = BIT(0),
 918        RATE_INFO_FLAGS_VHT_MCS                 = BIT(1),
 919        RATE_INFO_FLAGS_SHORT_GI                = BIT(2),
 920        RATE_INFO_FLAGS_60G                     = BIT(3),
 921};
 922
 923/**
 924 * enum rate_info_bw - rate bandwidth information
 925 *
 926 * Used by the driver to indicate the rate bandwidth.
 927 *
 928 * @RATE_INFO_BW_5: 5 MHz bandwidth
 929 * @RATE_INFO_BW_10: 10 MHz bandwidth
 930 * @RATE_INFO_BW_20: 20 MHz bandwidth
 931 * @RATE_INFO_BW_40: 40 MHz bandwidth
 932 * @RATE_INFO_BW_80: 80 MHz bandwidth
 933 * @RATE_INFO_BW_160: 160 MHz bandwidth
 934 */
 935enum rate_info_bw {
 936        RATE_INFO_BW_5,
 937        RATE_INFO_BW_10,
 938        RATE_INFO_BW_20,
 939        RATE_INFO_BW_40,
 940        RATE_INFO_BW_80,
 941        RATE_INFO_BW_160,
 942};
 943
 944/**
 945 * struct rate_info - bitrate information
 946 *
 947 * Information about a receiving or transmitting bitrate
 948 *
 949 * @flags: bitflag of flags from &enum rate_info_flags
 950 * @mcs: mcs index if struct describes a 802.11n bitrate
 951 * @legacy: bitrate in 100kbit/s for 802.11abg
 952 * @nss: number of streams (VHT only)
 953 * @bw: bandwidth (from &enum rate_info_bw)
 954 */
 955struct rate_info {
 956        u8 flags;
 957        u8 mcs;
 958        u16 legacy;
 959        u8 nss;
 960        u8 bw;
 961};
 962
 963/**
 964 * enum station_info_rate_flags - bitrate info flags
 965 *
 966 * Used by the driver to indicate the specific rate transmission
 967 * type for 802.11n transmissions.
 968 *
 969 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
 970 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
 971 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
 972 */
 973enum bss_param_flags {
 974        BSS_PARAM_FLAGS_CTS_PROT        = 1<<0,
 975        BSS_PARAM_FLAGS_SHORT_PREAMBLE  = 1<<1,
 976        BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
 977};
 978
 979/**
 980 * struct sta_bss_parameters - BSS parameters for the attached station
 981 *
 982 * Information about the currently associated BSS
 983 *
 984 * @flags: bitflag of flags from &enum bss_param_flags
 985 * @dtim_period: DTIM period for the BSS
 986 * @beacon_interval: beacon interval
 987 */
 988struct sta_bss_parameters {
 989        u8 flags;
 990        u8 dtim_period;
 991        u16 beacon_interval;
 992};
 993
 994/**
 995 * struct cfg80211_tid_stats - per-TID statistics
 996 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
 997 *      indicate the relevant values in this struct are filled
 998 * @rx_msdu: number of received MSDUs
 999 * @tx_msdu: number of (attempted) transmitted MSDUs
1000 * @tx_msdu_retries: number of retries (not counting the first) for
1001 *      transmitted MSDUs
1002 * @tx_msdu_failed: number of failed transmitted MSDUs
1003 */
1004struct cfg80211_tid_stats {
1005        u32 filled;
1006        u64 rx_msdu;
1007        u64 tx_msdu;
1008        u64 tx_msdu_retries;
1009        u64 tx_msdu_failed;
1010};
1011
1012#define IEEE80211_MAX_CHAINS    4
1013
1014/**
1015 * struct station_info - station information
1016 *
1017 * Station information filled by driver for get_station() and dump_station.
1018 *
1019 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1020 *      indicate the relevant values in this struct for them
1021 * @connected_time: time(in secs) since a station is last connected
1022 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1023 * @rx_bytes: bytes (size of MPDUs) received from this station
1024 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1025 * @llid: mesh local link id
1026 * @plid: mesh peer link id
1027 * @plink_state: mesh peer link state
1028 * @signal: The signal strength, type depends on the wiphy's signal_type.
1029 *      For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1030 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1031 *      For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1032 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1033 * @chain_signal: per-chain signal strength of last received packet in dBm
1034 * @chain_signal_avg: per-chain signal strength average in dBm
1035 * @txrate: current unicast bitrate from this station
1036 * @rxrate: current unicast bitrate to this station
1037 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1038 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1039 * @tx_retries: cumulative retry counts (MPDUs)
1040 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1041 * @rx_dropped_misc:  Dropped for un-specified reason.
1042 * @bss_param: current BSS parameters
1043 * @generation: generation number for nl80211 dumps.
1044 *      This number should increase every time the list of stations
1045 *      changes, i.e. when a station is added or removed, so that
1046 *      userspace can tell whether it got a consistent snapshot.
1047 * @assoc_req_ies: IEs from (Re)Association Request.
1048 *      This is used only when in AP mode with drivers that do not use
1049 *      user space MLME/SME implementation. The information is provided for
1050 *      the cfg80211_new_sta() calls to notify user space of the IEs.
1051 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1052 * @sta_flags: station flags mask & values
1053 * @beacon_loss_count: Number of times beacon loss event has triggered.
1054 * @t_offset: Time offset of the station relative to this host.
1055 * @local_pm: local mesh STA power save mode
1056 * @peer_pm: peer mesh STA power save mode
1057 * @nonpeer_pm: non-peer mesh STA power save mode
1058 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1059 *      towards this station.
1060 * @rx_beacon: number of beacons received from this peer
1061 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1062 *      from this peer
1063 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1064 *      (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1065 */
1066struct station_info {
1067        u32 filled;
1068        u32 connected_time;
1069        u32 inactive_time;
1070        u64 rx_bytes;
1071        u64 tx_bytes;
1072        u16 llid;
1073        u16 plid;
1074        u8 plink_state;
1075        s8 signal;
1076        s8 signal_avg;
1077
1078        u8 chains;
1079        s8 chain_signal[IEEE80211_MAX_CHAINS];
1080        s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1081
1082        struct rate_info txrate;
1083        struct rate_info rxrate;
1084        u32 rx_packets;
1085        u32 tx_packets;
1086        u32 tx_retries;
1087        u32 tx_failed;
1088        u32 rx_dropped_misc;
1089        struct sta_bss_parameters bss_param;
1090        struct nl80211_sta_flag_update sta_flags;
1091
1092        int generation;
1093
1094        const u8 *assoc_req_ies;
1095        size_t assoc_req_ies_len;
1096
1097        u32 beacon_loss_count;
1098        s64 t_offset;
1099        enum nl80211_mesh_power_mode local_pm;
1100        enum nl80211_mesh_power_mode peer_pm;
1101        enum nl80211_mesh_power_mode nonpeer_pm;
1102
1103        u32 expected_throughput;
1104
1105        u64 rx_beacon;
1106        u8 rx_beacon_signal_avg;
1107        struct cfg80211_tid_stats pertid[IEEE80211_NUM_TIDS + 1];
1108};
1109
1110/**
1111 * cfg80211_get_station - retrieve information about a given station
1112 * @dev: the device where the station is supposed to be connected to
1113 * @mac_addr: the mac address of the station of interest
1114 * @sinfo: pointer to the structure to fill with the information
1115 *
1116 * Returns 0 on success and sinfo is filled with the available information
1117 * otherwise returns a negative error code and the content of sinfo has to be
1118 * considered undefined.
1119 */
1120int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1121                         struct station_info *sinfo);
1122
1123/**
1124 * enum monitor_flags - monitor flags
1125 *
1126 * Monitor interface configuration flags. Note that these must be the bits
1127 * according to the nl80211 flags.
1128 *
1129 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1130 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1131 * @MONITOR_FLAG_CONTROL: pass control frames
1132 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1133 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1134 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1135 */
1136enum monitor_flags {
1137        MONITOR_FLAG_FCSFAIL            = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1138        MONITOR_FLAG_PLCPFAIL           = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1139        MONITOR_FLAG_CONTROL            = 1<<NL80211_MNTR_FLAG_CONTROL,
1140        MONITOR_FLAG_OTHER_BSS          = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1141        MONITOR_FLAG_COOK_FRAMES        = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1142        MONITOR_FLAG_ACTIVE             = 1<<NL80211_MNTR_FLAG_ACTIVE,
1143};
1144
1145/**
1146 * enum mpath_info_flags -  mesh path information flags
1147 *
1148 * Used by the driver to indicate which info in &struct mpath_info it has filled
1149 * in during get_station() or dump_station().
1150 *
1151 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1152 * @MPATH_INFO_SN: @sn filled
1153 * @MPATH_INFO_METRIC: @metric filled
1154 * @MPATH_INFO_EXPTIME: @exptime filled
1155 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1156 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1157 * @MPATH_INFO_FLAGS: @flags filled
1158 */
1159enum mpath_info_flags {
1160        MPATH_INFO_FRAME_QLEN           = BIT(0),
1161        MPATH_INFO_SN                   = BIT(1),
1162        MPATH_INFO_METRIC               = BIT(2),
1163        MPATH_INFO_EXPTIME              = BIT(3),
1164        MPATH_INFO_DISCOVERY_TIMEOUT    = BIT(4),
1165        MPATH_INFO_DISCOVERY_RETRIES    = BIT(5),
1166        MPATH_INFO_FLAGS                = BIT(6),
1167};
1168
1169/**
1170 * struct mpath_info - mesh path information
1171 *
1172 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1173 *
1174 * @filled: bitfield of flags from &enum mpath_info_flags
1175 * @frame_qlen: number of queued frames for this destination
1176 * @sn: target sequence number
1177 * @metric: metric (cost) of this mesh path
1178 * @exptime: expiration time for the mesh path from now, in msecs
1179 * @flags: mesh path flags
1180 * @discovery_timeout: total mesh path discovery timeout, in msecs
1181 * @discovery_retries: mesh path discovery retries
1182 * @generation: generation number for nl80211 dumps.
1183 *      This number should increase every time the list of mesh paths
1184 *      changes, i.e. when a station is added or removed, so that
1185 *      userspace can tell whether it got a consistent snapshot.
1186 */
1187struct mpath_info {
1188        u32 filled;
1189        u32 frame_qlen;
1190        u32 sn;
1191        u32 metric;
1192        u32 exptime;
1193        u32 discovery_timeout;
1194        u8 discovery_retries;
1195        u8 flags;
1196
1197        int generation;
1198};
1199
1200/**
1201 * struct bss_parameters - BSS parameters
1202 *
1203 * Used to change BSS parameters (mainly for AP mode).
1204 *
1205 * @use_cts_prot: Whether to use CTS protection
1206 *      (0 = no, 1 = yes, -1 = do not change)
1207 * @use_short_preamble: Whether the use of short preambles is allowed
1208 *      (0 = no, 1 = yes, -1 = do not change)
1209 * @use_short_slot_time: Whether the use of short slot time is allowed
1210 *      (0 = no, 1 = yes, -1 = do not change)
1211 * @basic_rates: basic rates in IEEE 802.11 format
1212 *      (or NULL for no change)
1213 * @basic_rates_len: number of basic rates
1214 * @ap_isolate: do not forward packets between connected stations
1215 * @ht_opmode: HT Operation mode
1216 *      (u16 = opmode, -1 = do not change)
1217 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1218 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1219 */
1220struct bss_parameters {
1221        int use_cts_prot;
1222        int use_short_preamble;
1223        int use_short_slot_time;
1224        const u8 *basic_rates;
1225        u8 basic_rates_len;
1226        int ap_isolate;
1227        int ht_opmode;
1228        s8 p2p_ctwindow, p2p_opp_ps;
1229};
1230
1231/**
1232 * struct mesh_config - 802.11s mesh configuration
1233 *
1234 * These parameters can be changed while the mesh is active.
1235 *
1236 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1237 *      by the Mesh Peering Open message
1238 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1239 *      used by the Mesh Peering Open message
1240 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1241 *      the mesh peering management to close a mesh peering
1242 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1243 *      mesh interface
1244 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1245 *      be sent to establish a new peer link instance in a mesh
1246 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1247 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1248 *      elements
1249 * @auto_open_plinks: whether we should automatically open peer links when we
1250 *      detect compatible mesh peers
1251 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1252 *      synchronize to for 11s default synchronization method
1253 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1254 *      that an originator mesh STA can send to a particular path target
1255 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1256 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1257 *      a path discovery in milliseconds
1258 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1259 *      receiving a PREQ shall consider the forwarding information from the
1260 *      root to be valid. (TU = time unit)
1261 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1262 *      which a mesh STA can send only one action frame containing a PREQ
1263 *      element
1264 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1265 *      which a mesh STA can send only one Action frame containing a PERR
1266 *      element
1267 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1268 *      it takes for an HWMP information element to propagate across the mesh
1269 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1270 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1271 *      announcements are transmitted
1272 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1273 *      station has access to a broader network beyond the MBSS. (This is
1274 *      missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1275 *      only means that the station will announce others it's a mesh gate, but
1276 *      not necessarily using the gate announcement protocol. Still keeping the
1277 *      same nomenclature to be in sync with the spec)
1278 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1279 *      entity (default is TRUE - forwarding entity)
1280 * @rssi_threshold: the threshold for average signal strength of candidate
1281 *      station to establish a peer link
1282 * @ht_opmode: mesh HT protection mode
1283 *
1284 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1285 *      receiving a proactive PREQ shall consider the forwarding information to
1286 *      the root mesh STA to be valid.
1287 *
1288 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1289 *      PREQs are transmitted.
1290 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1291 *      during which a mesh STA can send only one Action frame containing
1292 *      a PREQ element for root path confirmation.
1293 * @power_mode: The default mesh power save mode which will be the initial
1294 *      setting for new peer links.
1295 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1296 *      after transmitting its beacon.
1297 * @plink_timeout: If no tx activity is seen from a STA we've established
1298 *      peering with for longer than this time (in seconds), then remove it
1299 *      from the STA's list of peers.  Default is 30 minutes.
1300 */
1301struct mesh_config {
1302        u16 dot11MeshRetryTimeout;
1303        u16 dot11MeshConfirmTimeout;
1304        u16 dot11MeshHoldingTimeout;
1305        u16 dot11MeshMaxPeerLinks;
1306        u8 dot11MeshMaxRetries;
1307        u8 dot11MeshTTL;
1308        u8 element_ttl;
1309        bool auto_open_plinks;
1310        u32 dot11MeshNbrOffsetMaxNeighbor;
1311        u8 dot11MeshHWMPmaxPREQretries;
1312        u32 path_refresh_time;
1313        u16 min_discovery_timeout;
1314        u32 dot11MeshHWMPactivePathTimeout;
1315        u16 dot11MeshHWMPpreqMinInterval;
1316        u16 dot11MeshHWMPperrMinInterval;
1317        u16 dot11MeshHWMPnetDiameterTraversalTime;
1318        u8 dot11MeshHWMPRootMode;
1319        u16 dot11MeshHWMPRannInterval;
1320        bool dot11MeshGateAnnouncementProtocol;
1321        bool dot11MeshForwarding;
1322        s32 rssi_threshold;
1323        u16 ht_opmode;
1324        u32 dot11MeshHWMPactivePathToRootTimeout;
1325        u16 dot11MeshHWMProotInterval;
1326        u16 dot11MeshHWMPconfirmationInterval;
1327        enum nl80211_mesh_power_mode power_mode;
1328        u16 dot11MeshAwakeWindowDuration;
1329        u32 plink_timeout;
1330};
1331
1332/**
1333 * struct mesh_setup - 802.11s mesh setup configuration
1334 * @chandef: defines the channel to use
1335 * @mesh_id: the mesh ID
1336 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1337 * @sync_method: which synchronization method to use
1338 * @path_sel_proto: which path selection protocol to use
1339 * @path_metric: which metric to use
1340 * @auth_id: which authentication method this mesh is using
1341 * @ie: vendor information elements (optional)
1342 * @ie_len: length of vendor information elements
1343 * @is_authenticated: this mesh requires authentication
1344 * @is_secure: this mesh uses security
1345 * @user_mpm: userspace handles all MPM functions
1346 * @dtim_period: DTIM period to use
1347 * @beacon_interval: beacon interval to use
1348 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1349 * @basic_rates: basic rates to use when creating the mesh
1350 *
1351 * These parameters are fixed when the mesh is created.
1352 */
1353struct mesh_setup {
1354        struct cfg80211_chan_def chandef;
1355        const u8 *mesh_id;
1356        u8 mesh_id_len;
1357        u8 sync_method;
1358        u8 path_sel_proto;
1359        u8 path_metric;
1360        u8 auth_id;
1361        const u8 *ie;
1362        u8 ie_len;
1363        bool is_authenticated;
1364        bool is_secure;
1365        bool user_mpm;
1366        u8 dtim_period;
1367        u16 beacon_interval;
1368        int mcast_rate[IEEE80211_NUM_BANDS];
1369        u32 basic_rates;
1370};
1371
1372/**
1373 * struct ocb_setup - 802.11p OCB mode setup configuration
1374 * @chandef: defines the channel to use
1375 *
1376 * These parameters are fixed when connecting to the network
1377 */
1378struct ocb_setup {
1379        struct cfg80211_chan_def chandef;
1380};
1381
1382/**
1383 * struct ieee80211_txq_params - TX queue parameters
1384 * @ac: AC identifier
1385 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1386 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1387 *      1..32767]
1388 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1389 *      1..32767]
1390 * @aifs: Arbitration interframe space [0..255]
1391 */
1392struct ieee80211_txq_params {
1393        enum nl80211_ac ac;
1394        u16 txop;
1395        u16 cwmin;
1396        u16 cwmax;
1397        u8 aifs;
1398};
1399
1400/**
1401 * DOC: Scanning and BSS list handling
1402 *
1403 * The scanning process itself is fairly simple, but cfg80211 offers quite
1404 * a bit of helper functionality. To start a scan, the scan operation will
1405 * be invoked with a scan definition. This scan definition contains the
1406 * channels to scan, and the SSIDs to send probe requests for (including the
1407 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1408 * probe. Additionally, a scan request may contain extra information elements
1409 * that should be added to the probe request. The IEs are guaranteed to be
1410 * well-formed, and will not exceed the maximum length the driver advertised
1411 * in the wiphy structure.
1412 *
1413 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1414 * it is responsible for maintaining the BSS list; the driver should not
1415 * maintain a list itself. For this notification, various functions exist.
1416 *
1417 * Since drivers do not maintain a BSS list, there are also a number of
1418 * functions to search for a BSS and obtain information about it from the
1419 * BSS structure cfg80211 maintains. The BSS list is also made available
1420 * to userspace.
1421 */
1422
1423/**
1424 * struct cfg80211_ssid - SSID description
1425 * @ssid: the SSID
1426 * @ssid_len: length of the ssid
1427 */
1428struct cfg80211_ssid {
1429        u8 ssid[IEEE80211_MAX_SSID_LEN];
1430        u8 ssid_len;
1431};
1432
1433/**
1434 * struct cfg80211_scan_request - scan request description
1435 *
1436 * @ssids: SSIDs to scan for (active scan only)
1437 * @n_ssids: number of SSIDs
1438 * @channels: channels to scan on.
1439 * @n_channels: total number of channels to scan
1440 * @scan_width: channel width for scanning
1441 * @ie: optional information element(s) to add into Probe Request or %NULL
1442 * @ie_len: length of ie in octets
1443 * @flags: bit field of flags controlling operation
1444 * @rates: bitmap of rates to advertise for each band
1445 * @wiphy: the wiphy this was for
1446 * @scan_start: time (in jiffies) when the scan started
1447 * @wdev: the wireless device to scan for
1448 * @aborted: (internal) scan request was notified as aborted
1449 * @notified: (internal) scan request was notified as done or aborted
1450 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1451 * @mac_addr: MAC address used with randomisation
1452 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1453 *      are 0 in the mask should be randomised, bits that are 1 should
1454 *      be taken from the @mac_addr
1455 */
1456struct cfg80211_scan_request {
1457        struct cfg80211_ssid *ssids;
1458        int n_ssids;
1459        u32 n_channels;
1460        enum nl80211_bss_scan_width scan_width;
1461        const u8 *ie;
1462        size_t ie_len;
1463        u32 flags;
1464
1465        u32 rates[IEEE80211_NUM_BANDS];
1466
1467        struct wireless_dev *wdev;
1468
1469        u8 mac_addr[ETH_ALEN] __aligned(2);
1470        u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1471
1472        /* internal */
1473        struct wiphy *wiphy;
1474        unsigned long scan_start;
1475        bool aborted, notified;
1476        bool no_cck;
1477
1478        /* keep last */
1479        struct ieee80211_channel *channels[0];
1480};
1481
1482static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
1483{
1484        int i;
1485
1486        get_random_bytes(buf, ETH_ALEN);
1487        for (i = 0; i < ETH_ALEN; i++) {
1488                buf[i] &= ~mask[i];
1489                buf[i] |= addr[i] & mask[i];
1490        }
1491}
1492
1493/**
1494 * struct cfg80211_match_set - sets of attributes to match
1495 *
1496 * @ssid: SSID to be matched; may be zero-length for no match (RSSI only)
1497 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1498 */
1499struct cfg80211_match_set {
1500        struct cfg80211_ssid ssid;
1501        s32 rssi_thold;
1502};
1503
1504/**
1505 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
1506 *
1507 * @interval: interval between scheduled scan iterations. In seconds.
1508 * @iterations: number of scan iterations in this scan plan. Zero means
1509 *      infinite loop.
1510 *      The last scan plan will always have this parameter set to zero,
1511 *      all other scan plans will have a finite number of iterations.
1512 */
1513struct cfg80211_sched_scan_plan {
1514        u32 interval;
1515        u32 iterations;
1516};
1517
1518/**
1519 * struct cfg80211_sched_scan_request - scheduled scan request description
1520 *
1521 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1522 * @n_ssids: number of SSIDs
1523 * @n_channels: total number of channels to scan
1524 * @scan_width: channel width for scanning
1525 * @ie: optional information element(s) to add into Probe Request or %NULL
1526 * @ie_len: length of ie in octets
1527 * @flags: bit field of flags controlling operation
1528 * @match_sets: sets of parameters to be matched for a scan result
1529 *      entry to be considered valid and to be passed to the host
1530 *      (others are filtered out).
1531 *      If ommited, all results are passed.
1532 * @n_match_sets: number of match sets
1533 * @wiphy: the wiphy this was for
1534 * @dev: the interface
1535 * @scan_start: start time of the scheduled scan
1536 * @channels: channels to scan
1537 * @min_rssi_thold: for drivers only supporting a single threshold, this
1538 *      contains the minimum over all matchsets
1539 * @mac_addr: MAC address used with randomisation
1540 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1541 *      are 0 in the mask should be randomised, bits that are 1 should
1542 *      be taken from the @mac_addr
1543 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
1544 *      index must be executed first.
1545 * @n_scan_plans: number of scan plans, at least 1.
1546 * @rcu_head: RCU callback used to free the struct
1547 * @owner_nlportid: netlink portid of owner (if this should is a request
1548 *      owned by a particular socket)
1549 * @delay: delay in seconds to use before starting the first scan
1550 *      cycle.  The driver may ignore this parameter and start
1551 *      immediately (or at any other time), if this feature is not
1552 *      supported.
1553 */
1554struct cfg80211_sched_scan_request {
1555        struct cfg80211_ssid *ssids;
1556        int n_ssids;
1557        u32 n_channels;
1558        enum nl80211_bss_scan_width scan_width;
1559        const u8 *ie;
1560        size_t ie_len;
1561        u32 flags;
1562        struct cfg80211_match_set *match_sets;
1563        int n_match_sets;
1564        s32 min_rssi_thold;
1565        u32 delay;
1566        struct cfg80211_sched_scan_plan *scan_plans;
1567        int n_scan_plans;
1568
1569        u8 mac_addr[ETH_ALEN] __aligned(2);
1570        u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1571
1572        /* internal */
1573        struct wiphy *wiphy;
1574        struct net_device *dev;
1575        unsigned long scan_start;
1576        struct rcu_head rcu_head;
1577        u32 owner_nlportid;
1578
1579        /* keep last */
1580        struct ieee80211_channel *channels[0];
1581};
1582
1583/**
1584 * enum cfg80211_signal_type - signal type
1585 *
1586 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1587 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1588 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1589 */
1590enum cfg80211_signal_type {
1591        CFG80211_SIGNAL_TYPE_NONE,
1592        CFG80211_SIGNAL_TYPE_MBM,
1593        CFG80211_SIGNAL_TYPE_UNSPEC,
1594};
1595
1596/**
1597 * struct cfg80211_inform_bss - BSS inform data
1598 * @chan: channel the frame was received on
1599 * @scan_width: scan width that was used
1600 * @signal: signal strength value, according to the wiphy's
1601 *      signal type
1602 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
1603 *      received; should match the time when the frame was actually
1604 *      received by the device (not just by the host, in case it was
1605 *      buffered on the device) and be accurate to about 10ms.
1606 *      If the frame isn't buffered, just passing the return value of
1607 *      ktime_get_boot_ns() is likely appropriate.
1608 */
1609struct cfg80211_inform_bss {
1610        struct ieee80211_channel *chan;
1611        enum nl80211_bss_scan_width scan_width;
1612        s32 signal;
1613        u64 boottime_ns;
1614};
1615
1616/**
1617 * struct cfg80211_bss_ie_data - BSS entry IE data
1618 * @tsf: TSF contained in the frame that carried these IEs
1619 * @rcu_head: internal use, for freeing
1620 * @len: length of the IEs
1621 * @from_beacon: these IEs are known to come from a beacon
1622 * @data: IE data
1623 */
1624struct cfg80211_bss_ies {
1625        u64 tsf;
1626        struct rcu_head rcu_head;
1627        int len;
1628        bool from_beacon;
1629        u8 data[];
1630};
1631
1632/**
1633 * struct cfg80211_bss - BSS description
1634 *
1635 * This structure describes a BSS (which may also be a mesh network)
1636 * for use in scan results and similar.
1637 *
1638 * @channel: channel this BSS is on
1639 * @scan_width: width of the control channel
1640 * @bssid: BSSID of the BSS
1641 * @beacon_interval: the beacon interval as from the frame
1642 * @capability: the capability field in host byte order
1643 * @ies: the information elements (Note that there is no guarantee that these
1644 *      are well-formed!); this is a pointer to either the beacon_ies or
1645 *      proberesp_ies depending on whether Probe Response frame has been
1646 *      received. It is always non-%NULL.
1647 * @beacon_ies: the information elements from the last Beacon frame
1648 *      (implementation note: if @hidden_beacon_bss is set this struct doesn't
1649 *      own the beacon_ies, but they're just pointers to the ones from the
1650 *      @hidden_beacon_bss struct)
1651 * @proberesp_ies: the information elements from the last Probe Response frame
1652 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1653 *      a BSS that hides the SSID in its beacon, this points to the BSS struct
1654 *      that holds the beacon data. @beacon_ies is still valid, of course, and
1655 *      points to the same data as hidden_beacon_bss->beacon_ies in that case.
1656 * @signal: signal strength value (type depends on the wiphy's signal_type)
1657 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1658 */
1659struct cfg80211_bss {
1660        struct ieee80211_channel *channel;
1661        enum nl80211_bss_scan_width scan_width;
1662
1663        const struct cfg80211_bss_ies __rcu *ies;
1664        const struct cfg80211_bss_ies __rcu *beacon_ies;
1665        const struct cfg80211_bss_ies __rcu *proberesp_ies;
1666
1667        struct cfg80211_bss *hidden_beacon_bss;
1668
1669        s32 signal;
1670
1671        u16 beacon_interval;
1672        u16 capability;
1673
1674        u8 bssid[ETH_ALEN];
1675
1676        u8 priv[0] __aligned(sizeof(void *));
1677};
1678
1679/**
1680 * ieee80211_bss_get_ie - find IE with given ID
1681 * @bss: the bss to search
1682 * @ie: the IE ID
1683 *
1684 * Note that the return value is an RCU-protected pointer, so
1685 * rcu_read_lock() must be held when calling this function.
1686 * Return: %NULL if not found.
1687 */
1688const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1689
1690
1691/**
1692 * struct cfg80211_auth_request - Authentication request data
1693 *
1694 * This structure provides information needed to complete IEEE 802.11
1695 * authentication.
1696 *
1697 * @bss: The BSS to authenticate with, the callee must obtain a reference
1698 *      to it if it needs to keep it.
1699 * @auth_type: Authentication type (algorithm)
1700 * @ie: Extra IEs to add to Authentication frame or %NULL
1701 * @ie_len: Length of ie buffer in octets
1702 * @key_len: length of WEP key for shared key authentication
1703 * @key_idx: index of WEP key for shared key authentication
1704 * @key: WEP key for shared key authentication
1705 * @sae_data: Non-IE data to use with SAE or %NULL. This starts with
1706 *      Authentication transaction sequence number field.
1707 * @sae_data_len: Length of sae_data buffer in octets
1708 */
1709struct cfg80211_auth_request {
1710        struct cfg80211_bss *bss;
1711        const u8 *ie;
1712        size_t ie_len;
1713        enum nl80211_auth_type auth_type;
1714        const u8 *key;
1715        u8 key_len, key_idx;
1716        const u8 *sae_data;
1717        size_t sae_data_len;
1718};
1719
1720/**
1721 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1722 *
1723 * @ASSOC_REQ_DISABLE_HT:  Disable HT (802.11n)
1724 * @ASSOC_REQ_DISABLE_VHT:  Disable VHT
1725 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
1726 */
1727enum cfg80211_assoc_req_flags {
1728        ASSOC_REQ_DISABLE_HT            = BIT(0),
1729        ASSOC_REQ_DISABLE_VHT           = BIT(1),
1730        ASSOC_REQ_USE_RRM               = BIT(2),
1731};
1732
1733/**
1734 * struct cfg80211_assoc_request - (Re)Association request data
1735 *
1736 * This structure provides information needed to complete IEEE 802.11
1737 * (re)association.
1738 * @bss: The BSS to associate with. If the call is successful the driver is
1739 *      given a reference that it must give back to cfg80211_send_rx_assoc()
1740 *      or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
1741 *      association requests while already associating must be rejected.
1742 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1743 * @ie_len: Length of ie buffer in octets
1744 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1745 * @crypto: crypto settings
1746 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
1747 * @flags:  See &enum cfg80211_assoc_req_flags
1748 * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
1749 *      will be used in ht_capa.  Un-supported values will be ignored.
1750 * @ht_capa_mask:  The bits of ht_capa which are to be used.
1751 * @vht_capa: VHT capability override
1752 * @vht_capa_mask: VHT capability mask indicating which fields to use
1753 */
1754struct cfg80211_assoc_request {
1755        struct cfg80211_bss *bss;
1756        const u8 *ie, *prev_bssid;
1757        size_t ie_len;
1758        struct cfg80211_crypto_settings crypto;
1759        bool use_mfp;
1760        u32 flags;
1761        struct ieee80211_ht_cap ht_capa;
1762        struct ieee80211_ht_cap ht_capa_mask;
1763        struct ieee80211_vht_cap vht_capa, vht_capa_mask;
1764};
1765
1766/**
1767 * struct cfg80211_deauth_request - Deauthentication request data
1768 *
1769 * This structure provides information needed to complete IEEE 802.11
1770 * deauthentication.
1771 *
1772 * @bssid: the BSSID of the BSS to deauthenticate from
1773 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1774 * @ie_len: Length of ie buffer in octets
1775 * @reason_code: The reason code for the deauthentication
1776 * @local_state_change: if set, change local state only and
1777 *      do not set a deauth frame
1778 */
1779struct cfg80211_deauth_request {
1780        const u8 *bssid;
1781        const u8 *ie;
1782        size_t ie_len;
1783        u16 reason_code;
1784        bool local_state_change;
1785};
1786
1787/**
1788 * struct cfg80211_disassoc_request - Disassociation request data
1789 *
1790 * This structure provides information needed to complete IEEE 802.11
1791 * disassocation.
1792 *
1793 * @bss: the BSS to disassociate from
1794 * @ie: Extra IEs to add to Disassociation frame or %NULL
1795 * @ie_len: Length of ie buffer in octets
1796 * @reason_code: The reason code for the disassociation
1797 * @local_state_change: This is a request for a local state only, i.e., no
1798 *      Disassociation frame is to be transmitted.
1799 */
1800struct cfg80211_disassoc_request {
1801        struct cfg80211_bss *bss;
1802        const u8 *ie;
1803        size_t ie_len;
1804        u16 reason_code;
1805        bool local_state_change;
1806};
1807
1808/**
1809 * struct cfg80211_ibss_params - IBSS parameters
1810 *
1811 * This structure defines the IBSS parameters for the join_ibss()
1812 * method.
1813 *
1814 * @ssid: The SSID, will always be non-null.
1815 * @ssid_len: The length of the SSID, will always be non-zero.
1816 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1817 *      search for IBSSs with a different BSSID.
1818 * @chandef: defines the channel to use if no other IBSS to join can be found
1819 * @channel_fixed: The channel should be fixed -- do not search for
1820 *      IBSSs to join on other channels.
1821 * @ie: information element(s) to include in the beacon
1822 * @ie_len: length of that
1823 * @beacon_interval: beacon interval to use
1824 * @privacy: this is a protected network, keys will be configured
1825 *      after joining
1826 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1827 *      sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1828 *      required to assume that the port is unauthorized until authorized by
1829 *      user space. Otherwise, port is marked authorized by default.
1830 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1831 *      changes the channel when a radar is detected. This is required
1832 *      to operate on DFS channels.
1833 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1834 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1835 * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
1836 *      will be used in ht_capa.  Un-supported values will be ignored.
1837 * @ht_capa_mask:  The bits of ht_capa which are to be used.
1838 */
1839struct cfg80211_ibss_params {
1840        const u8 *ssid;
1841        const u8 *bssid;
1842        struct cfg80211_chan_def chandef;
1843        const u8 *ie;
1844        u8 ssid_len, ie_len;
1845        u16 beacon_interval;
1846        u32 basic_rates;
1847        bool channel_fixed;
1848        bool privacy;
1849        bool control_port;
1850        bool userspace_handles_dfs;
1851        int mcast_rate[IEEE80211_NUM_BANDS];
1852        struct ieee80211_ht_cap ht_capa;
1853        struct ieee80211_ht_cap ht_capa_mask;
1854};
1855
1856/**
1857 * struct cfg80211_connect_params - Connection parameters
1858 *
1859 * This structure provides information needed to complete IEEE 802.11
1860 * authentication and association.
1861 *
1862 * @channel: The channel to use or %NULL if not specified (auto-select based
1863 *      on scan results)
1864 * @channel_hint: The channel of the recommended BSS for initial connection or
1865 *      %NULL if not specified
1866 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1867 *      results)
1868 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
1869 *      %NULL if not specified. Unlike the @bssid parameter, the driver is
1870 *      allowed to ignore this @bssid_hint if it has knowledge of a better BSS
1871 *      to use.
1872 * @ssid: SSID
1873 * @ssid_len: Length of ssid in octets
1874 * @auth_type: Authentication type (algorithm)
1875 * @ie: IEs for association request
1876 * @ie_len: Length of assoc_ie in octets
1877 * @privacy: indicates whether privacy-enabled APs should be used
1878 * @mfp: indicate whether management frame protection is used
1879 * @crypto: crypto settings
1880 * @key_len: length of WEP key for shared key authentication
1881 * @key_idx: index of WEP key for shared key authentication
1882 * @key: WEP key for shared key authentication
1883 * @flags:  See &enum cfg80211_assoc_req_flags
1884 * @bg_scan_period:  Background scan period in seconds
1885 *      or -1 to indicate that default value is to be used.
1886 * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
1887 *      will be used in ht_capa.  Un-supported values will be ignored.
1888 * @ht_capa_mask:  The bits of ht_capa which are to be used.
1889 * @vht_capa:  VHT Capability overrides
1890 * @vht_capa_mask: The bits of vht_capa which are to be used.
1891 */
1892struct cfg80211_connect_params {
1893        struct ieee80211_channel *channel;
1894        struct ieee80211_channel *channel_hint;
1895        const u8 *bssid;
1896        const u8 *bssid_hint;
1897        const u8 *ssid;
1898        size_t ssid_len;
1899        enum nl80211_auth_type auth_type;
1900        const u8 *ie;
1901        size_t ie_len;
1902        bool privacy;
1903        enum nl80211_mfp mfp;
1904        struct cfg80211_crypto_settings crypto;
1905        const u8 *key;
1906        u8 key_len, key_idx;
1907        u32 flags;
1908        int bg_scan_period;
1909        struct ieee80211_ht_cap ht_capa;
1910        struct ieee80211_ht_cap ht_capa_mask;
1911        struct ieee80211_vht_cap vht_capa;
1912        struct ieee80211_vht_cap vht_capa_mask;
1913};
1914
1915/**
1916 * enum wiphy_params_flags - set_wiphy_params bitfield values
1917 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1918 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1919 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1920 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1921 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1922 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
1923 */
1924enum wiphy_params_flags {
1925        WIPHY_PARAM_RETRY_SHORT         = 1 << 0,
1926        WIPHY_PARAM_RETRY_LONG          = 1 << 1,
1927        WIPHY_PARAM_FRAG_THRESHOLD      = 1 << 2,
1928        WIPHY_PARAM_RTS_THRESHOLD       = 1 << 3,
1929        WIPHY_PARAM_COVERAGE_CLASS      = 1 << 4,
1930        WIPHY_PARAM_DYN_ACK             = 1 << 5,
1931};
1932
1933/*
1934 * cfg80211_bitrate_mask - masks for bitrate control
1935 */
1936struct cfg80211_bitrate_mask {
1937        struct {
1938                u32 legacy;
1939                u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
1940                u16 vht_mcs[NL80211_VHT_NSS_MAX];
1941                enum nl80211_txrate_gi gi;
1942        } control[IEEE80211_NUM_BANDS];
1943};
1944/**
1945 * struct cfg80211_pmksa - PMK Security Association
1946 *
1947 * This structure is passed to the set/del_pmksa() method for PMKSA
1948 * caching.
1949 *
1950 * @bssid: The AP's BSSID.
1951 * @pmkid: The PMK material itself.
1952 */
1953struct cfg80211_pmksa {
1954        const u8 *bssid;
1955        const u8 *pmkid;
1956};
1957
1958/**
1959 * struct cfg80211_pkt_pattern - packet pattern
1960 * @mask: bitmask where to match pattern and where to ignore bytes,
1961 *      one bit per byte, in same format as nl80211
1962 * @pattern: bytes to match where bitmask is 1
1963 * @pattern_len: length of pattern (in bytes)
1964 * @pkt_offset: packet offset (in bytes)
1965 *
1966 * Internal note: @mask and @pattern are allocated in one chunk of
1967 * memory, free @mask only!
1968 */
1969struct cfg80211_pkt_pattern {
1970        const u8 *mask, *pattern;
1971        int pattern_len;
1972        int pkt_offset;
1973};
1974
1975/**
1976 * struct cfg80211_wowlan_tcp - TCP connection parameters
1977 *
1978 * @sock: (internal) socket for source port allocation
1979 * @src: source IP address
1980 * @dst: destination IP address
1981 * @dst_mac: destination MAC address
1982 * @src_port: source port
1983 * @dst_port: destination port
1984 * @payload_len: data payload length
1985 * @payload: data payload buffer
1986 * @payload_seq: payload sequence stamping configuration
1987 * @data_interval: interval at which to send data packets
1988 * @wake_len: wakeup payload match length
1989 * @wake_data: wakeup payload match data
1990 * @wake_mask: wakeup payload match mask
1991 * @tokens_size: length of the tokens buffer
1992 * @payload_tok: payload token usage configuration
1993 */
1994struct cfg80211_wowlan_tcp {
1995        struct socket *sock;
1996        __be32 src, dst;
1997        u16 src_port, dst_port;
1998        u8 dst_mac[ETH_ALEN];
1999        int payload_len;
2000        const u8 *payload;
2001        struct nl80211_wowlan_tcp_data_seq payload_seq;
2002        u32 data_interval;
2003        u32 wake_len;
2004        const u8 *wake_data, *wake_mask;
2005        u32 tokens_size;
2006        /* must be last, variable member */
2007        struct nl80211_wowlan_tcp_data_token payload_tok;
2008};
2009
2010/**
2011 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2012 *
2013 * This structure defines the enabled WoWLAN triggers for the device.
2014 * @any: wake up on any activity -- special trigger if device continues
2015 *      operating as normal during suspend
2016 * @disconnect: wake up if getting disconnected
2017 * @magic_pkt: wake up on receiving magic packet
2018 * @patterns: wake up on receiving packet matching a pattern
2019 * @n_patterns: number of patterns
2020 * @gtk_rekey_failure: wake up on GTK rekey failure
2021 * @eap_identity_req: wake up on EAP identity request packet
2022 * @four_way_handshake: wake up on 4-way handshake
2023 * @rfkill_release: wake up when rfkill is released
2024 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2025 *      NULL if not configured.
2026 * @nd_config: configuration for the scan to be used for net detect wake.
2027 */
2028struct cfg80211_wowlan {
2029        bool any, disconnect, magic_pkt, gtk_rekey_failure,
2030             eap_identity_req, four_way_handshake,
2031             rfkill_release;
2032        struct cfg80211_pkt_pattern *patterns;
2033        struct cfg80211_wowlan_tcp *tcp;
2034        int n_patterns;
2035        struct cfg80211_sched_scan_request *nd_config;
2036};
2037
2038/**
2039 * struct cfg80211_coalesce_rules - Coalesce rule parameters
2040 *
2041 * This structure defines coalesce rule for the device.
2042 * @delay: maximum coalescing delay in msecs.
2043 * @condition: condition for packet coalescence.
2044 *      see &enum nl80211_coalesce_condition.
2045 * @patterns: array of packet patterns
2046 * @n_patterns: number of patterns
2047 */
2048struct cfg80211_coalesce_rules {
2049        int delay;
2050        enum nl80211_coalesce_condition condition;
2051        struct cfg80211_pkt_pattern *patterns;
2052        int n_patterns;
2053};
2054
2055/**
2056 * struct cfg80211_coalesce - Packet coalescing settings
2057 *
2058 * This structure defines coalescing settings.
2059 * @rules: array of coalesce rules
2060 * @n_rules: number of rules
2061 */
2062struct cfg80211_coalesce {
2063        struct cfg80211_coalesce_rules *rules;
2064        int n_rules;
2065};
2066
2067/**
2068 * struct cfg80211_wowlan_nd_match - information about the match
2069 *
2070 * @ssid: SSID of the match that triggered the wake up
2071 * @n_channels: Number of channels where the match occurred.  This
2072 *      value may be zero if the driver can't report the channels.
2073 * @channels: center frequencies of the channels where a match
2074 *      occurred (in MHz)
2075 */
2076struct cfg80211_wowlan_nd_match {
2077        struct cfg80211_ssid ssid;
2078        int n_channels;
2079        u32 channels[];
2080};
2081
2082/**
2083 * struct cfg80211_wowlan_nd_info - net detect wake up information
2084 *
2085 * @n_matches: Number of match information instances provided in
2086 *      @matches.  This value may be zero if the driver can't provide
2087 *      match information.
2088 * @matches: Array of pointers to matches containing information about
2089 *      the matches that triggered the wake up.
2090 */
2091struct cfg80211_wowlan_nd_info {
2092        int n_matches;
2093        struct cfg80211_wowlan_nd_match *matches[];
2094};
2095
2096/**
2097 * struct cfg80211_wowlan_wakeup - wakeup report
2098 * @disconnect: woke up by getting disconnected
2099 * @magic_pkt: woke up by receiving magic packet
2100 * @gtk_rekey_failure: woke up by GTK rekey failure
2101 * @eap_identity_req: woke up by EAP identity request packet
2102 * @four_way_handshake: woke up by 4-way handshake
2103 * @rfkill_release: woke up by rfkill being released
2104 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2105 * @packet_present_len: copied wakeup packet data
2106 * @packet_len: original wakeup packet length
2107 * @packet: The packet causing the wakeup, if any.
2108 * @packet_80211:  For pattern match, magic packet and other data
2109 *      frame triggers an 802.3 frame should be reported, for
2110 *      disconnect due to deauth 802.11 frame. This indicates which
2111 *      it is.
2112 * @tcp_match: TCP wakeup packet received
2113 * @tcp_connlost: TCP connection lost or failed to establish
2114 * @tcp_nomoretokens: TCP data ran out of tokens
2115 * @net_detect: if not %NULL, woke up because of net detect
2116 */
2117struct cfg80211_wowlan_wakeup {
2118        bool disconnect, magic_pkt, gtk_rekey_failure,
2119             eap_identity_req, four_way_handshake,
2120             rfkill_release, packet_80211,
2121             tcp_match, tcp_connlost, tcp_nomoretokens;
2122        s32 pattern_idx;
2123        u32 packet_present_len, packet_len;
2124        const void *packet;
2125        struct cfg80211_wowlan_nd_info *net_detect;
2126};
2127
2128/**
2129 * struct cfg80211_gtk_rekey_data - rekey data
2130 * @kek: key encryption key (NL80211_KEK_LEN bytes)
2131 * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2132 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2133 */
2134struct cfg80211_gtk_rekey_data {
2135        const u8 *kek, *kck, *replay_ctr;
2136};
2137
2138/**
2139 * struct cfg80211_update_ft_ies_params - FT IE Information
2140 *
2141 * This structure provides information needed to update the fast transition IE
2142 *
2143 * @md: The Mobility Domain ID, 2 Octet value
2144 * @ie: Fast Transition IEs
2145 * @ie_len: Length of ft_ie in octets
2146 */
2147struct cfg80211_update_ft_ies_params {
2148        u16 md;
2149        const u8 *ie;
2150        size_t ie_len;
2151};
2152
2153/**
2154 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2155 *
2156 * This structure provides information needed to transmit a mgmt frame
2157 *
2158 * @chan: channel to use
2159 * @offchan: indicates wether off channel operation is required
2160 * @wait: duration for ROC
2161 * @buf: buffer to transmit
2162 * @len: buffer length
2163 * @no_cck: don't use cck rates for this frame
2164 * @dont_wait_for_ack: tells the low level not to wait for an ack
2165 * @n_csa_offsets: length of csa_offsets array
2166 * @csa_offsets: array of all the csa offsets in the frame
2167 */
2168struct cfg80211_mgmt_tx_params {
2169        struct ieee80211_channel *chan;
2170        bool offchan;
2171        unsigned int wait;
2172        const u8 *buf;
2173        size_t len;
2174        bool no_cck;
2175        bool dont_wait_for_ack;
2176        int n_csa_offsets;
2177        const u16 *csa_offsets;
2178};
2179
2180/**
2181 * struct cfg80211_dscp_exception - DSCP exception
2182 *
2183 * @dscp: DSCP value that does not adhere to the user priority range definition
2184 * @up: user priority value to which the corresponding DSCP value belongs
2185 */
2186struct cfg80211_dscp_exception {
2187        u8 dscp;
2188        u8 up;
2189};
2190
2191/**
2192 * struct cfg80211_dscp_range - DSCP range definition for user priority
2193 *
2194 * @low: lowest DSCP value of this user priority range, inclusive
2195 * @high: highest DSCP value of this user priority range, inclusive
2196 */
2197struct cfg80211_dscp_range {
2198        u8 low;
2199        u8 high;
2200};
2201
2202/* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2203#define IEEE80211_QOS_MAP_MAX_EX        21
2204#define IEEE80211_QOS_MAP_LEN_MIN       16
2205#define IEEE80211_QOS_MAP_LEN_MAX \
2206        (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2207
2208/**
2209 * struct cfg80211_qos_map - QoS Map Information
2210 *
2211 * This struct defines the Interworking QoS map setting for DSCP values
2212 *
2213 * @num_des: number of DSCP exceptions (0..21)
2214 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2215 *      the user priority DSCP range definition
2216 * @up: DSCP range definition for a particular user priority
2217 */
2218struct cfg80211_qos_map {
2219        u8 num_des;
2220        struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2221        struct cfg80211_dscp_range up[8];
2222};
2223
2224/**
2225 * struct cfg80211_ops - backend description for wireless configuration
2226 *
2227 * This struct is registered by fullmac card drivers and/or wireless stacks
2228 * in order to handle configuration requests on their interfaces.
2229 *
2230 * All callbacks except where otherwise noted should return 0
2231 * on success or a negative error code.
2232 *
2233 * All operations are currently invoked under rtnl for consistency with the
2234 * wireless extensions but this is subject to reevaluation as soon as this
2235 * code is used more widely and we have a first user without wext.
2236 *
2237 * @suspend: wiphy device needs to be suspended. The variable @wow will
2238 *      be %NULL or contain the enabled Wake-on-Wireless triggers that are
2239 *      configured for the device.
2240 * @resume: wiphy device needs to be resumed
2241 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
2242 *      to call device_set_wakeup_enable() to enable/disable wakeup from
2243 *      the device.
2244 *
2245 * @add_virtual_intf: create a new virtual interface with the given name,
2246 *      must set the struct wireless_dev's iftype. Beware: You must create
2247 *      the new netdev in the wiphy's network namespace! Returns the struct
2248 *      wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
2249 *      also set the address member in the wdev.
2250 *
2251 * @del_virtual_intf: remove the virtual interface
2252 *
2253 * @change_virtual_intf: change type/configuration of virtual interface,
2254 *      keep the struct wireless_dev's iftype updated.
2255 *
2256 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
2257 *      when adding a group key.
2258 *
2259 * @get_key: get information about the key with the given parameters.
2260 *      @mac_addr will be %NULL when requesting information for a group
2261 *      key. All pointers given to the @callback function need not be valid
2262 *      after it returns. This function should return an error if it is
2263 *      not possible to retrieve the key, -ENOENT if it doesn't exist.
2264 *
2265 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
2266 *      and @key_index, return -ENOENT if the key doesn't exist.
2267 *
2268 * @set_default_key: set the default key on an interface
2269 *
2270 * @set_default_mgmt_key: set the default management frame key on an interface
2271 *
2272 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
2273 *
2274 * @start_ap: Start acting in AP mode defined by the parameters.
2275 * @change_beacon: Change the beacon parameters for an access point mode
2276 *      interface. This should reject the call when AP mode wasn't started.
2277 * @stop_ap: Stop being an AP, including stopping beaconing.
2278 *
2279 * @add_station: Add a new station.
2280 * @del_station: Remove a station
2281 * @change_station: Modify a given station. Note that flags changes are not much
2282 *      validated in cfg80211, in particular the auth/assoc/authorized flags
2283 *      might come to the driver in invalid combinations -- make sure to check
2284 *      them, also against the existing state! Drivers must call
2285 *      cfg80211_check_station_change() to validate the information.
2286 * @get_station: get station information for the station identified by @mac
2287 * @dump_station: dump station callback -- resume dump at index @idx
2288 *
2289 * @add_mpath: add a fixed mesh path
2290 * @del_mpath: delete a given mesh path
2291 * @change_mpath: change a given mesh path
2292 * @get_mpath: get a mesh path for the given parameters
2293 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
2294 * @get_mpp: get a mesh proxy path for the given parameters
2295 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
2296 * @join_mesh: join the mesh network with the specified parameters
2297 *      (invoked with the wireless_dev mutex held)
2298 * @leave_mesh: leave the current mesh network
2299 *      (invoked with the wireless_dev mutex held)
2300 *
2301 * @get_mesh_config: Get the current mesh configuration
2302 *
2303 * @update_mesh_config: Update mesh parameters on a running mesh.
2304 *      The mask is a bitfield which tells us which parameters to
2305 *      set, and which to leave alone.
2306 *
2307 * @change_bss: Modify parameters for a given BSS.
2308 *
2309 * @set_txq_params: Set TX queue parameters
2310 *
2311 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
2312 *      as it doesn't implement join_mesh and needs to set the channel to
2313 *      join the mesh instead.
2314 *
2315 * @set_monitor_channel: Set the monitor mode channel for the device. If other
2316 *      interfaces are active this callback should reject the configuration.
2317 *      If no interfaces are active or the device is down, the channel should
2318 *      be stored for when a monitor interface becomes active.
2319 *
2320 * @scan: Request to do a scan. If returning zero, the scan request is given
2321 *      the driver, and will be valid until passed to cfg80211_scan_done().
2322 *      For scan results, call cfg80211_inform_bss(); you can call this outside
2323 *      the scan/scan_done bracket too.
2324 *
2325 * @auth: Request to authenticate with the specified peer
2326 *      (invoked with the wireless_dev mutex held)
2327 * @assoc: Request to (re)associate with the specified peer
2328 *      (invoked with the wireless_dev mutex held)
2329 * @deauth: Request to deauthenticate from the specified peer
2330 *      (invoked with the wireless_dev mutex held)
2331 * @disassoc: Request to disassociate from the specified peer
2332 *      (invoked with the wireless_dev mutex held)
2333 *
2334 * @connect: Connect to the ESS with the specified parameters. When connected,
2335 *      call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
2336 *      If the connection fails for some reason, call cfg80211_connect_result()
2337 *      with the status from the AP.
2338 *      (invoked with the wireless_dev mutex held)
2339 * @disconnect: Disconnect from the BSS/ESS.
2340 *      (invoked with the wireless_dev mutex held)
2341 *
2342 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
2343 *      cfg80211_ibss_joined(), also call that function when changing BSSID due
2344 *      to a merge.
2345 *      (invoked with the wireless_dev mutex held)
2346 * @leave_ibss: Leave the IBSS.
2347 *      (invoked with the wireless_dev mutex held)
2348 *
2349 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
2350 *      MESH mode)
2351 *
2352 * @set_wiphy_params: Notify that wiphy parameters have changed;
2353 *      @changed bitfield (see &enum wiphy_params_flags) describes which values
2354 *      have changed. The actual parameter values are available in
2355 *      struct wiphy. If returning an error, no value should be changed.
2356 *
2357 * @set_tx_power: set the transmit power according to the parameters,
2358 *      the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
2359 *      wdev may be %NULL if power was set for the wiphy, and will
2360 *      always be %NULL unless the driver supports per-vif TX power
2361 *      (as advertised by the nl80211 feature flag.)
2362 * @get_tx_power: store the current TX power into the dbm variable;
2363 *      return 0 if successful
2364 *
2365 * @set_wds_peer: set the WDS peer for a WDS interface
2366 *
2367 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
2368 *      functions to adjust rfkill hw state
2369 *
2370 * @dump_survey: get site survey information.
2371 *
2372 * @remain_on_channel: Request the driver to remain awake on the specified
2373 *      channel for the specified duration to complete an off-channel
2374 *      operation (e.g., public action frame exchange). When the driver is
2375 *      ready on the requested channel, it must indicate this with an event
2376 *      notification by calling cfg80211_ready_on_channel().
2377 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
2378 *      This allows the operation to be terminated prior to timeout based on
2379 *      the duration value.
2380 * @mgmt_tx: Transmit a management frame.
2381 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
2382 *      frame on another channel
2383 *
2384 * @testmode_cmd: run a test mode command; @wdev may be %NULL
2385 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
2386 *      used by the function, but 0 and 1 must not be touched. Additionally,
2387 *      return error codes other than -ENOBUFS and -ENOENT will terminate the
2388 *      dump and return to userspace with an error, so be careful. If any data
2389 *      was passed in from userspace then the data/len arguments will be present
2390 *      and point to the data contained in %NL80211_ATTR_TESTDATA.
2391 *
2392 * @set_bitrate_mask: set the bitrate mask configuration
2393 *
2394 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
2395 *      devices running firmwares capable of generating the (re) association
2396 *      RSN IE. It allows for faster roaming between WPA2 BSSIDs.
2397 * @del_pmksa: Delete a cached PMKID.
2398 * @flush_pmksa: Flush all cached PMKIDs.
2399 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
2400 *      allows the driver to adjust the dynamic ps timeout value.
2401 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
2402 *      After configuration, the driver should (soon) send an event indicating
2403 *      the current level is above/below the configured threshold; this may
2404 *      need some care when the configuration is changed (without first being
2405 *      disabled.)
2406 * @set_cqm_txe_config: Configure connection quality monitor TX error
2407 *      thresholds.
2408 * @sched_scan_start: Tell the driver to start a scheduled scan.
2409 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan. This
2410 *      call must stop the scheduled scan and be ready for starting a new one
2411 *      before it returns, i.e. @sched_scan_start may be called immediately
2412 *      after that again and should not fail in that case. The driver should
2413 *      not call cfg80211_sched_scan_stopped() for a requested stop (when this
2414 *      method returns 0.)
2415 *
2416 * @mgmt_frame_register: Notify driver that a management frame type was
2417 *      registered. The callback is allowed to sleep.
2418 *
2419 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2420 *      Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2421 *      reject TX/RX mask combinations they cannot support by returning -EINVAL
2422 *      (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2423 *
2424 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2425 *
2426 * @tdls_mgmt: Transmit a TDLS management frame.
2427 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
2428 *
2429 * @probe_client: probe an associated client, must return a cookie that it
2430 *      later passes to cfg80211_probe_status().
2431 *
2432 * @set_noack_map: Set the NoAck Map for the TIDs.
2433 *
2434 * @get_channel: Get the current operating channel for the virtual interface.
2435 *      For monitor interfaces, it should return %NULL unless there's a single
2436 *      current monitoring channel.
2437 *
2438 * @start_p2p_device: Start the given P2P device.
2439 * @stop_p2p_device: Stop the given P2P device.
2440 *
2441 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
2442 *      Parameters include ACL policy, an array of MAC address of stations
2443 *      and the number of MAC addresses. If there is already a list in driver
2444 *      this new list replaces the existing one. Driver has to clear its ACL
2445 *      when number of MAC addresses entries is passed as 0. Drivers which
2446 *      advertise the support for MAC based ACL have to implement this callback.
2447 *
2448 * @start_radar_detection: Start radar detection in the driver.
2449 *
2450 * @update_ft_ies: Provide updated Fast BSS Transition information to the
2451 *      driver. If the SME is in the driver/firmware, this information can be
2452 *      used in building Authentication and Reassociation Request frames.
2453 *
2454 * @crit_proto_start: Indicates a critical protocol needs more link reliability
2455 *      for a given duration (milliseconds). The protocol is provided so the
2456 *      driver can take the most appropriate actions.
2457 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
2458 *      reliability. This operation can not fail.
2459 * @set_coalesce: Set coalesce parameters.
2460 *
2461 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
2462 *      responsible for veryfing if the switch is possible. Since this is
2463 *      inherently tricky driver may decide to disconnect an interface later
2464 *      with cfg80211_stop_iface(). This doesn't mean driver can accept
2465 *      everything. It should do it's best to verify requests and reject them
2466 *      as soon as possible.
2467 *
2468 * @set_qos_map: Set QoS mapping information to the driver
2469 *
2470 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
2471 *      given interface This is used e.g. for dynamic HT 20/40 MHz channel width
2472 *      changes during the lifetime of the BSS.
2473 *
2474 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
2475 *      with the given parameters; action frame exchange has been handled by
2476 *      userspace so this just has to modify the TX path to take the TS into
2477 *      account.
2478 *      If the admitted time is 0 just validate the parameters to make sure
2479 *      the session can be created at all; it is valid to just always return
2480 *      success for that but that may result in inefficient behaviour (handshake
2481 *      with the peer followed by immediate teardown when the addition is later
2482 *      rejected)
2483 * @del_tx_ts: remove an existing TX TS
2484 *
2485 * @join_ocb: join the OCB network with the specified parameters
2486 *      (invoked with the wireless_dev mutex held)
2487 * @leave_ocb: leave the current OCB network
2488 *      (invoked with the wireless_dev mutex held)
2489 *
2490 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
2491 *      is responsible for continually initiating channel-switching operations
2492 *      and returning to the base channel for communication with the AP.
2493 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
2494 *      peers must be on the base channel when the call completes.
2495 */
2496struct cfg80211_ops {
2497        int     (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
2498        int     (*resume)(struct wiphy *wiphy);
2499        void    (*set_wakeup)(struct wiphy *wiphy, bool enabled);
2500
2501        struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
2502                                                  const char *name,
2503                                                  unsigned char name_assign_type,
2504                                                  enum nl80211_iftype type,
2505                                                  u32 *flags,
2506                                                  struct vif_params *params);
2507        int     (*del_virtual_intf)(struct wiphy *wiphy,
2508                                    struct wireless_dev *wdev);
2509        int     (*change_virtual_intf)(struct wiphy *wiphy,
2510                                       struct net_device *dev,
2511                                       enum nl80211_iftype type, u32 *flags,
2512                                       struct vif_params *params);
2513
2514        int     (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
2515                           u8 key_index, bool pairwise, const u8 *mac_addr,
2516                           struct key_params *params);
2517        int     (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
2518                           u8 key_index, bool pairwise, const u8 *mac_addr,
2519                           void *cookie,
2520                           void (*callback)(void *cookie, struct key_params*));
2521        int     (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
2522                           u8 key_index, bool pairwise, const u8 *mac_addr);
2523        int     (*set_default_key)(struct wiphy *wiphy,
2524                                   struct net_device *netdev,
2525                                   u8 key_index, bool unicast, bool multicast);
2526        int     (*set_default_mgmt_key)(struct wiphy *wiphy,
2527                                        struct net_device *netdev,
2528                                        u8 key_index);
2529
2530        int     (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
2531                            struct cfg80211_ap_settings *settings);
2532        int     (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
2533                                 struct cfg80211_beacon_data *info);
2534        int     (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
2535
2536
2537        int     (*add_station)(struct wiphy *wiphy, struct net_device *dev,
2538                               const u8 *mac,
2539                               struct station_parameters *params);
2540        int     (*del_station)(struct wiphy *wiphy, struct net_device *dev,
2541                               struct station_del_parameters *params);
2542        int     (*change_station)(struct wiphy *wiphy, struct net_device *dev,
2543                                  const u8 *mac,
2544                                  struct station_parameters *params);
2545        int     (*get_station)(struct wiphy *wiphy, struct net_device *dev,
2546                               const u8 *mac, struct station_info *sinfo);
2547        int     (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
2548                                int idx, u8 *mac, struct station_info *sinfo);
2549
2550        int     (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
2551                               const u8 *dst, const u8 *next_hop);
2552        int     (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
2553                               const u8 *dst);
2554        int     (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
2555                                  const u8 *dst, const u8 *next_hop);
2556        int     (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
2557                             u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
2558        int     (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
2559                              int idx, u8 *dst, u8 *next_hop,
2560                              struct mpath_info *pinfo);
2561        int     (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
2562                           u8 *dst, u8 *mpp, struct mpath_info *pinfo);
2563        int     (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
2564                            int idx, u8 *dst, u8 *mpp,
2565                            struct mpath_info *pinfo);
2566        int     (*get_mesh_config)(struct wiphy *wiphy,
2567                                struct net_device *dev,
2568                                struct mesh_config *conf);
2569        int     (*update_mesh_config)(struct wiphy *wiphy,
2570                                      struct net_device *dev, u32 mask,
2571                                      const struct mesh_config *nconf);
2572        int     (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
2573                             const struct mesh_config *conf,
2574                             const struct mesh_setup *setup);
2575        int     (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
2576
2577        int     (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
2578                            struct ocb_setup *setup);
2579        int     (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
2580
2581        int     (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
2582                              struct bss_parameters *params);
2583
2584        int     (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
2585                                  struct ieee80211_txq_params *params);
2586
2587        int     (*libertas_set_mesh_channel)(struct wiphy *wiphy,
2588                                             struct net_device *dev,
2589                                             struct ieee80211_channel *chan);
2590
2591        int     (*set_monitor_channel)(struct wiphy *wiphy,
2592                                       struct cfg80211_chan_def *chandef);
2593
2594        int     (*scan)(struct wiphy *wiphy,
2595                        struct cfg80211_scan_request *request);
2596
2597        int     (*auth)(struct wiphy *wiphy, struct net_device *dev,
2598                        struct cfg80211_auth_request *req);
2599        int     (*assoc)(struct wiphy *wiphy, struct net_device *dev,
2600                         struct cfg80211_assoc_request *req);
2601        int     (*deauth)(struct wiphy *wiphy, struct net_device *dev,
2602                          struct cfg80211_deauth_request *req);
2603        int     (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
2604                            struct cfg80211_disassoc_request *req);
2605
2606        int     (*connect)(struct wiphy *wiphy, struct net_device *dev,
2607                           struct cfg80211_connect_params *sme);
2608        int     (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
2609                              u16 reason_code);
2610
2611        int     (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
2612                             struct cfg80211_ibss_params *params);
2613        int     (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
2614
2615        int     (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
2616                                  int rate[IEEE80211_NUM_BANDS]);
2617
2618        int     (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
2619
2620        int     (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2621                                enum nl80211_tx_power_setting type, int mbm);
2622        int     (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2623                                int *dbm);
2624
2625        int     (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
2626                                const u8 *addr);
2627
2628        void    (*rfkill_poll)(struct wiphy *wiphy);
2629
2630#ifdef CONFIG_NL80211_TESTMODE
2631        int     (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
2632                                void *data, int len);
2633        int     (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
2634                                 struct netlink_callback *cb,
2635                                 void *data, int len);
2636#endif
2637
2638        int     (*set_bitrate_mask)(struct wiphy *wiphy,
2639                                    struct net_device *dev,
2640                                    const u8 *peer,
2641                                    const struct cfg80211_bitrate_mask *mask);
2642
2643        int     (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
2644                        int idx, struct survey_info *info);
2645
2646        int     (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2647                             struct cfg80211_pmksa *pmksa);
2648        int     (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2649                             struct cfg80211_pmksa *pmksa);
2650        int     (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
2651
2652        int     (*remain_on_channel)(struct wiphy *wiphy,
2653                                     struct wireless_dev *wdev,
2654                                     struct ieee80211_channel *chan,
2655                                     unsigned int duration,
2656                                     u64 *cookie);
2657        int     (*cancel_remain_on_channel)(struct wiphy *wiphy,
2658                                            struct wireless_dev *wdev,
2659                                            u64 cookie);
2660
2661        int     (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
2662                           struct cfg80211_mgmt_tx_params *params,
2663                           u64 *cookie);
2664        int     (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
2665                                       struct wireless_dev *wdev,
2666                                       u64 cookie);
2667
2668        int     (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2669                                  bool enabled, int timeout);
2670
2671        int     (*set_cqm_rssi_config)(struct wiphy *wiphy,
2672                                       struct net_device *dev,
2673                                       s32 rssi_thold, u32 rssi_hyst);
2674
2675        int     (*set_cqm_txe_config)(struct wiphy *wiphy,
2676                                      struct net_device *dev,
2677                                      u32 rate, u32 pkts, u32 intvl);
2678
2679        void    (*mgmt_frame_register)(struct wiphy *wiphy,
2680                                       struct wireless_dev *wdev,
2681                                       u16 frame_type, bool reg);
2682
2683        int     (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
2684        int     (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
2685
2686        int     (*sched_scan_start)(struct wiphy *wiphy,
2687                                struct net_device *dev,
2688                                struct cfg80211_sched_scan_request *request);
2689        int     (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
2690
2691        int     (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
2692                                  struct cfg80211_gtk_rekey_data *data);
2693
2694        int     (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2695                             const u8 *peer, u8 action_code,  u8 dialog_token,
2696                             u16 status_code, u32 peer_capability,
2697                             bool initiator, const u8 *buf, size_t len);
2698        int     (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
2699                             const u8 *peer, enum nl80211_tdls_operation oper);
2700
2701        int     (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
2702                                const u8 *peer, u64 *cookie);
2703
2704        int     (*set_noack_map)(struct wiphy *wiphy,
2705                                  struct net_device *dev,
2706                                  u16 noack_map);
2707
2708        int     (*get_channel)(struct wiphy *wiphy,
2709                               struct wireless_dev *wdev,
2710                               struct cfg80211_chan_def *chandef);
2711
2712        int     (*start_p2p_device)(struct wiphy *wiphy,
2713                                    struct wireless_dev *wdev);
2714        void    (*stop_p2p_device)(struct wiphy *wiphy,
2715                                   struct wireless_dev *wdev);
2716
2717        int     (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
2718                               const struct cfg80211_acl_data *params);
2719
2720        int     (*start_radar_detection)(struct wiphy *wiphy,
2721                                         struct net_device *dev,
2722                                         struct cfg80211_chan_def *chandef,
2723                                         u32 cac_time_ms);
2724        int     (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
2725                                 struct cfg80211_update_ft_ies_params *ftie);
2726        int     (*crit_proto_start)(struct wiphy *wiphy,
2727                                    struct wireless_dev *wdev,
2728                                    enum nl80211_crit_proto_id protocol,
2729                                    u16 duration);
2730        void    (*crit_proto_stop)(struct wiphy *wiphy,
2731                                   struct wireless_dev *wdev);
2732        int     (*set_coalesce)(struct wiphy *wiphy,
2733                                struct cfg80211_coalesce *coalesce);
2734
2735        int     (*channel_switch)(struct wiphy *wiphy,
2736                                  struct net_device *dev,
2737                                  struct cfg80211_csa_settings *params);
2738
2739        int     (*set_qos_map)(struct wiphy *wiphy,
2740                               struct net_device *dev,
2741                               struct cfg80211_qos_map *qos_map);
2742
2743        int     (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
2744                                    struct cfg80211_chan_def *chandef);
2745
2746        int     (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
2747                             u8 tsid, const u8 *peer, u8 user_prio,
2748                             u16 admitted_time);
2749        int     (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
2750                             u8 tsid, const u8 *peer);
2751
2752        int     (*tdls_channel_switch)(struct wiphy *wiphy,
2753                                       struct net_device *dev,
2754                                       const u8 *addr, u8 oper_class,
2755                                       struct cfg80211_chan_def *chandef);
2756        void    (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
2757                                              struct net_device *dev,
2758                                              const u8 *addr);
2759};
2760
2761/*
2762 * wireless hardware and networking interfaces structures
2763 * and registration/helper functions
2764 */
2765
2766/**
2767 * enum wiphy_flags - wiphy capability flags
2768 *
2769 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
2770 *      wiphy at all
2771 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
2772 *      by default -- this flag will be set depending on the kernel's default
2773 *      on wiphy_new(), but can be changed by the driver if it has a good
2774 *      reason to override the default
2775 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
2776 *      on a VLAN interface)
2777 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
2778 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
2779 *      control port protocol ethertype. The device also honours the
2780 *      control_port_no_encrypt flag.
2781 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
2782 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
2783 *      auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
2784 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
2785 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
2786 *      firmware.
2787 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
2788 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
2789 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
2790 *      link setup/discovery operations internally. Setup, discovery and
2791 *      teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
2792 *      command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
2793 *      used for asking the driver/firmware to perform a TDLS operation.
2794 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
2795 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
2796 *      when there are virtual interfaces in AP mode by calling
2797 *      cfg80211_report_obss_beacon().
2798 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
2799 *      responds to probe-requests in hardware.
2800 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
2801 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
2802 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
2803 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
2804 *      beaconing mode (AP, IBSS, Mesh, ...).
2805 */
2806enum wiphy_flags {
2807        /* use hole at 0 */
2808        /* use hole at 1 */
2809        /* use hole at 2 */
2810        WIPHY_FLAG_NETNS_OK                     = BIT(3),
2811        WIPHY_FLAG_PS_ON_BY_DEFAULT             = BIT(4),
2812        WIPHY_FLAG_4ADDR_AP                     = BIT(5),
2813        WIPHY_FLAG_4ADDR_STATION                = BIT(6),
2814        WIPHY_FLAG_CONTROL_PORT_PROTOCOL        = BIT(7),
2815        WIPHY_FLAG_IBSS_RSN                     = BIT(8),
2816        WIPHY_FLAG_MESH_AUTH                    = BIT(10),
2817        WIPHY_FLAG_SUPPORTS_SCHED_SCAN          = BIT(11),
2818        /* use hole at 12 */
2819        WIPHY_FLAG_SUPPORTS_FW_ROAM             = BIT(13),
2820        WIPHY_FLAG_AP_UAPSD                     = BIT(14),
2821        WIPHY_FLAG_SUPPORTS_TDLS                = BIT(15),
2822        WIPHY_FLAG_TDLS_EXTERNAL_SETUP          = BIT(16),
2823        WIPHY_FLAG_HAVE_AP_SME                  = BIT(17),
2824        WIPHY_FLAG_REPORTS_OBSS                 = BIT(18),
2825        WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD        = BIT(19),
2826        WIPHY_FLAG_OFFCHAN_TX                   = BIT(20),
2827        WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL        = BIT(21),
2828        WIPHY_FLAG_SUPPORTS_5_10_MHZ            = BIT(22),
2829        WIPHY_FLAG_HAS_CHANNEL_SWITCH           = BIT(23),
2830};
2831
2832/**
2833 * struct ieee80211_iface_limit - limit on certain interface types
2834 * @max: maximum number of interfaces of these types
2835 * @types: interface types (bits)
2836 */
2837struct ieee80211_iface_limit {
2838        u16 max;
2839        u16 types;
2840};
2841
2842/**
2843 * struct ieee80211_iface_combination - possible interface combination
2844 * @limits: limits for the given interface types
2845 * @n_limits: number of limitations
2846 * @num_different_channels: can use up to this many different channels
2847 * @max_interfaces: maximum number of interfaces in total allowed in this
2848 *      group
2849 * @beacon_int_infra_match: In this combination, the beacon intervals
2850 *      between infrastructure and AP types must match. This is required
2851 *      only in special cases.
2852 * @radar_detect_widths: bitmap of channel widths supported for radar detection
2853 * @radar_detect_regions: bitmap of regions supported for radar detection
2854 *
2855 * With this structure the driver can describe which interface
2856 * combinations it supports concurrently.
2857 *
2858 * Examples:
2859 *
2860 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
2861 *
2862 *  struct ieee80211_iface_limit limits1[] = {
2863 *      { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2864 *      { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
2865 *  };
2866 *  struct ieee80211_iface_combination combination1 = {
2867 *      .limits = limits1,
2868 *      .n_limits = ARRAY_SIZE(limits1),
2869 *      .max_interfaces = 2,
2870 *      .beacon_int_infra_match = true,
2871 *  };
2872 *
2873 *
2874 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
2875 *
2876 *  struct ieee80211_iface_limit limits2[] = {
2877 *      { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
2878 *                           BIT(NL80211_IFTYPE_P2P_GO), },
2879 *  };
2880 *  struct ieee80211_iface_combination combination2 = {
2881 *      .limits = limits2,
2882 *      .n_limits = ARRAY_SIZE(limits2),
2883 *      .max_interfaces = 8,
2884 *      .num_different_channels = 1,
2885 *  };
2886 *
2887 *
2888 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
2889 *
2890 * This allows for an infrastructure connection and three P2P connections.
2891 *
2892 *  struct ieee80211_iface_limit limits3[] = {
2893 *      { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2894 *      { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
2895 *                           BIT(NL80211_IFTYPE_P2P_CLIENT), },
2896 *  };
2897 *  struct ieee80211_iface_combination combination3 = {
2898 *      .limits = limits3,
2899 *      .n_limits = ARRAY_SIZE(limits3),
2900 *      .max_interfaces = 4,
2901 *      .num_different_channels = 2,
2902 *  };
2903 */
2904struct ieee80211_iface_combination {
2905        const struct ieee80211_iface_limit *limits;
2906        u32 num_different_channels;
2907        u16 max_interfaces;
2908        u8 n_limits;
2909        bool beacon_int_infra_match;
2910        u8 radar_detect_widths;
2911        u8 radar_detect_regions;
2912};
2913
2914struct ieee80211_txrx_stypes {
2915        u16 tx, rx;
2916};
2917
2918/**
2919 * enum wiphy_wowlan_support_flags - WoWLAN support flags
2920 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
2921 *      trigger that keeps the device operating as-is and
2922 *      wakes up the host on any activity, for example a
2923 *      received packet that passed filtering; note that the
2924 *      packet should be preserved in that case
2925 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
2926 *      (see nl80211.h)
2927 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
2928 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
2929 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
2930 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
2931 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
2932 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
2933 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
2934 */
2935enum wiphy_wowlan_support_flags {
2936        WIPHY_WOWLAN_ANY                = BIT(0),
2937        WIPHY_WOWLAN_MAGIC_PKT          = BIT(1),
2938        WIPHY_WOWLAN_DISCONNECT         = BIT(2),
2939        WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
2940        WIPHY_WOWLAN_GTK_REKEY_FAILURE  = BIT(4),
2941        WIPHY_WOWLAN_EAP_IDENTITY_REQ   = BIT(5),
2942        WIPHY_WOWLAN_4WAY_HANDSHAKE     = BIT(6),
2943        WIPHY_WOWLAN_RFKILL_RELEASE     = BIT(7),
2944        WIPHY_WOWLAN_NET_DETECT         = BIT(8),
2945};
2946
2947struct wiphy_wowlan_tcp_support {
2948        const struct nl80211_wowlan_tcp_data_token_feature *tok;
2949        u32 data_payload_max;
2950        u32 data_interval_max;
2951        u32 wake_payload_max;
2952        bool seq;
2953};
2954
2955/**
2956 * struct wiphy_wowlan_support - WoWLAN support data
2957 * @flags: see &enum wiphy_wowlan_support_flags
2958 * @n_patterns: number of supported wakeup patterns
2959 *      (see nl80211.h for the pattern definition)
2960 * @pattern_max_len: maximum length of each pattern
2961 * @pattern_min_len: minimum length of each pattern
2962 * @max_pkt_offset: maximum Rx packet offset
2963 * @max_nd_match_sets: maximum number of matchsets for net-detect,
2964 *      similar, but not necessarily identical, to max_match_sets for
2965 *      scheduled scans.
2966 *      See &struct cfg80211_sched_scan_request.@match_sets for more
2967 *      details.
2968 * @tcp: TCP wakeup support information
2969 */
2970struct wiphy_wowlan_support {
2971        u32 flags;
2972        int n_patterns;
2973        int pattern_max_len;
2974        int pattern_min_len;
2975        int max_pkt_offset;
2976        int max_nd_match_sets;
2977        const struct wiphy_wowlan_tcp_support *tcp;
2978};
2979
2980/**
2981 * struct wiphy_coalesce_support - coalesce support data
2982 * @n_rules: maximum number of coalesce rules
2983 * @max_delay: maximum supported coalescing delay in msecs
2984 * @n_patterns: number of supported patterns in a rule
2985 *      (see nl80211.h for the pattern definition)
2986 * @pattern_max_len: maximum length of each pattern
2987 * @pattern_min_len: minimum length of each pattern
2988 * @max_pkt_offset: maximum Rx packet offset
2989 */
2990struct wiphy_coalesce_support {
2991        int n_rules;
2992        int max_delay;
2993        int n_patterns;
2994        int pattern_max_len;
2995        int pattern_min_len;
2996        int max_pkt_offset;
2997};
2998
2999/**
3000 * enum wiphy_vendor_command_flags - validation flags for vendor commands
3001 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
3002 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
3003 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
3004 *      (must be combined with %_WDEV or %_NETDEV)
3005 */
3006enum wiphy_vendor_command_flags {
3007        WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
3008        WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
3009        WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
3010};
3011
3012/**
3013 * struct wiphy_vendor_command - vendor command definition
3014 * @info: vendor command identifying information, as used in nl80211
3015 * @flags: flags, see &enum wiphy_vendor_command_flags
3016 * @doit: callback for the operation, note that wdev is %NULL if the
3017 *      flags didn't ask for a wdev and non-%NULL otherwise; the data
3018 *      pointer may be %NULL if userspace provided no data at all
3019 * @dumpit: dump callback, for transferring bigger/multiple items. The
3020 *      @storage points to cb->args[5], ie. is preserved over the multiple
3021 *      dumpit calls.
3022 * It's recommended to not have the same sub command with both @doit and
3023 * @dumpit, so that userspace can assume certain ones are get and others
3024 * are used with dump requests.
3025 */
3026struct wiphy_vendor_command {
3027        struct nl80211_vendor_cmd_info info;
3028        u32 flags;
3029        int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3030                    const void *data, int data_len);
3031        int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3032                      struct sk_buff *skb, const void *data, int data_len,
3033                      unsigned long *storage);
3034};
3035
3036/**
3037 * struct wiphy - wireless hardware description
3038 * @reg_notifier: the driver's regulatory notification callback,
3039 *      note that if your driver uses wiphy_apply_custom_regulatory()
3040 *      the reg_notifier's request can be passed as NULL
3041 * @regd: the driver's regulatory domain, if one was requested via
3042 *      the regulatory_hint() API. This can be used by the driver
3043 *      on the reg_notifier() if it chooses to ignore future
3044 *      regulatory domain changes caused by other drivers.
3045 * @signal_type: signal type reported in &struct cfg80211_bss.
3046 * @cipher_suites: supported cipher suites
3047 * @n_cipher_suites: number of supported cipher suites
3048 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
3049 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
3050 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
3051 *      -1 = fragmentation disabled, only odd values >= 256 used
3052 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
3053 * @_net: the network namespace this wiphy currently lives in
3054 * @perm_addr: permanent MAC address of this device
3055 * @addr_mask: If the device supports multiple MAC addresses by masking,
3056 *      set this to a mask with variable bits set to 1, e.g. if the last
3057 *      four bits are variable then set it to 00-00-00-00-00-0f. The actual
3058 *      variable bits shall be determined by the interfaces added, with
3059 *      interfaces not matching the mask being rejected to be brought up.
3060 * @n_addresses: number of addresses in @addresses.
3061 * @addresses: If the device has more than one address, set this pointer
3062 *      to a list of addresses (6 bytes each). The first one will be used
3063 *      by default for perm_addr. In this case, the mask should be set to
3064 *      all-zeroes. In this case it is assumed that the device can handle
3065 *      the same number of arbitrary MAC addresses.
3066 * @registered: protects ->resume and ->suspend sysfs callbacks against
3067 *      unregister hardware
3068 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
3069 *      automatically on wiphy renames
3070 * @dev: (virtual) struct device for this wiphy
3071 * @registered: helps synchronize suspend/resume with wiphy unregister
3072 * @wext: wireless extension handlers
3073 * @priv: driver private data (sized according to wiphy_new() parameter)
3074 * @interface_modes: bitmask of interfaces types valid for this wiphy,
3075 *      must be set by driver
3076 * @iface_combinations: Valid interface combinations array, should not
3077 *      list single interface types.
3078 * @n_iface_combinations: number of entries in @iface_combinations array.
3079 * @software_iftypes: bitmask of software interface types, these are not
3080 *      subject to any restrictions since they are purely managed in SW.
3081 * @flags: wiphy flags, see &enum wiphy_flags
3082 * @regulatory_flags: wiphy regulatory flags, see
3083 *      &enum ieee80211_regulatory_flags
3084 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
3085 * @ext_features: extended features advertised to nl80211, see
3086 *      &enum nl80211_ext_feature_index.
3087 * @bss_priv_size: each BSS struct has private data allocated with it,
3088 *      this variable determines its size
3089 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
3090 *      any given scan
3091 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
3092 *      for in any given scheduled scan
3093 * @max_match_sets: maximum number of match sets the device can handle
3094 *      when performing a scheduled scan, 0 if filtering is not
3095 *      supported.
3096 * @max_scan_ie_len: maximum length of user-controlled IEs device can
3097 *      add to probe request frames transmitted during a scan, must not
3098 *      include fixed IEs like supported rates
3099 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
3100 *      scans
3101 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
3102 *      of iterations) for scheduled scan supported by the device.
3103 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
3104 *      single scan plan supported by the device.
3105 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
3106 *      scan plan supported by the device.
3107 * @coverage_class: current coverage class
3108 * @fw_version: firmware version for ethtool reporting
3109 * @hw_version: hardware version for ethtool reporting
3110 * @max_num_pmkids: maximum number of PMKIDs supported by device
3111 * @privid: a pointer that drivers can use to identify if an arbitrary
3112 *      wiphy is theirs, e.g. in global notifiers
3113 * @bands: information about bands/channels supported by this device
3114 *
3115 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
3116 *      transmitted through nl80211, points to an array indexed by interface
3117 *      type
3118 *
3119 * @available_antennas_tx: bitmap of antennas which are available to be
3120 *      configured as TX antennas. Antenna configuration commands will be
3121 *      rejected unless this or @available_antennas_rx is set.
3122 *
3123 * @available_antennas_rx: bitmap of antennas which are available to be
3124 *      configured as RX antennas. Antenna configuration commands will be
3125 *      rejected unless this or @available_antennas_tx is set.
3126 *
3127 * @probe_resp_offload:
3128 *       Bitmap of supported protocols for probe response offloading.
3129 *       See &enum nl80211_probe_resp_offload_support_attr. Only valid
3130 *       when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3131 *
3132 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
3133 *      may request, if implemented.
3134 *
3135 * @wowlan: WoWLAN support information
3136 * @wowlan_config: current WoWLAN configuration; this should usually not be
3137 *      used since access to it is necessarily racy, use the parameter passed
3138 *      to the suspend() operation instead.
3139 *
3140 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
3141 * @ht_capa_mod_mask:  Specify what ht_cap values can be over-ridden.
3142 *      If null, then none can be over-ridden.
3143 * @vht_capa_mod_mask:  Specify what VHT capabilities can be over-ridden.
3144 *      If null, then none can be over-ridden.
3145 *
3146 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
3147 *      supports for ACL.
3148 *
3149 * @extended_capabilities: extended capabilities supported by the driver,
3150 *      additional capabilities might be supported by userspace; these are
3151 *      the 802.11 extended capabilities ("Extended Capabilities element")
3152 *      and are in the same format as in the information element. See
3153 *      802.11-2012 8.4.2.29 for the defined fields.
3154 * @extended_capabilities_mask: mask of the valid values
3155 * @extended_capabilities_len: length of the extended capabilities
3156 * @coalesce: packet coalescing support information
3157 *
3158 * @vendor_commands: array of vendor commands supported by the hardware
3159 * @n_vendor_commands: number of vendor commands
3160 * @vendor_events: array of vendor events supported by the hardware
3161 * @n_vendor_events: number of vendor events
3162 *
3163 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
3164 *      (including P2P GO) or 0 to indicate no such limit is advertised. The
3165 *      driver is allowed to advertise a theoretical limit that it can reach in
3166 *      some cases, but may not always reach.
3167 *
3168 * @max_num_csa_counters: Number of supported csa_counters in beacons
3169 *      and probe responses.  This value should be set if the driver
3170 *      wishes to limit the number of csa counters. Default (0) means
3171 *      infinite.
3172 * @max_adj_channel_rssi_comp: max offset of between the channel on which the
3173 *      frame was sent and the channel on which the frame was heard for which
3174 *      the reported rssi is still valid. If a driver is able to compensate the
3175 *      low rssi when a frame is heard on different channel, then it should set
3176 *      this variable to the maximal offset for which it can compensate.
3177 *      This value should be set in MHz.
3178 */
3179struct wiphy {
3180        /* assign these fields before you register the wiphy */
3181
3182        /* permanent MAC address(es) */
3183        u8 perm_addr[ETH_ALEN];
3184        u8 addr_mask[ETH_ALEN];
3185
3186        struct mac_address *addresses;
3187
3188        const struct ieee80211_txrx_stypes *mgmt_stypes;
3189
3190        const struct ieee80211_iface_combination *iface_combinations;
3191        int n_iface_combinations;
3192        u16 software_iftypes;
3193
3194        u16 n_addresses;
3195
3196        /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
3197        u16 interface_modes;
3198
3199        u16 max_acl_mac_addrs;
3200
3201        u32 flags, regulatory_flags, features;
3202        u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
3203
3204        u32 ap_sme_capa;
3205
3206        enum cfg80211_signal_type signal_type;
3207
3208        int bss_priv_size;
3209        u8 max_scan_ssids;
3210        u8 max_sched_scan_ssids;
3211        u8 max_match_sets;
3212        u16 max_scan_ie_len;
3213        u16 max_sched_scan_ie_len;
3214        u32 max_sched_scan_plans;
3215        u32 max_sched_scan_plan_interval;
3216        u32 max_sched_scan_plan_iterations;
3217
3218        int n_cipher_suites;
3219        const u32 *cipher_suites;
3220
3221        u8 retry_short;
3222        u8 retry_long;
3223        u32 frag_threshold;
3224        u32 rts_threshold;
3225        u8 coverage_class;
3226
3227        char fw_version[ETHTOOL_FWVERS_LEN];
3228        u32 hw_version;
3229
3230#ifdef CONFIG_PM
3231        const struct wiphy_wowlan_support *wowlan;
3232        struct cfg80211_wowlan *wowlan_config;
3233#endif
3234
3235        u16 max_remain_on_channel_duration;
3236
3237        u8 max_num_pmkids;
3238
3239        u32 available_antennas_tx;
3240        u32 available_antennas_rx;
3241
3242        /*
3243         * Bitmap of supported protocols for probe response offloading
3244         * see &enum nl80211_probe_resp_offload_support_attr. Only valid
3245         * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3246         */
3247        u32 probe_resp_offload;
3248
3249        const u8 *extended_capabilities, *extended_capabilities_mask;
3250        u8 extended_capabilities_len;
3251
3252        /* If multiple wiphys are registered and you're handed e.g.
3253         * a regular netdev with assigned ieee80211_ptr, you won't
3254         * know whether it points to a wiphy your driver has registered
3255         * or not. Assign this to something global to your driver to
3256         * help determine whether you own this wiphy or not. */
3257        const void *privid;
3258
3259        struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
3260
3261        /* Lets us get back the wiphy on the callback */
3262        void (*reg_notifier)(struct wiphy *wiphy,
3263                             struct regulatory_request *request);
3264
3265        /* fields below are read-only, assigned by cfg80211 */
3266
3267        const struct ieee80211_regdomain __rcu *regd;
3268
3269        /* the item in /sys/class/ieee80211/ points to this,
3270         * you need use set_wiphy_dev() (see below) */
3271        struct device dev;
3272
3273        /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
3274        bool registered;
3275
3276        /* dir in debugfs: ieee80211/<wiphyname> */
3277        struct dentry *debugfsdir;
3278
3279        const struct ieee80211_ht_cap *ht_capa_mod_mask;
3280        const struct ieee80211_vht_cap *vht_capa_mod_mask;
3281
3282        /* the network namespace this phy lives in currently */
3283        possible_net_t _net;
3284
3285#ifdef CONFIG_CFG80211_WEXT
3286        const struct iw_handler_def *wext;
3287#endif
3288
3289        const struct wiphy_coalesce_support *coalesce;
3290
3291        const struct wiphy_vendor_command *vendor_commands;
3292        const struct nl80211_vendor_cmd_info *vendor_events;
3293        int n_vendor_commands, n_vendor_events;
3294
3295        u16 max_ap_assoc_sta;
3296
3297        u8 max_num_csa_counters;
3298        u8 max_adj_channel_rssi_comp;
3299
3300        char priv[0] __aligned(NETDEV_ALIGN);
3301};
3302
3303static inline struct net *wiphy_net(struct wiphy *wiphy)
3304{
3305        return read_pnet(&wiphy->_net);
3306}
3307
3308static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
3309{
3310        write_pnet(&wiphy->_net, net);
3311}
3312
3313/**
3314 * wiphy_priv - return priv from wiphy
3315 *
3316 * @wiphy: the wiphy whose priv pointer to return
3317 * Return: The priv of @wiphy.
3318 */
3319static inline void *wiphy_priv(struct wiphy *wiphy)
3320{
3321        BUG_ON(!wiphy);
3322        return &wiphy->priv;
3323}
3324
3325/**
3326 * priv_to_wiphy - return the wiphy containing the priv
3327 *
3328 * @priv: a pointer previously returned by wiphy_priv
3329 * Return: The wiphy of @priv.
3330 */
3331static inline struct wiphy *priv_to_wiphy(void *priv)
3332{
3333        BUG_ON(!priv);
3334        return container_of(priv, struct wiphy, priv);
3335}
3336
3337/**
3338 * set_wiphy_dev - set device pointer for wiphy
3339 *
3340 * @wiphy: The wiphy whose device to bind
3341 * @dev: The device to parent it to
3342 */
3343static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
3344{
3345        wiphy->dev.parent = dev;
3346}
3347
3348/**
3349 * wiphy_dev - get wiphy dev pointer
3350 *
3351 * @wiphy: The wiphy whose device struct to look up
3352 * Return: The dev of @wiphy.
3353 */
3354static inline struct device *wiphy_dev(struct wiphy *wiphy)
3355{
3356        return wiphy->dev.parent;
3357}
3358
3359/**
3360 * wiphy_name - get wiphy name
3361 *
3362 * @wiphy: The wiphy whose name to return
3363 * Return: The name of @wiphy.
3364 */
3365static inline const char *wiphy_name(const struct wiphy *wiphy)
3366{
3367        return dev_name(&wiphy->dev);
3368}
3369
3370/**
3371 * wiphy_new_nm - create a new wiphy for use with cfg80211
3372 *
3373 * @ops: The configuration operations for this device
3374 * @sizeof_priv: The size of the private area to allocate
3375 * @requested_name: Request a particular name.
3376 *      NULL is valid value, and means use the default phy%d naming.
3377 *
3378 * Create a new wiphy and associate the given operations with it.
3379 * @sizeof_priv bytes are allocated for private use.
3380 *
3381 * Return: A pointer to the new wiphy. This pointer must be
3382 * assigned to each netdev's ieee80211_ptr for proper operation.
3383 */
3384struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
3385                           const char *requested_name);
3386
3387/**
3388 * wiphy_new - create a new wiphy for use with cfg80211
3389 *
3390 * @ops: The configuration operations for this device
3391 * @sizeof_priv: The size of the private area to allocate
3392 *
3393 * Create a new wiphy and associate the given operations with it.
3394 * @sizeof_priv bytes are allocated for private use.
3395 *
3396 * Return: A pointer to the new wiphy. This pointer must be
3397 * assigned to each netdev's ieee80211_ptr for proper operation.
3398 */
3399static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
3400                                      int sizeof_priv)
3401{
3402        return wiphy_new_nm(ops, sizeof_priv, NULL);
3403}
3404
3405/**
3406 * wiphy_register - register a wiphy with cfg80211
3407 *
3408 * @wiphy: The wiphy to register.
3409 *
3410 * Return: A non-negative wiphy index or a negative error code.
3411 */
3412int wiphy_register(struct wiphy *wiphy);
3413
3414/**
3415 * wiphy_unregister - deregister a wiphy from cfg80211
3416 *
3417 * @wiphy: The wiphy to unregister.
3418 *
3419 * After this call, no more requests can be made with this priv
3420 * pointer, but the call may sleep to wait for an outstanding
3421 * request that is being handled.
3422 */
3423void wiphy_unregister(struct wiphy *wiphy);
3424
3425/**
3426 * wiphy_free - free wiphy
3427 *
3428 * @wiphy: The wiphy to free
3429 */
3430void wiphy_free(struct wiphy *wiphy);
3431
3432/* internal structs */
3433struct cfg80211_conn;
3434struct cfg80211_internal_bss;
3435struct cfg80211_cached_keys;
3436
3437/**
3438 * struct wireless_dev - wireless device state
3439 *
3440 * For netdevs, this structure must be allocated by the driver
3441 * that uses the ieee80211_ptr field in struct net_device (this
3442 * is intentional so it can be allocated along with the netdev.)
3443 * It need not be registered then as netdev registration will
3444 * be intercepted by cfg80211 to see the new wireless device.
3445 *
3446 * For non-netdev uses, it must also be allocated by the driver
3447 * in response to the cfg80211 callbacks that require it, as
3448 * there's no netdev registration in that case it may not be
3449 * allocated outside of callback operations that return it.
3450 *
3451 * @wiphy: pointer to hardware description
3452 * @iftype: interface type
3453 * @list: (private) Used to collect the interfaces
3454 * @netdev: (private) Used to reference back to the netdev, may be %NULL
3455 * @identifier: (private) Identifier used in nl80211 to identify this
3456 *      wireless device if it has no netdev
3457 * @current_bss: (private) Used by the internal configuration code
3458 * @chandef: (private) Used by the internal configuration code to track
3459 *      the user-set channel definition.
3460 * @preset_chandef: (private) Used by the internal configuration code to
3461 *      track the channel to be used for AP later
3462 * @bssid: (private) Used by the internal configuration code
3463 * @ssid: (private) Used by the internal configuration code
3464 * @ssid_len: (private) Used by the internal configuration code
3465 * @mesh_id_len: (private) Used by the internal configuration code
3466 * @mesh_id_up_len: (private) Used by the internal configuration code
3467 * @wext: (private) Used by the internal wireless extensions compat code
3468 * @use_4addr: indicates 4addr mode is used on this interface, must be
3469 *      set by driver (if supported) on add_interface BEFORE registering the
3470 *      netdev and may otherwise be used by driver read-only, will be update
3471 *      by cfg80211 on change_interface
3472 * @mgmt_registrations: list of registrations for management frames
3473 * @mgmt_registrations_lock: lock for the list
3474 * @mtx: mutex used to lock data in this struct, may be used by drivers
3475 *      and some API functions require it held
3476 * @beacon_interval: beacon interval used on this device for transmitting
3477 *      beacons, 0 when not valid
3478 * @address: The address for this device, valid only if @netdev is %NULL
3479 * @p2p_started: true if this is a P2P Device that has been started
3480 * @cac_started: true if DFS channel availability check has been started
3481 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
3482 * @cac_time_ms: CAC time in ms
3483 * @ps: powersave mode is enabled
3484 * @ps_timeout: dynamic powersave timeout
3485 * @ap_unexpected_nlportid: (private) netlink port ID of application
3486 *      registered for unexpected class 3 frames (AP mode)
3487 * @conn: (private) cfg80211 software SME connection state machine data
3488 * @connect_keys: (private) keys to set after connection is established
3489 * @ibss_fixed: (private) IBSS is using fixed BSSID
3490 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
3491 * @event_list: (private) list for internal event processing
3492 * @event_lock: (private) lock for event list
3493 * @owner_nlportid: (private) owner socket port ID
3494 */
3495struct wireless_dev {
3496        struct wiphy *wiphy;
3497        enum nl80211_iftype iftype;
3498
3499        /* the remainder of this struct should be private to cfg80211 */
3500        struct list_head list;
3501        struct net_device *netdev;
3502
3503        u32 identifier;
3504
3505        struct list_head mgmt_registrations;
3506        spinlock_t mgmt_registrations_lock;
3507
3508        struct mutex mtx;
3509
3510        bool use_4addr, p2p_started;
3511
3512        u8 address[ETH_ALEN] __aligned(sizeof(u16));
3513
3514        /* currently used for IBSS and SME - might be rearranged later */
3515        u8 ssid[IEEE80211_MAX_SSID_LEN];
3516        u8 ssid_len, mesh_id_len, mesh_id_up_len;
3517        struct cfg80211_conn *conn;
3518        struct cfg80211_cached_keys *connect_keys;
3519
3520        struct list_head event_list;
3521        spinlock_t event_lock;
3522
3523        struct cfg80211_internal_bss *current_bss; /* associated / joined */
3524        struct cfg80211_chan_def preset_chandef;
3525        struct cfg80211_chan_def chandef;
3526
3527        bool ibss_fixed;
3528        bool ibss_dfs_possible;
3529
3530        bool ps;
3531        int ps_timeout;
3532
3533        int beacon_interval;
3534
3535        u32 ap_unexpected_nlportid;
3536
3537        bool cac_started;
3538        unsigned long cac_start_time;
3539        unsigned int cac_time_ms;
3540
3541        u32 owner_nlportid;
3542
3543#ifdef CONFIG_CFG80211_WEXT
3544        /* wext data */
3545        struct {
3546                struct cfg80211_ibss_params ibss;
3547                struct cfg80211_connect_params connect;
3548                struct cfg80211_cached_keys *keys;
3549                const u8 *ie;
3550                size_t ie_len;
3551                u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
3552                u8 ssid[IEEE80211_MAX_SSID_LEN];
3553                s8 default_key, default_mgmt_key;
3554                bool prev_bssid_valid;
3555        } wext;
3556#endif
3557};
3558
3559static inline u8 *wdev_address(struct wireless_dev *wdev)
3560{
3561        if (wdev->netdev)
3562                return wdev->netdev->dev_addr;
3563        return wdev->address;
3564}
3565
3566/**
3567 * wdev_priv - return wiphy priv from wireless_dev
3568 *
3569 * @wdev: The wireless device whose wiphy's priv pointer to return
3570 * Return: The wiphy priv of @wdev.
3571 */
3572static inline void *wdev_priv(struct wireless_dev *wdev)
3573{
3574        BUG_ON(!wdev);
3575        return wiphy_priv(wdev->wiphy);
3576}
3577
3578/**
3579 * DOC: Utility functions
3580 *
3581 * cfg80211 offers a number of utility functions that can be useful.
3582 */
3583
3584/**
3585 * ieee80211_channel_to_frequency - convert channel number to frequency
3586 * @chan: channel number
3587 * @band: band, necessary due to channel number overlap
3588 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
3589 */
3590int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
3591
3592/**
3593 * ieee80211_frequency_to_channel - convert frequency to channel number
3594 * @freq: center frequency
3595 * Return: The corresponding channel, or 0 if the conversion failed.
3596 */
3597int ieee80211_frequency_to_channel(int freq);
3598
3599/*
3600 * Name indirection necessary because the ieee80211 code also has
3601 * a function named "ieee80211_get_channel", so if you include
3602 * cfg80211's header file you get cfg80211's version, if you try
3603 * to include both header files you'll (rightfully!) get a symbol
3604 * clash.
3605 */
3606struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
3607                                                  int freq);
3608/**
3609 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
3610 * @wiphy: the struct wiphy to get the channel for
3611 * @freq: the center frequency of the channel
3612 * Return: The channel struct from @wiphy at @freq.
3613 */
3614static inline struct ieee80211_channel *
3615ieee80211_get_channel(struct wiphy *wiphy, int freq)
3616{
3617        return __ieee80211_get_channel(wiphy, freq);
3618}
3619
3620/**
3621 * ieee80211_get_response_rate - get basic rate for a given rate
3622 *
3623 * @sband: the band to look for rates in
3624 * @basic_rates: bitmap of basic rates
3625 * @bitrate: the bitrate for which to find the basic rate
3626 *
3627 * Return: The basic rate corresponding to a given bitrate, that
3628 * is the next lower bitrate contained in the basic rate map,
3629 * which is, for this function, given as a bitmap of indices of
3630 * rates in the band's bitrate table.
3631 */
3632struct ieee80211_rate *
3633ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
3634                            u32 basic_rates, int bitrate);
3635
3636/**
3637 * ieee80211_mandatory_rates - get mandatory rates for a given band
3638 * @sband: the band to look for rates in
3639 * @scan_width: width of the control channel
3640 *
3641 * This function returns a bitmap of the mandatory rates for the given
3642 * band, bits are set according to the rate position in the bitrates array.
3643 */
3644u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
3645                              enum nl80211_bss_scan_width scan_width);
3646
3647/*
3648 * Radiotap parsing functions -- for controlled injection support
3649 *
3650 * Implemented in net/wireless/radiotap.c
3651 * Documentation in Documentation/networking/radiotap-headers.txt
3652 */
3653
3654struct radiotap_align_size {
3655        uint8_t align:4, size:4;
3656};
3657
3658struct ieee80211_radiotap_namespace {
3659        const struct radiotap_align_size *align_size;
3660        int n_bits;
3661        uint32_t oui;
3662        uint8_t subns;
3663};
3664
3665struct ieee80211_radiotap_vendor_namespaces {
3666        const struct ieee80211_radiotap_namespace *ns;
3667        int n_ns;
3668};
3669
3670/**
3671 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
3672 * @this_arg_index: index of current arg, valid after each successful call
3673 *      to ieee80211_radiotap_iterator_next()
3674 * @this_arg: pointer to current radiotap arg; it is valid after each
3675 *      call to ieee80211_radiotap_iterator_next() but also after
3676 *      ieee80211_radiotap_iterator_init() where it will point to
3677 *      the beginning of the actual data portion
3678 * @this_arg_size: length of the current arg, for convenience
3679 * @current_namespace: pointer to the current namespace definition
3680 *      (or internally %NULL if the current namespace is unknown)
3681 * @is_radiotap_ns: indicates whether the current namespace is the default
3682 *      radiotap namespace or not
3683 *
3684 * @_rtheader: pointer to the radiotap header we are walking through
3685 * @_max_length: length of radiotap header in cpu byte ordering
3686 * @_arg_index: next argument index
3687 * @_arg: next argument pointer
3688 * @_next_bitmap: internal pointer to next present u32
3689 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
3690 * @_vns: vendor namespace definitions
3691 * @_next_ns_data: beginning of the next namespace's data
3692 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
3693 *      next bitmap word
3694 *
3695 * Describes the radiotap parser state. Fields prefixed with an underscore
3696 * must not be used by users of the parser, only by the parser internally.
3697 */
3698
3699struct ieee80211_radiotap_iterator {
3700        struct ieee80211_radiotap_header *_rtheader;
3701        const struct ieee80211_radiotap_vendor_namespaces *_vns;
3702        const struct ieee80211_radiotap_namespace *current_namespace;
3703
3704        unsigned char *_arg, *_next_ns_data;
3705        __le32 *_next_bitmap;
3706
3707        unsigned char *this_arg;
3708        int this_arg_index;
3709        int this_arg_size;
3710
3711        int is_radiotap_ns;
3712
3713        int _max_length;
3714        int _arg_index;
3715        uint32_t _bitmap_shifter;
3716        int _reset_on_ext;
3717};
3718
3719int
3720ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
3721                                 struct ieee80211_radiotap_header *radiotap_header,
3722                                 int max_length,
3723                                 const struct ieee80211_radiotap_vendor_namespaces *vns);
3724
3725int
3726ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
3727
3728
3729extern const unsigned char rfc1042_header[6];
3730extern const unsigned char bridge_tunnel_header[6];
3731
3732/**
3733 * ieee80211_get_hdrlen_from_skb - get header length from data
3734 *
3735 * @skb: the frame
3736 *
3737 * Given an skb with a raw 802.11 header at the data pointer this function
3738 * returns the 802.11 header length.
3739 *
3740 * Return: The 802.11 header length in bytes (not including encryption
3741 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
3742 * 802.11 header.
3743 */
3744unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
3745
3746/**
3747 * ieee80211_hdrlen - get header length in bytes from frame control
3748 * @fc: frame control field in little-endian format
3749 * Return: The header length in bytes.
3750 */
3751unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
3752
3753/**
3754 * ieee80211_get_mesh_hdrlen - get mesh extension header length
3755 * @meshhdr: the mesh extension header, only the flags field
3756 *      (first byte) will be accessed
3757 * Return: The length of the extension header, which is always at
3758 * least 6 bytes and at most 18 if address 5 and 6 are present.
3759 */
3760unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
3761
3762/**
3763 * DOC: Data path helpers
3764 *
3765 * In addition to generic utilities, cfg80211 also offers
3766 * functions that help implement the data path for devices
3767 * that do not do the 802.11/802.3 conversion on the device.
3768 */
3769
3770/**
3771 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
3772 * @skb: the 802.11 data frame
3773 * @addr: the device MAC address
3774 * @iftype: the virtual interface type
3775 * Return: 0 on success. Non-zero on error.
3776 */
3777int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
3778                           enum nl80211_iftype iftype);
3779
3780/**
3781 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
3782 * @skb: the 802.3 frame
3783 * @addr: the device MAC address
3784 * @iftype: the virtual interface type
3785 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
3786 * @qos: build 802.11 QoS data frame
3787 * Return: 0 on success, or a negative error code.
3788 */
3789int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
3790                             enum nl80211_iftype iftype, const u8 *bssid,
3791                             bool qos);
3792
3793/**
3794 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
3795 *
3796 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
3797 * 802.3 frames. The @list will be empty if the decode fails. The
3798 * @skb is consumed after the function returns.
3799 *
3800 * @skb: The input IEEE 802.11n A-MSDU frame.
3801 * @list: The output list of 802.3 frames. It must be allocated and
3802 *      initialized by by the caller.
3803 * @addr: The device MAC address.
3804 * @iftype: The device interface type.
3805 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
3806 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
3807 */
3808void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
3809                              const u8 *addr, enum nl80211_iftype iftype,
3810                              const unsigned int extra_headroom,
3811                              bool has_80211_header);
3812
3813/**
3814 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
3815 * @skb: the data frame
3816 * @qos_map: Interworking QoS mapping or %NULL if not in use
3817 * Return: The 802.1p/1d tag.
3818 */
3819unsigned int cfg80211_classify8021d(struct sk_buff *skb,
3820                                    struct cfg80211_qos_map *qos_map);
3821
3822/**
3823 * cfg80211_find_ie - find information element in data
3824 *
3825 * @eid: element ID
3826 * @ies: data consisting of IEs
3827 * @len: length of data
3828 *
3829 * Return: %NULL if the element ID could not be found or if
3830 * the element is invalid (claims to be longer than the given
3831 * data), or a pointer to the first byte of the requested
3832 * element, that is the byte containing the element ID.
3833 *
3834 * Note: There are no checks on the element length other than
3835 * having to fit into the given data.
3836 */
3837const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
3838
3839/**
3840 * cfg80211_find_vendor_ie - find vendor specific information element in data
3841 *
3842 * @oui: vendor OUI
3843 * @oui_type: vendor-specific OUI type
3844 * @ies: data consisting of IEs
3845 * @len: length of data
3846 *
3847 * Return: %NULL if the vendor specific element ID could not be found or if the
3848 * element is invalid (claims to be longer than the given data), or a pointer to
3849 * the first byte of the requested element, that is the byte containing the
3850 * element ID.
3851 *
3852 * Note: There are no checks on the element length other than having to fit into
3853 * the given data.
3854 */
3855const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,
3856                                  const u8 *ies, int len);
3857
3858/**
3859 * DOC: Regulatory enforcement infrastructure
3860 *
3861 * TODO
3862 */
3863
3864/**
3865 * regulatory_hint - driver hint to the wireless core a regulatory domain
3866 * @wiphy: the wireless device giving the hint (used only for reporting
3867 *      conflicts)
3868 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
3869 *      should be in. If @rd is set this should be NULL. Note that if you
3870 *      set this to NULL you should still set rd->alpha2 to some accepted
3871 *      alpha2.
3872 *
3873 * Wireless drivers can use this function to hint to the wireless core
3874 * what it believes should be the current regulatory domain by
3875 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
3876 * domain should be in or by providing a completely build regulatory domain.
3877 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
3878 * for a regulatory domain structure for the respective country.
3879 *
3880 * The wiphy must have been registered to cfg80211 prior to this call.
3881 * For cfg80211 drivers this means you must first use wiphy_register(),
3882 * for mac80211 drivers you must first use ieee80211_register_hw().
3883 *
3884 * Drivers should check the return value, its possible you can get
3885 * an -ENOMEM.
3886 *
3887 * Return: 0 on success. -ENOMEM.
3888 */
3889int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
3890
3891/**
3892 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
3893 * @wiphy: the wireless device we want to process the regulatory domain on
3894 * @rd: the regulatory domain informatoin to use for this wiphy
3895 *
3896 * Set the regulatory domain information for self-managed wiphys, only they
3897 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
3898 * information.
3899 *
3900 * Return: 0 on success. -EINVAL, -EPERM
3901 */
3902int regulatory_set_wiphy_regd(struct wiphy *wiphy,
3903                              struct ieee80211_regdomain *rd);
3904
3905/**
3906 * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
3907 * @wiphy: the wireless device we want to process the regulatory domain on
3908 * @rd: the regulatory domain information to use for this wiphy
3909 *
3910 * This functions requires the RTNL to be held and applies the new regdomain
3911 * synchronously to this wiphy. For more details see
3912 * regulatory_set_wiphy_regd().
3913 *
3914 * Return: 0 on success. -EINVAL, -EPERM
3915 */
3916int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy *wiphy,
3917                                        struct ieee80211_regdomain *rd);
3918
3919/**
3920 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
3921 * @wiphy: the wireless device we want to process the regulatory domain on
3922 * @regd: the custom regulatory domain to use for this wiphy
3923 *
3924 * Drivers can sometimes have custom regulatory domains which do not apply
3925 * to a specific country. Drivers can use this to apply such custom regulatory
3926 * domains. This routine must be called prior to wiphy registration. The
3927 * custom regulatory domain will be trusted completely and as such previous
3928 * default channel settings will be disregarded. If no rule is found for a
3929 * channel on the regulatory domain the channel will be disabled.
3930 * Drivers using this for a wiphy should also set the wiphy flag
3931 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
3932 * that called this helper.
3933 */
3934void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
3935                                   const struct ieee80211_regdomain *regd);
3936
3937/**
3938 * freq_reg_info - get regulatory information for the given frequency
3939 * @wiphy: the wiphy for which we want to process this rule for
3940 * @center_freq: Frequency in KHz for which we want regulatory information for
3941 *
3942 * Use this function to get the regulatory rule for a specific frequency on
3943 * a given wireless device. If the device has a specific regulatory domain
3944 * it wants to follow we respect that unless a country IE has been received
3945 * and processed already.
3946 *
3947 * Return: A valid pointer, or, when an error occurs, for example if no rule
3948 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
3949 * check and PTR_ERR() to obtain the numeric return value. The numeric return
3950 * value will be -ERANGE if we determine the given center_freq does not even
3951 * have a regulatory rule for a frequency range in the center_freq's band.
3952 * See freq_in_rule_band() for our current definition of a band -- this is
3953 * purely subjective and right now it's 802.11 specific.
3954 */
3955const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
3956                                               u32 center_freq);
3957
3958/**
3959 * reg_initiator_name - map regulatory request initiator enum to name
3960 * @initiator: the regulatory request initiator
3961 *
3962 * You can use this to map the regulatory request initiator enum to a
3963 * proper string representation.
3964 */
3965const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
3966
3967/*
3968 * callbacks for asynchronous cfg80211 methods, notification
3969 * functions and BSS handling helpers
3970 */
3971
3972/**
3973 * cfg80211_scan_done - notify that scan finished
3974 *
3975 * @request: the corresponding scan request
3976 * @aborted: set to true if the scan was aborted for any reason,
3977 *      userspace will be notified of that
3978 */
3979void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
3980
3981/**
3982 * cfg80211_sched_scan_results - notify that new scan results are available
3983 *
3984 * @wiphy: the wiphy which got scheduled scan results
3985 */
3986void cfg80211_sched_scan_results(struct wiphy *wiphy);
3987
3988/**
3989 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
3990 *
3991 * @wiphy: the wiphy on which the scheduled scan stopped
3992 *
3993 * The driver can call this function to inform cfg80211 that the
3994 * scheduled scan had to be stopped, for whatever reason.  The driver
3995 * is then called back via the sched_scan_stop operation when done.
3996 */
3997void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
3998
3999/**
4000 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
4001 *
4002 * @wiphy: the wiphy on which the scheduled scan stopped
4003 *
4004 * The driver can call this function to inform cfg80211 that the
4005 * scheduled scan had to be stopped, for whatever reason.  The driver
4006 * is then called back via the sched_scan_stop operation when done.
4007 * This function should be called with rtnl locked.
4008 */
4009void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy);
4010
4011/**
4012 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
4013 * @wiphy: the wiphy reporting the BSS
4014 * @data: the BSS metadata
4015 * @mgmt: the management frame (probe response or beacon)
4016 * @len: length of the management frame
4017 * @gfp: context flags
4018 *
4019 * This informs cfg80211 that BSS information was found and
4020 * the BSS should be updated/added.
4021 *
4022 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4023 * Or %NULL on error.
4024 */
4025struct cfg80211_bss * __must_check
4026cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
4027                               struct cfg80211_inform_bss *data,
4028                               struct ieee80211_mgmt *mgmt, size_t len,
4029                               gfp_t gfp);
4030
4031static inline struct cfg80211_bss * __must_check
4032cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
4033                                struct ieee80211_channel *rx_channel,
4034                                enum nl80211_bss_scan_width scan_width,
4035                                struct ieee80211_mgmt *mgmt, size_t len,
4036                                s32 signal, gfp_t gfp)
4037{
4038        struct cfg80211_inform_bss data = {
4039                .chan = rx_channel,
4040                .scan_width = scan_width,
4041                .signal = signal,
4042        };
4043
4044        return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4045}
4046
4047static inline struct cfg80211_bss * __must_check
4048cfg80211_inform_bss_frame(struct wiphy *wiphy,
4049                          struct ieee80211_channel *rx_channel,
4050                          struct ieee80211_mgmt *mgmt, size_t len,
4051                          s32 signal, gfp_t gfp)
4052{
4053        struct cfg80211_inform_bss data = {
4054                .chan = rx_channel,
4055                .scan_width = NL80211_BSS_CHAN_WIDTH_20,
4056                .signal = signal,
4057        };
4058
4059        return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4060}
4061
4062/**
4063 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
4064 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
4065 *      from a beacon or probe response
4066 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
4067 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
4068 */
4069enum cfg80211_bss_frame_type {
4070        CFG80211_BSS_FTYPE_UNKNOWN,
4071        CFG80211_BSS_FTYPE_BEACON,
4072        CFG80211_BSS_FTYPE_PRESP,
4073};
4074
4075/**
4076 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
4077 *
4078 * @wiphy: the wiphy reporting the BSS
4079 * @data: the BSS metadata
4080 * @ftype: frame type (if known)
4081 * @bssid: the BSSID of the BSS
4082 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
4083 * @capability: the capability field sent by the peer
4084 * @beacon_interval: the beacon interval announced by the peer
4085 * @ie: additional IEs sent by the peer
4086 * @ielen: length of the additional IEs
4087 * @gfp: context flags
4088 *
4089 * This informs cfg80211 that BSS information was found and
4090 * the BSS should be updated/added.
4091 *
4092 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4093 * Or %NULL on error.
4094 */
4095struct cfg80211_bss * __must_check
4096cfg80211_inform_bss_data(struct wiphy *wiphy,
4097                         struct cfg80211_inform_bss *data,
4098                         enum cfg80211_bss_frame_type ftype,
4099                         const u8 *bssid, u64 tsf, u16 capability,
4100                         u16 beacon_interval, const u8 *ie, size_t ielen,
4101                         gfp_t gfp);
4102
4103static inline struct cfg80211_bss * __must_check
4104cfg80211_inform_bss_width(struct wiphy *wiphy,
4105                          struct ieee80211_channel *rx_channel,
4106                          enum nl80211_bss_scan_width scan_width,
4107                          enum cfg80211_bss_frame_type ftype,
4108                          const u8 *bssid, u64 tsf, u16 capability,
4109                          u16 beacon_interval, const u8 *ie, size_t ielen,
4110                          s32 signal, gfp_t gfp)
4111{
4112        struct cfg80211_inform_bss data = {
4113                .chan = rx_channel,
4114                .scan_width = scan_width,
4115                .signal = signal,
4116        };
4117
4118        return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4119                                        capability, beacon_interval, ie, ielen,
4120                                        gfp);
4121}
4122
4123static inline struct cfg80211_bss * __must_check
4124cfg80211_inform_bss(struct wiphy *wiphy,
4125                    struct ieee80211_channel *rx_channel,
4126                    enum cfg80211_bss_frame_type ftype,
4127                    const u8 *bssid, u64 tsf, u16 capability,
4128                    u16 beacon_interval, const u8 *ie, size_t ielen,
4129                    s32 signal, gfp_t gfp)
4130{
4131        struct cfg80211_inform_bss data = {
4132                .chan = rx_channel,
4133                .scan_width = NL80211_BSS_CHAN_WIDTH_20,
4134                .signal = signal,
4135        };
4136
4137        return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4138                                        capability, beacon_interval, ie, ielen,
4139                                        gfp);
4140}
4141
4142struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
4143                                      struct ieee80211_channel *channel,
4144                                      const u8 *bssid,
4145                                      const u8 *ssid, size_t ssid_len,
4146                                      enum ieee80211_bss_type bss_type,
4147                                      enum ieee80211_privacy);
4148static inline struct cfg80211_bss *
4149cfg80211_get_ibss(struct wiphy *wiphy,
4150                  struct ieee80211_channel *channel,
4151                  const u8 *ssid, size_t ssid_len)
4152{
4153        return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
4154                                IEEE80211_BSS_TYPE_IBSS,
4155                                IEEE80211_PRIVACY_ANY);
4156}
4157
4158/**
4159 * cfg80211_ref_bss - reference BSS struct
4160 * @wiphy: the wiphy this BSS struct belongs to
4161 * @bss: the BSS struct to reference
4162 *
4163 * Increments the refcount of the given BSS struct.
4164 */
4165void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4166
4167/**
4168 * cfg80211_put_bss - unref BSS struct
4169 * @wiphy: the wiphy this BSS struct belongs to
4170 * @bss: the BSS struct
4171 *
4172 * Decrements the refcount of the given BSS struct.
4173 */
4174void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4175
4176/**
4177 * cfg80211_unlink_bss - unlink BSS from internal data structures
4178 * @wiphy: the wiphy
4179 * @bss: the bss to remove
4180 *
4181 * This function removes the given BSS from the internal data structures
4182 * thereby making it no longer show up in scan results etc. Use this
4183 * function when you detect a BSS is gone. Normally BSSes will also time
4184 * out, so it is not necessary to use this function at all.
4185 */
4186void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4187
4188static inline enum nl80211_bss_scan_width
4189cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
4190{
4191        switch (chandef->width) {
4192        case NL80211_CHAN_WIDTH_5:
4193                return NL80211_BSS_CHAN_WIDTH_5;
4194        case NL80211_CHAN_WIDTH_10:
4195                return NL80211_BSS_CHAN_WIDTH_10;
4196        default:
4197                return NL80211_BSS_CHAN_WIDTH_20;
4198        }
4199}
4200
4201/**
4202 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
4203 * @dev: network device
4204 * @buf: authentication frame (header + body)
4205 * @len: length of the frame data
4206 *
4207 * This function is called whenever an authentication, disassociation or
4208 * deauthentication frame has been received and processed in station mode.
4209 * After being asked to authenticate via cfg80211_ops::auth() the driver must
4210 * call either this function or cfg80211_auth_timeout().
4211 * After being asked to associate via cfg80211_ops::assoc() the driver must
4212 * call either this function or cfg80211_auth_timeout().
4213 * While connected, the driver must calls this for received and processed
4214 * disassociation and deauthentication frames. If the frame couldn't be used
4215 * because it was unprotected, the driver must call the function
4216 * cfg80211_rx_unprot_mlme_mgmt() instead.
4217 *
4218 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4219 */
4220void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4221
4222/**
4223 * cfg80211_auth_timeout - notification of timed out authentication
4224 * @dev: network device
4225 * @addr: The MAC address of the device with which the authentication timed out
4226 *
4227 * This function may sleep. The caller must hold the corresponding wdev's
4228 * mutex.
4229 */
4230void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
4231
4232/**
4233 * cfg80211_rx_assoc_resp - notification of processed association response
4234 * @dev: network device
4235 * @bss: the BSS that association was requested with, ownership of the pointer
4236 *      moves to cfg80211 in this call
4237 * @buf: authentication frame (header + body)
4238 * @len: length of the frame data
4239 * @uapsd_queues: bitmap of ACs configured to uapsd. -1 if n/a.
4240 *
4241 * After being asked to associate via cfg80211_ops::assoc() the driver must
4242 * call either this function or cfg80211_auth_timeout().
4243 *
4244 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4245 */
4246void cfg80211_rx_assoc_resp(struct net_device *dev,
4247                            struct cfg80211_bss *bss,
4248                            const u8 *buf, size_t len,
4249                            int uapsd_queues);
4250
4251/**
4252 * cfg80211_assoc_timeout - notification of timed out association
4253 * @dev: network device
4254 * @bss: The BSS entry with which association timed out.
4255 *
4256 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4257 */
4258void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
4259
4260/**
4261 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
4262 * @dev: network device
4263 * @buf: 802.11 frame (header + body)
4264 * @len: length of the frame data
4265 *
4266 * This function is called whenever deauthentication has been processed in
4267 * station mode. This includes both received deauthentication frames and
4268 * locally generated ones. This function may sleep. The caller must hold the
4269 * corresponding wdev's mutex.
4270 */
4271void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4272
4273/**
4274 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
4275 * @dev: network device
4276 * @buf: deauthentication frame (header + body)
4277 * @len: length of the frame data
4278 *
4279 * This function is called whenever a received deauthentication or dissassoc
4280 * frame has been dropped in station mode because of MFP being used but the
4281 * frame was not protected. This function may sleep.
4282 */
4283void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
4284                                  const u8 *buf, size_t len);
4285
4286/**
4287 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
4288 * @dev: network device
4289 * @addr: The source MAC address of the frame
4290 * @key_type: The key type that the received frame used
4291 * @key_id: Key identifier (0..3). Can be -1 if missing.
4292 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
4293 * @gfp: allocation flags
4294 *
4295 * This function is called whenever the local MAC detects a MIC failure in a
4296 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
4297 * primitive.
4298 */
4299void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
4300                                  enum nl80211_key_type key_type, int key_id,
4301                                  const u8 *tsc, gfp_t gfp);
4302
4303/**
4304 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
4305 *
4306 * @dev: network device
4307 * @bssid: the BSSID of the IBSS joined
4308 * @channel: the channel of the IBSS joined
4309 * @gfp: allocation flags
4310 *
4311 * This function notifies cfg80211 that the device joined an IBSS or
4312 * switched to a different BSSID. Before this function can be called,
4313 * either a beacon has to have been received from the IBSS, or one of
4314 * the cfg80211_inform_bss{,_frame} functions must have been called
4315 * with the locally generated beacon -- this guarantees that there is
4316 * always a scan result for this IBSS. cfg80211 will handle the rest.
4317 */
4318void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
4319                          struct ieee80211_channel *channel, gfp_t gfp);
4320
4321/**
4322 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
4323 *
4324 * @dev: network device
4325 * @macaddr: the MAC address of the new candidate
4326 * @ie: information elements advertised by the peer candidate
4327 * @ie_len: lenght of the information elements buffer
4328 * @gfp: allocation flags
4329 *
4330 * This function notifies cfg80211 that the mesh peer candidate has been
4331 * detected, most likely via a beacon or, less likely, via a probe response.
4332 * cfg80211 then sends a notification to userspace.
4333 */
4334void cfg80211_notify_new_peer_candidate(struct net_device *dev,
4335                const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
4336
4337/**
4338 * DOC: RFkill integration
4339 *
4340 * RFkill integration in cfg80211 is almost invisible to drivers,
4341 * as cfg80211 automatically registers an rfkill instance for each
4342 * wireless device it knows about. Soft kill is also translated
4343 * into disconnecting and turning all interfaces off, drivers are
4344 * expected to turn off the device when all interfaces are down.
4345 *
4346 * However, devices may have a hard RFkill line, in which case they
4347 * also need to interact with the rfkill subsystem, via cfg80211.
4348 * They can do this with a few helper functions documented here.
4349 */
4350
4351/**
4352 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
4353 * @wiphy: the wiphy
4354 * @blocked: block status
4355 */
4356void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
4357
4358/**
4359 * wiphy_rfkill_start_polling - start polling rfkill
4360 * @wiphy: the wiphy
4361 */
4362void wiphy_rfkill_start_polling(struct wiphy *wiphy);
4363
4364/**
4365 * wiphy_rfkill_stop_polling - stop polling rfkill
4366 * @wiphy: the wiphy
4367 */
4368void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
4369
4370/**
4371 * DOC: Vendor commands
4372 *
4373 * Occasionally, there are special protocol or firmware features that
4374 * can't be implemented very openly. For this and similar cases, the
4375 * vendor command functionality allows implementing the features with
4376 * (typically closed-source) userspace and firmware, using nl80211 as
4377 * the configuration mechanism.
4378 *
4379 * A driver supporting vendor commands must register them as an array
4380 * in struct wiphy, with handlers for each one, each command has an
4381 * OUI and sub command ID to identify it.
4382 *
4383 * Note that this feature should not be (ab)used to implement protocol
4384 * features that could openly be shared across drivers. In particular,
4385 * it must never be required to use vendor commands to implement any
4386 * "normal" functionality that higher-level userspace like connection
4387 * managers etc. need.
4388 */
4389
4390struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
4391                                           enum nl80211_commands cmd,
4392                                           enum nl80211_attrs attr,
4393                                           int approxlen);
4394
4395struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
4396                                           struct wireless_dev *wdev,
4397                                           enum nl80211_commands cmd,
4398                                           enum nl80211_attrs attr,
4399                                           int vendor_event_idx,
4400                                           int approxlen, gfp_t gfp);
4401
4402void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
4403
4404/**
4405 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
4406 * @wiphy: the wiphy
4407 * @approxlen: an upper bound of the length of the data that will
4408 *      be put into the skb
4409 *
4410 * This function allocates and pre-fills an skb for a reply to
4411 * a vendor command. Since it is intended for a reply, calling
4412 * it outside of a vendor command's doit() operation is invalid.
4413 *
4414 * The returned skb is pre-filled with some identifying data in
4415 * a way that any data that is put into the skb (with skb_put(),
4416 * nla_put() or similar) will end up being within the
4417 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
4418 * with the skb is adding data for the corresponding userspace tool
4419 * which can then read that data out of the vendor data attribute.
4420 * You must not modify the skb in any other way.
4421 *
4422 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
4423 * its error code as the result of the doit() operation.
4424 *
4425 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4426 */
4427static inline struct sk_buff *
4428cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4429{
4430        return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
4431                                          NL80211_ATTR_VENDOR_DATA, approxlen);
4432}
4433
4434/**
4435 * cfg80211_vendor_cmd_reply - send the reply skb
4436 * @skb: The skb, must have been allocated with
4437 *      cfg80211_vendor_cmd_alloc_reply_skb()
4438 *
4439 * Since calling this function will usually be the last thing
4440 * before returning from the vendor command doit() you should
4441 * return the error code.  Note that this function consumes the
4442 * skb regardless of the return value.
4443 *
4444 * Return: An error code or 0 on success.
4445 */
4446int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
4447
4448/**
4449 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
4450 * @wiphy: the wiphy
4451 * @wdev: the wireless device
4452 * @event_idx: index of the vendor event in the wiphy's vendor_events
4453 * @approxlen: an upper bound of the length of the data that will
4454 *      be put into the skb
4455 * @gfp: allocation flags
4456 *
4457 * This function allocates and pre-fills an skb for an event on the
4458 * vendor-specific multicast group.
4459 *
4460 * If wdev != NULL, both the ifindex and identifier of the specified
4461 * wireless device are added to the event message before the vendor data
4462 * attribute.
4463 *
4464 * When done filling the skb, call cfg80211_vendor_event() with the
4465 * skb to send the event.
4466 *
4467 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4468 */
4469static inline struct sk_buff *
4470cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
4471                             int approxlen, int event_idx, gfp_t gfp)
4472{
4473        return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
4474                                          NL80211_ATTR_VENDOR_DATA,
4475                                          event_idx, approxlen, gfp);
4476}
4477
4478/**
4479 * cfg80211_vendor_event - send the event
4480 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
4481 * @gfp: allocation flags
4482 *
4483 * This function sends the given @skb, which must have been allocated
4484 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
4485 */
4486static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
4487{
4488        __cfg80211_send_event_skb(skb, gfp);
4489}
4490
4491#ifdef CONFIG_NL80211_TESTMODE
4492/**
4493 * DOC: Test mode
4494 *
4495 * Test mode is a set of utility functions to allow drivers to
4496 * interact with driver-specific tools to aid, for instance,
4497 * factory programming.
4498 *
4499 * This chapter describes how drivers interact with it, for more
4500 * information see the nl80211 book's chapter on it.
4501 */
4502
4503/**
4504 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
4505 * @wiphy: the wiphy
4506 * @approxlen: an upper bound of the length of the data that will
4507 *      be put into the skb
4508 *
4509 * This function allocates and pre-fills an skb for a reply to
4510 * the testmode command. Since it is intended for a reply, calling
4511 * it outside of the @testmode_cmd operation is invalid.
4512 *
4513 * The returned skb is pre-filled with the wiphy index and set up in
4514 * a way that any data that is put into the skb (with skb_put(),
4515 * nla_put() or similar) will end up being within the
4516 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
4517 * with the skb is adding data for the corresponding userspace tool
4518 * which can then read that data out of the testdata attribute. You
4519 * must not modify the skb in any other way.
4520 *
4521 * When done, call cfg80211_testmode_reply() with the skb and return
4522 * its error code as the result of the @testmode_cmd operation.
4523 *
4524 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4525 */
4526static inline struct sk_buff *
4527cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4528{
4529        return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
4530                                          NL80211_ATTR_TESTDATA, approxlen);
4531}
4532
4533/**
4534 * cfg80211_testmode_reply - send the reply skb
4535 * @skb: The skb, must have been allocated with
4536 *      cfg80211_testmode_alloc_reply_skb()
4537 *
4538 * Since calling this function will usually be the last thing
4539 * before returning from the @testmode_cmd you should return
4540 * the error code.  Note that this function consumes the skb
4541 * regardless of the return value.
4542 *
4543 * Return: An error code or 0 on success.
4544 */
4545static inline int cfg80211_testmode_reply(struct sk_buff *skb)
4546{
4547        return cfg80211_vendor_cmd_reply(skb);
4548}
4549
4550/**
4551 * cfg80211_testmode_alloc_event_skb - allocate testmode event
4552 * @wiphy: the wiphy
4553 * @approxlen: an upper bound of the length of the data that will
4554 *      be put into the skb
4555 * @gfp: allocation flags
4556 *
4557 * This function allocates and pre-fills an skb for an event on the
4558 * testmode multicast group.
4559 *
4560 * The returned skb is set up in the same way as with
4561 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
4562 * there, you should simply add data to it that will then end up in the
4563 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
4564 * in any other way.
4565 *
4566 * When done filling the skb, call cfg80211_testmode_event() with the
4567 * skb to send the event.
4568 *
4569 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4570 */
4571static inline struct sk_buff *
4572cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
4573{
4574        return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
4575                                          NL80211_ATTR_TESTDATA, -1,
4576                                          approxlen, gfp);
4577}
4578
4579/**
4580 * cfg80211_testmode_event - send the event
4581 * @skb: The skb, must have been allocated with
4582 *      cfg80211_testmode_alloc_event_skb()
4583 * @gfp: allocation flags
4584 *
4585 * This function sends the given @skb, which must have been allocated
4586 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
4587 * consumes it.
4588 */
4589static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
4590{
4591        __cfg80211_send_event_skb(skb, gfp);
4592}
4593
4594#define CFG80211_TESTMODE_CMD(cmd)      .testmode_cmd = (cmd),
4595#define CFG80211_TESTMODE_DUMP(cmd)     .testmode_dump = (cmd),
4596#else
4597#define CFG80211_TESTMODE_CMD(cmd)
4598#define CFG80211_TESTMODE_DUMP(cmd)
4599#endif
4600
4601/**
4602 * cfg80211_connect_result - notify cfg80211 of connection result
4603 *
4604 * @dev: network device
4605 * @bssid: the BSSID of the AP
4606 * @req_ie: association request IEs (maybe be %NULL)
4607 * @req_ie_len: association request IEs length
4608 * @resp_ie: association response IEs (may be %NULL)
4609 * @resp_ie_len: assoc response IEs length
4610 * @status: status code, 0 for successful connection, use
4611 *      %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
4612 *      the real status code for failures.
4613 * @gfp: allocation flags
4614 *
4615 * It should be called by the underlying driver whenever connect() has
4616 * succeeded.
4617 */
4618void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
4619                             const u8 *req_ie, size_t req_ie_len,
4620                             const u8 *resp_ie, size_t resp_ie_len,
4621                             u16 status, gfp_t gfp);
4622
4623/**
4624 * cfg80211_roamed - notify cfg80211 of roaming
4625 *
4626 * @dev: network device
4627 * @channel: the channel of the new AP
4628 * @bssid: the BSSID of the new AP
4629 * @req_ie: association request IEs (maybe be %NULL)
4630 * @req_ie_len: association request IEs length
4631 * @resp_ie: association response IEs (may be %NULL)
4632 * @resp_ie_len: assoc response IEs length
4633 * @gfp: allocation flags
4634 *
4635 * It should be called by the underlying driver whenever it roamed
4636 * from one AP to another while connected.
4637 */
4638void cfg80211_roamed(struct net_device *dev,
4639                     struct ieee80211_channel *channel,
4640                     const u8 *bssid,
4641                     const u8 *req_ie, size_t req_ie_len,
4642                     const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
4643
4644/**
4645 * cfg80211_roamed_bss - notify cfg80211 of roaming
4646 *
4647 * @dev: network device
4648 * @bss: entry of bss to which STA got roamed
4649 * @req_ie: association request IEs (maybe be %NULL)
4650 * @req_ie_len: association request IEs length
4651 * @resp_ie: association response IEs (may be %NULL)
4652 * @resp_ie_len: assoc response IEs length
4653 * @gfp: allocation flags
4654 *
4655 * This is just a wrapper to notify cfg80211 of roaming event with driver
4656 * passing bss to avoid a race in timeout of the bss entry. It should be
4657 * called by the underlying driver whenever it roamed from one AP to another
4658 * while connected. Drivers which have roaming implemented in firmware
4659 * may use this function to avoid a race in bss entry timeout where the bss
4660 * entry of the new AP is seen in the driver, but gets timed out by the time
4661 * it is accessed in __cfg80211_roamed() due to delay in scheduling
4662 * rdev->event_work. In case of any failures, the reference is released
4663 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
4664 * it will be released while diconneting from the current bss.
4665 */
4666void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
4667                         const u8 *req_ie, size_t req_ie_len,
4668                         const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
4669
4670/**
4671 * cfg80211_disconnected - notify cfg80211 that connection was dropped
4672 *
4673 * @dev: network device
4674 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
4675 * @ie_len: length of IEs
4676 * @reason: reason code for the disconnection, set it to 0 if unknown
4677 * @locally_generated: disconnection was requested locally
4678 * @gfp: allocation flags
4679 *
4680 * After it calls this function, the driver should enter an idle state
4681 * and not try to connect to any AP any more.
4682 */
4683void cfg80211_disconnected(struct net_device *dev, u16 reason,
4684                           const u8 *ie, size_t ie_len,
4685                           bool locally_generated, gfp_t gfp);
4686
4687/**
4688 * cfg80211_ready_on_channel - notification of remain_on_channel start
4689 * @wdev: wireless device
4690 * @cookie: the request cookie
4691 * @chan: The current channel (from remain_on_channel request)
4692 * @duration: Duration in milliseconds that the driver intents to remain on the
4693 *      channel
4694 * @gfp: allocation flags
4695 */
4696void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
4697                               struct ieee80211_channel *chan,
4698                               unsigned int duration, gfp_t gfp);
4699
4700/**
4701 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
4702 * @wdev: wireless device
4703 * @cookie: the request cookie
4704 * @chan: The current channel (from remain_on_channel request)
4705 * @gfp: allocation flags
4706 */
4707void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
4708                                        struct ieee80211_channel *chan,
4709                                        gfp_t gfp);
4710
4711
4712/**
4713 * cfg80211_new_sta - notify userspace about station
4714 *
4715 * @dev: the netdev
4716 * @mac_addr: the station's address
4717 * @sinfo: the station information
4718 * @gfp: allocation flags
4719 */
4720void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
4721                      struct station_info *sinfo, gfp_t gfp);
4722
4723/**
4724 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
4725 * @dev: the netdev
4726 * @mac_addr: the station's address
4727 * @sinfo: the station information/statistics
4728 * @gfp: allocation flags
4729 */
4730void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
4731                            struct station_info *sinfo, gfp_t gfp);
4732
4733/**
4734 * cfg80211_del_sta - notify userspace about deletion of a station
4735 *
4736 * @dev: the netdev
4737 * @mac_addr: the station's address
4738 * @gfp: allocation flags
4739 */
4740static inline void cfg80211_del_sta(struct net_device *dev,
4741                                    const u8 *mac_addr, gfp_t gfp)
4742{
4743        cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
4744}
4745
4746/**
4747 * cfg80211_conn_failed - connection request failed notification
4748 *
4749 * @dev: the netdev
4750 * @mac_addr: the station's address
4751 * @reason: the reason for connection failure
4752 * @gfp: allocation flags
4753 *
4754 * Whenever a station tries to connect to an AP and if the station
4755 * could not connect to the AP as the AP has rejected the connection
4756 * for some reasons, this function is called.
4757 *
4758 * The reason for connection failure can be any of the value from
4759 * nl80211_connect_failed_reason enum
4760 */
4761void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
4762                          enum nl80211_connect_failed_reason reason,
4763                          gfp_t gfp);
4764
4765/**
4766 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
4767 * @wdev: wireless device receiving the frame
4768 * @freq: Frequency on which the frame was received in MHz
4769 * @sig_dbm: signal strength in mBm, or 0 if unknown
4770 * @buf: Management frame (header + body)
4771 * @len: length of the frame data
4772 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
4773 *
4774 * This function is called whenever an Action frame is received for a station
4775 * mode interface, but is not processed in kernel.
4776 *
4777 * Return: %true if a user space application has registered for this frame.
4778 * For action frames, that makes it responsible for rejecting unrecognized
4779 * action frames; %false otherwise, in which case for action frames the
4780 * driver is responsible for rejecting the frame.
4781 */
4782bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
4783                      const u8 *buf, size_t len, u32 flags);
4784
4785/**
4786 * cfg80211_mgmt_tx_status - notification of TX status for management frame
4787 * @wdev: wireless device receiving the frame
4788 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
4789 * @buf: Management frame (header + body)
4790 * @len: length of the frame data
4791 * @ack: Whether frame was acknowledged
4792 * @gfp: context flags
4793 *
4794 * This function is called whenever a management frame was requested to be
4795 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
4796 * transmission attempt.
4797 */
4798void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
4799                             const u8 *buf, size_t len, bool ack, gfp_t gfp);
4800
4801
4802/**
4803 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
4804 * @dev: network device
4805 * @rssi_event: the triggered RSSI event
4806 * @gfp: context flags
4807 *
4808 * This function is called when a configured connection quality monitoring
4809 * rssi threshold reached event occurs.
4810 */
4811void cfg80211_cqm_rssi_notify(struct net_device *dev,
4812                              enum nl80211_cqm_rssi_threshold_event rssi_event,
4813                              gfp_t gfp);
4814
4815/**
4816 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
4817 * @dev: network device
4818 * @peer: peer's MAC address
4819 * @num_packets: how many packets were lost -- should be a fixed threshold
4820 *      but probably no less than maybe 50, or maybe a throughput dependent
4821 *      threshold (to account for temporary interference)
4822 * @gfp: context flags
4823 */
4824void cfg80211_cqm_pktloss_notify(struct net_device *dev,
4825                                 const u8 *peer, u32 num_packets, gfp_t gfp);
4826
4827/**
4828 * cfg80211_cqm_txe_notify - TX error rate event
4829 * @dev: network device
4830 * @peer: peer's MAC address
4831 * @num_packets: how many packets were lost
4832 * @rate: % of packets which failed transmission
4833 * @intvl: interval (in s) over which the TX failure threshold was breached.
4834 * @gfp: context flags
4835 *
4836 * Notify userspace when configured % TX failures over number of packets in a
4837 * given interval is exceeded.
4838 */
4839void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
4840                             u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
4841
4842/**
4843 * cfg80211_cqm_beacon_loss_notify - beacon loss event
4844 * @dev: network device
4845 * @gfp: context flags
4846 *
4847 * Notify userspace about beacon loss from the connected AP.
4848 */
4849void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
4850
4851/**
4852 * cfg80211_radar_event - radar detection event
4853 * @wiphy: the wiphy
4854 * @chandef: chandef for the current channel
4855 * @gfp: context flags
4856 *
4857 * This function is called when a radar is detected on the current chanenl.
4858 */
4859void cfg80211_radar_event(struct wiphy *wiphy,
4860                          struct cfg80211_chan_def *chandef, gfp_t gfp);
4861
4862/**
4863 * cfg80211_cac_event - Channel availability check (CAC) event
4864 * @netdev: network device
4865 * @chandef: chandef for the current channel
4866 * @event: type of event
4867 * @gfp: context flags
4868 *
4869 * This function is called when a Channel availability check (CAC) is finished
4870 * or aborted. This must be called to notify the completion of a CAC process,
4871 * also by full-MAC drivers.
4872 */
4873void cfg80211_cac_event(struct net_device *netdev,
4874                        const struct cfg80211_chan_def *chandef,
4875                        enum nl80211_radar_event event, gfp_t gfp);
4876
4877
4878/**
4879 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
4880 * @dev: network device
4881 * @bssid: BSSID of AP (to avoid races)
4882 * @replay_ctr: new replay counter
4883 * @gfp: allocation flags
4884 */
4885void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
4886                               const u8 *replay_ctr, gfp_t gfp);
4887
4888/**
4889 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
4890 * @dev: network device
4891 * @index: candidate index (the smaller the index, the higher the priority)
4892 * @bssid: BSSID of AP
4893 * @preauth: Whether AP advertises support for RSN pre-authentication
4894 * @gfp: allocation flags
4895 */
4896void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
4897                                     const u8 *bssid, bool preauth, gfp_t gfp);
4898
4899/**
4900 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
4901 * @dev: The device the frame matched to
4902 * @addr: the transmitter address
4903 * @gfp: context flags
4904 *
4905 * This function is used in AP mode (only!) to inform userspace that
4906 * a spurious class 3 frame was received, to be able to deauth the
4907 * sender.
4908 * Return: %true if the frame was passed to userspace (or this failed
4909 * for a reason other than not having a subscription.)
4910 */
4911bool cfg80211_rx_spurious_frame(struct net_device *dev,
4912                                const u8 *addr, gfp_t gfp);
4913
4914/**
4915 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
4916 * @dev: The device the frame matched to
4917 * @addr: the transmitter address
4918 * @gfp: context flags
4919 *
4920 * This function is used in AP mode (only!) to inform userspace that
4921 * an associated station sent a 4addr frame but that wasn't expected.
4922 * It is allowed and desirable to send this event only once for each
4923 * station to avoid event flooding.
4924 * Return: %true if the frame was passed to userspace (or this failed
4925 * for a reason other than not having a subscription.)
4926 */
4927bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
4928                                        const u8 *addr, gfp_t gfp);
4929
4930/**
4931 * cfg80211_probe_status - notify userspace about probe status
4932 * @dev: the device the probe was sent on
4933 * @addr: the address of the peer
4934 * @cookie: the cookie filled in @probe_client previously
4935 * @acked: indicates whether probe was acked or not
4936 * @gfp: allocation flags
4937 */
4938void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
4939                           u64 cookie, bool acked, gfp_t gfp);
4940
4941/**
4942 * cfg80211_report_obss_beacon - report beacon from other APs
4943 * @wiphy: The wiphy that received the beacon
4944 * @frame: the frame
4945 * @len: length of the frame
4946 * @freq: frequency the frame was received on
4947 * @sig_dbm: signal strength in mBm, or 0 if unknown
4948 *
4949 * Use this function to report to userspace when a beacon was
4950 * received. It is not useful to call this when there is no
4951 * netdev that is in AP/GO mode.
4952 */
4953void cfg80211_report_obss_beacon(struct wiphy *wiphy,
4954                                 const u8 *frame, size_t len,
4955                                 int freq, int sig_dbm);
4956
4957/**
4958 * cfg80211_reg_can_beacon - check if beaconing is allowed
4959 * @wiphy: the wiphy
4960 * @chandef: the channel definition
4961 * @iftype: interface type
4962 *
4963 * Return: %true if there is no secondary channel or the secondary channel(s)
4964 * can be used for beaconing (i.e. is not a radar channel etc.)
4965 */
4966bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
4967                             struct cfg80211_chan_def *chandef,
4968                             enum nl80211_iftype iftype);
4969
4970/**
4971 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
4972 * @wiphy: the wiphy
4973 * @chandef: the channel definition
4974 * @iftype: interface type
4975 *
4976 * Return: %true if there is no secondary channel or the secondary channel(s)
4977 * can be used for beaconing (i.e. is not a radar channel etc.). This version
4978 * also checks if IR-relaxation conditions apply, to allow beaconing under
4979 * more permissive conditions.
4980 *
4981 * Requires the RTNL to be held.
4982 */
4983bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
4984                                   struct cfg80211_chan_def *chandef,
4985                                   enum nl80211_iftype iftype);
4986
4987/*
4988 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
4989 * @dev: the device which switched channels
4990 * @chandef: the new channel definition
4991 *
4992 * Caller must acquire wdev_lock, therefore must only be called from sleepable
4993 * driver context!
4994 */
4995void cfg80211_ch_switch_notify(struct net_device *dev,
4996                               struct cfg80211_chan_def *chandef);
4997
4998/*
4999 * cfg80211_ch_switch_started_notify - notify channel switch start
5000 * @dev: the device on which the channel switch started
5001 * @chandef: the future channel definition
5002 * @count: the number of TBTTs until the channel switch happens
5003 *
5004 * Inform the userspace about the channel switch that has just
5005 * started, so that it can take appropriate actions (eg. starting
5006 * channel switch on other vifs), if necessary.
5007 */
5008void cfg80211_ch_switch_started_notify(struct net_device *dev,
5009                                       struct cfg80211_chan_def *chandef,
5010                                       u8 count);
5011
5012/**
5013 * ieee80211_operating_class_to_band - convert operating class to band
5014 *
5015 * @operating_class: the operating class to convert
5016 * @band: band pointer to fill
5017 *
5018 * Returns %true if the conversion was successful, %false otherwise.
5019 */
5020bool ieee80211_operating_class_to_band(u8 operating_class,
5021                                       enum ieee80211_band *band);
5022
5023/**
5024 * ieee80211_chandef_to_operating_class - convert chandef to operation class
5025 *
5026 * @chandef: the chandef to convert
5027 * @op_class: a pointer to the resulting operating class
5028 *
5029 * Returns %true if the conversion was successful, %false otherwise.
5030 */
5031bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
5032                                          u8 *op_class);
5033
5034/*
5035 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
5036 * @dev: the device on which the operation is requested
5037 * @peer: the MAC address of the peer device
5038 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
5039 *      NL80211_TDLS_TEARDOWN)
5040 * @reason_code: the reason code for teardown request
5041 * @gfp: allocation flags
5042 *
5043 * This function is used to request userspace to perform TDLS operation that
5044 * requires knowledge of keys, i.e., link setup or teardown when the AP
5045 * connection uses encryption. This is optional mechanism for the driver to use
5046 * if it can automatically determine when a TDLS link could be useful (e.g.,
5047 * based on traffic and signal strength for a peer).
5048 */
5049void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
5050                                enum nl80211_tdls_operation oper,
5051                                u16 reason_code, gfp_t gfp);
5052
5053/*
5054 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
5055 * @rate: given rate_info to calculate bitrate from
5056 *
5057 * return 0 if MCS index >= 32
5058 */
5059u32 cfg80211_calculate_bitrate(struct rate_info *rate);
5060
5061/**
5062 * cfg80211_unregister_wdev - remove the given wdev
5063 * @wdev: struct wireless_dev to remove
5064 *
5065 * Call this function only for wdevs that have no netdev assigned,
5066 * e.g. P2P Devices. It removes the device from the list so that
5067 * it can no longer be used. It is necessary to call this function
5068 * even when cfg80211 requests the removal of the interface by
5069 * calling the del_virtual_intf() callback. The function must also
5070 * be called when the driver wishes to unregister the wdev, e.g.
5071 * when the device is unbound from the driver.
5072 *
5073 * Requires the RTNL to be held.
5074 */
5075void cfg80211_unregister_wdev(struct wireless_dev *wdev);
5076
5077/**
5078 * struct cfg80211_ft_event - FT Information Elements
5079 * @ies: FT IEs
5080 * @ies_len: length of the FT IE in bytes
5081 * @target_ap: target AP's MAC address
5082 * @ric_ies: RIC IE
5083 * @ric_ies_len: length of the RIC IE in bytes
5084 */
5085struct cfg80211_ft_event_params {
5086        const u8 *ies;
5087        size_t ies_len;
5088        const u8 *target_ap;
5089        const u8 *ric_ies;
5090        size_t ric_ies_len;
5091};
5092
5093/**
5094 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
5095 * @netdev: network device
5096 * @ft_event: IE information
5097 */
5098void cfg80211_ft_event(struct net_device *netdev,
5099                       struct cfg80211_ft_event_params *ft_event);
5100
5101/**
5102 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
5103 * @ies: the input IE buffer
5104 * @len: the input length
5105 * @attr: the attribute ID to find
5106 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
5107 *      if the function is only called to get the needed buffer size
5108 * @bufsize: size of the output buffer
5109 *
5110 * The function finds a given P2P attribute in the (vendor) IEs and
5111 * copies its contents to the given buffer.
5112 *
5113 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
5114 * malformed or the attribute can't be found (respectively), or the
5115 * length of the found attribute (which can be zero).
5116 */
5117int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
5118                          enum ieee80211_p2p_attr_id attr,
5119                          u8 *buf, unsigned int bufsize);
5120
5121/**
5122 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
5123 * @ies: the IE buffer
5124 * @ielen: the length of the IE buffer
5125 * @ids: an array with element IDs that are allowed before
5126 *      the split
5127 * @n_ids: the size of the element ID array
5128 * @after_ric: array IE types that come after the RIC element
5129 * @n_after_ric: size of the @after_ric array
5130 * @offset: offset where to start splitting in the buffer
5131 *
5132 * This function splits an IE buffer by updating the @offset
5133 * variable to point to the location where the buffer should be
5134 * split.
5135 *
5136 * It assumes that the given IE buffer is well-formed, this
5137 * has to be guaranteed by the caller!
5138 *
5139 * It also assumes that the IEs in the buffer are ordered
5140 * correctly, if not the result of using this function will not
5141 * be ordered correctly either, i.e. it does no reordering.
5142 *
5143 * The function returns the offset where the next part of the
5144 * buffer starts, which may be @ielen if the entire (remainder)
5145 * of the buffer should be used.
5146 */
5147size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
5148                              const u8 *ids, int n_ids,
5149                              const u8 *after_ric, int n_after_ric,
5150                              size_t offset);
5151
5152/**
5153 * ieee80211_ie_split - split an IE buffer according to ordering
5154 * @ies: the IE buffer
5155 * @ielen: the length of the IE buffer
5156 * @ids: an array with element IDs that are allowed before
5157 *      the split
5158 * @n_ids: the size of the element ID array
5159 * @offset: offset where to start splitting in the buffer
5160 *
5161 * This function splits an IE buffer by updating the @offset
5162 * variable to point to the location where the buffer should be
5163 * split.
5164 *
5165 * It assumes that the given IE buffer is well-formed, this
5166 * has to be guaranteed by the caller!
5167 *
5168 * It also assumes that the IEs in the buffer are ordered
5169 * correctly, if not the result of using this function will not
5170 * be ordered correctly either, i.e. it does no reordering.
5171 *
5172 * The function returns the offset where the next part of the
5173 * buffer starts, which may be @ielen if the entire (remainder)
5174 * of the buffer should be used.
5175 */
5176size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
5177                          const u8 *ids, int n_ids, size_t offset);
5178
5179/**
5180 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
5181 * @wdev: the wireless device reporting the wakeup
5182 * @wakeup: the wakeup report
5183 * @gfp: allocation flags
5184 *
5185 * This function reports that the given device woke up. If it
5186 * caused the wakeup, report the reason(s), otherwise you may
5187 * pass %NULL as the @wakeup parameter to advertise that something
5188 * else caused the wakeup.
5189 */
5190void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
5191                                   struct cfg80211_wowlan_wakeup *wakeup,
5192                                   gfp_t gfp);
5193
5194/**
5195 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
5196 *
5197 * @wdev: the wireless device for which critical protocol is stopped.
5198 * @gfp: allocation flags
5199 *
5200 * This function can be called by the driver to indicate it has reverted
5201 * operation back to normal. One reason could be that the duration given
5202 * by .crit_proto_start() has expired.
5203 */
5204void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
5205
5206/**
5207 * ieee80211_get_num_supported_channels - get number of channels device has
5208 * @wiphy: the wiphy
5209 *
5210 * Return: the number of channels supported by the device.
5211 */
5212unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
5213
5214/**
5215 * cfg80211_check_combinations - check interface combinations
5216 *
5217 * @wiphy: the wiphy
5218 * @num_different_channels: the number of different channels we want
5219 *      to use for verification
5220 * @radar_detect: a bitmap where each bit corresponds to a channel
5221 *      width where radar detection is needed, as in the definition of
5222 *      &struct ieee80211_iface_combination.@radar_detect_widths
5223 * @iftype_num: array with the numbers of interfaces of each interface
5224 *      type.  The index is the interface type as specified in &enum
5225 *      nl80211_iftype.
5226 *
5227 * This function can be called by the driver to check whether a
5228 * combination of interfaces and their types are allowed according to
5229 * the interface combinations.
5230 */
5231int cfg80211_check_combinations(struct wiphy *wiphy,
5232                                const int num_different_channels,
5233                                const u8 radar_detect,
5234                                const int iftype_num[NUM_NL80211_IFTYPES]);
5235
5236/**
5237 * cfg80211_iter_combinations - iterate over matching combinations
5238 *
5239 * @wiphy: the wiphy
5240 * @num_different_channels: the number of different channels we want
5241 *      to use for verification
5242 * @radar_detect: a bitmap where each bit corresponds to a channel
5243 *      width where radar detection is needed, as in the definition of
5244 *      &struct ieee80211_iface_combination.@radar_detect_widths
5245 * @iftype_num: array with the numbers of interfaces of each interface
5246 *      type.  The index is the interface type as specified in &enum
5247 *      nl80211_iftype.
5248 * @iter: function to call for each matching combination
5249 * @data: pointer to pass to iter function
5250 *
5251 * This function can be called by the driver to check what possible
5252 * combinations it fits in at a given moment, e.g. for channel switching
5253 * purposes.
5254 */
5255int cfg80211_iter_combinations(struct wiphy *wiphy,
5256                               const int num_different_channels,
5257                               const u8 radar_detect,
5258                               const int iftype_num[NUM_NL80211_IFTYPES],
5259                               void (*iter)(const struct ieee80211_iface_combination *c,
5260                                            void *data),
5261                               void *data);
5262
5263/*
5264 * cfg80211_stop_iface - trigger interface disconnection
5265 *
5266 * @wiphy: the wiphy
5267 * @wdev: wireless device
5268 * @gfp: context flags
5269 *
5270 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
5271 * disconnected.
5272 *
5273 * Note: This doesn't need any locks and is asynchronous.
5274 */
5275void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
5276                         gfp_t gfp);
5277
5278/**
5279 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
5280 * @wiphy: the wiphy to shut down
5281 *
5282 * This function shuts down all interfaces belonging to this wiphy by
5283 * calling dev_close() (and treating non-netdev interfaces as needed).
5284 * It shouldn't really be used unless there are some fatal device errors
5285 * that really can't be recovered in any other way.
5286 *
5287 * Callers must hold the RTNL and be able to deal with callbacks into
5288 * the driver while the function is running.
5289 */
5290void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
5291
5292/**
5293 * wiphy_ext_feature_set - set the extended feature flag
5294 *
5295 * @wiphy: the wiphy to modify.
5296 * @ftidx: extended feature bit index.
5297 *
5298 * The extended features are flagged in multiple bytes (see
5299 * &struct wiphy.@ext_features)
5300 */
5301static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
5302                                         enum nl80211_ext_feature_index ftidx)
5303{
5304        u8 *ft_byte;
5305
5306        ft_byte = &wiphy->ext_features[ftidx / 8];
5307        *ft_byte |= BIT(ftidx % 8);
5308}
5309
5310/**
5311 * wiphy_ext_feature_isset - check the extended feature flag
5312 *
5313 * @wiphy: the wiphy to modify.
5314 * @ftidx: extended feature bit index.
5315 *
5316 * The extended features are flagged in multiple bytes (see
5317 * &struct wiphy.@ext_features)
5318 */
5319static inline bool
5320wiphy_ext_feature_isset(struct wiphy *wiphy,
5321                        enum nl80211_ext_feature_index ftidx)
5322{
5323        u8 ft_byte;
5324
5325        ft_byte = wiphy->ext_features[ftidx / 8];
5326        return (ft_byte & BIT(ftidx % 8)) != 0;
5327}
5328
5329/* ethtool helper */
5330void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
5331
5332/* Logging, debugging and troubleshooting/diagnostic helpers. */
5333
5334/* wiphy_printk helpers, similar to dev_printk */
5335
5336#define wiphy_printk(level, wiphy, format, args...)             \
5337        dev_printk(level, &(wiphy)->dev, format, ##args)
5338#define wiphy_emerg(wiphy, format, args...)                     \
5339        dev_emerg(&(wiphy)->dev, format, ##args)
5340#define wiphy_alert(wiphy, format, args...)                     \
5341        dev_alert(&(wiphy)->dev, format, ##args)
5342#define wiphy_crit(wiphy, format, args...)                      \
5343        dev_crit(&(wiphy)->dev, format, ##args)
5344#define wiphy_err(wiphy, format, args...)                       \
5345        dev_err(&(wiphy)->dev, format, ##args)
5346#define wiphy_warn(wiphy, format, args...)                      \
5347        dev_warn(&(wiphy)->dev, format, ##args)
5348#define wiphy_notice(wiphy, format, args...)                    \
5349        dev_notice(&(wiphy)->dev, format, ##args)
5350#define wiphy_info(wiphy, format, args...)                      \
5351        dev_info(&(wiphy)->dev, format, ##args)
5352
5353#define wiphy_debug(wiphy, format, args...)                     \
5354        wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
5355
5356#define wiphy_dbg(wiphy, format, args...)                       \
5357        dev_dbg(&(wiphy)->dev, format, ##args)
5358
5359#if defined(VERBOSE_DEBUG)
5360#define wiphy_vdbg      wiphy_dbg
5361#else
5362#define wiphy_vdbg(wiphy, format, args...)                              \
5363({                                                                      \
5364        if (0)                                                          \
5365                wiphy_printk(KERN_DEBUG, wiphy, format, ##args);        \
5366        0;                                                              \
5367})
5368#endif
5369
5370/*
5371 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
5372 * of using a WARN/WARN_ON to get the message out, including the
5373 * file/line information and a backtrace.
5374 */
5375#define wiphy_WARN(wiphy, format, args...)                      \
5376        WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
5377
5378#endif /* __NET_CFG80211_H */
5379