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