include/net/cfg80211.h

   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  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 as
  10  * published by the Free Software Foundation.
  11  */
  12
  13 #include <linux/netdevice.h>
  14 #include <linux/debugfs.h>
  15 #include <linux/list.h>
  16 #include <linux/bug.h>
  17 #include <linux/netlink.h>
  18 #include <linux/skbuff.h>
  19 #include <linux/nl80211.h>
  20 #include <linux/if_ether.h>
  21 #include <linux/ieee80211.h>
  22 #include <net/regulatory.h>
  23
  24 /**
  25  * DOC: Introduction
  26  *
  27  * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
  28  * userspace and drivers, and offers some utility functionality associated
  29  * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
  30  * by all modern wireless drivers in Linux, so that they offer a consistent
  31  * API through nl80211. For backward compatibility, cfg80211 also offers
  32  * wireless extensions to userspace, but hides them from drivers completely.
  33  *
  34  * Additionally, cfg80211 contains code to help enforce regulatory spectrum
  35  * use restrictions.
  36  */
  37
  38
  39 /**
  40  * DOC: Device registration
  41  *
  42  * In order for a driver to use cfg80211, it must register the hardware device
  43  * with cfg80211. This happens through a number of hardware capability structs
  44  * described below.
  45  *
  46  * The fundamental structure for each device is the 'wiphy', of which each
  47  * instance describes a physical wireless device connected to the system. Each
  48  * such wiphy can have zero, one, or many virtual interfaces associated with
  49  * it, which need to be identified as such by pointing the network interface's
  50  * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
  51  * the wireless part of the interface, normally this struct is embedded in the
  52  * network interface's private data area. Drivers can optionally allow creating
  53  * or destroying virtual interfaces on the fly, but without at least one or the
  54  * ability to create some the wireless device isn't useful.
  55  *
  56  * Each wiphy structure contains device capability information, and also has
  57  * a pointer to the various operations the driver offers. The definitions and
  58  * structures here describe these capabilities in detail.
  59  */
  60
  61 struct wiphy;
  62
  63 /*
  64  * wireless hardware capability structures
  65  */
  66
  67 /**
  68  * enum ieee80211_band - supported frequency bands
  69  *
  70  * The bands are assigned this way because the supported
  71  * bitrates differ in these bands.
  72  *
  73  * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
  74  * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
  75  * @IEEE80211_BAND_60GHZ: around 60 GHz band (58.32 - 64.80 GHz)
  76  * @IEEE80211_NUM_BANDS: number of defined bands
  77  */
  78 enum ieee80211_band {
  79         IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
  80         IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
  81         IEEE80211_BAND_60GHZ = NL80211_BAND_60GHZ,
  82
  83         /* keep last */
  84         IEEE80211_NUM_BANDS
  85 };
  86
  87 /**
  88  * enum ieee80211_channel_flags - channel flags
  89  *
  90  * Channel flags set by the regulatory control code.
  91  *
  92  * @IEEE80211_CHAN_DISABLED: This channel is disabled.
  93  * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
  94  *      on this channel.
  95  * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
  96  * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
  97  * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
  98  *      is not permitted.
  99  * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
 100  *      is not permitted.
 101  * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
 102  */
 103 enum ieee80211_channel_flags {
 104         IEEE80211_CHAN_DISABLED         = 1<<0,
 105         IEEE80211_CHAN_PASSIVE_SCAN     = 1<<1,
 106         IEEE80211_CHAN_NO_IBSS          = 1<<2,
 107         IEEE80211_CHAN_RADAR            = 1<<3,
 108         IEEE80211_CHAN_NO_HT40PLUS      = 1<<4,
 109         IEEE80211_CHAN_NO_HT40MINUS     = 1<<5,
 110         IEEE80211_CHAN_NO_OFDM          = 1<<6,
 111 };
 112
 113 #define IEEE80211_CHAN_NO_HT40 \
 114         (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
 115
 116 /**
 117  * struct ieee80211_channel - channel definition
 118  *
 119  * This structure describes a single channel for use
 120  * with cfg80211.
 121  *
 122  * @center_freq: center frequency in MHz
 123  * @hw_value: hardware-specific value for the channel
 124  * @flags: channel flags from &enum ieee80211_channel_flags.
 125  * @orig_flags: channel flags at registration time, used by regulatory
 126  *      code to support devices with additional restrictions
 127  * @band: band this channel belongs to.
 128  * @max_antenna_gain: maximum antenna gain in dBi
 129  * @max_power: maximum transmission power (in dBm)
 130  * @max_reg_power: maximum regulatory transmission power (in dBm)
 131  * @beacon_found: helper to regulatory code to indicate when a beacon
 132  *      has been found on this channel. Use regulatory_hint_found_beacon()
 133  *      to enable this, this is useful only on 5 GHz band.
 134  * @orig_mag: internal use
 135  * @orig_mpwr: internal use
 136  */
 137 struct ieee80211_channel {
 138         enum ieee80211_band band;
 139         u16 center_freq;
 140         u16 hw_value;
 141         u32 flags;
 142         int max_antenna_gain;
 143         int max_power;
 144         int max_reg_power;
 145         bool beacon_found;
 146         u32 orig_flags;
 147         int orig_mag, orig_mpwr;
 148 };
 149
 150 /**
 151  * enum ieee80211_rate_flags - rate flags
 152  *
 153  * Hardware/specification flags for rates. These are structured
 154  * in a way that allows using the same bitrate structure for
 155  * different bands/PHY modes.
 156  *
 157  * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
 158  *      preamble on this bitrate; only relevant in 2.4GHz band and
 159  *      with CCK rates.
 160  * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
 161  *      when used with 802.11a (on the 5 GHz band); filled by the
 162  *      core code when registering the wiphy.
 163  * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
 164  *      when used with 802.11b (on the 2.4 GHz band); filled by the
 165  *      core code when registering the wiphy.
 166  * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
 167  *      when used with 802.11g (on the 2.4 GHz band); filled by the
 168  *      core code when registering the wiphy.
 169  * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
 170  */
 171 enum ieee80211_rate_flags {
 172         IEEE80211_RATE_SHORT_PREAMBLE   = 1<<0,
 173         IEEE80211_RATE_MANDATORY_A      = 1<<1,
 174         IEEE80211_RATE_MANDATORY_B      = 1<<2,
 175         IEEE80211_RATE_MANDATORY_G      = 1<<3,
 176         IEEE80211_RATE_ERP_G            = 1<<4,
 177 };
 178
 179 /**
 180  * struct ieee80211_rate - bitrate definition
 181  *
 182  * This structure describes a bitrate that an 802.11 PHY can
 183  * operate with. The two values @hw_value and @hw_value_short
 184  * are only for driver use when pointers to this structure are
 185  * passed around.
 186  *
 187  * @flags: rate-specific flags
 188  * @bitrate: bitrate in units of 100 Kbps
 189  * @hw_value: driver/hardware value for this rate
 190  * @hw_value_short: driver/hardware value for this rate when
 191  *      short preamble is used
 192  */
 193 struct ieee80211_rate {
 194         u32 flags;
 195         u16 bitrate;
 196         u16 hw_value, hw_value_short;
 197 };
 198
 199 /**
 200  * struct ieee80211_sta_ht_cap - STA's HT capabilities
 201  *
 202  * This structure describes most essential parameters needed
 203  * to describe 802.11n HT capabilities for an STA.
 204  *
 205  * @ht_supported: is HT supported by the STA
 206  * @cap: HT capabilities map as described in 802.11n spec
 207  * @ampdu_factor: Maximum A-MPDU length factor
 208  * @ampdu_density: Minimum A-MPDU spacing
 209  * @mcs: Supported MCS rates
 210  */
 211 struct ieee80211_sta_ht_cap {
 212         u16 cap; /* use IEEE80211_HT_CAP_ */
 213         bool ht_supported;
 214         u8 ampdu_factor;
 215         u8 ampdu_density;
 216         struct ieee80211_mcs_info mcs;
 217 };
 218
 219 /**
 220  * struct ieee80211_sta_vht_cap - STA's VHT capabilities
 221  *
 222  * This structure describes most essential parameters needed
 223  * to describe 802.11ac VHT capabilities for an STA.
 224  *
 225  * @vht_supported: is VHT supported by the STA
 226  * @cap: VHT capabilities map as described in 802.11ac spec
 227  * @vht_mcs: Supported VHT MCS rates
 228  */
 229 struct ieee80211_sta_vht_cap {
 230         bool vht_supported;
 231         u32 cap; /* use IEEE80211_VHT_CAP_ */
 232         struct ieee80211_vht_mcs_info vht_mcs;
 233 };
 234
 235 /**
 236  * struct ieee80211_supported_band - frequency band definition
 237  *
 238  * This structure describes a frequency band a wiphy
 239  * is able to operate in.
 240  *
 241  * @channels: Array of channels the hardware can operate in
 242  *      in this band.
 243  * @band: the band this structure represents
 244  * @n_channels: Number of channels in @channels
 245  * @bitrates: Array of bitrates the hardware can operate with
 246  *      in this band. Must be sorted to give a valid "supported
 247  *      rates" IE, i.e. CCK rates first, then OFDM.
 248  * @n_bitrates: Number of bitrates in @bitrates
 249  * @ht_cap: HT capabilities in this band
 250  * @vht_cap: VHT capabilities in this band
 251  */
 252 struct ieee80211_supported_band {
 253         struct ieee80211_channel *channels;
 254         struct ieee80211_rate *bitrates;
 255         enum ieee80211_band band;
 256         int n_channels;
 257         int n_bitrates;
 258         struct ieee80211_sta_ht_cap ht_cap;
 259         struct ieee80211_sta_vht_cap vht_cap;
 260 };
 261
 262 /*
 263  * Wireless hardware/device configuration structures and methods
 264  */
 265
 266 /**
 267  * DOC: Actions and configuration
 268  *
 269  * Each wireless device and each virtual interface offer a set of configuration
 270  * operations and other actions that are invoked by userspace. Each of these
 271  * actions is described in the operations structure, and the parameters these
 272  * operations use are described separately.
 273  *
 274  * Additionally, some operations are asynchronous and expect to get status
 275  * information via some functions that drivers need to call.
 276  *
 277  * Scanning and BSS list handling with its associated functionality is described
 278  * in a separate chapter.
 279  */
 280
 281 /**
 282  * struct vif_params - describes virtual interface parameters
 283  * @use_4addr: use 4-address frames
 284  * @macaddr: address to use for this virtual interface. This will only
 285  *      be used for non-netdevice interfaces. If this parameter is set
 286  *      to zero address the driver may determine the address as needed.
 287  */
 288 struct vif_params {
 289        int use_4addr;
 290        u8 macaddr[ETH_ALEN];
 291 };
 292
 293 /**
 294  * struct key_params - key information
 295  *
 296  * Information about a key
 297  *
 298  * @key: key material
 299  * @key_len: length of key material
 300  * @cipher: cipher suite selector
 301  * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
 302  *      with the get_key() callback, must be in little endian,
 303  *      length given by @seq_len.
 304  * @seq_len: length of @seq.
 305  */
 306 struct key_params {
 307         u8 *key;
 308         u8 *seq;
 309         int key_len;
 310         int seq_len;
 311         u32 cipher;
 312 };
 313
 314 /**
 315  * struct cfg80211_chan_def - channel definition
 316  * @chan: the (control) channel
 317  * @width: channel width
 318  * @center_freq1: center frequency of first segment
 319  * @center_freq2: center frequency of second segment
 320  *      (only with 80+80 MHz)
 321  */
 322 struct cfg80211_chan_def {
 323         struct ieee80211_channel *chan;
 324         enum nl80211_chan_width width;
 325         u32 center_freq1;
 326         u32 center_freq2;
 327 };
 328
 329 /**
 330  * cfg80211_get_chandef_type - return old channel type from chandef
 331  * @chandef: the channel definition
 332  *
 333  * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
 334  * chandef, which must have a bandwidth allowing this conversion.
 335  */
 336 static inline enum nl80211_channel_type
 337 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
 338 {
 339         switch (chandef->width) {
 340         case NL80211_CHAN_WIDTH_20_NOHT:
 341                 return NL80211_CHAN_NO_HT;
 342         case NL80211_CHAN_WIDTH_20:
 343                 return NL80211_CHAN_HT20;
 344         case NL80211_CHAN_WIDTH_40:
 345                 if (chandef->center_freq1 > chandef->chan->center_freq)
 346                         return NL80211_CHAN_HT40PLUS;
 347                 return NL80211_CHAN_HT40MINUS;
 348         default:
 349                 WARN_ON(1);
 350                 return NL80211_CHAN_NO_HT;
 351         }
 352 }
 353
 354 /**
 355  * cfg80211_chandef_create - create channel definition using channel type
 356  * @chandef: the channel definition struct to fill
 357  * @channel: the control channel
 358  * @chantype: the channel type
 359  *
 360  * Given a channel type, create a channel definition.
 361  */
 362 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
 363                              struct ieee80211_channel *channel,
 364                              enum nl80211_channel_type chantype);
 365
 366 /**
 367  * cfg80211_chandef_identical - check if two channel definitions are identical
 368  * @chandef1: first channel definition
 369  * @chandef2: second channel definition
 370  *
 371  * Return: %true if the channels defined by the channel definitions are
 372  * identical, %false otherwise.
 373  */
 374 static inline bool
 375 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
 376                            const struct cfg80211_chan_def *chandef2)
 377 {
 378         return (chandef1->chan == chandef2->chan &&
 379                 chandef1->width == chandef2->width &&
 380                 chandef1->center_freq1 == chandef2->center_freq1 &&
 381                 chandef1->center_freq2 == chandef2->center_freq2);
 382 }
 383
 384 /**
 385  * cfg80211_chandef_compatible - check if two channel definitions are compatible
 386  * @chandef1: first channel definition
 387  * @chandef2: second channel definition
 388  *
 389  * Return: %NULL if the given channel definitions are incompatible,
 390  * chandef1 or chandef2 otherwise.
 391  */
 392 const struct cfg80211_chan_def *
 393 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
 394                             const struct cfg80211_chan_def *chandef2);
 395
 396 /**
 397  * cfg80211_chandef_valid - check if a channel definition is valid
 398  * @chandef: the channel definition to check
 399  * Return: %true if the channel definition is valid. %false otherwise.
 400  */
 401 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
 402
 403 /**
 404  * cfg80211_chandef_usable - check if secondary channels can be used
 405  * @wiphy: the wiphy to validate against
 406  * @chandef: the channel definition to check
 407  * @prohibited_flags: the regulatory channel flags that must not be set
 408  * Return: %true if secondary channels are usable. %false otherwise.
 409  */
 410 bool cfg80211_chandef_usable(struct wiphy *wiphy,
 411                              const struct cfg80211_chan_def *chandef,
 412                              u32 prohibited_flags);
 413
 414 /**
 415  * enum survey_info_flags - survey information flags
 416  *
 417  * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
 418  * @SURVEY_INFO_IN_USE: channel is currently being used
 419  * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
 420  * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
 421  * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
 422  * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
 423  * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
 424  *
 425  * Used by the driver to indicate which info in &struct survey_info
 426  * it has filled in during the get_survey().
 427  */
 428 enum survey_info_flags {
 429         SURVEY_INFO_NOISE_DBM = 1<<0,
 430         SURVEY_INFO_IN_USE = 1<<1,
 431         SURVEY_INFO_CHANNEL_TIME = 1<<2,
 432         SURVEY_INFO_CHANNEL_TIME_BUSY = 1<<3,
 433         SURVEY_INFO_CHANNEL_TIME_EXT_BUSY = 1<<4,
 434         SURVEY_INFO_CHANNEL_TIME_RX = 1<<5,
 435         SURVEY_INFO_CHANNEL_TIME_TX = 1<<6,
 436 };
 437
 438 /**
 439  * struct survey_info - channel survey response
 440  *
 441  * @channel: the channel this survey record reports, mandatory
 442  * @filled: bitflag of flags from &enum survey_info_flags
 443  * @noise: channel noise in dBm. This and all following fields are
 444  *     optional
 445  * @channel_time: amount of time in ms the radio spent on the channel
 446  * @channel_time_busy: amount of time the primary channel was sensed busy
 447  * @channel_time_ext_busy: amount of time the extension channel was sensed busy
 448  * @channel_time_rx: amount of time the radio spent receiving data
 449  * @channel_time_tx: amount of time the radio spent transmitting data
 450  *
 451  * Used by dump_survey() to report back per-channel survey information.
 452  *
 453  * This structure can later be expanded with things like
 454  * channel duty cycle etc.
 455  */
 456 struct survey_info {
 457         struct ieee80211_channel *channel;
 458         u64 channel_time;
 459         u64 channel_time_busy;
 460         u64 channel_time_ext_busy;
 461         u64 channel_time_rx;
 462         u64 channel_time_tx;
 463         u32 filled;
 464         s8 noise;
 465 };
 466
 467 /**
 468  * struct cfg80211_crypto_settings - Crypto settings
 469  * @wpa_versions: indicates which, if any, WPA versions are enabled
 470  *      (from enum nl80211_wpa_versions)
 471  * @cipher_group: group key cipher suite (or 0 if unset)
 472  * @n_ciphers_pairwise: number of AP supported unicast ciphers
 473  * @ciphers_pairwise: unicast key cipher suites
 474  * @n_akm_suites: number of AKM suites
 475  * @akm_suites: AKM suites
 476  * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
 477  *      sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
 478  *      required to assume that the port is unauthorized until authorized by
 479  *      user space. Otherwise, port is marked authorized by default.
 480  * @control_port_ethertype: the control port protocol that should be
 481  *      allowed through even on unauthorized ports
 482  * @control_port_no_encrypt: TRUE to prevent encryption of control port
 483  *      protocol frames.
 484  */
 485 struct cfg80211_crypto_settings {
 486         u32 wpa_versions;
 487         u32 cipher_group;
 488         int n_ciphers_pairwise;
 489         u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
 490         int n_akm_suites;
 491         u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
 492         bool control_port;
 493         __be16 control_port_ethertype;
 494         bool control_port_no_encrypt;
 495 };
 496
 497 /**
 498  * struct cfg80211_beacon_data - beacon data
 499  * @head: head portion of beacon (before TIM IE)
 500  *     or %NULL if not changed
 501  * @tail: tail portion of beacon (after TIM IE)
 502  *     or %NULL if not changed
 503  * @head_len: length of @head
 504  * @tail_len: length of @tail
 505  * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
 506  * @beacon_ies_len: length of beacon_ies in octets
 507  * @proberesp_ies: extra information element(s) to add into Probe Response
 508  *      frames or %NULL
 509  * @proberesp_ies_len: length of proberesp_ies in octets
 510  * @assocresp_ies: extra information element(s) to add into (Re)Association
 511  *      Response frames or %NULL
 512  * @assocresp_ies_len: length of assocresp_ies in octets
 513  * @probe_resp_len: length of probe response template (@probe_resp)
 514  * @probe_resp: probe response template (AP mode only)
 515  */
 516 struct cfg80211_beacon_data {
 517         const u8 *head, *tail;
 518         const u8 *beacon_ies;
 519         const u8 *proberesp_ies;
 520         const u8 *assocresp_ies;
 521         const u8 *probe_resp;
 522
 523         size_t head_len, tail_len;
 524         size_t beacon_ies_len;
 525         size_t proberesp_ies_len;
 526         size_t assocresp_ies_len;
 527         size_t probe_resp_len;
 528 };
 529
 530 struct mac_address {
 531         u8 addr[ETH_ALEN];
 532 };
 533
 534 /**
 535  * struct cfg80211_acl_data - Access control list data
 536  *
 537  * @acl_policy: ACL policy to be applied on the station's
 538         entry specified by mac_addr
 539  * @n_acl_entries: Number of MAC address entries passed
 540  * @mac_addrs: List of MAC addresses of stations to be used for ACL
 541  */
 542 struct cfg80211_acl_data {
 543         enum nl80211_acl_policy acl_policy;
 544         int n_acl_entries;
 545
 546         /* Keep it last */
 547         struct mac_address mac_addrs[];
 548 };
 549
 550 /**
 551  * struct cfg80211_ap_settings - AP configuration
 552  *
 553  * Used to configure an AP interface.
 554  *
 555  * @chandef: defines the channel to use
 556  * @beacon: beacon data
 557  * @beacon_interval: beacon interval
 558  * @dtim_period: DTIM period
 559  * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
 560  *      user space)
 561  * @ssid_len: length of @ssid
 562  * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
 563  * @crypto: crypto settings
 564  * @privacy: the BSS uses privacy
 565  * @auth_type: Authentication type (algorithm)
 566  * @inactivity_timeout: time in seconds to determine station's inactivity.
 567  * @p2p_ctwindow: P2P CT Window
 568  * @p2p_opp_ps: P2P opportunistic PS
 569  * @acl: ACL configuration used by the drivers which has support for
 570  *      MAC address based access control
 571  */
 572 struct cfg80211_ap_settings {
 573         struct cfg80211_chan_def chandef;
 574
 575         struct cfg80211_beacon_data beacon;
 576
 577         int beacon_interval, dtim_period;
 578         const u8 *ssid;
 579         size_t ssid_len;
 580         enum nl80211_hidden_ssid hidden_ssid;
 581         struct cfg80211_crypto_settings crypto;
 582         bool privacy;
 583         enum nl80211_auth_type auth_type;
 584         int inactivity_timeout;
 585         u8 p2p_ctwindow;
 586         bool p2p_opp_ps;
 587         const struct cfg80211_acl_data *acl;
 588 };
 589
 590 /**
 591  * enum plink_action - actions to perform in mesh peers
 592  *
 593  * @PLINK_ACTION_INVALID: action 0 is reserved
 594  * @PLINK_ACTION_OPEN: start mesh peer link establishment
 595  * @PLINK_ACTION_BLOCK: block traffic from this mesh peer
 596  */
 597 enum plink_actions {
 598         PLINK_ACTION_INVALID,
 599         PLINK_ACTION_OPEN,
 600         PLINK_ACTION_BLOCK,
 601 };
 602
 603 /**
 604  * enum station_parameters_apply_mask - station parameter values to apply
 605  * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
 606  *
 607  * Not all station parameters have in-band "no change" signalling,
 608  * for those that don't these flags will are used.
 609  */
 610 enum station_parameters_apply_mask {
 611         STATION_PARAM_APPLY_UAPSD = BIT(0),
 612 };
 613
 614 /**
 615  * struct station_parameters - station parameters
 616  *
 617  * Used to change and create a new station.
 618  *
 619  * @vlan: vlan interface station should belong to
 620  * @supported_rates: supported rates in IEEE 802.11 format
 621  *      (or NULL for no change)
 622  * @supported_rates_len: number of supported rates
 623  * @sta_flags_mask: station flags that changed
 624  *      (bitmask of BIT(NL80211_STA_FLAG_...))
 625  * @sta_flags_set: station flags values
 626  *      (bitmask of BIT(NL80211_STA_FLAG_...))
 627  * @listen_interval: listen interval or -1 for no change
 628  * @aid: AID or zero for no change
 629  * @plink_action: plink action to take
 630  * @plink_state: set the peer link state for a station
 631  * @ht_capa: HT capabilities of station
 632  * @vht_capa: VHT capabilities of station
 633  * @uapsd_queues: bitmap of queues configured for uapsd. same format
 634  *      as the AC bitmap in the QoS info field
 635  * @max_sp: max Service Period. same format as the MAX_SP in the
 636  *      QoS info field (but already shifted down)
 637  * @sta_modify_mask: bitmap indicating which parameters changed
 638  *      (for those that don't have a natural "no change" value),
 639  *      see &enum station_parameters_apply_mask
 640  * @local_pm: local link-specific mesh power save mode (no change when set
 641  *      to unknown)
 642  */
 643 struct station_parameters {
 644         u8 *supported_rates;
 645         struct net_device *vlan;
 646         u32 sta_flags_mask, sta_flags_set;
 647         u32 sta_modify_mask;
 648         int listen_interval;
 649         u16 aid;
 650         u8 supported_rates_len;
 651         u8 plink_action;
 652         u8 plink_state;
 653         struct ieee80211_ht_cap *ht_capa;
 654         struct ieee80211_vht_cap *vht_capa;
 655         u8 uapsd_queues;
 656         u8 max_sp;
 657         enum nl80211_mesh_power_mode local_pm;
 658 };
 659
 660 /**
 661  * enum station_info_flags - station information flags
 662  *
 663  * Used by the driver to indicate which info in &struct station_info
 664  * it has filled in during get_station() or dump_station().
 665  *
 666  * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
 667  * @STATION_INFO_RX_BYTES: @rx_bytes filled
 668  * @STATION_INFO_TX_BYTES: @tx_bytes filled
 669  * @STATION_INFO_LLID: @llid filled
 670  * @STATION_INFO_PLID: @plid filled
 671  * @STATION_INFO_PLINK_STATE: @plink_state filled
 672  * @STATION_INFO_SIGNAL: @signal filled
 673  * @STATION_INFO_TX_BITRATE: @txrate fields are filled
 674  *  (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
 675  * @STATION_INFO_RX_PACKETS: @rx_packets filled
 676  * @STATION_INFO_TX_PACKETS: @tx_packets filled
 677  * @STATION_INFO_TX_RETRIES: @tx_retries filled
 678  * @STATION_INFO_TX_FAILED: @tx_failed filled
 679  * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
 680  * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
 681  * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
 682  * @STATION_INFO_BSS_PARAM: @bss_param filled
 683  * @STATION_INFO_CONNECTED_TIME: @connected_time filled
 684  * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled
 685  * @STATION_INFO_STA_FLAGS: @sta_flags filled
 686  * @STATION_INFO_BEACON_LOSS_COUNT: @beacon_loss_count filled
 687  * @STATION_INFO_T_OFFSET: @t_offset filled
 688  * @STATION_INFO_LOCAL_PM: @local_pm filled
 689  * @STATION_INFO_PEER_PM: @peer_pm filled
 690  * @STATION_INFO_NONPEER_PM: @nonpeer_pm filled
 691  */
 692 enum station_info_flags {
 693         STATION_INFO_INACTIVE_TIME      = 1<<0,
 694         STATION_INFO_RX_BYTES           = 1<<1,
 695         STATION_INFO_TX_BYTES           = 1<<2,
 696         STATION_INFO_LLID               = 1<<3,
 697         STATION_INFO_PLID               = 1<<4,
 698         STATION_INFO_PLINK_STATE        = 1<<5,
 699         STATION_INFO_SIGNAL             = 1<<6,
 700         STATION_INFO_TX_BITRATE         = 1<<7,
 701         STATION_INFO_RX_PACKETS         = 1<<8,
 702         STATION_INFO_TX_PACKETS         = 1<<9,
 703         STATION_INFO_TX_RETRIES         = 1<<10,
 704         STATION_INFO_TX_FAILED          = 1<<11,
 705         STATION_INFO_RX_DROP_MISC       = 1<<12,
 706         STATION_INFO_SIGNAL_AVG         = 1<<13,
 707         STATION_INFO_RX_BITRATE         = 1<<14,
 708         STATION_INFO_BSS_PARAM          = 1<<15,
 709         STATION_INFO_CONNECTED_TIME     = 1<<16,
 710         STATION_INFO_ASSOC_REQ_IES      = 1<<17,
 711         STATION_INFO_STA_FLAGS          = 1<<18,
 712         STATION_INFO_BEACON_LOSS_COUNT  = 1<<19,
 713         STATION_INFO_T_OFFSET           = 1<<20,
 714         STATION_INFO_LOCAL_PM           = 1<<21,
 715         STATION_INFO_PEER_PM            = 1<<22,
 716         STATION_INFO_NONPEER_PM         = 1<<23,
 717 };
 718
 719 /**
 720  * enum station_info_rate_flags - bitrate info flags
 721  *
 722  * Used by the driver to indicate the specific rate transmission
 723  * type for 802.11n transmissions.
 724  *
 725  * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
 726  * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
 727  * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 MHz width transmission
 728  * @RATE_INFO_FLAGS_80_MHZ_WIDTH: 80 MHz width transmission
 729  * @RATE_INFO_FLAGS_80P80_MHZ_WIDTH: 80+80 MHz width transmission
 730  * @RATE_INFO_FLAGS_160_MHZ_WIDTH: 160 MHz width transmission
 731  * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
 732  * @RATE_INFO_FLAGS_60G: 60GHz MCS
 733  */
 734 enum rate_info_flags {
 735         RATE_INFO_FLAGS_MCS                     = BIT(0),
 736         RATE_INFO_FLAGS_VHT_MCS                 = BIT(1),
 737         RATE_INFO_FLAGS_40_MHZ_WIDTH            = BIT(2),
 738         RATE_INFO_FLAGS_80_MHZ_WIDTH            = BIT(3),
 739         RATE_INFO_FLAGS_80P80_MHZ_WIDTH         = BIT(4),
 740         RATE_INFO_FLAGS_160_MHZ_WIDTH           = BIT(5),
 741         RATE_INFO_FLAGS_SHORT_GI                = BIT(6),
 742         RATE_INFO_FLAGS_60G                     = BIT(7),
 743 };
 744
 745 /**
 746  * struct rate_info - bitrate information
 747  *
 748  * Information about a receiving or transmitting bitrate
 749  *
 750  * @flags: bitflag of flags from &enum rate_info_flags
 751  * @mcs: mcs index if struct describes a 802.11n bitrate
 752  * @legacy: bitrate in 100kbit/s for 802.11abg
 753  * @nss: number of streams (VHT only)
 754  */
 755 struct rate_info {
 756         u8 flags;
 757         u8 mcs;
 758         u16 legacy;
 759         u8 nss;
 760 };
 761
 762 /**
 763  * enum station_info_rate_flags - bitrate info flags
 764  *
 765  * Used by the driver to indicate the specific rate transmission
 766  * type for 802.11n transmissions.
 767  *
 768  * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
 769  * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
 770  * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
 771  */
 772 enum bss_param_flags {
 773         BSS_PARAM_FLAGS_CTS_PROT        = 1<<0,
 774         BSS_PARAM_FLAGS_SHORT_PREAMBLE  = 1<<1,
 775         BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
 776 };
 777
 778 /**
 779  * struct sta_bss_parameters - BSS parameters for the attached station
 780  *
 781  * Information about the currently associated BSS
 782  *
 783  * @flags: bitflag of flags from &enum bss_param_flags
 784  * @dtim_period: DTIM period for the BSS
 785  * @beacon_interval: beacon interval
 786  */
 787 struct sta_bss_parameters {
 788         u8 flags;
 789         u8 dtim_period;
 790         u16 beacon_interval;
 791 };
 792
 793 /**
 794  * struct station_info - station information
 795  *
 796  * Station information filled by driver for get_station() and dump_station.
 797  *
 798  * @filled: bitflag of flags from &enum station_info_flags
 799  * @connected_time: time(in secs) since a station is last connected
 800  * @inactive_time: time since last station activity (tx/rx) in milliseconds
 801  * @rx_bytes: bytes received from this station
 802  * @tx_bytes: bytes transmitted to this station
 803  * @llid: mesh local link id
 804  * @plid: mesh peer link id
 805  * @plink_state: mesh peer link state
 806  * @signal: The signal strength, type depends on the wiphy's signal_type.
 807  *      For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
 808  * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
 809  *      For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
 810  * @txrate: current unicast bitrate from this station
 811  * @rxrate: current unicast bitrate to this station
 812  * @rx_packets: packets received from this station
 813  * @tx_packets: packets transmitted to this station
 814  * @tx_retries: cumulative retry counts
 815  * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
 816  * @rx_dropped_misc:  Dropped for un-specified reason.
 817  * @bss_param: current BSS parameters
 818  * @generation: generation number for nl80211 dumps.
 819  *      This number should increase every time the list of stations
 820  *      changes, i.e. when a station is added or removed, so that
 821  *      userspace can tell whether it got a consistent snapshot.
 822  * @assoc_req_ies: IEs from (Re)Association Request.
 823  *      This is used only when in AP mode with drivers that do not use
 824  *      user space MLME/SME implementation. The information is provided for
 825  *      the cfg80211_new_sta() calls to notify user space of the IEs.
 826  * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
 827  * @sta_flags: station flags mask & values
 828  * @beacon_loss_count: Number of times beacon loss event has triggered.
 829  * @t_offset: Time offset of the station relative to this host.
 830  * @local_pm: local mesh STA power save mode
 831  * @peer_pm: peer mesh STA power save mode
 832  * @nonpeer_pm: non-peer mesh STA power save mode
 833  */
 834 struct station_info {
 835         u32 filled;
 836         u32 connected_time;
 837         u32 inactive_time;
 838         u32 rx_bytes;
 839         u32 tx_bytes;
 840         u16 llid;
 841         u16 plid;
 842         u8 plink_state;
 843         s8 signal;
 844         s8 signal_avg;
 845         struct rate_info txrate;
 846         struct rate_info rxrate;
 847         u32 rx_packets;
 848         u32 tx_packets;
 849         u32 tx_retries;
 850         u32 tx_failed;
 851         u32 rx_dropped_misc;
 852         struct sta_bss_parameters bss_param;
 853         struct nl80211_sta_flag_update sta_flags;
 854
 855         int generation;
 856
 857         const u8 *assoc_req_ies;
 858         size_t assoc_req_ies_len;
 859
 860         u32 beacon_loss_count;
 861         s64 t_offset;
 862         enum nl80211_mesh_power_mode local_pm;
 863         enum nl80211_mesh_power_mode peer_pm;
 864         enum nl80211_mesh_power_mode nonpeer_pm;
 865
 866         /*
 867          * Note: Add a new enum station_info_flags value for each new field and
 868          * use it to check which fields are initialized.
 869          */
 870 };
 871
 872 /**
 873  * enum monitor_flags - monitor flags
 874  *
 875  * Monitor interface configuration flags. Note that these must be the bits
 876  * according to the nl80211 flags.
 877  *
 878  * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
 879  * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
 880  * @MONITOR_FLAG_CONTROL: pass control frames
 881  * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
 882  * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
 883  */
 884 enum monitor_flags {
 885         MONITOR_FLAG_FCSFAIL            = 1<<NL80211_MNTR_FLAG_FCSFAIL,
 886         MONITOR_FLAG_PLCPFAIL           = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
 887         MONITOR_FLAG_CONTROL            = 1<<NL80211_MNTR_FLAG_CONTROL,
 888         MONITOR_FLAG_OTHER_BSS          = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
 889         MONITOR_FLAG_COOK_FRAMES        = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
 890 };
 891
 892 /**
 893  * enum mpath_info_flags -  mesh path information flags
 894  *
 895  * Used by the driver to indicate which info in &struct mpath_info it has filled
 896  * in during get_station() or dump_station().
 897  *
 898  * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
 899  * @MPATH_INFO_SN: @sn filled
 900  * @MPATH_INFO_METRIC: @metric filled
 901  * @MPATH_INFO_EXPTIME: @exptime filled
 902  * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
 903  * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
 904  * @MPATH_INFO_FLAGS: @flags filled
 905  */
 906 enum mpath_info_flags {
 907         MPATH_INFO_FRAME_QLEN           = BIT(0),
 908         MPATH_INFO_SN                   = BIT(1),
 909         MPATH_INFO_METRIC               = BIT(2),
 910         MPATH_INFO_EXPTIME              = BIT(3),
 911         MPATH_INFO_DISCOVERY_TIMEOUT    = BIT(4),
 912         MPATH_INFO_DISCOVERY_RETRIES    = BIT(5),
 913         MPATH_INFO_FLAGS                = BIT(6),
 914 };
 915
 916 /**
 917  * struct mpath_info - mesh path information
 918  *
 919  * Mesh path information filled by driver for get_mpath() and dump_mpath().
 920  *
 921  * @filled: bitfield of flags from &enum mpath_info_flags
 922  * @frame_qlen: number of queued frames for this destination
 923  * @sn: target sequence number
 924  * @metric: metric (cost) of this mesh path
 925  * @exptime: expiration time for the mesh path from now, in msecs
 926  * @flags: mesh path flags
 927  * @discovery_timeout: total mesh path discovery timeout, in msecs
 928  * @discovery_retries: mesh path discovery retries
 929  * @generation: generation number for nl80211 dumps.
 930  *      This number should increase every time the list of mesh paths
 931  *      changes, i.e. when a station is added or removed, so that
 932  *      userspace can tell whether it got a consistent snapshot.
 933  */
 934 struct mpath_info {
 935         u32 filled;
 936         u32 frame_qlen;
 937         u32 sn;
 938         u32 metric;
 939         u32 exptime;
 940         u32 discovery_timeout;
 941         u8 discovery_retries;
 942         u8 flags;
 943
 944         int generation;
 945 };
 946
 947 /**
 948  * struct bss_parameters - BSS parameters
 949  *
 950  * Used to change BSS parameters (mainly for AP mode).
 951  *
 952  * @use_cts_prot: Whether to use CTS protection
 953  *      (0 = no, 1 = yes, -1 = do not change)
 954  * @use_short_preamble: Whether the use of short preambles is allowed
 955  *      (0 = no, 1 = yes, -1 = do not change)
 956  * @use_short_slot_time: Whether the use of short slot time is allowed
 957  *      (0 = no, 1 = yes, -1 = do not change)
 958  * @basic_rates: basic rates in IEEE 802.11 format
 959  *      (or NULL for no change)
 960  * @basic_rates_len: number of basic rates
 961  * @ap_isolate: do not forward packets between connected stations
 962  * @ht_opmode: HT Operation mode
 963  *      (u16 = opmode, -1 = do not change)
 964  * @p2p_ctwindow: P2P CT Window (-1 = no change)
 965  * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
 966  */
 967 struct bss_parameters {
 968         int use_cts_prot;
 969         int use_short_preamble;
 970         int use_short_slot_time;
 971         u8 *basic_rates;
 972         u8 basic_rates_len;
 973         int ap_isolate;
 974         int ht_opmode;
 975         s8 p2p_ctwindow, p2p_opp_ps;
 976 };
 977
 978 /**
 979  * struct mesh_config - 802.11s mesh configuration
 980  *
 981  * These parameters can be changed while the mesh is active.
 982  *
 983  * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
 984  *      by the Mesh Peering Open message
 985  * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
 986  *      used by the Mesh Peering Open message
 987  * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
 988  *      the mesh peering management to close a mesh peering
 989  * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
 990  *      mesh interface
 991  * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
 992  *      be sent to establish a new peer link instance in a mesh
 993  * @dot11MeshTTL: the value of TTL field set at a source mesh STA
 994  * @element_ttl: the value of TTL field set at a mesh STA for path selection
 995  *      elements
 996  * @auto_open_plinks: whether we should automatically open peer links when we
 997  *      detect compatible mesh peers
 998  * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
 999  *      synchronize to for 11s default synchronization method
1000  * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1001  *      that an originator mesh STA can send to a particular path target
1002  * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1003  * @min_discovery_timeout: the minimum length of time to wait until giving up on
1004  *      a path discovery in milliseconds
1005  * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1006  *      receiving a PREQ shall consider the forwarding information from the
1007  *      root to be valid. (TU = time unit)
1008  * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1009  *      which a mesh STA can send only one action frame containing a PREQ
1010  *      element
1011  * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1012  *      which a mesh STA can send only one Action frame containing a PERR
1013  *      element
1014  * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1015  *      it takes for an HWMP information element to propagate across the mesh
1016  * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1017  * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1018  *      announcements are transmitted
1019  * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1020  *      station has access to a broader network beyond the MBSS. (This is
1021  *      missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1022  *      only means that the station will announce others it's a mesh gate, but
1023  *      not necessarily using the gate announcement protocol. Still keeping the
1024  *      same nomenclature to be in sync with the spec)
1025  * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1026  *      entity (default is TRUE - forwarding entity)
1027  * @rssi_threshold: the threshold for average signal strength of candidate
1028  *      station to establish a peer link
1029  * @ht_opmode: mesh HT protection mode
1030  *
1031  * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1032  *      receiving a proactive PREQ shall consider the forwarding information to
1033  *      the root mesh STA to be valid.
1034  *
1035  * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1036  *      PREQs are transmitted.
1037  * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1038  *      during which a mesh STA can send only one Action frame containing
1039  *      a PREQ element for root path confirmation.
1040  * @power_mode: The default mesh power save mode which will be the initial
1041  *      setting for new peer links.
1042  * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1043  *      after transmitting its beacon.
1044  */
1045 struct mesh_config {
1046         u16 dot11MeshRetryTimeout;
1047         u16 dot11MeshConfirmTimeout;
1048         u16 dot11MeshHoldingTimeout;
1049         u16 dot11MeshMaxPeerLinks;
1050         u8 dot11MeshMaxRetries;
1051         u8 dot11MeshTTL;
1052         u8 element_ttl;
1053         bool auto_open_plinks;
1054         u32 dot11MeshNbrOffsetMaxNeighbor;
1055         u8 dot11MeshHWMPmaxPREQretries;
1056         u32 path_refresh_time;
1057         u16 min_discovery_timeout;
1058         u32 dot11MeshHWMPactivePathTimeout;
1059         u16 dot11MeshHWMPpreqMinInterval;
1060         u16 dot11MeshHWMPperrMinInterval;
1061         u16 dot11MeshHWMPnetDiameterTraversalTime;
1062         u8 dot11MeshHWMPRootMode;
1063         u16 dot11MeshHWMPRannInterval;
1064         bool dot11MeshGateAnnouncementProtocol;
1065         bool dot11MeshForwarding;
1066         s32 rssi_threshold;
1067         u16 ht_opmode;
1068         u32 dot11MeshHWMPactivePathToRootTimeout;
1069         u16 dot11MeshHWMProotInterval;
1070         u16 dot11MeshHWMPconfirmationInterval;
1071         enum nl80211_mesh_power_mode power_mode;
1072         u16 dot11MeshAwakeWindowDuration;
1073 };
1074
1075 /**
1076  * struct mesh_setup - 802.11s mesh setup configuration
1077  * @chandef: defines the channel to use
1078  * @mesh_id: the mesh ID
1079  * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1080  * @sync_method: which synchronization method to use
1081  * @path_sel_proto: which path selection protocol to use
1082  * @path_metric: which metric to use
1083  * @ie: vendor information elements (optional)
1084  * @ie_len: length of vendor information elements
1085  * @is_authenticated: this mesh requires authentication
1086  * @is_secure: this mesh uses security
1087  * @dtim_period: DTIM period to use
1088  * @beacon_interval: beacon interval to use
1089  * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1090  *
1091  * These parameters are fixed when the mesh is created.
1092  */
1093 struct mesh_setup {
1094         struct cfg80211_chan_def chandef;
1095         const u8 *mesh_id;
1096         u8 mesh_id_len;
1097         u8 sync_method;
1098         u8 path_sel_proto;
1099         u8 path_metric;
1100         const u8 *ie;
1101         u8 ie_len;
1102         bool is_authenticated;
1103         bool is_secure;
1104         u8 dtim_period;
1105         u16 beacon_interval;
1106         int mcast_rate[IEEE80211_NUM_BANDS];
1107 };
1108
1109 /**
1110  * struct ieee80211_txq_params - TX queue parameters
1111  * @ac: AC identifier
1112  * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1113  * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1114  *      1..32767]
1115  * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1116  *      1..32767]
1117  * @aifs: Arbitration interframe space [0..255]
1118  */
1119 struct ieee80211_txq_params {
1120         enum nl80211_ac ac;
1121         u16 txop;
1122         u16 cwmin;
1123         u16 cwmax;
1124         u8 aifs;
1125 };
1126
1127 /**
1128  * DOC: Scanning and BSS list handling
1129  *
1130  * The scanning process itself is fairly simple, but cfg80211 offers quite
1131  * a bit of helper functionality. To start a scan, the scan operation will
1132  * be invoked with a scan definition. This scan definition contains the
1133  * channels to scan, and the SSIDs to send probe requests for (including the
1134  * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1135  * probe. Additionally, a scan request may contain extra information elements
1136  * that should be added to the probe request. The IEs are guaranteed to be
1137  * well-formed, and will not exceed the maximum length the driver advertised
1138  * in the wiphy structure.
1139  *
1140  * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1141  * it is responsible for maintaining the BSS list; the driver should not
1142  * maintain a list itself. For this notification, various functions exist.
1143  *
1144  * Since drivers do not maintain a BSS list, there are also a number of
1145  * functions to search for a BSS and obtain information about it from the
1146  * BSS structure cfg80211 maintains. The BSS list is also made available
1147  * to userspace.
1148  */
1149
1150 /**
1151  * struct cfg80211_ssid - SSID description
1152  * @ssid: the SSID
1153  * @ssid_len: length of the ssid
1154  */
1155 struct cfg80211_ssid {
1156         u8 ssid[IEEE80211_MAX_SSID_LEN];
1157         u8 ssid_len;
1158 };
1159
1160 /**
1161  * struct cfg80211_scan_request - scan request description
1162  *
1163  * @ssids: SSIDs to scan for (active scan only)
1164  * @n_ssids: number of SSIDs
1165  * @channels: channels to scan on.
1166  * @n_channels: total number of channels to scan
1167  * @ie: optional information element(s) to add into Probe Request or %NULL
1168  * @ie_len: length of ie in octets
1169  * @flags: bit field of flags controlling operation
1170  * @rates: bitmap of rates to advertise for each band
1171  * @wiphy: the wiphy this was for
1172  * @scan_start: time (in jiffies) when the scan started
1173  * @wdev: the wireless device to scan for
1174  * @aborted: (internal) scan request was notified as aborted
1175  * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1176  */
1177 struct cfg80211_scan_request {
1178         struct cfg80211_ssid *ssids;
1179         int n_ssids;
1180         u32 n_channels;
1181         const u8 *ie;
1182         size_t ie_len;
1183         u32 flags;
1184
1185         u32 rates[IEEE80211_NUM_BANDS];
1186
1187         struct wireless_dev *wdev;
1188
1189         /* internal */
1190         struct wiphy *wiphy;
1191         unsigned long scan_start;
1192         bool aborted;
1193         bool no_cck;
1194
1195         /* keep last */
1196         struct ieee80211_channel *channels[0];
1197 };
1198
1199 /**
1200  * struct cfg80211_match_set - sets of attributes to match
1201  *
1202  * @ssid: SSID to be matched
1203  */
1204 struct cfg80211_match_set {
1205         struct cfg80211_ssid ssid;
1206 };
1207
1208 /**
1209  * struct cfg80211_sched_scan_request - scheduled scan request description
1210  *
1211  * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1212  * @n_ssids: number of SSIDs
1213  * @n_channels: total number of channels to scan
1214  * @interval: interval between each scheduled scan cycle
1215  * @ie: optional information element(s) to add into Probe Request or %NULL
1216  * @ie_len: length of ie in octets
1217  * @flags: bit field of flags controlling operation
1218  * @match_sets: sets of parameters to be matched for a scan result
1219  *      entry to be considered valid and to be passed to the host
1220  *      (others are filtered out).
1221  *      If ommited, all results are passed.
1222  * @n_match_sets: number of match sets
1223  * @wiphy: the wiphy this was for
1224  * @dev: the interface
1225  * @channels: channels to scan
1226  * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1227  */
1228 struct cfg80211_sched_scan_request {
1229         struct cfg80211_ssid *ssids;
1230         int n_ssids;
1231         u32 n_channels;
1232         u32 interval;
1233         const u8 *ie;
1234         size_t ie_len;
1235         u32 flags;
1236         struct cfg80211_match_set *match_sets;
1237         int n_match_sets;
1238         s32 rssi_thold;
1239
1240         /* internal */
1241         struct wiphy *wiphy;
1242         struct net_device *dev;
1243         unsigned long scan_start;
1244
1245         /* keep last */
1246         struct ieee80211_channel *channels[0];
1247 };
1248
1249 /**
1250  * enum cfg80211_signal_type - signal type
1251  *
1252  * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1253  * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1254  * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1255  */
1256 enum cfg80211_signal_type {
1257         CFG80211_SIGNAL_TYPE_NONE,
1258         CFG80211_SIGNAL_TYPE_MBM,
1259         CFG80211_SIGNAL_TYPE_UNSPEC,
1260 };
1261
1262 /**
1263  * struct cfg80211_bss_ie_data - BSS entry IE data
1264  * @rcu_head: internal use, for freeing
1265  * @len: length of the IEs
1266  * @data: IE data
1267  */
1268 struct cfg80211_bss_ies {
1269         struct rcu_head rcu_head;
1270         int len;
1271         u8 data[];
1272 };
1273
1274 /**
1275  * struct cfg80211_bss - BSS description
1276  *
1277  * This structure describes a BSS (which may also be a mesh network)
1278  * for use in scan results and similar.
1279  *
1280  * @channel: channel this BSS is on
1281  * @bssid: BSSID of the BSS
1282  * @tsf: timestamp of last received update
1283  * @beacon_interval: the beacon interval as from the frame
1284  * @capability: the capability field in host byte order
1285  * @ies: the information elements (Note that there
1286  *      is no guarantee that these are well-formed!); this is a pointer to
1287  *      either the beacon_ies or proberesp_ies depending on whether Probe
1288  *      Response frame has been received
1289  * @beacon_ies: the information elements from the last Beacon frame
1290  * @proberesp_ies: the information elements from the last Probe Response frame
1291  * @signal: signal strength value (type depends on the wiphy's signal_type)
1292  * @free_priv: function pointer to free private data
1293  * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1294  */
1295 struct cfg80211_bss {
1296         u64 tsf;
1297
1298         struct ieee80211_channel *channel;
1299
1300         const struct cfg80211_bss_ies __rcu *ies;
1301         const struct cfg80211_bss_ies __rcu *beacon_ies;
1302         const struct cfg80211_bss_ies __rcu *proberesp_ies;
1303
1304         void (*free_priv)(struct cfg80211_bss *bss);
1305
1306         s32 signal;
1307
1308         u16 beacon_interval;
1309         u16 capability;
1310
1311         u8 bssid[ETH_ALEN];
1312
1313         u8 priv[0] __aligned(sizeof(void *));
1314 };
1315
1316 /**
1317  * ieee80211_bss_get_ie - find IE with given ID
1318  * @bss: the bss to search
1319  * @ie: the IE ID
1320  *
1321  * Note that the return value is an RCU-protected pointer, so
1322  * rcu_read_lock() must be held when calling this function.
1323  * Return: %NULL if not found.
1324  */
1325 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1326
1327
1328 /**
1329  * struct cfg80211_auth_request - Authentication request data
1330  *
1331  * This structure provides information needed to complete IEEE 802.11
1332  * authentication.
1333  *
1334  * @bss: The BSS to authenticate with.
1335  * @auth_type: Authentication type (algorithm)
1336  * @ie: Extra IEs to add to Authentication frame or %NULL
1337  * @ie_len: Length of ie buffer in octets
1338  * @key_len: length of WEP key for shared key authentication
1339  * @key_idx: index of WEP key for shared key authentication
1340  * @key: WEP key for shared key authentication
1341  * @sae_data: Non-IE data to use with SAE or %NULL. This starts with
1342  *      Authentication transaction sequence number field.
1343  * @sae_data_len: Length of sae_data buffer in octets
1344  */
1345 struct cfg80211_auth_request {
1346         struct cfg80211_bss *bss;
1347         const u8 *ie;
1348         size_t ie_len;
1349         enum nl80211_auth_type auth_type;
1350         const u8 *key;
1351         u8 key_len, key_idx;
1352         const u8 *sae_data;
1353         size_t sae_data_len;
1354 };
1355
1356 /**
1357  * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1358  *
1359  * @ASSOC_REQ_DISABLE_HT:  Disable HT (802.11n)
1360  */
1361 enum cfg80211_assoc_req_flags {
1362         ASSOC_REQ_DISABLE_HT            = BIT(0),
1363 };
1364
1365 /**
1366  * struct cfg80211_assoc_request - (Re)Association request data
1367  *
1368  * This structure provides information needed to complete IEEE 802.11
1369  * (re)association.
1370  * @bss: The BSS to associate with. If the call is successful the driver
1371  *      is given a reference that it must release, normally via a call to
1372  *      cfg80211_send_rx_assoc(), or, if association timed out, with a
1373  *      call to cfg80211_put_bss() (in addition to calling
1374  *      cfg80211_send_assoc_timeout())
1375  * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1376  * @ie_len: Length of ie buffer in octets
1377  * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1378  * @crypto: crypto settings
1379  * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
1380  * @flags:  See &enum cfg80211_assoc_req_flags
1381  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
1382  *   will be used in ht_capa.  Un-supported values will be ignored.
1383  * @ht_capa_mask:  The bits of ht_capa which are to be used.
1384  */
1385 struct cfg80211_assoc_request {
1386         struct cfg80211_bss *bss;
1387         const u8 *ie, *prev_bssid;
1388         size_t ie_len;
1389         struct cfg80211_crypto_settings crypto;
1390         bool use_mfp;
1391         u32 flags;
1392         struct ieee80211_ht_cap ht_capa;
1393         struct ieee80211_ht_cap ht_capa_mask;
1394 };
1395
1396 /**
1397  * struct cfg80211_deauth_request - Deauthentication request data
1398  *
1399  * This structure provides information needed to complete IEEE 802.11
1400  * deauthentication.
1401  *
1402  * @bssid: the BSSID of the BSS to deauthenticate from
1403  * @ie: Extra IEs to add to Deauthentication frame or %NULL
1404  * @ie_len: Length of ie buffer in octets
1405  * @reason_code: The reason code for the deauthentication
1406  */
1407 struct cfg80211_deauth_request {
1408         const u8 *bssid;
1409         const u8 *ie;
1410         size_t ie_len;
1411         u16 reason_code;
1412         bool local_state_change;
1413 };
1414
1415 /**
1416  * struct cfg80211_disassoc_request - Disassociation request data
1417  *
1418  * This structure provides information needed to complete IEEE 802.11
1419  * disassocation.
1420  *
1421  * @bss: the BSS to disassociate from
1422  * @ie: Extra IEs to add to Disassociation frame or %NULL
1423  * @ie_len: Length of ie buffer in octets
1424  * @reason_code: The reason code for the disassociation
1425  * @local_state_change: This is a request for a local state only, i.e., no
1426  *      Disassociation frame is to be transmitted.
1427  */
1428 struct cfg80211_disassoc_request {
1429         struct cfg80211_bss *bss;
1430         const u8 *ie;
1431         size_t ie_len;
1432         u16 reason_code;
1433         bool local_state_change;
1434 };
1435
1436 /**
1437  * struct cfg80211_ibss_params - IBSS parameters
1438  *
1439  * This structure defines the IBSS parameters for the join_ibss()
1440  * method.
1441  *
1442  * @ssid: The SSID, will always be non-null.
1443  * @ssid_len: The length of the SSID, will always be non-zero.
1444  * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1445  *      search for IBSSs with a different BSSID.
1446  * @chandef: defines the channel to use if no other IBSS to join can be found
1447  * @channel_fixed: The channel should be fixed -- do not search for
1448  *      IBSSs to join on other channels.
1449  * @ie: information element(s) to include in the beacon
1450  * @ie_len: length of that
1451  * @beacon_interval: beacon interval to use
1452  * @privacy: this is a protected network, keys will be configured
1453  *      after joining
1454  * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1455  *      sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1456  *      required to assume that the port is unauthorized until authorized by
1457  *      user space. Otherwise, port is marked authorized by default.
1458  * @basic_rates: bitmap of basic rates to use when creating the IBSS
1459  * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1460  */
1461 struct cfg80211_ibss_params {
1462         u8 *ssid;
1463         u8 *bssid;
1464         struct cfg80211_chan_def chandef;
1465         u8 *ie;
1466         u8 ssid_len, ie_len;
1467         u16 beacon_interval;
1468         u32 basic_rates;
1469         bool channel_fixed;
1470         bool privacy;
1471         bool control_port;
1472         int mcast_rate[IEEE80211_NUM_BANDS];
1473 };
1474
1475 /**
1476  * struct cfg80211_connect_params - Connection parameters
1477  *
1478  * This structure provides information needed to complete IEEE 802.11
1479  * authentication and association.
1480  *
1481  * @channel: The channel to use or %NULL if not specified (auto-select based
1482  *      on scan results)
1483  * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1484  *      results)
1485  * @ssid: SSID
1486  * @ssid_len: Length of ssid in octets
1487  * @auth_type: Authentication type (algorithm)
1488  * @ie: IEs for association request
1489  * @ie_len: Length of assoc_ie in octets
1490  * @privacy: indicates whether privacy-enabled APs should be used
1491  * @mfp: indicate whether management frame protection is used
1492  * @crypto: crypto settings
1493  * @key_len: length of WEP key for shared key authentication
1494  * @key_idx: index of WEP key for shared key authentication
1495  * @key: WEP key for shared key authentication
1496  * @flags:  See &enum cfg80211_assoc_req_flags
1497  * @bg_scan_period:  Background scan period in seconds
1498  *   or -1 to indicate that default value is to be used.
1499  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
1500  *   will be used in ht_capa.  Un-supported values will be ignored.
1501  * @ht_capa_mask:  The bits of ht_capa which are to be used.
1502  */
1503 struct cfg80211_connect_params {
1504         struct ieee80211_channel *channel;
1505         u8 *bssid;
1506         u8 *ssid;
1507         size_t ssid_len;
1508         enum nl80211_auth_type auth_type;
1509         u8 *ie;
1510         size_t ie_len;
1511         bool privacy;
1512         enum nl80211_mfp mfp;
1513         struct cfg80211_crypto_settings crypto;
1514         const u8 *key;
1515         u8 key_len, key_idx;
1516         u32 flags;
1517         int bg_scan_period;
1518         struct ieee80211_ht_cap ht_capa;
1519         struct ieee80211_ht_cap ht_capa_mask;
1520 };
1521
1522 /**
1523  * enum wiphy_params_flags - set_wiphy_params bitfield values
1524  * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1525  * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1526  * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1527  * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1528  * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1529  */
1530 enum wiphy_params_flags {
1531         WIPHY_PARAM_RETRY_SHORT         = 1 << 0,
1532         WIPHY_PARAM_RETRY_LONG          = 1 << 1,
1533         WIPHY_PARAM_FRAG_THRESHOLD      = 1 << 2,
1534         WIPHY_PARAM_RTS_THRESHOLD       = 1 << 3,
1535         WIPHY_PARAM_COVERAGE_CLASS      = 1 << 4,
1536 };
1537
1538 /*
1539  * cfg80211_bitrate_mask - masks for bitrate control
1540  */
1541 struct cfg80211_bitrate_mask {
1542         struct {
1543                 u32 legacy;
1544                 u8 mcs[IEEE80211_HT_MCS_MASK_LEN];
1545         } control[IEEE80211_NUM_BANDS];
1546 };
1547 /**
1548  * struct cfg80211_pmksa - PMK Security Association
1549  *
1550  * This structure is passed to the set/del_pmksa() method for PMKSA
1551  * caching.
1552  *
1553  * @bssid: The AP's BSSID.
1554  * @pmkid: The PMK material itself.
1555  */
1556 struct cfg80211_pmksa {
1557         u8 *bssid;
1558         u8 *pmkid;
1559 };
1560
1561 /**
1562  * struct cfg80211_wowlan_trig_pkt_pattern - packet pattern
1563  * @mask: bitmask where to match pattern and where to ignore bytes,
1564  *      one bit per byte, in same format as nl80211
1565  * @pattern: bytes to match where bitmask is 1
1566  * @pattern_len: length of pattern (in bytes)
1567  *
1568  * Internal note: @mask and @pattern are allocated in one chunk of
1569  * memory, free @mask only!
1570  */
1571 struct cfg80211_wowlan_trig_pkt_pattern {
1572         u8 *mask, *pattern;
1573         int pattern_len;
1574 };
1575
1576 /**
1577  * struct cfg80211_wowlan - Wake on Wireless-LAN support info
1578  *
1579  * This structure defines the enabled WoWLAN triggers for the device.
1580  * @any: wake up on any activity -- special trigger if device continues
1581  *      operating as normal during suspend
1582  * @disconnect: wake up if getting disconnected
1583  * @magic_pkt: wake up on receiving magic packet
1584  * @patterns: wake up on receiving packet matching a pattern
1585  * @n_patterns: number of patterns
1586  * @gtk_rekey_failure: wake up on GTK rekey failure
1587  * @eap_identity_req: wake up on EAP identity request packet
1588  * @four_way_handshake: wake up on 4-way handshake
1589  * @rfkill_release: wake up when rfkill is released
1590  */
1591 struct cfg80211_wowlan {
1592         bool any, disconnect, magic_pkt, gtk_rekey_failure,
1593              eap_identity_req, four_way_handshake,
1594              rfkill_release;
1595         struct cfg80211_wowlan_trig_pkt_pattern *patterns;
1596         int n_patterns;
1597 };
1598
1599 /**
1600  * struct cfg80211_gtk_rekey_data - rekey data
1601  * @kek: key encryption key
1602  * @kck: key confirmation key
1603  * @replay_ctr: replay counter
1604  */
1605 struct cfg80211_gtk_rekey_data {
1606         u8 kek[NL80211_KEK_LEN];
1607         u8 kck[NL80211_KCK_LEN];
1608         u8 replay_ctr[NL80211_REPLAY_CTR_LEN];
1609 };
1610
1611 /**
1612  * struct cfg80211_ops - backend description for wireless configuration
1613  *
1614  * This struct is registered by fullmac card drivers and/or wireless stacks
1615  * in order to handle configuration requests on their interfaces.
1616  *
1617  * All callbacks except where otherwise noted should return 0
1618  * on success or a negative error code.
1619  *
1620  * All operations are currently invoked under rtnl for consistency with the
1621  * wireless extensions but this is subject to reevaluation as soon as this
1622  * code is used more widely and we have a first user without wext.
1623  *
1624  * @suspend: wiphy device needs to be suspended. The variable @wow will
1625  *      be %NULL or contain the enabled Wake-on-Wireless triggers that are
1626  *      configured for the device.
1627  * @resume: wiphy device needs to be resumed
1628  * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
1629  *      to call device_set_wakeup_enable() to enable/disable wakeup from
1630  *      the device.
1631  *
1632  * @add_virtual_intf: create a new virtual interface with the given name,
1633  *      must set the struct wireless_dev's iftype. Beware: You must create
1634  *      the new netdev in the wiphy's network namespace! Returns the struct
1635  *      wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
1636  *      also set the address member in the wdev.
1637  *
1638  * @del_virtual_intf: remove the virtual interface
1639  *
1640  * @change_virtual_intf: change type/configuration of virtual interface,
1641  *      keep the struct wireless_dev's iftype updated.
1642  *
1643  * @add_key: add a key with the given parameters. @mac_addr will be %NULL
1644  *      when adding a group key.
1645  *
1646  * @get_key: get information about the key with the given parameters.
1647  *      @mac_addr will be %NULL when requesting information for a group
1648  *      key. All pointers given to the @callback function need not be valid
1649  *      after it returns. This function should return an error if it is
1650  *      not possible to retrieve the key, -ENOENT if it doesn't exist.
1651  *
1652  * @del_key: remove a key given the @mac_addr (%NULL for a group key)
1653  *      and @key_index, return -ENOENT if the key doesn't exist.
1654  *
1655  * @set_default_key: set the default key on an interface
1656  *
1657  * @set_default_mgmt_key: set the default management frame key on an interface
1658  *
1659  * @set_rekey_data: give the data necessary for GTK rekeying to the driver
1660  *
1661  * @start_ap: Start acting in AP mode defined by the parameters.
1662  * @change_beacon: Change the beacon parameters for an access point mode
1663  *      interface. This should reject the call when AP mode wasn't started.
1664  * @stop_ap: Stop being an AP, including stopping beaconing.
1665  *
1666  * @add_station: Add a new station.
1667  * @del_station: Remove a station; @mac may be NULL to remove all stations.
1668  * @change_station: Modify a given station. Note that flags changes are not much
1669  *      validated in cfg80211, in particular the auth/assoc/authorized flags
1670  *      might come to the driver in invalid combinations -- make sure to check
1671  *      them, also against the existing state! Also, supported_rates changes are
1672  *      not checked in station mode -- drivers need to reject (or ignore) them
1673  *      for anything but TDLS peers.
1674  * @get_station: get station information for the station identified by @mac
1675  * @dump_station: dump station callback -- resume dump at index @idx
1676  *
1677  * @add_mpath: add a fixed mesh path
1678  * @del_mpath: delete a given mesh path
1679  * @change_mpath: change a given mesh path
1680  * @get_mpath: get a mesh path for the given parameters
1681  * @dump_mpath: dump mesh path callback -- resume dump at index @idx
1682  * @join_mesh: join the mesh network with the specified parameters
1683  * @leave_mesh: leave the current mesh network
1684  *
1685  * @get_mesh_config: Get the current mesh configuration
1686  *
1687  * @update_mesh_config: Update mesh parameters on a running mesh.
1688  *      The mask is a bitfield which tells us which parameters to
1689  *      set, and which to leave alone.
1690  *
1691  * @change_bss: Modify parameters for a given BSS.
1692  *
1693  * @set_txq_params: Set TX queue parameters
1694  *
1695  * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
1696  *      as it doesn't implement join_mesh and needs to set the channel to
1697  *      join the mesh instead.
1698  *
1699  * @set_monitor_channel: Set the monitor mode channel for the device. If other
1700  *      interfaces are active this callback should reject the configuration.
1701  *      If no interfaces are active or the device is down, the channel should
1702  *      be stored for when a monitor interface becomes active.
1703  *
1704  * @scan: Request to do a scan. If returning zero, the scan request is given
1705  *      the driver, and will be valid until passed to cfg80211_scan_done().
1706  *      For scan results, call cfg80211_inform_bss(); you can call this outside
1707  *      the scan/scan_done bracket too.
1708  *
1709  * @auth: Request to authenticate with the specified peer
1710  * @assoc: Request to (re)associate with the specified peer
1711  * @deauth: Request to deauthenticate from the specified peer
1712  * @disassoc: Request to disassociate from the specified peer
1713  *
1714  * @connect: Connect to the ESS with the specified parameters. When connected,
1715  *      call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
1716  *      If the connection fails for some reason, call cfg80211_connect_result()
1717  *      with the status from the AP.
1718  * @disconnect: Disconnect from the BSS/ESS.
1719  *
1720  * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
1721  *      cfg80211_ibss_joined(), also call that function when changing BSSID due
1722  *      to a merge.
1723  * @leave_ibss: Leave the IBSS.
1724  *
1725  * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
1726  *      MESH mode)
1727  *
1728  * @set_wiphy_params: Notify that wiphy parameters have changed;
1729  *      @changed bitfield (see &enum wiphy_params_flags) describes which values
1730  *      have changed. The actual parameter values are available in
1731  *      struct wiphy. If returning an error, no value should be changed.
1732  *
1733  * @set_tx_power: set the transmit power according to the parameters,
1734  *      the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
1735  *      wdev may be %NULL if power was set for the wiphy, and will
1736  *      always be %NULL unless the driver supports per-vif TX power
1737  *      (as advertised by the nl80211 feature flag.)
1738  * @get_tx_power: store the current TX power into the dbm variable;
1739  *      return 0 if successful
1740  *
1741  * @set_wds_peer: set the WDS peer for a WDS interface
1742  *
1743  * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
1744  *      functions to adjust rfkill hw state
1745  *
1746  * @dump_survey: get site survey information.
1747  *
1748  * @remain_on_channel: Request the driver to remain awake on the specified
1749  *      channel for the specified duration to complete an off-channel
1750  *      operation (e.g., public action frame exchange). When the driver is
1751  *      ready on the requested channel, it must indicate this with an event
1752  *      notification by calling cfg80211_ready_on_channel().
1753  * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
1754  *      This allows the operation to be terminated prior to timeout based on
1755  *      the duration value.
1756  * @mgmt_tx: Transmit a management frame.
1757  * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
1758  *      frame on another channel
1759  *
1760  * @testmode_cmd: run a test mode command
1761  * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
1762  *      used by the function, but 0 and 1 must not be touched. Additionally,
1763  *      return error codes other than -ENOBUFS and -ENOENT will terminate the
1764  *      dump and return to userspace with an error, so be careful. If any data
1765  *      was passed in from userspace then the data/len arguments will be present
1766  *      and point to the data contained in %NL80211_ATTR_TESTDATA.
1767  *
1768  * @set_bitrate_mask: set the bitrate mask configuration
1769  *
1770  * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
1771  *      devices running firmwares capable of generating the (re) association
1772  *      RSN IE. It allows for faster roaming between WPA2 BSSIDs.
1773  * @del_pmksa: Delete a cached PMKID.
1774  * @flush_pmksa: Flush all cached PMKIDs.
1775  * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
1776  *      allows the driver to adjust the dynamic ps timeout value.
1777  * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
1778  * @set_cqm_txe_config: Configure connection quality monitor TX error
1779  *      thresholds.
1780  * @sched_scan_start: Tell the driver to start a scheduled scan.
1781  * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan.
1782  *
1783  * @mgmt_frame_register: Notify driver that a management frame type was
1784  *      registered. Note that this callback may not sleep, and cannot run
1785  *      concurrently with itself.
1786  *
1787  * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1788  *      Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1789  *      reject TX/RX mask combinations they cannot support by returning -EINVAL
1790  *      (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1791  *
1792  * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
1793  *
1794  * @set_ringparam: Set tx and rx ring sizes.
1795  *
1796  * @get_ringparam: Get tx and rx ring current and maximum sizes.
1797  *
1798  * @tdls_mgmt: Transmit a TDLS management frame.
1799  * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
1800  *
1801  * @probe_client: probe an associated client, must return a cookie that it
1802  *      later passes to cfg80211_probe_status().
1803  *
1804  * @set_noack_map: Set the NoAck Map for the TIDs.
1805  *
1806  * @get_et_sset_count:  Ethtool API to get string-set count.
1807  *      See @ethtool_ops.get_sset_count
1808  *
1809  * @get_et_stats:  Ethtool API to get a set of u64 stats.
1810  *      See @ethtool_ops.get_ethtool_stats
1811  *
1812  * @get_et_strings:  Ethtool API to get a set of strings to describe stats
1813  *      and perhaps other supported types of ethtool data-sets.
1814  *      See @ethtool_ops.get_strings
1815  *
1816  * @get_channel: Get the current operating channel for the virtual interface.
1817  *      For monitor interfaces, it should return %NULL unless there's a single
1818  *      current monitoring channel.
1819  *
1820  * @start_p2p_device: Start the given P2P device.
1821  * @stop_p2p_device: Stop the given P2P device.
1822  *
1823  * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
1824  *      Parameters include ACL policy, an array of MAC address of stations
1825  *      and the number of MAC addresses. If there is already a list in driver
1826  *      this new list replaces the existing one. Driver has to clear its ACL
1827  *      when number of MAC addresses entries is passed as 0. Drivers which
1828  *      advertise the support for MAC based ACL have to implement this callback.
1829  */
1830 struct cfg80211_ops {
1831         int     (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
1832         int     (*resume)(struct wiphy *wiphy);
1833         void    (*set_wakeup)(struct wiphy *wiphy, bool enabled);
1834
1835         struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
1836                                                   const char *name,
1837                                                   enum nl80211_iftype type,
1838                                                   u32 *flags,
1839                                                   struct vif_params *params);
1840         int     (*del_virtual_intf)(struct wiphy *wiphy,
1841                                     struct wireless_dev *wdev);
1842         int     (*change_virtual_intf)(struct wiphy *wiphy,
1843                                        struct net_device *dev,
1844                                        enum nl80211_iftype type, u32 *flags,
1845                                        struct vif_params *params);
1846
1847         int     (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
1848                            u8 key_index, bool pairwise, const u8 *mac_addr,
1849                            struct key_params *params);
1850         int     (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
1851                            u8 key_index, bool pairwise, const u8 *mac_addr,
1852                            void *cookie,
1853                            void (*callback)(void *cookie, struct key_params*));
1854         int     (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
1855                            u8 key_index, bool pairwise, const u8 *mac_addr);
1856         int     (*set_default_key)(struct wiphy *wiphy,
1857                                    struct net_device *netdev,
1858                                    u8 key_index, bool unicast, bool multicast);
1859         int     (*set_default_mgmt_key)(struct wiphy *wiphy,
1860                                         struct net_device *netdev,
1861                                         u8 key_index);
1862
1863         int     (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
1864                             struct cfg80211_ap_settings *settings);
1865         int     (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
1866                                  struct cfg80211_beacon_data *info);
1867         int     (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
1868
1869
1870         int     (*add_station)(struct wiphy *wiphy, struct net_device *dev,
1871                                u8 *mac, struct station_parameters *params);
1872         int     (*del_station)(struct wiphy *wiphy, struct net_device *dev,
1873                                u8 *mac);
1874         int     (*change_station)(struct wiphy *wiphy, struct net_device *dev,
1875                                   u8 *mac, struct station_parameters *params);
1876         int     (*get_station)(struct wiphy *wiphy, struct net_device *dev,
1877                                u8 *mac, struct station_info *sinfo);
1878         int     (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
1879                                int idx, u8 *mac, struct station_info *sinfo);
1880
1881         int     (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
1882                                u8 *dst, u8 *next_hop);
1883         int     (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
1884                                u8 *dst);
1885         int     (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
1886                                   u8 *dst, u8 *next_hop);
1887         int     (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
1888                                u8 *dst, u8 *next_hop,
1889                                struct mpath_info *pinfo);
1890         int     (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
1891                                int idx, u8 *dst, u8 *next_hop,
1892                                struct mpath_info *pinfo);
1893         int     (*get_mesh_config)(struct wiphy *wiphy,
1894                                 struct net_device *dev,
1895                                 struct mesh_config *conf);
1896         int     (*update_mesh_config)(struct wiphy *wiphy,
1897                                       struct net_device *dev, u32 mask,
1898                                       const struct mesh_config *nconf);
1899         int     (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
1900                              const struct mesh_config *conf,
1901                              const struct mesh_setup *setup);
1902         int     (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
1903
1904         int     (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
1905                               struct bss_parameters *params);
1906
1907         int     (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
1908                                   struct ieee80211_txq_params *params);
1909
1910         int     (*libertas_set_mesh_channel)(struct wiphy *wiphy,
1911                                              struct net_device *dev,
1912                                              struct ieee80211_channel *chan);
1913
1914         int     (*set_monitor_channel)(struct wiphy *wiphy,
1915                                        struct cfg80211_chan_def *chandef);
1916
1917         int     (*scan)(struct wiphy *wiphy,
1918                         struct cfg80211_scan_request *request);
1919
1920         int     (*auth)(struct wiphy *wiphy, struct net_device *dev,
1921                         struct cfg80211_auth_request *req);
1922         int     (*assoc)(struct wiphy *wiphy, struct net_device *dev,
1923                          struct cfg80211_assoc_request *req);
1924         int     (*deauth)(struct wiphy *wiphy, struct net_device *dev,
1925                           struct cfg80211_deauth_request *req);
1926         int     (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
1927                             struct cfg80211_disassoc_request *req);
1928
1929         int     (*connect)(struct wiphy *wiphy, struct net_device *dev,
1930                            struct cfg80211_connect_params *sme);
1931         int     (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
1932                               u16 reason_code);
1933
1934         int     (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
1935                              struct cfg80211_ibss_params *params);
1936         int     (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
1937
1938         int     (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
1939                                   int rate[IEEE80211_NUM_BANDS]);
1940
1941         int     (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
1942
1943         int     (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
1944                                 enum nl80211_tx_power_setting type, int mbm);
1945         int     (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
1946                                 int *dbm);
1947
1948         int     (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
1949                                 const u8 *addr);
1950
1951         void    (*rfkill_poll)(struct wiphy *wiphy);
1952
1953 #ifdef CONFIG_NL80211_TESTMODE
1954         int     (*testmode_cmd)(struct wiphy *wiphy, void *data, int len);
1955         int     (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
1956                                  struct netlink_callback *cb,
1957                                  void *data, int len);
1958 #endif
1959
1960         int     (*set_bitrate_mask)(struct wiphy *wiphy,
1961                                     struct net_device *dev,
1962                                     const u8 *peer,
1963                                     const struct cfg80211_bitrate_mask *mask);
1964
1965         int     (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
1966                         int idx, struct survey_info *info);
1967
1968         int     (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1969                              struct cfg80211_pmksa *pmksa);
1970         int     (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1971                              struct cfg80211_pmksa *pmksa);
1972         int     (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
1973
1974         int     (*remain_on_channel)(struct wiphy *wiphy,
1975                                      struct wireless_dev *wdev,
1976                                      struct ieee80211_channel *chan,
1977                                      unsigned int duration,
1978                                      u64 *cookie);
1979         int     (*cancel_remain_on_channel)(struct wiphy *wiphy,
1980                                             struct wireless_dev *wdev,
1981                                             u64 cookie);
1982
1983         int     (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
1984                           struct ieee80211_channel *chan, bool offchan,
1985                           unsigned int wait, const u8 *buf, size_t len,
1986                           bool no_cck, bool dont_wait_for_ack, u64 *cookie);
1987         int     (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
1988                                        struct wireless_dev *wdev,
1989                                        u64 cookie);
1990
1991         int     (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
1992                                   bool enabled, int timeout);
1993
1994         int     (*set_cqm_rssi_config)(struct wiphy *wiphy,
1995                                        struct net_device *dev,
1996                                        s32 rssi_thold, u32 rssi_hyst);
1997
1998         int     (*set_cqm_txe_config)(struct wiphy *wiphy,
1999                                       struct net_device *dev,
2000                                       u32 rate, u32 pkts, u32 intvl);
2001
2002         void    (*mgmt_frame_register)(struct wiphy *wiphy,
2003                                        struct wireless_dev *wdev,
2004                                        u16 frame_type, bool reg);
2005
2006         int     (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
2007         int     (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
2008
2009         int     (*set_ringparam)(struct wiphy *wiphy, u32 tx, u32 rx);
2010         void    (*get_ringparam)(struct wiphy *wiphy,
2011                                  u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
2012
2013         int     (*sched_scan_start)(struct wiphy *wiphy,
2014                                 struct net_device *dev,
2015                                 struct cfg80211_sched_scan_request *request);
2016         int     (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
2017
2018         int     (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
2019                                   struct cfg80211_gtk_rekey_data *data);
2020
2021         int     (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2022                              u8 *peer, u8 action_code,  u8 dialog_token,
2023                              u16 status_code, const u8 *buf, size_t len);
2024         int     (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
2025                              u8 *peer, enum nl80211_tdls_operation oper);
2026
2027         int     (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
2028                                 const u8 *peer, u64 *cookie);
2029
2030         int     (*set_noack_map)(struct wiphy *wiphy,
2031                                   struct net_device *dev,
2032                                   u16 noack_map);
2033
2034         int     (*get_et_sset_count)(struct wiphy *wiphy,
2035                                      struct net_device *dev, int sset);
2036         void    (*get_et_stats)(struct wiphy *wiphy, struct net_device *dev,
2037                                 struct ethtool_stats *stats, u64 *data);
2038         void    (*get_et_strings)(struct wiphy *wiphy, struct net_device *dev,
2039                                   u32 sset, u8 *data);
2040
2041         int     (*get_channel)(struct wiphy *wiphy,
2042                                struct wireless_dev *wdev,
2043                                struct cfg80211_chan_def *chandef);
2044
2045         int     (*start_p2p_device)(struct wiphy *wiphy,
2046                                     struct wireless_dev *wdev);
2047         void    (*stop_p2p_device)(struct wiphy *wiphy,
2048                                    struct wireless_dev *wdev);
2049
2050         int     (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
2051                                const struct cfg80211_acl_data *params);
2052 };
2053
2054 /*
2055  * wireless hardware and networking interfaces structures
2056  * and registration/helper functions
2057  */
2058
2059 /**
2060  * enum wiphy_flags - wiphy capability flags
2061  *
2062  * @WIPHY_FLAG_CUSTOM_REGULATORY:  tells us the driver for this device
2063  *      has its own custom regulatory domain and cannot identify the
2064  *      ISO / IEC 3166 alpha2 it belongs to. When this is enabled
2065  *      we will disregard the first regulatory hint (when the
2066  *      initiator is %REGDOM_SET_BY_CORE).
2067  * @WIPHY_FLAG_STRICT_REGULATORY: tells us the driver for this device will
2068  *      ignore regulatory domain settings until it gets its own regulatory
2069  *      domain via its regulatory_hint() unless the regulatory hint is
2070  *      from a country IE. After its gets its own regulatory domain it will
2071  *      only allow further regulatory domain settings to further enhance
2072  *      compliance. For example if channel 13 and 14 are disabled by this
2073  *      regulatory domain no user regulatory domain can enable these channels
2074  *      at a later time. This can be used for devices which do not have
2075  *      calibration information guaranteed for frequencies or settings
2076  *      outside of its regulatory domain. If used in combination with
2077  *      WIPHY_FLAG_CUSTOM_REGULATORY the inspected country IE power settings
2078  *      will be followed.
2079  * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure
2080  *      that passive scan flags and beaconing flags may not be lifted by
2081  *      cfg80211 due to regulatory beacon hints. For more information on beacon
2082  *      hints read the documenation for regulatory_hint_found_beacon()
2083  * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
2084  *      wiphy at all
2085  * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
2086  *      by default -- this flag will be set depending on the kernel's default
2087  *      on wiphy_new(), but can be changed by the driver if it has a good
2088  *      reason to override the default
2089  * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
2090  *      on a VLAN interface)
2091  * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
2092  * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
2093  *      control port protocol ethertype. The device also honours the
2094  *      control_port_no_encrypt flag.
2095  * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
2096  * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
2097  *      auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
2098  * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
2099  * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
2100  *      firmware.
2101  * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
2102  * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
2103  * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
2104  *      link setup/discovery operations internally. Setup, discovery and
2105  *      teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
2106  *      command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
2107  *      used for asking the driver/firmware to perform a TDLS operation.
2108  * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
2109  * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
2110  *      when there are virtual interfaces in AP mode by calling
2111  *      cfg80211_report_obss_beacon().
2112  * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
2113  *      responds to probe-requests in hardware.
2114  * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
2115  * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
2116  */
2117 enum wiphy_flags {
2118         WIPHY_FLAG_CUSTOM_REGULATORY            = BIT(0),
2119         WIPHY_FLAG_STRICT_REGULATORY            = BIT(1),
2120         WIPHY_FLAG_DISABLE_BEACON_HINTS         = BIT(2),
2121         WIPHY_FLAG_NETNS_OK                     = BIT(3),
2122         WIPHY_FLAG_PS_ON_BY_DEFAULT             = BIT(4),
2123         WIPHY_FLAG_4ADDR_AP                     = BIT(5),
2124         WIPHY_FLAG_4ADDR_STATION                = BIT(6),
2125         WIPHY_FLAG_CONTROL_PORT_PROTOCOL        = BIT(7),
2126         WIPHY_FLAG_IBSS_RSN                     = BIT(8),
2127         WIPHY_FLAG_MESH_AUTH                    = BIT(10),
2128         WIPHY_FLAG_SUPPORTS_SCHED_SCAN          = BIT(11),
2129         /* use hole at 12 */
2130         WIPHY_FLAG_SUPPORTS_FW_ROAM             = BIT(13),
2131         WIPHY_FLAG_AP_UAPSD                     = BIT(14),
2132         WIPHY_FLAG_SUPPORTS_TDLS                = BIT(15),
2133         WIPHY_FLAG_TDLS_EXTERNAL_SETUP          = BIT(16),
2134         WIPHY_FLAG_HAVE_AP_SME                  = BIT(17),
2135         WIPHY_FLAG_REPORTS_OBSS                 = BIT(18),
2136         WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD        = BIT(19),
2137         WIPHY_FLAG_OFFCHAN_TX                   = BIT(20),
2138         WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL        = BIT(21),
2139 };
2140
2141 /**
2142  * struct ieee80211_iface_limit - limit on certain interface types
2143  * @max: maximum number of interfaces of these types
2144  * @types: interface types (bits)
2145  */
2146 struct ieee80211_iface_limit {
2147         u16 max;
2148         u16 types;
2149 };
2150
2151 /**
2152  * struct ieee80211_iface_combination - possible interface combination
2153  * @limits: limits for the given interface types
2154  * @n_limits: number of limitations
2155  * @num_different_channels: can use up to this many different channels
2156  * @max_interfaces: maximum number of interfaces in total allowed in this
2157  *      group
2158  * @beacon_int_infra_match: In this combination, the beacon intervals
2159  *      between infrastructure and AP types must match. This is required
2160  *      only in special cases.
2161  * @radar_detect_widths: bitmap of channel widths supported for radar detection
2162  *
2163  * These examples can be expressed as follows:
2164  *
2165  * Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
2166  *
2167  *  struct ieee80211_iface_limit limits1[] = {
2168  *      { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2169  *      { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
2170  *  };
2171  *  struct ieee80211_iface_combination combination1 = {
2172  *      .limits = limits1,
2173  *      .n_limits = ARRAY_SIZE(limits1),
2174  *      .max_interfaces = 2,
2175  *      .beacon_int_infra_match = true,
2176  *  };
2177  *
2178  *
2179  * Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
2180  *
2181  *  struct ieee80211_iface_limit limits2[] = {
2182  *      { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
2183  *                           BIT(NL80211_IFTYPE_P2P_GO), },
2184  *  };
2185  *  struct ieee80211_iface_combination combination2 = {
2186  *      .limits = limits2,
2187  *      .n_limits = ARRAY_SIZE(limits2),
2188  *      .max_interfaces = 8,
2189  *      .num_different_channels = 1,
2190  *  };
2191  *
2192  *
2193  * Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
2194  * This allows for an infrastructure connection and three P2P connections.
2195  *
2196  *  struct ieee80211_iface_limit limits3[] = {
2197  *      { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2198  *      { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
2199  *                           BIT(NL80211_IFTYPE_P2P_CLIENT), },
2200  *  };
2201  *  struct ieee80211_iface_combination combination3 = {
2202  *      .limits = limits3,
2203  *      .n_limits = ARRAY_SIZE(limits3),
2204  *      .max_interfaces = 4,
2205  *      .num_different_channels = 2,
2206  *  };
2207  */
2208 struct ieee80211_iface_combination {
2209         const struct ieee80211_iface_limit *limits;
2210         u32 num_different_channels;
2211         u16 max_interfaces;
2212         u8 n_limits;
2213         bool beacon_int_infra_match;
2214         u8 radar_detect_widths;
2215 };
2216
2217 struct ieee80211_txrx_stypes {
2218         u16 tx, rx;
2219 };
2220
2221 /**
2222  * enum wiphy_wowlan_support_flags - WoWLAN support flags
2223  * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
2224  *      trigger that keeps the device operating as-is and
2225  *      wakes up the host on any activity, for example a
2226  *      received packet that passed filtering; note that the
2227  *      packet should be preserved in that case
2228  * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
2229  *      (see nl80211.h)
2230  * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
2231  * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
2232  * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
2233  * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
2234  * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
2235  * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
2236  */
2237 enum wiphy_wowlan_support_flags {
2238         WIPHY_WOWLAN_ANY                = BIT(0),
2239         WIPHY_WOWLAN_MAGIC_PKT          = BIT(1),
2240         WIPHY_WOWLAN_DISCONNECT         = BIT(2),
2241         WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
2242         WIPHY_WOWLAN_GTK_REKEY_FAILURE  = BIT(4),
2243         WIPHY_WOWLAN_EAP_IDENTITY_REQ   = BIT(5),
2244         WIPHY_WOWLAN_4WAY_HANDSHAKE     = BIT(6),
2245         WIPHY_WOWLAN_RFKILL_RELEASE     = BIT(7),
2246 };
2247
2248 /**
2249  * struct wiphy_wowlan_support - WoWLAN support data
2250  * @flags: see &enum wiphy_wowlan_support_flags
2251  * @n_patterns: number of supported wakeup patterns
2252  *      (see nl80211.h for the pattern definition)
2253  * @pattern_max_len: maximum length of each pattern
2254  * @pattern_min_len: minimum length of each pattern
2255  */
2256 struct wiphy_wowlan_support {
2257         u32 flags;
2258         int n_patterns;
2259         int pattern_max_len;
2260         int pattern_min_len;
2261 };
2262
2263 /**
2264  * struct wiphy - wireless hardware description
2265  * @reg_notifier: the driver's regulatory notification callback,
2266  *      note that if your driver uses wiphy_apply_custom_regulatory()
2267  *      the reg_notifier's request can be passed as NULL
2268  * @regd: the driver's regulatory domain, if one was requested via
2269  *      the regulatory_hint() API. This can be used by the driver
2270  *      on the reg_notifier() if it chooses to ignore future
2271  *      regulatory domain changes caused by other drivers.
2272  * @signal_type: signal type reported in &struct cfg80211_bss.
2273  * @cipher_suites: supported cipher suites
2274  * @n_cipher_suites: number of supported cipher suites
2275  * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
2276  * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
2277  * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
2278  *      -1 = fragmentation disabled, only odd values >= 256 used
2279  * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
2280  * @_net: the network namespace this wiphy currently lives in
2281  * @perm_addr: permanent MAC address of this device
2282  * @addr_mask: If the device supports multiple MAC addresses by masking,
2283  *      set this to a mask with variable bits set to 1, e.g. if the last
2284  *      four bits are variable then set it to 00:...:00:0f. The actual
2285  *      variable bits shall be determined by the interfaces added, with
2286  *      interfaces not matching the mask being rejected to be brought up.
2287  * @n_addresses: number of addresses in @addresses.
2288  * @addresses: If the device has more than one address, set this pointer
2289  *      to a list of addresses (6 bytes each). The first one will be used
2290  *      by default for perm_addr. In this case, the mask should be set to
2291  *      all-zeroes. In this case it is assumed that the device can handle
2292  *      the same number of arbitrary MAC addresses.
2293  * @registered: protects ->resume and ->suspend sysfs callbacks against
2294  *      unregister hardware
2295  * @debugfsdir: debugfs directory used for this wiphy, will be renamed
2296  *      automatically on wiphy renames
2297  * @dev: (virtual) struct device for this wiphy
2298  * @registered: helps synchronize suspend/resume with wiphy unregister
2299  * @wext: wireless extension handlers
2300  * @priv: driver private data (sized according to wiphy_new() parameter)
2301  * @interface_modes: bitmask of interfaces types valid for this wiphy,
2302  *      must be set by driver
2303  * @iface_combinations: Valid interface combinations array, should not
2304  *      list single interface types.
2305  * @n_iface_combinations: number of entries in @iface_combinations array.
2306  * @software_iftypes: bitmask of software interface types, these are not
2307  *      subject to any restrictions since they are purely managed in SW.
2308  * @flags: wiphy flags, see &enum wiphy_flags
2309  * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
2310  * @bss_priv_size: each BSS struct has private data allocated with it,
2311  *      this variable determines its size
2312  * @max_scan_ssids: maximum number of SSIDs the device can scan for in
2313  *      any given scan
2314  * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
2315  *      for in any given scheduled scan
2316  * @max_match_sets: maximum number of match sets the device can handle
2317  *      when performing a scheduled scan, 0 if filtering is not
2318  *      supported.
2319  * @max_scan_ie_len: maximum length of user-controlled IEs device can
2320  *      add to probe request frames transmitted during a scan, must not
2321  *      include fixed IEs like supported rates
2322  * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
2323  *      scans
2324  * @coverage_class: current coverage class
2325  * @fw_version: firmware version for ethtool reporting
2326  * @hw_version: hardware version for ethtool reporting
2327  * @max_num_pmkids: maximum number of PMKIDs supported by device
2328  * @privid: a pointer that drivers can use to identify if an arbitrary
2329  *      wiphy is theirs, e.g. in global notifiers
2330  * @bands: information about bands/channels supported by this device
2331  *
2332  * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
2333  *      transmitted through nl80211, points to an array indexed by interface
2334  *      type
2335  *
2336  * @available_antennas_tx: bitmap of antennas which are available to be
2337  *      configured as TX antennas. Antenna configuration commands will be
2338  *      rejected unless this or @available_antennas_rx is set.
2339  *
2340  * @available_antennas_rx: bitmap of antennas which are available to be
2341  *      configured as RX antennas. Antenna configuration commands will be
2342  *      rejected unless this or @available_antennas_tx is set.
2343  *
2344  * @probe_resp_offload:
2345  *       Bitmap of supported protocols for probe response offloading.
2346  *       See &enum nl80211_probe_resp_offload_support_attr. Only valid
2347  *       when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2348  *
2349  * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
2350  *      may request, if implemented.
2351  *
2352  * @wowlan: WoWLAN support information
2353  *
2354  * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
2355  * @ht_capa_mod_mask:  Specify what ht_cap values can be over-ridden.
2356  *      If null, then none can be over-ridden.
2357  *
2358  * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
2359  *      supports for ACL.
2360  */
2361 struct wiphy {
2362         /* assign these fields before you register the wiphy */
2363
2364         /* permanent MAC address(es) */
2365         u8 perm_addr[ETH_ALEN];
2366         u8 addr_mask[ETH_ALEN];
2367
2368         struct mac_address *addresses;
2369
2370         const struct ieee80211_txrx_stypes *mgmt_stypes;
2371
2372         const struct ieee80211_iface_combination *iface_combinations;
2373         int n_iface_combinations;
2374         u16 software_iftypes;
2375
2376         u16 n_addresses;
2377
2378         /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
2379         u16 interface_modes;
2380
2381         u16 max_acl_mac_addrs;
2382
2383         u32 flags, features;
2384
2385         u32 ap_sme_capa;
2386
2387         enum cfg80211_signal_type signal_type;
2388
2389         int bss_priv_size;
2390         u8 max_scan_ssids;
2391         u8 max_sched_scan_ssids;
2392         u8 max_match_sets;
2393         u16 max_scan_ie_len;
2394         u16 max_sched_scan_ie_len;
2395
2396         int n_cipher_suites;
2397         const u32 *cipher_suites;
2398
2399         u8 retry_short;
2400         u8 retry_long;
2401         u32 frag_threshold;
2402         u32 rts_threshold;
2403         u8 coverage_class;
2404
2405         char fw_version[ETHTOOL_FWVERS_LEN];
2406         u32 hw_version;
2407
2408 #ifdef CONFIG_PM
2409         struct wiphy_wowlan_support wowlan;
2410 #endif
2411
2412         u16 max_remain_on_channel_duration;
2413
2414         u8 max_num_pmkids;
2415
2416         u32 available_antennas_tx;
2417         u32 available_antennas_rx;
2418
2419         /*
2420          * Bitmap of supported protocols for probe response offloading
2421          * see &enum nl80211_probe_resp_offload_support_attr. Only valid
2422          * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2423          */
2424         u32 probe_resp_offload;
2425
2426         /* If multiple wiphys are registered and you're handed e.g.
2427          * a regular netdev with assigned ieee80211_ptr, you won't
2428          * know whether it points to a wiphy your driver has registered
2429          * or not. Assign this to something global to your driver to
2430          * help determine whether you own this wiphy or not. */
2431         const void *privid;
2432
2433         struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
2434
2435         /* Lets us get back the wiphy on the callback */
2436         void (*reg_notifier)(struct wiphy *wiphy,
2437                              struct regulatory_request *request);
2438
2439         /* fields below are read-only, assigned by cfg80211 */
2440
2441         const struct ieee80211_regdomain __rcu *regd;
2442
2443         /* the item in /sys/class/ieee80211/ points to this,
2444          * you need use set_wiphy_dev() (see below) */
2445         struct device dev;
2446
2447         /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
2448         bool registered;
2449
2450         /* dir in debugfs: ieee80211/<wiphyname> */
2451         struct dentry *debugfsdir;
2452
2453         const struct ieee80211_ht_cap *ht_capa_mod_mask;
2454
2455 #ifdef CONFIG_NET_NS
2456         /* the network namespace this phy lives in currently */
2457         struct net *_net;
2458 #endif
2459
2460 #ifdef CONFIG_CFG80211_WEXT
2461         const struct iw_handler_def *wext;
2462 #endif
2463
2464         char priv[0] __aligned(NETDEV_ALIGN);
2465 };
2466
2467 static inline struct net *wiphy_net(struct wiphy *wiphy)
2468 {
2469         return read_pnet(&wiphy->_net);
2470 }
2471
2472 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
2473 {
2474         write_pnet(&wiphy->_net, net);
2475 }
2476
2477 /**
2478  * wiphy_priv - return priv from wiphy
2479  *
2480  * @wiphy: the wiphy whose priv pointer to return
2481  * Return: The priv of @wiphy.
2482  */
2483 static inline void *wiphy_priv(struct wiphy *wiphy)
2484 {
2485         BUG_ON(!wiphy);
2486         return &wiphy->priv;
2487 }
2488
2489 /**
2490  * priv_to_wiphy - return the wiphy containing the priv
2491  *
2492  * @priv: a pointer previously returned by wiphy_priv
2493  * Return: The wiphy of @priv.
2494  */
2495 static inline struct wiphy *priv_to_wiphy(void *priv)
2496 {
2497         BUG_ON(!priv);
2498         return container_of(priv, struct wiphy, priv);
2499 }
2500
2501 /**
2502  * set_wiphy_dev - set device pointer for wiphy
2503  *
2504  * @wiphy: The wiphy whose device to bind
2505  * @dev: The device to parent it to
2506  */
2507 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
2508 {
2509         wiphy->dev.parent = dev;
2510 }
2511
2512 /**
2513  * wiphy_dev - get wiphy dev pointer
2514  *
2515  * @wiphy: The wiphy whose device struct to look up
2516  * Return: The dev of @wiphy.
2517  */
2518 static inline struct device *wiphy_dev(struct wiphy *wiphy)
2519 {
2520         return wiphy->dev.parent;
2521 }
2522
2523 /**
2524  * wiphy_name - get wiphy name
2525  *
2526  * @wiphy: The wiphy whose name to return
2527  * Return: The name of @wiphy.
2528  */
2529 static inline const char *wiphy_name(const struct wiphy *wiphy)
2530 {
2531         return dev_name(&wiphy->dev);
2532 }
2533
2534 /**
2535  * wiphy_new - create a new wiphy for use with cfg80211
2536  *
2537  * @ops: The configuration operations for this device
2538  * @sizeof_priv: The size of the private area to allocate
2539  *
2540  * Create a new wiphy and associate the given operations with it.
2541  * @sizeof_priv bytes are allocated for private use.
2542  *
2543  * Return: A pointer to the new wiphy. This pointer must be
2544  * assigned to each netdev's ieee80211_ptr for proper operation.
2545  */
2546 struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
2547
2548 /**
2549  * wiphy_register - register a wiphy with cfg80211
2550  *
2551  * @wiphy: The wiphy to register.
2552  *
2553  * Return: A non-negative wiphy index or a negative error code.
2554  */
2555 extern int wiphy_register(struct wiphy *wiphy);
2556
2557 /**
2558  * wiphy_unregister - deregister a wiphy from cfg80211
2559  *
2560  * @wiphy: The wiphy to unregister.
2561  *
2562  * After this call, no more requests can be made with this priv
2563  * pointer, but the call may sleep to wait for an outstanding
2564  * request that is being handled.
2565  */
2566 extern void wiphy_unregister(struct wiphy *wiphy);
2567
2568 /**
2569  * wiphy_free - free wiphy
2570  *
2571  * @wiphy: The wiphy to free
2572  */
2573 extern void wiphy_free(struct wiphy *wiphy);
2574
2575 /* internal structs */
2576 struct cfg80211_conn;
2577 struct cfg80211_internal_bss;
2578 struct cfg80211_cached_keys;
2579
2580 /**
2581  * struct wireless_dev - wireless device state
2582  *
2583  * For netdevs, this structure must be allocated by the driver
2584  * that uses the ieee80211_ptr field in struct net_device (this
2585  * is intentional so it can be allocated along with the netdev.)
2586  * It need not be registered then as netdev registration will
2587  * be intercepted by cfg80211 to see the new wireless device.
2588  *
2589  * For non-netdev uses, it must also be allocated by the driver
2590  * in response to the cfg80211 callbacks that require it, as
2591  * there's no netdev registration in that case it may not be
2592  * allocated outside of callback operations that return it.
2593  *
2594  * @wiphy: pointer to hardware description
2595  * @iftype: interface type
2596  * @list: (private) Used to collect the interfaces
2597  * @netdev: (private) Used to reference back to the netdev, may be %NULL
2598  * @identifier: (private) Identifier used in nl80211 to identify this
2599  *      wireless device if it has no netdev
2600  * @current_bss: (private) Used by the internal configuration code
2601  * @channel: (private) Used by the internal configuration code to track
2602  *      the user-set AP, monitor and WDS channel
2603  * @preset_chan: (private) Used by the internal configuration code to
2604  *      track the channel to be used for AP later
2605  * @preset_chantype: (private) the corresponding channel type
2606  * @bssid: (private) Used by the internal configuration code
2607  * @ssid: (private) Used by the internal configuration code
2608  * @ssid_len: (private) Used by the internal configuration code
2609  * @mesh_id_len: (private) Used by the internal configuration code
2610  * @mesh_id_up_len: (private) Used by the internal configuration code
2611  * @wext: (private) Used by the internal wireless extensions compat code
2612  * @use_4addr: indicates 4addr mode is used on this interface, must be
2613  *      set by driver (if supported) on add_interface BEFORE registering the
2614  *      netdev and may otherwise be used by driver read-only, will be update
2615  *      by cfg80211 on change_interface
2616  * @mgmt_registrations: list of registrations for management frames
2617  * @mgmt_registrations_lock: lock for the list
2618  * @mtx: mutex used to lock data in this struct
2619  * @cleanup_work: work struct used for cleanup that can't be done directly
2620  * @beacon_interval: beacon interval used on this device for transmitting
2621  *      beacons, 0 when not valid
2622  * @address: The address for this device, valid only if @netdev is %NULL
2623  * @p2p_started: true if this is a P2P Device that has been started
2624  */
2625 struct wireless_dev {
2626         struct wiphy *wiphy;
2627         enum nl80211_iftype iftype;
2628
2629         /* the remainder of this struct should be private to cfg80211 */
2630         struct list_head list;
2631         struct net_device *netdev;
2632
2633         u32 identifier;
2634
2635         struct list_head mgmt_registrations;
2636         spinlock_t mgmt_registrations_lock;
2637
2638         struct mutex mtx;
2639
2640         struct work_struct cleanup_work;
2641
2642         bool use_4addr, p2p_started;
2643
2644         u8 address[ETH_ALEN] __aligned(sizeof(u16));
2645
2646         /* currently used for IBSS and SME - might be rearranged later */
2647         u8 ssid[IEEE80211_MAX_SSID_LEN];
2648         u8 ssid_len, mesh_id_len, mesh_id_up_len;
2649         enum {
2650                 CFG80211_SME_IDLE,
2651                 CFG80211_SME_CONNECTING,
2652                 CFG80211_SME_CONNECTED,
2653         } sme_state;
2654         struct cfg80211_conn *conn;
2655         struct cfg80211_cached_keys *connect_keys;
2656
2657         struct list_head event_list;
2658         spinlock_t event_lock;
2659
2660         struct cfg80211_internal_bss *current_bss; /* associated / joined */
2661         struct cfg80211_chan_def preset_chandef;
2662
2663         /* for AP and mesh channel tracking */
2664         struct ieee80211_channel *channel;
2665
2666         bool ibss_fixed;
2667
2668         bool ps;
2669         int ps_timeout;
2670
2671         int beacon_interval;
2672
2673         u32 ap_unexpected_nlportid;
2674
2675 #ifdef CONFIG_CFG80211_WEXT
2676         /* wext data */
2677         struct {
2678                 struct cfg80211_ibss_params ibss;
2679                 struct cfg80211_connect_params connect;
2680                 struct cfg80211_cached_keys *keys;
2681                 u8 *ie;
2682                 size_t ie_len;
2683                 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
2684                 u8 ssid[IEEE80211_MAX_SSID_LEN];
2685                 s8 default_key, default_mgmt_key;
2686                 bool prev_bssid_valid;
2687         } wext;
2688 #endif
2689 };
2690
2691 static inline u8 *wdev_address(struct wireless_dev *wdev)
2692 {
2693         if (wdev->netdev)
2694                 return wdev->netdev->dev_addr;
2695         return wdev->address;
2696 }
2697
2698 /**
2699  * wdev_priv - return wiphy priv from wireless_dev
2700  *
2701  * @wdev: The wireless device whose wiphy's priv pointer to return
2702  * Return: The wiphy priv of @wdev.
2703  */
2704 static inline void *wdev_priv(struct wireless_dev *wdev)
2705 {
2706         BUG_ON(!wdev);
2707         return wiphy_priv(wdev->wiphy);
2708 }
2709
2710 /**
2711  * DOC: Utility functions
2712  *
2713  * cfg80211 offers a number of utility functions that can be useful.
2714  */
2715
2716 /**
2717  * ieee80211_channel_to_frequency - convert channel number to frequency
2718  * @chan: channel number
2719  * @band: band, necessary due to channel number overlap
2720  * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
2721  */
2722 extern int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
2723
2724 /**
2725  * ieee80211_frequency_to_channel - convert frequency to channel number
2726  * @freq: center frequency
2727  * Return: The corresponding channel, or 0 if the conversion failed.
2728  */
2729 extern int ieee80211_frequency_to_channel(int freq);
2730
2731 /*
2732  * Name indirection necessary because the ieee80211 code also has
2733  * a function named "ieee80211_get_channel", so if you include
2734  * cfg80211's header file you get cfg80211's version, if you try
2735  * to include both header files you'll (rightfully!) get a symbol
2736  * clash.
2737  */
2738 extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
2739                                                          int freq);
2740 /**
2741  * ieee80211_get_channel - get channel struct from wiphy for specified frequency
2742  * @wiphy: the struct wiphy to get the channel for
2743  * @freq: the center frequency of the channel
2744  * Return: The channel struct from @wiphy at @freq.
2745  */
2746 static inline struct ieee80211_channel *
2747 ieee80211_get_channel(struct wiphy *wiphy, int freq)
2748 {
2749         return __ieee80211_get_channel(wiphy, freq);
2750 }
2751
2752 /**
2753  * ieee80211_get_response_rate - get basic rate for a given rate
2754  *
2755  * @sband: the band to look for rates in
2756  * @basic_rates: bitmap of basic rates
2757  * @bitrate: the bitrate for which to find the basic rate
2758  *
2759  * Return: The basic rate corresponding to a given bitrate, that
2760  * is the next lower bitrate contained in the basic rate map,
2761  * which is, for this function, given as a bitmap of indices of
2762  * rates in the band's bitrate table.
2763  */
2764 struct ieee80211_rate *
2765 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
2766                             u32 basic_rates, int bitrate);
2767
2768 /*
2769  * Radiotap parsing functions -- for controlled injection support
2770  *
2771  * Implemented in net/wireless/radiotap.c
2772  * Documentation in Documentation/networking/radiotap-headers.txt
2773  */
2774
2775 struct radiotap_align_size {
2776         uint8_t align:4, size:4;
2777 };
2778
2779 struct ieee80211_radiotap_namespace {
2780         const struct radiotap_align_size *align_size;
2781         int n_bits;
2782         uint32_t oui;
2783         uint8_t subns;
2784 };
2785
2786 struct ieee80211_radiotap_vendor_namespaces {
2787         const struct ieee80211_radiotap_namespace *ns;
2788         int n_ns;
2789 };
2790
2791 /**
2792  * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
2793  * @this_arg_index: index of current arg, valid after each successful call
2794  *      to ieee80211_radiotap_iterator_next()
2795  * @this_arg: pointer to current radiotap arg; it is valid after each
2796  *      call to ieee80211_radiotap_iterator_next() but also after
2797  *      ieee80211_radiotap_iterator_init() where it will point to
2798  *      the beginning of the actual data portion
2799  * @this_arg_size: length of the current arg, for convenience
2800  * @current_namespace: pointer to the current namespace definition
2801  *      (or internally %NULL if the current namespace is unknown)
2802  * @is_radiotap_ns: indicates whether the current namespace is the default
2803  *      radiotap namespace or not
2804  *
2805  * @_rtheader: pointer to the radiotap header we are walking through
2806  * @_max_length: length of radiotap header in cpu byte ordering
2807  * @_arg_index: next argument index
2808  * @_arg: next argument pointer
2809  * @_next_bitmap: internal pointer to next present u32
2810  * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
2811  * @_vns: vendor namespace definitions
2812  * @_next_ns_data: beginning of the next namespace's data
2813  * @_reset_on_ext: internal; reset the arg index to 0 when going to the
2814  *      next bitmap word
2815  *
2816  * Describes the radiotap parser state. Fields prefixed with an underscore
2817  * must not be used by users of the parser, only by the parser internally.
2818  */
2819
2820 struct ieee80211_radiotap_iterator {
2821         struct ieee80211_radiotap_header *_rtheader;
2822         const struct ieee80211_radiotap_vendor_namespaces *_vns;
2823         const struct ieee80211_radiotap_namespace *current_namespace;
2824
2825         unsigned char *_arg, *_next_ns_data;
2826         __le32 *_next_bitmap;
2827
2828         unsigned char *this_arg;
2829         int this_arg_index;
2830         int this_arg_size;
2831
2832         int is_radiotap_ns;
2833
2834         int _max_length;
2835         int _arg_index;
2836         uint32_t _bitmap_shifter;
2837         int _reset_on_ext;
2838 };
2839
2840 extern int ieee80211_radiotap_iterator_init(
2841         struct ieee80211_radiotap_iterator *iterator,
2842         struct ieee80211_radiotap_header *radiotap_header,
2843         int max_length, const struct ieee80211_radiotap_vendor_namespaces *vns);
2844
2845 extern int ieee80211_radiotap_iterator_next(
2846         struct ieee80211_radiotap_iterator *iterator);
2847
2848
2849 extern const unsigned char rfc1042_header[6];
2850 extern const unsigned char bridge_tunnel_header[6];
2851
2852 /**
2853  * ieee80211_get_hdrlen_from_skb - get header length from data
2854  *
2855  * @skb: the frame
2856  *
2857  * Given an skb with a raw 802.11 header at the data pointer this function
2858  * returns the 802.11 header length.
2859  *
2860  * Return: The 802.11 header length in bytes (not including encryption
2861  * headers). Or 0 if the data in the sk_buff is too short to contain a valid
2862  * 802.11 header.
2863  */
2864 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
2865
2866 /**
2867  * ieee80211_hdrlen - get header length in bytes from frame control
2868  * @fc: frame control field in little-endian format
2869  * Return: The header length in bytes.
2870  */
2871 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
2872
2873 /**
2874  * ieee80211_get_mesh_hdrlen - get mesh extension header length
2875  * @meshhdr: the mesh extension header, only the flags field
2876  *      (first byte) will be accessed
2877  * Return: The length of the extension header, which is always at
2878  * least 6 bytes and at most 18 if address 5 and 6 are present.
2879  */
2880 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
2881
2882 /**
2883  * DOC: Data path helpers
2884  *
2885  * In addition to generic utilities, cfg80211 also offers
2886  * functions that help implement the data path for devices
2887  * that do not do the 802.11/802.3 conversion on the device.
2888  */
2889
2890 /**
2891  * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
2892  * @skb: the 802.11 data frame
2893  * @addr: the device MAC address
2894  * @iftype: the virtual interface type
2895  * Return: 0 on success. Non-zero on error.
2896  */
2897 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
2898                            enum nl80211_iftype iftype);
2899
2900 /**
2901  * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
2902  * @skb: the 802.3 frame
2903  * @addr: the device MAC address
2904  * @iftype: the virtual interface type
2905  * @bssid: the network bssid (used only for iftype STATION and ADHOC)
2906  * @qos: build 802.11 QoS data frame
2907  * Return: 0 on success, or a negative error code.
2908  */
2909 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
2910                              enum nl80211_iftype iftype, u8 *bssid, bool qos);
2911
2912 /**
2913  * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
2914  *
2915  * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
2916  * 802.3 frames. The @list will be empty if the decode fails. The
2917  * @skb is consumed after the function returns.
2918  *
2919  * @skb: The input IEEE 802.11n A-MSDU frame.
2920  * @list: The output list of 802.3 frames. It must be allocated and
2921  *      initialized by by the caller.
2922  * @addr: The device MAC address.
2923  * @iftype: The device interface type.
2924  * @extra_headroom: The hardware extra headroom for SKBs in the @list.
2925  * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
2926  */
2927 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
2928                               const u8 *addr, enum nl80211_iftype iftype,
2929                               const unsigned int extra_headroom,
2930                               bool has_80211_header);
2931
2932 /**
2933  * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
2934  * @skb: the data frame
2935  * Return: The 802.1p/1d tag.
2936  */
2937 unsigned int cfg80211_classify8021d(struct sk_buff *skb);
2938
2939 /**
2940  * cfg80211_find_ie - find information element in data
2941  *
2942  * @eid: element ID
2943  * @ies: data consisting of IEs
2944  * @len: length of data
2945  *
2946  * Return: %NULL if the element ID could not be found or if
2947  * the element is invalid (claims to be longer than the given
2948  * data), or a pointer to the first byte of the requested
2949  * element, that is the byte containing the element ID.
2950  *
2951  * Note: There are no checks on the element length other than
2952  * having to fit into the given data.
2953  */
2954 const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
2955
2956 /**
2957  * cfg80211_find_vendor_ie - find vendor specific information element in data
2958  *
2959  * @oui: vendor OUI
2960  * @oui_type: vendor-specific OUI type
2961  * @ies: data consisting of IEs
2962  * @len: length of data
2963  *
2964  * Return: %NULL if the vendor specific element ID could not be found or if the
2965  * element is invalid (claims to be longer than the given data), or a pointer to
2966  * the first byte of the requested element, that is the byte containing the
2967  * element ID.
2968  *
2969  * Note: There are no checks on the element length other than having to fit into
2970  * the given data.
2971  */
2972 const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,
2973                                   const u8 *ies, int len);
2974
2975 /**
2976  * DOC: Regulatory enforcement infrastructure
2977  *
2978  * TODO
2979  */
2980
2981 /**
2982  * regulatory_hint - driver hint to the wireless core a regulatory domain
2983  * @wiphy: the wireless device giving the hint (used only for reporting
2984  *      conflicts)
2985  * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
2986  *      should be in. If @rd is set this should be NULL. Note that if you
2987  *      set this to NULL you should still set rd->alpha2 to some accepted
2988  *      alpha2.
2989  *
2990  * Wireless drivers can use this function to hint to the wireless core
2991  * what it believes should be the current regulatory domain by
2992  * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
2993  * domain should be in or by providing a completely build regulatory domain.
2994  * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
2995  * for a regulatory domain structure for the respective country.
2996  *
2997  * The wiphy must have been registered to cfg80211 prior to this call.
2998  * For cfg80211 drivers this means you must first use wiphy_register(),
2999  * for mac80211 drivers you must first use ieee80211_register_hw().
3000  *
3001  * Drivers should check the return value, its possible you can get
3002  * an -ENOMEM.
3003  *
3004  * Return: 0 on success. -ENOMEM.
3005  */
3006 extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
3007
3008 /**
3009  * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
3010  * @wiphy: the wireless device we want to process the regulatory domain on
3011  * @regd: the custom regulatory domain to use for this wiphy
3012  *
3013  * Drivers can sometimes have custom regulatory domains which do not apply
3014  * to a specific country. Drivers can use this to apply such custom regulatory
3015  * domains. This routine must be called prior to wiphy registration. The
3016  * custom regulatory domain will be trusted completely and as such previous
3017  * default channel settings will be disregarded. If no rule is found for a
3018  * channel on the regulatory domain the channel will be disabled.
3019  */
3020 extern void wiphy_apply_custom_regulatory(
3021         struct wiphy *wiphy,
3022         const struct ieee80211_regdomain *regd);
3023
3024 /**
3025  * freq_reg_info - get regulatory information for the given frequency
3026  * @wiphy: the wiphy for which we want to process this rule for
3027  * @center_freq: Frequency in KHz for which we want regulatory information for
3028  *
3029  * Use this function to get the regulatory rule for a specific frequency on
3030  * a given wireless device. If the device has a specific regulatory domain
3031  * it wants to follow we respect that unless a country IE has been received
3032  * and processed already.
3033  *
3034  * Return: A valid pointer, or, when an error occurs, for example if no rule
3035  * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
3036  * check and PTR_ERR() to obtain the numeric return value. The numeric return
3037  * value will be -ERANGE if we determine the given center_freq does not even
3038  * have a regulatory rule for a frequency range in the center_freq's band.
3039  * See freq_in_rule_band() for our current definition of a band -- this is
3040  * purely subjective and right now it's 802.11 specific.
3041  */
3042 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
3043                                                u32 center_freq);
3044
3045 /*
3046  * callbacks for asynchronous cfg80211 methods, notification
3047  * functions and BSS handling helpers
3048  */
3049
3050 /**
3051  * cfg80211_scan_done - notify that scan finished
3052  *
3053  * @request: the corresponding scan request
3054  * @aborted: set to true if the scan was aborted for any reason,
3055  *      userspace will be notified of that
3056  */
3057 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
3058
3059 /**
3060  * cfg80211_sched_scan_results - notify that new scan results are available
3061  *
3062  * @wiphy: the wiphy which got scheduled scan results
3063  */
3064 void cfg80211_sched_scan_results(struct wiphy *wiphy);
3065
3066 /**
3067  * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
3068  *
3069  * @wiphy: the wiphy on which the scheduled scan stopped
3070  *
3071  * The driver can call this function to inform cfg80211 that the
3072  * scheduled scan had to be stopped, for whatever reason.  The driver
3073  * is then called back via the sched_scan_stop operation when done.
3074  */
3075 void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
3076
3077 /**
3078  * cfg80211_inform_bss_frame - inform cfg80211 of a received BSS frame
3079  *
3080  * @wiphy: the wiphy reporting the BSS
3081  * @channel: The channel the frame was received on
3082  * @mgmt: the management frame (probe response or beacon)
3083  * @len: length of the management frame
3084  * @signal: the signal strength, type depends on the wiphy's signal_type
3085  * @gfp: context flags
3086  *
3087  * This informs cfg80211 that BSS information was found and
3088  * the BSS should be updated/added.
3089  *
3090  * Return: A referenced struct, must be released with cfg80211_put_bss()!
3091  * Or %NULL on error.
3092  */
3093 struct cfg80211_bss * __must_check
3094 cfg80211_inform_bss_frame(struct wiphy *wiphy,
3095                           struct ieee80211_channel *channel,
3096                           struct ieee80211_mgmt *mgmt, size_t len,
3097                           s32 signal, gfp_t gfp);
3098
3099 /**
3100  * cfg80211_inform_bss - inform cfg80211 of a new BSS
3101  *
3102  * @wiphy: the wiphy reporting the BSS
3103  * @channel: The channel the frame was received on
3104  * @bssid: the BSSID of the BSS
3105  * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
3106  * @capability: the capability field sent by the peer
3107  * @beacon_interval: the beacon interval announced by the peer
3108  * @ie: additional IEs sent by the peer
3109  * @ielen: length of the additional IEs
3110  * @signal: the signal strength, type depends on the wiphy's signal_type
3111  * @gfp: context flags
3112  *
3113  * This informs cfg80211 that BSS information was found and
3114  * the BSS should be updated/added.
3115  *
3116  * Return: A referenced struct, must be released with cfg80211_put_bss()!
3117  * Or %NULL on error.
3118  */
3119 struct cfg80211_bss * __must_check
3120 cfg80211_inform_bss(struct wiphy *wiphy,
3121                     struct ieee80211_channel *channel,
3122                     const u8 *bssid, u64 tsf, u16 capability,
3123                     u16 beacon_interval, const u8 *ie, size_t ielen,
3124                     s32 signal, gfp_t gfp);
3125
3126 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
3127                                       struct ieee80211_channel *channel,
3128                                       const u8 *bssid,
3129                                       const u8 *ssid, size_t ssid_len,
3130                                       u16 capa_mask, u16 capa_val);
3131 static inline struct cfg80211_bss *
3132 cfg80211_get_ibss(struct wiphy *wiphy,
3133                   struct ieee80211_channel *channel,
3134                   const u8 *ssid, size_t ssid_len)
3135 {
3136         return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
3137                                 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
3138 }
3139
3140 struct cfg80211_bss *cfg80211_get_mesh(struct wiphy *wiphy,
3141                                        struct ieee80211_channel *channel,
3142                                        const u8 *meshid, size_t meshidlen,
3143                                        const u8 *meshcfg);
3144 /**
3145  * cfg80211_ref_bss - reference BSS struct
3146  * @bss: the BSS struct to reference
3147  *
3148  * Increments the refcount of the given BSS struct.
3149  */
3150 void cfg80211_ref_bss(struct cfg80211_bss *bss);
3151
3152 /**
3153  * cfg80211_put_bss - unref BSS struct
3154  * @bss: the BSS struct
3155  *
3156  * Decrements the refcount of the given BSS struct.
3157  */
3158 void cfg80211_put_bss(struct cfg80211_bss *bss);
3159
3160 /**
3161  * cfg80211_unlink_bss - unlink BSS from internal data structures
3162  * @wiphy: the wiphy
3163  * @bss: the bss to remove
3164  *
3165  * This function removes the given BSS from the internal data structures
3166  * thereby making it no longer show up in scan results etc. Use this
3167  * function when you detect a BSS is gone. Normally BSSes will also time
3168  * out, so it is not necessary to use this function at all.
3169  */
3170 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3171
3172 /**
3173  * cfg80211_send_rx_auth - notification of processed authentication
3174  * @dev: network device
3175  * @buf: authentication frame (header + body)
3176  * @len: length of the frame data
3177  *
3178  * This function is called whenever an authentication has been processed in
3179  * station mode. The driver is required to call either this function or
3180  * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
3181  * call. This function may sleep.
3182  */
3183 void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
3184
3185 /**
3186  * cfg80211_send_auth_timeout - notification of timed out authentication
3187  * @dev: network device
3188  * @addr: The MAC address of the device with which the authentication timed out
3189  *
3190  * This function may sleep.
3191  */
3192 void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr);
3193
3194 /**
3195  * cfg80211_send_rx_assoc - notification of processed association
3196  * @dev: network device
3197  * @bss: the BSS struct association was requested for, the struct reference
3198  *      is owned by cfg80211 after this call
3199  * @buf: (re)association response frame (header + body)
3200  * @len: length of the frame data
3201  *
3202  * This function is called whenever a (re)association response has been
3203  * processed in station mode. The driver is required to call either this
3204  * function or cfg80211_send_assoc_timeout() to indicate the result of
3205  * cfg80211_ops::assoc() call. This function may sleep.
3206  */
3207 void cfg80211_send_rx_assoc(struct net_device *dev, struct cfg80211_bss *bss,
3208                             const u8 *buf, size_t len);
3209
3210 /**
3211  * cfg80211_send_assoc_timeout - notification of timed out association
3212  * @dev: network device
3213  * @addr: The MAC address of the device with which the association timed out
3214  *
3215  * This function may sleep.
3216  */
3217 void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr);
3218
3219 /**
3220  * cfg80211_send_deauth - notification of processed deauthentication
3221  * @dev: network device
3222  * @buf: deauthentication frame (header + body)
3223  * @len: length of the frame data
3224  *
3225  * This function is called whenever deauthentication has been processed in
3226  * station mode. This includes both received deauthentication frames and
3227  * locally generated ones. This function may sleep.
3228  */
3229 void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
3230
3231 /**
3232  * __cfg80211_send_deauth - notification of processed deauthentication
3233  * @dev: network device
3234  * @buf: deauthentication frame (header + body)
3235  * @len: length of the frame data
3236  *
3237  * Like cfg80211_send_deauth(), but doesn't take the wdev lock.
3238  */
3239 void __cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
3240
3241 /**
3242  * cfg80211_send_disassoc - notification of processed disassociation
3243  * @dev: network device
3244  * @buf: disassociation response frame (header + body)
3245  * @len: length of the frame data
3246  *
3247  * This function is called whenever disassociation has been processed in
3248  * station mode. This includes both received disassociation frames and locally
3249  * generated ones. This function may sleep.
3250  */
3251 void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len);
3252
3253 /**
3254  * __cfg80211_send_disassoc - notification of processed disassociation
3255  * @dev: network device
3256  * @buf: disassociation response frame (header + body)
3257  * @len: length of the frame data
3258  *
3259  * Like cfg80211_send_disassoc(), but doesn't take the wdev lock.
3260  */
3261 void __cfg80211_send_disassoc(struct net_device *dev, const u8 *buf,
3262         size_t len);
3263
3264 /**
3265  * cfg80211_send_unprot_deauth - notification of unprotected deauthentication
3266  * @dev: network device
3267  * @buf: deauthentication frame (header + body)
3268  * @len: length of the frame data
3269  *
3270  * This function is called whenever a received Deauthentication frame has been
3271  * dropped in station mode because of MFP being used but the Deauthentication
3272  * frame was not protected. This function may sleep.
3273  */
3274 void cfg80211_send_unprot_deauth(struct net_device *dev, const u8 *buf,
3275                                  size_t len);
3276
3277 /**
3278  * cfg80211_send_unprot_disassoc - notification of unprotected disassociation
3279  * @dev: network device
3280  * @buf: disassociation frame (header + body)
3281  * @len: length of the frame data
3282  *
3283  * This function is called whenever a received Disassociation frame has been
3284  * dropped in station mode because of MFP being used but the Disassociation
3285  * frame was not protected. This function may sleep.
3286  */
3287 void cfg80211_send_unprot_disassoc(struct net_device *dev, const u8 *buf,
3288                                    size_t len);
3289
3290 /**
3291  * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
3292  * @dev: network device
3293  * @addr: The source MAC address of the frame
3294  * @key_type: The key type that the received frame used
3295  * @key_id: Key identifier (0..3). Can be -1 if missing.
3296  * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
3297  * @gfp: allocation flags
3298  *
3299  * This function is called whenever the local MAC detects a MIC failure in a
3300  * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
3301  * primitive.
3302  */
3303 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
3304                                   enum nl80211_key_type key_type, int key_id,
3305                                   const u8 *tsc, gfp_t gfp);
3306
3307 /**
3308  * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
3309  *
3310  * @dev: network device
3311  * @bssid: the BSSID of the IBSS joined
3312  * @gfp: allocation flags
3313  *
3314  * This function notifies cfg80211 that the device joined an IBSS or
3315  * switched to a different BSSID. Before this function can be called,
3316  * either a beacon has to have been received from the IBSS, or one of
3317  * the cfg80211_inform_bss{,_frame} functions must have been called
3318  * with the locally generated beacon -- this guarantees that there is
3319  * always a scan result for this IBSS. cfg80211 will handle the rest.
3320  */
3321 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
3322
3323 /**
3324  * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
3325  *
3326  * @dev: network device
3327  * @macaddr: the MAC address of the new candidate
3328  * @ie: information elements advertised by the peer candidate
3329  * @ie_len: lenght of the information elements buffer
3330  * @gfp: allocation flags
3331  *
3332  * This function notifies cfg80211 that the mesh peer candidate has been
3333  * detected, most likely via a beacon or, less likely, via a probe response.
3334  * cfg80211 then sends a notification to userspace.
3335  */
3336 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
3337                 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
3338
3339 /**
3340  * DOC: RFkill integration
3341  *
3342  * RFkill integration in cfg80211 is almost invisible to drivers,
3343  * as cfg80211 automatically registers an rfkill instance for each
3344  * wireless device it knows about. Soft kill is also translated
3345  * into disconnecting and turning all interfaces off, drivers are
3346  * expected to turn off the device when all interfaces are down.
3347  *
3348  * However, devices may have a hard RFkill line, in which case they
3349  * also need to interact with the rfkill subsystem, via cfg80211.
3350  * They can do this with a few helper functions documented here.
3351  */
3352
3353 /**
3354  * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
3355  * @wiphy: the wiphy
3356  * @blocked: block status
3357  */
3358 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
3359
3360 /**
3361  * wiphy_rfkill_start_polling - start polling rfkill
3362  * @wiphy: the wiphy
3363  */
3364 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
3365
3366 /**
3367  * wiphy_rfkill_stop_polling - stop polling rfkill
3368  * @wiphy: the wiphy
3369  */
3370 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
3371
3372 #ifdef CONFIG_NL80211_TESTMODE
3373 /**
3374  * DOC: Test mode
3375  *
3376  * Test mode is a set of utility functions to allow drivers to
3377  * interact with driver-specific tools to aid, for instance,
3378  * factory programming.
3379  *
3380  * This chapter describes how drivers interact with it, for more
3381  * information see the nl80211 book's chapter on it.
3382  */
3383
3384 /**
3385  * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
3386  * @wiphy: the wiphy
3387  * @approxlen: an upper bound of the length of the data that will
3388  *      be put into the skb
3389  *
3390  * This function allocates and pre-fills an skb for a reply to
3391  * the testmode command. Since it is intended for a reply, calling
3392  * it outside of the @testmode_cmd operation is invalid.
3393  *
3394  * The returned skb is pre-filled with the wiphy index and set up in
3395  * a way that any data that is put into the skb (with skb_put(),
3396  * nla_put() or similar) will end up being within the
3397  * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
3398  * with the skb is adding data for the corresponding userspace tool
3399  * which can then read that data out of the testdata attribute. You
3400  * must not modify the skb in any other way.
3401  *
3402  * When done, call cfg80211_testmode_reply() with the skb and return
3403  * its error code as the result of the @testmode_cmd operation.
3404  *
3405  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
3406  */
3407 struct sk_buff *cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy,
3408                                                   int approxlen);
3409
3410 /**
3411  * cfg80211_testmode_reply - send the reply skb
3412  * @skb: The skb, must have been allocated with
3413  *      cfg80211_testmode_alloc_reply_skb()
3414  *
3415  * Since calling this function will usually be the last thing
3416  * before returning from the @testmode_cmd you should return
3417  * the error code.  Note that this function consumes the skb
3418  * regardless of the return value.
3419  *
3420  * Return: An error code or 0 on success.
3421  */
3422 int cfg80211_testmode_reply(struct sk_buff *skb);
3423
3424 /**
3425  * cfg80211_testmode_alloc_event_skb - allocate testmode event
3426  * @wiphy: the wiphy
3427  * @approxlen: an upper bound of the length of the data that will
3428  *      be put into the skb
3429  * @gfp: allocation flags
3430  *
3431  * This function allocates and pre-fills an skb for an event on the
3432  * testmode multicast group.
3433  *
3434  * The returned skb is set up in the same way as with
3435  * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
3436  * there, you should simply add data to it that will then end up in the
3437  * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
3438  * in any other way.
3439  *
3440  * When done filling the skb, call cfg80211_testmode_event() with the
3441  * skb to send the event.
3442  *
3443  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
3444  */
3445 struct sk_buff *cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy,
3446                                                   int approxlen, gfp_t gfp);
3447
3448 /**
3449  * cfg80211_testmode_event - send the event
3450  * @skb: The skb, must have been allocated with
3451  *      cfg80211_testmode_alloc_event_skb()
3452  * @gfp: allocation flags
3453  *
3454  * This function sends the given @skb, which must have been allocated
3455  * by cfg80211_testmode_alloc_event_skb(), as an event. It always
3456  * consumes it.
3457  */
3458 void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp);
3459
3460 #define CFG80211_TESTMODE_CMD(cmd)      .testmode_cmd = (cmd),
3461 #define CFG80211_TESTMODE_DUMP(cmd)     .testmode_dump = (cmd),
3462 #else
3463 #define CFG80211_TESTMODE_CMD(cmd)
3464 #define CFG80211_TESTMODE_DUMP(cmd)
3465 #endif
3466
3467 /**
3468  * cfg80211_connect_result - notify cfg80211 of connection result
3469  *
3470  * @dev: network device
3471  * @bssid: the BSSID of the AP
3472  * @req_ie: association request IEs (maybe be %NULL)
3473  * @req_ie_len: association request IEs length
3474  * @resp_ie: association response IEs (may be %NULL)
3475  * @resp_ie_len: assoc response IEs length
3476  * @status: status code, 0 for successful connection, use
3477  *      %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
3478  *      the real status code for failures.
3479  * @gfp: allocation flags
3480  *
3481  * It should be called by the underlying driver whenever connect() has
3482  * succeeded.
3483  */
3484 void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
3485                              const u8 *req_ie, size_t req_ie_len,
3486                              const u8 *resp_ie, size_t resp_ie_len,
3487                              u16 status, gfp_t gfp);
3488
3489 /**
3490  * cfg80211_roamed - notify cfg80211 of roaming
3491  *
3492  * @dev: network device
3493  * @channel: the channel of the new AP
3494  * @bssid: the BSSID of the new AP
3495  * @req_ie: association request IEs (maybe be %NULL)
3496  * @req_ie_len: association request IEs length
3497  * @resp_ie: association response IEs (may be %NULL)
3498  * @resp_ie_len: assoc response IEs length
3499  * @gfp: allocation flags
3500  *
3501  * It should be called by the underlying driver whenever it roamed
3502  * from one AP to another while connected.
3503  */
3504 void cfg80211_roamed(struct net_device *dev,
3505                      struct ieee80211_channel *channel,
3506                      const u8 *bssid,
3507                      const u8 *req_ie, size_t req_ie_len,
3508                      const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
3509
3510 /**
3511  * cfg80211_roamed_bss - notify cfg80211 of roaming
3512  *
3513  * @dev: network device
3514  * @bss: entry of bss to which STA got roamed
3515  * @req_ie: association request IEs (maybe be %NULL)
3516  * @req_ie_len: association request IEs length
3517  * @resp_ie: association response IEs (may be %NULL)
3518  * @resp_ie_len: assoc response IEs length
3519  * @gfp: allocation flags
3520  *
3521  * This is just a wrapper to notify cfg80211 of roaming event with driver
3522  * passing bss to avoid a race in timeout of the bss entry. It should be
3523  * called by the underlying driver whenever it roamed from one AP to another
3524  * while connected. Drivers which have roaming implemented in firmware
3525  * may use this function to avoid a race in bss entry timeout where the bss
3526  * entry of the new AP is seen in the driver, but gets timed out by the time
3527  * it is accessed in __cfg80211_roamed() due to delay in scheduling
3528  * rdev->event_work. In case of any failures, the reference is released
3529  * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
3530  * it will be released while diconneting from the current bss.
3531  */
3532 void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
3533                          const u8 *req_ie, size_t req_ie_len,
3534                          const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
3535
3536 /**
3537  * cfg80211_disconnected - notify cfg80211 that connection was dropped
3538  *
3539  * @dev: network device
3540  * @ie: information elements of the deauth/disassoc frame (may be %NULL)
3541  * @ie_len: length of IEs
3542  * @reason: reason code for the disconnection, set it to 0 if unknown
3543  * @gfp: allocation flags
3544  *
3545  * After it calls this function, the driver should enter an idle state
3546  * and not try to connect to any AP any more.
3547  */
3548 void cfg80211_disconnected(struct net_device *dev, u16 reason,
3549                            u8 *ie, size_t ie_len, gfp_t gfp);
3550
3551 /**
3552  * cfg80211_ready_on_channel - notification of remain_on_channel start
3553  * @wdev: wireless device
3554  * @cookie: the request cookie
3555  * @chan: The current channel (from remain_on_channel request)
3556  * @duration: Duration in milliseconds that the driver intents to remain on the
3557  *      channel
3558  * @gfp: allocation flags
3559  */
3560 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
3561                                struct ieee80211_channel *chan,
3562                                unsigned int duration, gfp_t gfp);
3563
3564 /**
3565  * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
3566  * @wdev: wireless device
3567  * @cookie: the request cookie
3568  * @chan: The current channel (from remain_on_channel request)
3569  * @gfp: allocation flags
3570  */
3571 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
3572                                         struct ieee80211_channel *chan,
3573                                         gfp_t gfp);
3574
3575
3576 /**
3577  * cfg80211_new_sta - notify userspace about station
3578  *
3579  * @dev: the netdev
3580  * @mac_addr: the station's address
3581  * @sinfo: the station information
3582  * @gfp: allocation flags
3583  */
3584 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
3585                       struct station_info *sinfo, gfp_t gfp);
3586
3587 /**
3588  * cfg80211_del_sta - notify userspace about deletion of a station
3589  *
3590  * @dev: the netdev
3591  * @mac_addr: the station's address
3592  * @gfp: allocation flags
3593  */
3594 void cfg80211_del_sta(struct net_device *dev, const u8 *mac_addr, gfp_t gfp);
3595
3596 /**
3597  * cfg80211_conn_failed - connection request failed notification
3598  *
3599  * @dev: the netdev
3600  * @mac_addr: the station's address
3601  * @reason: the reason for connection failure
3602  * @gfp: allocation flags
3603  *
3604  * Whenever a station tries to connect to an AP and if the station
3605  * could not connect to the AP as the AP has rejected the connection
3606  * for some reasons, this function is called.
3607  *
3608  * The reason for connection failure can be any of the value from
3609  * nl80211_connect_failed_reason enum
3610  */
3611 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
3612                           enum nl80211_connect_failed_reason reason,
3613                           gfp_t gfp);
3614
3615 /**
3616  * cfg80211_rx_mgmt - notification of received, unprocessed management frame
3617  * @wdev: wireless device receiving the frame
3618  * @freq: Frequency on which the frame was received in MHz
3619  * @sig_dbm: signal strength in mBm, or 0 if unknown
3620  * @buf: Management frame (header + body)
3621  * @len: length of the frame data
3622  * @gfp: context flags
3623  *
3624  * This function is called whenever an Action frame is received for a station
3625  * mode interface, but is not processed in kernel.
3626  *
3627  * Return: %true if a user space application has registered for this frame.
3628  * For action frames, that makes it responsible for rejecting unrecognized
3629  * action frames; %false otherwise, in which case for action frames the
3630  * driver is responsible for rejecting the frame.
3631  */
3632 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
3633                       const u8 *buf, size_t len, gfp_t gfp);
3634
3635 /**
3636  * cfg80211_mgmt_tx_status - notification of TX status for management frame
3637  * @wdev: wireless device receiving the frame
3638  * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
3639  * @buf: Management frame (header + body)
3640  * @len: length of the frame data
3641  * @ack: Whether frame was acknowledged
3642  * @gfp: context flags
3643  *
3644  * This function is called whenever a management frame was requested to be
3645  * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
3646  * transmission attempt.
3647  */
3648 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
3649                              const u8 *buf, size_t len, bool ack, gfp_t gfp);
3650
3651
3652 /**
3653  * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
3654  * @dev: network device
3655  * @rssi_event: the triggered RSSI event
3656  * @gfp: context flags
3657  *
3658  * This function is called when a configured connection quality monitoring
3659  * rssi threshold reached event occurs.
3660  */
3661 void cfg80211_cqm_rssi_notify(struct net_device *dev,
3662                               enum nl80211_cqm_rssi_threshold_event rssi_event,
3663                               gfp_t gfp);
3664
3665 /**
3666  * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
3667  * @dev: network device
3668  * @peer: peer's MAC address
3669  * @num_packets: how many packets were lost -- should be a fixed threshold
3670  *      but probably no less than maybe 50, or maybe a throughput dependent
3671  *      threshold (to account for temporary interference)
3672  * @gfp: context flags
3673  */
3674 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
3675                                  const u8 *peer, u32 num_packets, gfp_t gfp);
3676
3677 /**
3678  * cfg80211_cqm_txe_notify - TX error rate event
3679  * @dev: network device
3680  * @peer: peer's MAC address
3681  * @num_packets: how many packets were lost
3682  * @rate: % of packets which failed transmission
3683  * @intvl: interval (in s) over which the TX failure threshold was breached.
3684  * @gfp: context flags
3685  *
3686  * Notify userspace when configured % TX failures over number of packets in a
3687  * given interval is exceeded.
3688  */
3689 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
3690                              u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
3691
3692 /**
3693  * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
3694  * @dev: network device
3695  * @bssid: BSSID of AP (to avoid races)
3696  * @replay_ctr: new replay counter
3697  * @gfp: allocation flags
3698  */
3699 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
3700                                const u8 *replay_ctr, gfp_t gfp);
3701
3702 /**
3703  * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
3704  * @dev: network device
3705  * @index: candidate index (the smaller the index, the higher the priority)
3706  * @bssid: BSSID of AP
3707  * @preauth: Whether AP advertises support for RSN pre-authentication
3708  * @gfp: allocation flags
3709  */
3710 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
3711                                      const u8 *bssid, bool preauth, gfp_t gfp);
3712
3713 /**
3714  * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
3715  * @dev: The device the frame matched to
3716  * @addr: the transmitter address
3717  * @gfp: context flags
3718  *
3719  * This function is used in AP mode (only!) to inform userspace that
3720  * a spurious class 3 frame was received, to be able to deauth the
3721  * sender.
3722  * Return: %true if the frame was passed to userspace (or this failed
3723  * for a reason other than not having a subscription.)
3724  */
3725 bool cfg80211_rx_spurious_frame(struct net_device *dev,
3726                                 const u8 *addr, gfp_t gfp);
3727
3728 /**
3729  * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
3730  * @dev: The device the frame matched to
3731  * @addr: the transmitter address
3732  * @gfp: context flags
3733  *
3734  * This function is used in AP mode (only!) to inform userspace that
3735  * an associated station sent a 4addr frame but that wasn't expected.
3736  * It is allowed and desirable to send this event only once for each
3737  * station to avoid event flooding.
3738  * Return: %true if the frame was passed to userspace (or this failed
3739  * for a reason other than not having a subscription.)
3740  */
3741 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
3742                                         const u8 *addr, gfp_t gfp);
3743
3744 /**
3745  * cfg80211_probe_status - notify userspace about probe status
3746  * @dev: the device the probe was sent on
3747  * @addr: the address of the peer
3748  * @cookie: the cookie filled in @probe_client previously
3749  * @acked: indicates whether probe was acked or not
3750  * @gfp: allocation flags
3751  */
3752 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
3753                            u64 cookie, bool acked, gfp_t gfp);
3754
3755 /**
3756  * cfg80211_report_obss_beacon - report beacon from other APs
3757  * @wiphy: The wiphy that received the beacon
3758  * @frame: the frame
3759  * @len: length of the frame
3760  * @freq: frequency the frame was received on
3761  * @sig_dbm: signal strength in mBm, or 0 if unknown
3762  *
3763  * Use this function to report to userspace when a beacon was
3764  * received. It is not useful to call this when there is no
3765  * netdev that is in AP/GO mode.
3766  */
3767 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
3768                                  const u8 *frame, size_t len,
3769                                  int freq, int sig_dbm);
3770
3771 /**
3772  * cfg80211_reg_can_beacon - check if beaconing is allowed
3773  * @wiphy: the wiphy
3774  * @chandef: the channel definition
3775  *
3776  * Return: %true if there is no secondary channel or the secondary channel(s)
3777  * can be used for beaconing (i.e. is not a radar channel etc.)
3778  */
3779 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
3780                              struct cfg80211_chan_def *chandef);
3781
3782 /*
3783  * cfg80211_ch_switch_notify - update wdev channel and notify userspace
3784  * @dev: the device which switched channels
3785  * @chandef: the new channel definition
3786  *
3787  * Acquires wdev_lock, so must only be called from sleepable driver context!
3788  */
3789 void cfg80211_ch_switch_notify(struct net_device *dev,
3790                                struct cfg80211_chan_def *chandef);
3791
3792 /*
3793  * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
3794  * @dev: the device on which the operation is requested
3795  * @peer: the MAC address of the peer device
3796  * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
3797  *      NL80211_TDLS_TEARDOWN)
3798  * @reason_code: the reason code for teardown request
3799  * @gfp: allocation flags
3800  *
3801  * This function is used to request userspace to perform TDLS operation that
3802  * requires knowledge of keys, i.e., link setup or teardown when the AP
3803  * connection uses encryption. This is optional mechanism for the driver to use
3804  * if it can automatically determine when a TDLS link could be useful (e.g.,
3805  * based on traffic and signal strength for a peer).
3806  */
3807 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
3808                                 enum nl80211_tdls_operation oper,
3809                                 u16 reason_code, gfp_t gfp);
3810
3811 /*
3812  * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
3813  * @rate: given rate_info to calculate bitrate from
3814  *
3815  * return 0 if MCS index >= 32
3816  */
3817 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
3818
3819 /**
3820  * cfg80211_unregister_wdev - remove the given wdev
3821  * @wdev: struct wireless_dev to remove
3822  *
3823  * Call this function only for wdevs that have no netdev assigned,
3824  * e.g. P2P Devices. It removes the device from the list so that
3825  * it can no longer be used. It is necessary to call this function
3826  * even when cfg80211 requests the removal of the interface by
3827  * calling the del_virtual_intf() callback. The function must also
3828  * be called when the driver wishes to unregister the wdev, e.g.
3829  * when the device is unbound from the driver.
3830  *
3831  * Requires the RTNL to be held.
3832  */
3833 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
3834
3835 /**
3836  * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
3837  * @ies: the input IE buffer
3838  * @len: the input length
3839  * @attr: the attribute ID to find
3840  * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
3841  *      if the function is only called to get the needed buffer size
3842  * @bufsize: size of the output buffer
3843  *
3844  * The function finds a given P2P attribute in the (vendor) IEs and
3845  * copies its contents to the given buffer.
3846  *
3847  * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
3848  * malformed or the attribute can't be found (respectively), or the
3849  * length of the found attribute (which can be zero).
3850  */
3851 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
3852                           enum ieee80211_p2p_attr_id attr,
3853                           u8 *buf, unsigned int bufsize);
3854
3855 /* Logging, debugging and troubleshooting/diagnostic helpers. */
3856
3857 /* wiphy_printk helpers, similar to dev_printk */
3858
3859 #define wiphy_printk(level, wiphy, format, args...)             \
3860         dev_printk(level, &(wiphy)->dev, format, ##args)
3861 #define wiphy_emerg(wiphy, format, args...)                     \
3862         dev_emerg(&(wiphy)->dev, format, ##args)
3863 #define wiphy_alert(wiphy, format, args...)                     \
3864         dev_alert(&(wiphy)->dev, format, ##args)
3865 #define wiphy_crit(wiphy, format, args...)                      \
3866         dev_crit(&(wiphy)->dev, format, ##args)
3867 #define wiphy_err(wiphy, format, args...)                       \
3868         dev_err(&(wiphy)->dev, format, ##args)
3869 #define wiphy_warn(wiphy, format, args...)                      \
3870         dev_warn(&(wiphy)->dev, format, ##args)
3871 #define wiphy_notice(wiphy, format, args...)                    \
3872         dev_notice(&(wiphy)->dev, format, ##args)
3873 #define wiphy_info(wiphy, format, args...)                      \
3874         dev_info(&(wiphy)->dev, format, ##args)
3875
3876 #define wiphy_debug(wiphy, format, args...)                     \
3877         wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
3878
3879 #define wiphy_dbg(wiphy, format, args...)                       \
3880         dev_dbg(&(wiphy)->dev, format, ##args)
3881
3882 #if defined(VERBOSE_DEBUG)
3883 #define wiphy_vdbg      wiphy_dbg
3884 #else
3885 #define wiphy_vdbg(wiphy, format, args...)                              \
3886 ({                                                                      \
3887         if (0)                                                          \
3888                 wiphy_printk(KERN_DEBUG, wiphy, format, ##args);        \
3889         0;                                                              \
3890 })
3891 #endif
3892
3893 /*
3894  * wiphy_WARN() acts like wiphy_printk(), but with the key difference
3895  * of using a WARN/WARN_ON to get the message out, including the
3896  * file/line information and a backtrace.
3897  */
3898 #define wiphy_WARN(wiphy, format, args...)                      \
3899         WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
3900
3901 #endif /* __NET_CFG80211_H */