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