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