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