linux/include/net/mac80211.h
<<
>>
Prefs
   1/*
   2 * mac80211 <-> driver interface
   3 *
   4 * Copyright 2002-2005, Devicescape Software, Inc.
   5 * Copyright 2006-2007  Jiri Benc <jbenc@suse.cz>
   6 * Copyright 2007-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#ifndef MAC80211_H
  14#define MAC80211_H
  15
  16#include <linux/bug.h>
  17#include <linux/kernel.h>
  18#include <linux/if_ether.h>
  19#include <linux/skbuff.h>
  20#include <linux/ieee80211.h>
  21#include <net/cfg80211.h>
  22#include <asm/unaligned.h>
  23
  24/**
  25 * DOC: Introduction
  26 *
  27 * mac80211 is the Linux stack for 802.11 hardware that implements
  28 * only partial functionality in hard- or firmware. This document
  29 * defines the interface between mac80211 and low-level hardware
  30 * drivers.
  31 */
  32
  33/**
  34 * DOC: Calling mac80211 from interrupts
  35 *
  36 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
  37 * called in hardware interrupt context. The low-level driver must not call any
  38 * other functions in hardware interrupt context. If there is a need for such
  39 * call, the low-level driver should first ACK the interrupt and perform the
  40 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
  41 * tasklet function.
  42 *
  43 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
  44 *       use the non-IRQ-safe functions!
  45 */
  46
  47/**
  48 * DOC: Warning
  49 *
  50 * If you're reading this document and not the header file itself, it will
  51 * be incomplete because not all documentation has been converted yet.
  52 */
  53
  54/**
  55 * DOC: Frame format
  56 *
  57 * As a general rule, when frames are passed between mac80211 and the driver,
  58 * they start with the IEEE 802.11 header and include the same octets that are
  59 * sent over the air except for the FCS which should be calculated by the
  60 * hardware.
  61 *
  62 * There are, however, various exceptions to this rule for advanced features:
  63 *
  64 * The first exception is for hardware encryption and decryption offload
  65 * where the IV/ICV may or may not be generated in hardware.
  66 *
  67 * Secondly, when the hardware handles fragmentation, the frame handed to
  68 * the driver from mac80211 is the MSDU, not the MPDU.
  69 *
  70 * Finally, for received frames, the driver is able to indicate that it has
  71 * filled a radiotap header and put that in front of the frame; if it does
  72 * not do so then mac80211 may add this under certain circumstances.
  73 */
  74
  75/**
  76 * DOC: mac80211 workqueue
  77 *
  78 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
  79 * The workqueue is a single threaded workqueue and can only be accessed by
  80 * helpers for sanity checking. Drivers must ensure all work added onto the
  81 * mac80211 workqueue should be cancelled on the driver stop() callback.
  82 *
  83 * mac80211 will flushed the workqueue upon interface removal and during
  84 * suspend.
  85 *
  86 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
  87 *
  88 */
  89
  90struct device;
  91
  92/**
  93 * enum ieee80211_max_queues - maximum number of queues
  94 *
  95 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
  96 */
  97enum ieee80211_max_queues {
  98        IEEE80211_MAX_QUEUES =          16,
  99};
 100
 101#define IEEE80211_INVAL_HW_QUEUE        0xff
 102
 103/**
 104 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
 105 * @IEEE80211_AC_VO: voice
 106 * @IEEE80211_AC_VI: video
 107 * @IEEE80211_AC_BE: best effort
 108 * @IEEE80211_AC_BK: background
 109 */
 110enum ieee80211_ac_numbers {
 111        IEEE80211_AC_VO         = 0,
 112        IEEE80211_AC_VI         = 1,
 113        IEEE80211_AC_BE         = 2,
 114        IEEE80211_AC_BK         = 3,
 115};
 116#define IEEE80211_NUM_ACS       4
 117
 118/**
 119 * struct ieee80211_tx_queue_params - transmit queue configuration
 120 *
 121 * The information provided in this structure is required for QoS
 122 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
 123 *
 124 * @aifs: arbitration interframe space [0..255]
 125 * @cw_min: minimum contention window [a value of the form
 126 *      2^n-1 in the range 1..32767]
 127 * @cw_max: maximum contention window [like @cw_min]
 128 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
 129 * @uapsd: is U-APSD mode enabled for the queue
 130 */
 131struct ieee80211_tx_queue_params {
 132        u16 txop;
 133        u16 cw_min;
 134        u16 cw_max;
 135        u8 aifs;
 136        bool uapsd;
 137};
 138
 139struct ieee80211_low_level_stats {
 140        unsigned int dot11ACKFailureCount;
 141        unsigned int dot11RTSFailureCount;
 142        unsigned int dot11FCSErrorCount;
 143        unsigned int dot11RTSSuccessCount;
 144};
 145
 146/**
 147 * enum ieee80211_bss_change - BSS change notification flags
 148 *
 149 * These flags are used with the bss_info_changed() callback
 150 * to indicate which BSS parameter changed.
 151 *
 152 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
 153 *      also implies a change in the AID.
 154 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
 155 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
 156 * @BSS_CHANGED_ERP_SLOT: slot timing changed
 157 * @BSS_CHANGED_HT: 802.11n parameters changed
 158 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
 159 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
 160 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
 161 *      reason (IBSS and managed mode)
 162 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
 163 *      new beacon (beaconing modes)
 164 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
 165 *      enabled/disabled (beaconing modes)
 166 * @BSS_CHANGED_CQM: Connection quality monitor config changed
 167 * @BSS_CHANGED_IBSS: IBSS join status changed
 168 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
 169 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
 170 *      that it is only ever disabled for station mode.
 171 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
 172 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP mode)
 173 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
 174 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
 175 */
 176enum ieee80211_bss_change {
 177        BSS_CHANGED_ASSOC               = 1<<0,
 178        BSS_CHANGED_ERP_CTS_PROT        = 1<<1,
 179        BSS_CHANGED_ERP_PREAMBLE        = 1<<2,
 180        BSS_CHANGED_ERP_SLOT            = 1<<3,
 181        BSS_CHANGED_HT                  = 1<<4,
 182        BSS_CHANGED_BASIC_RATES         = 1<<5,
 183        BSS_CHANGED_BEACON_INT          = 1<<6,
 184        BSS_CHANGED_BSSID               = 1<<7,
 185        BSS_CHANGED_BEACON              = 1<<8,
 186        BSS_CHANGED_BEACON_ENABLED      = 1<<9,
 187        BSS_CHANGED_CQM                 = 1<<10,
 188        BSS_CHANGED_IBSS                = 1<<11,
 189        BSS_CHANGED_ARP_FILTER          = 1<<12,
 190        BSS_CHANGED_QOS                 = 1<<13,
 191        BSS_CHANGED_IDLE                = 1<<14,
 192        BSS_CHANGED_SSID                = 1<<15,
 193        BSS_CHANGED_AP_PROBE_RESP       = 1<<16,
 194        BSS_CHANGED_PS                  = 1<<17,
 195
 196        /* when adding here, make sure to change ieee80211_reconfig */
 197};
 198
 199/*
 200 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
 201 * of addresses for an interface increase beyond this value, hardware ARP
 202 * filtering will be disabled.
 203 */
 204#define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
 205
 206/**
 207 * enum ieee80211_rssi_event - RSSI threshold event
 208 * An indicator for when RSSI goes below/above a certain threshold.
 209 * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
 210 * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
 211 */
 212enum ieee80211_rssi_event {
 213        RSSI_EVENT_HIGH,
 214        RSSI_EVENT_LOW,
 215};
 216
 217/**
 218 * struct ieee80211_bss_conf - holds the BSS's changing parameters
 219 *
 220 * This structure keeps information about a BSS (and an association
 221 * to that BSS) that can change during the lifetime of the BSS.
 222 *
 223 * @assoc: association status
 224 * @ibss_joined: indicates whether this station is part of an IBSS
 225 *      or not
 226 * @aid: association ID number, valid only when @assoc is true
 227 * @use_cts_prot: use CTS protection
 228 * @use_short_preamble: use 802.11b short preamble;
 229 *      if the hardware cannot handle this it must set the
 230 *      IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
 231 * @use_short_slot: use short slot time (only relevant for ERP);
 232 *      if the hardware cannot handle this it must set the
 233 *      IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
 234 * @dtim_period: num of beacons before the next DTIM, for beaconing,
 235 *      valid in station mode only while @assoc is true and if also
 236 *      requested by %IEEE80211_HW_NEED_DTIM_PERIOD (cf. also hw conf
 237 *      @ps_dtim_period)
 238 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
 239 *      as it may have been received during scanning long ago)
 240 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
 241 *      the driver/device can use this to calculate synchronisation
 242 * @beacon_int: beacon interval
 243 * @assoc_capability: capabilities taken from assoc resp
 244 * @basic_rates: bitmap of basic rates, each bit stands for an
 245 *      index into the rate table configured by the driver in
 246 *      the current band.
 247 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
 248 * @bssid: The BSSID for this BSS
 249 * @enable_beacon: whether beaconing should be enabled or not
 250 * @channel_type: Channel type for this BSS -- the hardware might be
 251 *      configured for HT40+ while this BSS only uses no-HT, for
 252 *      example.
 253 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
 254 *      This field is only valid when the channel type is one of the HT types.
 255 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
 256 *      implies disabled
 257 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
 258 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
 259 *      may filter ARP queries targeted for other addresses than listed here.
 260 *      The driver must allow ARP queries targeted for all address listed here
 261 *      to pass through. An empty list implies no ARP queries need to pass.
 262 * @arp_addr_cnt: Number of addresses currently on the list.
 263 * @arp_filter_enabled: Enable ARP filtering - if enabled, the hardware may
 264 *      filter ARP queries based on the @arp_addr_list, if disabled, the
 265 *      hardware must not perform any ARP filtering. Note, that the filter will
 266 *      be enabled also in promiscuous mode.
 267 * @qos: This is a QoS-enabled BSS.
 268 * @idle: This interface is idle. There's also a global idle flag in the
 269 *      hardware config which may be more appropriate depending on what
 270 *      your driver/device needs to do.
 271 * @ps: power-save mode (STA only). This flag is NOT affected by
 272 *      offchannel/dynamic_ps operations.
 273 * @ssid: The SSID of the current vif. Only valid in AP-mode.
 274 * @ssid_len: Length of SSID given in @ssid.
 275 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
 276 */
 277struct ieee80211_bss_conf {
 278        const u8 *bssid;
 279        /* association related data */
 280        bool assoc, ibss_joined;
 281        u16 aid;
 282        /* erp related data */
 283        bool use_cts_prot;
 284        bool use_short_preamble;
 285        bool use_short_slot;
 286        bool enable_beacon;
 287        u8 dtim_period;
 288        u16 beacon_int;
 289        u16 assoc_capability;
 290        u64 sync_tsf;
 291        u32 sync_device_ts;
 292        u32 basic_rates;
 293        int mcast_rate[IEEE80211_NUM_BANDS];
 294        u16 ht_operation_mode;
 295        s32 cqm_rssi_thold;
 296        u32 cqm_rssi_hyst;
 297        enum nl80211_channel_type channel_type;
 298        __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
 299        u8 arp_addr_cnt;
 300        bool arp_filter_enabled;
 301        bool qos;
 302        bool idle;
 303        bool ps;
 304        u8 ssid[IEEE80211_MAX_SSID_LEN];
 305        size_t ssid_len;
 306        bool hidden_ssid;
 307};
 308
 309/**
 310 * enum mac80211_tx_control_flags - flags to describe transmission information/status
 311 *
 312 * These flags are used with the @flags member of &ieee80211_tx_info.
 313 *
 314 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
 315 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
 316 *      number to this frame, taking care of not overwriting the fragment
 317 *      number and increasing the sequence number only when the
 318 *      IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
 319 *      assign sequence numbers to QoS-data frames but cannot do so correctly
 320 *      for non-QoS-data and management frames because beacons need them from
 321 *      that counter as well and mac80211 cannot guarantee proper sequencing.
 322 *      If this flag is set, the driver should instruct the hardware to
 323 *      assign a sequence number to the frame or assign one itself. Cf. IEEE
 324 *      802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
 325 *      beacons and always be clear for frames without a sequence number field.
 326 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
 327 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
 328 *      station
 329 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
 330 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
 331 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
 332 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
 333 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
 334 *      because the destination STA was in powersave mode. Note that to
 335 *      avoid race conditions, the filter must be set by the hardware or
 336 *      firmware upon receiving a frame that indicates that the station
 337 *      went to sleep (must be done on device to filter frames already on
 338 *      the queue) and may only be unset after mac80211 gives the OK for
 339 *      that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
 340 *      since only then is it guaranteed that no more frames are in the
 341 *      hardware queue.
 342 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
 343 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
 344 *      is for the whole aggregation.
 345 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
 346 *      so consider using block ack request (BAR).
 347 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
 348 *      set by rate control algorithms to indicate probe rate, will
 349 *      be cleared for fragmented frames (except on the last fragment)
 350 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
 351 *      used to indicate that a pending frame requires TX processing before
 352 *      it can be sent out.
 353 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
 354 *      used to indicate that a frame was already retried due to PS
 355 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
 356 *      used to indicate frame should not be encrypted
 357 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
 358 *      frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
 359 *      be sent although the station is in powersave mode.
 360 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
 361 *      transmit function after the current frame, this can be used
 362 *      by drivers to kick the DMA queue only if unset or when the
 363 *      queue gets full.
 364 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
 365 *      after TX status because the destination was asleep, it must not
 366 *      be modified again (no seqno assignment, crypto, etc.)
 367 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
 368 *      MLME command (internal to mac80211 to figure out whether to send TX
 369 *      status to user space)
 370 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
 371 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
 372 *      frame and selects the maximum number of streams that it can use.
 373 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
 374 *      the off-channel channel when a remain-on-channel offload is done
 375 *      in hardware -- normal packets still flow and are expected to be
 376 *      handled properly by the device.
 377 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
 378 *      testing. It will be sent out with incorrect Michael MIC key to allow
 379 *      TKIP countermeasures to be tested.
 380 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
 381 *      This flag is actually used for management frame especially for P2P
 382 *      frames not being sent at CCK rate in 2GHz band.
 383 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
 384 *      when its status is reported the service period ends. For frames in
 385 *      an SP that mac80211 transmits, it is already set; for driver frames
 386 *      the driver may set this flag. It is also used to do the same for
 387 *      PS-Poll responses.
 388 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
 389 *      This flag is used to send nullfunc frame at minimum rate when
 390 *      the nullfunc is used for connection monitoring purpose.
 391 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
 392 *      would be fragmented by size (this is optional, only used for
 393 *      monitor injection).
 394 *
 395 * Note: If you have to add new flags to the enumeration, then don't
 396 *       forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
 397 */
 398enum mac80211_tx_control_flags {
 399        IEEE80211_TX_CTL_REQ_TX_STATUS          = BIT(0),
 400        IEEE80211_TX_CTL_ASSIGN_SEQ             = BIT(1),
 401        IEEE80211_TX_CTL_NO_ACK                 = BIT(2),
 402        IEEE80211_TX_CTL_CLEAR_PS_FILT          = BIT(3),
 403        IEEE80211_TX_CTL_FIRST_FRAGMENT         = BIT(4),
 404        IEEE80211_TX_CTL_SEND_AFTER_DTIM        = BIT(5),
 405        IEEE80211_TX_CTL_AMPDU                  = BIT(6),
 406        IEEE80211_TX_CTL_INJECTED               = BIT(7),
 407        IEEE80211_TX_STAT_TX_FILTERED           = BIT(8),
 408        IEEE80211_TX_STAT_ACK                   = BIT(9),
 409        IEEE80211_TX_STAT_AMPDU                 = BIT(10),
 410        IEEE80211_TX_STAT_AMPDU_NO_BACK         = BIT(11),
 411        IEEE80211_TX_CTL_RATE_CTRL_PROBE        = BIT(12),
 412        IEEE80211_TX_INTFL_NEED_TXPROCESSING    = BIT(14),
 413        IEEE80211_TX_INTFL_RETRIED              = BIT(15),
 414        IEEE80211_TX_INTFL_DONT_ENCRYPT         = BIT(16),
 415        IEEE80211_TX_CTL_NO_PS_BUFFER           = BIT(17),
 416        IEEE80211_TX_CTL_MORE_FRAMES            = BIT(18),
 417        IEEE80211_TX_INTFL_RETRANSMISSION       = BIT(19),
 418        /* hole at 20, use later */
 419        IEEE80211_TX_INTFL_NL80211_FRAME_TX     = BIT(21),
 420        IEEE80211_TX_CTL_LDPC                   = BIT(22),
 421        IEEE80211_TX_CTL_STBC                   = BIT(23) | BIT(24),
 422        IEEE80211_TX_CTL_TX_OFFCHAN             = BIT(25),
 423        IEEE80211_TX_INTFL_TKIP_MIC_FAILURE     = BIT(26),
 424        IEEE80211_TX_CTL_NO_CCK_RATE            = BIT(27),
 425        IEEE80211_TX_STATUS_EOSP                = BIT(28),
 426        IEEE80211_TX_CTL_USE_MINRATE            = BIT(29),
 427        IEEE80211_TX_CTL_DONTFRAG               = BIT(30),
 428};
 429
 430#define IEEE80211_TX_CTL_STBC_SHIFT             23
 431
 432/*
 433 * This definition is used as a mask to clear all temporary flags, which are
 434 * set by the tx handlers for each transmission attempt by the mac80211 stack.
 435 */
 436#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK |               \
 437        IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT |    \
 438        IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU |           \
 439        IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK |               \
 440        IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK |           \
 441        IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER |    \
 442        IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC |                \
 443        IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
 444
 445/**
 446 * enum mac80211_rate_control_flags - per-rate flags set by the
 447 *      Rate Control algorithm.
 448 *
 449 * These flags are set by the Rate control algorithm for each rate during tx,
 450 * in the @flags member of struct ieee80211_tx_rate.
 451 *
 452 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
 453 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
 454 *      This is set if the current BSS requires ERP protection.
 455 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
 456 * @IEEE80211_TX_RC_MCS: HT rate.
 457 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
 458 *      Greenfield mode.
 459 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
 460 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
 461 *      adjacent 20 MHz channels, if the current channel type is
 462 *      NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
 463 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
 464 */
 465enum mac80211_rate_control_flags {
 466        IEEE80211_TX_RC_USE_RTS_CTS             = BIT(0),
 467        IEEE80211_TX_RC_USE_CTS_PROTECT         = BIT(1),
 468        IEEE80211_TX_RC_USE_SHORT_PREAMBLE      = BIT(2),
 469
 470        /* rate index is an MCS rate number instead of an index */
 471        IEEE80211_TX_RC_MCS                     = BIT(3),
 472        IEEE80211_TX_RC_GREEN_FIELD             = BIT(4),
 473        IEEE80211_TX_RC_40_MHZ_WIDTH            = BIT(5),
 474        IEEE80211_TX_RC_DUP_DATA                = BIT(6),
 475        IEEE80211_TX_RC_SHORT_GI                = BIT(7),
 476};
 477
 478
 479/* there are 40 bytes if you don't need the rateset to be kept */
 480#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
 481
 482/* if you do need the rateset, then you have less space */
 483#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
 484
 485/* maximum number of rate stages */
 486#define IEEE80211_TX_MAX_RATES  4
 487
 488/**
 489 * struct ieee80211_tx_rate - rate selection/status
 490 *
 491 * @idx: rate index to attempt to send with
 492 * @flags: rate control flags (&enum mac80211_rate_control_flags)
 493 * @count: number of tries in this rate before going to the next rate
 494 *
 495 * A value of -1 for @idx indicates an invalid rate and, if used
 496 * in an array of retry rates, that no more rates should be tried.
 497 *
 498 * When used for transmit status reporting, the driver should
 499 * always report the rate along with the flags it used.
 500 *
 501 * &struct ieee80211_tx_info contains an array of these structs
 502 * in the control information, and it will be filled by the rate
 503 * control algorithm according to what should be sent. For example,
 504 * if this array contains, in the format { <idx>, <count> } the
 505 * information
 506 *    { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
 507 * then this means that the frame should be transmitted
 508 * up to twice at rate 3, up to twice at rate 2, and up to four
 509 * times at rate 1 if it doesn't get acknowledged. Say it gets
 510 * acknowledged by the peer after the fifth attempt, the status
 511 * information should then contain
 512 *   { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
 513 * since it was transmitted twice at rate 3, twice at rate 2
 514 * and once at rate 1 after which we received an acknowledgement.
 515 */
 516struct ieee80211_tx_rate {
 517        s8 idx;
 518        u8 count;
 519        u8 flags;
 520} __packed;
 521
 522/**
 523 * struct ieee80211_tx_info - skb transmit information
 524 *
 525 * This structure is placed in skb->cb for three uses:
 526 *  (1) mac80211 TX control - mac80211 tells the driver what to do
 527 *  (2) driver internal use (if applicable)
 528 *  (3) TX status information - driver tells mac80211 what happened
 529 *
 530 * @flags: transmit info flags, defined above
 531 * @band: the band to transmit on (use for checking for races)
 532 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
 533 * @ack_frame_id: internal frame ID for TX status, used internally
 534 * @control: union for control data
 535 * @status: union for status data
 536 * @driver_data: array of driver_data pointers
 537 * @ampdu_ack_len: number of acked aggregated frames.
 538 *      relevant only if IEEE80211_TX_STAT_AMPDU was set.
 539 * @ampdu_len: number of aggregated frames.
 540 *      relevant only if IEEE80211_TX_STAT_AMPDU was set.
 541 * @ack_signal: signal strength of the ACK frame
 542 */
 543struct ieee80211_tx_info {
 544        /* common information */
 545        u32 flags;
 546        u8 band;
 547
 548        u8 hw_queue;
 549
 550        u16 ack_frame_id;
 551
 552        union {
 553                struct {
 554                        union {
 555                                /* rate control */
 556                                struct {
 557                                        struct ieee80211_tx_rate rates[
 558                                                IEEE80211_TX_MAX_RATES];
 559                                        s8 rts_cts_rate_idx;
 560                                        /* 3 bytes free */
 561                                };
 562                                /* only needed before rate control */
 563                                unsigned long jiffies;
 564                        };
 565                        /* NB: vif can be NULL for injected frames */
 566                        struct ieee80211_vif *vif;
 567                        struct ieee80211_key_conf *hw_key;
 568                        /* 8 bytes free */
 569                } control;
 570                struct {
 571                        struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
 572                        int ack_signal;
 573                        u8 ampdu_ack_len;
 574                        u8 ampdu_len;
 575                        u8 antenna;
 576                        /* 21 bytes free */
 577                } status;
 578                struct {
 579                        struct ieee80211_tx_rate driver_rates[
 580                                IEEE80211_TX_MAX_RATES];
 581                        void *rate_driver_data[
 582                                IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
 583                };
 584                void *driver_data[
 585                        IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
 586        };
 587};
 588
 589/**
 590 * struct ieee80211_sched_scan_ies - scheduled scan IEs
 591 *
 592 * This structure is used to pass the appropriate IEs to be used in scheduled
 593 * scans for all bands.  It contains both the IEs passed from the userspace
 594 * and the ones generated by mac80211.
 595 *
 596 * @ie: array with the IEs for each supported band
 597 * @len: array with the total length of the IEs for each band
 598 */
 599struct ieee80211_sched_scan_ies {
 600        u8 *ie[IEEE80211_NUM_BANDS];
 601        size_t len[IEEE80211_NUM_BANDS];
 602};
 603
 604static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
 605{
 606        return (struct ieee80211_tx_info *)skb->cb;
 607}
 608
 609static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
 610{
 611        return (struct ieee80211_rx_status *)skb->cb;
 612}
 613
 614/**
 615 * ieee80211_tx_info_clear_status - clear TX status
 616 *
 617 * @info: The &struct ieee80211_tx_info to be cleared.
 618 *
 619 * When the driver passes an skb back to mac80211, it must report
 620 * a number of things in TX status. This function clears everything
 621 * in the TX status but the rate control information (it does clear
 622 * the count since you need to fill that in anyway).
 623 *
 624 * NOTE: You can only use this function if you do NOT use
 625 *       info->driver_data! Use info->rate_driver_data
 626 *       instead if you need only the less space that allows.
 627 */
 628static inline void
 629ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
 630{
 631        int i;
 632
 633        BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
 634                     offsetof(struct ieee80211_tx_info, control.rates));
 635        BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
 636                     offsetof(struct ieee80211_tx_info, driver_rates));
 637        BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
 638        /* clear the rate counts */
 639        for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
 640                info->status.rates[i].count = 0;
 641
 642        BUILD_BUG_ON(
 643            offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
 644        memset(&info->status.ampdu_ack_len, 0,
 645               sizeof(struct ieee80211_tx_info) -
 646               offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
 647}
 648
 649
 650/**
 651 * enum mac80211_rx_flags - receive flags
 652 *
 653 * These flags are used with the @flag member of &struct ieee80211_rx_status.
 654 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
 655 *      Use together with %RX_FLAG_MMIC_STRIPPED.
 656 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
 657 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
 658 *      verification has been done by the hardware.
 659 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
 660 *      If this flag is set, the stack cannot do any replay detection
 661 *      hence the driver or hardware will have to do that.
 662 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
 663 *      the frame.
 664 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
 665 *      the frame.
 666 * @RX_FLAG_MACTIME_MPDU: The timestamp passed in the RX status (@mactime
 667 *      field) is valid and contains the time the first symbol of the MPDU
 668 *      was received. This is useful in monitor mode and for proper IBSS
 669 *      merging.
 670 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
 671 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
 672 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
 673 * @RX_FLAG_SHORT_GI: Short guard interval was used
 674 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
 675 *      Valid only for data frames (mainly A-MPDU)
 676 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
 677 *      the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
 678 *      to hw.radiotap_mcs_details to advertise that fact
 679 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
 680 *      number (@ampdu_reference) must be populated and be a distinct number for
 681 *      each A-MPDU
 682 * @RX_FLAG_AMPDU_REPORT_ZEROLEN: driver reports 0-length subframes
 683 * @RX_FLAG_AMPDU_IS_ZEROLEN: This is a zero-length subframe, for
 684 *      monitoring purposes only
 685 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
 686 *      subframes of a single A-MPDU
 687 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
 688 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
 689 *      on this subframe
 690 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
 691 *      is stored in the @ampdu_delimiter_crc field)
 692 */
 693enum mac80211_rx_flags {
 694        RX_FLAG_MMIC_ERROR              = BIT(0),
 695        RX_FLAG_DECRYPTED               = BIT(1),
 696        RX_FLAG_MMIC_STRIPPED           = BIT(3),
 697        RX_FLAG_IV_STRIPPED             = BIT(4),
 698        RX_FLAG_FAILED_FCS_CRC          = BIT(5),
 699        RX_FLAG_FAILED_PLCP_CRC         = BIT(6),
 700        RX_FLAG_MACTIME_MPDU            = BIT(7),
 701        RX_FLAG_SHORTPRE                = BIT(8),
 702        RX_FLAG_HT                      = BIT(9),
 703        RX_FLAG_40MHZ                   = BIT(10),
 704        RX_FLAG_SHORT_GI                = BIT(11),
 705        RX_FLAG_NO_SIGNAL_VAL           = BIT(12),
 706        RX_FLAG_HT_GF                   = BIT(13),
 707        RX_FLAG_AMPDU_DETAILS           = BIT(14),
 708        RX_FLAG_AMPDU_REPORT_ZEROLEN    = BIT(15),
 709        RX_FLAG_AMPDU_IS_ZEROLEN        = BIT(16),
 710        RX_FLAG_AMPDU_LAST_KNOWN        = BIT(17),
 711        RX_FLAG_AMPDU_IS_LAST           = BIT(18),
 712        RX_FLAG_AMPDU_DELIM_CRC_ERROR   = BIT(19),
 713        RX_FLAG_AMPDU_DELIM_CRC_KNOWN   = BIT(20),
 714};
 715
 716/**
 717 * struct ieee80211_rx_status - receive status
 718 *
 719 * The low-level driver should provide this information (the subset
 720 * supported by hardware) to the 802.11 code with each received
 721 * frame, in the skb's control buffer (cb).
 722 *
 723 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
 724 *      (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
 725 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
 726 *      it but can store it and pass it back to the driver for synchronisation
 727 * @band: the active band when this frame was received
 728 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
 729 * @signal: signal strength when receiving this frame, either in dBm, in dB or
 730 *      unspecified depending on the hardware capabilities flags
 731 *      @IEEE80211_HW_SIGNAL_*
 732 * @antenna: antenna used
 733 * @rate_idx: index of data rate into band's supported rates or MCS index if
 734 *      HT rates are use (RX_FLAG_HT)
 735 * @flag: %RX_FLAG_*
 736 * @rx_flags: internal RX flags for mac80211
 737 * @ampdu_reference: A-MPDU reference number, must be a different value for
 738 *      each A-MPDU but the same for each subframe within one A-MPDU
 739 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
 740 */
 741struct ieee80211_rx_status {
 742        u64 mactime;
 743        u32 device_timestamp;
 744        u32 ampdu_reference;
 745        u32 flag;
 746        u16 freq;
 747        u8 rate_idx;
 748        u8 rx_flags;
 749        u8 band;
 750        u8 antenna;
 751        s8 signal;
 752        u8 ampdu_delimiter_crc;
 753};
 754
 755/**
 756 * enum ieee80211_conf_flags - configuration flags
 757 *
 758 * Flags to define PHY configuration options
 759 *
 760 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
 761 *      to determine for example whether to calculate timestamps for packets
 762 *      or not, do not use instead of filter flags!
 763 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
 764 *      This is the power save mode defined by IEEE 802.11-2007 section 11.2,
 765 *      meaning that the hardware still wakes up for beacons, is able to
 766 *      transmit frames and receive the possible acknowledgment frames.
 767 *      Not to be confused with hardware specific wakeup/sleep states,
 768 *      driver is responsible for that. See the section "Powersave support"
 769 *      for more.
 770 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
 771 *      the driver should be prepared to handle configuration requests but
 772 *      may turn the device off as much as possible. Typically, this flag will
 773 *      be set when an interface is set UP but not associated or scanning, but
 774 *      it can also be unset in that case when monitor interfaces are active.
 775 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
 776 *      operating channel.
 777 */
 778enum ieee80211_conf_flags {
 779        IEEE80211_CONF_MONITOR          = (1<<0),
 780        IEEE80211_CONF_PS               = (1<<1),
 781        IEEE80211_CONF_IDLE             = (1<<2),
 782        IEEE80211_CONF_OFFCHANNEL       = (1<<3),
 783};
 784
 785
 786/**
 787 * enum ieee80211_conf_changed - denotes which configuration changed
 788 *
 789 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
 790 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
 791 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
 792 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
 793 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
 794 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
 795 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
 796 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
 797 */
 798enum ieee80211_conf_changed {
 799        IEEE80211_CONF_CHANGE_SMPS              = BIT(1),
 800        IEEE80211_CONF_CHANGE_LISTEN_INTERVAL   = BIT(2),
 801        IEEE80211_CONF_CHANGE_MONITOR           = BIT(3),
 802        IEEE80211_CONF_CHANGE_PS                = BIT(4),
 803        IEEE80211_CONF_CHANGE_POWER             = BIT(5),
 804        IEEE80211_CONF_CHANGE_CHANNEL           = BIT(6),
 805        IEEE80211_CONF_CHANGE_RETRY_LIMITS      = BIT(7),
 806        IEEE80211_CONF_CHANGE_IDLE              = BIT(8),
 807};
 808
 809/**
 810 * enum ieee80211_smps_mode - spatial multiplexing power save mode
 811 *
 812 * @IEEE80211_SMPS_AUTOMATIC: automatic
 813 * @IEEE80211_SMPS_OFF: off
 814 * @IEEE80211_SMPS_STATIC: static
 815 * @IEEE80211_SMPS_DYNAMIC: dynamic
 816 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
 817 */
 818enum ieee80211_smps_mode {
 819        IEEE80211_SMPS_AUTOMATIC,
 820        IEEE80211_SMPS_OFF,
 821        IEEE80211_SMPS_STATIC,
 822        IEEE80211_SMPS_DYNAMIC,
 823
 824        /* keep last */
 825        IEEE80211_SMPS_NUM_MODES,
 826};
 827
 828/**
 829 * struct ieee80211_conf - configuration of the device
 830 *
 831 * This struct indicates how the driver shall configure the hardware.
 832 *
 833 * @flags: configuration flags defined above
 834 *
 835 * @listen_interval: listen interval in units of beacon interval
 836 * @max_sleep_period: the maximum number of beacon intervals to sleep for
 837 *      before checking the beacon for a TIM bit (managed mode only); this
 838 *      value will be only achievable between DTIM frames, the hardware
 839 *      needs to check for the multicast traffic bit in DTIM beacons.
 840 *      This variable is valid only when the CONF_PS flag is set.
 841 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
 842 *      in power saving. Power saving will not be enabled until a beacon
 843 *      has been received and the DTIM period is known.
 844 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
 845 *      powersave documentation below. This variable is valid only when
 846 *      the CONF_PS flag is set.
 847 *
 848 * @power_level: requested transmit power (in dBm)
 849 *
 850 * @channel: the channel to tune to
 851 * @channel_type: the channel (HT) type
 852 *
 853 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
 854 *    (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
 855 *    but actually means the number of transmissions not the number of retries
 856 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
 857 *    frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
 858 *    number of transmissions not the number of retries
 859 *
 860 * @smps_mode: spatial multiplexing powersave mode; note that
 861 *      %IEEE80211_SMPS_STATIC is used when the device is not
 862 *      configured for an HT channel
 863 */
 864struct ieee80211_conf {
 865        u32 flags;
 866        int power_level, dynamic_ps_timeout;
 867        int max_sleep_period;
 868
 869        u16 listen_interval;
 870        u8 ps_dtim_period;
 871
 872        u8 long_frame_max_tx_count, short_frame_max_tx_count;
 873
 874        struct ieee80211_channel *channel;
 875        enum nl80211_channel_type channel_type;
 876        enum ieee80211_smps_mode smps_mode;
 877};
 878
 879/**
 880 * struct ieee80211_channel_switch - holds the channel switch data
 881 *
 882 * The information provided in this structure is required for channel switch
 883 * operation.
 884 *
 885 * @timestamp: value in microseconds of the 64-bit Time Synchronization
 886 *      Function (TSF) timer when the frame containing the channel switch
 887 *      announcement was received. This is simply the rx.mactime parameter
 888 *      the driver passed into mac80211.
 889 * @block_tx: Indicates whether transmission must be blocked before the
 890 *      scheduled channel switch, as indicated by the AP.
 891 * @channel: the new channel to switch to
 892 * @count: the number of TBTT's until the channel switch event
 893 */
 894struct ieee80211_channel_switch {
 895        u64 timestamp;
 896        bool block_tx;
 897        struct ieee80211_channel *channel;
 898        u8 count;
 899};
 900
 901/**
 902 * enum ieee80211_vif_flags - virtual interface flags
 903 *
 904 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
 905 *      on this virtual interface to avoid unnecessary CPU wakeups
 906 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
 907 *      monitoring on this virtual interface -- i.e. it can monitor
 908 *      connection quality related parameters, such as the RSSI level and
 909 *      provide notifications if configured trigger levels are reached.
 910 */
 911enum ieee80211_vif_flags {
 912        IEEE80211_VIF_BEACON_FILTER             = BIT(0),
 913        IEEE80211_VIF_SUPPORTS_CQM_RSSI         = BIT(1),
 914};
 915
 916/**
 917 * struct ieee80211_vif - per-interface data
 918 *
 919 * Data in this structure is continually present for driver
 920 * use during the life of a virtual interface.
 921 *
 922 * @type: type of this virtual interface
 923 * @bss_conf: BSS configuration for this interface, either our own
 924 *      or the BSS we're associated to
 925 * @addr: address of this interface
 926 * @p2p: indicates whether this AP or STA interface is a p2p
 927 *      interface, i.e. a GO or p2p-sta respectively
 928 * @driver_flags: flags/capabilities the driver has for this interface,
 929 *      these need to be set (or cleared) when the interface is added
 930 *      or, if supported by the driver, the interface type is changed
 931 *      at runtime, mac80211 will never touch this field
 932 * @hw_queue: hardware queue for each AC
 933 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
 934 * @drv_priv: data area for driver use, will always be aligned to
 935 *      sizeof(void *).
 936 */
 937struct ieee80211_vif {
 938        enum nl80211_iftype type;
 939        struct ieee80211_bss_conf bss_conf;
 940        u8 addr[ETH_ALEN];
 941        bool p2p;
 942
 943        u8 cab_queue;
 944        u8 hw_queue[IEEE80211_NUM_ACS];
 945
 946        u32 driver_flags;
 947
 948        /* must be last */
 949        u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
 950};
 951
 952static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
 953{
 954#ifdef CONFIG_MAC80211_MESH
 955        return vif->type == NL80211_IFTYPE_MESH_POINT;
 956#endif
 957        return false;
 958}
 959
 960/**
 961 * enum ieee80211_key_flags - key flags
 962 *
 963 * These flags are used for communication about keys between the driver
 964 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
 965 *
 966 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
 967 *      that the STA this key will be used with could be using QoS.
 968 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
 969 *      driver to indicate that it requires IV generation for this
 970 *      particular key.
 971 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
 972 *      the driver for a TKIP key if it requires Michael MIC
 973 *      generation in software.
 974 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
 975 *      that the key is pairwise rather then a shared key.
 976 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
 977 *      CCMP key if it requires CCMP encryption of management frames (MFP) to
 978 *      be done in software.
 979 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
 980 *      if space should be prepared for the IV, but the IV
 981 *      itself should not be generated. Do not set together with
 982 *      @IEEE80211_KEY_FLAG_GENERATE_IV on the same key.
 983 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
 984 *      management frames. The flag can help drivers that have a hardware
 985 *      crypto implementation that doesn't deal with management frames
 986 *      properly by allowing them to not upload the keys to hardware and
 987 *      fall back to software crypto. Note that this flag deals only with
 988 *      RX, if your crypto engine can't deal with TX you can also set the
 989 *      %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
 990 */
 991enum ieee80211_key_flags {
 992        IEEE80211_KEY_FLAG_WMM_STA      = 1<<0,
 993        IEEE80211_KEY_FLAG_GENERATE_IV  = 1<<1,
 994        IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
 995        IEEE80211_KEY_FLAG_PAIRWISE     = 1<<3,
 996        IEEE80211_KEY_FLAG_SW_MGMT_TX   = 1<<4,
 997        IEEE80211_KEY_FLAG_PUT_IV_SPACE = 1<<5,
 998        IEEE80211_KEY_FLAG_RX_MGMT      = 1<<6,
 999};
1000
1001/**
1002 * struct ieee80211_key_conf - key information
1003 *
1004 * This key information is given by mac80211 to the driver by
1005 * the set_key() callback in &struct ieee80211_ops.
1006 *
1007 * @hw_key_idx: To be set by the driver, this is the key index the driver
1008 *      wants to be given when a frame is transmitted and needs to be
1009 *      encrypted in hardware.
1010 * @cipher: The key's cipher suite selector.
1011 * @flags: key flags, see &enum ieee80211_key_flags.
1012 * @keyidx: the key index (0-3)
1013 * @keylen: key material length
1014 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1015 *      data block:
1016 *      - Temporal Encryption Key (128 bits)
1017 *      - Temporal Authenticator Tx MIC Key (64 bits)
1018 *      - Temporal Authenticator Rx MIC Key (64 bits)
1019 * @icv_len: The ICV length for this key type
1020 * @iv_len: The IV length for this key type
1021 */
1022struct ieee80211_key_conf {
1023        u32 cipher;
1024        u8 icv_len;
1025        u8 iv_len;
1026        u8 hw_key_idx;
1027        u8 flags;
1028        s8 keyidx;
1029        u8 keylen;
1030        u8 key[0];
1031};
1032
1033/**
1034 * enum set_key_cmd - key command
1035 *
1036 * Used with the set_key() callback in &struct ieee80211_ops, this
1037 * indicates whether a key is being removed or added.
1038 *
1039 * @SET_KEY: a key is set
1040 * @DISABLE_KEY: a key must be disabled
1041 */
1042enum set_key_cmd {
1043        SET_KEY, DISABLE_KEY,
1044};
1045
1046/**
1047 * enum ieee80211_sta_state - station state
1048 *
1049 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1050 *      this is a special state for add/remove transitions
1051 * @IEEE80211_STA_NONE: station exists without special state
1052 * @IEEE80211_STA_AUTH: station is authenticated
1053 * @IEEE80211_STA_ASSOC: station is associated
1054 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1055 */
1056enum ieee80211_sta_state {
1057        /* NOTE: These need to be ordered correctly! */
1058        IEEE80211_STA_NOTEXIST,
1059        IEEE80211_STA_NONE,
1060        IEEE80211_STA_AUTH,
1061        IEEE80211_STA_ASSOC,
1062        IEEE80211_STA_AUTHORIZED,
1063};
1064
1065/**
1066 * struct ieee80211_sta - station table entry
1067 *
1068 * A station table entry represents a station we are possibly
1069 * communicating with. Since stations are RCU-managed in
1070 * mac80211, any ieee80211_sta pointer you get access to must
1071 * either be protected by rcu_read_lock() explicitly or implicitly,
1072 * or you must take good care to not use such a pointer after a
1073 * call to your sta_remove callback that removed it.
1074 *
1075 * @addr: MAC address
1076 * @aid: AID we assigned to the station if we're an AP
1077 * @supp_rates: Bitmap of supported rates (per band)
1078 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
1079 * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
1080 * @drv_priv: data area for driver use, will always be aligned to
1081 *      sizeof(void *), size is determined in hw information.
1082 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1083 *      if wme is supported.
1084 * @max_sp: max Service Period. Only valid if wme is supported.
1085 */
1086struct ieee80211_sta {
1087        u32 supp_rates[IEEE80211_NUM_BANDS];
1088        u8 addr[ETH_ALEN];
1089        u16 aid;
1090        struct ieee80211_sta_ht_cap ht_cap;
1091        bool wme;
1092        u8 uapsd_queues;
1093        u8 max_sp;
1094
1095        /* must be last */
1096        u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
1097};
1098
1099/**
1100 * enum sta_notify_cmd - sta notify command
1101 *
1102 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1103 * indicates if an associated station made a power state transition.
1104 *
1105 * @STA_NOTIFY_SLEEP: a station is now sleeping
1106 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1107 */
1108enum sta_notify_cmd {
1109        STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1110};
1111
1112/**
1113 * struct ieee80211_tx_control - TX control data
1114 *
1115 * @sta: station table entry, this sta pointer may be NULL and
1116 *      it is not allowed to copy the pointer, due to RCU.
1117 */
1118struct ieee80211_tx_control {
1119        struct ieee80211_sta *sta;
1120};
1121
1122/**
1123 * enum ieee80211_hw_flags - hardware flags
1124 *
1125 * These flags are used to indicate hardware capabilities to
1126 * the stack. Generally, flags here should have their meaning
1127 * done in a way that the simplest hardware doesn't need setting
1128 * any particular flags. There are some exceptions to this rule,
1129 * however, so you are advised to review these flags carefully.
1130 *
1131 * @IEEE80211_HW_HAS_RATE_CONTROL:
1132 *      The hardware or firmware includes rate control, and cannot be
1133 *      controlled by the stack. As such, no rate control algorithm
1134 *      should be instantiated, and the TX rate reported to userspace
1135 *      will be taken from the TX status instead of the rate control
1136 *      algorithm.
1137 *      Note that this requires that the driver implement a number of
1138 *      callbacks so it has the correct information, it needs to have
1139 *      the @set_rts_threshold callback and must look at the BSS config
1140 *      @use_cts_prot for G/N protection, @use_short_slot for slot
1141 *      timing in 2.4 GHz and @use_short_preamble for preambles for
1142 *      CCK frames.
1143 *
1144 * @IEEE80211_HW_RX_INCLUDES_FCS:
1145 *      Indicates that received frames passed to the stack include
1146 *      the FCS at the end.
1147 *
1148 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1149 *      Some wireless LAN chipsets buffer broadcast/multicast frames
1150 *      for power saving stations in the hardware/firmware and others
1151 *      rely on the host system for such buffering. This option is used
1152 *      to configure the IEEE 802.11 upper layer to buffer broadcast and
1153 *      multicast frames when there are power saving stations so that
1154 *      the driver can fetch them with ieee80211_get_buffered_bc().
1155 *
1156 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1157 *      Hardware is not capable of short slot operation on the 2.4 GHz band.
1158 *
1159 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1160 *      Hardware is not capable of receiving frames with short preamble on
1161 *      the 2.4 GHz band.
1162 *
1163 * @IEEE80211_HW_SIGNAL_UNSPEC:
1164 *      Hardware can provide signal values but we don't know its units. We
1165 *      expect values between 0 and @max_signal.
1166 *      If possible please provide dB or dBm instead.
1167 *
1168 * @IEEE80211_HW_SIGNAL_DBM:
1169 *      Hardware gives signal values in dBm, decibel difference from
1170 *      one milliwatt. This is the preferred method since it is standardized
1171 *      between different devices. @max_signal does not need to be set.
1172 *
1173 * @IEEE80211_HW_SPECTRUM_MGMT:
1174 *      Hardware supports spectrum management defined in 802.11h
1175 *      Measurement, Channel Switch, Quieting, TPC
1176 *
1177 * @IEEE80211_HW_AMPDU_AGGREGATION:
1178 *      Hardware supports 11n A-MPDU aggregation.
1179 *
1180 * @IEEE80211_HW_SUPPORTS_PS:
1181 *      Hardware has power save support (i.e. can go to sleep).
1182 *
1183 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1184 *      Hardware requires nullfunc frame handling in stack, implies
1185 *      stack support for dynamic PS.
1186 *
1187 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1188 *      Hardware has support for dynamic PS.
1189 *
1190 * @IEEE80211_HW_MFP_CAPABLE:
1191 *      Hardware supports management frame protection (MFP, IEEE 802.11w).
1192 *
1193 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1194 *      Hardware supports static spatial multiplexing powersave,
1195 *      ie. can turn off all but one chain even on HT connections
1196 *      that should be using more chains.
1197 *
1198 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1199 *      Hardware supports dynamic spatial multiplexing powersave,
1200 *      ie. can turn off all but one chain and then wake the rest
1201 *      up as required after, for example, rts/cts handshake.
1202 *
1203 * @IEEE80211_HW_SUPPORTS_UAPSD:
1204 *      Hardware supports Unscheduled Automatic Power Save Delivery
1205 *      (U-APSD) in managed mode. The mode is configured with
1206 *      conf_tx() operation.
1207 *
1208 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1209 *      Hardware can provide ack status reports of Tx frames to
1210 *      the stack.
1211 *
1212 * @IEEE80211_HW_CONNECTION_MONITOR:
1213 *      The hardware performs its own connection monitoring, including
1214 *      periodic keep-alives to the AP and probing the AP on beacon loss.
1215 *      When this flag is set, signaling beacon-loss will cause an immediate
1216 *      change to disassociated state.
1217 *
1218 * @IEEE80211_HW_NEED_DTIM_PERIOD:
1219 *      This device needs to know the DTIM period for the BSS before
1220 *      associating.
1221 *
1222 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1223 *      per-station GTKs as used by IBSS RSN or during fast transition. If
1224 *      the device doesn't support per-station GTKs, but can be asked not
1225 *      to decrypt group addressed frames, then IBSS RSN support is still
1226 *      possible but software crypto will be used. Advertise the wiphy flag
1227 *      only in that case.
1228 *
1229 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1230 *      autonomously manages the PS status of connected stations. When
1231 *      this flag is set mac80211 will not trigger PS mode for connected
1232 *      stations based on the PM bit of incoming frames.
1233 *      Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1234 *      the PS mode of connected stations.
1235 *
1236 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1237 *      setup strictly in HW. mac80211 should not attempt to do this in
1238 *      software.
1239 *
1240 * @IEEE80211_HW_SCAN_WHILE_IDLE: The device can do hw scan while
1241 *      being idle (i.e. mac80211 doesn't have to go idle-off during the
1242 *      the scan).
1243 *
1244 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1245 *      a virtual monitor interface when monitor interfaces are the only
1246 *      active interfaces.
1247 *
1248 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1249 *      queue mapping in order to use different queues (not just one per AC)
1250 *      for different virtual interfaces. See the doc section on HW queue
1251 *      control for more details.
1252 *
1253 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1254 *      P2P Interface. This will be honoured even if more than one interface
1255 *      is supported.
1256 */
1257enum ieee80211_hw_flags {
1258        IEEE80211_HW_HAS_RATE_CONTROL                   = 1<<0,
1259        IEEE80211_HW_RX_INCLUDES_FCS                    = 1<<1,
1260        IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING        = 1<<2,
1261        IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE          = 1<<3,
1262        IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE      = 1<<4,
1263        IEEE80211_HW_SIGNAL_UNSPEC                      = 1<<5,
1264        IEEE80211_HW_SIGNAL_DBM                         = 1<<6,
1265        IEEE80211_HW_NEED_DTIM_PERIOD                   = 1<<7,
1266        IEEE80211_HW_SPECTRUM_MGMT                      = 1<<8,
1267        IEEE80211_HW_AMPDU_AGGREGATION                  = 1<<9,
1268        IEEE80211_HW_SUPPORTS_PS                        = 1<<10,
1269        IEEE80211_HW_PS_NULLFUNC_STACK                  = 1<<11,
1270        IEEE80211_HW_SUPPORTS_DYNAMIC_PS                = 1<<12,
1271        IEEE80211_HW_MFP_CAPABLE                        = 1<<13,
1272        IEEE80211_HW_WANT_MONITOR_VIF                   = 1<<14,
1273        IEEE80211_HW_SUPPORTS_STATIC_SMPS               = 1<<15,
1274        IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS              = 1<<16,
1275        IEEE80211_HW_SUPPORTS_UAPSD                     = 1<<17,
1276        IEEE80211_HW_REPORTS_TX_ACK_STATUS              = 1<<18,
1277        IEEE80211_HW_CONNECTION_MONITOR                 = 1<<19,
1278        IEEE80211_HW_QUEUE_CONTROL                      = 1<<20,
1279        IEEE80211_HW_SUPPORTS_PER_STA_GTK               = 1<<21,
1280        IEEE80211_HW_AP_LINK_PS                         = 1<<22,
1281        IEEE80211_HW_TX_AMPDU_SETUP_IN_HW               = 1<<23,
1282        IEEE80211_HW_SCAN_WHILE_IDLE                    = 1<<24,
1283        IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF              = 1<<25,
1284};
1285
1286/**
1287 * struct ieee80211_hw - hardware information and state
1288 *
1289 * This structure contains the configuration and hardware
1290 * information for an 802.11 PHY.
1291 *
1292 * @wiphy: This points to the &struct wiphy allocated for this
1293 *      802.11 PHY. You must fill in the @perm_addr and @dev
1294 *      members of this structure using SET_IEEE80211_DEV()
1295 *      and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1296 *      bands (with channels, bitrates) are registered here.
1297 *
1298 * @conf: &struct ieee80211_conf, device configuration, don't use.
1299 *
1300 * @priv: pointer to private area that was allocated for driver use
1301 *      along with this structure.
1302 *
1303 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1304 *
1305 * @extra_tx_headroom: headroom to reserve in each transmit skb
1306 *      for use by the driver (e.g. for transmit headers.)
1307 *
1308 * @channel_change_time: time (in microseconds) it takes to change channels.
1309 *
1310 * @max_signal: Maximum value for signal (rssi) in RX information, used
1311 *     only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1312 *
1313 * @max_listen_interval: max listen interval in units of beacon interval
1314 *     that HW supports
1315 *
1316 * @queues: number of available hardware transmit queues for
1317 *      data packets. WMM/QoS requires at least four, these
1318 *      queues need to have configurable access parameters.
1319 *
1320 * @rate_control_algorithm: rate control algorithm for this hardware.
1321 *      If unset (NULL), the default algorithm will be used. Must be
1322 *      set before calling ieee80211_register_hw().
1323 *
1324 * @vif_data_size: size (in bytes) of the drv_priv data area
1325 *      within &struct ieee80211_vif.
1326 * @sta_data_size: size (in bytes) of the drv_priv data area
1327 *      within &struct ieee80211_sta.
1328 *
1329 * @max_rates: maximum number of alternate rate retry stages the hw
1330 *      can handle.
1331 * @max_report_rates: maximum number of alternate rate retry stages
1332 *      the hw can report back.
1333 * @max_rate_tries: maximum number of tries for each stage
1334 *
1335 * @napi_weight: weight used for NAPI polling.  You must specify an
1336 *      appropriate value here if a napi_poll operation is provided
1337 *      by your driver.
1338 *
1339 * @max_rx_aggregation_subframes: maximum buffer size (number of
1340 *      sub-frames) to be used for A-MPDU block ack receiver
1341 *      aggregation.
1342 *      This is only relevant if the device has restrictions on the
1343 *      number of subframes, if it relies on mac80211 to do reordering
1344 *      it shouldn't be set.
1345 *
1346 * @max_tx_aggregation_subframes: maximum number of subframes in an
1347 *      aggregate an HT driver will transmit, used by the peer as a
1348 *      hint to size its reorder buffer.
1349 *
1350 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
1351 *      (if %IEEE80211_HW_QUEUE_CONTROL is set)
1352 *
1353 * @radiotap_mcs_details: lists which MCS information can the HW
1354 *      reports, by default it is set to _MCS, _GI and _BW but doesn't
1355 *      include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
1356 *      adding _BW is supported today.
1357 *
1358 * @netdev_features: netdev features to be set in each netdev created
1359 *      from this HW. Note only HW checksum features are currently
1360 *      compatible with mac80211. Other feature bits will be rejected.
1361 */
1362struct ieee80211_hw {
1363        struct ieee80211_conf conf;
1364        struct wiphy *wiphy;
1365        const char *rate_control_algorithm;
1366        void *priv;
1367        u32 flags;
1368        unsigned int extra_tx_headroom;
1369        int channel_change_time;
1370        int vif_data_size;
1371        int sta_data_size;
1372        int napi_weight;
1373        u16 queues;
1374        u16 max_listen_interval;
1375        s8 max_signal;
1376        u8 max_rates;
1377        u8 max_report_rates;
1378        u8 max_rate_tries;
1379        u8 max_rx_aggregation_subframes;
1380        u8 max_tx_aggregation_subframes;
1381        u8 offchannel_tx_hw_queue;
1382        u8 radiotap_mcs_details;
1383        netdev_features_t netdev_features;
1384};
1385
1386/**
1387 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1388 *
1389 * @wiphy: the &struct wiphy which we want to query
1390 *
1391 * mac80211 drivers can use this to get to their respective
1392 * &struct ieee80211_hw. Drivers wishing to get to their own private
1393 * structure can then access it via hw->priv. Note that mac802111 drivers should
1394 * not use wiphy_priv() to try to get their private driver structure as this
1395 * is already used internally by mac80211.
1396 */
1397struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1398
1399/**
1400 * SET_IEEE80211_DEV - set device for 802.11 hardware
1401 *
1402 * @hw: the &struct ieee80211_hw to set the device for
1403 * @dev: the &struct device of this 802.11 device
1404 */
1405static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1406{
1407        set_wiphy_dev(hw->wiphy, dev);
1408}
1409
1410/**
1411 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1412 *
1413 * @hw: the &struct ieee80211_hw to set the MAC address for
1414 * @addr: the address to set
1415 */
1416static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1417{
1418        memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1419}
1420
1421static inline struct ieee80211_rate *
1422ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1423                      const struct ieee80211_tx_info *c)
1424{
1425        if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
1426                return NULL;
1427        return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1428}
1429
1430static inline struct ieee80211_rate *
1431ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1432                           const struct ieee80211_tx_info *c)
1433{
1434        if (c->control.rts_cts_rate_idx < 0)
1435                return NULL;
1436        return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1437}
1438
1439static inline struct ieee80211_rate *
1440ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1441                             const struct ieee80211_tx_info *c, int idx)
1442{
1443        if (c->control.rates[idx + 1].idx < 0)
1444                return NULL;
1445        return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1446}
1447
1448/**
1449 * ieee80211_free_txskb - free TX skb
1450 * @hw: the hardware
1451 * @skb: the skb
1452 *
1453 * Free a transmit skb. Use this funtion when some failure
1454 * to transmit happened and thus status cannot be reported.
1455 */
1456void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
1457
1458/**
1459 * DOC: Hardware crypto acceleration
1460 *
1461 * mac80211 is capable of taking advantage of many hardware
1462 * acceleration designs for encryption and decryption operations.
1463 *
1464 * The set_key() callback in the &struct ieee80211_ops for a given
1465 * device is called to enable hardware acceleration of encryption and
1466 * decryption. The callback takes a @sta parameter that will be NULL
1467 * for default keys or keys used for transmission only, or point to
1468 * the station information for the peer for individual keys.
1469 * Multiple transmission keys with the same key index may be used when
1470 * VLANs are configured for an access point.
1471 *
1472 * When transmitting, the TX control data will use the @hw_key_idx
1473 * selected by the driver by modifying the &struct ieee80211_key_conf
1474 * pointed to by the @key parameter to the set_key() function.
1475 *
1476 * The set_key() call for the %SET_KEY command should return 0 if
1477 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1478 * added; if you return 0 then hw_key_idx must be assigned to the
1479 * hardware key index, you are free to use the full u8 range.
1480 *
1481 * When the cmd is %DISABLE_KEY then it must succeed.
1482 *
1483 * Note that it is permissible to not decrypt a frame even if a key
1484 * for it has been uploaded to hardware, the stack will not make any
1485 * decision based on whether a key has been uploaded or not but rather
1486 * based on the receive flags.
1487 *
1488 * The &struct ieee80211_key_conf structure pointed to by the @key
1489 * parameter is guaranteed to be valid until another call to set_key()
1490 * removes it, but it can only be used as a cookie to differentiate
1491 * keys.
1492 *
1493 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1494 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1495 * handler.
1496 * The update_tkip_key() call updates the driver with the new phase 1 key.
1497 * This happens every time the iv16 wraps around (every 65536 packets). The
1498 * set_key() call will happen only once for each key (unless the AP did
1499 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1500 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1501 * handler is software decryption with wrap around of iv16.
1502 */
1503
1504/**
1505 * DOC: Powersave support
1506 *
1507 * mac80211 has support for various powersave implementations.
1508 *
1509 * First, it can support hardware that handles all powersaving by itself,
1510 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1511 * flag. In that case, it will be told about the desired powersave mode
1512 * with the %IEEE80211_CONF_PS flag depending on the association status.
1513 * The hardware must take care of sending nullfunc frames when necessary,
1514 * i.e. when entering and leaving powersave mode. The hardware is required
1515 * to look at the AID in beacons and signal to the AP that it woke up when
1516 * it finds traffic directed to it.
1517 *
1518 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1519 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1520 * with hardware wakeup and sleep states. Driver is responsible for waking
1521 * up the hardware before issuing commands to the hardware and putting it
1522 * back to sleep at appropriate times.
1523 *
1524 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1525 * buffered multicast/broadcast frames after the beacon. Also it must be
1526 * possible to send frames and receive the acknowledment frame.
1527 *
1528 * Other hardware designs cannot send nullfunc frames by themselves and also
1529 * need software support for parsing the TIM bitmap. This is also supported
1530 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1531 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1532 * required to pass up beacons. The hardware is still required to handle
1533 * waking up for multicast traffic; if it cannot the driver must handle that
1534 * as best as it can, mac80211 is too slow to do that.
1535 *
1536 * Dynamic powersave is an extension to normal powersave in which the
1537 * hardware stays awake for a user-specified period of time after sending a
1538 * frame so that reply frames need not be buffered and therefore delayed to
1539 * the next wakeup. It's compromise of getting good enough latency when
1540 * there's data traffic and still saving significantly power in idle
1541 * periods.
1542 *
1543 * Dynamic powersave is simply supported by mac80211 enabling and disabling
1544 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1545 * flag and mac80211 will handle everything automatically. Additionally,
1546 * hardware having support for the dynamic PS feature may set the
1547 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1548 * dynamic PS mode itself. The driver needs to look at the
1549 * @dynamic_ps_timeout hardware configuration value and use it that value
1550 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1551 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1552 * enabled whenever user has enabled powersave.
1553 *
1554 * Some hardware need to toggle a single shared antenna between WLAN and
1555 * Bluetooth to facilitate co-existence. These types of hardware set
1556 * limitations on the use of host controlled dynamic powersave whenever there
1557 * is simultaneous WLAN and Bluetooth traffic. For these types of hardware, the
1558 * driver may request temporarily going into full power save, in order to
1559 * enable toggling the antenna between BT and WLAN. If the driver requests
1560 * disabling dynamic powersave, the @dynamic_ps_timeout value will be
1561 * temporarily set to zero until the driver re-enables dynamic powersave.
1562 *
1563 * Driver informs U-APSD client support by enabling
1564 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1565 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1566 * Nullfunc frames and stay awake until the service period has ended. To
1567 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1568 * from that AC are transmitted with powersave enabled.
1569 *
1570 * Note: U-APSD client mode is not yet supported with
1571 * %IEEE80211_HW_PS_NULLFUNC_STACK.
1572 */
1573
1574/**
1575 * DOC: Beacon filter support
1576 *
1577 * Some hardware have beacon filter support to reduce host cpu wakeups
1578 * which will reduce system power consumption. It usually works so that
1579 * the firmware creates a checksum of the beacon but omits all constantly
1580 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1581 * beacon is forwarded to the host, otherwise it will be just dropped. That
1582 * way the host will only receive beacons where some relevant information
1583 * (for example ERP protection or WMM settings) have changed.
1584 *
1585 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
1586 * interface capability. The driver needs to enable beacon filter support
1587 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1588 * power save is enabled, the stack will not check for beacon loss and the
1589 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1590 *
1591 * The time (or number of beacons missed) until the firmware notifies the
1592 * driver of a beacon loss event (which in turn causes the driver to call
1593 * ieee80211_beacon_loss()) should be configurable and will be controlled
1594 * by mac80211 and the roaming algorithm in the future.
1595 *
1596 * Since there may be constantly changing information elements that nothing
1597 * in the software stack cares about, we will, in the future, have mac80211
1598 * tell the driver which information elements are interesting in the sense
1599 * that we want to see changes in them. This will include
1600 *  - a list of information element IDs
1601 *  - a list of OUIs for the vendor information element
1602 *
1603 * Ideally, the hardware would filter out any beacons without changes in the
1604 * requested elements, but if it cannot support that it may, at the expense
1605 * of some efficiency, filter out only a subset. For example, if the device
1606 * doesn't support checking for OUIs it should pass up all changes in all
1607 * vendor information elements.
1608 *
1609 * Note that change, for the sake of simplification, also includes information
1610 * elements appearing or disappearing from the beacon.
1611 *
1612 * Some hardware supports an "ignore list" instead, just make sure nothing
1613 * that was requested is on the ignore list, and include commonly changing
1614 * information element IDs in the ignore list, for example 11 (BSS load) and
1615 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1616 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1617 * it could also include some currently unused IDs.
1618 *
1619 *
1620 * In addition to these capabilities, hardware should support notifying the
1621 * host of changes in the beacon RSSI. This is relevant to implement roaming
1622 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1623 * the received data packets). This can consist in notifying the host when
1624 * the RSSI changes significantly or when it drops below or rises above
1625 * configurable thresholds. In the future these thresholds will also be
1626 * configured by mac80211 (which gets them from userspace) to implement
1627 * them as the roaming algorithm requires.
1628 *
1629 * If the hardware cannot implement this, the driver should ask it to
1630 * periodically pass beacon frames to the host so that software can do the
1631 * signal strength threshold checking.
1632 */
1633
1634/**
1635 * DOC: Spatial multiplexing power save
1636 *
1637 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1638 * power in an 802.11n implementation. For details on the mechanism
1639 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1640 * "11.2.3 SM power save".
1641 *
1642 * The mac80211 implementation is capable of sending action frames
1643 * to update the AP about the station's SMPS mode, and will instruct
1644 * the driver to enter the specific mode. It will also announce the
1645 * requested SMPS mode during the association handshake. Hardware
1646 * support for this feature is required, and can be indicated by
1647 * hardware flags.
1648 *
1649 * The default mode will be "automatic", which nl80211/cfg80211
1650 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1651 * turned off otherwise.
1652 *
1653 * To support this feature, the driver must set the appropriate
1654 * hardware support flags, and handle the SMPS flag to the config()
1655 * operation. It will then with this mechanism be instructed to
1656 * enter the requested SMPS mode while associated to an HT AP.
1657 */
1658
1659/**
1660 * DOC: Frame filtering
1661 *
1662 * mac80211 requires to see many management frames for proper
1663 * operation, and users may want to see many more frames when
1664 * in monitor mode. However, for best CPU usage and power consumption,
1665 * having as few frames as possible percolate through the stack is
1666 * desirable. Hence, the hardware should filter as much as possible.
1667 *
1668 * To achieve this, mac80211 uses filter flags (see below) to tell
1669 * the driver's configure_filter() function which frames should be
1670 * passed to mac80211 and which should be filtered out.
1671 *
1672 * Before configure_filter() is invoked, the prepare_multicast()
1673 * callback is invoked with the parameters @mc_count and @mc_list
1674 * for the combined multicast address list of all virtual interfaces.
1675 * It's use is optional, and it returns a u64 that is passed to
1676 * configure_filter(). Additionally, configure_filter() has the
1677 * arguments @changed_flags telling which flags were changed and
1678 * @total_flags with the new flag states.
1679 *
1680 * If your device has no multicast address filters your driver will
1681 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1682 * parameter to see whether multicast frames should be accepted
1683 * or dropped.
1684 *
1685 * All unsupported flags in @total_flags must be cleared.
1686 * Hardware does not support a flag if it is incapable of _passing_
1687 * the frame to the stack. Otherwise the driver must ignore
1688 * the flag, but not clear it.
1689 * You must _only_ clear the flag (announce no support for the
1690 * flag to mac80211) if you are not able to pass the packet type
1691 * to the stack (so the hardware always filters it).
1692 * So for example, you should clear @FIF_CONTROL, if your hardware
1693 * always filters control frames. If your hardware always passes
1694 * control frames to the kernel and is incapable of filtering them,
1695 * you do _not_ clear the @FIF_CONTROL flag.
1696 * This rule applies to all other FIF flags as well.
1697 */
1698
1699/**
1700 * DOC: AP support for powersaving clients
1701 *
1702 * In order to implement AP and P2P GO modes, mac80211 has support for
1703 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
1704 * There currently is no support for sAPSD.
1705 *
1706 * There is one assumption that mac80211 makes, namely that a client
1707 * will not poll with PS-Poll and trigger with uAPSD at the same time.
1708 * Both are supported, and both can be used by the same client, but
1709 * they can't be used concurrently by the same client. This simplifies
1710 * the driver code.
1711 *
1712 * The first thing to keep in mind is that there is a flag for complete
1713 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
1714 * mac80211 expects the driver to handle most of the state machine for
1715 * powersaving clients and will ignore the PM bit in incoming frames.
1716 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
1717 * stations' powersave transitions. In this mode, mac80211 also doesn't
1718 * handle PS-Poll/uAPSD.
1719 *
1720 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
1721 * PM bit in incoming frames for client powersave transitions. When a
1722 * station goes to sleep, we will stop transmitting to it. There is,
1723 * however, a race condition: a station might go to sleep while there is
1724 * data buffered on hardware queues. If the device has support for this
1725 * it will reject frames, and the driver should give the frames back to
1726 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
1727 * cause mac80211 to retry the frame when the station wakes up. The
1728 * driver is also notified of powersave transitions by calling its
1729 * @sta_notify callback.
1730 *
1731 * When the station is asleep, it has three choices: it can wake up,
1732 * it can PS-Poll, or it can possibly start a uAPSD service period.
1733 * Waking up is implemented by simply transmitting all buffered (and
1734 * filtered) frames to the station. This is the easiest case. When
1735 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
1736 * will inform the driver of this with the @allow_buffered_frames
1737 * callback; this callback is optional. mac80211 will then transmit
1738 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
1739 * on each frame. The last frame in the service period (or the only
1740 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
1741 * indicate that it ends the service period; as this frame must have
1742 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
1743 * When TX status is reported for this frame, the service period is
1744 * marked has having ended and a new one can be started by the peer.
1745 *
1746 * Additionally, non-bufferable MMPDUs can also be transmitted by
1747 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
1748 *
1749 * Another race condition can happen on some devices like iwlwifi
1750 * when there are frames queued for the station and it wakes up
1751 * or polls; the frames that are already queued could end up being
1752 * transmitted first instead, causing reordering and/or wrong
1753 * processing of the EOSP. The cause is that allowing frames to be
1754 * transmitted to a certain station is out-of-band communication to
1755 * the device. To allow this problem to be solved, the driver can
1756 * call ieee80211_sta_block_awake() if frames are buffered when it
1757 * is notified that the station went to sleep. When all these frames
1758 * have been filtered (see above), it must call the function again
1759 * to indicate that the station is no longer blocked.
1760 *
1761 * If the driver buffers frames in the driver for aggregation in any
1762 * way, it must use the ieee80211_sta_set_buffered() call when it is
1763 * notified of the station going to sleep to inform mac80211 of any
1764 * TIDs that have frames buffered. Note that when a station wakes up
1765 * this information is reset (hence the requirement to call it when
1766 * informed of the station going to sleep). Then, when a service
1767 * period starts for any reason, @release_buffered_frames is called
1768 * with the number of frames to be released and which TIDs they are
1769 * to come from. In this case, the driver is responsible for setting
1770 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
1771 * to help the @more_data paramter is passed to tell the driver if
1772 * there is more data on other TIDs -- the TIDs to release frames
1773 * from are ignored since mac80211 doesn't know how many frames the
1774 * buffers for those TIDs contain.
1775 *
1776 * If the driver also implement GO mode, where absence periods may
1777 * shorten service periods (or abort PS-Poll responses), it must
1778 * filter those response frames except in the case of frames that
1779 * are buffered in the driver -- those must remain buffered to avoid
1780 * reordering. Because it is possible that no frames are released
1781 * in this case, the driver must call ieee80211_sta_eosp_irqsafe()
1782 * to indicate to mac80211 that the service period ended anyway.
1783 *
1784 * Finally, if frames from multiple TIDs are released from mac80211
1785 * but the driver might reorder them, it must clear & set the flags
1786 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
1787 * and also take care of the EOSP and MORE_DATA bits in the frame.
1788 * The driver may also use ieee80211_sta_eosp_irqsafe() in this case.
1789 */
1790
1791/**
1792 * DOC: HW queue control
1793 *
1794 * Before HW queue control was introduced, mac80211 only had a single static
1795 * assignment of per-interface AC software queues to hardware queues. This
1796 * was problematic for a few reasons:
1797 * 1) off-channel transmissions might get stuck behind other frames
1798 * 2) multiple virtual interfaces couldn't be handled correctly
1799 * 3) after-DTIM frames could get stuck behind other frames
1800 *
1801 * To solve this, hardware typically uses multiple different queues for all
1802 * the different usages, and this needs to be propagated into mac80211 so it
1803 * won't have the same problem with the software queues.
1804 *
1805 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
1806 * flag that tells it that the driver implements its own queue control. To do
1807 * so, the driver will set up the various queues in each &struct ieee80211_vif
1808 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
1809 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
1810 * if necessary will queue the frame on the right software queue that mirrors
1811 * the hardware queue.
1812 * Additionally, the driver has to then use these HW queue IDs for the queue
1813 * management functions (ieee80211_stop_queue() et al.)
1814 *
1815 * The driver is free to set up the queue mappings as needed, multiple virtual
1816 * interfaces may map to the same hardware queues if needed. The setup has to
1817 * happen during add_interface or change_interface callbacks. For example, a
1818 * driver supporting station+station and station+AP modes might decide to have
1819 * 10 hardware queues to handle different scenarios:
1820 *
1821 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
1822 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
1823 * after-DTIM queue for AP:   8
1824 * off-channel queue:         9
1825 *
1826 * It would then set up the hardware like this:
1827 *   hw.offchannel_tx_hw_queue = 9
1828 *
1829 * and the first virtual interface that is added as follows:
1830 *   vif.hw_queue[IEEE80211_AC_VO] = 0
1831 *   vif.hw_queue[IEEE80211_AC_VI] = 1
1832 *   vif.hw_queue[IEEE80211_AC_BE] = 2
1833 *   vif.hw_queue[IEEE80211_AC_BK] = 3
1834 *   vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
1835 * and the second virtual interface with 4-7.
1836 *
1837 * If queue 6 gets full, for example, mac80211 would only stop the second
1838 * virtual interface's BE queue since virtual interface queues are per AC.
1839 *
1840 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
1841 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
1842 * queue could potentially be shared since mac80211 will look at cab_queue when
1843 * a queue is stopped/woken even if the interface is not in AP mode.
1844 */
1845
1846/**
1847 * enum ieee80211_filter_flags - hardware filter flags
1848 *
1849 * These flags determine what the filter in hardware should be
1850 * programmed to let through and what should not be passed to the
1851 * stack. It is always safe to pass more frames than requested,
1852 * but this has negative impact on power consumption.
1853 *
1854 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1855 *      think of the BSS as your network segment and then this corresponds
1856 *      to the regular ethernet device promiscuous mode.
1857 *
1858 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1859 *      by the user or if the hardware is not capable of filtering by
1860 *      multicast address.
1861 *
1862 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1863 *      %RX_FLAG_FAILED_FCS_CRC for them)
1864 *
1865 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1866 *      the %RX_FLAG_FAILED_PLCP_CRC for them
1867 *
1868 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1869 *      to the hardware that it should not filter beacons or probe responses
1870 *      by BSSID. Filtering them can greatly reduce the amount of processing
1871 *      mac80211 needs to do and the amount of CPU wakeups, so you should
1872 *      honour this flag if possible.
1873 *
1874 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
1875 *      is not set then only those addressed to this station.
1876 *
1877 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1878 *
1879 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1880 *      those addressed to this station.
1881 *
1882 * @FIF_PROBE_REQ: pass probe request frames
1883 */
1884enum ieee80211_filter_flags {
1885        FIF_PROMISC_IN_BSS      = 1<<0,
1886        FIF_ALLMULTI            = 1<<1,
1887        FIF_FCSFAIL             = 1<<2,
1888        FIF_PLCPFAIL            = 1<<3,
1889        FIF_BCN_PRBRESP_PROMISC = 1<<4,
1890        FIF_CONTROL             = 1<<5,
1891        FIF_OTHER_BSS           = 1<<6,
1892        FIF_PSPOLL              = 1<<7,
1893        FIF_PROBE_REQ           = 1<<8,
1894};
1895
1896/**
1897 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1898 *
1899 * These flags are used with the ampdu_action() callback in
1900 * &struct ieee80211_ops to indicate which action is needed.
1901 *
1902 * Note that drivers MUST be able to deal with a TX aggregation
1903 * session being stopped even before they OK'ed starting it by
1904 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
1905 * might receive the addBA frame and send a delBA right away!
1906 *
1907 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1908 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1909 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1910 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1911 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
1912 */
1913enum ieee80211_ampdu_mlme_action {
1914        IEEE80211_AMPDU_RX_START,
1915        IEEE80211_AMPDU_RX_STOP,
1916        IEEE80211_AMPDU_TX_START,
1917        IEEE80211_AMPDU_TX_STOP,
1918        IEEE80211_AMPDU_TX_OPERATIONAL,
1919};
1920
1921/**
1922 * enum ieee80211_frame_release_type - frame release reason
1923 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
1924 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
1925 *      frame received on trigger-enabled AC
1926 */
1927enum ieee80211_frame_release_type {
1928        IEEE80211_FRAME_RELEASE_PSPOLL,
1929        IEEE80211_FRAME_RELEASE_UAPSD,
1930};
1931
1932/**
1933 * enum ieee80211_rate_control_changed - flags to indicate what changed
1934 *
1935 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
1936 *      to this station changed.
1937 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
1938 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
1939 *      changed (in IBSS mode) due to discovering more information about
1940 *      the peer.
1941 */
1942enum ieee80211_rate_control_changed {
1943        IEEE80211_RC_BW_CHANGED         = BIT(0),
1944        IEEE80211_RC_SMPS_CHANGED       = BIT(1),
1945        IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
1946};
1947
1948/**
1949 * struct ieee80211_ops - callbacks from mac80211 to the driver
1950 *
1951 * This structure contains various callbacks that the driver may
1952 * handle or, in some cases, must handle, for example to configure
1953 * the hardware to a new channel or to transmit a frame.
1954 *
1955 * @tx: Handler that 802.11 module calls for each transmitted frame.
1956 *      skb contains the buffer starting from the IEEE 802.11 header.
1957 *      The low-level driver should send the frame out based on
1958 *      configuration in the TX control data. This handler should,
1959 *      preferably, never fail and stop queues appropriately.
1960 *      Must be atomic.
1961 *
1962 * @start: Called before the first netdevice attached to the hardware
1963 *      is enabled. This should turn on the hardware and must turn on
1964 *      frame reception (for possibly enabled monitor interfaces.)
1965 *      Returns negative error codes, these may be seen in userspace,
1966 *      or zero.
1967 *      When the device is started it should not have a MAC address
1968 *      to avoid acknowledging frames before a non-monitor device
1969 *      is added.
1970 *      Must be implemented and can sleep.
1971 *
1972 * @stop: Called after last netdevice attached to the hardware
1973 *      is disabled. This should turn off the hardware (at least
1974 *      it must turn off frame reception.)
1975 *      May be called right after add_interface if that rejects
1976 *      an interface. If you added any work onto the mac80211 workqueue
1977 *      you should ensure to cancel it on this callback.
1978 *      Must be implemented and can sleep.
1979 *
1980 * @suspend: Suspend the device; mac80211 itself will quiesce before and
1981 *      stop transmitting and doing any other configuration, and then
1982 *      ask the device to suspend. This is only invoked when WoWLAN is
1983 *      configured, otherwise the device is deconfigured completely and
1984 *      reconfigured at resume time.
1985 *      The driver may also impose special conditions under which it
1986 *      wants to use the "normal" suspend (deconfigure), say if it only
1987 *      supports WoWLAN when the device is associated. In this case, it
1988 *      must return 1 from this function.
1989 *
1990 * @resume: If WoWLAN was configured, this indicates that mac80211 is
1991 *      now resuming its operation, after this the device must be fully
1992 *      functional again. If this returns an error, the only way out is
1993 *      to also unregister the device. If it returns 1, then mac80211
1994 *      will also go through the regular complete restart on resume.
1995 *
1996 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
1997 *      modified. The reason is that device_set_wakeup_enable() is
1998 *      supposed to be called when the configuration changes, not only
1999 *      in suspend().
2000 *
2001 * @add_interface: Called when a netdevice attached to the hardware is
2002 *      enabled. Because it is not called for monitor mode devices, @start
2003 *      and @stop must be implemented.
2004 *      The driver should perform any initialization it needs before
2005 *      the device can be enabled. The initial configuration for the
2006 *      interface is given in the conf parameter.
2007 *      The callback may refuse to add an interface by returning a
2008 *      negative error code (which will be seen in userspace.)
2009 *      Must be implemented and can sleep.
2010 *
2011 * @change_interface: Called when a netdevice changes type. This callback
2012 *      is optional, but only if it is supported can interface types be
2013 *      switched while the interface is UP. The callback may sleep.
2014 *      Note that while an interface is being switched, it will not be
2015 *      found by the interface iteration callbacks.
2016 *
2017 * @remove_interface: Notifies a driver that an interface is going down.
2018 *      The @stop callback is called after this if it is the last interface
2019 *      and no monitor interfaces are present.
2020 *      When all interfaces are removed, the MAC address in the hardware
2021 *      must be cleared so the device no longer acknowledges packets,
2022 *      the mac_addr member of the conf structure is, however, set to the
2023 *      MAC address of the device going away.
2024 *      Hence, this callback must be implemented. It can sleep.
2025 *
2026 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2027 *      function to change hardware configuration, e.g., channel.
2028 *      This function should never fail but returns a negative error code
2029 *      if it does. The callback can sleep.
2030 *
2031 * @bss_info_changed: Handler for configuration requests related to BSS
2032 *      parameters that may vary during BSS's lifespan, and may affect low
2033 *      level driver (e.g. assoc/disassoc status, erp parameters).
2034 *      This function should not be used if no BSS has been set, unless
2035 *      for association indication. The @changed parameter indicates which
2036 *      of the bss parameters has changed when a call is made. The callback
2037 *      can sleep.
2038 *
2039 * @prepare_multicast: Prepare for multicast filter configuration.
2040 *      This callback is optional, and its return value is passed
2041 *      to configure_filter(). This callback must be atomic.
2042 *
2043 * @configure_filter: Configure the device's RX filter.
2044 *      See the section "Frame filtering" for more information.
2045 *      This callback must be implemented and can sleep.
2046 *
2047 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
2048 *      must be set or cleared for a given STA. Must be atomic.
2049 *
2050 * @set_key: See the section "Hardware crypto acceleration"
2051 *      This callback is only called between add_interface and
2052 *      remove_interface calls, i.e. while the given virtual interface
2053 *      is enabled.
2054 *      Returns a negative error code if the key can't be added.
2055 *      The callback can sleep.
2056 *
2057 * @update_tkip_key: See the section "Hardware crypto acceleration"
2058 *      This callback will be called in the context of Rx. Called for drivers
2059 *      which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
2060 *      The callback must be atomic.
2061 *
2062 * @set_rekey_data: If the device supports GTK rekeying, for example while the
2063 *      host is suspended, it can assign this callback to retrieve the data
2064 *      necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2065 *      After rekeying was done it should (for example during resume) notify
2066 *      userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2067 *
2068 * @hw_scan: Ask the hardware to service the scan request, no need to start
2069 *      the scan state machine in stack. The scan must honour the channel
2070 *      configuration done by the regulatory agent in the wiphy's
2071 *      registered bands. The hardware (or the driver) needs to make sure
2072 *      that power save is disabled.
2073 *      The @req ie/ie_len members are rewritten by mac80211 to contain the
2074 *      entire IEs after the SSID, so that drivers need not look at these
2075 *      at all but just send them after the SSID -- mac80211 includes the
2076 *      (extended) supported rates and HT information (where applicable).
2077 *      When the scan finishes, ieee80211_scan_completed() must be called;
2078 *      note that it also must be called when the scan cannot finish due to
2079 *      any error unless this callback returned a negative error code.
2080 *      The callback can sleep.
2081 *
2082 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2083 *      The driver should ask the hardware to cancel the scan (if possible),
2084 *      but the scan will be completed only after the driver will call
2085 *      ieee80211_scan_completed().
2086 *      This callback is needed for wowlan, to prevent enqueueing a new
2087 *      scan_work after the low-level driver was already suspended.
2088 *      The callback can sleep.
2089 *
2090 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2091 *      specific intervals.  The driver must call the
2092 *      ieee80211_sched_scan_results() function whenever it finds results.
2093 *      This process will continue until sched_scan_stop is called.
2094 *
2095 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
2096 *
2097 * @sw_scan_start: Notifier function that is called just before a software scan
2098 *      is started. Can be NULL, if the driver doesn't need this notification.
2099 *      The callback can sleep.
2100 *
2101 * @sw_scan_complete: Notifier function that is called just after a
2102 *      software scan finished. Can be NULL, if the driver doesn't need
2103 *      this notification.
2104 *      The callback can sleep.
2105 *
2106 * @get_stats: Return low-level statistics.
2107 *      Returns zero if statistics are available.
2108 *      The callback can sleep.
2109 *
2110 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
2111 *      callback should be provided to read the TKIP transmit IVs (both IV32
2112 *      and IV16) for the given key from hardware.
2113 *      The callback must be atomic.
2114 *
2115 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
2116 *      if the device does fragmentation by itself; if this callback is
2117 *      implemented then the stack will not do fragmentation.
2118 *      The callback can sleep.
2119 *
2120 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
2121 *      The callback can sleep.
2122 *
2123 * @sta_add: Notifies low level driver about addition of an associated station,
2124 *      AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2125 *
2126 * @sta_remove: Notifies low level driver about removal of an associated
2127 *      station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2128 *
2129 * @sta_notify: Notifies low level driver about power state transition of an
2130 *      associated station, AP,  IBSS/WDS/mesh peer etc. For a VIF operating
2131 *      in AP mode, this callback will not be called when the flag
2132 *      %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
2133 *
2134 * @sta_state: Notifies low level driver about state transition of a
2135 *      station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
2136 *      This callback is mutually exclusive with @sta_add/@sta_remove.
2137 *      It must not fail for down transitions but may fail for transitions
2138 *      up the list of states.
2139 *      The callback can sleep.
2140 *
2141 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
2142 *      used to transmit to the station. The changes are advertised with bits
2143 *      from &enum ieee80211_rate_control_changed and the values are reflected
2144 *      in the station data. This callback should only be used when the driver
2145 *      uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
2146 *      otherwise the rate control algorithm is notified directly.
2147 *      Must be atomic.
2148 *
2149 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
2150 *      bursting) for a hardware TX queue.
2151 *      Returns a negative error code on failure.
2152 *      The callback can sleep.
2153 *
2154 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
2155 *      this is only used for IBSS mode BSSID merging and debugging. Is not a
2156 *      required function.
2157 *      The callback can sleep.
2158 *
2159 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
2160 *      Currently, this is only used for IBSS mode debugging. Is not a
2161 *      required function.
2162 *      The callback can sleep.
2163 *
2164 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
2165 *      with other STAs in the IBSS. This is only used in IBSS mode. This
2166 *      function is optional if the firmware/hardware takes full care of
2167 *      TSF synchronization.
2168 *      The callback can sleep.
2169 *
2170 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
2171 *      This is needed only for IBSS mode and the result of this function is
2172 *      used to determine whether to reply to Probe Requests.
2173 *      Returns non-zero if this device sent the last beacon.
2174 *      The callback can sleep.
2175 *
2176 * @ampdu_action: Perform a certain A-MPDU action
2177 *      The RA/TID combination determines the destination and TID we want
2178 *      the ampdu action to be performed for. The action is defined through
2179 *      ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
2180 *      is the first frame we expect to perform the action on. Notice
2181 *      that TX/RX_STOP can pass NULL for this parameter.
2182 *      The @buf_size parameter is only valid when the action is set to
2183 *      %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
2184 *      buffer size (number of subframes) for this session -- the driver
2185 *      may neither send aggregates containing more subframes than this
2186 *      nor send aggregates in a way that lost frames would exceed the
2187 *      buffer size. If just limiting the aggregate size, this would be
2188 *      possible with a buf_size of 8:
2189 *       - TX: 1.....7
2190 *       - RX:  2....7 (lost frame #1)
2191 *       - TX:        8..1...
2192 *      which is invalid since #1 was now re-transmitted well past the
2193 *      buffer size of 8. Correct ways to retransmit #1 would be:
2194 *       - TX:       1 or 18 or 81
2195 *      Even "189" would be wrong since 1 could be lost again.
2196 *
2197 *      Returns a negative error code on failure.
2198 *      The callback can sleep.
2199 *
2200 * @get_survey: Return per-channel survey information
2201 *
2202 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
2203 *      need to set wiphy->rfkill_poll to %true before registration,
2204 *      and need to call wiphy_rfkill_set_hw_state() in the callback.
2205 *      The callback can sleep.
2206 *
2207 * @set_coverage_class: Set slot time for given coverage class as specified
2208 *      in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
2209 *      accordingly. This callback is not required and may sleep.
2210 *
2211 * @testmode_cmd: Implement a cfg80211 test mode command.
2212 *      The callback can sleep.
2213 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
2214 *
2215 * @flush: Flush all pending frames from the hardware queue, making sure
2216 *      that the hardware queues are empty. If the parameter @drop is set
2217 *      to %true, pending frames may be dropped. The callback can sleep.
2218 *
2219 * @channel_switch: Drivers that need (or want) to offload the channel
2220 *      switch operation for CSAs received from the AP may implement this
2221 *      callback. They must then call ieee80211_chswitch_done() to indicate
2222 *      completion of the channel switch.
2223 *
2224 * @napi_poll: Poll Rx queue for incoming data frames.
2225 *
2226 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2227 *      Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2228 *      reject TX/RX mask combinations they cannot support by returning -EINVAL
2229 *      (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2230 *
2231 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2232 *
2233 * @remain_on_channel: Starts an off-channel period on the given channel, must
2234 *      call back to ieee80211_ready_on_channel() when on that channel. Note
2235 *      that normal channel traffic is not stopped as this is intended for hw
2236 *      offload. Frames to transmit on the off-channel channel are transmitted
2237 *      normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
2238 *      duration (which will always be non-zero) expires, the driver must call
2239 *      ieee80211_remain_on_channel_expired().
2240 *      Note that this callback may be called while the device is in IDLE and
2241 *      must be accepted in this case.
2242 *      This callback may sleep.
2243 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
2244 *      aborted before it expires. This callback may sleep.
2245 *
2246 * @set_ringparam: Set tx and rx ring sizes.
2247 *
2248 * @get_ringparam: Get tx and rx ring current and maximum sizes.
2249 *
2250 * @tx_frames_pending: Check if there is any pending frame in the hardware
2251 *      queues before entering power save.
2252 *
2253 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
2254 *      when transmitting a frame. Currently only legacy rates are handled.
2255 *      The callback can sleep.
2256 * @rssi_callback: Notify driver when the average RSSI goes above/below
2257 *      thresholds that were registered previously. The callback can sleep.
2258 *
2259 * @release_buffered_frames: Release buffered frames according to the given
2260 *      parameters. In the case where the driver buffers some frames for
2261 *      sleeping stations mac80211 will use this callback to tell the driver
2262 *      to release some frames, either for PS-poll or uAPSD.
2263 *      Note that if the @more_data paramter is %false the driver must check
2264 *      if there are more frames on the given TIDs, and if there are more than
2265 *      the frames being released then it must still set the more-data bit in
2266 *      the frame. If the @more_data parameter is %true, then of course the
2267 *      more-data bit must always be set.
2268 *      The @tids parameter tells the driver which TIDs to release frames
2269 *      from, for PS-poll it will always have only a single bit set.
2270 *      In the case this is used for a PS-poll initiated release, the
2271 *      @num_frames parameter will always be 1 so code can be shared. In
2272 *      this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
2273 *      on the TX status (and must report TX status) so that the PS-poll
2274 *      period is properly ended. This is used to avoid sending multiple
2275 *      responses for a retried PS-poll frame.
2276 *      In the case this is used for uAPSD, the @num_frames parameter may be
2277 *      bigger than one, but the driver may send fewer frames (it must send
2278 *      at least one, however). In this case it is also responsible for
2279 *      setting the EOSP flag in the QoS header of the frames. Also, when the
2280 *      service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
2281 *      on the last frame in the SP. Alternatively, it may call the function
2282 *      ieee80211_sta_eosp_irqsafe() to inform mac80211 of the end of the SP.
2283 *      This callback must be atomic.
2284 * @allow_buffered_frames: Prepare device to allow the given number of frames
2285 *      to go out to the given station. The frames will be sent by mac80211
2286 *      via the usual TX path after this call. The TX information for frames
2287 *      released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
2288 *      and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
2289 *      frames from multiple TIDs are released and the driver might reorder
2290 *      them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
2291 *      on the last frame and clear it on all others and also handle the EOSP
2292 *      bit in the QoS header correctly. Alternatively, it can also call the
2293 *      ieee80211_sta_eosp_irqsafe() function.
2294 *      The @tids parameter is a bitmap and tells the driver which TIDs the
2295 *      frames will be on; it will at most have two bits set.
2296 *      This callback must be atomic.
2297 *
2298 * @get_et_sset_count:  Ethtool API to get string-set count.
2299 *
2300 * @get_et_stats:  Ethtool API to get a set of u64 stats.
2301 *
2302 * @get_et_strings:  Ethtool API to get a set of strings to describe stats
2303 *      and perhaps other supported types of ethtool data-sets.
2304 *
2305 * @get_rssi: Get current signal strength in dBm, the function is optional
2306 *      and can sleep.
2307 *
2308 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
2309 *      before associated. In multi-channel scenarios, a virtual interface is
2310 *      bound to a channel before it is associated, but as it isn't associated
2311 *      yet it need not necessarily be given airtime, in particular since any
2312 *      transmission to a P2P GO needs to be synchronized against the GO's
2313 *      powersave state. mac80211 will call this function before transmitting a
2314 *      management frame prior to having successfully associated to allow the
2315 *      driver to give it channel time for the transmission, to get a response
2316 *      and to be able to synchronize with the GO.
2317 *      The callback will be called before each transmission and upon return
2318 *      mac80211 will transmit the frame right away.
2319 *      The callback is optional and can (should!) sleep.
2320 */
2321struct ieee80211_ops {
2322        void (*tx)(struct ieee80211_hw *hw,
2323                   struct ieee80211_tx_control *control,
2324                   struct sk_buff *skb);
2325        int (*start)(struct ieee80211_hw *hw);
2326        void (*stop)(struct ieee80211_hw *hw);
2327#ifdef CONFIG_PM
2328        int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
2329        int (*resume)(struct ieee80211_hw *hw);
2330        void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
2331#endif
2332        int (*add_interface)(struct ieee80211_hw *hw,
2333                             struct ieee80211_vif *vif);
2334        int (*change_interface)(struct ieee80211_hw *hw,
2335                                struct ieee80211_vif *vif,
2336                                enum nl80211_iftype new_type, bool p2p);
2337        void (*remove_interface)(struct ieee80211_hw *hw,
2338                                 struct ieee80211_vif *vif);
2339        int (*config)(struct ieee80211_hw *hw, u32 changed);
2340        void (*bss_info_changed)(struct ieee80211_hw *hw,
2341                                 struct ieee80211_vif *vif,
2342                                 struct ieee80211_bss_conf *info,
2343                                 u32 changed);
2344
2345        u64 (*prepare_multicast)(struct ieee80211_hw *hw,
2346                                 struct netdev_hw_addr_list *mc_list);
2347        void (*configure_filter)(struct ieee80211_hw *hw,
2348                                 unsigned int changed_flags,
2349                                 unsigned int *total_flags,
2350                                 u64 multicast);
2351        int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
2352                       bool set);
2353        int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
2354                       struct ieee80211_vif *vif, struct ieee80211_sta *sta,
2355                       struct ieee80211_key_conf *key);
2356        void (*update_tkip_key)(struct ieee80211_hw *hw,
2357                                struct ieee80211_vif *vif,
2358                                struct ieee80211_key_conf *conf,
2359                                struct ieee80211_sta *sta,
2360                                u32 iv32, u16 *phase1key);
2361        void (*set_rekey_data)(struct ieee80211_hw *hw,
2362                               struct ieee80211_vif *vif,
2363                               struct cfg80211_gtk_rekey_data *data);
2364        int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2365                       struct cfg80211_scan_request *req);
2366        void (*cancel_hw_scan)(struct ieee80211_hw *hw,
2367                               struct ieee80211_vif *vif);
2368        int (*sched_scan_start)(struct ieee80211_hw *hw,
2369                                struct ieee80211_vif *vif,
2370                                struct cfg80211_sched_scan_request *req,
2371                                struct ieee80211_sched_scan_ies *ies);
2372        void (*sched_scan_stop)(struct ieee80211_hw *hw,
2373                               struct ieee80211_vif *vif);
2374        void (*sw_scan_start)(struct ieee80211_hw *hw);
2375        void (*sw_scan_complete)(struct ieee80211_hw *hw);
2376        int (*get_stats)(struct ieee80211_hw *hw,
2377                         struct ieee80211_low_level_stats *stats);
2378        void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
2379                             u32 *iv32, u16 *iv16);
2380        int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
2381        int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
2382        int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2383                       struct ieee80211_sta *sta);
2384        int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2385                          struct ieee80211_sta *sta);
2386        void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2387                        enum sta_notify_cmd, struct ieee80211_sta *sta);
2388        int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2389                         struct ieee80211_sta *sta,
2390                         enum ieee80211_sta_state old_state,
2391                         enum ieee80211_sta_state new_state);
2392        void (*sta_rc_update)(struct ieee80211_hw *hw,
2393                              struct ieee80211_vif *vif,
2394                              struct ieee80211_sta *sta,
2395                              u32 changed);
2396        int (*conf_tx)(struct ieee80211_hw *hw,
2397                       struct ieee80211_vif *vif, u16 ac,
2398                       const struct ieee80211_tx_queue_params *params);
2399        u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2400        void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2401                        u64 tsf);
2402        void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2403        int (*tx_last_beacon)(struct ieee80211_hw *hw);
2404        int (*ampdu_action)(struct ieee80211_hw *hw,
2405                            struct ieee80211_vif *vif,
2406                            enum ieee80211_ampdu_mlme_action action,
2407                            struct ieee80211_sta *sta, u16 tid, u16 *ssn,
2408                            u8 buf_size);
2409        int (*get_survey)(struct ieee80211_hw *hw, int idx,
2410                struct survey_info *survey);
2411        void (*rfkill_poll)(struct ieee80211_hw *hw);
2412        void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
2413#ifdef CONFIG_NL80211_TESTMODE
2414        int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
2415        int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
2416                             struct netlink_callback *cb,
2417                             void *data, int len);
2418#endif
2419        void (*flush)(struct ieee80211_hw *hw, bool drop);
2420        void (*channel_switch)(struct ieee80211_hw *hw,
2421                               struct ieee80211_channel_switch *ch_switch);
2422        int (*napi_poll)(struct ieee80211_hw *hw, int budget);
2423        int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
2424        int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
2425
2426        int (*remain_on_channel)(struct ieee80211_hw *hw,
2427                                 struct ieee80211_channel *chan,
2428                                 enum nl80211_channel_type channel_type,
2429                                 int duration);
2430        int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
2431        int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
2432        void (*get_ringparam)(struct ieee80211_hw *hw,
2433                              u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
2434        bool (*tx_frames_pending)(struct ieee80211_hw *hw);
2435        int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2436                                const struct cfg80211_bitrate_mask *mask);
2437        void (*rssi_callback)(struct ieee80211_hw *hw,
2438                              enum ieee80211_rssi_event rssi_event);
2439
2440        void (*allow_buffered_frames)(struct ieee80211_hw *hw,
2441                                      struct ieee80211_sta *sta,
2442                                      u16 tids, int num_frames,
2443                                      enum ieee80211_frame_release_type reason,
2444                                      bool more_data);
2445        void (*release_buffered_frames)(struct ieee80211_hw *hw,
2446                                        struct ieee80211_sta *sta,
2447                                        u16 tids, int num_frames,
2448                                        enum ieee80211_frame_release_type reason,
2449                                        bool more_data);
2450
2451        int     (*get_et_sset_count)(struct ieee80211_hw *hw,
2452                                     struct ieee80211_vif *vif, int sset);
2453        void    (*get_et_stats)(struct ieee80211_hw *hw,
2454                                struct ieee80211_vif *vif,
2455                                struct ethtool_stats *stats, u64 *data);
2456        void    (*get_et_strings)(struct ieee80211_hw *hw,
2457                                  struct ieee80211_vif *vif,
2458                                  u32 sset, u8 *data);
2459        int     (*get_rssi)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2460                            struct ieee80211_sta *sta, s8 *rssi_dbm);
2461
2462        void    (*mgd_prepare_tx)(struct ieee80211_hw *hw,
2463                                  struct ieee80211_vif *vif);
2464};
2465
2466/**
2467 * ieee80211_alloc_hw -  Allocate a new hardware device
2468 *
2469 * This must be called once for each hardware device. The returned pointer
2470 * must be used to refer to this device when calling other functions.
2471 * mac80211 allocates a private data area for the driver pointed to by
2472 * @priv in &struct ieee80211_hw, the size of this area is given as
2473 * @priv_data_len.
2474 *
2475 * @priv_data_len: length of private data
2476 * @ops: callbacks for this device
2477 */
2478struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
2479                                        const struct ieee80211_ops *ops);
2480
2481/**
2482 * ieee80211_register_hw - Register hardware device
2483 *
2484 * You must call this function before any other functions in
2485 * mac80211. Note that before a hardware can be registered, you
2486 * need to fill the contained wiphy's information.
2487 *
2488 * @hw: the device to register as returned by ieee80211_alloc_hw()
2489 */
2490int ieee80211_register_hw(struct ieee80211_hw *hw);
2491
2492/**
2493 * struct ieee80211_tpt_blink - throughput blink description
2494 * @throughput: throughput in Kbit/sec
2495 * @blink_time: blink time in milliseconds
2496 *      (full cycle, ie. one off + one on period)
2497 */
2498struct ieee80211_tpt_blink {
2499        int throughput;
2500        int blink_time;
2501};
2502
2503/**
2504 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
2505 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
2506 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
2507 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
2508 *      interface is connected in some way, including being an AP
2509 */
2510enum ieee80211_tpt_led_trigger_flags {
2511        IEEE80211_TPT_LEDTRIG_FL_RADIO          = BIT(0),
2512        IEEE80211_TPT_LEDTRIG_FL_WORK           = BIT(1),
2513        IEEE80211_TPT_LEDTRIG_FL_CONNECTED      = BIT(2),
2514};
2515
2516#ifdef CONFIG_MAC80211_LEDS
2517extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
2518extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
2519extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
2520extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
2521extern char *__ieee80211_create_tpt_led_trigger(
2522                                struct ieee80211_hw *hw, unsigned int flags,
2523                                const struct ieee80211_tpt_blink *blink_table,
2524                                unsigned int blink_table_len);
2525#endif
2526/**
2527 * ieee80211_get_tx_led_name - get name of TX LED
2528 *
2529 * mac80211 creates a transmit LED trigger for each wireless hardware
2530 * that can be used to drive LEDs if your driver registers a LED device.
2531 * This function returns the name (or %NULL if not configured for LEDs)
2532 * of the trigger so you can automatically link the LED device.
2533 *
2534 * @hw: the hardware to get the LED trigger name for
2535 */
2536static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
2537{
2538#ifdef CONFIG_MAC80211_LEDS
2539        return __ieee80211_get_tx_led_name(hw);
2540#else
2541        return NULL;
2542#endif
2543}
2544
2545/**
2546 * ieee80211_get_rx_led_name - get name of RX LED
2547 *
2548 * mac80211 creates a receive LED trigger for each wireless hardware
2549 * that can be used to drive LEDs if your driver registers a LED device.
2550 * This function returns the name (or %NULL if not configured for LEDs)
2551 * of the trigger so you can automatically link the LED device.
2552 *
2553 * @hw: the hardware to get the LED trigger name for
2554 */
2555static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
2556{
2557#ifdef CONFIG_MAC80211_LEDS
2558        return __ieee80211_get_rx_led_name(hw);
2559#else
2560        return NULL;
2561#endif
2562}
2563
2564/**
2565 * ieee80211_get_assoc_led_name - get name of association LED
2566 *
2567 * mac80211 creates a association LED trigger for each wireless hardware
2568 * that can be used to drive LEDs if your driver registers a LED device.
2569 * This function returns the name (or %NULL if not configured for LEDs)
2570 * of the trigger so you can automatically link the LED device.
2571 *
2572 * @hw: the hardware to get the LED trigger name for
2573 */
2574static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
2575{
2576#ifdef CONFIG_MAC80211_LEDS
2577        return __ieee80211_get_assoc_led_name(hw);
2578#else
2579        return NULL;
2580#endif
2581}
2582
2583/**
2584 * ieee80211_get_radio_led_name - get name of radio LED
2585 *
2586 * mac80211 creates a radio change LED trigger for each wireless hardware
2587 * that can be used to drive LEDs if your driver registers a LED device.
2588 * This function returns the name (or %NULL if not configured for LEDs)
2589 * of the trigger so you can automatically link the LED device.
2590 *
2591 * @hw: the hardware to get the LED trigger name for
2592 */
2593static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
2594{
2595#ifdef CONFIG_MAC80211_LEDS
2596        return __ieee80211_get_radio_led_name(hw);
2597#else
2598        return NULL;
2599#endif
2600}
2601
2602/**
2603 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
2604 * @hw: the hardware to create the trigger for
2605 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
2606 * @blink_table: the blink table -- needs to be ordered by throughput
2607 * @blink_table_len: size of the blink table
2608 *
2609 * This function returns %NULL (in case of error, or if no LED
2610 * triggers are configured) or the name of the new trigger.
2611 * This function must be called before ieee80211_register_hw().
2612 */
2613static inline char *
2614ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
2615                                 const struct ieee80211_tpt_blink *blink_table,
2616                                 unsigned int blink_table_len)
2617{
2618#ifdef CONFIG_MAC80211_LEDS
2619        return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
2620                                                  blink_table_len);
2621#else
2622        return NULL;
2623#endif
2624}
2625
2626/**
2627 * ieee80211_unregister_hw - Unregister a hardware device
2628 *
2629 * This function instructs mac80211 to free allocated resources
2630 * and unregister netdevices from the networking subsystem.
2631 *
2632 * @hw: the hardware to unregister
2633 */
2634void ieee80211_unregister_hw(struct ieee80211_hw *hw);
2635
2636/**
2637 * ieee80211_free_hw - free hardware descriptor
2638 *
2639 * This function frees everything that was allocated, including the
2640 * private data for the driver. You must call ieee80211_unregister_hw()
2641 * before calling this function.
2642 *
2643 * @hw: the hardware to free
2644 */
2645void ieee80211_free_hw(struct ieee80211_hw *hw);
2646
2647/**
2648 * ieee80211_restart_hw - restart hardware completely
2649 *
2650 * Call this function when the hardware was restarted for some reason
2651 * (hardware error, ...) and the driver is unable to restore its state
2652 * by itself. mac80211 assumes that at this point the driver/hardware
2653 * is completely uninitialised and stopped, it starts the process by
2654 * calling the ->start() operation. The driver will need to reset all
2655 * internal state that it has prior to calling this function.
2656 *
2657 * @hw: the hardware to restart
2658 */
2659void ieee80211_restart_hw(struct ieee80211_hw *hw);
2660
2661/** ieee80211_napi_schedule - schedule NAPI poll
2662 *
2663 * Use this function to schedule NAPI polling on a device.
2664 *
2665 * @hw: the hardware to start polling
2666 */
2667void ieee80211_napi_schedule(struct ieee80211_hw *hw);
2668
2669/** ieee80211_napi_complete - complete NAPI polling
2670 *
2671 * Use this function to finish NAPI polling on a device.
2672 *
2673 * @hw: the hardware to stop polling
2674 */
2675void ieee80211_napi_complete(struct ieee80211_hw *hw);
2676
2677/**
2678 * ieee80211_rx - receive frame
2679 *
2680 * Use this function to hand received frames to mac80211. The receive
2681 * buffer in @skb must start with an IEEE 802.11 header. In case of a
2682 * paged @skb is used, the driver is recommended to put the ieee80211
2683 * header of the frame on the linear part of the @skb to avoid memory
2684 * allocation and/or memcpy by the stack.
2685 *
2686 * This function may not be called in IRQ context. Calls to this function
2687 * for a single hardware must be synchronized against each other. Calls to
2688 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
2689 * mixed for a single hardware.
2690 *
2691 * In process context use instead ieee80211_rx_ni().
2692 *
2693 * @hw: the hardware this frame came in on
2694 * @skb: the buffer to receive, owned by mac80211 after this call
2695 */
2696void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
2697
2698/**
2699 * ieee80211_rx_irqsafe - receive frame
2700 *
2701 * Like ieee80211_rx() but can be called in IRQ context
2702 * (internally defers to a tasklet.)
2703 *
2704 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
2705 * be mixed for a single hardware.
2706 *
2707 * @hw: the hardware this frame came in on
2708 * @skb: the buffer to receive, owned by mac80211 after this call
2709 */
2710void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
2711
2712/**
2713 * ieee80211_rx_ni - receive frame (in process context)
2714 *
2715 * Like ieee80211_rx() but can be called in process context
2716 * (internally disables bottom halves).
2717 *
2718 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
2719 * not be mixed for a single hardware.
2720 *
2721 * @hw: the hardware this frame came in on
2722 * @skb: the buffer to receive, owned by mac80211 after this call
2723 */
2724static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
2725                                   struct sk_buff *skb)
2726{
2727        local_bh_disable();
2728        ieee80211_rx(hw, skb);
2729        local_bh_enable();
2730}
2731
2732/**
2733 * ieee80211_sta_ps_transition - PS transition for connected sta
2734 *
2735 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
2736 * flag set, use this function to inform mac80211 about a connected station
2737 * entering/leaving PS mode.
2738 *
2739 * This function may not be called in IRQ context or with softirqs enabled.
2740 *
2741 * Calls to this function for a single hardware must be synchronized against
2742 * each other.
2743 *
2744 * The function returns -EINVAL when the requested PS mode is already set.
2745 *
2746 * @sta: currently connected sta
2747 * @start: start or stop PS
2748 */
2749int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
2750
2751/**
2752 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
2753 *                                  (in process context)
2754 *
2755 * Like ieee80211_sta_ps_transition() but can be called in process context
2756 * (internally disables bottom halves). Concurrent call restriction still
2757 * applies.
2758 *
2759 * @sta: currently connected sta
2760 * @start: start or stop PS
2761 */
2762static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
2763                                                  bool start)
2764{
2765        int ret;
2766
2767        local_bh_disable();
2768        ret = ieee80211_sta_ps_transition(sta, start);
2769        local_bh_enable();
2770
2771        return ret;
2772}
2773
2774/*
2775 * The TX headroom reserved by mac80211 for its own tx_status functions.
2776 * This is enough for the radiotap header.
2777 */
2778#define IEEE80211_TX_STATUS_HEADROOM    14
2779
2780/**
2781 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
2782 * @sta: &struct ieee80211_sta pointer for the sleeping station
2783 * @tid: the TID that has buffered frames
2784 * @buffered: indicates whether or not frames are buffered for this TID
2785 *
2786 * If a driver buffers frames for a powersave station instead of passing
2787 * them back to mac80211 for retransmission, the station may still need
2788 * to be told that there are buffered frames via the TIM bit.
2789 *
2790 * This function informs mac80211 whether or not there are frames that are
2791 * buffered in the driver for a given TID; mac80211 can then use this data
2792 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
2793 * call! Beware of the locking!)
2794 *
2795 * If all frames are released to the station (due to PS-poll or uAPSD)
2796 * then the driver needs to inform mac80211 that there no longer are
2797 * frames buffered. However, when the station wakes up mac80211 assumes
2798 * that all buffered frames will be transmitted and clears this data,
2799 * drivers need to make sure they inform mac80211 about all buffered
2800 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
2801 *
2802 * Note that technically mac80211 only needs to know this per AC, not per
2803 * TID, but since driver buffering will inevitably happen per TID (since
2804 * it is related to aggregation) it is easier to make mac80211 map the
2805 * TID to the AC as required instead of keeping track in all drivers that
2806 * use this API.
2807 */
2808void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
2809                                u8 tid, bool buffered);
2810
2811/**
2812 * ieee80211_tx_status - transmit status callback
2813 *
2814 * Call this function for all transmitted frames after they have been
2815 * transmitted. It is permissible to not call this function for
2816 * multicast frames but this can affect statistics.
2817 *
2818 * This function may not be called in IRQ context. Calls to this function
2819 * for a single hardware must be synchronized against each other. Calls
2820 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
2821 * may not be mixed for a single hardware.
2822 *
2823 * @hw: the hardware the frame was transmitted by
2824 * @skb: the frame that was transmitted, owned by mac80211 after this call
2825 */
2826void ieee80211_tx_status(struct ieee80211_hw *hw,
2827                         struct sk_buff *skb);
2828
2829/**
2830 * ieee80211_tx_status_ni - transmit status callback (in process context)
2831 *
2832 * Like ieee80211_tx_status() but can be called in process context.
2833 *
2834 * Calls to this function, ieee80211_tx_status() and
2835 * ieee80211_tx_status_irqsafe() may not be mixed
2836 * for a single hardware.
2837 *
2838 * @hw: the hardware the frame was transmitted by
2839 * @skb: the frame that was transmitted, owned by mac80211 after this call
2840 */
2841static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
2842                                          struct sk_buff *skb)
2843{
2844        local_bh_disable();
2845        ieee80211_tx_status(hw, skb);
2846        local_bh_enable();
2847}
2848
2849/**
2850 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
2851 *
2852 * Like ieee80211_tx_status() but can be called in IRQ context
2853 * (internally defers to a tasklet.)
2854 *
2855 * Calls to this function, ieee80211_tx_status() and
2856 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
2857 *
2858 * @hw: the hardware the frame was transmitted by
2859 * @skb: the frame that was transmitted, owned by mac80211 after this call
2860 */
2861void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
2862                                 struct sk_buff *skb);
2863
2864/**
2865 * ieee80211_report_low_ack - report non-responding station
2866 *
2867 * When operating in AP-mode, call this function to report a non-responding
2868 * connected STA.
2869 *
2870 * @sta: the non-responding connected sta
2871 * @num_packets: number of packets sent to @sta without a response
2872 */
2873void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
2874
2875/**
2876 * ieee80211_beacon_get_tim - beacon generation function
2877 * @hw: pointer obtained from ieee80211_alloc_hw().
2878 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2879 * @tim_offset: pointer to variable that will receive the TIM IE offset.
2880 *      Set to 0 if invalid (in non-AP modes).
2881 * @tim_length: pointer to variable that will receive the TIM IE length,
2882 *      (including the ID and length bytes!).
2883 *      Set to 0 if invalid (in non-AP modes).
2884 *
2885 * If the driver implements beaconing modes, it must use this function to
2886 * obtain the beacon frame/template.
2887 *
2888 * If the beacon frames are generated by the host system (i.e., not in
2889 * hardware/firmware), the driver uses this function to get each beacon
2890 * frame from mac80211 -- it is responsible for calling this function
2891 * before the beacon is needed (e.g. based on hardware interrupt).
2892 *
2893 * If the beacon frames are generated by the device, then the driver
2894 * must use the returned beacon as the template and change the TIM IE
2895 * according to the current DTIM parameters/TIM bitmap.
2896 *
2897 * The driver is responsible for freeing the returned skb.
2898 */
2899struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
2900                                         struct ieee80211_vif *vif,
2901                                         u16 *tim_offset, u16 *tim_length);
2902
2903/**
2904 * ieee80211_beacon_get - beacon generation function
2905 * @hw: pointer obtained from ieee80211_alloc_hw().
2906 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2907 *
2908 * See ieee80211_beacon_get_tim().
2909 */
2910static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
2911                                                   struct ieee80211_vif *vif)
2912{
2913        return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
2914}
2915
2916/**
2917 * ieee80211_proberesp_get - retrieve a Probe Response template
2918 * @hw: pointer obtained from ieee80211_alloc_hw().
2919 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2920 *
2921 * Creates a Probe Response template which can, for example, be uploaded to
2922 * hardware. The destination address should be set by the caller.
2923 *
2924 * Can only be called in AP mode.
2925 */
2926struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
2927                                        struct ieee80211_vif *vif);
2928
2929/**
2930 * ieee80211_pspoll_get - retrieve a PS Poll template
2931 * @hw: pointer obtained from ieee80211_alloc_hw().
2932 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2933 *
2934 * Creates a PS Poll a template which can, for example, uploaded to
2935 * hardware. The template must be updated after association so that correct
2936 * AID, BSSID and MAC address is used.
2937 *
2938 * Note: Caller (or hardware) is responsible for setting the
2939 * &IEEE80211_FCTL_PM bit.
2940 */
2941struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
2942                                     struct ieee80211_vif *vif);
2943
2944/**
2945 * ieee80211_nullfunc_get - retrieve a nullfunc template
2946 * @hw: pointer obtained from ieee80211_alloc_hw().
2947 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2948 *
2949 * Creates a Nullfunc template which can, for example, uploaded to
2950 * hardware. The template must be updated after association so that correct
2951 * BSSID and address is used.
2952 *
2953 * Note: Caller (or hardware) is responsible for setting the
2954 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
2955 */
2956struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
2957                                       struct ieee80211_vif *vif);
2958
2959/**
2960 * ieee80211_probereq_get - retrieve a Probe Request template
2961 * @hw: pointer obtained from ieee80211_alloc_hw().
2962 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2963 * @ssid: SSID buffer
2964 * @ssid_len: length of SSID
2965 * @ie: buffer containing all IEs except SSID for the template
2966 * @ie_len: length of the IE buffer
2967 *
2968 * Creates a Probe Request template which can, for example, be uploaded to
2969 * hardware.
2970 */
2971struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
2972                                       struct ieee80211_vif *vif,
2973                                       const u8 *ssid, size_t ssid_len,
2974                                       const u8 *ie, size_t ie_len);
2975
2976/**
2977 * ieee80211_rts_get - RTS frame generation function
2978 * @hw: pointer obtained from ieee80211_alloc_hw().
2979 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2980 * @frame: pointer to the frame that is going to be protected by the RTS.
2981 * @frame_len: the frame length (in octets).
2982 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2983 * @rts: The buffer where to store the RTS frame.
2984 *
2985 * If the RTS frames are generated by the host system (i.e., not in
2986 * hardware/firmware), the low-level driver uses this function to receive
2987 * the next RTS frame from the 802.11 code. The low-level is responsible
2988 * for calling this function before and RTS frame is needed.
2989 */
2990void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2991                       const void *frame, size_t frame_len,
2992                       const struct ieee80211_tx_info *frame_txctl,
2993                       struct ieee80211_rts *rts);
2994
2995/**
2996 * ieee80211_rts_duration - Get the duration field for an RTS frame
2997 * @hw: pointer obtained from ieee80211_alloc_hw().
2998 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2999 * @frame_len: the length of the frame that is going to be protected by the RTS.
3000 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3001 *
3002 * If the RTS is generated in firmware, but the host system must provide
3003 * the duration field, the low-level driver uses this function to receive
3004 * the duration field value in little-endian byteorder.
3005 */
3006__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
3007                              struct ieee80211_vif *vif, size_t frame_len,
3008                              const struct ieee80211_tx_info *frame_txctl);
3009
3010/**
3011 * ieee80211_ctstoself_get - CTS-to-self frame generation function
3012 * @hw: pointer obtained from ieee80211_alloc_hw().
3013 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3014 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
3015 * @frame_len: the frame length (in octets).
3016 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3017 * @cts: The buffer where to store the CTS-to-self frame.
3018 *
3019 * If the CTS-to-self frames are generated by the host system (i.e., not in
3020 * hardware/firmware), the low-level driver uses this function to receive
3021 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
3022 * for calling this function before and CTS-to-self frame is needed.
3023 */
3024void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
3025                             struct ieee80211_vif *vif,
3026                             const void *frame, size_t frame_len,
3027                             const struct ieee80211_tx_info *frame_txctl,
3028                             struct ieee80211_cts *cts);
3029
3030/**
3031 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
3032 * @hw: pointer obtained from ieee80211_alloc_hw().
3033 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3034 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
3035 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3036 *
3037 * If the CTS-to-self is generated in firmware, but the host system must provide
3038 * the duration field, the low-level driver uses this function to receive
3039 * the duration field value in little-endian byteorder.
3040 */
3041__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
3042                                    struct ieee80211_vif *vif,
3043                                    size_t frame_len,
3044                                    const struct ieee80211_tx_info *frame_txctl);
3045
3046/**
3047 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
3048 * @hw: pointer obtained from ieee80211_alloc_hw().
3049 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3050 * @band: the band to calculate the frame duration on
3051 * @frame_len: the length of the frame.
3052 * @rate: the rate at which the frame is going to be transmitted.
3053 *
3054 * Calculate the duration field of some generic frame, given its
3055 * length and transmission rate (in 100kbps).
3056 */
3057__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
3058                                        struct ieee80211_vif *vif,
3059                                        enum ieee80211_band band,
3060                                        size_t frame_len,
3061                                        struct ieee80211_rate *rate);
3062
3063/**
3064 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
3065 * @hw: pointer as obtained from ieee80211_alloc_hw().
3066 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3067 *
3068 * Function for accessing buffered broadcast and multicast frames. If
3069 * hardware/firmware does not implement buffering of broadcast/multicast
3070 * frames when power saving is used, 802.11 code buffers them in the host
3071 * memory. The low-level driver uses this function to fetch next buffered
3072 * frame. In most cases, this is used when generating beacon frame. This
3073 * function returns a pointer to the next buffered skb or NULL if no more
3074 * buffered frames are available.
3075 *
3076 * Note: buffered frames are returned only after DTIM beacon frame was
3077 * generated with ieee80211_beacon_get() and the low-level driver must thus
3078 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
3079 * NULL if the previous generated beacon was not DTIM, so the low-level driver
3080 * does not need to check for DTIM beacons separately and should be able to
3081 * use common code for all beacons.
3082 */
3083struct sk_buff *
3084ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3085
3086/**
3087 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
3088 *
3089 * This function returns the TKIP phase 1 key for the given IV32.
3090 *
3091 * @keyconf: the parameter passed with the set key
3092 * @iv32: IV32 to get the P1K for
3093 * @p1k: a buffer to which the key will be written, as 5 u16 values
3094 */
3095void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
3096                               u32 iv32, u16 *p1k);
3097
3098/**
3099 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
3100 *
3101 * This function returns the TKIP phase 1 key for the IV32 taken
3102 * from the given packet.
3103 *
3104 * @keyconf: the parameter passed with the set key
3105 * @skb: the packet to take the IV32 value from that will be encrypted
3106 *      with this P1K
3107 * @p1k: a buffer to which the key will be written, as 5 u16 values
3108 */
3109static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
3110                                          struct sk_buff *skb, u16 *p1k)
3111{
3112        struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
3113        const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
3114        u32 iv32 = get_unaligned_le32(&data[4]);
3115
3116        ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
3117}
3118
3119/**
3120 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
3121 *
3122 * This function returns the TKIP phase 1 key for the given IV32
3123 * and transmitter address.
3124 *
3125 * @keyconf: the parameter passed with the set key
3126 * @ta: TA that will be used with the key
3127 * @iv32: IV32 to get the P1K for
3128 * @p1k: a buffer to which the key will be written, as 5 u16 values
3129 */
3130void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
3131                               const u8 *ta, u32 iv32, u16 *p1k);
3132
3133/**
3134 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
3135 *
3136 * This function computes the TKIP RC4 key for the IV values
3137 * in the packet.
3138 *
3139 * @keyconf: the parameter passed with the set key
3140 * @skb: the packet to take the IV32/IV16 values from that will be
3141 *      encrypted with this key
3142 * @p2k: a buffer to which the key will be written, 16 bytes
3143 */
3144void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
3145                            struct sk_buff *skb, u8 *p2k);
3146
3147/**
3148 * struct ieee80211_key_seq - key sequence counter
3149 *
3150 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
3151 * @ccmp: PN data, most significant byte first (big endian,
3152 *      reverse order than in packet)
3153 * @aes_cmac: PN data, most significant byte first (big endian,
3154 *      reverse order than in packet)
3155 */
3156struct ieee80211_key_seq {
3157        union {
3158                struct {
3159                        u32 iv32;
3160                        u16 iv16;
3161                } tkip;
3162                struct {
3163                        u8 pn[6];
3164                } ccmp;
3165                struct {
3166                        u8 pn[6];
3167                } aes_cmac;
3168        };
3169};
3170
3171/**
3172 * ieee80211_get_key_tx_seq - get key TX sequence counter
3173 *
3174 * @keyconf: the parameter passed with the set key
3175 * @seq: buffer to receive the sequence data
3176 *
3177 * This function allows a driver to retrieve the current TX IV/PN
3178 * for the given key. It must not be called if IV generation is
3179 * offloaded to the device.
3180 *
3181 * Note that this function may only be called when no TX processing
3182 * can be done concurrently, for example when queues are stopped
3183 * and the stop has been synchronized.
3184 */
3185void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
3186                              struct ieee80211_key_seq *seq);
3187
3188/**
3189 * ieee80211_get_key_rx_seq - get key RX sequence counter
3190 *
3191 * @keyconf: the parameter passed with the set key
3192 * @tid: The TID, or -1 for the management frame value (CCMP only);
3193 *      the value on TID 0 is also used for non-QoS frames. For
3194 *      CMAC, only TID 0 is valid.
3195 * @seq: buffer to receive the sequence data
3196 *
3197 * This function allows a driver to retrieve the current RX IV/PNs
3198 * for the given key. It must not be called if IV checking is done
3199 * by the device and not by mac80211.
3200 *
3201 * Note that this function may only be called when no RX processing
3202 * can be done concurrently.
3203 */
3204void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
3205                              int tid, struct ieee80211_key_seq *seq);
3206
3207/**
3208 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
3209 * @vif: virtual interface the rekeying was done on
3210 * @bssid: The BSSID of the AP, for checking association
3211 * @replay_ctr: the new replay counter after GTK rekeying
3212 * @gfp: allocation flags
3213 */
3214void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
3215                                const u8 *replay_ctr, gfp_t gfp);
3216
3217/**
3218 * ieee80211_wake_queue - wake specific queue
3219 * @hw: pointer as obtained from ieee80211_alloc_hw().
3220 * @queue: queue number (counted from zero).
3221 *
3222 * Drivers should use this function instead of netif_wake_queue.
3223 */
3224void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
3225
3226/**
3227 * ieee80211_stop_queue - stop specific queue
3228 * @hw: pointer as obtained from ieee80211_alloc_hw().
3229 * @queue: queue number (counted from zero).
3230 *
3231 * Drivers should use this function instead of netif_stop_queue.
3232 */
3233void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
3234
3235/**
3236 * ieee80211_queue_stopped - test status of the queue
3237 * @hw: pointer as obtained from ieee80211_alloc_hw().
3238 * @queue: queue number (counted from zero).
3239 *
3240 * Drivers should use this function instead of netif_stop_queue.
3241 */
3242
3243int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
3244
3245/**
3246 * ieee80211_stop_queues - stop all queues
3247 * @hw: pointer as obtained from ieee80211_alloc_hw().
3248 *
3249 * Drivers should use this function instead of netif_stop_queue.
3250 */
3251void ieee80211_stop_queues(struct ieee80211_hw *hw);
3252
3253/**
3254 * ieee80211_wake_queues - wake all queues
3255 * @hw: pointer as obtained from ieee80211_alloc_hw().
3256 *
3257 * Drivers should use this function instead of netif_wake_queue.
3258 */
3259void ieee80211_wake_queues(struct ieee80211_hw *hw);
3260
3261/**
3262 * ieee80211_scan_completed - completed hardware scan
3263 *
3264 * When hardware scan offload is used (i.e. the hw_scan() callback is
3265 * assigned) this function needs to be called by the driver to notify
3266 * mac80211 that the scan finished. This function can be called from
3267 * any context, including hardirq context.
3268 *
3269 * @hw: the hardware that finished the scan
3270 * @aborted: set to true if scan was aborted
3271 */
3272void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
3273
3274/**
3275 * ieee80211_sched_scan_results - got results from scheduled scan
3276 *
3277 * When a scheduled scan is running, this function needs to be called by the
3278 * driver whenever there are new scan results available.
3279 *
3280 * @hw: the hardware that is performing scheduled scans
3281 */
3282void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
3283
3284/**
3285 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
3286 *
3287 * When a scheduled scan is running, this function can be called by
3288 * the driver if it needs to stop the scan to perform another task.
3289 * Usual scenarios are drivers that cannot continue the scheduled scan
3290 * while associating, for instance.
3291 *
3292 * @hw: the hardware that is performing scheduled scans
3293 */
3294void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
3295
3296/**
3297 * ieee80211_iterate_active_interfaces - iterate active interfaces
3298 *
3299 * This function iterates over the interfaces associated with a given
3300 * hardware that are currently active and calls the callback for them.
3301 * This function allows the iterator function to sleep, when the iterator
3302 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
3303 * be used.
3304 * Does not iterate over a new interface during add_interface()
3305 *
3306 * @hw: the hardware struct of which the interfaces should be iterated over
3307 * @iterator: the iterator function to call
3308 * @data: first argument of the iterator function
3309 */
3310void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
3311                                         void (*iterator)(void *data, u8 *mac,
3312                                                struct ieee80211_vif *vif),
3313                                         void *data);
3314
3315/**
3316 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
3317 *
3318 * This function iterates over the interfaces associated with a given
3319 * hardware that are currently active and calls the callback for them.
3320 * This function requires the iterator callback function to be atomic,
3321 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
3322 * Does not iterate over a new interface during add_interface()
3323 *
3324 * @hw: the hardware struct of which the interfaces should be iterated over
3325 * @iterator: the iterator function to call, cannot sleep
3326 * @data: first argument of the iterator function
3327 */
3328void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
3329                                                void (*iterator)(void *data,
3330                                                    u8 *mac,
3331                                                    struct ieee80211_vif *vif),
3332                                                void *data);
3333
3334/**
3335 * ieee80211_queue_work - add work onto the mac80211 workqueue
3336 *
3337 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
3338 * This helper ensures drivers are not queueing work when they should not be.
3339 *
3340 * @hw: the hardware struct for the interface we are adding work for
3341 * @work: the work we want to add onto the mac80211 workqueue
3342 */
3343void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
3344
3345/**
3346 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
3347 *
3348 * Drivers and mac80211 use this to queue delayed work onto the mac80211
3349 * workqueue.
3350 *
3351 * @hw: the hardware struct for the interface we are adding work for
3352 * @dwork: delayable work to queue onto the mac80211 workqueue
3353 * @delay: number of jiffies to wait before queueing
3354 */
3355void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
3356                                  struct delayed_work *dwork,
3357                                  unsigned long delay);
3358
3359/**
3360 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
3361 * @sta: the station for which to start a BA session
3362 * @tid: the TID to BA on.
3363 * @timeout: session timeout value (in TUs)
3364 *
3365 * Return: success if addBA request was sent, failure otherwise
3366 *
3367 * Although mac80211/low level driver/user space application can estimate
3368 * the need to start aggregation on a certain RA/TID, the session level
3369 * will be managed by the mac80211.
3370 */
3371int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
3372                                  u16 timeout);
3373
3374/**
3375 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
3376 * @vif: &struct ieee80211_vif pointer from the add_interface callback
3377 * @ra: receiver address of the BA session recipient.
3378 * @tid: the TID to BA on.
3379 *
3380 * This function must be called by low level driver once it has
3381 * finished with preparations for the BA session. It can be called
3382 * from any context.
3383 */
3384void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
3385                                      u16 tid);
3386
3387/**
3388 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
3389 * @sta: the station whose BA session to stop
3390 * @tid: the TID to stop BA.
3391 *
3392 * Return: negative error if the TID is invalid, or no aggregation active
3393 *
3394 * Although mac80211/low level driver/user space application can estimate
3395 * the need to stop aggregation on a certain RA/TID, the session level
3396 * will be managed by the mac80211.
3397 */
3398int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
3399
3400/**
3401 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
3402 * @vif: &struct ieee80211_vif pointer from the add_interface callback
3403 * @ra: receiver address of the BA session recipient.
3404 * @tid: the desired TID to BA on.
3405 *
3406 * This function must be called by low level driver once it has
3407 * finished with preparations for the BA session tear down. It
3408 * can be called from any context.
3409 */
3410void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
3411                                     u16 tid);
3412
3413/**
3414 * ieee80211_find_sta - find a station
3415 *
3416 * @vif: virtual interface to look for station on
3417 * @addr: station's address
3418 *
3419 * This function must be called under RCU lock and the
3420 * resulting pointer is only valid under RCU lock as well.
3421 */
3422struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
3423                                         const u8 *addr);
3424
3425/**
3426 * ieee80211_find_sta_by_ifaddr - find a station on hardware
3427 *
3428 * @hw: pointer as obtained from ieee80211_alloc_hw()
3429 * @addr: remote station's address
3430 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
3431 *
3432 * This function must be called under RCU lock and the
3433 * resulting pointer is only valid under RCU lock as well.
3434 *
3435 * NOTE: You may pass NULL for localaddr, but then you will just get
3436 *      the first STA that matches the remote address 'addr'.
3437 *      We can have multiple STA associated with multiple
3438 *      logical stations (e.g. consider a station connecting to another
3439 *      BSSID on the same AP hardware without disconnecting first).
3440 *      In this case, the result of this method with localaddr NULL
3441 *      is not reliable.
3442 *
3443 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
3444 */
3445struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
3446                                               const u8 *addr,
3447                                               const u8 *localaddr);
3448
3449/**
3450 * ieee80211_sta_block_awake - block station from waking up
3451 * @hw: the hardware
3452 * @pubsta: the station
3453 * @block: whether to block or unblock
3454 *
3455 * Some devices require that all frames that are on the queues
3456 * for a specific station that went to sleep are flushed before
3457 * a poll response or frames after the station woke up can be
3458 * delivered to that it. Note that such frames must be rejected
3459 * by the driver as filtered, with the appropriate status flag.
3460 *
3461 * This function allows implementing this mode in a race-free
3462 * manner.
3463 *
3464 * To do this, a driver must keep track of the number of frames
3465 * still enqueued for a specific station. If this number is not
3466 * zero when the station goes to sleep, the driver must call
3467 * this function to force mac80211 to consider the station to
3468 * be asleep regardless of the station's actual state. Once the
3469 * number of outstanding frames reaches zero, the driver must
3470 * call this function again to unblock the station. That will
3471 * cause mac80211 to be able to send ps-poll responses, and if
3472 * the station queried in the meantime then frames will also
3473 * be sent out as a result of this. Additionally, the driver
3474 * will be notified that the station woke up some time after
3475 * it is unblocked, regardless of whether the station actually
3476 * woke up while blocked or not.
3477 */
3478void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
3479                               struct ieee80211_sta *pubsta, bool block);
3480
3481/**
3482 * ieee80211_sta_eosp - notify mac80211 about end of SP
3483 * @pubsta: the station
3484 *
3485 * When a device transmits frames in a way that it can't tell
3486 * mac80211 in the TX status about the EOSP, it must clear the
3487 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
3488 * This applies for PS-Poll as well as uAPSD.
3489 *
3490 * Note that there is no non-_irqsafe version right now as
3491 * it wasn't needed, but just like _tx_status() and _rx()
3492 * must not be mixed in irqsafe/non-irqsafe versions, this
3493 * function must not be mixed with those either. Use the
3494 * all irqsafe, or all non-irqsafe, don't mix! If you need
3495 * the non-irqsafe version of this, you need to add it.
3496 */
3497void ieee80211_sta_eosp_irqsafe(struct ieee80211_sta *pubsta);
3498
3499/**
3500 * ieee80211_iter_keys - iterate keys programmed into the device
3501 * @hw: pointer obtained from ieee80211_alloc_hw()
3502 * @vif: virtual interface to iterate, may be %NULL for all
3503 * @iter: iterator function that will be called for each key
3504 * @iter_data: custom data to pass to the iterator function
3505 *
3506 * This function can be used to iterate all the keys known to
3507 * mac80211, even those that weren't previously programmed into
3508 * the device. This is intended for use in WoWLAN if the device
3509 * needs reprogramming of the keys during suspend. Note that due
3510 * to locking reasons, it is also only safe to call this at few
3511 * spots since it must hold the RTNL and be able to sleep.
3512 *
3513 * The order in which the keys are iterated matches the order
3514 * in which they were originally installed and handed to the
3515 * set_key callback.
3516 */
3517void ieee80211_iter_keys(struct ieee80211_hw *hw,
3518                         struct ieee80211_vif *vif,
3519                         void (*iter)(struct ieee80211_hw *hw,
3520                                      struct ieee80211_vif *vif,
3521                                      struct ieee80211_sta *sta,
3522                                      struct ieee80211_key_conf *key,
3523                                      void *data),
3524                         void *iter_data);
3525
3526/**
3527 * ieee80211_ap_probereq_get - retrieve a Probe Request template
3528 * @hw: pointer obtained from ieee80211_alloc_hw().
3529 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3530 *
3531 * Creates a Probe Request template which can, for example, be uploaded to
3532 * hardware. The template is filled with bssid, ssid and supported rate
3533 * information. This function must only be called from within the
3534 * .bss_info_changed callback function and only in managed mode. The function
3535 * is only useful when the interface is associated, otherwise it will return
3536 * NULL.
3537 */
3538struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
3539                                          struct ieee80211_vif *vif);
3540
3541/**
3542 * ieee80211_beacon_loss - inform hardware does not receive beacons
3543 *
3544 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3545 *
3546 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
3547 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
3548 * hardware is not receiving beacons with this function.
3549 */
3550void ieee80211_beacon_loss(struct ieee80211_vif *vif);
3551
3552/**
3553 * ieee80211_connection_loss - inform hardware has lost connection to the AP
3554 *
3555 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3556 *
3557 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
3558 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
3559 * needs to inform if the connection to the AP has been lost.
3560 *
3561 * This function will cause immediate change to disassociated state,
3562 * without connection recovery attempts.
3563 */
3564void ieee80211_connection_loss(struct ieee80211_vif *vif);
3565
3566/**
3567 * ieee80211_resume_disconnect - disconnect from AP after resume
3568 *
3569 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3570 *
3571 * Instructs mac80211 to disconnect from the AP after resume.
3572 * Drivers can use this after WoWLAN if they know that the
3573 * connection cannot be kept up, for example because keys were
3574 * used while the device was asleep but the replay counters or
3575 * similar cannot be retrieved from the device during resume.
3576 *
3577 * Note that due to implementation issues, if the driver uses
3578 * the reconfiguration functionality during resume the interface
3579 * will still be added as associated first during resume and then
3580 * disconnect normally later.
3581 *
3582 * This function can only be called from the resume callback and
3583 * the driver must not be holding any of its own locks while it
3584 * calls this function, or at least not any locks it needs in the
3585 * key configuration paths (if it supports HW crypto).
3586 */
3587void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
3588
3589/**
3590 * ieee80211_disable_dyn_ps - force mac80211 to temporarily disable dynamic psm
3591 *
3592 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3593 *
3594 * Some hardware require full power save to manage simultaneous BT traffic
3595 * on the WLAN frequency. Full PSM is required periodically, whenever there are
3596 * burst of BT traffic. The hardware gets information of BT traffic via
3597 * hardware co-existence lines, and consequentially requests mac80211 to
3598 * (temporarily) enter full psm.
3599 * This function will only temporarily disable dynamic PS, not enable PSM if
3600 * it was not already enabled.
3601 * The driver must make sure to re-enable dynamic PS using
3602 * ieee80211_enable_dyn_ps() if the driver has disabled it.
3603 *
3604 */
3605void ieee80211_disable_dyn_ps(struct ieee80211_vif *vif);
3606
3607/**
3608 * ieee80211_enable_dyn_ps - restore dynamic psm after being disabled
3609 *
3610 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3611 *
3612 * This function restores dynamic PS after being temporarily disabled via
3613 * ieee80211_disable_dyn_ps(). Each ieee80211_disable_dyn_ps() call must
3614 * be coupled with an eventual call to this function.
3615 *
3616 */
3617void ieee80211_enable_dyn_ps(struct ieee80211_vif *vif);
3618
3619/**
3620 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
3621 *      rssi threshold triggered
3622 *
3623 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3624 * @rssi_event: the RSSI trigger event type
3625 * @gfp: context flags
3626 *
3627 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
3628 * monitoring is configured with an rssi threshold, the driver will inform
3629 * whenever the rssi level reaches the threshold.
3630 */
3631void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
3632                               enum nl80211_cqm_rssi_threshold_event rssi_event,
3633                               gfp_t gfp);
3634
3635/**
3636 * ieee80211_chswitch_done - Complete channel switch process
3637 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3638 * @success: make the channel switch successful or not
3639 *
3640 * Complete the channel switch post-process: set the new operational channel
3641 * and wake up the suspended queues.
3642 */
3643void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
3644
3645/**
3646 * ieee80211_request_smps - request SM PS transition
3647 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3648 * @smps_mode: new SM PS mode
3649 *
3650 * This allows the driver to request an SM PS transition in managed
3651 * mode. This is useful when the driver has more information than
3652 * the stack about possible interference, for example by bluetooth.
3653 */
3654void ieee80211_request_smps(struct ieee80211_vif *vif,
3655                            enum ieee80211_smps_mode smps_mode);
3656
3657/**
3658 * ieee80211_ready_on_channel - notification of remain-on-channel start
3659 * @hw: pointer as obtained from ieee80211_alloc_hw()
3660 */
3661void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
3662
3663/**
3664 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
3665 * @hw: pointer as obtained from ieee80211_alloc_hw()
3666 */
3667void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
3668
3669/**
3670 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
3671 *
3672 * in order not to harm the system performance and user experience, the device
3673 * may request not to allow any rx ba session and tear down existing rx ba
3674 * sessions based on system constraints such as periodic BT activity that needs
3675 * to limit wlan activity (eg.sco or a2dp)."
3676 * in such cases, the intention is to limit the duration of the rx ppdu and
3677 * therefore prevent the peer device to use a-mpdu aggregation.
3678 *
3679 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3680 * @ba_rx_bitmap: Bit map of open rx ba per tid
3681 * @addr: & to bssid mac address
3682 */
3683void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
3684                                  const u8 *addr);
3685
3686/**
3687 * ieee80211_send_bar - send a BlockAckReq frame
3688 *
3689 * can be used to flush pending frames from the peer's aggregation reorder
3690 * buffer.
3691 *
3692 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3693 * @ra: the peer's destination address
3694 * @tid: the TID of the aggregation session
3695 * @ssn: the new starting sequence number for the receiver
3696 */
3697void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
3698
3699/* Rate control API */
3700
3701/**
3702 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
3703 *
3704 * @hw: The hardware the algorithm is invoked for.
3705 * @sband: The band this frame is being transmitted on.
3706 * @bss_conf: the current BSS configuration
3707 * @skb: the skb that will be transmitted, the control information in it needs
3708 *      to be filled in
3709 * @reported_rate: The rate control algorithm can fill this in to indicate
3710 *      which rate should be reported to userspace as the current rate and
3711 *      used for rate calculations in the mesh network.
3712 * @rts: whether RTS will be used for this frame because it is longer than the
3713 *      RTS threshold
3714 * @short_preamble: whether mac80211 will request short-preamble transmission
3715 *      if the selected rate supports it
3716 * @max_rate_idx: user-requested maximum (legacy) rate
3717 *      (deprecated; this will be removed once drivers get updated to use
3718 *      rate_idx_mask)
3719 * @rate_idx_mask: user-requested (legacy) rate mask
3720 * @rate_idx_mcs_mask: user-requested MCS rate mask
3721 * @bss: whether this frame is sent out in AP or IBSS mode
3722 */
3723struct ieee80211_tx_rate_control {
3724        struct ieee80211_hw *hw;
3725        struct ieee80211_supported_band *sband;
3726        struct ieee80211_bss_conf *bss_conf;
3727        struct sk_buff *skb;
3728        struct ieee80211_tx_rate reported_rate;
3729        bool rts, short_preamble;
3730        u8 max_rate_idx;
3731        u32 rate_idx_mask;
3732        u8 rate_idx_mcs_mask[IEEE80211_HT_MCS_MASK_LEN];
3733        bool bss;
3734};
3735
3736struct rate_control_ops {
3737        struct module *module;
3738        const char *name;
3739        void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
3740        void (*free)(void *priv);
3741
3742        void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
3743        void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
3744                          struct ieee80211_sta *sta, void *priv_sta);
3745        void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
3746                            struct ieee80211_sta *sta, void *priv_sta,
3747                            u32 changed);
3748        void (*free_sta)(void *priv, struct ieee80211_sta *sta,
3749                         void *priv_sta);
3750
3751        void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
3752                          struct ieee80211_sta *sta, void *priv_sta,
3753                          struct sk_buff *skb);
3754        void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
3755                         struct ieee80211_tx_rate_control *txrc);
3756
3757        void (*add_sta_debugfs)(void *priv, void *priv_sta,
3758                                struct dentry *dir);
3759        void (*remove_sta_debugfs)(void *priv, void *priv_sta);
3760};
3761
3762static inline int rate_supported(struct ieee80211_sta *sta,
3763                                 enum ieee80211_band band,
3764                                 int index)
3765{
3766        return (sta == NULL || sta->supp_rates[band] & BIT(index));
3767}
3768
3769/**
3770 * rate_control_send_low - helper for drivers for management/no-ack frames
3771 *
3772 * Rate control algorithms that agree to use the lowest rate to
3773 * send management frames and NO_ACK data with the respective hw
3774 * retries should use this in the beginning of their mac80211 get_rate
3775 * callback. If true is returned the rate control can simply return.
3776 * If false is returned we guarantee that sta and sta and priv_sta is
3777 * not null.
3778 *
3779 * Rate control algorithms wishing to do more intelligent selection of
3780 * rate for multicast/broadcast frames may choose to not use this.
3781 *
3782 * @sta: &struct ieee80211_sta pointer to the target destination. Note
3783 *      that this may be null.
3784 * @priv_sta: private rate control structure. This may be null.
3785 * @txrc: rate control information we sholud populate for mac80211.
3786 */
3787bool rate_control_send_low(struct ieee80211_sta *sta,
3788                           void *priv_sta,
3789                           struct ieee80211_tx_rate_control *txrc);
3790
3791
3792static inline s8
3793rate_lowest_index(struct ieee80211_supported_band *sband,
3794                  struct ieee80211_sta *sta)
3795{
3796        int i;
3797
3798        for (i = 0; i < sband->n_bitrates; i++)
3799                if (rate_supported(sta, sband->band, i))
3800                        return i;
3801
3802        /* warn when we cannot find a rate. */
3803        WARN_ON_ONCE(1);
3804
3805        /* and return 0 (the lowest index) */
3806        return 0;
3807}
3808
3809static inline
3810bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
3811                              struct ieee80211_sta *sta)
3812{
3813        unsigned int i;
3814
3815        for (i = 0; i < sband->n_bitrates; i++)
3816                if (rate_supported(sta, sband->band, i))
3817                        return true;
3818        return false;
3819}
3820
3821int ieee80211_rate_control_register(struct rate_control_ops *ops);
3822void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
3823
3824static inline bool
3825conf_is_ht20(struct ieee80211_conf *conf)
3826{
3827        return conf->channel_type == NL80211_CHAN_HT20;
3828}
3829
3830static inline bool
3831conf_is_ht40_minus(struct ieee80211_conf *conf)
3832{
3833        return conf->channel_type == NL80211_CHAN_HT40MINUS;
3834}
3835
3836static inline bool
3837conf_is_ht40_plus(struct ieee80211_conf *conf)
3838{
3839        return conf->channel_type == NL80211_CHAN_HT40PLUS;
3840}
3841
3842static inline bool
3843conf_is_ht40(struct ieee80211_conf *conf)
3844{
3845        return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
3846}
3847
3848static inline bool
3849conf_is_ht(struct ieee80211_conf *conf)
3850{
3851        return conf->channel_type != NL80211_CHAN_NO_HT;
3852}
3853
3854static inline enum nl80211_iftype
3855ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
3856{
3857        if (p2p) {
3858                switch (type) {
3859                case NL80211_IFTYPE_STATION:
3860                        return NL80211_IFTYPE_P2P_CLIENT;
3861                case NL80211_IFTYPE_AP:
3862                        return NL80211_IFTYPE_P2P_GO;
3863                default:
3864                        break;
3865                }
3866        }
3867        return type;
3868}
3869
3870static inline enum nl80211_iftype
3871ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
3872{
3873        return ieee80211_iftype_p2p(vif->type, vif->p2p);
3874}
3875
3876void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
3877                                   int rssi_min_thold,
3878                                   int rssi_max_thold);
3879
3880void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
3881
3882/**
3883 * ieee80211_ave_rssi - report the average rssi for the specified interface
3884 *
3885 * @vif: the specified virtual interface
3886 *
3887 * This function return the average rssi value for the requested interface.
3888 * It assumes that the given vif is valid.
3889 */
3890int ieee80211_ave_rssi(struct ieee80211_vif *vif);
3891
3892#endif /* MAC80211_H */
3893
lxr.linux.no kindly hosted by Redpill Linpro AS, provider of Linux consulting and operations services since 1995.