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-2009  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  * wireless hardware capability structures
  30  */
  31
  32 /**
  33  * enum ieee80211_band - supported frequency bands
  34  *
  35  * The bands are assigned this way because the supported
  36  * bitrates differ in these bands.
  37  *
  38  * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
  39  * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
  40  */
  41 enum ieee80211_band {
  42         IEEE80211_BAND_2GHZ,
  43         IEEE80211_BAND_5GHZ,
  44
  45         /* keep last */
  46         IEEE80211_NUM_BANDS
  47 };
  48
  49 /**
  50  * enum ieee80211_channel_flags - channel flags
  51  *
  52  * Channel flags set by the regulatory control code.
  53  *
  54  * @IEEE80211_CHAN_DISABLED: This channel is disabled.
  55  * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
  56  *      on this channel.
  57  * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
  58  * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
  59  * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
  60  *      is not permitted.
  61  * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
  62  *      is not permitted.
  63  */
  64 enum ieee80211_channel_flags {
  65         IEEE80211_CHAN_DISABLED         = 1<<0,
  66         IEEE80211_CHAN_PASSIVE_SCAN     = 1<<1,
  67         IEEE80211_CHAN_NO_IBSS          = 1<<2,
  68         IEEE80211_CHAN_RADAR            = 1<<3,
  69         IEEE80211_CHAN_NO_HT40PLUS      = 1<<4,
  70         IEEE80211_CHAN_NO_HT40MINUS     = 1<<5,
  71 };
  72
  73 #define IEEE80211_CHAN_NO_HT40 \
  74         (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
  75
  76 /**
  77  * struct ieee80211_channel - channel definition
  78  *
  79  * This structure describes a single channel for use
  80  * with cfg80211.
  81  *
  82  * @center_freq: center frequency in MHz
  83  * @hw_value: hardware-specific value for the channel
  84  * @flags: channel flags from &enum ieee80211_channel_flags.
  85  * @orig_flags: channel flags at registration time, used by regulatory
  86  *      code to support devices with additional restrictions
  87  * @band: band this channel belongs to.
  88  * @max_antenna_gain: maximum antenna gain in dBi
  89  * @max_power: maximum transmission power (in dBm)
  90  * @beacon_found: helper to regulatory code to indicate when a beacon
  91  *      has been found on this channel. Use regulatory_hint_found_beacon()
  92  *      to enable this, this is is useful only on 5 GHz band.
  93  * @orig_mag: internal use
  94  * @orig_mpwr: internal use
  95  */
  96 struct ieee80211_channel {
  97         enum ieee80211_band band;
  98         u16 center_freq;
  99         u16 hw_value;
 100         u32 flags;
 101         int max_antenna_gain;
 102         int max_power;
 103         bool beacon_found;
 104         u32 orig_flags;
 105         int orig_mag, orig_mpwr;
 106 };
 107
 108 /**
 109  * enum ieee80211_rate_flags - rate flags
 110  *
 111  * Hardware/specification flags for rates. These are structured
 112  * in a way that allows using the same bitrate structure for
 113  * different bands/PHY modes.
 114  *
 115  * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
 116  *      preamble on this bitrate; only relevant in 2.4GHz band and
 117  *      with CCK rates.
 118  * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
 119  *      when used with 802.11a (on the 5 GHz band); filled by the
 120  *      core code when registering the wiphy.
 121  * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
 122  *      when used with 802.11b (on the 2.4 GHz band); filled by the
 123  *      core code when registering the wiphy.
 124  * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
 125  *      when used with 802.11g (on the 2.4 GHz band); filled by the
 126  *      core code when registering the wiphy.
 127  * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
 128  */
 129 enum ieee80211_rate_flags {
 130         IEEE80211_RATE_SHORT_PREAMBLE   = 1<<0,
 131         IEEE80211_RATE_MANDATORY_A      = 1<<1,
 132         IEEE80211_RATE_MANDATORY_B      = 1<<2,
 133         IEEE80211_RATE_MANDATORY_G      = 1<<3,
 134         IEEE80211_RATE_ERP_G            = 1<<4,
 135 };
 136
 137 /**
 138  * struct ieee80211_rate - bitrate definition
 139  *
 140  * This structure describes a bitrate that an 802.11 PHY can
 141  * operate with. The two values @hw_value and @hw_value_short
 142  * are only for driver use when pointers to this structure are
 143  * passed around.
 144  *
 145  * @flags: rate-specific flags
 146  * @bitrate: bitrate in units of 100 Kbps
 147  * @hw_value: driver/hardware value for this rate
 148  * @hw_value_short: driver/hardware value for this rate when
 149  *      short preamble is used
 150  */
 151 struct ieee80211_rate {
 152         u32 flags;
 153         u16 bitrate;
 154         u16 hw_value, hw_value_short;
 155 };
 156
 157 /**
 158  * struct ieee80211_sta_ht_cap - STA's HT capabilities
 159  *
 160  * This structure describes most essential parameters needed
 161  * to describe 802.11n HT capabilities for an STA.
 162  *
 163  * @ht_supported: is HT supported by the STA
 164  * @cap: HT capabilities map as described in 802.11n spec
 165  * @ampdu_factor: Maximum A-MPDU length factor
 166  * @ampdu_density: Minimum A-MPDU spacing
 167  * @mcs: Supported MCS rates
 168  */
 169 struct ieee80211_sta_ht_cap {
 170         u16 cap; /* use IEEE80211_HT_CAP_ */
 171         bool ht_supported;
 172         u8 ampdu_factor;
 173         u8 ampdu_density;
 174         struct ieee80211_mcs_info mcs;
 175 };
 176
 177 /**
 178  * struct ieee80211_supported_band - frequency band definition
 179  *
 180  * This structure describes a frequency band a wiphy
 181  * is able to operate in.
 182  *
 183  * @channels: Array of channels the hardware can operate in
 184  *      in this band.
 185  * @band: the band this structure represents
 186  * @n_channels: Number of channels in @channels
 187  * @bitrates: Array of bitrates the hardware can operate with
 188  *      in this band. Must be sorted to give a valid "supported
 189  *      rates" IE, i.e. CCK rates first, then OFDM.
 190  * @n_bitrates: Number of bitrates in @bitrates
 191  */
 192 struct ieee80211_supported_band {
 193         struct ieee80211_channel *channels;
 194         struct ieee80211_rate *bitrates;
 195         enum ieee80211_band band;
 196         int n_channels;
 197         int n_bitrates;
 198         struct ieee80211_sta_ht_cap ht_cap;
 199 };
 200
 201 /*
 202  * Wireless hardware/device configuration structures and methods
 203  */
 204
 205 /**
 206  * struct vif_params - describes virtual interface parameters
 207  * @mesh_id: mesh ID to use
 208  * @mesh_id_len: length of the mesh ID
 209  * @use_4addr: use 4-address frames
 210  */
 211 struct vif_params {
 212        u8 *mesh_id;
 213        int mesh_id_len;
 214        int use_4addr;
 215 };
 216
 217 /**
 218  * struct key_params - key information
 219  *
 220  * Information about a key
 221  *
 222  * @key: key material
 223  * @key_len: length of key material
 224  * @cipher: cipher suite selector
 225  * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
 226  *      with the get_key() callback, must be in little endian,
 227  *      length given by @seq_len.
 228  */
 229 struct key_params {
 230         u8 *key;
 231         u8 *seq;
 232         int key_len;
 233         int seq_len;
 234         u32 cipher;
 235 };
 236
 237 /**
 238  * enum survey_info_flags - survey information flags
 239  *
 240  * Used by the driver to indicate which info in &struct survey_info
 241  * it has filled in during the get_survey().
 242  */
 243 enum survey_info_flags {
 244         SURVEY_INFO_NOISE_DBM = 1<<0,
 245 };
 246
 247 /**
 248  * struct survey_info - channel survey response
 249  *
 250  * Used by dump_survey() to report back per-channel survey information.
 251  *
 252  * @channel: the channel this survey record reports, mandatory
 253  * @filled: bitflag of flags from &enum survey_info_flags
 254  * @noise: channel noise in dBm. This and all following fields are
 255  *     optional
 256  *
 257  * This structure can later be expanded with things like
 258  * channel duty cycle etc.
 259  */
 260 struct survey_info {
 261         struct ieee80211_channel *channel;
 262         u32 filled;
 263         s8 noise;
 264 };
 265
 266 /**
 267  * struct beacon_parameters - beacon parameters
 268  *
 269  * Used to configure the beacon for an interface.
 270  *
 271  * @head: head portion of beacon (before TIM IE)
 272  *     or %NULL if not changed
 273  * @tail: tail portion of beacon (after TIM IE)
 274  *     or %NULL if not changed
 275  * @interval: beacon interval or zero if not changed
 276  * @dtim_period: DTIM period or zero if not changed
 277  * @head_len: length of @head
 278  * @tail_len: length of @tail
 279  */
 280 struct beacon_parameters {
 281         u8 *head, *tail;
 282         int interval, dtim_period;
 283         int head_len, tail_len;
 284 };
 285
 286 /**
 287  * enum plink_action - actions to perform in mesh peers
 288  *
 289  * @PLINK_ACTION_INVALID: action 0 is reserved
 290  * @PLINK_ACTION_OPEN: start mesh peer link establishment
 291  * @PLINK_ACTION_BLOCL: block traffic from this mesh peer
 292  */
 293 enum plink_actions {
 294         PLINK_ACTION_INVALID,
 295         PLINK_ACTION_OPEN,
 296         PLINK_ACTION_BLOCK,
 297 };
 298
 299 /**
 300  * struct station_parameters - station parameters
 301  *
 302  * Used to change and create a new station.
 303  *
 304  * @vlan: vlan interface station should belong to
 305  * @supported_rates: supported rates in IEEE 802.11 format
 306  *      (or NULL for no change)
 307  * @supported_rates_len: number of supported rates
 308  * @sta_flags_mask: station flags that changed
 309  *      (bitmask of BIT(NL80211_STA_FLAG_...))
 310  * @sta_flags_set: station flags values
 311  *      (bitmask of BIT(NL80211_STA_FLAG_...))
 312  * @listen_interval: listen interval or -1 for no change
 313  * @aid: AID or zero for no change
 314  */
 315 struct station_parameters {
 316         u8 *supported_rates;
 317         struct net_device *vlan;
 318         u32 sta_flags_mask, sta_flags_set;
 319         int listen_interval;
 320         u16 aid;
 321         u8 supported_rates_len;
 322         u8 plink_action;
 323         struct ieee80211_ht_cap *ht_capa;
 324 };
 325
 326 /**
 327  * enum station_info_flags - station information flags
 328  *
 329  * Used by the driver to indicate which info in &struct station_info
 330  * it has filled in during get_station() or dump_station().
 331  *
 332  * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
 333  * @STATION_INFO_RX_BYTES: @rx_bytes filled
 334  * @STATION_INFO_TX_BYTES: @tx_bytes filled
 335  * @STATION_INFO_LLID: @llid filled
 336  * @STATION_INFO_PLID: @plid filled
 337  * @STATION_INFO_PLINK_STATE: @plink_state filled
 338  * @STATION_INFO_SIGNAL: @signal filled
 339  * @STATION_INFO_TX_BITRATE: @tx_bitrate fields are filled
 340  *  (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
 341  * @STATION_INFO_RX_PACKETS: @rx_packets filled
 342  * @STATION_INFO_TX_PACKETS: @tx_packets filled
 343  */
 344 enum station_info_flags {
 345         STATION_INFO_INACTIVE_TIME      = 1<<0,
 346         STATION_INFO_RX_BYTES           = 1<<1,
 347         STATION_INFO_TX_BYTES           = 1<<2,
 348         STATION_INFO_LLID               = 1<<3,
 349         STATION_INFO_PLID               = 1<<4,
 350         STATION_INFO_PLINK_STATE        = 1<<5,
 351         STATION_INFO_SIGNAL             = 1<<6,
 352         STATION_INFO_TX_BITRATE         = 1<<7,
 353         STATION_INFO_RX_PACKETS         = 1<<8,
 354         STATION_INFO_TX_PACKETS         = 1<<9,
 355 };
 356
 357 /**
 358  * enum station_info_rate_flags - bitrate info flags
 359  *
 360  * Used by the driver to indicate the specific rate transmission
 361  * type for 802.11n transmissions.
 362  *
 363  * @RATE_INFO_FLAGS_MCS: @tx_bitrate_mcs filled
 364  * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 Mhz width transmission
 365  * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
 366  */
 367 enum rate_info_flags {
 368         RATE_INFO_FLAGS_MCS             = 1<<0,
 369         RATE_INFO_FLAGS_40_MHZ_WIDTH    = 1<<1,
 370         RATE_INFO_FLAGS_SHORT_GI        = 1<<2,
 371 };
 372
 373 /**
 374  * struct rate_info - bitrate information
 375  *
 376  * Information about a receiving or transmitting bitrate
 377  *
 378  * @flags: bitflag of flags from &enum rate_info_flags
 379  * @mcs: mcs index if struct describes a 802.11n bitrate
 380  * @legacy: bitrate in 100kbit/s for 802.11abg
 381  */
 382 struct rate_info {
 383         u8 flags;
 384         u8 mcs;
 385         u16 legacy;
 386 };
 387
 388 /**
 389  * struct station_info - station information
 390  *
 391  * Station information filled by driver for get_station() and dump_station.
 392  *
 393  * @filled: bitflag of flags from &enum station_info_flags
 394  * @inactive_time: time since last station activity (tx/rx) in milliseconds
 395  * @rx_bytes: bytes received from this station
 396  * @tx_bytes: bytes transmitted to this station
 397  * @llid: mesh local link id
 398  * @plid: mesh peer link id
 399  * @plink_state: mesh peer link state
 400  * @signal: signal strength of last received packet in dBm
 401  * @txrate: current unicast bitrate to this station
 402  * @rx_packets: packets received from this station
 403  * @tx_packets: packets transmitted to this station
 404  * @generation: generation number for nl80211 dumps.
 405  *      This number should increase every time the list of stations
 406  *      changes, i.e. when a station is added or removed, so that
 407  *      userspace can tell whether it got a consistent snapshot.
 408  */
 409 struct station_info {
 410         u32 filled;
 411         u32 inactive_time;
 412         u32 rx_bytes;
 413         u32 tx_bytes;
 414         u16 llid;
 415         u16 plid;
 416         u8 plink_state;
 417         s8 signal;
 418         struct rate_info txrate;
 419         u32 rx_packets;
 420         u32 tx_packets;
 421
 422         int generation;
 423 };
 424
 425 /**
 426  * enum monitor_flags - monitor flags
 427  *
 428  * Monitor interface configuration flags. Note that these must be the bits
 429  * according to the nl80211 flags.
 430  *
 431  * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
 432  * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
 433  * @MONITOR_FLAG_CONTROL: pass control frames
 434  * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
 435  * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
 436  */
 437 enum monitor_flags {
 438         MONITOR_FLAG_FCSFAIL            = 1<<NL80211_MNTR_FLAG_FCSFAIL,
 439         MONITOR_FLAG_PLCPFAIL           = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
 440         MONITOR_FLAG_CONTROL            = 1<<NL80211_MNTR_FLAG_CONTROL,
 441         MONITOR_FLAG_OTHER_BSS          = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
 442         MONITOR_FLAG_COOK_FRAMES        = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
 443 };
 444
 445 /**
 446  * enum mpath_info_flags -  mesh path information flags
 447  *
 448  * Used by the driver to indicate which info in &struct mpath_info it has filled
 449  * in during get_station() or dump_station().
 450  *
 451  * MPATH_INFO_FRAME_QLEN: @frame_qlen filled
 452  * MPATH_INFO_SN: @sn filled
 453  * MPATH_INFO_METRIC: @metric filled
 454  * MPATH_INFO_EXPTIME: @exptime filled
 455  * MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
 456  * MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
 457  * MPATH_INFO_FLAGS: @flags filled
 458  */
 459 enum mpath_info_flags {
 460         MPATH_INFO_FRAME_QLEN           = BIT(0),
 461         MPATH_INFO_SN                   = BIT(1),
 462         MPATH_INFO_METRIC               = BIT(2),
 463         MPATH_INFO_EXPTIME              = BIT(3),
 464         MPATH_INFO_DISCOVERY_TIMEOUT    = BIT(4),
 465         MPATH_INFO_DISCOVERY_RETRIES    = BIT(5),
 466         MPATH_INFO_FLAGS                = BIT(6),
 467 };
 468
 469 /**
 470  * struct mpath_info - mesh path information
 471  *
 472  * Mesh path information filled by driver for get_mpath() and dump_mpath().
 473  *
 474  * @filled: bitfield of flags from &enum mpath_info_flags
 475  * @frame_qlen: number of queued frames for this destination
 476  * @sn: target sequence number
 477  * @metric: metric (cost) of this mesh path
 478  * @exptime: expiration time for the mesh path from now, in msecs
 479  * @flags: mesh path flags
 480  * @discovery_timeout: total mesh path discovery timeout, in msecs
 481  * @discovery_retries: mesh path discovery retries
 482  * @generation: generation number for nl80211 dumps.
 483  *      This number should increase every time the list of mesh paths
 484  *      changes, i.e. when a station is added or removed, so that
 485  *      userspace can tell whether it got a consistent snapshot.
 486  */
 487 struct mpath_info {
 488         u32 filled;
 489         u32 frame_qlen;
 490         u32 sn;
 491         u32 metric;
 492         u32 exptime;
 493         u32 discovery_timeout;
 494         u8 discovery_retries;
 495         u8 flags;
 496
 497         int generation;
 498 };
 499
 500 /**
 501  * struct bss_parameters - BSS parameters
 502  *
 503  * Used to change BSS parameters (mainly for AP mode).
 504  *
 505  * @use_cts_prot: Whether to use CTS protection
 506  *      (0 = no, 1 = yes, -1 = do not change)
 507  * @use_short_preamble: Whether the use of short preambles is allowed
 508  *      (0 = no, 1 = yes, -1 = do not change)
 509  * @use_short_slot_time: Whether the use of short slot time is allowed
 510  *      (0 = no, 1 = yes, -1 = do not change)
 511  * @basic_rates: basic rates in IEEE 802.11 format
 512  *      (or NULL for no change)
 513  * @basic_rates_len: number of basic rates
 514  */
 515 struct bss_parameters {
 516         int use_cts_prot;
 517         int use_short_preamble;
 518         int use_short_slot_time;
 519         u8 *basic_rates;
 520         u8 basic_rates_len;
 521 };
 522
 523 struct mesh_config {
 524         /* Timeouts in ms */
 525         /* Mesh plink management parameters */
 526         u16 dot11MeshRetryTimeout;
 527         u16 dot11MeshConfirmTimeout;
 528         u16 dot11MeshHoldingTimeout;
 529         u16 dot11MeshMaxPeerLinks;
 530         u8  dot11MeshMaxRetries;
 531         u8  dot11MeshTTL;
 532         bool auto_open_plinks;
 533         /* HWMP parameters */
 534         u8  dot11MeshHWMPmaxPREQretries;
 535         u32 path_refresh_time;
 536         u16 min_discovery_timeout;
 537         u32 dot11MeshHWMPactivePathTimeout;
 538         u16 dot11MeshHWMPpreqMinInterval;
 539         u16 dot11MeshHWMPnetDiameterTraversalTime;
 540         u8  dot11MeshHWMPRootMode;
 541 };
 542
 543 /**
 544  * struct ieee80211_txq_params - TX queue parameters
 545  * @queue: TX queue identifier (NL80211_TXQ_Q_*)
 546  * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
 547  * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
 548  *      1..32767]
 549  * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
 550  *      1..32767]
 551  * @aifs: Arbitration interframe space [0..255]
 552  */
 553 struct ieee80211_txq_params {
 554         enum nl80211_txq_q queue;
 555         u16 txop;
 556         u16 cwmin;
 557         u16 cwmax;
 558         u8 aifs;
 559 };
 560
 561 /* from net/wireless.h */
 562 struct wiphy;
 563
 564 /* from net/ieee80211.h */
 565 struct ieee80211_channel;
 566
 567 /**
 568  * struct cfg80211_ssid - SSID description
 569  * @ssid: the SSID
 570  * @ssid_len: length of the ssid
 571  */
 572 struct cfg80211_ssid {
 573         u8 ssid[IEEE80211_MAX_SSID_LEN];
 574         u8 ssid_len;
 575 };
 576
 577 /**
 578  * struct cfg80211_scan_request - scan request description
 579  *
 580  * @ssids: SSIDs to scan for (active scan only)
 581  * @n_ssids: number of SSIDs
 582  * @channels: channels to scan on.
 583  * @n_channels: total number of channels to scan
 584  * @ie: optional information element(s) to add into Probe Request or %NULL
 585  * @ie_len: length of ie in octets
 586  * @wiphy: the wiphy this was for
 587  * @dev: the interface
 588  */
 589 struct cfg80211_scan_request {
 590         struct cfg80211_ssid *ssids;
 591         int n_ssids;
 592         u32 n_channels;
 593         const u8 *ie;
 594         size_t ie_len;
 595
 596         /* internal */
 597         struct wiphy *wiphy;
 598         struct net_device *dev;
 599         bool aborted;
 600
 601         /* keep last */
 602         struct ieee80211_channel *channels[0];
 603 };
 604
 605 /**
 606  * enum cfg80211_signal_type - signal type
 607  *
 608  * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
 609  * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
 610  * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
 611  */
 612 enum cfg80211_signal_type {
 613         CFG80211_SIGNAL_TYPE_NONE,
 614         CFG80211_SIGNAL_TYPE_MBM,
 615         CFG80211_SIGNAL_TYPE_UNSPEC,
 616 };
 617
 618 /**
 619  * struct cfg80211_bss - BSS description
 620  *
 621  * This structure describes a BSS (which may also be a mesh network)
 622  * for use in scan results and similar.
 623  *
 624  * @bssid: BSSID of the BSS
 625  * @tsf: timestamp of last received update
 626  * @beacon_interval: the beacon interval as from the frame
 627  * @capability: the capability field in host byte order
 628  * @information_elements: the information elements (Note that there
 629  *      is no guarantee that these are well-formed!)
 630  * @len_information_elements: total length of the information elements
 631  * @signal: signal strength value (type depends on the wiphy's signal_type)
 632  * @free_priv: function pointer to free private data
 633  * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
 634  */
 635 struct cfg80211_bss {
 636         struct ieee80211_channel *channel;
 637
 638         u8 bssid[ETH_ALEN];
 639         u64 tsf;
 640         u16 beacon_interval;
 641         u16 capability;
 642         u8 *information_elements;
 643         size_t len_information_elements;
 644
 645         s32 signal;
 646
 647         void (*free_priv)(struct cfg80211_bss *bss);
 648         u8 priv[0] __attribute__((__aligned__(sizeof(void *))));
 649 };
 650
 651 /**
 652  * ieee80211_bss_get_ie - find IE with given ID
 653  * @bss: the bss to search
 654  * @ie: the IE ID
 655  * Returns %NULL if not found.
 656  */
 657 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
 658
 659
 660 /**
 661  * struct cfg80211_crypto_settings - Crypto settings
 662  * @wpa_versions: indicates which, if any, WPA versions are enabled
 663  *      (from enum nl80211_wpa_versions)
 664  * @cipher_group: group key cipher suite (or 0 if unset)
 665  * @n_ciphers_pairwise: number of AP supported unicast ciphers
 666  * @ciphers_pairwise: unicast key cipher suites
 667  * @n_akm_suites: number of AKM suites
 668  * @akm_suites: AKM suites
 669  * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
 670  *      sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
 671  *      required to assume that the port is unauthorized until authorized by
 672  *      user space. Otherwise, port is marked authorized by default.
 673  */
 674 struct cfg80211_crypto_settings {
 675         u32 wpa_versions;
 676         u32 cipher_group;
 677         int n_ciphers_pairwise;
 678         u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
 679         int n_akm_suites;
 680         u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
 681         bool control_port;
 682 };
 683
 684 /**
 685  * struct cfg80211_auth_request - Authentication request data
 686  *
 687  * This structure provides information needed to complete IEEE 802.11
 688  * authentication.
 689  *
 690  * @bss: The BSS to authenticate with.
 691  * @auth_type: Authentication type (algorithm)
 692  * @ie: Extra IEs to add to Authentication frame or %NULL
 693  * @ie_len: Length of ie buffer in octets
 694  * @key_len: length of WEP key for shared key authentication
 695  * @key_idx: index of WEP key for shared key authentication
 696  * @key: WEP key for shared key authentication
 697  */
 698 struct cfg80211_auth_request {
 699         struct cfg80211_bss *bss;
 700         const u8 *ie;
 701         size_t ie_len;
 702         enum nl80211_auth_type auth_type;
 703         const u8 *key;
 704         u8 key_len, key_idx;
 705 };
 706
 707 /**
 708  * struct cfg80211_assoc_request - (Re)Association request data
 709  *
 710  * This structure provides information needed to complete IEEE 802.11
 711  * (re)association.
 712  * @bss: The BSS to associate with.
 713  * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
 714  * @ie_len: Length of ie buffer in octets
 715  * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
 716  * @crypto: crypto settings
 717  * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
 718  */
 719 struct cfg80211_assoc_request {
 720         struct cfg80211_bss *bss;
 721         const u8 *ie, *prev_bssid;
 722         size_t ie_len;
 723         struct cfg80211_crypto_settings crypto;
 724         bool use_mfp;
 725 };
 726
 727 /**
 728  * struct cfg80211_deauth_request - Deauthentication request data
 729  *
 730  * This structure provides information needed to complete IEEE 802.11
 731  * deauthentication.
 732  *
 733  * @bss: the BSS to deauthenticate from
 734  * @ie: Extra IEs to add to Deauthentication frame or %NULL
 735  * @ie_len: Length of ie buffer in octets
 736  * @reason_code: The reason code for the deauthentication
 737  */
 738 struct cfg80211_deauth_request {
 739         struct cfg80211_bss *bss;
 740         const u8 *ie;
 741         size_t ie_len;
 742         u16 reason_code;
 743 };
 744
 745 /**
 746  * struct cfg80211_disassoc_request - Disassociation request data
 747  *
 748  * This structure provides information needed to complete IEEE 802.11
 749  * disassocation.
 750  *
 751  * @bss: the BSS to disassociate from
 752  * @ie: Extra IEs to add to Disassociation frame or %NULL
 753  * @ie_len: Length of ie buffer in octets
 754  * @reason_code: The reason code for the disassociation
 755  */
 756 struct cfg80211_disassoc_request {
 757         struct cfg80211_bss *bss;
 758         const u8 *ie;
 759         size_t ie_len;
 760         u16 reason_code;
 761 };
 762
 763 /**
 764  * struct cfg80211_ibss_params - IBSS parameters
 765  *
 766  * This structure defines the IBSS parameters for the join_ibss()
 767  * method.
 768  *
 769  * @ssid: The SSID, will always be non-null.
 770  * @ssid_len: The length of the SSID, will always be non-zero.
 771  * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
 772  *      search for IBSSs with a different BSSID.
 773  * @channel: The channel to use if no IBSS can be found to join.
 774  * @channel_fixed: The channel should be fixed -- do not search for
 775  *      IBSSs to join on other channels.
 776  * @ie: information element(s) to include in the beacon
 777  * @ie_len: length of that
 778  * @beacon_interval: beacon interval to use
 779  * @privacy: this is a protected network, keys will be configured
 780  *      after joining
 781  */
 782 struct cfg80211_ibss_params {
 783         u8 *ssid;
 784         u8 *bssid;
 785         struct ieee80211_channel *channel;
 786         u8 *ie;
 787         u8 ssid_len, ie_len;
 788         u16 beacon_interval;
 789         bool channel_fixed;
 790         bool privacy;
 791 };
 792
 793 /**
 794  * struct cfg80211_connect_params - Connection parameters
 795  *
 796  * This structure provides information needed to complete IEEE 802.11
 797  * authentication and association.
 798  *
 799  * @channel: The channel to use or %NULL if not specified (auto-select based
 800  *      on scan results)
 801  * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
 802  *      results)
 803  * @ssid: SSID
 804  * @ssid_len: Length of ssid in octets
 805  * @auth_type: Authentication type (algorithm)
 806  * @assoc_ie: IEs for association request
 807  * @assoc_ie_len: Length of assoc_ie in octets
 808  * @privacy: indicates whether privacy-enabled APs should be used
 809  * @crypto: crypto settings
 810  * @key_len: length of WEP key for shared key authentication
 811  * @key_idx: index of WEP key for shared key authentication
 812  * @key: WEP key for shared key authentication
 813  */
 814 struct cfg80211_connect_params {
 815         struct ieee80211_channel *channel;
 816         u8 *bssid;
 817         u8 *ssid;
 818         size_t ssid_len;
 819         enum nl80211_auth_type auth_type;
 820         u8 *ie;
 821         size_t ie_len;
 822         bool privacy;
 823         struct cfg80211_crypto_settings crypto;
 824         const u8 *key;
 825         u8 key_len, key_idx;
 826 };
 827
 828 /**
 829  * enum wiphy_params_flags - set_wiphy_params bitfield values
 830  * WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
 831  * WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
 832  * WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
 833  * WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
 834  */
 835 enum wiphy_params_flags {
 836         WIPHY_PARAM_RETRY_SHORT         = 1 << 0,
 837         WIPHY_PARAM_RETRY_LONG          = 1 << 1,
 838         WIPHY_PARAM_FRAG_THRESHOLD      = 1 << 2,
 839         WIPHY_PARAM_RTS_THRESHOLD       = 1 << 3,
 840 };
 841
 842 /**
 843  * enum tx_power_setting - TX power adjustment
 844  *
 845  * @TX_POWER_AUTOMATIC: the dbm parameter is ignored
 846  * @TX_POWER_LIMITED: limit TX power by the dbm parameter
 847  * @TX_POWER_FIXED: fix TX power to the dbm parameter
 848  */
 849 enum tx_power_setting {
 850         TX_POWER_AUTOMATIC,
 851         TX_POWER_LIMITED,
 852         TX_POWER_FIXED,
 853 };
 854
 855 /*
 856  * cfg80211_bitrate_mask - masks for bitrate control
 857  */
 858 struct cfg80211_bitrate_mask {
 859 /*
 860  * As discussed in Berlin, this struct really
 861  * should look like this:
 862
 863         struct {
 864                 u32 legacy;
 865                 u8 mcs[IEEE80211_HT_MCS_MASK_LEN];
 866         } control[IEEE80211_NUM_BANDS];
 867
 868  * Since we can always fix in-kernel users, let's keep
 869  * it simpler for now:
 870  */
 871         u32 fixed;   /* fixed bitrate, 0 == not fixed */
 872         u32 maxrate; /* in kbps, 0 == no limit */
 873 };
 874
 875 /**
 876  * struct cfg80211_ops - backend description for wireless configuration
 877  *
 878  * This struct is registered by fullmac card drivers and/or wireless stacks
 879  * in order to handle configuration requests on their interfaces.
 880  *
 881  * All callbacks except where otherwise noted should return 0
 882  * on success or a negative error code.
 883  *
 884  * All operations are currently invoked under rtnl for consistency with the
 885  * wireless extensions but this is subject to reevaluation as soon as this
 886  * code is used more widely and we have a first user without wext.
 887  *
 888  * @suspend: wiphy device needs to be suspended
 889  * @resume: wiphy device needs to be resumed
 890  *
 891  * @add_virtual_intf: create a new virtual interface with the given name,
 892  *      must set the struct wireless_dev's iftype. Beware: You must create
 893  *      the new netdev in the wiphy's network namespace!
 894  *
 895  * @del_virtual_intf: remove the virtual interface determined by ifindex.
 896  *
 897  * @change_virtual_intf: change type/configuration of virtual interface,
 898  *      keep the struct wireless_dev's iftype updated.
 899  *
 900  * @add_key: add a key with the given parameters. @mac_addr will be %NULL
 901  *      when adding a group key.
 902  *
 903  * @get_key: get information about the key with the given parameters.
 904  *      @mac_addr will be %NULL when requesting information for a group
 905  *      key. All pointers given to the @callback function need not be valid
 906  *      after it returns. This function should return an error if it is
 907  *      not possible to retrieve the key, -ENOENT if it doesn't exist.
 908  *
 909  * @del_key: remove a key given the @mac_addr (%NULL for a group key)
 910  *      and @key_index, return -ENOENT if the key doesn't exist.
 911  *
 912  * @set_default_key: set the default key on an interface
 913  *
 914  * @set_default_mgmt_key: set the default management frame key on an interface
 915  *
 916  * @add_beacon: Add a beacon with given parameters, @head, @interval
 917  *      and @dtim_period will be valid, @tail is optional.
 918  * @set_beacon: Change the beacon parameters for an access point mode
 919  *      interface. This should reject the call when no beacon has been
 920  *      configured.
 921  * @del_beacon: Remove beacon configuration and stop sending the beacon.
 922  *
 923  * @add_station: Add a new station.
 924  *
 925  * @del_station: Remove a station; @mac may be NULL to remove all stations.
 926  *
 927  * @change_station: Modify a given station.
 928  *
 929  * @get_mesh_params: Put the current mesh parameters into *params
 930  *
 931  * @set_mesh_params: Set mesh parameters.
 932  *      The mask is a bitfield which tells us which parameters to
 933  *      set, and which to leave alone.
 934  *
 935  * @set_mesh_cfg: set mesh parameters (by now, just mesh id)
 936  *
 937  * @change_bss: Modify parameters for a given BSS.
 938  *
 939  * @set_txq_params: Set TX queue parameters
 940  *
 941  * @set_channel: Set channel
 942  *
 943  * @scan: Request to do a scan. If returning zero, the scan request is given
 944  *      the driver, and will be valid until passed to cfg80211_scan_done().
 945  *      For scan results, call cfg80211_inform_bss(); you can call this outside
 946  *      the scan/scan_done bracket too.
 947  *
 948  * @auth: Request to authenticate with the specified peer
 949  * @assoc: Request to (re)associate with the specified peer
 950  * @deauth: Request to deauthenticate from the specified peer
 951  * @disassoc: Request to disassociate from the specified peer
 952  *
 953  * @connect: Connect to the ESS with the specified parameters. When connected,
 954  *      call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
 955  *      If the connection fails for some reason, call cfg80211_connect_result()
 956  *      with the status from the AP.
 957  * @disconnect: Disconnect from the BSS/ESS.
 958  *
 959  * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
 960  *      cfg80211_ibss_joined(), also call that function when changing BSSID due
 961  *      to a merge.
 962  * @leave_ibss: Leave the IBSS.
 963  *
 964  * @set_wiphy_params: Notify that wiphy parameters have changed;
 965  *      @changed bitfield (see &enum wiphy_params_flags) describes which values
 966  *      have changed. The actual parameter values are available in
 967  *      struct wiphy. If returning an error, no value should be changed.
 968  *
 969  * @set_tx_power: set the transmit power according to the parameters
 970  * @get_tx_power: store the current TX power into the dbm variable;
 971  *      return 0 if successful
 972  *
 973  * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
 974  *      functions to adjust rfkill hw state
 975  *
 976  * @dump_survey: get site survey information.
 977  *
 978  * @testmode_cmd: run a test mode command
 979  */
 980 struct cfg80211_ops {
 981         int     (*suspend)(struct wiphy *wiphy);
 982         int     (*resume)(struct wiphy *wiphy);
 983
 984         int     (*add_virtual_intf)(struct wiphy *wiphy, char *name,
 985                                     enum nl80211_iftype type, u32 *flags,
 986                                     struct vif_params *params);
 987         int     (*del_virtual_intf)(struct wiphy *wiphy, struct net_device *dev);
 988         int     (*change_virtual_intf)(struct wiphy *wiphy,
 989                                        struct net_device *dev,
 990                                        enum nl80211_iftype type, u32 *flags,
 991                                        struct vif_params *params);
 992
 993         int     (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
 994                            u8 key_index, const u8 *mac_addr,
 995                            struct key_params *params);
 996         int     (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
 997                            u8 key_index, const u8 *mac_addr, void *cookie,
 998                            void (*callback)(void *cookie, struct key_params*));
 999         int     (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
1000                            u8 key_index, const u8 *mac_addr);
1001         int     (*set_default_key)(struct wiphy *wiphy,
1002                                    struct net_device *netdev,
1003                                    u8 key_index);
1004         int     (*set_default_mgmt_key)(struct wiphy *wiphy,
1005                                         struct net_device *netdev,
1006                                         u8 key_index);
1007
1008         int     (*add_beacon)(struct wiphy *wiphy, struct net_device *dev,
1009                               struct beacon_parameters *info);
1010         int     (*set_beacon)(struct wiphy *wiphy, struct net_device *dev,
1011                               struct beacon_parameters *info);
1012         int     (*del_beacon)(struct wiphy *wiphy, struct net_device *dev);
1013
1014
1015         int     (*add_station)(struct wiphy *wiphy, struct net_device *dev,
1016                                u8 *mac, struct station_parameters *params);
1017         int     (*del_station)(struct wiphy *wiphy, struct net_device *dev,
1018                                u8 *mac);
1019         int     (*change_station)(struct wiphy *wiphy, struct net_device *dev,
1020                                   u8 *mac, struct station_parameters *params);
1021         int     (*get_station)(struct wiphy *wiphy, struct net_device *dev,
1022                                u8 *mac, struct station_info *sinfo);
1023         int     (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
1024                                int idx, u8 *mac, struct station_info *sinfo);
1025
1026         int     (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
1027                                u8 *dst, u8 *next_hop);
1028         int     (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
1029                                u8 *dst);
1030         int     (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
1031                                   u8 *dst, u8 *next_hop);
1032         int     (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
1033                                u8 *dst, u8 *next_hop,
1034                                struct mpath_info *pinfo);
1035         int     (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
1036                                int idx, u8 *dst, u8 *next_hop,
1037                                struct mpath_info *pinfo);
1038         int     (*get_mesh_params)(struct wiphy *wiphy,
1039                                 struct net_device *dev,
1040                                 struct mesh_config *conf);
1041         int     (*set_mesh_params)(struct wiphy *wiphy,
1042                                 struct net_device *dev,
1043                                 const struct mesh_config *nconf, u32 mask);
1044         int     (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
1045                               struct bss_parameters *params);
1046
1047         int     (*set_txq_params)(struct wiphy *wiphy,
1048                                   struct ieee80211_txq_params *params);
1049
1050         int     (*set_channel)(struct wiphy *wiphy,
1051                                struct ieee80211_channel *chan,
1052                                enum nl80211_channel_type channel_type);
1053
1054         int     (*scan)(struct wiphy *wiphy, struct net_device *dev,
1055                         struct cfg80211_scan_request *request);
1056
1057         int     (*auth)(struct wiphy *wiphy, struct net_device *dev,
1058                         struct cfg80211_auth_request *req);
1059         int     (*assoc)(struct wiphy *wiphy, struct net_device *dev,
1060                          struct cfg80211_assoc_request *req);
1061         int     (*deauth)(struct wiphy *wiphy, struct net_device *dev,
1062                           struct cfg80211_deauth_request *req,
1063                           void *cookie);
1064         int     (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
1065                             struct cfg80211_disassoc_request *req,
1066                             void *cookie);
1067
1068         int     (*connect)(struct wiphy *wiphy, struct net_device *dev,
1069                            struct cfg80211_connect_params *sme);
1070         int     (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
1071                               u16 reason_code);
1072
1073         int     (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
1074                              struct cfg80211_ibss_params *params);
1075         int     (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
1076
1077         int     (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
1078
1079         int     (*set_tx_power)(struct wiphy *wiphy,
1080                                 enum tx_power_setting type, int dbm);
1081         int     (*get_tx_power)(struct wiphy *wiphy, int *dbm);
1082
1083         int     (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
1084                                 u8 *addr);
1085
1086         void    (*rfkill_poll)(struct wiphy *wiphy);
1087
1088 #ifdef CONFIG_NL80211_TESTMODE
1089         int     (*testmode_cmd)(struct wiphy *wiphy, void *data, int len);
1090 #endif
1091
1092         int     (*set_bitrate_mask)(struct wiphy *wiphy,
1093                                     struct net_device *dev,
1094                                     const u8 *peer,
1095                                     const struct cfg80211_bitrate_mask *mask);
1096
1097         int     (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
1098                         int idx, struct survey_info *info);
1099
1100         /* some temporary stuff to finish wext */
1101         int     (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
1102                                   bool enabled, int timeout);
1103 };
1104
1105 /*
1106  * wireless hardware and networking interfaces structures
1107  * and registration/helper functions
1108  */
1109
1110 /**
1111  * enum wiphy_flags - wiphy capability flags
1112  *
1113  * @WIPHY_FLAG_CUSTOM_REGULATORY:  tells us the driver for this device
1114  *      has its own custom regulatory domain and cannot identify the
1115  *      ISO / IEC 3166 alpha2 it belongs to. When this is enabled
1116  *      we will disregard the first regulatory hint (when the
1117  *      initiator is %REGDOM_SET_BY_CORE).
1118  * @WIPHY_FLAG_STRICT_REGULATORY: tells us the driver for this device will
1119  *      ignore regulatory domain settings until it gets its own regulatory
1120  *      domain via its regulatory_hint(). After its gets its own regulatory
1121  *      domain it will only allow further regulatory domain settings to
1122  *      further enhance compliance. For example if channel 13 and 14 are
1123  *      disabled by this regulatory domain no user regulatory domain can
1124  *      enable these channels at a later time. This can be used for devices
1125  *      which do not have calibration information gauranteed for frequencies
1126  *      or settings outside of its regulatory domain.
1127  * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure
1128  *      that passive scan flags and beaconing flags may not be lifted by
1129  *      cfg80211 due to regulatory beacon hints. For more information on beacon
1130  *      hints read the documenation for regulatory_hint_found_beacon()
1131  * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
1132  *      wiphy at all
1133  * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
1134  *      by default -- this flag will be set depending on the kernel's default
1135  *      on wiphy_new(), but can be changed by the driver if it has a good
1136  *      reason to override the default
1137  * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
1138  *      on a VLAN interface)
1139  * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
1140  */
1141 enum wiphy_flags {
1142         WIPHY_FLAG_CUSTOM_REGULATORY    = BIT(0),
1143         WIPHY_FLAG_STRICT_REGULATORY    = BIT(1),
1144         WIPHY_FLAG_DISABLE_BEACON_HINTS = BIT(2),
1145         WIPHY_FLAG_NETNS_OK             = BIT(3),
1146         WIPHY_FLAG_PS_ON_BY_DEFAULT     = BIT(4),
1147         WIPHY_FLAG_4ADDR_AP             = BIT(5),
1148         WIPHY_FLAG_4ADDR_STATION        = BIT(6),
1149 };
1150
1151 /**
1152  * struct wiphy - wireless hardware description
1153  * @idx: the wiphy index assigned to this item
1154  * @class_dev: the class device representing /sys/class/ieee80211/<wiphy-name>
1155  * @reg_notifier: the driver's regulatory notification callback
1156  * @regd: the driver's regulatory domain, if one was requested via
1157  *      the regulatory_hint() API. This can be used by the driver
1158  *      on the reg_notifier() if it chooses to ignore future
1159  *      regulatory domain changes caused by other drivers.
1160  * @signal_type: signal type reported in &struct cfg80211_bss.
1161  * @cipher_suites: supported cipher suites
1162  * @n_cipher_suites: number of supported cipher suites
1163  * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
1164  * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
1165  * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
1166  *      -1 = fragmentation disabled, only odd values >= 256 used
1167  * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
1168  * @net: the network namespace this wiphy currently lives in
1169  */
1170 struct wiphy {
1171         /* assign these fields before you register the wiphy */
1172
1173         /* permanent MAC address */
1174         u8 perm_addr[ETH_ALEN];
1175
1176         /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
1177         u16 interface_modes;
1178
1179         u32 flags;
1180
1181         enum cfg80211_signal_type signal_type;
1182
1183         int bss_priv_size;
1184         u8 max_scan_ssids;
1185         u16 max_scan_ie_len;
1186
1187         int n_cipher_suites;
1188         const u32 *cipher_suites;
1189
1190         u8 retry_short;
1191         u8 retry_long;
1192         u32 frag_threshold;
1193         u32 rts_threshold;
1194
1195         char fw_version[ETHTOOL_BUSINFO_LEN];
1196         u32 hw_version;
1197
1198         /* If multiple wiphys are registered and you're handed e.g.
1199          * a regular netdev with assigned ieee80211_ptr, you won't
1200          * know whether it points to a wiphy your driver has registered
1201          * or not. Assign this to something global to your driver to
1202          * help determine whether you own this wiphy or not. */
1203         const void *privid;
1204
1205         struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
1206
1207         /* Lets us get back the wiphy on the callback */
1208         int (*reg_notifier)(struct wiphy *wiphy,
1209                             struct regulatory_request *request);
1210
1211         /* fields below are read-only, assigned by cfg80211 */
1212
1213         const struct ieee80211_regdomain *regd;
1214
1215         /* the item in /sys/class/ieee80211/ points to this,
1216          * you need use set_wiphy_dev() (see below) */
1217         struct device dev;
1218
1219         /* dir in debugfs: ieee80211/<wiphyname> */
1220         struct dentry *debugfsdir;
1221
1222 #ifdef CONFIG_NET_NS
1223         /* the network namespace this phy lives in currently */
1224         struct net *_net;
1225 #endif
1226
1227 #ifdef CONFIG_CFG80211_WEXT
1228         const struct iw_handler_def *wext;
1229 #endif
1230
1231         char priv[0] __attribute__((__aligned__(NETDEV_ALIGN)));
1232 };
1233
1234 #ifdef CONFIG_NET_NS
1235 static inline struct net *wiphy_net(struct wiphy *wiphy)
1236 {
1237         return wiphy->_net;
1238 }
1239
1240 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
1241 {
1242         wiphy->_net = net;
1243 }
1244 #else
1245 static inline struct net *wiphy_net(struct wiphy *wiphy)
1246 {
1247         return &init_net;
1248 }
1249
1250 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
1251 {
1252 }
1253 #endif
1254
1255 /**
1256  * wiphy_priv - return priv from wiphy
1257  *
1258  * @wiphy: the wiphy whose priv pointer to return
1259  */
1260 static inline void *wiphy_priv(struct wiphy *wiphy)
1261 {
1262         BUG_ON(!wiphy);
1263         return &wiphy->priv;
1264 }
1265
1266 /**
1267  * priv_to_wiphy - return the wiphy containing the priv
1268  *
1269  * @priv: a pointer previously returned by wiphy_priv
1270  */
1271 static inline struct wiphy *priv_to_wiphy(void *priv)
1272 {
1273         BUG_ON(!priv);
1274         return container_of(priv, struct wiphy, priv);
1275 }
1276
1277 /**
1278  * set_wiphy_dev - set device pointer for wiphy
1279  *
1280  * @wiphy: The wiphy whose device to bind
1281  * @dev: The device to parent it to
1282  */
1283 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
1284 {
1285         wiphy->dev.parent = dev;
1286 }
1287
1288 /**
1289  * wiphy_dev - get wiphy dev pointer
1290  *
1291  * @wiphy: The wiphy whose device struct to look up
1292  */
1293 static inline struct device *wiphy_dev(struct wiphy *wiphy)
1294 {
1295         return wiphy->dev.parent;
1296 }
1297
1298 /**
1299  * wiphy_name - get wiphy name
1300  *
1301  * @wiphy: The wiphy whose name to return
1302  */
1303 static inline const char *wiphy_name(struct wiphy *wiphy)
1304 {
1305         return dev_name(&wiphy->dev);
1306 }
1307
1308 /**
1309  * wiphy_new - create a new wiphy for use with cfg80211
1310  *
1311  * @ops: The configuration operations for this device
1312  * @sizeof_priv: The size of the private area to allocate
1313  *
1314  * Create a new wiphy and associate the given operations with it.
1315  * @sizeof_priv bytes are allocated for private use.
1316  *
1317  * The returned pointer must be assigned to each netdev's
1318  * ieee80211_ptr for proper operation.
1319  */
1320 struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
1321
1322 /**
1323  * wiphy_register - register a wiphy with cfg80211
1324  *
1325  * @wiphy: The wiphy to register.
1326  *
1327  * Returns a non-negative wiphy index or a negative error code.
1328  */
1329 extern int wiphy_register(struct wiphy *wiphy);
1330
1331 /**
1332  * wiphy_unregister - deregister a wiphy from cfg80211
1333  *
1334  * @wiphy: The wiphy to unregister.
1335  *
1336  * After this call, no more requests can be made with this priv
1337  * pointer, but the call may sleep to wait for an outstanding
1338  * request that is being handled.
1339  */
1340 extern void wiphy_unregister(struct wiphy *wiphy);
1341
1342 /**
1343  * wiphy_free - free wiphy
1344  *
1345  * @wiphy: The wiphy to free
1346  */
1347 extern void wiphy_free(struct wiphy *wiphy);
1348
1349 /* internal structs */
1350 struct cfg80211_conn;
1351 struct cfg80211_internal_bss;
1352 struct cfg80211_cached_keys;
1353
1354 #define MAX_AUTH_BSSES          4
1355
1356 /**
1357  * struct wireless_dev - wireless per-netdev state
1358  *
1359  * This structure must be allocated by the driver/stack
1360  * that uses the ieee80211_ptr field in struct net_device
1361  * (this is intentional so it can be allocated along with
1362  * the netdev.)
1363  *
1364  * @wiphy: pointer to hardware description
1365  * @iftype: interface type
1366  * @list: (private) Used to collect the interfaces
1367  * @netdev: (private) Used to reference back to the netdev
1368  * @current_bss: (private) Used by the internal configuration code
1369  * @bssid: (private) Used by the internal configuration code
1370  * @ssid: (private) Used by the internal configuration code
1371  * @ssid_len: (private) Used by the internal configuration code
1372  * @wext: (private) Used by the internal wireless extensions compat code
1373  * @wext_bssid: (private) Used by the internal wireless extensions compat code
1374  * @use_4addr: indicates 4addr mode is used on this interface, must be
1375  *      set by driver (if supported) on add_interface BEFORE registering the
1376  *      netdev and may otherwise be used by driver read-only, will be update
1377  *      by cfg80211 on change_interface
1378  */
1379 struct wireless_dev {
1380         struct wiphy *wiphy;
1381         enum nl80211_iftype iftype;
1382
1383         /* the remainder of this struct should be private to cfg80211 */
1384         struct list_head list;
1385         struct net_device *netdev;
1386
1387         struct mutex mtx;
1388
1389         struct work_struct cleanup_work;
1390
1391         bool use_4addr;
1392
1393         /* currently used for IBSS and SME - might be rearranged later */
1394         u8 ssid[IEEE80211_MAX_SSID_LEN];
1395         u8 ssid_len;
1396         enum {
1397                 CFG80211_SME_IDLE,
1398                 CFG80211_SME_CONNECTING,
1399                 CFG80211_SME_CONNECTED,
1400         } sme_state;
1401         struct cfg80211_conn *conn;
1402         struct cfg80211_cached_keys *connect_keys;
1403
1404         struct list_head event_list;
1405         spinlock_t event_lock;
1406
1407         struct cfg80211_internal_bss *authtry_bsses[MAX_AUTH_BSSES];
1408         struct cfg80211_internal_bss *auth_bsses[MAX_AUTH_BSSES];
1409         struct cfg80211_internal_bss *current_bss; /* associated / joined */
1410
1411 #ifdef CONFIG_CFG80211_WEXT
1412         /* wext data */
1413         struct {
1414                 struct cfg80211_ibss_params ibss;
1415                 struct cfg80211_connect_params connect;
1416                 struct cfg80211_cached_keys *keys;
1417                 u8 *ie;
1418                 size_t ie_len;
1419                 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
1420                 u8 ssid[IEEE80211_MAX_SSID_LEN];
1421                 s8 default_key, default_mgmt_key;
1422                 bool ps, prev_bssid_valid;
1423                 int ps_timeout;
1424         } wext;
1425 #endif
1426 };
1427
1428 /**
1429  * wdev_priv - return wiphy priv from wireless_dev
1430  *
1431  * @wdev: The wireless device whose wiphy's priv pointer to return
1432  */
1433 static inline void *wdev_priv(struct wireless_dev *wdev)
1434 {
1435         BUG_ON(!wdev);
1436         return wiphy_priv(wdev->wiphy);
1437 }
1438
1439 /*
1440  * Utility functions
1441  */
1442
1443 /**
1444  * ieee80211_channel_to_frequency - convert channel number to frequency
1445  */
1446 extern int ieee80211_channel_to_frequency(int chan);
1447
1448 /**
1449  * ieee80211_frequency_to_channel - convert frequency to channel number
1450  */
1451 extern int ieee80211_frequency_to_channel(int freq);
1452
1453 /*
1454  * Name indirection necessary because the ieee80211 code also has
1455  * a function named "ieee80211_get_channel", so if you include
1456  * cfg80211's header file you get cfg80211's version, if you try
1457  * to include both header files you'll (rightfully!) get a symbol
1458  * clash.
1459  */
1460 extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
1461                                                          int freq);
1462 /**
1463  * ieee80211_get_channel - get channel struct from wiphy for specified frequency
1464  */
1465 static inline struct ieee80211_channel *
1466 ieee80211_get_channel(struct wiphy *wiphy, int freq)
1467 {
1468         return __ieee80211_get_channel(wiphy, freq);
1469 }
1470
1471 /**
1472  * ieee80211_get_response_rate - get basic rate for a given rate
1473  *
1474  * @sband: the band to look for rates in
1475  * @basic_rates: bitmap of basic rates
1476  * @bitrate: the bitrate for which to find the basic rate
1477  *
1478  * This function returns the basic rate corresponding to a given
1479  * bitrate, that is the next lower bitrate contained in the basic
1480  * rate map, which is, for this function, given as a bitmap of
1481  * indices of rates in the band's bitrate table.
1482  */
1483 struct ieee80211_rate *
1484 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
1485                             u32 basic_rates, int bitrate);
1486
1487 /*
1488  * Radiotap parsing functions -- for controlled injection support
1489  *
1490  * Implemented in net/wireless/radiotap.c
1491  * Documentation in Documentation/networking/radiotap-headers.txt
1492  */
1493
1494 /**
1495  * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
1496  * @rtheader: pointer to the radiotap header we are walking through
1497  * @max_length: length of radiotap header in cpu byte ordering
1498  * @this_arg_index: IEEE80211_RADIOTAP_... index of current arg
1499  * @this_arg: pointer to current radiotap arg
1500  * @arg_index: internal next argument index
1501  * @arg: internal next argument pointer
1502  * @next_bitmap: internal pointer to next present u32
1503  * @bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
1504  */
1505
1506 struct ieee80211_radiotap_iterator {
1507         struct ieee80211_radiotap_header *rtheader;
1508         int max_length;
1509         int this_arg_index;
1510         u8 *this_arg;
1511
1512         int arg_index;
1513         u8 *arg;
1514         __le32 *next_bitmap;
1515         u32 bitmap_shifter;
1516 };
1517
1518 extern int ieee80211_radiotap_iterator_init(
1519    struct ieee80211_radiotap_iterator *iterator,
1520    struct ieee80211_radiotap_header *radiotap_header,
1521    int max_length);
1522
1523 extern int ieee80211_radiotap_iterator_next(
1524    struct ieee80211_radiotap_iterator *iterator);
1525
1526 extern const unsigned char rfc1042_header[6];
1527 extern const unsigned char bridge_tunnel_header[6];
1528
1529 /**
1530  * ieee80211_get_hdrlen_from_skb - get header length from data
1531  *
1532  * Given an skb with a raw 802.11 header at the data pointer this function
1533  * returns the 802.11 header length in bytes (not including encryption
1534  * headers). If the data in the sk_buff is too short to contain a valid 802.11
1535  * header the function returns 0.
1536  *
1537  * @skb: the frame
1538  */
1539 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1540
1541 /**
1542  * ieee80211_hdrlen - get header length in bytes from frame control
1543  * @fc: frame control field in little-endian format
1544  */
1545 unsigned int ieee80211_hdrlen(__le16 fc);
1546
1547 /**
1548  * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
1549  * @skb: the 802.11 data frame
1550  * @addr: the device MAC address
1551  * @iftype: the virtual interface type
1552  */
1553 int ieee80211_data_to_8023(struct sk_buff *skb, u8 *addr,
1554                            enum nl80211_iftype iftype);
1555
1556 /**
1557  * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
1558  * @skb: the 802.3 frame
1559  * @addr: the device MAC address
1560  * @iftype: the virtual interface type
1561  * @bssid: the network bssid (used only for iftype STATION and ADHOC)
1562  * @qos: build 802.11 QoS data frame
1563  */
1564 int ieee80211_data_from_8023(struct sk_buff *skb, u8 *addr,
1565                              enum nl80211_iftype iftype, u8 *bssid, bool qos);
1566
1567 /**
1568  * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
1569  * @skb: the data frame
1570  */
1571 unsigned int cfg80211_classify8021d(struct sk_buff *skb);
1572
1573 /*
1574  * Regulatory helper functions for wiphys
1575  */
1576
1577 /**
1578  * regulatory_hint - driver hint to the wireless core a regulatory domain
1579  * @wiphy: the wireless device giving the hint (used only for reporting
1580  *      conflicts)
1581  * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
1582  *      should be in. If @rd is set this should be NULL. Note that if you
1583  *      set this to NULL you should still set rd->alpha2 to some accepted
1584  *      alpha2.
1585  *
1586  * Wireless drivers can use this function to hint to the wireless core
1587  * what it believes should be the current regulatory domain by
1588  * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
1589  * domain should be in or by providing a completely build regulatory domain.
1590  * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
1591  * for a regulatory domain structure for the respective country.
1592  *
1593  * The wiphy must have been registered to cfg80211 prior to this call.
1594  * For cfg80211 drivers this means you must first use wiphy_register(),
1595  * for mac80211 drivers you must first use ieee80211_register_hw().
1596  *
1597  * Drivers should check the return value, its possible you can get
1598  * an -ENOMEM.
1599  */
1600 extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
1601
1602 /**
1603  * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
1604  * @wiphy: the wireless device we want to process the regulatory domain on
1605  * @regd: the custom regulatory domain to use for this wiphy
1606  *
1607  * Drivers can sometimes have custom regulatory domains which do not apply
1608  * to a specific country. Drivers can use this to apply such custom regulatory
1609  * domains. This routine must be called prior to wiphy registration. The
1610  * custom regulatory domain will be trusted completely and as such previous
1611  * default channel settings will be disregarded. If no rule is found for a
1612  * channel on the regulatory domain the channel will be disabled.
1613  */
1614 extern void wiphy_apply_custom_regulatory(
1615         struct wiphy *wiphy,
1616         const struct ieee80211_regdomain *regd);
1617
1618 /**
1619  * freq_reg_info - get regulatory information for the given frequency
1620  * @wiphy: the wiphy for which we want to process this rule for
1621  * @center_freq: Frequency in KHz for which we want regulatory information for
1622  * @desired_bw_khz: the desired max bandwidth you want to use per
1623  *      channel. Note that this is still 20 MHz if you want to use HT40
1624  *      as HT40 makes use of two channels for its 40 MHz width bandwidth.
1625  *      If set to 0 we'll assume you want the standard 20 MHz.
1626  * @reg_rule: the regulatory rule which we have for this frequency
1627  *
1628  * Use this function to get the regulatory rule for a specific frequency on
1629  * a given wireless device. If the device has a specific regulatory domain
1630  * it wants to follow we respect that unless a country IE has been received
1631  * and processed already.
1632  *
1633  * Returns 0 if it was able to find a valid regulatory rule which does
1634  * apply to the given center_freq otherwise it returns non-zero. It will
1635  * also return -ERANGE if we determine the given center_freq does not even have
1636  * a regulatory rule for a frequency range in the center_freq's band. See
1637  * freq_in_rule_band() for our current definition of a band -- this is purely
1638  * subjective and right now its 802.11 specific.
1639  */
1640 extern int freq_reg_info(struct wiphy *wiphy,
1641                          u32 center_freq,
1642                          u32 desired_bw_khz,
1643                          const struct ieee80211_reg_rule **reg_rule);
1644
1645 /*
1646  * Temporary wext handlers & helper functions
1647  *
1648  * In the future cfg80211 will simply assign the entire wext handler
1649  * structure to netdevs it manages, but we're not there yet.
1650  */
1651 int cfg80211_wext_giwname(struct net_device *dev,
1652                           struct iw_request_info *info,
1653                           char *name, char *extra);
1654 int cfg80211_wext_siwmode(struct net_device *dev, struct iw_request_info *info,
1655                           u32 *mode, char *extra);
1656 int cfg80211_wext_giwmode(struct net_device *dev, struct iw_request_info *info,
1657                           u32 *mode, char *extra);
1658 int cfg80211_wext_siwscan(struct net_device *dev,
1659                           struct iw_request_info *info,
1660                           union iwreq_data *wrqu, char *extra);
1661 int cfg80211_wext_giwscan(struct net_device *dev,
1662                           struct iw_request_info *info,
1663                           struct iw_point *data, char *extra);
1664 int cfg80211_wext_siwmlme(struct net_device *dev,
1665                           struct iw_request_info *info,
1666                           struct iw_point *data, char *extra);
1667 int cfg80211_wext_giwrange(struct net_device *dev,
1668                            struct iw_request_info *info,
1669                            struct iw_point *data, char *extra);
1670 int cfg80211_wext_siwgenie(struct net_device *dev,
1671                            struct iw_request_info *info,
1672                            struct iw_point *data, char *extra);
1673 int cfg80211_wext_siwauth(struct net_device *dev,
1674                           struct iw_request_info *info,
1675                           struct iw_param *data, char *extra);
1676 int cfg80211_wext_giwauth(struct net_device *dev,
1677                           struct iw_request_info *info,
1678                           struct iw_param *data, char *extra);
1679
1680 int cfg80211_wext_siwfreq(struct net_device *dev,
1681                           struct iw_request_info *info,
1682                           struct iw_freq *freq, char *extra);
1683 int cfg80211_wext_giwfreq(struct net_device *dev,
1684                           struct iw_request_info *info,
1685                           struct iw_freq *freq, char *extra);
1686 int cfg80211_wext_siwessid(struct net_device *dev,
1687                            struct iw_request_info *info,
1688                            struct iw_point *data, char *ssid);
1689 int cfg80211_wext_giwessid(struct net_device *dev,
1690                            struct iw_request_info *info,
1691                            struct iw_point *data, char *ssid);
1692 int cfg80211_wext_siwrate(struct net_device *dev,
1693                           struct iw_request_info *info,
1694                           struct iw_param *rate, char *extra);
1695 int cfg80211_wext_giwrate(struct net_device *dev,
1696                           struct iw_request_info *info,
1697                           struct iw_param *rate, char *extra);
1698
1699 int cfg80211_wext_siwrts(struct net_device *dev,
1700                          struct iw_request_info *info,
1701                          struct iw_param *rts, char *extra);
1702 int cfg80211_wext_giwrts(struct net_device *dev,
1703                          struct iw_request_info *info,
1704                          struct iw_param *rts, char *extra);
1705 int cfg80211_wext_siwfrag(struct net_device *dev,
1706                           struct iw_request_info *info,
1707                           struct iw_param *frag, char *extra);
1708 int cfg80211_wext_giwfrag(struct net_device *dev,
1709                           struct iw_request_info *info,
1710                           struct iw_param *frag, char *extra);
1711 int cfg80211_wext_siwretry(struct net_device *dev,
1712                            struct iw_request_info *info,
1713                            struct iw_param *retry, char *extra);
1714 int cfg80211_wext_giwretry(struct net_device *dev,
1715                            struct iw_request_info *info,
1716                            struct iw_param *retry, char *extra);
1717 int cfg80211_wext_siwencodeext(struct net_device *dev,
1718                                struct iw_request_info *info,
1719                                struct iw_point *erq, char *extra);
1720 int cfg80211_wext_siwencode(struct net_device *dev,
1721                             struct iw_request_info *info,
1722                             struct iw_point *erq, char *keybuf);
1723 int cfg80211_wext_giwencode(struct net_device *dev,
1724                             struct iw_request_info *info,
1725                             struct iw_point *erq, char *keybuf);
1726 int cfg80211_wext_siwtxpower(struct net_device *dev,
1727                              struct iw_request_info *info,
1728                              union iwreq_data *data, char *keybuf);
1729 int cfg80211_wext_giwtxpower(struct net_device *dev,
1730                              struct iw_request_info *info,
1731                              union iwreq_data *data, char *keybuf);
1732 struct iw_statistics *cfg80211_wireless_stats(struct net_device *dev);
1733
1734 int cfg80211_wext_siwpower(struct net_device *dev,
1735                            struct iw_request_info *info,
1736                            struct iw_param *wrq, char *extra);
1737 int cfg80211_wext_giwpower(struct net_device *dev,
1738                            struct iw_request_info *info,
1739                            struct iw_param *wrq, char *extra);
1740
1741 int cfg80211_wext_siwap(struct net_device *dev,
1742                         struct iw_request_info *info,
1743                         struct sockaddr *ap_addr, char *extra);
1744 int cfg80211_wext_giwap(struct net_device *dev,
1745                         struct iw_request_info *info,
1746                         struct sockaddr *ap_addr, char *extra);
1747
1748 /*
1749  * callbacks for asynchronous cfg80211 methods, notification
1750  * functions and BSS handling helpers
1751  */
1752
1753 /**
1754  * cfg80211_scan_done - notify that scan finished
1755  *
1756  * @request: the corresponding scan request
1757  * @aborted: set to true if the scan was aborted for any reason,
1758  *      userspace will be notified of that
1759  */
1760 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
1761
1762 /**
1763  * cfg80211_inform_bss - inform cfg80211 of a new BSS
1764  *
1765  * @wiphy: the wiphy reporting the BSS
1766  * @bss: the found BSS
1767  * @signal: the signal strength, type depends on the wiphy's signal_type
1768  * @gfp: context flags
1769  *
1770  * This informs cfg80211 that BSS information was found and
1771  * the BSS should be updated/added.
1772  */
1773 struct cfg80211_bss*
1774 cfg80211_inform_bss_frame(struct wiphy *wiphy,
1775                           struct ieee80211_channel *channel,
1776                           struct ieee80211_mgmt *mgmt, size_t len,
1777                           s32 signal, gfp_t gfp);
1778
1779 struct cfg80211_bss*
1780 cfg80211_inform_bss(struct wiphy *wiphy,
1781                     struct ieee80211_channel *channel,
1782                     const u8 *bssid,
1783                     u64 timestamp, u16 capability, u16 beacon_interval,
1784                     const u8 *ie, size_t ielen,
1785                     s32 signal, gfp_t gfp);
1786
1787 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
1788                                       struct ieee80211_channel *channel,
1789                                       const u8 *bssid,
1790                                       const u8 *ssid, size_t ssid_len,
1791                                       u16 capa_mask, u16 capa_val);
1792 static inline struct cfg80211_bss *
1793 cfg80211_get_ibss(struct wiphy *wiphy,
1794                   struct ieee80211_channel *channel,
1795                   const u8 *ssid, size_t ssid_len)
1796 {
1797         return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
1798                                 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
1799 }
1800
1801 struct cfg80211_bss *cfg80211_get_mesh(struct wiphy *wiphy,
1802                                        struct ieee80211_channel *channel,
1803                                        const u8 *meshid, size_t meshidlen,
1804                                        const u8 *meshcfg);
1805 void cfg80211_put_bss(struct cfg80211_bss *bss);
1806
1807 /**
1808  * cfg80211_unlink_bss - unlink BSS from internal data structures
1809  * @wiphy: the wiphy
1810  * @bss: the bss to remove
1811  *
1812  * This function removes the given BSS from the internal data structures
1813  * thereby making it no longer show up in scan results etc. Use this
1814  * function when you detect a BSS is gone. Normally BSSes will also time
1815  * out, so it is not necessary to use this function at all.
1816  */
1817 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
1818
1819 /**
1820  * cfg80211_send_rx_auth - notification of processed authentication
1821  * @dev: network device
1822  * @buf: authentication frame (header + body)
1823  * @len: length of the frame data
1824  *
1825  * This function is called whenever an authentication has been processed in
1826  * station mode. The driver is required to call either this function or
1827  * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
1828  * call. This function may sleep.
1829  */
1830 void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
1831
1832 /**
1833  * cfg80211_send_auth_timeout - notification of timed out authentication
1834  * @dev: network device
1835  * @addr: The MAC address of the device with which the authentication timed out
1836  *
1837  * This function may sleep.
1838  */
1839 void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr);
1840
1841 /**
1842  * __cfg80211_auth_canceled - notify cfg80211 that authentication was canceled
1843  * @dev: network device
1844  * @addr: The MAC address of the device with which the authentication timed out
1845  *
1846  * When a pending authentication had no action yet, the driver may decide
1847  * to not send a deauth frame, but in that case must calls this function
1848  * to tell cfg80211 about this decision. It is only valid to call this
1849  * function within the deauth() callback.
1850  */
1851 void __cfg80211_auth_canceled(struct net_device *dev, const u8 *addr);
1852
1853 /**
1854  * cfg80211_send_rx_assoc - notification of processed association
1855  * @dev: network device
1856  * @buf: (re)association response frame (header + body)
1857  * @len: length of the frame data
1858  *
1859  * This function is called whenever a (re)association response has been
1860  * processed in station mode. The driver is required to call either this
1861  * function or cfg80211_send_assoc_timeout() to indicate the result of
1862  * cfg80211_ops::assoc() call. This function may sleep.
1863  */
1864 void cfg80211_send_rx_assoc(struct net_device *dev, const u8 *buf, size_t len);
1865
1866 /**
1867  * cfg80211_send_assoc_timeout - notification of timed out association
1868  * @dev: network device
1869  * @addr: The MAC address of the device with which the association timed out
1870  *
1871  * This function may sleep.
1872  */
1873 void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr);
1874
1875 /**
1876  * cfg80211_send_deauth - notification of processed deauthentication
1877  * @dev: network device
1878  * @buf: deauthentication frame (header + body)
1879  * @len: length of the frame data
1880  *
1881  * This function is called whenever deauthentication has been processed in
1882  * station mode. This includes both received deauthentication frames and
1883  * locally generated ones. This function may sleep.
1884  */
1885 void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
1886
1887 /**
1888  * __cfg80211_send_deauth - notification of processed deauthentication
1889  * @dev: network device
1890  * @buf: deauthentication frame (header + body)
1891  * @len: length of the frame data
1892  *
1893  * Like cfg80211_send_deauth(), but doesn't take the wdev lock.
1894  */
1895 void __cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
1896
1897 /**
1898  * cfg80211_send_disassoc - notification of processed disassociation
1899  * @dev: network device
1900  * @buf: disassociation response frame (header + body)
1901  * @len: length of the frame data
1902  *
1903  * This function is called whenever disassociation has been processed in
1904  * station mode. This includes both received disassociation frames and locally
1905  * generated ones. This function may sleep.
1906  */
1907 void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len);
1908
1909 /**
1910  * __cfg80211_send_disassoc - notification of processed disassociation
1911  * @dev: network device
1912  * @buf: disassociation response frame (header + body)
1913  * @len: length of the frame data
1914  *
1915  * Like cfg80211_send_disassoc(), but doesn't take the wdev lock.
1916  */
1917 void __cfg80211_send_disassoc(struct net_device *dev, const u8 *buf,
1918         size_t len);
1919
1920 /**
1921  * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
1922  * @dev: network device
1923  * @addr: The source MAC address of the frame
1924  * @key_type: The key type that the received frame used
1925  * @key_id: Key identifier (0..3)
1926  * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
1927  * @gfp: allocation flags
1928  *
1929  * This function is called whenever the local MAC detects a MIC failure in a
1930  * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
1931  * primitive.
1932  */
1933 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
1934                                   enum nl80211_key_type key_type, int key_id,
1935                                   const u8 *tsc, gfp_t gfp);
1936
1937 /**
1938  * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
1939  *
1940  * @dev: network device
1941  * @bssid: the BSSID of the IBSS joined
1942  * @gfp: allocation flags
1943  *
1944  * This function notifies cfg80211 that the device joined an IBSS or
1945  * switched to a different BSSID. Before this function can be called,
1946  * either a beacon has to have been received from the IBSS, or one of
1947  * the cfg80211_inform_bss{,_frame} functions must have been called
1948  * with the locally generated beacon -- this guarantees that there is
1949  * always a scan result for this IBSS. cfg80211 will handle the rest.
1950  */
1951 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
1952
1953 /**
1954  * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
1955  * @wiphy: the wiphy
1956  * @blocked: block status
1957  */
1958 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
1959
1960 /**
1961  * wiphy_rfkill_start_polling - start polling rfkill
1962  * @wiphy: the wiphy
1963  */
1964 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
1965
1966 /**
1967  * wiphy_rfkill_stop_polling - stop polling rfkill
1968  * @wiphy: the wiphy
1969  */
1970 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
1971
1972 #ifdef CONFIG_NL80211_TESTMODE
1973 /**
1974  * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
1975  * @wiphy: the wiphy
1976  * @approxlen: an upper bound of the length of the data that will
1977  *      be put into the skb
1978  *
1979  * This function allocates and pre-fills an skb for a reply to
1980  * the testmode command. Since it is intended for a reply, calling
1981  * it outside of the @testmode_cmd operation is invalid.
1982  *
1983  * The returned skb (or %NULL if any errors happen) is pre-filled
1984  * with the wiphy index and set up in a way that any data that is
1985  * put into the skb (with skb_put(), nla_put() or similar) will end
1986  * up being within the %NL80211_ATTR_TESTDATA attribute, so all that
1987  * needs to be done with the skb is adding data for the corresponding
1988  * userspace tool which can then read that data out of the testdata
1989  * attribute. You must not modify the skb in any other way.
1990  *
1991  * When done, call cfg80211_testmode_reply() with the skb and return
1992  * its error code as the result of the @testmode_cmd operation.
1993  */
1994 struct sk_buff *cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy,
1995                                                   int approxlen);
1996
1997 /**
1998  * cfg80211_testmode_reply - send the reply skb
1999  * @skb: The skb, must have been allocated with
2000  *      cfg80211_testmode_alloc_reply_skb()
2001  *
2002  * Returns an error code or 0 on success, since calling this
2003  * function will usually be the last thing before returning
2004  * from the @testmode_cmd you should return the error code.
2005  * Note that this function consumes the skb regardless of the
2006  * return value.
2007  */
2008 int cfg80211_testmode_reply(struct sk_buff *skb);
2009
2010 /**
2011  * cfg80211_testmode_alloc_event_skb - allocate testmode event
2012  * @wiphy: the wiphy
2013  * @approxlen: an upper bound of the length of the data that will
2014  *      be put into the skb
2015  * @gfp: allocation flags
2016  *
2017  * This function allocates and pre-fills an skb for an event on the
2018  * testmode multicast group.
2019  *
2020  * The returned skb (or %NULL if any errors happen) is set up in the
2021  * same way as with cfg80211_testmode_alloc_reply_skb() but prepared
2022  * for an event. As there, you should simply add data to it that will
2023  * then end up in the %NL80211_ATTR_TESTDATA attribute. Again, you must
2024  * not modify the skb in any other way.
2025  *
2026  * When done filling the skb, call cfg80211_testmode_event() with the
2027  * skb to send the event.
2028  */
2029 struct sk_buff *cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy,
2030                                                   int approxlen, gfp_t gfp);
2031
2032 /**
2033  * cfg80211_testmode_event - send the event
2034  * @skb: The skb, must have been allocated with
2035  *      cfg80211_testmode_alloc_event_skb()
2036  * @gfp: allocation flags
2037  *
2038  * This function sends the given @skb, which must have been allocated
2039  * by cfg80211_testmode_alloc_event_skb(), as an event. It always
2040  * consumes it.
2041  */
2042 void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp);
2043
2044 #define CFG80211_TESTMODE_CMD(cmd)      .testmode_cmd = (cmd),
2045 #else
2046 #define CFG80211_TESTMODE_CMD(cmd)
2047 #endif
2048
2049 /**
2050  * cfg80211_connect_result - notify cfg80211 of connection result
2051  *
2052  * @dev: network device
2053  * @bssid: the BSSID of the AP
2054  * @req_ie: association request IEs (maybe be %NULL)
2055  * @req_ie_len: association request IEs length
2056  * @resp_ie: association response IEs (may be %NULL)
2057  * @resp_ie_len: assoc response IEs length
2058  * @status: status code, 0 for successful connection, use
2059  *      %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
2060  *      the real status code for failures.
2061  * @gfp: allocation flags
2062  *
2063  * It should be called by the underlying driver whenever connect() has
2064  * succeeded.
2065  */
2066 void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
2067                              const u8 *req_ie, size_t req_ie_len,
2068                              const u8 *resp_ie, size_t resp_ie_len,
2069                              u16 status, gfp_t gfp);
2070
2071 /**
2072  * cfg80211_roamed - notify cfg80211 of roaming
2073  *
2074  * @dev: network device
2075  * @bssid: the BSSID of the new AP
2076  * @req_ie: association request IEs (maybe be %NULL)
2077  * @req_ie_len: association request IEs length
2078  * @resp_ie: association response IEs (may be %NULL)
2079  * @resp_ie_len: assoc response IEs length
2080  * @gfp: allocation flags
2081  *
2082  * It should be called by the underlying driver whenever it roamed
2083  * from one AP to another while connected.
2084  */
2085 void cfg80211_roamed(struct net_device *dev, const u8 *bssid,
2086                      const u8 *req_ie, size_t req_ie_len,
2087                      const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
2088
2089 /**
2090  * cfg80211_disconnected - notify cfg80211 that connection was dropped
2091  *
2092  * @dev: network device
2093  * @ie: information elements of the deauth/disassoc frame (may be %NULL)
2094  * @ie_len: length of IEs
2095  * @reason: reason code for the disconnection, set it to 0 if unknown
2096  * @gfp: allocation flags
2097  *
2098  * After it calls this function, the driver should enter an idle state
2099  * and not try to connect to any AP any more.
2100  */
2101 void cfg80211_disconnected(struct net_device *dev, u16 reason,
2102                            u8 *ie, size_t ie_len, gfp_t gfp);
2103
2104
2105 #endif /* __NET_CFG80211_H */