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