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