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