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