include/net/cfg80211.h

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