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 * Copyright 2013-2014  Intel Mobile Communications GmbH
   8 * Copyright (C) 2015 - 2017 Intel Deutschland GmbH
   9 *
  10 * This program is free software; you can redistribute it and/or modify
  11 * it under the terms of the GNU General Public License version 2 as
  12 * published by the Free Software Foundation.
  13 */
  14
  15#ifndef MAC80211_H
  16#define MAC80211_H
  17
  18#include <linux/bug.h>
  19#include <linux/kernel.h>
  20#include <linux/if_ether.h>
  21#include <linux/skbuff.h>
  22#include <linux/ieee80211.h>
  23#include <net/cfg80211.h>
  24#include <net/codel.h>
  25#include <asm/unaligned.h>
  26
  27/**
  28 * DOC: Introduction
  29 *
  30 * mac80211 is the Linux stack for 802.11 hardware that implements
  31 * only partial functionality in hard- or firmware. This document
  32 * defines the interface between mac80211 and low-level hardware
  33 * drivers.
  34 */
  35
  36/**
  37 * DOC: Calling mac80211 from interrupts
  38 *
  39 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
  40 * called in hardware interrupt context. The low-level driver must not call any
  41 * other functions in hardware interrupt context. If there is a need for such
  42 * call, the low-level driver should first ACK the interrupt and perform the
  43 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
  44 * tasklet function.
  45 *
  46 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
  47 *       use the non-IRQ-safe functions!
  48 */
  49
  50/**
  51 * DOC: Warning
  52 *
  53 * If you're reading this document and not the header file itself, it will
  54 * be incomplete because not all documentation has been converted yet.
  55 */
  56
  57/**
  58 * DOC: Frame format
  59 *
  60 * As a general rule, when frames are passed between mac80211 and the driver,
  61 * they start with the IEEE 802.11 header and include the same octets that are
  62 * sent over the air except for the FCS which should be calculated by the
  63 * hardware.
  64 *
  65 * There are, however, various exceptions to this rule for advanced features:
  66 *
  67 * The first exception is for hardware encryption and decryption offload
  68 * where the IV/ICV may or may not be generated in hardware.
  69 *
  70 * Secondly, when the hardware handles fragmentation, the frame handed to
  71 * the driver from mac80211 is the MSDU, not the MPDU.
  72 */
  73
  74/**
  75 * DOC: mac80211 workqueue
  76 *
  77 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
  78 * The workqueue is a single threaded workqueue and can only be accessed by
  79 * helpers for sanity checking. Drivers must ensure all work added onto the
  80 * mac80211 workqueue should be cancelled on the driver stop() callback.
  81 *
  82 * mac80211 will flushed the workqueue upon interface removal and during
  83 * suspend.
  84 *
  85 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
  86 *
  87 */
  88
  89/**
  90 * DOC: mac80211 software tx queueing
  91 *
  92 * mac80211 provides an optional intermediate queueing implementation designed
  93 * to allow the driver to keep hardware queues short and provide some fairness
  94 * between different stations/interfaces.
  95 * In this model, the driver pulls data frames from the mac80211 queue instead
  96 * of letting mac80211 push them via drv_tx().
  97 * Other frames (e.g. control or management) are still pushed using drv_tx().
  98 *
  99 * Drivers indicate that they use this model by implementing the .wake_tx_queue
 100 * driver operation.
 101 *
 102 * Intermediate queues (struct ieee80211_txq) are kept per-sta per-tid, with a
 103 * single per-vif queue for multicast data frames.
 104 *
 105 * The driver is expected to initialize its private per-queue data for stations
 106 * and interfaces in the .add_interface and .sta_add ops.
 107 *
 108 * The driver can't access the queue directly. To dequeue a frame, it calls
 109 * ieee80211_tx_dequeue(). Whenever mac80211 adds a new frame to a queue, it
 110 * calls the .wake_tx_queue driver op.
 111 *
 112 * For AP powersave TIM handling, the driver only needs to indicate if it has
 113 * buffered packets in the driver specific data structures by calling
 114 * ieee80211_sta_set_buffered(). For frames buffered in the ieee80211_txq
 115 * struct, mac80211 sets the appropriate TIM PVB bits and calls
 116 * .release_buffered_frames().
 117 * In that callback the driver is therefore expected to release its own
 118 * buffered frames and afterwards also frames from the ieee80211_txq (obtained
 119 * via the usual ieee80211_tx_dequeue).
 120 */
 121
 122struct device;
 123
 124/**
 125 * enum ieee80211_max_queues - maximum number of queues
 126 *
 127 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
 128 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
 129 */
 130enum ieee80211_max_queues {
 131        IEEE80211_MAX_QUEUES =          16,
 132        IEEE80211_MAX_QUEUE_MAP =       BIT(IEEE80211_MAX_QUEUES) - 1,
 133};
 134
 135#define IEEE80211_INVAL_HW_QUEUE        0xff
 136
 137/**
 138 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
 139 * @IEEE80211_AC_VO: voice
 140 * @IEEE80211_AC_VI: video
 141 * @IEEE80211_AC_BE: best effort
 142 * @IEEE80211_AC_BK: background
 143 */
 144enum ieee80211_ac_numbers {
 145        IEEE80211_AC_VO         = 0,
 146        IEEE80211_AC_VI         = 1,
 147        IEEE80211_AC_BE         = 2,
 148        IEEE80211_AC_BK         = 3,
 149};
 150
 151/**
 152 * struct ieee80211_tx_queue_params - transmit queue configuration
 153 *
 154 * The information provided in this structure is required for QoS
 155 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
 156 *
 157 * @aifs: arbitration interframe space [0..255]
 158 * @cw_min: minimum contention window [a value of the form
 159 *      2^n-1 in the range 1..32767]
 160 * @cw_max: maximum contention window [like @cw_min]
 161 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
 162 * @acm: is mandatory admission control required for the access category
 163 * @uapsd: is U-APSD mode enabled for the queue
 164 */
 165struct ieee80211_tx_queue_params {
 166        u16 txop;
 167        u16 cw_min;
 168        u16 cw_max;
 169        u8 aifs;
 170        bool acm;
 171        bool uapsd;
 172};
 173
 174struct ieee80211_low_level_stats {
 175        unsigned int dot11ACKFailureCount;
 176        unsigned int dot11RTSFailureCount;
 177        unsigned int dot11FCSErrorCount;
 178        unsigned int dot11RTSSuccessCount;
 179};
 180
 181/**
 182 * enum ieee80211_chanctx_change - change flag for channel context
 183 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
 184 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
 185 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
 186 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
 187 *      this is used only with channel switching with CSA
 188 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
 189 */
 190enum ieee80211_chanctx_change {
 191        IEEE80211_CHANCTX_CHANGE_WIDTH          = BIT(0),
 192        IEEE80211_CHANCTX_CHANGE_RX_CHAINS      = BIT(1),
 193        IEEE80211_CHANCTX_CHANGE_RADAR          = BIT(2),
 194        IEEE80211_CHANCTX_CHANGE_CHANNEL        = BIT(3),
 195        IEEE80211_CHANCTX_CHANGE_MIN_WIDTH      = BIT(4),
 196};
 197
 198/**
 199 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
 200 *
 201 * This is the driver-visible part. The ieee80211_chanctx
 202 * that contains it is visible in mac80211 only.
 203 *
 204 * @def: the channel definition
 205 * @min_def: the minimum channel definition currently required.
 206 * @rx_chains_static: The number of RX chains that must always be
 207 *      active on the channel to receive MIMO transmissions
 208 * @rx_chains_dynamic: The number of RX chains that must be enabled
 209 *      after RTS/CTS handshake to receive SMPS MIMO transmissions;
 210 *      this will always be >= @rx_chains_static.
 211 * @radar_enabled: whether radar detection is enabled on this channel.
 212 * @drv_priv: data area for driver use, will always be aligned to
 213 *      sizeof(void *), size is determined in hw information.
 214 */
 215struct ieee80211_chanctx_conf {
 216        struct cfg80211_chan_def def;
 217        struct cfg80211_chan_def min_def;
 218
 219        u8 rx_chains_static, rx_chains_dynamic;
 220
 221        bool radar_enabled;
 222
 223        u8 drv_priv[0] __aligned(sizeof(void *));
 224};
 225
 226/**
 227 * enum ieee80211_chanctx_switch_mode - channel context switch mode
 228 * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already
 229 *      exist (and will continue to exist), but the virtual interface
 230 *      needs to be switched from one to the other.
 231 * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop
 232 *      to exist with this call, the new context doesn't exist but
 233 *      will be active after this call, the virtual interface switches
 234 *      from the old to the new (note that the driver may of course
 235 *      implement this as an on-the-fly chandef switch of the existing
 236 *      hardware context, but the mac80211 pointer for the old context
 237 *      will cease to exist and only the new one will later be used
 238 *      for changes/removal.)
 239 */
 240enum ieee80211_chanctx_switch_mode {
 241        CHANCTX_SWMODE_REASSIGN_VIF,
 242        CHANCTX_SWMODE_SWAP_CONTEXTS,
 243};
 244
 245/**
 246 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information
 247 *
 248 * This is structure is used to pass information about a vif that
 249 * needs to switch from one chanctx to another.  The
 250 * &ieee80211_chanctx_switch_mode defines how the switch should be
 251 * done.
 252 *
 253 * @vif: the vif that should be switched from old_ctx to new_ctx
 254 * @old_ctx: the old context to which the vif was assigned
 255 * @new_ctx: the new context to which the vif must be assigned
 256 */
 257struct ieee80211_vif_chanctx_switch {
 258        struct ieee80211_vif *vif;
 259        struct ieee80211_chanctx_conf *old_ctx;
 260        struct ieee80211_chanctx_conf *new_ctx;
 261};
 262
 263/**
 264 * enum ieee80211_bss_change - BSS change notification flags
 265 *
 266 * These flags are used with the bss_info_changed() callback
 267 * to indicate which BSS parameter changed.
 268 *
 269 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
 270 *      also implies a change in the AID.
 271 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
 272 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
 273 * @BSS_CHANGED_ERP_SLOT: slot timing changed
 274 * @BSS_CHANGED_HT: 802.11n parameters changed
 275 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
 276 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
 277 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
 278 *      reason (IBSS and managed mode)
 279 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
 280 *      new beacon (beaconing modes)
 281 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
 282 *      enabled/disabled (beaconing modes)
 283 * @BSS_CHANGED_CQM: Connection quality monitor config changed
 284 * @BSS_CHANGED_IBSS: IBSS join status changed
 285 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
 286 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
 287 *      that it is only ever disabled for station mode.
 288 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
 289 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
 290 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
 291 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
 292 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
 293 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
 294 *      changed
 295 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
 296 *      currently dtim_period only is under consideration.
 297 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
 298 *      note that this is only called when it changes after the channel
 299 *      context had been assigned.
 300 * @BSS_CHANGED_OCB: OCB join status changed
 301 * @BSS_CHANGED_MU_GROUPS: VHT MU-MIMO group id or user position changed
 302 * @BSS_CHANGED_KEEP_ALIVE: keep alive options (idle period or protected
 303 *      keep alive) changed.
 304 */
 305enum ieee80211_bss_change {
 306        BSS_CHANGED_ASSOC               = 1<<0,
 307        BSS_CHANGED_ERP_CTS_PROT        = 1<<1,
 308        BSS_CHANGED_ERP_PREAMBLE        = 1<<2,
 309        BSS_CHANGED_ERP_SLOT            = 1<<3,
 310        BSS_CHANGED_HT                  = 1<<4,
 311        BSS_CHANGED_BASIC_RATES         = 1<<5,
 312        BSS_CHANGED_BEACON_INT          = 1<<6,
 313        BSS_CHANGED_BSSID               = 1<<7,
 314        BSS_CHANGED_BEACON              = 1<<8,
 315        BSS_CHANGED_BEACON_ENABLED      = 1<<9,
 316        BSS_CHANGED_CQM                 = 1<<10,
 317        BSS_CHANGED_IBSS                = 1<<11,
 318        BSS_CHANGED_ARP_FILTER          = 1<<12,
 319        BSS_CHANGED_QOS                 = 1<<13,
 320        BSS_CHANGED_IDLE                = 1<<14,
 321        BSS_CHANGED_SSID                = 1<<15,
 322        BSS_CHANGED_AP_PROBE_RESP       = 1<<16,
 323        BSS_CHANGED_PS                  = 1<<17,
 324        BSS_CHANGED_TXPOWER             = 1<<18,
 325        BSS_CHANGED_P2P_PS              = 1<<19,
 326        BSS_CHANGED_BEACON_INFO         = 1<<20,
 327        BSS_CHANGED_BANDWIDTH           = 1<<21,
 328        BSS_CHANGED_OCB                 = 1<<22,
 329        BSS_CHANGED_MU_GROUPS           = 1<<23,
 330        BSS_CHANGED_KEEP_ALIVE          = 1<<24,
 331
 332        /* when adding here, make sure to change ieee80211_reconfig */
 333};
 334
 335/*
 336 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
 337 * of addresses for an interface increase beyond this value, hardware ARP
 338 * filtering will be disabled.
 339 */
 340#define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
 341
 342/**
 343 * enum ieee80211_event_type - event to be notified to the low level driver
 344 * @RSSI_EVENT: AP's rssi crossed the a threshold set by the driver.
 345 * @MLME_EVENT: event related to MLME
 346 * @BAR_RX_EVENT: a BAR was received
 347 * @BA_FRAME_TIMEOUT: Frames were released from the reordering buffer because
 348 *      they timed out. This won't be called for each frame released, but only
 349 *      once each time the timeout triggers.
 350 */
 351enum ieee80211_event_type {
 352        RSSI_EVENT,
 353        MLME_EVENT,
 354        BAR_RX_EVENT,
 355        BA_FRAME_TIMEOUT,
 356};
 357
 358/**
 359 * enum ieee80211_rssi_event_data - relevant when event type is %RSSI_EVENT
 360 * @RSSI_EVENT_HIGH: AP's rssi went below the threshold set by the driver.
 361 * @RSSI_EVENT_LOW: AP's rssi went above the threshold set by the driver.
 362 */
 363enum ieee80211_rssi_event_data {
 364        RSSI_EVENT_HIGH,
 365        RSSI_EVENT_LOW,
 366};
 367
 368/**
 369 * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT
 370 * @data: See &enum ieee80211_rssi_event_data
 371 */
 372struct ieee80211_rssi_event {
 373        enum ieee80211_rssi_event_data data;
 374};
 375
 376/**
 377 * enum ieee80211_mlme_event_data - relevant when event type is %MLME_EVENT
 378 * @AUTH_EVENT: the MLME operation is authentication
 379 * @ASSOC_EVENT: the MLME operation is association
 380 * @DEAUTH_RX_EVENT: deauth received..
 381 * @DEAUTH_TX_EVENT: deauth sent.
 382 */
 383enum ieee80211_mlme_event_data {
 384        AUTH_EVENT,
 385        ASSOC_EVENT,
 386        DEAUTH_RX_EVENT,
 387        DEAUTH_TX_EVENT,
 388};
 389
 390/**
 391 * enum ieee80211_mlme_event_status - relevant when event type is %MLME_EVENT
 392 * @MLME_SUCCESS: the MLME operation completed successfully.
 393 * @MLME_DENIED: the MLME operation was denied by the peer.
 394 * @MLME_TIMEOUT: the MLME operation timed out.
 395 */
 396enum ieee80211_mlme_event_status {
 397        MLME_SUCCESS,
 398        MLME_DENIED,
 399        MLME_TIMEOUT,
 400};
 401
 402/**
 403 * struct ieee80211_mlme_event - data attached to an %MLME_EVENT
 404 * @data: See &enum ieee80211_mlme_event_data
 405 * @status: See &enum ieee80211_mlme_event_status
 406 * @reason: the reason code if applicable
 407 */
 408struct ieee80211_mlme_event {
 409        enum ieee80211_mlme_event_data data;
 410        enum ieee80211_mlme_event_status status;
 411        u16 reason;
 412};
 413
 414/**
 415 * struct ieee80211_ba_event - data attached for BlockAck related events
 416 * @sta: pointer to the &ieee80211_sta to which this event relates
 417 * @tid: the tid
 418 * @ssn: the starting sequence number (for %BAR_RX_EVENT)
 419 */
 420struct ieee80211_ba_event {
 421        struct ieee80211_sta *sta;
 422        u16 tid;
 423        u16 ssn;
 424};
 425
 426/**
 427 * struct ieee80211_event - event to be sent to the driver
 428 * @type: The event itself. See &enum ieee80211_event_type.
 429 * @rssi: relevant if &type is %RSSI_EVENT
 430 * @mlme: relevant if &type is %AUTH_EVENT
 431 * @ba: relevant if &type is %BAR_RX_EVENT or %BA_FRAME_TIMEOUT
 432 * @u:union holding the fields above
 433 */
 434struct ieee80211_event {
 435        enum ieee80211_event_type type;
 436        union {
 437                struct ieee80211_rssi_event rssi;
 438                struct ieee80211_mlme_event mlme;
 439                struct ieee80211_ba_event ba;
 440        } u;
 441};
 442
 443/**
 444 * struct ieee80211_mu_group_data - STA's VHT MU-MIMO group data
 445 *
 446 * This structure describes the group id data of VHT MU-MIMO
 447 *
 448 * @membership: 64 bits array - a bit is set if station is member of the group
 449 * @position: 2 bits per group id indicating the position in the group
 450 */
 451struct ieee80211_mu_group_data {
 452        u8 membership[WLAN_MEMBERSHIP_LEN];
 453        u8 position[WLAN_USER_POSITION_LEN];
 454};
 455
 456/**
 457 * struct ieee80211_bss_conf - holds the BSS's changing parameters
 458 *
 459 * This structure keeps information about a BSS (and an association
 460 * to that BSS) that can change during the lifetime of the BSS.
 461 *
 462 * @assoc: association status
 463 * @ibss_joined: indicates whether this station is part of an IBSS
 464 *      or not
 465 * @ibss_creator: indicates if a new IBSS network is being created
 466 * @aid: association ID number, valid only when @assoc is true
 467 * @use_cts_prot: use CTS protection
 468 * @use_short_preamble: use 802.11b short preamble
 469 * @use_short_slot: use short slot time (only relevant for ERP)
 470 * @dtim_period: num of beacons before the next DTIM, for beaconing,
 471 *      valid in station mode only if after the driver was notified
 472 *      with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
 473 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
 474 *      as it may have been received during scanning long ago). If the
 475 *      HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
 476 *      only come from a beacon, but might not become valid until after
 477 *      association when a beacon is received (which is notified with the
 478 *      %BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice.
 479 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
 480 *      the driver/device can use this to calculate synchronisation
 481 *      (see @sync_tsf). See also sync_dtim_count important notice.
 482 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
 483 *      is requested, see @sync_tsf/@sync_device_ts.
 484 *      IMPORTANT: These three sync_* parameters would possibly be out of sync
 485 *      by the time the driver will use them. The synchronized view is currently
 486 *      guaranteed only in certain callbacks.
 487 * @beacon_int: beacon interval
 488 * @assoc_capability: capabilities taken from assoc resp
 489 * @basic_rates: bitmap of basic rates, each bit stands for an
 490 *      index into the rate table configured by the driver in
 491 *      the current band.
 492 * @beacon_rate: associated AP's beacon TX rate
 493 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
 494 * @bssid: The BSSID for this BSS
 495 * @enable_beacon: whether beaconing should be enabled or not
 496 * @chandef: Channel definition for this BSS -- the hardware might be
 497 *      configured a higher bandwidth than this BSS uses, for example.
 498 * @mu_group: VHT MU-MIMO group membership data
 499 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
 500 *      This field is only valid when the channel is a wide HT/VHT channel.
 501 *      Note that with TDLS this can be the case (channel is HT, protection must
 502 *      be used from this field) even when the BSS association isn't using HT.
 503 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
 504 *      implies disabled. As with the cfg80211 callback, a change here should
 505 *      cause an event to be sent indicating where the current value is in
 506 *      relation to the newly configured threshold.
 507 * @cqm_rssi_low: Connection quality monitor RSSI lower threshold, a zero value
 508 *      implies disabled.  This is an alternative mechanism to the single
 509 *      threshold event and can't be enabled simultaneously with it.
 510 * @cqm_rssi_high: Connection quality monitor RSSI upper threshold.
 511 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
 512 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
 513 *      may filter ARP queries targeted for other addresses than listed here.
 514 *      The driver must allow ARP queries targeted for all address listed here
 515 *      to pass through. An empty list implies no ARP queries need to pass.
 516 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
 517 *      may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
 518 *      array size), it's up to the driver what to do in that case.
 519 * @qos: This is a QoS-enabled BSS.
 520 * @idle: This interface is idle. There's also a global idle flag in the
 521 *      hardware config which may be more appropriate depending on what
 522 *      your driver/device needs to do.
 523 * @ps: power-save mode (STA only). This flag is NOT affected by
 524 *      offchannel/dynamic_ps operations.
 525 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
 526 * @ssid_len: Length of SSID given in @ssid.
 527 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
 528 * @txpower: TX power in dBm
 529 * @txpower_type: TX power adjustment used to control per packet Transmit
 530 *      Power Control (TPC) in lower driver for the current vif. In particular
 531 *      TPC is enabled if value passed in %txpower_type is
 532 *      NL80211_TX_POWER_LIMITED (allow using less than specified from
 533 *      userspace), whereas TPC is disabled if %txpower_type is set to
 534 *      NL80211_TX_POWER_FIXED (use value configured from userspace)
 535 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
 536 * @allow_p2p_go_ps: indication for AP or P2P GO interface, whether it's allowed
 537 *      to use P2P PS mechanism or not. AP/P2P GO is not allowed to use P2P PS
 538 *      if it has associated clients without P2P PS support.
 539 * @max_idle_period: the time period during which the station can refrain from
 540 *      transmitting frames to its associated AP without being disassociated.
 541 *      In units of 1000 TUs. Zero value indicates that the AP did not include
 542 *      a (valid) BSS Max Idle Period Element.
 543 * @protected_keep_alive: if set, indicates that the station should send an RSN
 544 *      protected frame to the AP to reset the idle timer at the AP for the
 545 *      station.
 546 */
 547struct ieee80211_bss_conf {
 548        const u8 *bssid;
 549        /* association related data */
 550        bool assoc, ibss_joined;
 551        bool ibss_creator;
 552        u16 aid;
 553        /* erp related data */
 554        bool use_cts_prot;
 555        bool use_short_preamble;
 556        bool use_short_slot;
 557        bool enable_beacon;
 558        u8 dtim_period;
 559        u16 beacon_int;
 560        u16 assoc_capability;
 561        u64 sync_tsf;
 562        u32 sync_device_ts;
 563        u8 sync_dtim_count;
 564        u32 basic_rates;
 565        struct ieee80211_rate *beacon_rate;
 566        int mcast_rate[NUM_NL80211_BANDS];
 567        u16 ht_operation_mode;
 568        s32 cqm_rssi_thold;
 569        u32 cqm_rssi_hyst;
 570        s32 cqm_rssi_low;
 571        s32 cqm_rssi_high;
 572        struct cfg80211_chan_def chandef;
 573        struct ieee80211_mu_group_data mu_group;
 574        __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
 575        int arp_addr_cnt;
 576        bool qos;
 577        bool idle;
 578        bool ps;
 579        u8 ssid[IEEE80211_MAX_SSID_LEN];
 580        size_t ssid_len;
 581        bool hidden_ssid;
 582        int txpower;
 583        enum nl80211_tx_power_setting txpower_type;
 584        struct ieee80211_p2p_noa_attr p2p_noa_attr;
 585        bool allow_p2p_go_ps;
 586        u16 max_idle_period;
 587        bool protected_keep_alive;
 588};
 589
 590/**
 591 * enum mac80211_tx_info_flags - flags to describe transmission information/status
 592 *
 593 * These flags are used with the @flags member of &ieee80211_tx_info.
 594 *
 595 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
 596 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
 597 *      number to this frame, taking care of not overwriting the fragment
 598 *      number and increasing the sequence number only when the
 599 *      IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
 600 *      assign sequence numbers to QoS-data frames but cannot do so correctly
 601 *      for non-QoS-data and management frames because beacons need them from
 602 *      that counter as well and mac80211 cannot guarantee proper sequencing.
 603 *      If this flag is set, the driver should instruct the hardware to
 604 *      assign a sequence number to the frame or assign one itself. Cf. IEEE
 605 *      802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
 606 *      beacons and always be clear for frames without a sequence number field.
 607 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
 608 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
 609 *      station
 610 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
 611 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
 612 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
 613 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
 614 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
 615 *      because the destination STA was in powersave mode. Note that to
 616 *      avoid race conditions, the filter must be set by the hardware or
 617 *      firmware upon receiving a frame that indicates that the station
 618 *      went to sleep (must be done on device to filter frames already on
 619 *      the queue) and may only be unset after mac80211 gives the OK for
 620 *      that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
 621 *      since only then is it guaranteed that no more frames are in the
 622 *      hardware queue.
 623 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
 624 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
 625 *      is for the whole aggregation.
 626 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
 627 *      so consider using block ack request (BAR).
 628 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
 629 *      set by rate control algorithms to indicate probe rate, will
 630 *      be cleared for fragmented frames (except on the last fragment)
 631 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
 632 *      that a frame can be transmitted while the queues are stopped for
 633 *      off-channel operation.
 634 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
 635 *      used to indicate that a pending frame requires TX processing before
 636 *      it can be sent out.
 637 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
 638 *      used to indicate that a frame was already retried due to PS
 639 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
 640 *      used to indicate frame should not be encrypted
 641 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
 642 *      frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
 643 *      be sent although the station is in powersave mode.
 644 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
 645 *      transmit function after the current frame, this can be used
 646 *      by drivers to kick the DMA queue only if unset or when the
 647 *      queue gets full.
 648 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
 649 *      after TX status because the destination was asleep, it must not
 650 *      be modified again (no seqno assignment, crypto, etc.)
 651 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
 652 *      code for connection establishment, this indicates that its status
 653 *      should kick the MLME state machine.
 654 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
 655 *      MLME command (internal to mac80211 to figure out whether to send TX
 656 *      status to user space)
 657 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
 658 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
 659 *      frame and selects the maximum number of streams that it can use.
 660 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
 661 *      the off-channel channel when a remain-on-channel offload is done
 662 *      in hardware -- normal packets still flow and are expected to be
 663 *      handled properly by the device.
 664 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
 665 *      testing. It will be sent out with incorrect Michael MIC key to allow
 666 *      TKIP countermeasures to be tested.
 667 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
 668 *      This flag is actually used for management frame especially for P2P
 669 *      frames not being sent at CCK rate in 2GHz band.
 670 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
 671 *      when its status is reported the service period ends. For frames in
 672 *      an SP that mac80211 transmits, it is already set; for driver frames
 673 *      the driver may set this flag. It is also used to do the same for
 674 *      PS-Poll responses.
 675 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
 676 *      This flag is used to send nullfunc frame at minimum rate when
 677 *      the nullfunc is used for connection monitoring purpose.
 678 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
 679 *      would be fragmented by size (this is optional, only used for
 680 *      monitor injection).
 681 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
 682 *      IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
 683 *      any errors (like issues specific to the driver/HW).
 684 *      This flag must not be set for frames that don't request no-ack
 685 *      behaviour with IEEE80211_TX_CTL_NO_ACK.
 686 *
 687 * Note: If you have to add new flags to the enumeration, then don't
 688 *       forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
 689 */
 690enum mac80211_tx_info_flags {
 691        IEEE80211_TX_CTL_REQ_TX_STATUS          = BIT(0),
 692        IEEE80211_TX_CTL_ASSIGN_SEQ             = BIT(1),
 693        IEEE80211_TX_CTL_NO_ACK                 = BIT(2),
 694        IEEE80211_TX_CTL_CLEAR_PS_FILT          = BIT(3),
 695        IEEE80211_TX_CTL_FIRST_FRAGMENT         = BIT(4),
 696        IEEE80211_TX_CTL_SEND_AFTER_DTIM        = BIT(5),
 697        IEEE80211_TX_CTL_AMPDU                  = BIT(6),
 698        IEEE80211_TX_CTL_INJECTED               = BIT(7),
 699        IEEE80211_TX_STAT_TX_FILTERED           = BIT(8),
 700        IEEE80211_TX_STAT_ACK                   = BIT(9),
 701        IEEE80211_TX_STAT_AMPDU                 = BIT(10),
 702        IEEE80211_TX_STAT_AMPDU_NO_BACK         = BIT(11),
 703        IEEE80211_TX_CTL_RATE_CTRL_PROBE        = BIT(12),
 704        IEEE80211_TX_INTFL_OFFCHAN_TX_OK        = BIT(13),
 705        IEEE80211_TX_INTFL_NEED_TXPROCESSING    = BIT(14),
 706        IEEE80211_TX_INTFL_RETRIED              = BIT(15),
 707        IEEE80211_TX_INTFL_DONT_ENCRYPT         = BIT(16),
 708        IEEE80211_TX_CTL_NO_PS_BUFFER           = BIT(17),
 709        IEEE80211_TX_CTL_MORE_FRAMES            = BIT(18),
 710        IEEE80211_TX_INTFL_RETRANSMISSION       = BIT(19),
 711        IEEE80211_TX_INTFL_MLME_CONN_TX         = BIT(20),
 712        IEEE80211_TX_INTFL_NL80211_FRAME_TX     = BIT(21),
 713        IEEE80211_TX_CTL_LDPC                   = BIT(22),
 714        IEEE80211_TX_CTL_STBC                   = BIT(23) | BIT(24),
 715        IEEE80211_TX_CTL_TX_OFFCHAN             = BIT(25),
 716        IEEE80211_TX_INTFL_TKIP_MIC_FAILURE     = BIT(26),
 717        IEEE80211_TX_CTL_NO_CCK_RATE            = BIT(27),
 718        IEEE80211_TX_STATUS_EOSP                = BIT(28),
 719        IEEE80211_TX_CTL_USE_MINRATE            = BIT(29),
 720        IEEE80211_TX_CTL_DONTFRAG               = BIT(30),
 721        IEEE80211_TX_STAT_NOACK_TRANSMITTED     = BIT(31),
 722};
 723
 724#define IEEE80211_TX_CTL_STBC_SHIFT             23
 725
 726/**
 727 * enum mac80211_tx_control_flags - flags to describe transmit control
 728 *
 729 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
 730 *      protocol frame (e.g. EAP)
 731 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
 732 *      frame (PS-Poll or uAPSD).
 733 * @IEEE80211_TX_CTRL_RATE_INJECT: This frame is injected with rate information
 734 * @IEEE80211_TX_CTRL_AMSDU: This frame is an A-MSDU frame
 735 * @IEEE80211_TX_CTRL_FAST_XMIT: This frame is going through the fast_xmit path
 736 *
 737 * These flags are used in tx_info->control.flags.
 738 */
 739enum mac80211_tx_control_flags {
 740        IEEE80211_TX_CTRL_PORT_CTRL_PROTO       = BIT(0),
 741        IEEE80211_TX_CTRL_PS_RESPONSE           = BIT(1),
 742        IEEE80211_TX_CTRL_RATE_INJECT           = BIT(2),
 743        IEEE80211_TX_CTRL_AMSDU                 = BIT(3),
 744        IEEE80211_TX_CTRL_FAST_XMIT             = BIT(4),
 745};
 746
 747/*
 748 * This definition is used as a mask to clear all temporary flags, which are
 749 * set by the tx handlers for each transmission attempt by the mac80211 stack.
 750 */
 751#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK |               \
 752        IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT |    \
 753        IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU |           \
 754        IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK |               \
 755        IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK |           \
 756        IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER |    \
 757        IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC |                \
 758        IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
 759
 760/**
 761 * enum mac80211_rate_control_flags - per-rate flags set by the
 762 *      Rate Control algorithm.
 763 *
 764 * These flags are set by the Rate control algorithm for each rate during tx,
 765 * in the @flags member of struct ieee80211_tx_rate.
 766 *
 767 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
 768 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
 769 *      This is set if the current BSS requires ERP protection.
 770 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
 771 * @IEEE80211_TX_RC_MCS: HT rate.
 772 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
 773 *      into a higher 4 bits (Nss) and lower 4 bits (MCS number)
 774 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
 775 *      Greenfield mode.
 776 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
 777 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
 778 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
 779 *      (80+80 isn't supported yet)
 780 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
 781 *      adjacent 20 MHz channels, if the current channel type is
 782 *      NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
 783 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
 784 */
 785enum mac80211_rate_control_flags {
 786        IEEE80211_TX_RC_USE_RTS_CTS             = BIT(0),
 787        IEEE80211_TX_RC_USE_CTS_PROTECT         = BIT(1),
 788        IEEE80211_TX_RC_USE_SHORT_PREAMBLE      = BIT(2),
 789
 790        /* rate index is an HT/VHT MCS instead of an index */
 791        IEEE80211_TX_RC_MCS                     = BIT(3),
 792        IEEE80211_TX_RC_GREEN_FIELD             = BIT(4),
 793        IEEE80211_TX_RC_40_MHZ_WIDTH            = BIT(5),
 794        IEEE80211_TX_RC_DUP_DATA                = BIT(6),
 795        IEEE80211_TX_RC_SHORT_GI                = BIT(7),
 796        IEEE80211_TX_RC_VHT_MCS                 = BIT(8),
 797        IEEE80211_TX_RC_80_MHZ_WIDTH            = BIT(9),
 798        IEEE80211_TX_RC_160_MHZ_WIDTH           = BIT(10),
 799};
 800
 801
 802/* there are 40 bytes if you don't need the rateset to be kept */
 803#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
 804
 805/* if you do need the rateset, then you have less space */
 806#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
 807
 808/* maximum number of rate stages */
 809#define IEEE80211_TX_MAX_RATES  4
 810
 811/* maximum number of rate table entries */
 812#define IEEE80211_TX_RATE_TABLE_SIZE    4
 813
 814/**
 815 * struct ieee80211_tx_rate - rate selection/status
 816 *
 817 * @idx: rate index to attempt to send with
 818 * @flags: rate control flags (&enum mac80211_rate_control_flags)
 819 * @count: number of tries in this rate before going to the next rate
 820 *
 821 * A value of -1 for @idx indicates an invalid rate and, if used
 822 * in an array of retry rates, that no more rates should be tried.
 823 *
 824 * When used for transmit status reporting, the driver should
 825 * always report the rate along with the flags it used.
 826 *
 827 * &struct ieee80211_tx_info contains an array of these structs
 828 * in the control information, and it will be filled by the rate
 829 * control algorithm according to what should be sent. For example,
 830 * if this array contains, in the format { <idx>, <count> } the
 831 * information::
 832 *
 833 *    { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
 834 *
 835 * then this means that the frame should be transmitted
 836 * up to twice at rate 3, up to twice at rate 2, and up to four
 837 * times at rate 1 if it doesn't get acknowledged. Say it gets
 838 * acknowledged by the peer after the fifth attempt, the status
 839 * information should then contain::
 840 *
 841 *   { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
 842 *
 843 * since it was transmitted twice at rate 3, twice at rate 2
 844 * and once at rate 1 after which we received an acknowledgement.
 845 */
 846struct ieee80211_tx_rate {
 847        s8 idx;
 848        u16 count:5,
 849            flags:11;
 850} __packed;
 851
 852#define IEEE80211_MAX_TX_RETRY          31
 853
 854static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
 855                                          u8 mcs, u8 nss)
 856{
 857        WARN_ON(mcs & ~0xF);
 858        WARN_ON((nss - 1) & ~0x7);
 859        rate->idx = ((nss - 1) << 4) | mcs;
 860}
 861
 862static inline u8
 863ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
 864{
 865        return rate->idx & 0xF;
 866}
 867
 868static inline u8
 869ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
 870{
 871        return (rate->idx >> 4) + 1;
 872}
 873
 874/**
 875 * struct ieee80211_tx_info - skb transmit information
 876 *
 877 * This structure is placed in skb->cb for three uses:
 878 *  (1) mac80211 TX control - mac80211 tells the driver what to do
 879 *  (2) driver internal use (if applicable)
 880 *  (3) TX status information - driver tells mac80211 what happened
 881 *
 882 * @flags: transmit info flags, defined above
 883 * @band: the band to transmit on (use for checking for races)
 884 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
 885 * @ack_frame_id: internal frame ID for TX status, used internally
 886 * @control: union for control data
 887 * @status: union for status data
 888 * @driver_data: array of driver_data pointers
 889 * @ampdu_ack_len: number of acked aggregated frames.
 890 *      relevant only if IEEE80211_TX_STAT_AMPDU was set.
 891 * @ampdu_len: number of aggregated frames.
 892 *      relevant only if IEEE80211_TX_STAT_AMPDU was set.
 893 * @ack_signal: signal strength of the ACK frame
 894 */
 895struct ieee80211_tx_info {
 896        /* common information */
 897        u32 flags;
 898        u8 band;
 899
 900        u8 hw_queue;
 901
 902        u16 ack_frame_id;
 903
 904        union {
 905                struct {
 906                        union {
 907                                /* rate control */
 908                                struct {
 909                                        struct ieee80211_tx_rate rates[
 910                                                IEEE80211_TX_MAX_RATES];
 911                                        s8 rts_cts_rate_idx;
 912                                        u8 use_rts:1;
 913                                        u8 use_cts_prot:1;
 914                                        u8 short_preamble:1;
 915                                        u8 skip_table:1;
 916                                        /* 2 bytes free */
 917                                };
 918                                /* only needed before rate control */
 919                                unsigned long jiffies;
 920                        };
 921                        /* NB: vif can be NULL for injected frames */
 922                        struct ieee80211_vif *vif;
 923                        struct ieee80211_key_conf *hw_key;
 924                        u32 flags;
 925                        codel_time_t enqueue_time;
 926                } control;
 927                struct {
 928                        u64 cookie;
 929                } ack;
 930                struct {
 931                        struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
 932                        s32 ack_signal;
 933                        u8 ampdu_ack_len;
 934                        u8 ampdu_len;
 935                        u8 antenna;
 936                        u16 tx_time;
 937                        void *status_driver_data[19 / sizeof(void *)];
 938                } status;
 939                struct {
 940                        struct ieee80211_tx_rate driver_rates[
 941                                IEEE80211_TX_MAX_RATES];
 942                        u8 pad[4];
 943
 944                        void *rate_driver_data[
 945                                IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
 946                };
 947                void *driver_data[
 948                        IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
 949        };
 950};
 951
 952/**
 953 * struct ieee80211_tx_status - extended tx staus info for rate control
 954 *
 955 * @sta: Station that the packet was transmitted for
 956 * @info: Basic tx status information
 957 * @skb: Packet skb (can be NULL if not provided by the driver)
 958 */
 959struct ieee80211_tx_status {
 960        struct ieee80211_sta *sta;
 961        struct ieee80211_tx_info *info;
 962        struct sk_buff *skb;
 963};
 964
 965/**
 966 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
 967 *
 968 * This structure is used to point to different blocks of IEs in HW scan
 969 * and scheduled scan. These blocks contain the IEs passed by userspace
 970 * and the ones generated by mac80211.
 971 *
 972 * @ies: pointers to band specific IEs.
 973 * @len: lengths of band_specific IEs.
 974 * @common_ies: IEs for all bands (especially vendor specific ones)
 975 * @common_ie_len: length of the common_ies
 976 */
 977struct ieee80211_scan_ies {
 978        const u8 *ies[NUM_NL80211_BANDS];
 979        size_t len[NUM_NL80211_BANDS];
 980        const u8 *common_ies;
 981        size_t common_ie_len;
 982};
 983
 984
 985static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
 986{
 987        return (struct ieee80211_tx_info *)skb->cb;
 988}
 989
 990static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
 991{
 992        return (struct ieee80211_rx_status *)skb->cb;
 993}
 994
 995/**
 996 * ieee80211_tx_info_clear_status - clear TX status
 997 *
 998 * @info: The &struct ieee80211_tx_info to be cleared.
 999 *
1000 * When the driver passes an skb back to mac80211, it must report
1001 * a number of things in TX status. This function clears everything
1002 * in the TX status but the rate control information (it does clear
1003 * the count since you need to fill that in anyway).
1004 *
1005 * NOTE: You can only use this function if you do NOT use
1006 *       info->driver_data! Use info->rate_driver_data
1007 *       instead if you need only the less space that allows.
1008 */
1009static inline void
1010ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
1011{
1012        int i;
1013
1014        BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
1015                     offsetof(struct ieee80211_tx_info, control.rates));
1016        BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
1017                     offsetof(struct ieee80211_tx_info, driver_rates));
1018        BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
1019        /* clear the rate counts */
1020        for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
1021                info->status.rates[i].count = 0;
1022
1023        BUILD_BUG_ON(
1024            offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
1025        memset(&info->status.ampdu_ack_len, 0,
1026               sizeof(struct ieee80211_tx_info) -
1027               offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
1028}
1029
1030
1031/**
1032 * enum mac80211_rx_flags - receive flags
1033 *
1034 * These flags are used with the @flag member of &struct ieee80211_rx_status.
1035 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
1036 *      Use together with %RX_FLAG_MMIC_STRIPPED.
1037 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
1038 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
1039 *      verification has been done by the hardware.
1040 * @RX_FLAG_IV_STRIPPED: The IV and ICV are stripped from this frame.
1041 *      If this flag is set, the stack cannot do any replay detection
1042 *      hence the driver or hardware will have to do that.
1043 * @RX_FLAG_PN_VALIDATED: Currently only valid for CCMP/GCMP frames, this
1044 *      flag indicates that the PN was verified for replay protection.
1045 *      Note that this flag is also currently only supported when a frame
1046 *      is also decrypted (ie. @RX_FLAG_DECRYPTED must be set)
1047 * @RX_FLAG_DUP_VALIDATED: The driver should set this flag if it did
1048 *      de-duplication by itself.
1049 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
1050 *      the frame.
1051 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
1052 *      the frame.
1053 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
1054 *      field) is valid and contains the time the first symbol of the MPDU
1055 *      was received. This is useful in monitor mode and for proper IBSS
1056 *      merging.
1057 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
1058 *      field) is valid and contains the time the last symbol of the MPDU
1059 *      (including FCS) was received.
1060 * @RX_FLAG_MACTIME_PLCP_START: The timestamp passed in the RX status (@mactime
1061 *      field) is valid and contains the time the SYNC preamble was received.
1062 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
1063 *      Valid only for data frames (mainly A-MPDU)
1064 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
1065 *      number (@ampdu_reference) must be populated and be a distinct number for
1066 *      each A-MPDU
1067 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
1068 *      subframes of a single A-MPDU
1069 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
1070 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
1071 *      on this subframe
1072 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
1073 *      is stored in the @ampdu_delimiter_crc field)
1074 * @RX_FLAG_MIC_STRIPPED: The mic was stripped of this packet. Decryption was
1075 *      done by the hardware
1076 * @RX_FLAG_ONLY_MONITOR: Report frame only to monitor interfaces without
1077 *      processing it in any regular way.
1078 *      This is useful if drivers offload some frames but still want to report
1079 *      them for sniffing purposes.
1080 * @RX_FLAG_SKIP_MONITOR: Process and report frame to all interfaces except
1081 *      monitor interfaces.
1082 *      This is useful if drivers offload some frames but still want to report
1083 *      them for sniffing purposes.
1084 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
1085 *      subframes instead of a one huge frame for performance reasons.
1086 *      All, but the last MSDU from an A-MSDU should have this flag set. E.g.
1087 *      if an A-MSDU has 3 frames, the first 2 must have the flag set, while
1088 *      the 3rd (last) one must not have this flag set. The flag is used to
1089 *      deal with retransmission/duplication recovery properly since A-MSDU
1090 *      subframes share the same sequence number. Reported subframes can be
1091 *      either regular MSDU or singly A-MSDUs. Subframes must not be
1092 *      interleaved with other frames.
1093 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific
1094 *      radiotap data in the skb->data (before the frame) as described by
1095 *      the &struct ieee80211_vendor_radiotap.
1096 * @RX_FLAG_ALLOW_SAME_PN: Allow the same PN as same packet before.
1097 *      This is used for AMSDU subframes which can have the same PN as
1098 *      the first subframe.
1099 * @RX_FLAG_ICV_STRIPPED: The ICV is stripped from this frame. CRC checking must
1100 *      be done in the hardware.
1101 */
1102enum mac80211_rx_flags {
1103        RX_FLAG_MMIC_ERROR              = BIT(0),
1104        RX_FLAG_DECRYPTED               = BIT(1),
1105        RX_FLAG_MACTIME_PLCP_START      = BIT(2),
1106        RX_FLAG_MMIC_STRIPPED           = BIT(3),
1107        RX_FLAG_IV_STRIPPED             = BIT(4),
1108        RX_FLAG_FAILED_FCS_CRC          = BIT(5),
1109        RX_FLAG_FAILED_PLCP_CRC         = BIT(6),
1110        RX_FLAG_MACTIME_START           = BIT(7),
1111        RX_FLAG_NO_SIGNAL_VAL           = BIT(8),
1112        RX_FLAG_AMPDU_DETAILS           = BIT(9),
1113        RX_FLAG_PN_VALIDATED            = BIT(10),
1114        RX_FLAG_DUP_VALIDATED           = BIT(11),
1115        RX_FLAG_AMPDU_LAST_KNOWN        = BIT(12),
1116        RX_FLAG_AMPDU_IS_LAST           = BIT(13),
1117        RX_FLAG_AMPDU_DELIM_CRC_ERROR   = BIT(14),
1118        RX_FLAG_AMPDU_DELIM_CRC_KNOWN   = BIT(15),
1119        RX_FLAG_MACTIME_END             = BIT(16),
1120        RX_FLAG_ONLY_MONITOR            = BIT(17),
1121        RX_FLAG_SKIP_MONITOR            = BIT(18),
1122        RX_FLAG_AMSDU_MORE              = BIT(19),
1123        RX_FLAG_RADIOTAP_VENDOR_DATA    = BIT(20),
1124        RX_FLAG_MIC_STRIPPED            = BIT(21),
1125        RX_FLAG_ALLOW_SAME_PN           = BIT(22),
1126        RX_FLAG_ICV_STRIPPED            = BIT(23),
1127};
1128
1129/**
1130 * enum mac80211_rx_encoding_flags - MCS & bandwidth flags
1131 *
1132 * @RX_ENC_FLAG_SHORTPRE: Short preamble was used for this frame
1133 * @RX_ENC_FLAG_SHORT_GI: Short guard interval was used
1134 * @RX_ENC_FLAG_HT_GF: This frame was received in a HT-greenfield transmission,
1135 *      if the driver fills this value it should add
1136 *      %IEEE80211_RADIOTAP_MCS_HAVE_FMT
1137 *      to hw.radiotap_mcs_details to advertise that fact
1138 * @RX_ENC_FLAG_LDPC: LDPC was used
1139 * @RX_ENC_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
1140 * @RX_ENC_FLAG_BF: packet was beamformed
1141 */
1142enum mac80211_rx_encoding_flags {
1143        RX_ENC_FLAG_SHORTPRE            = BIT(0),
1144        RX_ENC_FLAG_SHORT_GI            = BIT(2),
1145        RX_ENC_FLAG_HT_GF               = BIT(3),
1146        RX_ENC_FLAG_STBC_MASK           = BIT(4) | BIT(5),
1147        RX_ENC_FLAG_LDPC                = BIT(6),
1148        RX_ENC_FLAG_BF                  = BIT(7),
1149};
1150
1151#define RX_ENC_FLAG_STBC_SHIFT          4
1152
1153enum mac80211_rx_encoding {
1154        RX_ENC_LEGACY = 0,
1155        RX_ENC_HT,
1156        RX_ENC_VHT,
1157};
1158
1159/**
1160 * struct ieee80211_rx_status - receive status
1161 *
1162 * The low-level driver should provide this information (the subset
1163 * supported by hardware) to the 802.11 code with each received
1164 * frame, in the skb's control buffer (cb).
1165 *
1166 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
1167 *      (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
1168 * @boottime_ns: CLOCK_BOOTTIME timestamp the frame was received at, this is
1169 *      needed only for beacons and probe responses that update the scan cache.
1170 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
1171 *      it but can store it and pass it back to the driver for synchronisation
1172 * @band: the active band when this frame was received
1173 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
1174 *      This field must be set for management frames, but isn't strictly needed
1175 *      for data (other) frames - for those it only affects radiotap reporting.
1176 * @signal: signal strength when receiving this frame, either in dBm, in dB or
1177 *      unspecified depending on the hardware capabilities flags
1178 *      @IEEE80211_HW_SIGNAL_*
1179 * @chains: bitmask of receive chains for which separate signal strength
1180 *      values were filled.
1181 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
1182 *      support dB or unspecified units)
1183 * @antenna: antenna used
1184 * @rate_idx: index of data rate into band's supported rates or MCS index if
1185 *      HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
1186 * @nss: number of streams (VHT and HE only)
1187 * @flag: %RX_FLAG_\*
1188 * @encoding: &enum mac80211_rx_encoding
1189 * @bw: &enum rate_info_bw
1190 * @enc_flags: uses bits from &enum mac80211_rx_encoding_flags
1191 * @rx_flags: internal RX flags for mac80211
1192 * @ampdu_reference: A-MPDU reference number, must be a different value for
1193 *      each A-MPDU but the same for each subframe within one A-MPDU
1194 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
1195 */
1196struct ieee80211_rx_status {
1197        u64 mactime;
1198        u64 boottime_ns;
1199        u32 device_timestamp;
1200        u32 ampdu_reference;
1201        u32 flag;
1202        u16 freq;
1203        u8 enc_flags;
1204        u8 encoding:2, bw:3;
1205        u8 rate_idx;
1206        u8 nss;
1207        u8 rx_flags;
1208        u8 band;
1209        u8 antenna;
1210        s8 signal;
1211        u8 chains;
1212        s8 chain_signal[IEEE80211_MAX_CHAINS];
1213        u8 ampdu_delimiter_crc;
1214};
1215
1216/**
1217 * struct ieee80211_vendor_radiotap - vendor radiotap data information
1218 * @present: presence bitmap for this vendor namespace
1219 *      (this could be extended in the future if any vendor needs more
1220 *       bits, the radiotap spec does allow for that)
1221 * @align: radiotap vendor namespace alignment. This defines the needed
1222 *      alignment for the @data field below, not for the vendor namespace
1223 *      description itself (which has a fixed 2-byte alignment)
1224 *      Must be a power of two, and be set to at least 1!
1225 * @oui: radiotap vendor namespace OUI
1226 * @subns: radiotap vendor sub namespace
1227 * @len: radiotap vendor sub namespace skip length, if alignment is done
1228 *      then that's added to this, i.e. this is only the length of the
1229 *      @data field.
1230 * @pad: number of bytes of padding after the @data, this exists so that
1231 *      the skb data alignment can be preserved even if the data has odd
1232 *      length
1233 * @data: the actual vendor namespace data
1234 *
1235 * This struct, including the vendor data, goes into the skb->data before
1236 * the 802.11 header. It's split up in mac80211 using the align/oui/subns
1237 * data.
1238 */
1239struct ieee80211_vendor_radiotap {
1240        u32 present;
1241        u8 align;
1242        u8 oui[3];
1243        u8 subns;
1244        u8 pad;
1245        u16 len;
1246        u8 data[];
1247} __packed;
1248
1249/**
1250 * enum ieee80211_conf_flags - configuration flags
1251 *
1252 * Flags to define PHY configuration options
1253 *
1254 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1255 *      to determine for example whether to calculate timestamps for packets
1256 *      or not, do not use instead of filter flags!
1257 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1258 *      This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1259 *      meaning that the hardware still wakes up for beacons, is able to
1260 *      transmit frames and receive the possible acknowledgment frames.
1261 *      Not to be confused with hardware specific wakeup/sleep states,
1262 *      driver is responsible for that. See the section "Powersave support"
1263 *      for more.
1264 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1265 *      the driver should be prepared to handle configuration requests but
1266 *      may turn the device off as much as possible. Typically, this flag will
1267 *      be set when an interface is set UP but not associated or scanning, but
1268 *      it can also be unset in that case when monitor interfaces are active.
1269 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1270 *      operating channel.
1271 */
1272enum ieee80211_conf_flags {
1273        IEEE80211_CONF_MONITOR          = (1<<0),
1274        IEEE80211_CONF_PS               = (1<<1),
1275        IEEE80211_CONF_IDLE             = (1<<2),
1276        IEEE80211_CONF_OFFCHANNEL       = (1<<3),
1277};
1278
1279
1280/**
1281 * enum ieee80211_conf_changed - denotes which configuration changed
1282 *
1283 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1284 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1285 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1286 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1287 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1288 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1289 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1290 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1291 *      Note that this is only valid if channel contexts are not used,
1292 *      otherwise each channel context has the number of chains listed.
1293 */
1294enum ieee80211_conf_changed {
1295        IEEE80211_CONF_CHANGE_SMPS              = BIT(1),
1296        IEEE80211_CONF_CHANGE_LISTEN_INTERVAL   = BIT(2),
1297        IEEE80211_CONF_CHANGE_MONITOR           = BIT(3),
1298        IEEE80211_CONF_CHANGE_PS                = BIT(4),
1299        IEEE80211_CONF_CHANGE_POWER             = BIT(5),
1300        IEEE80211_CONF_CHANGE_CHANNEL           = BIT(6),
1301        IEEE80211_CONF_CHANGE_RETRY_LIMITS      = BIT(7),
1302        IEEE80211_CONF_CHANGE_IDLE              = BIT(8),
1303};
1304
1305/**
1306 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1307 *
1308 * @IEEE80211_SMPS_AUTOMATIC: automatic
1309 * @IEEE80211_SMPS_OFF: off
1310 * @IEEE80211_SMPS_STATIC: static
1311 * @IEEE80211_SMPS_DYNAMIC: dynamic
1312 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1313 */
1314enum ieee80211_smps_mode {
1315        IEEE80211_SMPS_AUTOMATIC,
1316        IEEE80211_SMPS_OFF,
1317        IEEE80211_SMPS_STATIC,
1318        IEEE80211_SMPS_DYNAMIC,
1319
1320        /* keep last */
1321        IEEE80211_SMPS_NUM_MODES,
1322};
1323
1324/**
1325 * struct ieee80211_conf - configuration of the device
1326 *
1327 * This struct indicates how the driver shall configure the hardware.
1328 *
1329 * @flags: configuration flags defined above
1330 *
1331 * @listen_interval: listen interval in units of beacon interval
1332 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1333 *      in power saving. Power saving will not be enabled until a beacon
1334 *      has been received and the DTIM period is known.
1335 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1336 *      powersave documentation below. This variable is valid only when
1337 *      the CONF_PS flag is set.
1338 *
1339 * @power_level: requested transmit power (in dBm), backward compatibility
1340 *      value only that is set to the minimum of all interfaces
1341 *
1342 * @chandef: the channel definition to tune to
1343 * @radar_enabled: whether radar detection is enabled
1344 *
1345 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1346 *      (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1347 *      but actually means the number of transmissions not the number of retries
1348 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1349 *      frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1350 *      number of transmissions not the number of retries
1351 *
1352 * @smps_mode: spatial multiplexing powersave mode; note that
1353 *      %IEEE80211_SMPS_STATIC is used when the device is not
1354 *      configured for an HT channel.
1355 *      Note that this is only valid if channel contexts are not used,
1356 *      otherwise each channel context has the number of chains listed.
1357 */
1358struct ieee80211_conf {
1359        u32 flags;
1360        int power_level, dynamic_ps_timeout;
1361
1362        u16 listen_interval;
1363        u8 ps_dtim_period;
1364
1365        u8 long_frame_max_tx_count, short_frame_max_tx_count;
1366
1367        struct cfg80211_chan_def chandef;
1368        bool radar_enabled;
1369        enum ieee80211_smps_mode smps_mode;
1370};
1371
1372/**
1373 * struct ieee80211_channel_switch - holds the channel switch data
1374 *
1375 * The information provided in this structure is required for channel switch
1376 * operation.
1377 *
1378 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1379 *      Function (TSF) timer when the frame containing the channel switch
1380 *      announcement was received. This is simply the rx.mactime parameter
1381 *      the driver passed into mac80211.
1382 * @device_timestamp: arbitrary timestamp for the device, this is the
1383 *      rx.device_timestamp parameter the driver passed to mac80211.
1384 * @block_tx: Indicates whether transmission must be blocked before the
1385 *      scheduled channel switch, as indicated by the AP.
1386 * @chandef: the new channel to switch to
1387 * @count: the number of TBTT's until the channel switch event
1388 */
1389struct ieee80211_channel_switch {
1390        u64 timestamp;
1391        u32 device_timestamp;
1392        bool block_tx;
1393        struct cfg80211_chan_def chandef;
1394        u8 count;
1395};
1396
1397/**
1398 * enum ieee80211_vif_flags - virtual interface flags
1399 *
1400 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1401 *      on this virtual interface to avoid unnecessary CPU wakeups
1402 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1403 *      monitoring on this virtual interface -- i.e. it can monitor
1404 *      connection quality related parameters, such as the RSSI level and
1405 *      provide notifications if configured trigger levels are reached.
1406 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this
1407 *      interface. This flag should be set during interface addition,
1408 *      but may be set/cleared as late as authentication to an AP. It is
1409 *      only valid for managed/station mode interfaces.
1410 * @IEEE80211_VIF_GET_NOA_UPDATE: request to handle NOA attributes
1411 *      and send P2P_PS notification to the driver if NOA changed, even
1412 *      this is not pure P2P vif.
1413 */
1414enum ieee80211_vif_flags {
1415        IEEE80211_VIF_BEACON_FILTER             = BIT(0),
1416        IEEE80211_VIF_SUPPORTS_CQM_RSSI         = BIT(1),
1417        IEEE80211_VIF_SUPPORTS_UAPSD            = BIT(2),
1418        IEEE80211_VIF_GET_NOA_UPDATE            = BIT(3),
1419};
1420
1421/**
1422 * struct ieee80211_vif - per-interface data
1423 *
1424 * Data in this structure is continually present for driver
1425 * use during the life of a virtual interface.
1426 *
1427 * @type: type of this virtual interface
1428 * @bss_conf: BSS configuration for this interface, either our own
1429 *      or the BSS we're associated to
1430 * @addr: address of this interface
1431 * @p2p: indicates whether this AP or STA interface is a p2p
1432 *      interface, i.e. a GO or p2p-sta respectively
1433 * @csa_active: marks whether a channel switch is going on. Internally it is
1434 *      write-protected by sdata_lock and local->mtx so holding either is fine
1435 *      for read access.
1436 * @mu_mimo_owner: indicates interface owns MU-MIMO capability
1437 * @driver_flags: flags/capabilities the driver has for this interface,
1438 *      these need to be set (or cleared) when the interface is added
1439 *      or, if supported by the driver, the interface type is changed
1440 *      at runtime, mac80211 will never touch this field
1441 * @hw_queue: hardware queue for each AC
1442 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1443 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1444 *      when it is not assigned. This pointer is RCU-protected due to the TX
1445 *      path needing to access it; even though the netdev carrier will always
1446 *      be off when it is %NULL there can still be races and packets could be
1447 *      processed after it switches back to %NULL.
1448 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1449 *      interface debug files. Note that it will be NULL for the virtual
1450 *      monitor interface (if that is requested.)
1451 * @probe_req_reg: probe requests should be reported to mac80211 for this
1452 *      interface.
1453 * @drv_priv: data area for driver use, will always be aligned to
1454 *      sizeof(void \*).
1455 * @txq: the multicast data TX queue (if driver uses the TXQ abstraction)
1456 */
1457struct ieee80211_vif {
1458        enum nl80211_iftype type;
1459        struct ieee80211_bss_conf bss_conf;
1460        u8 addr[ETH_ALEN] __aligned(2);
1461        bool p2p;
1462        bool csa_active;
1463        bool mu_mimo_owner;
1464
1465        u8 cab_queue;
1466        u8 hw_queue[IEEE80211_NUM_ACS];
1467
1468        struct ieee80211_txq *txq;
1469
1470        struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1471
1472        u32 driver_flags;
1473
1474#ifdef CONFIG_MAC80211_DEBUGFS
1475        struct dentry *debugfs_dir;
1476#endif
1477
1478        unsigned int probe_req_reg;
1479
1480        /* must be last */
1481        u8 drv_priv[0] __aligned(sizeof(void *));
1482};
1483
1484static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1485{
1486#ifdef CONFIG_MAC80211_MESH
1487        return vif->type == NL80211_IFTYPE_MESH_POINT;
1488#endif
1489        return false;
1490}
1491
1492/**
1493 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1494 * @wdev: the wdev to get the vif for
1495 *
1496 * This can be used by mac80211 drivers with direct cfg80211 APIs
1497 * (like the vendor commands) that get a wdev.
1498 *
1499 * Note that this function may return %NULL if the given wdev isn't
1500 * associated with a vif that the driver knows about (e.g. monitor
1501 * or AP_VLAN interfaces.)
1502 */
1503struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1504
1505/**
1506 * ieee80211_vif_to_wdev - return a wdev struct from a vif
1507 * @vif: the vif to get the wdev for
1508 *
1509 * This can be used by mac80211 drivers with direct cfg80211 APIs
1510 * (like the vendor commands) that needs to get the wdev for a vif.
1511 *
1512 * Note that this function may return %NULL if the given wdev isn't
1513 * associated with a vif that the driver knows about (e.g. monitor
1514 * or AP_VLAN interfaces.)
1515 */
1516struct wireless_dev *ieee80211_vif_to_wdev(struct ieee80211_vif *vif);
1517
1518/**
1519 * enum ieee80211_key_flags - key flags
1520 *
1521 * These flags are used for communication about keys between the driver
1522 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1523 *
1524 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1525 *      driver to indicate that it requires IV generation for this
1526 *      particular key. Setting this flag does not necessarily mean that SKBs
1527 *      will have sufficient tailroom for ICV or MIC.
1528 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1529 *      the driver for a TKIP key if it requires Michael MIC
1530 *      generation in software.
1531 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1532 *      that the key is pairwise rather then a shared key.
1533 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1534 *      CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames
1535 *      (MFP) to be done in software.
1536 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1537 *      if space should be prepared for the IV, but the IV
1538 *      itself should not be generated. Do not set together with
1539 *      @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1540 *      not necessarily mean that SKBs will have sufficient tailroom for ICV or
1541 *      MIC.
1542 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1543 *      management frames. The flag can help drivers that have a hardware
1544 *      crypto implementation that doesn't deal with management frames
1545 *      properly by allowing them to not upload the keys to hardware and
1546 *      fall back to software crypto. Note that this flag deals only with
1547 *      RX, if your crypto engine can't deal with TX you can also set the
1548 *      %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1549 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1550 *      driver for a CCMP/GCMP key to indicate that is requires IV generation
1551 *      only for managment frames (MFP).
1552 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the
1553 *      driver for a key to indicate that sufficient tailroom must always
1554 *      be reserved for ICV or MIC, even when HW encryption is enabled.
1555 */
1556enum ieee80211_key_flags {
1557        IEEE80211_KEY_FLAG_GENERATE_IV_MGMT     = BIT(0),
1558        IEEE80211_KEY_FLAG_GENERATE_IV          = BIT(1),
1559        IEEE80211_KEY_FLAG_GENERATE_MMIC        = BIT(2),
1560        IEEE80211_KEY_FLAG_PAIRWISE             = BIT(3),
1561        IEEE80211_KEY_FLAG_SW_MGMT_TX           = BIT(4),
1562        IEEE80211_KEY_FLAG_PUT_IV_SPACE         = BIT(5),
1563        IEEE80211_KEY_FLAG_RX_MGMT              = BIT(6),
1564        IEEE80211_KEY_FLAG_RESERVE_TAILROOM     = BIT(7),
1565};
1566
1567/**
1568 * struct ieee80211_key_conf - key information
1569 *
1570 * This key information is given by mac80211 to the driver by
1571 * the set_key() callback in &struct ieee80211_ops.
1572 *
1573 * @hw_key_idx: To be set by the driver, this is the key index the driver
1574 *      wants to be given when a frame is transmitted and needs to be
1575 *      encrypted in hardware.
1576 * @cipher: The key's cipher suite selector.
1577 * @tx_pn: PN used for TX keys, may be used by the driver as well if it
1578 *      needs to do software PN assignment by itself (e.g. due to TSO)
1579 * @flags: key flags, see &enum ieee80211_key_flags.
1580 * @keyidx: the key index (0-3)
1581 * @keylen: key material length
1582 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1583 *      data block:
1584 *      - Temporal Encryption Key (128 bits)
1585 *      - Temporal Authenticator Tx MIC Key (64 bits)
1586 *      - Temporal Authenticator Rx MIC Key (64 bits)
1587 * @icv_len: The ICV length for this key type
1588 * @iv_len: The IV length for this key type
1589 */
1590struct ieee80211_key_conf {
1591        atomic64_t tx_pn;
1592        u32 cipher;
1593        u8 icv_len;
1594        u8 iv_len;
1595        u8 hw_key_idx;
1596        u8 flags;
1597        s8 keyidx;
1598        u8 keylen;
1599        u8 key[0];
1600};
1601
1602#define IEEE80211_MAX_PN_LEN    16
1603
1604#define TKIP_PN_TO_IV16(pn) ((u16)(pn & 0xffff))
1605#define TKIP_PN_TO_IV32(pn) ((u32)((pn >> 16) & 0xffffffff))
1606
1607/**
1608 * struct ieee80211_key_seq - key sequence counter
1609 *
1610 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
1611 * @ccmp: PN data, most significant byte first (big endian,
1612 *      reverse order than in packet)
1613 * @aes_cmac: PN data, most significant byte first (big endian,
1614 *      reverse order than in packet)
1615 * @aes_gmac: PN data, most significant byte first (big endian,
1616 *      reverse order than in packet)
1617 * @gcmp: PN data, most significant byte first (big endian,
1618 *      reverse order than in packet)
1619 * @hw: data for HW-only (e.g. cipher scheme) keys
1620 */
1621struct ieee80211_key_seq {
1622        union {
1623                struct {
1624                        u32 iv32;
1625                        u16 iv16;
1626                } tkip;
1627                struct {
1628                        u8 pn[6];
1629                } ccmp;
1630                struct {
1631                        u8 pn[6];
1632                } aes_cmac;
1633                struct {
1634                        u8 pn[6];
1635                } aes_gmac;
1636                struct {
1637                        u8 pn[6];
1638                } gcmp;
1639                struct {
1640                        u8 seq[IEEE80211_MAX_PN_LEN];
1641                        u8 seq_len;
1642                } hw;
1643        };
1644};
1645
1646/**
1647 * struct ieee80211_cipher_scheme - cipher scheme
1648 *
1649 * This structure contains a cipher scheme information defining
1650 * the secure packet crypto handling.
1651 *
1652 * @cipher: a cipher suite selector
1653 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1654 * @hdr_len: a length of a security header used the cipher
1655 * @pn_len: a length of a packet number in the security header
1656 * @pn_off: an offset of pn from the beginning of the security header
1657 * @key_idx_off: an offset of key index byte in the security header
1658 * @key_idx_mask: a bit mask of key_idx bits
1659 * @key_idx_shift: a bit shift needed to get key_idx
1660 *     key_idx value calculation:
1661 *      (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1662 * @mic_len: a mic length in bytes
1663 */
1664struct ieee80211_cipher_scheme {
1665        u32 cipher;
1666        u16 iftype;
1667        u8 hdr_len;
1668        u8 pn_len;
1669        u8 pn_off;
1670        u8 key_idx_off;
1671        u8 key_idx_mask;
1672        u8 key_idx_shift;
1673        u8 mic_len;
1674};
1675
1676/**
1677 * enum set_key_cmd - key command
1678 *
1679 * Used with the set_key() callback in &struct ieee80211_ops, this
1680 * indicates whether a key is being removed or added.
1681 *
1682 * @SET_KEY: a key is set
1683 * @DISABLE_KEY: a key must be disabled
1684 */
1685enum set_key_cmd {
1686        SET_KEY, DISABLE_KEY,
1687};
1688
1689/**
1690 * enum ieee80211_sta_state - station state
1691 *
1692 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1693 *      this is a special state for add/remove transitions
1694 * @IEEE80211_STA_NONE: station exists without special state
1695 * @IEEE80211_STA_AUTH: station is authenticated
1696 * @IEEE80211_STA_ASSOC: station is associated
1697 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1698 */
1699enum ieee80211_sta_state {
1700        /* NOTE: These need to be ordered correctly! */
1701        IEEE80211_STA_NOTEXIST,
1702        IEEE80211_STA_NONE,
1703        IEEE80211_STA_AUTH,
1704        IEEE80211_STA_ASSOC,
1705        IEEE80211_STA_AUTHORIZED,
1706};
1707
1708/**
1709 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1710 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1711 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1712 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1713 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1714 *      (including 80+80 MHz)
1715 *
1716 * Implementation note: 20 must be zero to be initialized
1717 *      correctly, the values must be sorted.
1718 */
1719enum ieee80211_sta_rx_bandwidth {
1720        IEEE80211_STA_RX_BW_20 = 0,
1721        IEEE80211_STA_RX_BW_40,
1722        IEEE80211_STA_RX_BW_80,
1723        IEEE80211_STA_RX_BW_160,
1724};
1725
1726/**
1727 * struct ieee80211_sta_rates - station rate selection table
1728 *
1729 * @rcu_head: RCU head used for freeing the table on update
1730 * @rate: transmit rates/flags to be used by default.
1731 *      Overriding entries per-packet is possible by using cb tx control.
1732 */
1733struct ieee80211_sta_rates {
1734        struct rcu_head rcu_head;
1735        struct {
1736                s8 idx;
1737                u8 count;
1738                u8 count_cts;
1739                u8 count_rts;
1740                u16 flags;
1741        } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1742};
1743
1744/**
1745 * struct ieee80211_sta - station table entry
1746 *
1747 * A station table entry represents a station we are possibly
1748 * communicating with. Since stations are RCU-managed in
1749 * mac80211, any ieee80211_sta pointer you get access to must
1750 * either be protected by rcu_read_lock() explicitly or implicitly,
1751 * or you must take good care to not use such a pointer after a
1752 * call to your sta_remove callback that removed it.
1753 *
1754 * @addr: MAC address
1755 * @aid: AID we assigned to the station if we're an AP
1756 * @supp_rates: Bitmap of supported rates (per band)
1757 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1758 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1759 * @max_rx_aggregation_subframes: maximal amount of frames in a single AMPDU
1760 *      that this station is allowed to transmit to us.
1761 *      Can be modified by driver.
1762 * @wme: indicates whether the STA supports QoS/WME (if local devices does,
1763 *      otherwise always false)
1764 * @drv_priv: data area for driver use, will always be aligned to
1765 *      sizeof(void \*), size is determined in hw information.
1766 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1767 *      if wme is supported. The bits order is like in
1768 *      IEEE80211_WMM_IE_STA_QOSINFO_AC_*.
1769 * @max_sp: max Service Period. Only valid if wme is supported.
1770 * @bandwidth: current bandwidth the station can receive with
1771 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1772 *      station can receive at the moment, changed by operating mode
1773 *      notifications and capabilities. The value is only valid after
1774 *      the station moves to associated state.
1775 * @smps_mode: current SMPS mode (off, static or dynamic)
1776 * @rates: rate control selection table
1777 * @tdls: indicates whether the STA is a TDLS peer
1778 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
1779 *      valid if the STA is a TDLS peer in the first place.
1780 * @mfp: indicates whether the STA uses management frame protection or not.
1781 * @max_amsdu_subframes: indicates the maximal number of MSDUs in a single
1782 *      A-MSDU. Taken from the Extended Capabilities element. 0 means
1783 *      unlimited.
1784 * @support_p2p_ps: indicates whether the STA supports P2P PS mechanism or not.
1785 * @max_rc_amsdu_len: Maximum A-MSDU size in bytes recommended by rate control.
1786 * @txq: per-TID data TX queues (if driver uses the TXQ abstraction)
1787 */
1788struct ieee80211_sta {
1789        u32 supp_rates[NUM_NL80211_BANDS];
1790        u8 addr[ETH_ALEN];
1791        u16 aid;
1792        struct ieee80211_sta_ht_cap ht_cap;
1793        struct ieee80211_sta_vht_cap vht_cap;
1794        u8 max_rx_aggregation_subframes;
1795        bool wme;
1796        u8 uapsd_queues;
1797        u8 max_sp;
1798        u8 rx_nss;
1799        enum ieee80211_sta_rx_bandwidth bandwidth;
1800        enum ieee80211_smps_mode smps_mode;
1801        struct ieee80211_sta_rates __rcu *rates;
1802        bool tdls;
1803        bool tdls_initiator;
1804        bool mfp;
1805        u8 max_amsdu_subframes;
1806
1807        /**
1808         * @max_amsdu_len:
1809         * indicates the maximal length of an A-MSDU in bytes.
1810         * This field is always valid for packets with a VHT preamble.
1811         * For packets with a HT preamble, additional limits apply:
1812         *
1813         * * If the skb is transmitted as part of a BA agreement, the
1814         *   A-MSDU maximal size is min(max_amsdu_len, 4065) bytes.
1815         * * If the skb is not part of a BA aggreement, the A-MSDU maximal
1816         *   size is min(max_amsdu_len, 7935) bytes.
1817         *
1818         * Both additional HT limits must be enforced by the low level
1819         * driver. This is defined by the spec (IEEE 802.11-2012 section
1820         * 8.3.2.2 NOTE 2).
1821         */
1822        u16 max_amsdu_len;
1823        bool support_p2p_ps;
1824        u16 max_rc_amsdu_len;
1825
1826        struct ieee80211_txq *txq[IEEE80211_NUM_TIDS];
1827
1828        /* must be last */
1829        u8 drv_priv[0] __aligned(sizeof(void *));
1830};
1831
1832/**
1833 * enum sta_notify_cmd - sta notify command
1834 *
1835 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1836 * indicates if an associated station made a power state transition.
1837 *
1838 * @STA_NOTIFY_SLEEP: a station is now sleeping
1839 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1840 */
1841enum sta_notify_cmd {
1842        STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1843};
1844
1845/**
1846 * struct ieee80211_tx_control - TX control data
1847 *
1848 * @sta: station table entry, this sta pointer may be NULL and
1849 *      it is not allowed to copy the pointer, due to RCU.
1850 */
1851struct ieee80211_tx_control {
1852        struct ieee80211_sta *sta;
1853};
1854
1855/**
1856 * struct ieee80211_txq - Software intermediate tx queue
1857 *
1858 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1859 * @sta: station table entry, %NULL for per-vif queue
1860 * @tid: the TID for this queue (unused for per-vif queue)
1861 * @ac: the AC for this queue
1862 * @drv_priv: driver private area, sized by hw->txq_data_size
1863 *
1864 * The driver can obtain packets from this queue by calling
1865 * ieee80211_tx_dequeue().
1866 */
1867struct ieee80211_txq {
1868        struct ieee80211_vif *vif;
1869        struct ieee80211_sta *sta;
1870        u8 tid;
1871        u8 ac;
1872
1873        /* must be last */
1874        u8 drv_priv[0] __aligned(sizeof(void *));
1875};
1876
1877/**
1878 * enum ieee80211_hw_flags - hardware flags
1879 *
1880 * These flags are used to indicate hardware capabilities to
1881 * the stack. Generally, flags here should have their meaning
1882 * done in a way that the simplest hardware doesn't need setting
1883 * any particular flags. There are some exceptions to this rule,
1884 * however, so you are advised to review these flags carefully.
1885 *
1886 * @IEEE80211_HW_HAS_RATE_CONTROL:
1887 *      The hardware or firmware includes rate control, and cannot be
1888 *      controlled by the stack. As such, no rate control algorithm
1889 *      should be instantiated, and the TX rate reported to userspace
1890 *      will be taken from the TX status instead of the rate control
1891 *      algorithm.
1892 *      Note that this requires that the driver implement a number of
1893 *      callbacks so it has the correct information, it needs to have
1894 *      the @set_rts_threshold callback and must look at the BSS config
1895 *      @use_cts_prot for G/N protection, @use_short_slot for slot
1896 *      timing in 2.4 GHz and @use_short_preamble for preambles for
1897 *      CCK frames.
1898 *
1899 * @IEEE80211_HW_RX_INCLUDES_FCS:
1900 *      Indicates that received frames passed to the stack include
1901 *      the FCS at the end.
1902 *
1903 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1904 *      Some wireless LAN chipsets buffer broadcast/multicast frames
1905 *      for power saving stations in the hardware/firmware and others
1906 *      rely on the host system for such buffering. This option is used
1907 *      to configure the IEEE 802.11 upper layer to buffer broadcast and
1908 *      multicast frames when there are power saving stations so that
1909 *      the driver can fetch them with ieee80211_get_buffered_bc().
1910 *
1911 * @IEEE80211_HW_SIGNAL_UNSPEC:
1912 *      Hardware can provide signal values but we don't know its units. We
1913 *      expect values between 0 and @max_signal.
1914 *      If possible please provide dB or dBm instead.
1915 *
1916 * @IEEE80211_HW_SIGNAL_DBM:
1917 *      Hardware gives signal values in dBm, decibel difference from
1918 *      one milliwatt. This is the preferred method since it is standardized
1919 *      between different devices. @max_signal does not need to be set.
1920 *
1921 * @IEEE80211_HW_SPECTRUM_MGMT:
1922 *      Hardware supports spectrum management defined in 802.11h
1923 *      Measurement, Channel Switch, Quieting, TPC
1924 *
1925 * @IEEE80211_HW_AMPDU_AGGREGATION:
1926 *      Hardware supports 11n A-MPDU aggregation.
1927 *
1928 * @IEEE80211_HW_SUPPORTS_PS:
1929 *      Hardware has power save support (i.e. can go to sleep).
1930 *
1931 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1932 *      Hardware requires nullfunc frame handling in stack, implies
1933 *      stack support for dynamic PS.
1934 *
1935 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1936 *      Hardware has support for dynamic PS.
1937 *
1938 * @IEEE80211_HW_MFP_CAPABLE:
1939 *      Hardware supports management frame protection (MFP, IEEE 802.11w).
1940 *
1941 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1942 *      Hardware can provide ack status reports of Tx frames to
1943 *      the stack.
1944 *
1945 * @IEEE80211_HW_CONNECTION_MONITOR:
1946 *      The hardware performs its own connection monitoring, including
1947 *      periodic keep-alives to the AP and probing the AP on beacon loss.
1948 *
1949 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1950 *      This device needs to get data from beacon before association (i.e.
1951 *      dtim_period).
1952 *
1953 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1954 *      per-station GTKs as used by IBSS RSN or during fast transition. If
1955 *      the device doesn't support per-station GTKs, but can be asked not
1956 *      to decrypt group addressed frames, then IBSS RSN support is still
1957 *      possible but software crypto will be used. Advertise the wiphy flag
1958 *      only in that case.
1959 *
1960 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1961 *      autonomously manages the PS status of connected stations. When
1962 *      this flag is set mac80211 will not trigger PS mode for connected
1963 *      stations based on the PM bit of incoming frames.
1964 *      Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1965 *      the PS mode of connected stations.
1966 *
1967 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1968 *      setup strictly in HW. mac80211 should not attempt to do this in
1969 *      software.
1970 *
1971 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1972 *      a virtual monitor interface when monitor interfaces are the only
1973 *      active interfaces.
1974 *
1975 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
1976 *      be created.  It is expected user-space will create vifs as
1977 *      desired (and thus have them named as desired).
1978 *
1979 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the
1980 *      crypto algorithms can be done in software - so don't automatically
1981 *      try to fall back to it if hardware crypto fails, but do so only if
1982 *      the driver returns 1. This also forces the driver to advertise its
1983 *      supported cipher suites.
1984 *
1985 * @IEEE80211_HW_SUPPORT_FAST_XMIT: The driver/hardware supports fast-xmit,
1986 *      this currently requires only the ability to calculate the duration
1987 *      for frames.
1988 *
1989 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1990 *      queue mapping in order to use different queues (not just one per AC)
1991 *      for different virtual interfaces. See the doc section on HW queue
1992 *      control for more details.
1993 *
1994 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
1995 *      selection table provided by the rate control algorithm.
1996 *
1997 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1998 *      P2P Interface. This will be honoured even if more than one interface
1999 *      is supported.
2000 *
2001 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
2002 *      only, to allow getting TBTT of a DTIM beacon.
2003 *
2004 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
2005 *      and can cope with CCK rates in an aggregation session (e.g. by not
2006 *      using aggregation for such frames.)
2007 *
2008 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
2009 *      for a single active channel while using channel contexts. When support
2010 *      is not enabled the default action is to disconnect when getting the
2011 *      CSA frame.
2012 *
2013 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
2014 *      or tailroom of TX skbs without copying them first.
2015 *
2016 * @IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
2017 *      in one command, mac80211 doesn't have to run separate scans per band.
2018 *
2019 * @IEEE80211_HW_TDLS_WIDER_BW: The device/driver supports wider bandwidth
2020 *      than then BSS bandwidth for a TDLS link on the base channel.
2021 *
2022 * @IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU: The driver supports receiving A-MSDUs
2023 *      within A-MPDU.
2024 *
2025 * @IEEE80211_HW_BEACON_TX_STATUS: The device/driver provides TX status
2026 *      for sent beacons.
2027 *
2028 * @IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR: Hardware (or driver) requires that each
2029 *      station has a unique address, i.e. each station entry can be identified
2030 *      by just its MAC address; this prevents, for example, the same station
2031 *      from connecting to two virtual AP interfaces at the same time.
2032 *
2033 * @IEEE80211_HW_SUPPORTS_REORDERING_BUFFER: Hardware (or driver) manages the
2034 *      reordering buffer internally, guaranteeing mac80211 receives frames in
2035 *      order and does not need to manage its own reorder buffer or BA session
2036 *      timeout.
2037 *
2038 * @IEEE80211_HW_USES_RSS: The device uses RSS and thus requires parallel RX,
2039 *      which implies using per-CPU station statistics.
2040 *
2041 * @IEEE80211_HW_TX_AMSDU: Hardware (or driver) supports software aggregated
2042 *      A-MSDU frames. Requires software tx queueing and fast-xmit support.
2043 *      When not using minstrel/minstrel_ht rate control, the driver must
2044 *      limit the maximum A-MSDU size based on the current tx rate by setting
2045 *      max_rc_amsdu_len in struct ieee80211_sta.
2046 *
2047 * @IEEE80211_HW_TX_FRAG_LIST: Hardware (or driver) supports sending frag_list
2048 *      skbs, needed for zero-copy software A-MSDU.
2049 *
2050 * @IEEE80211_HW_REPORTS_LOW_ACK: The driver (or firmware) reports low ack event
2051 *      by ieee80211_report_low_ack() based on its own algorithm. For such
2052 *      drivers, mac80211 packet loss mechanism will not be triggered and driver
2053 *      is completely depending on firmware event for station kickout.
2054 *
2055 * @IEEE80211_HW_SUPPORTS_TX_FRAG: Hardware does fragmentation by itself.
2056 *      The stack will not do fragmentation.
2057 *      The callback for @set_frag_threshold should be set as well.
2058 *
2059 * @NUM_IEEE80211_HW_FLAGS: number of hardware flags, used for sizing arrays
2060 */
2061enum ieee80211_hw_flags {
2062        IEEE80211_HW_HAS_RATE_CONTROL,
2063        IEEE80211_HW_RX_INCLUDES_FCS,
2064        IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING,
2065        IEEE80211_HW_SIGNAL_UNSPEC,
2066        IEEE80211_HW_SIGNAL_DBM,
2067        IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC,
2068        IEEE80211_HW_SPECTRUM_MGMT,
2069        IEEE80211_HW_AMPDU_AGGREGATION,
2070        IEEE80211_HW_SUPPORTS_PS,
2071        IEEE80211_HW_PS_NULLFUNC_STACK,
2072        IEEE80211_HW_SUPPORTS_DYNAMIC_PS,
2073        IEEE80211_HW_MFP_CAPABLE,
2074        IEEE80211_HW_WANT_MONITOR_VIF,
2075        IEEE80211_HW_NO_AUTO_VIF,
2076        IEEE80211_HW_SW_CRYPTO_CONTROL,
2077        IEEE80211_HW_SUPPORT_FAST_XMIT,
2078        IEEE80211_HW_REPORTS_TX_ACK_STATUS,
2079        IEEE80211_HW_CONNECTION_MONITOR,
2080        IEEE80211_HW_QUEUE_CONTROL,
2081        IEEE80211_HW_SUPPORTS_PER_STA_GTK,
2082        IEEE80211_HW_AP_LINK_PS,
2083        IEEE80211_HW_TX_AMPDU_SETUP_IN_HW,
2084        IEEE80211_HW_SUPPORTS_RC_TABLE,
2085        IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF,
2086        IEEE80211_HW_TIMING_BEACON_ONLY,
2087        IEEE80211_HW_SUPPORTS_HT_CCK_RATES,
2088        IEEE80211_HW_CHANCTX_STA_CSA,
2089        IEEE80211_HW_SUPPORTS_CLONED_SKBS,
2090        IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS,
2091        IEEE80211_HW_TDLS_WIDER_BW,
2092        IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU,
2093        IEEE80211_HW_BEACON_TX_STATUS,
2094        IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR,
2095        IEEE80211_HW_SUPPORTS_REORDERING_BUFFER,
2096        IEEE80211_HW_USES_RSS,
2097        IEEE80211_HW_TX_AMSDU,
2098        IEEE80211_HW_TX_FRAG_LIST,
2099        IEEE80211_HW_REPORTS_LOW_ACK,
2100        IEEE80211_HW_SUPPORTS_TX_FRAG,
2101
2102        /* keep last, obviously */
2103        NUM_IEEE80211_HW_FLAGS
2104};
2105
2106/**
2107 * struct ieee80211_hw - hardware information and state
2108 *
2109 * This structure contains the configuration and hardware
2110 * information for an 802.11 PHY.
2111 *
2112 * @wiphy: This points to the &struct wiphy allocated for this
2113 *      802.11 PHY. You must fill in the @perm_addr and @dev
2114 *      members of this structure using SET_IEEE80211_DEV()
2115 *      and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
2116 *      bands (with channels, bitrates) are registered here.
2117 *
2118 * @conf: &struct ieee80211_conf, device configuration, don't use.
2119 *
2120 * @priv: pointer to private area that was allocated for driver use
2121 *      along with this structure.
2122 *
2123 * @flags: hardware flags, see &enum ieee80211_hw_flags.
2124 *
2125 * @extra_tx_headroom: headroom to reserve in each transmit skb
2126 *      for use by the driver (e.g. for transmit headers.)
2127 *
2128 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
2129 *      Can be used by drivers to add extra IEs.
2130 *
2131 * @max_signal: Maximum value for signal (rssi) in RX information, used
2132 *      only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
2133 *
2134 * @max_listen_interval: max listen interval in units of beacon interval
2135 *      that HW supports
2136 *
2137 * @queues: number of available hardware transmit queues for
2138 *      data packets. WMM/QoS requires at least four, these
2139 *      queues need to have configurable access parameters.
2140 *
2141 * @rate_control_algorithm: rate control algorithm for this hardware.
2142 *      If unset (NULL), the default algorithm will be used. Must be
2143 *      set before calling ieee80211_register_hw().
2144 *
2145 * @vif_data_size: size (in bytes) of the drv_priv data area
2146 *      within &struct ieee80211_vif.
2147 * @sta_data_size: size (in bytes) of the drv_priv data area
2148 *      within &struct ieee80211_sta.
2149 * @chanctx_data_size: size (in bytes) of the drv_priv data area
2150 *      within &struct ieee80211_chanctx_conf.
2151 * @txq_data_size: size (in bytes) of the drv_priv data area
2152 *      within @struct ieee80211_txq.
2153 *
2154 * @max_rates: maximum number of alternate rate retry stages the hw
2155 *      can handle.
2156 * @max_report_rates: maximum number of alternate rate retry stages
2157 *      the hw can report back.
2158 * @max_rate_tries: maximum number of tries for each stage
2159 *
2160 * @max_rx_aggregation_subframes: maximum buffer size (number of
2161 *      sub-frames) to be used for A-MPDU block ack receiver
2162 *      aggregation.
2163 *      This is only relevant if the device has restrictions on the
2164 *      number of subframes, if it relies on mac80211 to do reordering
2165 *      it shouldn't be set.
2166 *
2167 * @max_tx_aggregation_subframes: maximum number of subframes in an
2168 *      aggregate an HT driver will transmit. Though ADDBA will advertise
2169 *      a constant value of 64 as some older APs can crash if the window
2170 *      size is smaller (an example is LinkSys WRT120N with FW v1.0.07
2171 *      build 002 Jun 18 2012).
2172 *
2173 * @max_tx_fragments: maximum number of tx buffers per (A)-MSDU, sum
2174 *      of 1 + skb_shinfo(skb)->nr_frags for each skb in the frag_list.
2175 *
2176 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
2177 *      (if %IEEE80211_HW_QUEUE_CONTROL is set)
2178 *
2179 * @radiotap_mcs_details: lists which MCS information can the HW
2180 *      reports, by default it is set to _MCS, _GI and _BW but doesn't
2181 *      include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_\* values, only
2182 *      adding _BW is supported today.
2183 *
2184 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
2185 *      the default is _GI | _BANDWIDTH.
2186 *      Use the %IEEE80211_RADIOTAP_VHT_KNOWN_\* values.
2187 *
2188 * @radiotap_timestamp: Information for the radiotap timestamp field; if the
2189 *      'units_pos' member is set to a non-negative value it must be set to
2190 *      a combination of a IEEE80211_RADIOTAP_TIMESTAMP_UNIT_* and a
2191 *      IEEE80211_RADIOTAP_TIMESTAMP_SPOS_* value, and then the timestamp
2192 *      field will be added and populated from the &struct ieee80211_rx_status
2193 *      device_timestamp. If the 'accuracy' member is non-negative, it's put
2194 *      into the accuracy radiotap field and the accuracy known flag is set.
2195 *
2196 * @netdev_features: netdev features to be set in each netdev created
2197 *      from this HW. Note that not all features are usable with mac80211,
2198 *      other features will be rejected during HW registration.
2199 *
2200 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
2201 *      for each access category if it is uAPSD trigger-enabled and delivery-
2202 *      enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
2203 *      Each bit corresponds to different AC. Value '1' in specific bit means
2204 *      that corresponding AC is both trigger- and delivery-enabled. '0' means
2205 *      neither enabled.
2206 *
2207 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
2208 *      deliver to a WMM STA during any Service Period triggered by the WMM STA.
2209 *      Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
2210 *
2211 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
2212 * @cipher_schemes: a pointer to an array of cipher scheme definitions
2213 *      supported by HW.
2214 * @max_nan_de_entries: maximum number of NAN DE functions supported by the
2215 *      device.
2216 */
2217struct ieee80211_hw {
2218        struct ieee80211_conf conf;
2219        struct wiphy *wiphy;
2220        const char *rate_control_algorithm;
2221        void *priv;
2222        unsigned long flags[BITS_TO_LONGS(NUM_IEEE80211_HW_FLAGS)];
2223        unsigned int extra_tx_headroom;
2224        unsigned int extra_beacon_tailroom;
2225        int vif_data_size;
2226        int sta_data_size;
2227        int chanctx_data_size;
2228        int txq_data_size;
2229        u16 queues;
2230        u16 max_listen_interval;
2231        s8 max_signal;
2232        u8 max_rates;
2233        u8 max_report_rates;
2234        u8 max_rate_tries;
2235        u8 max_rx_aggregation_subframes;
2236        u8 max_tx_aggregation_subframes;
2237        u8 max_tx_fragments;
2238        u8 offchannel_tx_hw_queue;
2239        u8 radiotap_mcs_details;
2240        u16 radiotap_vht_details;
2241        struct {
2242                int units_pos;
2243                s16 accuracy;
2244        } radiotap_timestamp;
2245        netdev_features_t netdev_features;
2246        u8 uapsd_queues;
2247        u8 uapsd_max_sp_len;
2248        u8 n_cipher_schemes;
2249        const struct ieee80211_cipher_scheme *cipher_schemes;
2250        u8 max_nan_de_entries;
2251};
2252
2253static inline bool _ieee80211_hw_check(struct ieee80211_hw *hw,
2254                                       enum ieee80211_hw_flags flg)
2255{
2256        return test_bit(flg, hw->flags);
2257}
2258#define ieee80211_hw_check(hw, flg)     _ieee80211_hw_check(hw, IEEE80211_HW_##flg)
2259
2260static inline void _ieee80211_hw_set(struct ieee80211_hw *hw,
2261                                     enum ieee80211_hw_flags flg)
2262{
2263        return __set_bit(flg, hw->flags);
2264}
2265#define ieee80211_hw_set(hw, flg)       _ieee80211_hw_set(hw, IEEE80211_HW_##flg)
2266
2267/**
2268 * struct ieee80211_scan_request - hw scan request
2269 *
2270 * @ies: pointers different parts of IEs (in req.ie)
2271 * @req: cfg80211 request.
2272 */
2273struct ieee80211_scan_request {
2274        struct ieee80211_scan_ies ies;
2275
2276        /* Keep last */
2277        struct cfg80211_scan_request req;
2278};
2279
2280/**
2281 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
2282 *
2283 * @sta: peer this TDLS channel-switch request/response came from
2284 * @chandef: channel referenced in a TDLS channel-switch request
2285 * @action_code: see &enum ieee80211_tdls_actioncode
2286 * @status: channel-switch response status
2287 * @timestamp: time at which the frame was received
2288 * @switch_time: switch-timing parameter received in the frame
2289 * @switch_timeout: switch-timing parameter received in the frame
2290 * @tmpl_skb: TDLS switch-channel response template
2291 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
2292 */
2293struct ieee80211_tdls_ch_sw_params {
2294        struct ieee80211_sta *sta;
2295        struct cfg80211_chan_def *chandef;
2296        u8 action_code;
2297        u32 status;
2298        u32 timestamp;
2299        u16 switch_time;
2300        u16 switch_timeout;
2301        struct sk_buff *tmpl_skb;
2302        u32 ch_sw_tm_ie;
2303};
2304
2305/**
2306 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
2307 *
2308 * @wiphy: the &struct wiphy which we want to query
2309 *
2310 * mac80211 drivers can use this to get to their respective
2311 * &struct ieee80211_hw. Drivers wishing to get to their own private
2312 * structure can then access it via hw->priv. Note that mac802111 drivers should
2313 * not use wiphy_priv() to try to get their private driver structure as this
2314 * is already used internally by mac80211.
2315 *
2316 * Return: The mac80211 driver hw struct of @wiphy.
2317 */
2318struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
2319
2320/**
2321 * SET_IEEE80211_DEV - set device for 802.11 hardware
2322 *
2323 * @hw: the &struct ieee80211_hw to set the device for
2324 * @dev: the &struct device of this 802.11 device
2325 */
2326static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
2327{
2328        set_wiphy_dev(hw->wiphy, dev);
2329}
2330
2331/**
2332 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
2333 *
2334 * @hw: the &struct ieee80211_hw to set the MAC address for
2335 * @addr: the address to set
2336 */
2337static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, const u8 *addr)
2338{
2339        memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
2340}
2341
2342static inline struct ieee80211_rate *
2343ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
2344                      const struct ieee80211_tx_info *c)
2345{
2346        if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
2347                return NULL;
2348        return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
2349}
2350
2351static inline struct ieee80211_rate *
2352ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
2353                           const struct ieee80211_tx_info *c)
2354{
2355        if (c->control.rts_cts_rate_idx < 0)
2356                return NULL;
2357        return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
2358}
2359
2360static inline struct ieee80211_rate *
2361ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
2362                             const struct ieee80211_tx_info *c, int idx)
2363{
2364        if (c->control.rates[idx + 1].idx < 0)
2365                return NULL;
2366        return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
2367}
2368
2369/**
2370 * ieee80211_free_txskb - free TX skb
2371 * @hw: the hardware
2372 * @skb: the skb
2373 *
2374 * Free a transmit skb. Use this funtion when some failure
2375 * to transmit happened and thus status cannot be reported.
2376 */
2377void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
2378
2379/**
2380 * DOC: Hardware crypto acceleration
2381 *
2382 * mac80211 is capable of taking advantage of many hardware
2383 * acceleration designs for encryption and decryption operations.
2384 *
2385 * The set_key() callback in the &struct ieee80211_ops for a given
2386 * device is called to enable hardware acceleration of encryption and
2387 * decryption. The callback takes a @sta parameter that will be NULL
2388 * for default keys or keys used for transmission only, or point to
2389 * the station information for the peer for individual keys.
2390 * Multiple transmission keys with the same key index may be used when
2391 * VLANs are configured for an access point.
2392 *
2393 * When transmitting, the TX control data will use the @hw_key_idx
2394 * selected by the driver by modifying the &struct ieee80211_key_conf
2395 * pointed to by the @key parameter to the set_key() function.
2396 *
2397 * The set_key() call for the %SET_KEY command should return 0 if
2398 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
2399 * added; if you return 0 then hw_key_idx must be assigned to the
2400 * hardware key index, you are free to use the full u8 range.
2401 *
2402 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is
2403 * set, mac80211 will not automatically fall back to software crypto if
2404 * enabling hardware crypto failed. The set_key() call may also return the
2405 * value 1 to permit this specific key/algorithm to be done in software.
2406 *
2407 * When the cmd is %DISABLE_KEY then it must succeed.
2408 *
2409 * Note that it is permissible to not decrypt a frame even if a key
2410 * for it has been uploaded to hardware, the stack will not make any
2411 * decision based on whether a key has been uploaded or not but rather
2412 * based on the receive flags.
2413 *
2414 * The &struct ieee80211_key_conf structure pointed to by the @key
2415 * parameter is guaranteed to be valid until another call to set_key()
2416 * removes it, but it can only be used as a cookie to differentiate
2417 * keys.
2418 *
2419 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
2420 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
2421 * handler.
2422 * The update_tkip_key() call updates the driver with the new phase 1 key.
2423 * This happens every time the iv16 wraps around (every 65536 packets). The
2424 * set_key() call will happen only once for each key (unless the AP did
2425 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
2426 * provided by update_tkip_key only. The trigger that makes mac80211 call this
2427 * handler is software decryption with wrap around of iv16.
2428 *
2429 * The set_default_unicast_key() call updates the default WEP key index
2430 * configured to the hardware for WEP encryption type. This is required
2431 * for devices that support offload of data packets (e.g. ARP responses).
2432 */
2433
2434/**
2435 * DOC: Powersave support
2436 *
2437 * mac80211 has support for various powersave implementations.
2438 *
2439 * First, it can support hardware that handles all powersaving by itself,
2440 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
2441 * flag. In that case, it will be told about the desired powersave mode
2442 * with the %IEEE80211_CONF_PS flag depending on the association status.
2443 * The hardware must take care of sending nullfunc frames when necessary,
2444 * i.e. when entering and leaving powersave mode. The hardware is required
2445 * to look at the AID in beacons and signal to the AP that it woke up when
2446 * it finds traffic directed to it.
2447 *
2448 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
2449 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
2450 * with hardware wakeup and sleep states. Driver is responsible for waking
2451 * up the hardware before issuing commands to the hardware and putting it
2452 * back to sleep at appropriate times.
2453 *
2454 * When PS is enabled, hardware needs to wakeup for beacons and receive the
2455 * buffered multicast/broadcast frames after the beacon. Also it must be
2456 * possible to send frames and receive the acknowledment frame.
2457 *
2458 * Other hardware designs cannot send nullfunc frames by themselves and also
2459 * need software support for parsing the TIM bitmap. This is also supported
2460 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
2461 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
2462 * required to pass up beacons. The hardware is still required to handle
2463 * waking up for multicast traffic; if it cannot the driver must handle that
2464 * as best as it can, mac80211 is too slow to do that.
2465 *
2466 * Dynamic powersave is an extension to normal powersave in which the
2467 * hardware stays awake for a user-specified period of time after sending a
2468 * frame so that reply frames need not be buffered and therefore delayed to
2469 * the next wakeup. It's compromise of getting good enough latency when
2470 * there's data traffic and still saving significantly power in idle
2471 * periods.
2472 *
2473 * Dynamic powersave is simply supported by mac80211 enabling and disabling
2474 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
2475 * flag and mac80211 will handle everything automatically. Additionally,
2476 * hardware having support for the dynamic PS feature may set the
2477 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
2478 * dynamic PS mode itself. The driver needs to look at the
2479 * @dynamic_ps_timeout hardware configuration value and use it that value
2480 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
2481 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
2482 * enabled whenever user has enabled powersave.
2483 *
2484 * Driver informs U-APSD client support by enabling
2485 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
2486 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
2487 * Nullfunc frames and stay awake until the service period has ended. To
2488 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
2489 * from that AC are transmitted with powersave enabled.
2490 *
2491 * Note: U-APSD client mode is not yet supported with
2492 * %IEEE80211_HW_PS_NULLFUNC_STACK.
2493 */
2494
2495/**
2496 * DOC: Beacon filter support
2497 *
2498 * Some hardware have beacon filter support to reduce host cpu wakeups
2499 * which will reduce system power consumption. It usually works so that
2500 * the firmware creates a checksum of the beacon but omits all constantly
2501 * changing elements (TSF, TIM etc). Whenever the checksum changes the
2502 * beacon is forwarded to the host, otherwise it will be just dropped. That
2503 * way the host will only receive beacons where some relevant information
2504 * (for example ERP protection or WMM settings) have changed.
2505 *
2506 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
2507 * interface capability. The driver needs to enable beacon filter support
2508 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
2509 * power save is enabled, the stack will not check for beacon loss and the
2510 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
2511 *
2512 * The time (or number of beacons missed) until the firmware notifies the
2513 * driver of a beacon loss event (which in turn causes the driver to call
2514 * ieee80211_beacon_loss()) should be configurable and will be controlled
2515 * by mac80211 and the roaming algorithm in the future.
2516 *
2517 * Since there may be constantly changing information elements that nothing
2518 * in the software stack cares about, we will, in the future, have mac80211
2519 * tell the driver which information elements are interesting in the sense
2520 * that we want to see changes in them. This will include
2521 *
2522 *  - a list of information element IDs
2523 *  - a list of OUIs for the vendor information element
2524 *
2525 * Ideally, the hardware would filter out any beacons without changes in the
2526 * requested elements, but if it cannot support that it may, at the expense
2527 * of some efficiency, filter out only a subset. For example, if the device
2528 * doesn't support checking for OUIs it should pass up all changes in all
2529 * vendor information elements.
2530 *
2531 * Note that change, for the sake of simplification, also includes information
2532 * elements appearing or disappearing from the beacon.
2533 *
2534 * Some hardware supports an "ignore list" instead, just make sure nothing
2535 * that was requested is on the ignore list, and include commonly changing
2536 * information element IDs in the ignore list, for example 11 (BSS load) and
2537 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2538 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2539 * it could also include some currently unused IDs.
2540 *
2541 *
2542 * In addition to these capabilities, hardware should support notifying the
2543 * host of changes in the beacon RSSI. This is relevant to implement roaming
2544 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2545 * the received data packets). This can consist in notifying the host when
2546 * the RSSI changes significantly or when it drops below or rises above
2547 * configurable thresholds. In the future these thresholds will also be
2548 * configured by mac80211 (which gets them from userspace) to implement
2549 * them as the roaming algorithm requires.
2550 *
2551 * If the hardware cannot implement this, the driver should ask it to
2552 * periodically pass beacon frames to the host so that software can do the
2553 * signal strength threshold checking.
2554 */
2555
2556/**
2557 * DOC: Spatial multiplexing power save
2558 *
2559 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2560 * power in an 802.11n implementation. For details on the mechanism
2561 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2562 * "11.2.3 SM power save".
2563 *
2564 * The mac80211 implementation is capable of sending action frames
2565 * to update the AP about the station's SMPS mode, and will instruct
2566 * the driver to enter the specific mode. It will also announce the
2567 * requested SMPS mode during the association handshake. Hardware
2568 * support for this feature is required, and can be indicated by
2569 * hardware flags.
2570 *
2571 * The default mode will be "automatic", which nl80211/cfg80211
2572 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2573 * turned off otherwise.
2574 *
2575 * To support this feature, the driver must set the appropriate
2576 * hardware support flags, and handle the SMPS flag to the config()
2577 * operation. It will then with this mechanism be instructed to
2578 * enter the requested SMPS mode while associated to an HT AP.
2579 */
2580
2581/**
2582 * DOC: Frame filtering
2583 *
2584 * mac80211 requires to see many management frames for proper
2585 * operation, and users may want to see many more frames when
2586 * in monitor mode. However, for best CPU usage and power consumption,
2587 * having as few frames as possible percolate through the stack is
2588 * desirable. Hence, the hardware should filter as much as possible.
2589 *
2590 * To achieve this, mac80211 uses filter flags (see below) to tell
2591 * the driver's configure_filter() function which frames should be
2592 * passed to mac80211 and which should be filtered out.
2593 *
2594 * Before configure_filter() is invoked, the prepare_multicast()
2595 * callback is invoked with the parameters @mc_count and @mc_list
2596 * for the combined multicast address list of all virtual interfaces.
2597 * It's use is optional, and it returns a u64 that is passed to
2598 * configure_filter(). Additionally, configure_filter() has the
2599 * arguments @changed_flags telling which flags were changed and
2600 * @total_flags with the new flag states.
2601 *
2602 * If your device has no multicast address filters your driver will
2603 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2604 * parameter to see whether multicast frames should be accepted
2605 * or dropped.
2606 *
2607 * All unsupported flags in @total_flags must be cleared.
2608 * Hardware does not support a flag if it is incapable of _passing_
2609 * the frame to the stack. Otherwise the driver must ignore
2610 * the flag, but not clear it.
2611 * You must _only_ clear the flag (announce no support for the
2612 * flag to mac80211) if you are not able to pass the packet type
2613 * to the stack (so the hardware always filters it).
2614 * So for example, you should clear @FIF_CONTROL, if your hardware
2615 * always filters control frames. If your hardware always passes
2616 * control frames to the kernel and is incapable of filtering them,
2617 * you do _not_ clear the @FIF_CONTROL flag.
2618 * This rule applies to all other FIF flags as well.
2619 */
2620
2621/**
2622 * DOC: AP support for powersaving clients
2623 *
2624 * In order to implement AP and P2P GO modes, mac80211 has support for
2625 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2626 * There currently is no support for sAPSD.
2627 *
2628 * There is one assumption that mac80211 makes, namely that a client
2629 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2630 * Both are supported, and both can be used by the same client, but
2631 * they can't be used concurrently by the same client. This simplifies
2632 * the driver code.
2633 *
2634 * The first thing to keep in mind is that there is a flag for complete
2635 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2636 * mac80211 expects the driver to handle most of the state machine for
2637 * powersaving clients and will ignore the PM bit in incoming frames.
2638 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2639 * stations' powersave transitions. In this mode, mac80211 also doesn't
2640 * handle PS-Poll/uAPSD.
2641 *
2642 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2643 * PM bit in incoming frames for client powersave transitions. When a
2644 * station goes to sleep, we will stop transmitting to it. There is,
2645 * however, a race condition: a station might go to sleep while there is
2646 * data buffered on hardware queues. If the device has support for this
2647 * it will reject frames, and the driver should give the frames back to
2648 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2649 * cause mac80211 to retry the frame when the station wakes up. The
2650 * driver is also notified of powersave transitions by calling its
2651 * @sta_notify callback.
2652 *
2653 * When the station is asleep, it has three choices: it can wake up,
2654 * it can PS-Poll, or it can possibly start a uAPSD service period.
2655 * Waking up is implemented by simply transmitting all buffered (and
2656 * filtered) frames to the station. This is the easiest case. When
2657 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2658 * will inform the driver of this with the @allow_buffered_frames
2659 * callback; this callback is optional. mac80211 will then transmit
2660 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2661 * on each frame. The last frame in the service period (or the only
2662 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2663 * indicate that it ends the service period; as this frame must have
2664 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2665 * When TX status is reported for this frame, the service period is
2666 * marked has having ended and a new one can be started by the peer.
2667 *
2668 * Additionally, non-bufferable MMPDUs can also be transmitted by
2669 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2670 *
2671 * Another race condition can happen on some devices like iwlwifi
2672 * when there are frames queued for the station and it wakes up
2673 * or polls; the frames that are already queued could end up being
2674 * transmitted first instead, causing reordering and/or wrong
2675 * processing of the EOSP. The cause is that allowing frames to be
2676 * transmitted to a certain station is out-of-band communication to
2677 * the device. To allow this problem to be solved, the driver can
2678 * call ieee80211_sta_block_awake() if frames are buffered when it
2679 * is notified that the station went to sleep. When all these frames
2680 * have been filtered (see above), it must call the function again
2681 * to indicate that the station is no longer blocked.
2682 *
2683 * If the driver buffers frames in the driver for aggregation in any
2684 * way, it must use the ieee80211_sta_set_buffered() call when it is
2685 * notified of the station going to sleep to inform mac80211 of any
2686 * TIDs that have frames buffered. Note that when a station wakes up
2687 * this information is reset (hence the requirement to call it when
2688 * informed of the station going to sleep). Then, when a service
2689 * period starts for any reason, @release_buffered_frames is called
2690 * with the number of frames to be released and which TIDs they are
2691 * to come from. In this case, the driver is responsible for setting
2692 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2693 * to help the @more_data parameter is passed to tell the driver if
2694 * there is more data on other TIDs -- the TIDs to release frames
2695 * from are ignored since mac80211 doesn't know how many frames the
2696 * buffers for those TIDs contain.
2697 *
2698 * If the driver also implement GO mode, where absence periods may
2699 * shorten service periods (or abort PS-Poll responses), it must
2700 * filter those response frames except in the case of frames that
2701 * are buffered in the driver -- those must remain buffered to avoid
2702 * reordering. Because it is possible that no frames are released
2703 * in this case, the driver must call ieee80211_sta_eosp()
2704 * to indicate to mac80211 that the service period ended anyway.
2705 *
2706 * Finally, if frames from multiple TIDs are released from mac80211
2707 * but the driver might reorder them, it must clear & set the flags
2708 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2709 * and also take care of the EOSP and MORE_DATA bits in the frame.
2710 * The driver may also use ieee80211_sta_eosp() in this case.
2711 *
2712 * Note that if the driver ever buffers frames other than QoS-data
2713 * frames, it must take care to never send a non-QoS-data frame as
2714 * the last frame in a service period, adding a QoS-nulldata frame
2715 * after a non-QoS-data frame if needed.
2716 */
2717
2718/**
2719 * DOC: HW queue control
2720 *
2721 * Before HW queue control was introduced, mac80211 only had a single static
2722 * assignment of per-interface AC software queues to hardware queues. This
2723 * was problematic for a few reasons:
2724 * 1) off-channel transmissions might get stuck behind other frames
2725 * 2) multiple virtual interfaces couldn't be handled correctly
2726 * 3) after-DTIM frames could get stuck behind other frames
2727 *
2728 * To solve this, hardware typically uses multiple different queues for all
2729 * the different usages, and this needs to be propagated into mac80211 so it
2730 * won't have the same problem with the software queues.
2731 *
2732 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2733 * flag that tells it that the driver implements its own queue control. To do
2734 * so, the driver will set up the various queues in each &struct ieee80211_vif
2735 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2736 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2737 * if necessary will queue the frame on the right software queue that mirrors
2738 * the hardware queue.
2739 * Additionally, the driver has to then use these HW queue IDs for the queue
2740 * management functions (ieee80211_stop_queue() et al.)
2741 *
2742 * The driver is free to set up the queue mappings as needed, multiple virtual
2743 * interfaces may map to the same hardware queues if needed. The setup has to
2744 * happen during add_interface or change_interface callbacks. For example, a
2745 * driver supporting station+station and station+AP modes might decide to have
2746 * 10 hardware queues to handle different scenarios:
2747 *
2748 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2749 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2750 * after-DTIM queue for AP:   8
2751 * off-channel queue:         9
2752 *
2753 * It would then set up the hardware like this:
2754 *   hw.offchannel_tx_hw_queue = 9
2755 *
2756 * and the first virtual interface that is added as follows:
2757 *   vif.hw_queue[IEEE80211_AC_VO] = 0
2758 *   vif.hw_queue[IEEE80211_AC_VI] = 1
2759 *   vif.hw_queue[IEEE80211_AC_BE] = 2
2760 *   vif.hw_queue[IEEE80211_AC_BK] = 3
2761 *   vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2762 * and the second virtual interface with 4-7.
2763 *
2764 * If queue 6 gets full, for example, mac80211 would only stop the second
2765 * virtual interface's BE queue since virtual interface queues are per AC.
2766 *
2767 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2768 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2769 * queue could potentially be shared since mac80211 will look at cab_queue when
2770 * a queue is stopped/woken even if the interface is not in AP mode.
2771 */
2772
2773/**
2774 * enum ieee80211_filter_flags - hardware filter flags
2775 *
2776 * These flags determine what the filter in hardware should be
2777 * programmed to let through and what should not be passed to the
2778 * stack. It is always safe to pass more frames than requested,
2779 * but this has negative impact on power consumption.
2780 *
2781 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2782 *      by the user or if the hardware is not capable of filtering by
2783 *      multicast address.
2784 *
2785 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2786 *      %RX_FLAG_FAILED_FCS_CRC for them)
2787 *
2788 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2789 *      the %RX_FLAG_FAILED_PLCP_CRC for them
2790 *
2791 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2792 *      to the hardware that it should not filter beacons or probe responses
2793 *      by BSSID. Filtering them can greatly reduce the amount of processing
2794 *      mac80211 needs to do and the amount of CPU wakeups, so you should
2795 *      honour this flag if possible.
2796 *
2797 * @FIF_CONTROL: pass control frames (except for PS Poll) addressed to this
2798 *      station
2799 *
2800 * @FIF_OTHER_BSS: pass frames destined to other BSSes
2801 *
2802 * @FIF_PSPOLL: pass PS Poll frames
2803 *
2804 * @FIF_PROBE_REQ: pass probe request frames
2805 */
2806enum ieee80211_filter_flags {
2807        FIF_ALLMULTI            = 1<<1,
2808        FIF_FCSFAIL             = 1<<2,
2809        FIF_PLCPFAIL            = 1<<3,
2810        FIF_BCN_PRBRESP_PROMISC = 1<<4,
2811        FIF_CONTROL             = 1<<5,
2812        FIF_OTHER_BSS           = 1<<6,
2813        FIF_PSPOLL              = 1<<7,
2814        FIF_PROBE_REQ           = 1<<8,
2815};
2816
2817/**
2818 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2819 *
2820 * These flags are used with the ampdu_action() callback in
2821 * &struct ieee80211_ops to indicate which action is needed.
2822 *
2823 * Note that drivers MUST be able to deal with a TX aggregation
2824 * session being stopped even before they OK'ed starting it by
2825 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2826 * might receive the addBA frame and send a delBA right away!
2827 *
2828 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2829 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2830 * @IEEE80211_AMPDU_TX_START: start TX aggregation
2831 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2832 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2833 *      queued packets, now unaggregated. After all packets are transmitted the
2834 *      driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2835 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2836 *      called when the station is removed. There's no need or reason to call
2837 *      ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2838 *      session is gone and removes the station.
2839 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2840 *      but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2841 *      now the connection is dropped and the station will be removed. Drivers
2842 *      should clean up and drop remaining packets when this is called.
2843 */
2844enum ieee80211_ampdu_mlme_action {
2845        IEEE80211_AMPDU_RX_START,
2846        IEEE80211_AMPDU_RX_STOP,
2847        IEEE80211_AMPDU_TX_START,
2848        IEEE80211_AMPDU_TX_STOP_CONT,
2849        IEEE80211_AMPDU_TX_STOP_FLUSH,
2850        IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
2851        IEEE80211_AMPDU_TX_OPERATIONAL,
2852};
2853
2854/**
2855 * struct ieee80211_ampdu_params - AMPDU action parameters
2856 *
2857 * @action: the ampdu action, value from %ieee80211_ampdu_mlme_action.
2858 * @sta: peer of this AMPDU session
2859 * @tid: tid of the BA session
2860 * @ssn: start sequence number of the session. TX/RX_STOP can pass 0. When
2861 *      action is set to %IEEE80211_AMPDU_RX_START the driver passes back the
2862 *      actual ssn value used to start the session and writes the value here.
2863 * @buf_size: reorder buffer size  (number of subframes). Valid only when the
2864 *      action is set to %IEEE80211_AMPDU_RX_START or
2865 *      %IEEE80211_AMPDU_TX_OPERATIONAL
2866 * @amsdu: indicates the peer's ability to receive A-MSDU within A-MPDU.
2867 *      valid when the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL
2868 * @timeout: BA session timeout. Valid only when the action is set to
2869 *      %IEEE80211_AMPDU_RX_START
2870 */
2871struct ieee80211_ampdu_params {
2872        enum ieee80211_ampdu_mlme_action action;
2873        struct ieee80211_sta *sta;
2874        u16 tid;
2875        u16 ssn;
2876        u8 buf_size;
2877        bool amsdu;
2878        u16 timeout;
2879};
2880
2881/**
2882 * enum ieee80211_frame_release_type - frame release reason
2883 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2884 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2885 *      frame received on trigger-enabled AC
2886 */
2887enum ieee80211_frame_release_type {
2888        IEEE80211_FRAME_RELEASE_PSPOLL,
2889        IEEE80211_FRAME_RELEASE_UAPSD,
2890};
2891
2892/**
2893 * enum ieee80211_rate_control_changed - flags to indicate what changed
2894 *
2895 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2896 *      to this station changed. The actual bandwidth is in the station
2897 *      information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2898 *      flag changes, for HT and VHT the bandwidth field changes.
2899 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2900 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2901 *      changed (in IBSS mode) due to discovering more information about
2902 *      the peer.
2903 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2904 *      by the peer
2905 */
2906enum ieee80211_rate_control_changed {
2907        IEEE80211_RC_BW_CHANGED         = BIT(0),
2908        IEEE80211_RC_SMPS_CHANGED       = BIT(1),
2909        IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
2910        IEEE80211_RC_NSS_CHANGED        = BIT(3),
2911};
2912
2913/**
2914 * enum ieee80211_roc_type - remain on channel type
2915 *
2916 * With the support for multi channel contexts and multi channel operations,
2917 * remain on channel operations might be limited/deferred/aborted by other
2918 * flows/operations which have higher priority (and vise versa).
2919 * Specifying the ROC type can be used by devices to prioritize the ROC
2920 * operations compared to other operations/flows.
2921 *
2922 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2923 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2924 *      for sending managment frames offchannel.
2925 */
2926enum ieee80211_roc_type {
2927        IEEE80211_ROC_TYPE_NORMAL = 0,
2928        IEEE80211_ROC_TYPE_MGMT_TX,
2929};
2930
2931/**
2932 * enum ieee80211_reconfig_complete_type - reconfig type
2933 *
2934 * This enum is used by the reconfig_complete() callback to indicate what
2935 * reconfiguration type was completed.
2936 *
2937 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
2938 *      (also due to resume() callback returning 1)
2939 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
2940 *      of wowlan configuration)
2941 */
2942enum ieee80211_reconfig_type {
2943        IEEE80211_RECONFIG_TYPE_RESTART,
2944        IEEE80211_RECONFIG_TYPE_SUSPEND,
2945};
2946
2947/**
2948 * struct ieee80211_ops - callbacks from mac80211 to the driver
2949 *
2950 * This structure contains various callbacks that the driver may
2951 * handle or, in some cases, must handle, for example to configure
2952 * the hardware to a new channel or to transmit a frame.
2953 *
2954 * @tx: Handler that 802.11 module calls for each transmitted frame.
2955 *      skb contains the buffer starting from the IEEE 802.11 header.
2956 *      The low-level driver should send the frame out based on
2957 *      configuration in the TX control data. This handler should,
2958 *      preferably, never fail and stop queues appropriately.
2959 *      Must be atomic.
2960 *
2961 * @start: Called before the first netdevice attached to the hardware
2962 *      is enabled. This should turn on the hardware and must turn on
2963 *      frame reception (for possibly enabled monitor interfaces.)
2964 *      Returns negative error codes, these may be seen in userspace,
2965 *      or zero.
2966 *      When the device is started it should not have a MAC address
2967 *      to avoid acknowledging frames before a non-monitor device
2968 *      is added.
2969 *      Must be implemented and can sleep.
2970 *
2971 * @stop: Called after last netdevice attached to the hardware
2972 *      is disabled. This should turn off the hardware (at least
2973 *      it must turn off frame reception.)
2974 *      May be called right after add_interface if that rejects
2975 *      an interface. If you added any work onto the mac80211 workqueue
2976 *      you should ensure to cancel it on this callback.
2977 *      Must be implemented and can sleep.
2978 *
2979 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2980 *      stop transmitting and doing any other configuration, and then
2981 *      ask the device to suspend. This is only invoked when WoWLAN is
2982 *      configured, otherwise the device is deconfigured completely and
2983 *      reconfigured at resume time.
2984 *      The driver may also impose special conditions under which it
2985 *      wants to use the "normal" suspend (deconfigure), say if it only
2986 *      supports WoWLAN when the device is associated. In this case, it
2987 *      must return 1 from this function.
2988 *
2989 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2990 *      now resuming its operation, after this the device must be fully
2991 *      functional again. If this returns an error, the only way out is
2992 *      to also unregister the device. If it returns 1, then mac80211
2993 *      will also go through the regular complete restart on resume.
2994 *
2995 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2996 *      modified. The reason is that device_set_wakeup_enable() is
2997 *      supposed to be called when the configuration changes, not only
2998 *      in suspend().
2999 *
3000 * @add_interface: Called when a netdevice attached to the hardware is
3001 *      enabled. Because it is not called for monitor mode devices, @start
3002 *      and @stop must be implemented.
3003 *      The driver should perform any initialization it needs before
3004 *      the device can be enabled. The initial configuration for the
3005 *      interface is given in the conf parameter.
3006 *      The callback may refuse to add an interface by returning a
3007 *      negative error code (which will be seen in userspace.)
3008 *      Must be implemented and can sleep.
3009 *
3010 * @change_interface: Called when a netdevice changes type. This callback
3011 *      is optional, but only if it is supported can interface types be
3012 *      switched while the interface is UP. The callback may sleep.
3013 *      Note that while an interface is being switched, it will not be
3014 *      found by the interface iteration callbacks.
3015 *
3016 * @remove_interface: Notifies a driver that an interface is going down.
3017 *      The @stop callback is called after this if it is the last interface
3018 *      and no monitor interfaces are present.
3019 *      When all interfaces are removed, the MAC address in the hardware
3020 *      must be cleared so the device no longer acknowledges packets,
3021 *      the mac_addr member of the conf structure is, however, set to the
3022 *      MAC address of the device going away.
3023 *      Hence, this callback must be implemented. It can sleep.
3024 *
3025 * @config: Handler for configuration requests. IEEE 802.11 code calls this
3026 *      function to change hardware configuration, e.g., channel.
3027 *      This function should never fail but returns a negative error code
3028 *      if it does. The callback can sleep.
3029 *
3030 * @bss_info_changed: Handler for configuration requests related to BSS
3031 *      parameters that may vary during BSS's lifespan, and may affect low
3032 *      level driver (e.g. assoc/disassoc status, erp parameters).
3033 *      This function should not be used if no BSS has been set, unless
3034 *      for association indication. The @changed parameter indicates which
3035 *      of the bss parameters has changed when a call is made. The callback
3036 *      can sleep.
3037 *
3038 * @prepare_multicast: Prepare for multicast filter configuration.
3039 *      This callback is optional, and its return value is passed
3040 *      to configure_filter(). This callback must be atomic.
3041 *
3042 * @configure_filter: Configure the device's RX filter.
3043 *      See the section "Frame filtering" for more information.
3044 *      This callback must be implemented and can sleep.
3045 *
3046 * @config_iface_filter: Configure the interface's RX filter.
3047 *      This callback is optional and is used to configure which frames
3048 *      should be passed to mac80211. The filter_flags is the combination
3049 *      of FIF_* flags. The changed_flags is a bit mask that indicates
3050 *      which flags are changed.
3051 *      This callback can sleep.
3052 *
3053 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
3054 *      must be set or cleared for a given STA. Must be atomic.
3055 *
3056 * @set_key: See the section "Hardware crypto acceleration"
3057 *      This callback is only called between add_interface and
3058 *      remove_interface calls, i.e. while the given virtual interface
3059 *      is enabled.
3060 *      Returns a negative error code if the key can't be added.
3061 *      The callback can sleep.
3062 *
3063 * @update_tkip_key: See the section "Hardware crypto acceleration"
3064 *      This callback will be called in the context of Rx. Called for drivers
3065 *      which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
3066 *      The callback must be atomic.
3067 *
3068 * @set_rekey_data: If the device supports GTK rekeying, for example while the
3069 *      host is suspended, it can assign this callback to retrieve the data
3070 *      necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
3071 *      After rekeying was done it should (for example during resume) notify
3072 *      userspace of the new replay counter using ieee80211_gtk_rekey_notify().
3073 *
3074 * @set_default_unicast_key: Set the default (unicast) key index, useful for
3075 *      WEP when the device sends data packets autonomously, e.g. for ARP
3076 *      offloading. The index can be 0-3, or -1 for unsetting it.
3077 *
3078 * @hw_scan: Ask the hardware to service the scan request, no need to start
3079 *      the scan state machine in stack. The scan must honour the channel
3080 *      configuration done by the regulatory agent in the wiphy's
3081 *      registered bands. The hardware (or the driver) needs to make sure
3082 *      that power save is disabled.
3083 *      The @req ie/ie_len members are rewritten by mac80211 to contain the
3084 *      entire IEs after the SSID, so that drivers need not look at these
3085 *      at all but just send them after the SSID -- mac80211 includes the
3086 *      (extended) supported rates and HT information (where applicable).
3087 *      When the scan finishes, ieee80211_scan_completed() must be called;
3088 *      note that it also must be called when the scan cannot finish due to
3089 *      any error unless this callback returned a negative error code.
3090 *      The callback can sleep.
3091 *
3092 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
3093 *      The driver should ask the hardware to cancel the scan (if possible),
3094 *      but the scan will be completed only after the driver will call
3095 *      ieee80211_scan_completed().
3096 *      This callback is needed for wowlan, to prevent enqueueing a new
3097 *      scan_work after the low-level driver was already suspended.
3098 *      The callback can sleep.
3099 *
3100 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
3101 *      specific intervals.  The driver must call the
3102 *      ieee80211_sched_scan_results() function whenever it finds results.
3103 *      This process will continue until sched_scan_stop is called.
3104 *
3105 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
3106 *      In this case, ieee80211_sched_scan_stopped() must not be called.
3107 *
3108 * @sw_scan_start: Notifier function that is called just before a software scan
3109 *      is started. Can be NULL, if the driver doesn't need this notification.
3110 *      The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
3111 *      the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
3112 *      can use this parameter. The callback can sleep.
3113 *
3114 * @sw_scan_complete: Notifier function that is called just after a
3115 *      software scan finished. Can be NULL, if the driver doesn't need
3116 *      this notification.
3117 *      The callback can sleep.
3118 *
3119 * @get_stats: Return low-level statistics.
3120 *      Returns zero if statistics are available.
3121 *      The callback can sleep.
3122 *
3123 * @get_key_seq: If your device implements encryption in hardware and does
3124 *      IV/PN assignment then this callback should be provided to read the
3125 *      IV/PN for the given key from hardware.
3126 *      The callback must be atomic.
3127 *
3128 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
3129 *      if the device does fragmentation by itself. Note that to prevent the
3130 *      stack from doing fragmentation IEEE80211_HW_SUPPORTS_TX_FRAG
3131 *      should be set as well.
3132 *      The callback can sleep.
3133 *
3134 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
3135 *      The callback can sleep.
3136 *
3137 * @sta_add: Notifies low level driver about addition of an associated station,
3138 *      AP, IBSS/WDS/mesh peer etc. This callback can sleep.
3139 *
3140 * @sta_remove: Notifies low level driver about removal of an associated
3141 *      station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
3142 *      returns it isn't safe to use the pointer, not even RCU protected;
3143 *      no RCU grace period is guaranteed between returning here and freeing
3144 *      the station. See @sta_pre_rcu_remove if needed.
3145 *      This callback can sleep.
3146 *
3147 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
3148 *      when a station is added to mac80211's station list. This callback
3149 *      should be within a CONFIG_MAC80211_DEBUGFS conditional. This
3150 *      callback can sleep.
3151 *
3152 * @sta_notify: Notifies low level driver about power state transition of an
3153 *      associated station, AP,  IBSS/WDS/mesh peer etc. For a VIF operating
3154 *      in AP mode, this callback will not be called when the flag
3155 *      %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
3156 *
3157 * @sta_state: Notifies low level driver about state transition of a
3158 *      station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
3159 *      This callback is mutually exclusive with @sta_add/@sta_remove.
3160 *      It must not fail for down transitions but may fail for transitions
3161 *      up the list of states. Also note that after the callback returns it
3162 *      isn't safe to use the pointer, not even RCU protected - no RCU grace
3163 *      period is guaranteed between returning here and freeing the station.
3164 *      See @sta_pre_rcu_remove if needed.
3165 *      The callback can sleep.
3166 *
3167 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
3168 *      synchronisation. This is useful if a driver needs to have station
3169 *      pointers protected using RCU, it can then use this call to clear
3170 *      the pointers instead of waiting for an RCU grace period to elapse
3171 *      in @sta_state.
3172 *      The callback can sleep.
3173 *
3174 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
3175 *      used to transmit to the station. The changes are advertised with bits
3176 *      from &enum ieee80211_rate_control_changed and the values are reflected
3177 *      in the station data. This callback should only be used when the driver
3178 *      uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
3179 *      otherwise the rate control algorithm is notified directly.
3180 *      Must be atomic.
3181 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
3182 *      is only used if the configured rate control algorithm actually uses
3183 *      the new rate table API, and is therefore optional. Must be atomic.
3184 *
3185 * @sta_statistics: Get statistics for this station. For example with beacon
3186 *      filtering, the statistics kept by mac80211 might not be accurate, so
3187 *      let the driver pre-fill the statistics. The driver can fill most of
3188 *      the values (indicating which by setting the filled bitmap), but not
3189 *      all of them make sense - see the source for which ones are possible.
3190 *      Statistics that the driver doesn't fill will be filled by mac80211.
3191 *      The callback can sleep.
3192 *
3193 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
3194 *      bursting) for a hardware TX queue.
3195 *      Returns a negative error code on failure.
3196 *      The callback can sleep.
3197 *
3198 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
3199 *      this is only used for IBSS mode BSSID merging and debugging. Is not a
3200 *      required function.
3201 *      The callback can sleep.
3202 *
3203 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
3204 *      Currently, this is only used for IBSS mode debugging. Is not a
3205 *      required function.
3206 *      The callback can sleep.
3207 *
3208 * @offset_tsf: Offset the TSF timer by the specified value in the
3209 *      firmware/hardware.  Preferred to set_tsf as it avoids delay between
3210 *      calling set_tsf() and hardware getting programmed, which will show up
3211 *      as TSF delay. Is not a required function.
3212 *      The callback can sleep.
3213 *
3214 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
3215 *      with other STAs in the IBSS. This is only used in IBSS mode. This
3216 *      function is optional if the firmware/hardware takes full care of
3217 *      TSF synchronization.
3218 *      The callback can sleep.
3219 *
3220 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
3221 *      This is needed only for IBSS mode and the result of this function is
3222 *      used to determine whether to reply to Probe Requests.
3223 *      Returns non-zero if this device sent the last beacon.
3224 *      The callback can sleep.
3225 *
3226 * @get_survey: Return per-channel survey information
3227 *
3228 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
3229 *      need to set wiphy->rfkill_poll to %true before registration,
3230 *      and need to call wiphy_rfkill_set_hw_state() in the callback.
3231 *      The callback can sleep.
3232 *
3233 * @set_coverage_class: Set slot time for given coverage class as specified
3234 *      in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
3235 *      accordingly; coverage class equals to -1 to enable ACK timeout
3236 *      estimation algorithm (dynack). To disable dynack set valid value for
3237 *      coverage class. This callback is not required and may sleep.
3238 *
3239 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
3240 *      be %NULL. The callback can sleep.
3241 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
3242 *
3243 * @flush: Flush all pending frames from the hardware queue, making sure
3244 *      that the hardware queues are empty. The @queues parameter is a bitmap
3245 *      of queues to flush, which is useful if different virtual interfaces
3246 *      use different hardware queues; it may also indicate all queues.
3247 *      If the parameter @drop is set to %true, pending frames may be dropped.
3248 *      Note that vif can be NULL.
3249 *      The callback can sleep.
3250 *
3251 * @channel_switch: Drivers that need (or want) to offload the channel
3252 *      switch operation for CSAs received from the AP may implement this
3253 *      callback. They must then call ieee80211_chswitch_done() to indicate
3254 *      completion of the channel switch.
3255 *
3256 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3257 *      Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3258 *      reject TX/RX mask combinations they cannot support by returning -EINVAL
3259 *      (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3260 *
3261 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3262 *
3263 * @remain_on_channel: Starts an off-channel period on the given channel, must
3264 *      call back to ieee80211_ready_on_channel() when on that channel. Note
3265 *      that normal channel traffic is not stopped as this is intended for hw
3266 *      offload. Frames to transmit on the off-channel channel are transmitted
3267 *      normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
3268 *      duration (which will always be non-zero) expires, the driver must call
3269 *      ieee80211_remain_on_channel_expired().
3270 *      Note that this callback may be called while the device is in IDLE and
3271 *      must be accepted in this case.
3272 *      This callback may sleep.
3273 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
3274 *      aborted before it expires. This callback may sleep.
3275 *
3276 * @set_ringparam: Set tx and rx ring sizes.
3277 *
3278 * @get_ringparam: Get tx and rx ring current and maximum sizes.
3279 *
3280 * @tx_frames_pending: Check if there is any pending frame in the hardware
3281 *      queues before entering power save.
3282 *
3283 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
3284 *      when transmitting a frame. Currently only legacy rates are handled.
3285 *      The callback can sleep.
3286 * @event_callback: Notify driver about any event in mac80211. See
3287 *      &enum ieee80211_event_type for the different types.
3288 *      The callback must be atomic.
3289 *
3290 * @release_buffered_frames: Release buffered frames according to the given
3291 *      parameters. In the case where the driver buffers some frames for
3292 *      sleeping stations mac80211 will use this callback to tell the driver
3293 *      to release some frames, either for PS-poll or uAPSD.
3294 *      Note that if the @more_data parameter is %false the driver must check
3295 *      if there are more frames on the given TIDs, and if there are more than
3296 *      the frames being released then it must still set the more-data bit in
3297 *      the frame. If the @more_data parameter is %true, then of course the
3298 *      more-data bit must always be set.
3299 *      The @tids parameter tells the driver which TIDs to release frames
3300 *      from, for PS-poll it will always have only a single bit set.
3301 *      In the case this is used for a PS-poll initiated release, the
3302 *      @num_frames parameter will always be 1 so code can be shared. In
3303 *      this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
3304 *      on the TX status (and must report TX status) so that the PS-poll
3305 *      period is properly ended. This is used to avoid sending multiple
3306 *      responses for a retried PS-poll frame.
3307 *      In the case this is used for uAPSD, the @num_frames parameter may be
3308 *      bigger than one, but the driver may send fewer frames (it must send
3309 *      at least one, however). In this case it is also responsible for
3310 *      setting the EOSP flag in the QoS header of the frames. Also, when the
3311 *      service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
3312 *      on the last frame in the SP. Alternatively, it may call the function
3313 *      ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
3314 *      This callback must be atomic.
3315 * @allow_buffered_frames: Prepare device to allow the given number of frames
3316 *      to go out to the given station. The frames will be sent by mac80211
3317 *      via the usual TX path after this call. The TX information for frames
3318 *      released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
3319 *      and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
3320 *      frames from multiple TIDs are released and the driver might reorder
3321 *      them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
3322 *      on the last frame and clear it on all others and also handle the EOSP
3323 *      bit in the QoS header correctly. Alternatively, it can also call the
3324 *      ieee80211_sta_eosp() function.
3325 *      The @tids parameter is a bitmap and tells the driver which TIDs the
3326 *      frames will be on; it will at most have two bits set.
3327 *      This callback must be atomic.
3328 *
3329 * @get_et_sset_count:  Ethtool API to get string-set count.
3330 *
3331 * @get_et_stats:  Ethtool API to get a set of u64 stats.
3332 *
3333 * @get_et_strings:  Ethtool API to get a set of strings to describe stats
3334 *      and perhaps other supported types of ethtool data-sets.
3335 *
3336 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
3337 *      before associated. In multi-channel scenarios, a virtual interface is
3338 *      bound to a channel before it is associated, but as it isn't associated
3339 *      yet it need not necessarily be given airtime, in particular since any
3340 *      transmission to a P2P GO needs to be synchronized against the GO's
3341 *      powersave state. mac80211 will call this function before transmitting a
3342 *      management frame prior to having successfully associated to allow the
3343 *      driver to give it channel time for the transmission, to get a response
3344 *      and to be able to synchronize with the GO.
3345 *      The callback will be called before each transmission and upon return
3346 *      mac80211 will transmit the frame right away.
3347 *      The callback is optional and can (should!) sleep.
3348 *
3349 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
3350 *      a TDLS discovery-request, we expect a reply to arrive on the AP's
3351 *      channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
3352 *      setup-response is a direct packet not buffered by the AP.
3353 *      mac80211 will call this function just before the transmission of a TDLS
3354 *      discovery-request. The recommended period of protection is at least
3355 *      2 * (DTIM period).
3356 *      The callback is optional and can sleep.
3357 *
3358 * @add_chanctx: Notifies device driver about new channel context creation.
3359 *      This callback may sleep.
3360 * @remove_chanctx: Notifies device driver about channel context destruction.
3361 *      This callback may sleep.
3362 * @change_chanctx: Notifies device driver about channel context changes that
3363 *      may happen when combining different virtual interfaces on the same
3364 *      channel context with different settings
3365 *      This callback may sleep.
3366 * @assign_vif_chanctx: Notifies device driver about channel context being bound
3367 *      to vif. Possible use is for hw queue remapping.
3368 *      This callback may sleep.
3369 * @unassign_vif_chanctx: Notifies device driver about channel context being
3370 *      unbound from vif.
3371 *      This callback may sleep.
3372 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
3373 *      another, as specified in the list of
3374 *      @ieee80211_vif_chanctx_switch passed to the driver, according
3375 *      to the mode defined in &ieee80211_chanctx_switch_mode.
3376 *      This callback may sleep.
3377 *
3378 * @start_ap: Start operation on the AP interface, this is called after all the
3379 *      information in bss_conf is set and beacon can be retrieved. A channel
3380 *      context is bound before this is called. Note that if the driver uses
3381 *      software scan or ROC, this (and @stop_ap) isn't called when the AP is
3382 *      just "paused" for scanning/ROC, which is indicated by the beacon being
3383 *      disabled/enabled via @bss_info_changed.
3384 * @stop_ap: Stop operation on the AP interface.
3385 *
3386 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
3387 *      during resume, when the reconfiguration has completed.
3388 *      This can help the driver implement the reconfiguration step (and
3389 *      indicate mac80211 is ready to receive frames).
3390 *      This callback may sleep.
3391 *
3392 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
3393 *      Currently, this is only called for managed or P2P client interfaces.
3394 *      This callback is optional; it must not sleep.
3395 *
3396 * @channel_switch_beacon: Starts a channel switch to a new channel.
3397 *      Beacons are modified to include CSA or ECSA IEs before calling this
3398 *      function. The corresponding count fields in these IEs must be
3399 *      decremented, and when they reach 1 the driver must call
3400 *      ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
3401 *      get the csa counter decremented by mac80211, but must check if it is
3402 *      1 using ieee80211_csa_is_complete() after the beacon has been
3403 *      transmitted and then call ieee80211_csa_finish().
3404 *      If the CSA count starts as zero or 1, this function will not be called,
3405 *      since there won't be any time to beacon before the switch anyway.
3406 * @pre_channel_switch: This is an optional callback that is called
3407 *      before a channel switch procedure is started (ie. when a STA
3408 *      gets a CSA or a userspace initiated channel-switch), allowing
3409 *      the driver to prepare for the channel switch.
3410 * @post_channel_switch: This is an optional callback that is called
3411 *      after a channel switch procedure is completed, allowing the
3412 *      driver to go back to a normal configuration.
3413 *
3414 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
3415 *      information in bss_conf is set up and the beacon can be retrieved. A
3416 *      channel context is bound before this is called.
3417 * @leave_ibss: Leave the IBSS again.
3418 *
3419 * @get_expected_throughput: extract the expected throughput towards the
3420 *      specified station. The returned value is expressed in Kbps. It returns 0
3421 *      if the RC algorithm does not have proper data to provide.
3422 *
3423 * @get_txpower: get current maximum tx power (in dBm) based on configuration
3424 *      and hardware limits.
3425 *
3426 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3427 *      is responsible for continually initiating channel-switching operations
3428 *      and returning to the base channel for communication with the AP. The
3429 *      driver receives a channel-switch request template and the location of
3430 *      the switch-timing IE within the template as part of the invocation.
3431 *      The template is valid only within the call, and the driver can
3432 *      optionally copy the skb for further re-use.
3433 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3434 *      peers must be on the base channel when the call completes.
3435 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
3436 *      response) has been received from a remote peer. The driver gets
3437 *      parameters parsed from the incoming frame and may use them to continue
3438 *      an ongoing channel-switch operation. In addition, a channel-switch
3439 *      response template is provided, together with the location of the
3440 *      switch-timing IE within the template. The skb can only be used within
3441 *      the function call.
3442 *
3443 * @wake_tx_queue: Called when new packets have been added to the queue.
3444 * @sync_rx_queues: Process all pending frames in RSS queues. This is a
3445 *      synchronization which is needed in case driver has in its RSS queues
3446 *      pending frames that were received prior to the control path action
3447 *      currently taken (e.g. disassociation) but are not processed yet.
3448 *
3449 * @start_nan: join an existing NAN cluster, or create a new one.
3450 * @stop_nan: leave the NAN cluster.
3451 * @nan_change_conf: change NAN configuration. The data in cfg80211_nan_conf
3452 *      contains full new configuration and changes specify which parameters
3453 *      are changed with respect to the last NAN config.
3454 *      The driver gets both full configuration and the changed parameters since
3455 *      some devices may need the full configuration while others need only the
3456 *      changed parameters.
3457 * @add_nan_func: Add a NAN function. Returns 0 on success. The data in
3458 *      cfg80211_nan_func must not be referenced outside the scope of
3459 *      this call.
3460 * @del_nan_func: Remove a NAN function. The driver must call
3461 *      ieee80211_nan_func_terminated() with
3462 *      NL80211_NAN_FUNC_TERM_REASON_USER_REQUEST reason code upon removal.
3463 */
3464struct ieee80211_ops {
3465        void (*tx)(struct ieee80211_hw *hw,
3466                   struct ieee80211_tx_control *control,
3467                   struct sk_buff *skb);
3468        int (*start)(struct ieee80211_hw *hw);
3469        void (*stop)(struct ieee80211_hw *hw);
3470#ifdef CONFIG_PM
3471        int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
3472        int (*resume)(struct ieee80211_hw *hw);
3473        void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
3474#endif
3475        int (*add_interface)(struct ieee80211_hw *hw,
3476                             struct ieee80211_vif *vif);
3477        int (*change_interface)(struct ieee80211_hw *hw,
3478                                struct ieee80211_vif *vif,
3479                                enum nl80211_iftype new_type, bool p2p);
3480        void (*remove_interface)(struct ieee80211_hw *hw,
3481                                 struct ieee80211_vif *vif);
3482        int (*config)(struct ieee80211_hw *hw, u32 changed);
3483        void (*bss_info_changed)(struct ieee80211_hw *hw,
3484                                 struct ieee80211_vif *vif,
3485                                 struct ieee80211_bss_conf *info,
3486                                 u32 changed);
3487
3488        int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3489        void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3490
3491        u64 (*prepare_multicast)(struct ieee80211_hw *hw,
3492                                 struct netdev_hw_addr_list *mc_list);
3493        void (*configure_filter)(struct ieee80211_hw *hw,
3494                                 unsigned int changed_flags,
3495                                 unsigned int *total_flags,
3496                                 u64 multicast);
3497        void (*config_iface_filter)(struct ieee80211_hw *hw,
3498                                    struct ieee80211_vif *vif,
3499                                    unsigned int filter_flags,
3500                                    unsigned int changed_flags);
3501        int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
3502                       bool set);
3503        int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
3504                       struct ieee80211_vif *vif, struct ieee80211_sta *sta,
3505                       struct ieee80211_key_conf *key);
3506        void (*update_tkip_key)(struct ieee80211_hw *hw,
3507                                struct ieee80211_vif *vif,
3508                                struct ieee80211_key_conf *conf,
3509                                struct ieee80211_sta *sta,
3510                                u32 iv32, u16 *phase1key);
3511        void (*set_rekey_data)(struct ieee80211_hw *hw,
3512                               struct ieee80211_vif *vif,
3513                               struct cfg80211_gtk_rekey_data *data);
3514        void (*set_default_unicast_key)(struct ieee80211_hw *hw,
3515                                        struct ieee80211_vif *vif, int idx);
3516        int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3517                       struct ieee80211_scan_request *req);
3518        void (*cancel_hw_scan)(struct ieee80211_hw *hw,
3519                               struct ieee80211_vif *vif);
3520        int (*sched_scan_start)(struct ieee80211_hw *hw,
3521                                struct ieee80211_vif *vif,
3522                                struct cfg80211_sched_scan_request *req,
3523                                struct ieee80211_scan_ies *ies);
3524        int (*sched_scan_stop)(struct ieee80211_hw *hw,
3525                               struct ieee80211_vif *vif);
3526        void (*sw_scan_start)(struct ieee80211_hw *hw,
3527                              struct ieee80211_vif *vif,
3528                              const u8 *mac_addr);
3529        void (*sw_scan_complete)(struct ieee80211_hw *hw,
3530                                 struct ieee80211_vif *vif);
3531        int (*get_stats)(struct ieee80211_hw *hw,
3532                         struct ieee80211_low_level_stats *stats);
3533        void (*get_key_seq)(struct ieee80211_hw *hw,
3534                            struct ieee80211_key_conf *key,
3535                            struct ieee80211_key_seq *seq);
3536        int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
3537        int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
3538        int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3539                       struct ieee80211_sta *sta);
3540        int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3541                          struct ieee80211_sta *sta);
3542#ifdef CONFIG_MAC80211_DEBUGFS
3543        void (*sta_add_debugfs)(struct ieee80211_hw *hw,
3544                                struct ieee80211_vif *vif,
3545                                struct ieee80211_sta *sta,
3546                                struct dentry *dir);
3547#endif
3548        void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3549                        enum sta_notify_cmd, struct ieee80211_sta *sta);
3550        int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3551                         struct ieee80211_sta *sta,
3552                         enum ieee80211_sta_state old_state,
3553                         enum ieee80211_sta_state new_state);
3554        void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
3555                                   struct ieee80211_vif *vif,
3556                                   struct ieee80211_sta *sta);
3557        void (*sta_rc_update)(struct ieee80211_hw *hw,
3558                              struct ieee80211_vif *vif,
3559                              struct ieee80211_sta *sta,
3560                              u32 changed);
3561        void (*sta_rate_tbl_update)(struct ieee80211_hw *hw,
3562                                    struct ieee80211_vif *vif,
3563                                    struct ieee80211_sta *sta);
3564        void (*sta_statistics)(struct ieee80211_hw *hw,
3565                               struct ieee80211_vif *vif,
3566                               struct ieee80211_sta *sta,
3567                               struct station_info *sinfo);
3568        int (*conf_tx)(struct ieee80211_hw *hw,
3569                       struct ieee80211_vif *vif, u16 ac,
3570                       const struct ieee80211_tx_queue_params *params);
3571        u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3572        void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3573                        u64 tsf);
3574        void (*offset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3575                           s64 offset);
3576        void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3577        int (*tx_last_beacon)(struct ieee80211_hw *hw);
3578
3579        /**
3580         * @ampdu_action:
3581         * Perform a certain A-MPDU action.
3582         * The RA/TID combination determines the destination and TID we want
3583         * the ampdu action to be performed for. The action is defined through
3584         * ieee80211_ampdu_mlme_action.
3585         * When the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL the driver
3586         * may neither send aggregates containing more subframes than @buf_size
3587         * nor send aggregates in a way that lost frames would exceed the
3588         * buffer size. If just limiting the aggregate size, this would be
3589         * possible with a buf_size of 8:
3590         *
3591         * - ``TX: 1.....7``
3592         * - ``RX:  2....7`` (lost frame #1)
3593         * - ``TX:        8..1...``
3594         *
3595         * which is invalid since #1 was now re-transmitted well past the
3596         * buffer size of 8. Correct ways to retransmit #1 would be:
3597         *
3598         * - ``TX:        1   or``
3599         * - ``TX:        18  or``
3600         * - ``TX:        81``
3601         *
3602         * Even ``189`` would be wrong since 1 could be lost again.
3603         *
3604         * Returns a negative error code on failure.
3605         * The callback can sleep.
3606         */
3607        int (*ampdu_action)(struct ieee80211_hw *hw,
3608                            struct ieee80211_vif *vif,
3609                            struct ieee80211_ampdu_params *params);
3610        int (*get_survey)(struct ieee80211_hw *hw, int idx,
3611                struct survey_info *survey);
3612        void (*rfkill_poll)(struct ieee80211_hw *hw);
3613        void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class);
3614#ifdef CONFIG_NL80211_TESTMODE
3615        int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3616                            void *data, int len);
3617        int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
3618                             struct netlink_callback *cb,
3619                             void *data, int len);
3620#endif
3621        void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3622                      u32 queues, bool drop);
3623        void (*channel_switch)(struct ieee80211_hw *hw,
3624                               struct ieee80211_vif *vif,
3625                               struct ieee80211_channel_switch *ch_switch);
3626        int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
3627        int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
3628
3629        int (*remain_on_channel)(struct ieee80211_hw *hw,
3630                                 struct ieee80211_vif *vif,
3631                                 struct ieee80211_channel *chan,
3632                                 int duration,
3633                                 enum ieee80211_roc_type type);
3634        int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
3635        int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
3636        void (*get_ringparam)(struct ieee80211_hw *hw,
3637                              u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
3638        bool (*tx_frames_pending)(struct ieee80211_hw *hw);
3639        int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3640                                const struct cfg80211_bitrate_mask *mask);
3641        void (*event_callback)(struct ieee80211_hw *hw,
3642                               struct ieee80211_vif *vif,
3643                               const struct ieee80211_event *event);
3644
3645        void (*allow_buffered_frames)(struct ieee80211_hw *hw,
3646                                      struct ieee80211_sta *sta,
3647                                      u16 tids, int num_frames,
3648                                      enum ieee80211_frame_release_type reason,
3649                                      bool more_data);
3650        void (*release_buffered_frames)(struct ieee80211_hw *hw,
3651                                        struct ieee80211_sta *sta,
3652                                        u16 tids, int num_frames,
3653                                        enum ieee80211_frame_release_type reason,
3654                                        bool more_data);
3655
3656        int     (*get_et_sset_count)(struct ieee80211_hw *hw,
3657                                     struct ieee80211_vif *vif, int sset);
3658        void    (*get_et_stats)(struct ieee80211_hw *hw,
3659                                struct ieee80211_vif *vif,
3660                                struct ethtool_stats *stats, u64 *data);
3661        void    (*get_et_strings)(struct ieee80211_hw *hw,
3662                                  struct ieee80211_vif *vif,
3663                                  u32 sset, u8 *data);
3664
3665        void    (*mgd_prepare_tx)(struct ieee80211_hw *hw,
3666                                  struct ieee80211_vif *vif);
3667
3668        void    (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
3669                                             struct ieee80211_vif *vif);
3670
3671        int (*add_chanctx)(struct ieee80211_hw *hw,
3672                           struct ieee80211_chanctx_conf *ctx);
3673        void (*remove_chanctx)(struct ieee80211_hw *hw,
3674                               struct ieee80211_chanctx_conf *ctx);
3675        void (*change_chanctx)(struct ieee80211_hw *hw,
3676                               struct ieee80211_chanctx_conf *ctx,
3677                               u32 changed);
3678        int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
3679                                  struct ieee80211_vif *vif,
3680                                  struct ieee80211_chanctx_conf *ctx);
3681        void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
3682                                     struct ieee80211_vif *vif,
3683                                     struct ieee80211_chanctx_conf *ctx);
3684        int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
3685                                  struct ieee80211_vif_chanctx_switch *vifs,
3686                                  int n_vifs,
3687                                  enum ieee80211_chanctx_switch_mode mode);
3688
3689        void (*reconfig_complete)(struct ieee80211_hw *hw,
3690                                  enum ieee80211_reconfig_type reconfig_type);
3691
3692#if IS_ENABLED(CONFIG_IPV6)
3693        void (*ipv6_addr_change)(struct ieee80211_hw *hw,
3694                                 struct ieee80211_vif *vif,
3695                                 struct inet6_dev *idev);
3696#endif
3697        void (*channel_switch_beacon)(struct ieee80211_hw *hw,
3698                                      struct ieee80211_vif *vif,
3699                                      struct cfg80211_chan_def *chandef);
3700        int (*pre_channel_switch)(struct ieee80211_hw *hw,
3701                                  struct ieee80211_vif *vif,
3702                                  struct ieee80211_channel_switch *ch_switch);
3703
3704        int (*post_channel_switch)(struct ieee80211_hw *hw,
3705                                   struct ieee80211_vif *vif);
3706
3707        int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3708        void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3709        u32 (*get_expected_throughput)(struct ieee80211_hw *hw,
3710                                       struct ieee80211_sta *sta);
3711        int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3712                           int *dbm);
3713
3714        int (*tdls_channel_switch)(struct ieee80211_hw *hw,
3715                                   struct ieee80211_vif *vif,
3716                                   struct ieee80211_sta *sta, u8 oper_class,
3717                                   struct cfg80211_chan_def *chandef,
3718                                   struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie);
3719        void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw,
3720                                           struct ieee80211_vif *vif,
3721                                           struct ieee80211_sta *sta);
3722        void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw,
3723                                         struct ieee80211_vif *vif,
3724                                         struct ieee80211_tdls_ch_sw_params *params);
3725
3726        void (*wake_tx_queue)(struct ieee80211_hw *hw,
3727                              struct ieee80211_txq *txq);
3728        void (*sync_rx_queues)(struct ieee80211_hw *hw);
3729
3730        int (*start_nan)(struct ieee80211_hw *hw,
3731                         struct ieee80211_vif *vif,
3732                         struct cfg80211_nan_conf *conf);
3733        int (*stop_nan)(struct ieee80211_hw *hw,
3734                        struct ieee80211_vif *vif);
3735        int (*nan_change_conf)(struct ieee80211_hw *hw,
3736                               struct ieee80211_vif *vif,
3737                               struct cfg80211_nan_conf *conf, u32 changes);
3738        int (*add_nan_func)(struct ieee80211_hw *hw,
3739                            struct ieee80211_vif *vif,
3740                            const struct cfg80211_nan_func *nan_func);
3741        void (*del_nan_func)(struct ieee80211_hw *hw,
3742                            struct ieee80211_vif *vif,
3743                            u8 instance_id);
3744};
3745
3746/**
3747 * ieee80211_alloc_hw_nm - Allocate a new hardware device
3748 *
3749 * This must be called once for each hardware device. The returned pointer
3750 * must be used to refer to this device when calling other functions.
3751 * mac80211 allocates a private data area for the driver pointed to by
3752 * @priv in &struct ieee80211_hw, the size of this area is given as
3753 * @priv_data_len.
3754 *
3755 * @priv_data_len: length of private data
3756 * @ops: callbacks for this device
3757 * @requested_name: Requested name for this device.
3758 *      NULL is valid value, and means use the default naming (phy%d)
3759 *
3760 * Return: A pointer to the new hardware device, or %NULL on error.
3761 */
3762struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len,
3763                                           const struct ieee80211_ops *ops,
3764                                           const char *requested_name);
3765
3766/**
3767 * ieee80211_alloc_hw - Allocate a new hardware device
3768 *
3769 * This must be called once for each hardware device. The returned pointer
3770 * must be used to refer to this device when calling other functions.
3771 * mac80211 allocates a private data area for the driver pointed to by
3772 * @priv in &struct ieee80211_hw, the size of this area is given as
3773 * @priv_data_len.
3774 *
3775 * @priv_data_len: length of private data
3776 * @ops: callbacks for this device
3777 *
3778 * Return: A pointer to the new hardware device, or %NULL on error.
3779 */
3780static inline
3781struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
3782                                        const struct ieee80211_ops *ops)
3783{
3784        return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL);
3785}
3786
3787/**
3788 * ieee80211_register_hw - Register hardware device
3789 *
3790 * You must call this function before any other functions in
3791 * mac80211. Note that before a hardware can be registered, you
3792 * need to fill the contained wiphy's information.
3793 *
3794 * @hw: the device to register as returned by ieee80211_alloc_hw()
3795 *
3796 * Return: 0 on success. An error code otherwise.
3797 */
3798int ieee80211_register_hw(struct ieee80211_hw *hw);
3799
3800/**
3801 * struct ieee80211_tpt_blink - throughput blink description
3802 * @throughput: throughput in Kbit/sec
3803 * @blink_time: blink time in milliseconds
3804 *      (full cycle, ie. one off + one on period)
3805 */
3806struct ieee80211_tpt_blink {
3807        int throughput;
3808        int blink_time;
3809};
3810
3811/**
3812 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
3813 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
3814 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
3815 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
3816 *      interface is connected in some way, including being an AP
3817 */
3818enum ieee80211_tpt_led_trigger_flags {
3819        IEEE80211_TPT_LEDTRIG_FL_RADIO          = BIT(0),
3820        IEEE80211_TPT_LEDTRIG_FL_WORK           = BIT(1),
3821        IEEE80211_TPT_LEDTRIG_FL_CONNECTED      = BIT(2),
3822};
3823
3824#ifdef CONFIG_MAC80211_LEDS
3825const char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
3826const char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
3827const char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
3828const char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
3829const char *
3830__ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
3831                                   unsigned int flags,
3832                                   const struct ieee80211_tpt_blink *blink_table,
3833                                   unsigned int blink_table_len);
3834#endif
3835/**
3836 * ieee80211_get_tx_led_name - get name of TX LED
3837 *
3838 * mac80211 creates a transmit LED trigger for each wireless hardware
3839 * that can be used to drive LEDs if your driver registers a LED device.
3840 * This function returns the name (or %NULL if not configured for LEDs)
3841 * of the trigger so you can automatically link the LED device.
3842 *
3843 * @hw: the hardware to get the LED trigger name for
3844 *
3845 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3846 */
3847static inline const char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
3848{
3849#ifdef CONFIG_MAC80211_LEDS
3850        return __ieee80211_get_tx_led_name(hw);
3851#else
3852        return NULL;
3853#endif
3854}
3855
3856/**
3857 * ieee80211_get_rx_led_name - get name of RX LED
3858 *
3859 * mac80211 creates a receive LED trigger for each wireless hardware
3860 * that can be used to drive LEDs if your driver registers a LED device.
3861 * This function returns the name (or %NULL if not configured for LEDs)
3862 * of the trigger so you can automatically link the LED device.
3863 *
3864 * @hw: the hardware to get the LED trigger name for
3865 *
3866 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3867 */
3868static inline const char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
3869{
3870#ifdef CONFIG_MAC80211_LEDS
3871        return __ieee80211_get_rx_led_name(hw);
3872#else
3873        return NULL;
3874#endif
3875}
3876
3877/**
3878 * ieee80211_get_assoc_led_name - get name of association LED
3879 *
3880 * mac80211 creates a association LED trigger for each wireless hardware
3881 * that can be used to drive LEDs if your driver registers a LED device.
3882 * This function returns the name (or %NULL if not configured for LEDs)
3883 * of the trigger so you can automatically link the LED device.
3884 *
3885 * @hw: the hardware to get the LED trigger name for
3886 *
3887 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3888 */
3889static inline const char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
3890{
3891#ifdef CONFIG_MAC80211_LEDS
3892        return __ieee80211_get_assoc_led_name(hw);
3893#else
3894        return NULL;
3895#endif
3896}
3897
3898/**
3899 * ieee80211_get_radio_led_name - get name of radio LED
3900 *
3901 * mac80211 creates a radio change LED trigger for each wireless hardware
3902 * that can be used to drive LEDs if your driver registers a LED device.
3903 * This function returns the name (or %NULL if not configured for LEDs)
3904 * of the trigger so you can automatically link the LED device.
3905 *
3906 * @hw: the hardware to get the LED trigger name for
3907 *
3908 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3909 */
3910static inline const char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
3911{
3912#ifdef CONFIG_MAC80211_LEDS
3913        return __ieee80211_get_radio_led_name(hw);
3914#else
3915        return NULL;
3916#endif
3917}
3918
3919/**
3920 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
3921 * @hw: the hardware to create the trigger for
3922 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
3923 * @blink_table: the blink table -- needs to be ordered by throughput
3924 * @blink_table_len: size of the blink table
3925 *
3926 * Return: %NULL (in case of error, or if no LED triggers are
3927 * configured) or the name of the new trigger.
3928 *
3929 * Note: This function must be called before ieee80211_register_hw().
3930 */
3931static inline const char *
3932ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
3933                                 const struct ieee80211_tpt_blink *blink_table,
3934                                 unsigned int blink_table_len)
3935{
3936#ifdef CONFIG_MAC80211_LEDS
3937        return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
3938                                                  blink_table_len);
3939#else
3940        return NULL;
3941#endif
3942}
3943
3944/**
3945 * ieee80211_unregister_hw - Unregister a hardware device
3946 *
3947 * This function instructs mac80211 to free allocated resources
3948 * and unregister netdevices from the networking subsystem.
3949 *
3950 * @hw: the hardware to unregister
3951 */
3952void ieee80211_unregister_hw(struct ieee80211_hw *hw);
3953
3954/**
3955 * ieee80211_free_hw - free hardware descriptor
3956 *
3957 * This function frees everything that was allocated, including the
3958 * private data for the driver. You must call ieee80211_unregister_hw()
3959 * before calling this function.
3960 *
3961 * @hw: the hardware to free
3962 */
3963void ieee80211_free_hw(struct ieee80211_hw *hw);
3964
3965/**
3966 * ieee80211_restart_hw - restart hardware completely
3967 *
3968 * Call this function when the hardware was restarted for some reason
3969 * (hardware error, ...) and the driver is unable to restore its state
3970 * by itself. mac80211 assumes that at this point the driver/hardware
3971 * is completely uninitialised and stopped, it starts the process by
3972 * calling the ->start() operation. The driver will need to reset all
3973 * internal state that it has prior to calling this function.
3974 *
3975 * @hw: the hardware to restart
3976 */
3977void ieee80211_restart_hw(struct ieee80211_hw *hw);
3978
3979/**
3980 * ieee80211_rx_napi - receive frame from NAPI context
3981 *
3982 * Use this function to hand received frames to mac80211. The receive
3983 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3984 * paged @skb is used, the driver is recommended to put the ieee80211
3985 * header of the frame on the linear part of the @skb to avoid memory
3986 * allocation and/or memcpy by the stack.
3987 *
3988 * This function may not be called in IRQ context. Calls to this function
3989 * for a single hardware must be synchronized against each other. Calls to
3990 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3991 * mixed for a single hardware. Must not run concurrently with
3992 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3993 *
3994 * This function must be called with BHs disabled.
3995 *
3996 * @hw: the hardware this frame came in on
3997 * @sta: the station the frame was received from, or %NULL
3998 * @skb: the buffer to receive, owned by mac80211 after this call
3999 * @napi: the NAPI context
4000 */
4001void ieee80211_rx_napi(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
4002                       struct sk_buff *skb, struct napi_struct *napi);
4003
4004/**
4005 * ieee80211_rx - receive frame
4006 *
4007 * Use this function to hand received frames to mac80211. The receive
4008 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4009 * paged @skb is used, the driver is recommended to put the ieee80211
4010 * header of the frame on the linear part of the @skb to avoid memory
4011 * allocation and/or memcpy by the stack.
4012 *
4013 * This function may not be called in IRQ context. Calls to this function
4014 * for a single hardware must be synchronized against each other. Calls to
4015 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4016 * mixed for a single hardware. Must not run concurrently with
4017 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4018 *
4019 * In process context use instead ieee80211_rx_ni().
4020 *
4021 * @hw: the hardware this frame came in on
4022 * @skb: the buffer to receive, owned by mac80211 after this call
4023 */
4024static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb)
4025{
4026        ieee80211_rx_napi(hw, NULL, skb, NULL);
4027}
4028
4029/**
4030 * ieee80211_rx_irqsafe - receive frame
4031 *
4032 * Like ieee80211_rx() but can be called in IRQ context
4033 * (internally defers to a tasklet.)
4034 *
4035 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
4036 * be mixed for a single hardware.Must not run concurrently with
4037 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4038 *
4039 * @hw: the hardware this frame came in on
4040 * @skb: the buffer to receive, owned by mac80211 after this call
4041 */
4042void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
4043
4044/**
4045 * ieee80211_rx_ni - receive frame (in process context)
4046 *
4047 * Like ieee80211_rx() but can be called in process context
4048 * (internally disables bottom halves).
4049 *
4050 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
4051 * not be mixed for a single hardware. Must not run concurrently with
4052 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4053 *
4054 * @hw: the hardware this frame came in on
4055 * @skb: the buffer to receive, owned by mac80211 after this call
4056 */
4057static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
4058                                   struct sk_buff *skb)
4059{
4060        local_bh_disable();
4061        ieee80211_rx(hw, skb);
4062        local_bh_enable();
4063}
4064
4065/**
4066 * ieee80211_sta_ps_transition - PS transition for connected sta
4067 *
4068 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
4069 * flag set, use this function to inform mac80211 about a connected station
4070 * entering/leaving PS mode.
4071 *
4072 * This function may not be called in IRQ context or with softirqs enabled.
4073 *
4074 * Calls to this function for a single hardware must be synchronized against
4075 * each other.
4076 *
4077 * @sta: currently connected sta
4078 * @start: start or stop PS
4079 *
4080 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
4081 */
4082int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
4083
4084/**
4085 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
4086 *                                  (in process context)
4087 *
4088 * Like ieee80211_sta_ps_transition() but can be called in process context
4089 * (internally disables bottom halves). Concurrent call restriction still
4090 * applies.
4091 *
4092 * @sta: currently connected sta
4093 * @start: start or stop PS
4094 *
4095 * Return: Like ieee80211_sta_ps_transition().
4096 */
4097static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
4098                                                  bool start)
4099{
4100        int ret;
4101
4102        local_bh_disable();
4103        ret = ieee80211_sta_ps_transition(sta, start);
4104        local_bh_enable();
4105
4106        return ret;
4107}
4108
4109/**
4110 * ieee80211_sta_pspoll - PS-Poll frame received
4111 * @sta: currently connected station
4112 *
4113 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4114 * use this function to inform mac80211 that a PS-Poll frame from a
4115 * connected station was received.
4116 * This must be used in conjunction with ieee80211_sta_ps_transition()
4117 * and possibly ieee80211_sta_uapsd_trigger(); calls to all three must
4118 * be serialized.
4119 */
4120void ieee80211_sta_pspoll(struct ieee80211_sta *sta);
4121
4122/**
4123 * ieee80211_sta_uapsd_trigger - (potential) U-APSD trigger frame received
4124 * @sta: currently connected station
4125 * @tid: TID of the received (potential) trigger frame
4126 *
4127 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4128 * use this function to inform mac80211 that a (potential) trigger frame
4129 * from a connected station was received.
4130 * This must be used in conjunction with ieee80211_sta_ps_transition()
4131 * and possibly ieee80211_sta_pspoll(); calls to all three must be
4132 * serialized.
4133 * %IEEE80211_NUM_TIDS can be passed as the tid if the tid is unknown.
4134 * In this case, mac80211 will not check that this tid maps to an AC
4135 * that is trigger enabled and assume that the caller did the proper
4136 * checks.
4137 */
4138void ieee80211_sta_uapsd_trigger(struct ieee80211_sta *sta, u8 tid);
4139
4140/*
4141 * The TX headroom reserved by mac80211 for its own tx_status functions.
4142 * This is enough for the radiotap header.
4143 */
4144#define IEEE80211_TX_STATUS_HEADROOM    14
4145
4146/**
4147 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
4148 * @sta: &struct ieee80211_sta pointer for the sleeping station
4149 * @tid: the TID that has buffered frames
4150 * @buffered: indicates whether or not frames are buffered for this TID
4151 *
4152 * If a driver buffers frames for a powersave station instead of passing
4153 * them back to mac80211 for retransmission, the station may still need
4154 * to be told that there are buffered frames via the TIM bit.
4155 *
4156 * This function informs mac80211 whether or not there are frames that are
4157 * buffered in the driver for a given TID; mac80211 can then use this data
4158 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
4159 * call! Beware of the locking!)
4160 *
4161 * If all frames are released to the station (due to PS-poll or uAPSD)
4162 * then the driver needs to inform mac80211 that there no longer are
4163 * frames buffered. However, when the station wakes up mac80211 assumes
4164 * that all buffered frames will be transmitted and clears this data,
4165 * drivers need to make sure they inform mac80211 about all buffered
4166 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
4167 *
4168 * Note that technically mac80211 only needs to know this per AC, not per
4169 * TID, but since driver buffering will inevitably happen per TID (since
4170 * it is related to aggregation) it is easier to make mac80211 map the
4171 * TID to the AC as required instead of keeping track in all drivers that
4172 * use this API.
4173 */
4174void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
4175                                u8 tid, bool buffered);
4176
4177/**
4178 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
4179 *
4180 * Call this function in a driver with per-packet rate selection support
4181 * to combine the rate info in the packet tx info with the most recent
4182 * rate selection table for the station entry.
4183 *
4184 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4185 * @sta: the receiver station to which this packet is sent.
4186 * @skb: the frame to be transmitted.
4187 * @dest: buffer for extracted rate/retry information
4188 * @max_rates: maximum number of rates to fetch
4189 */
4190void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
4191                            struct ieee80211_sta *sta,
4192                            struct sk_buff *skb,
4193                            struct ieee80211_tx_rate *dest,
4194                            int max_rates);
4195
4196/**
4197 * ieee80211_sta_set_expected_throughput - set the expected tpt for a station
4198 *
4199 * Call this function to notify mac80211 about a change in expected throughput
4200 * to a station. A driver for a device that does rate control in firmware can
4201 * call this function when the expected throughput estimate towards a station
4202 * changes. The information is used to tune the CoDel AQM applied to traffic
4203 * going towards that station (which can otherwise be too aggressive and cause
4204 * slow stations to starve).
4205 *
4206 * @pubsta: the station to set throughput for.
4207 * @thr: the current expected throughput in kbps.
4208 */
4209void ieee80211_sta_set_expected_throughput(struct ieee80211_sta *pubsta,
4210                                           u32 thr);
4211
4212/**
4213 * ieee80211_tx_status - transmit status callback
4214 *
4215 * Call this function for all transmitted frames after they have been
4216 * transmitted. It is permissible to not call this function for
4217 * multicast frames but this can affect statistics.
4218 *
4219 * This function may not be called in IRQ context. Calls to this function
4220 * for a single hardware must be synchronized against each other. Calls
4221 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
4222 * may not be mixed for a single hardware. Must not run concurrently with
4223 * ieee80211_rx() or ieee80211_rx_ni().
4224 *
4225 * @hw: the hardware the frame was transmitted by
4226 * @skb: the frame that was transmitted, owned by mac80211 after this call
4227 */
4228void ieee80211_tx_status(struct ieee80211_hw *hw,
4229                         struct sk_buff *skb);
4230
4231/**
4232 * ieee80211_tx_status_ext - extended transmit status callback
4233 *
4234 * This function can be used as a replacement for ieee80211_tx_status
4235 * in drivers that may want to provide extra information that does not
4236 * fit into &struct ieee80211_tx_info.
4237 *
4238 * Calls to this function for a single hardware must be synchronized
4239 * against each other. Calls to this function, ieee80211_tx_status_ni()
4240 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4241 *
4242 * @hw: the hardware the frame was transmitted by
4243 * @status: tx status information
4244 */
4245void ieee80211_tx_status_ext(struct ieee80211_hw *hw,
4246                             struct ieee80211_tx_status *status);
4247
4248/**
4249 * ieee80211_tx_status_noskb - transmit status callback without skb
4250 *
4251 * This function can be used as a replacement for ieee80211_tx_status
4252 * in drivers that cannot reliably map tx status information back to
4253 * specific skbs.
4254 *
4255 * Calls to this function for a single hardware must be synchronized
4256 * against each other. Calls to this function, ieee80211_tx_status_ni()
4257 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4258 *
4259 * @hw: the hardware the frame was transmitted by
4260 * @sta: the receiver station to which this packet is sent
4261 *      (NULL for multicast packets)
4262 * @info: tx status information
4263 */
4264static inline void ieee80211_tx_status_noskb(struct ieee80211_hw *hw,
4265                                             struct ieee80211_sta *sta,
4266                                             struct ieee80211_tx_info *info)
4267{
4268        struct ieee80211_tx_status status = {
4269                .sta = sta,
4270                .info = info,
4271        };
4272
4273        ieee80211_tx_status_ext(hw, &status);
4274}
4275
4276/**
4277 * ieee80211_tx_status_ni - transmit status callback (in process context)
4278 *
4279 * Like ieee80211_tx_status() but can be called in process context.
4280 *
4281 * Calls to this function, ieee80211_tx_status() and
4282 * ieee80211_tx_status_irqsafe() may not be mixed
4283 * for a single hardware.
4284 *
4285 * @hw: the hardware the frame was transmitted by
4286 * @skb: the frame that was transmitted, owned by mac80211 after this call
4287 */
4288static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
4289                                          struct sk_buff *skb)
4290{
4291        local_bh_disable();
4292        ieee80211_tx_status(hw, skb);
4293        local_bh_enable();
4294}
4295
4296/**
4297 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
4298 *
4299 * Like ieee80211_tx_status() but can be called in IRQ context
4300 * (internally defers to a tasklet.)
4301 *
4302 * Calls to this function, ieee80211_tx_status() and
4303 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
4304 *
4305 * @hw: the hardware the frame was transmitted by
4306 * @skb: the frame that was transmitted, owned by mac80211 after this call
4307 */
4308void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
4309                                 struct sk_buff *skb);
4310
4311/**
4312 * ieee80211_report_low_ack - report non-responding station
4313 *
4314 * When operating in AP-mode, call this function to report a non-responding
4315 * connected STA.
4316 *
4317 * @sta: the non-responding connected sta
4318 * @num_packets: number of packets sent to @sta without a response
4319 */
4320void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
4321
4322#define IEEE80211_MAX_CSA_COUNTERS_NUM 2
4323
4324/**
4325 * struct ieee80211_mutable_offsets - mutable beacon offsets
4326 * @tim_offset: position of TIM element
4327 * @tim_length: size of TIM element
4328 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets
4329 *      to CSA counters.  This array can contain zero values which
4330 *      should be ignored.
4331 */
4332struct ieee80211_mutable_offsets {
4333        u16 tim_offset;
4334        u16 tim_length;
4335
4336        u16 csa_counter_offs[IEEE80211_MAX_CSA_COUNTERS_NUM];
4337};
4338
4339/**
4340 * ieee80211_beacon_get_template - beacon template generation function
4341 * @hw: pointer obtained from ieee80211_alloc_hw().
4342 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4343 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
4344 *      receive the offsets that may be updated by the driver.
4345 *
4346 * If the driver implements beaconing modes, it must use this function to
4347 * obtain the beacon template.
4348 *
4349 * This function should be used if the beacon frames are generated by the
4350 * device, and then the driver must use the returned beacon as the template
4351 * The driver or the device are responsible to update the DTIM and, when
4352 * applicable, the CSA count.
4353 *
4354 * The driver is responsible for freeing the returned skb.
4355 *
4356 * Return: The beacon template. %NULL on error.
4357 */
4358struct sk_buff *
4359ieee80211_beacon_get_template(struct ieee80211_hw *hw,
4360                              struct ieee80211_vif *vif,
4361                              struct ieee80211_mutable_offsets *offs);
4362
4363/**
4364 * ieee80211_beacon_get_tim - beacon generation function
4365 * @hw: pointer obtained from ieee80211_alloc_hw().
4366 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4367 * @tim_offset: pointer to variable that will receive the TIM IE offset.
4368 *      Set to 0 if invalid (in non-AP modes).
4369 * @tim_length: pointer to variable that will receive the TIM IE length,
4370 *      (including the ID and length bytes!).
4371 *      Set to 0 if invalid (in non-AP modes).
4372 *
4373 * If the driver implements beaconing modes, it must use this function to
4374 * obtain the beacon frame.
4375 *
4376 * If the beacon frames are generated by the host system (i.e., not in
4377 * hardware/firmware), the driver uses this function to get each beacon
4378 * frame from mac80211 -- it is responsible for calling this function exactly
4379 * once before the beacon is needed (e.g. based on hardware interrupt).
4380 *
4381 * The driver is responsible for freeing the returned skb.
4382 *
4383 * Return: The beacon template. %NULL on error.
4384 */
4385struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
4386                                         struct ieee80211_vif *vif,
4387                                         u16 *tim_offset, u16 *tim_length);
4388
4389/**
4390 * ieee80211_beacon_get - beacon generation function
4391 * @hw: pointer obtained from ieee80211_alloc_hw().
4392 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4393 *
4394 * See ieee80211_beacon_get_tim().
4395 *
4396 * Return: See ieee80211_beacon_get_tim().
4397 */
4398static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
4399                                                   struct ieee80211_vif *vif)
4400{
4401        return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
4402}
4403
4404/**
4405 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter
4406 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4407 *
4408 * The csa counter should be updated after each beacon transmission.
4409 * This function is called implicitly when
4410 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
4411 * beacon frames are generated by the device, the driver should call this
4412 * function after each beacon transmission to sync mac80211's csa counters.
4413 *
4414 * Return: new csa counter value
4415 */
4416u8 ieee80211_csa_update_counter(struct ieee80211_vif *vif);
4417
4418/**
4419 * ieee80211_csa_finish - notify mac80211 about channel switch
4420 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4421 *
4422 * After a channel switch announcement was scheduled and the counter in this
4423 * announcement hits 1, this function must be called by the driver to
4424 * notify mac80211 that the channel can be changed.
4425 */
4426void ieee80211_csa_finish(struct ieee80211_vif *vif);
4427
4428/**
4429 * ieee80211_csa_is_complete - find out if counters reached 1
4430 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4431 *
4432 * This function returns whether the channel switch counters reached zero.
4433 */
4434bool ieee80211_csa_is_complete(struct ieee80211_vif *vif);
4435
4436
4437/**
4438 * ieee80211_proberesp_get - retrieve a Probe Response template
4439 * @hw: pointer obtained from ieee80211_alloc_hw().
4440 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4441 *
4442 * Creates a Probe Response template which can, for example, be uploaded to
4443 * hardware. The destination address should be set by the caller.
4444 *
4445 * Can only be called in AP mode.
4446 *
4447 * Return: The Probe Response template. %NULL on error.
4448 */
4449struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
4450                                        struct ieee80211_vif *vif);
4451
4452/**
4453 * ieee80211_pspoll_get - retrieve a PS Poll template
4454 * @hw: pointer obtained from ieee80211_alloc_hw().
4455 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4456 *
4457 * Creates a PS Poll a template which can, for example, uploaded to
4458 * hardware. The template must be updated after association so that correct
4459 * AID, BSSID and MAC address is used.
4460 *
4461 * Note: Caller (or hardware) is responsible for setting the
4462 * &IEEE80211_FCTL_PM bit.
4463 *
4464 * Return: The PS Poll template. %NULL on error.
4465 */
4466struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
4467                                     struct ieee80211_vif *vif);
4468
4469/**
4470 * ieee80211_nullfunc_get - retrieve a nullfunc template
4471 * @hw: pointer obtained from ieee80211_alloc_hw().
4472 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4473 *
4474 * Creates a Nullfunc template which can, for example, uploaded to
4475 * hardware. The template must be updated after association so that correct
4476 * BSSID and address is used.
4477 *
4478 * Note: Caller (or hardware) is responsible for setting the
4479 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
4480 *
4481 * Return: The nullfunc template. %NULL on error.
4482 */
4483struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
4484                                       struct ieee80211_vif *vif);
4485
4486/**
4487 * ieee80211_probereq_get - retrieve a Probe Request template
4488 * @hw: pointer obtained from ieee80211_alloc_hw().
4489 * @src_addr: source MAC address
4490 * @ssid: SSID buffer
4491 * @ssid_len: length of SSID
4492 * @tailroom: tailroom to reserve at end of SKB for IEs
4493 *
4494 * Creates a Probe Request template which can, for example, be uploaded to
4495 * hardware.
4496 *
4497 * Return: The Probe Request template. %NULL on error.
4498 */
4499struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
4500                                       const u8 *src_addr,
4501                                       const u8 *ssid, size_t ssid_len,
4502                                       size_t tailroom);
4503
4504/**
4505 * ieee80211_rts_get - RTS frame generation function
4506 * @hw: pointer obtained from ieee80211_alloc_hw().
4507 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4508 * @frame: pointer to the frame that is going to be protected by the RTS.
4509 * @frame_len: the frame length (in octets).
4510 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4511 * @rts: The buffer where to store the RTS frame.
4512 *
4513 * If the RTS frames are generated by the host system (i.e., not in
4514 * hardware/firmware), the low-level driver uses this function to receive
4515 * the next RTS frame from the 802.11 code. The low-level is responsible
4516 * for calling this function before and RTS frame is needed.
4517 */
4518void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4519                       const void *frame, size_t frame_len,
4520                       const struct ieee80211_tx_info *frame_txctl,
4521                       struct ieee80211_rts *rts);
4522
4523/**
4524 * ieee80211_rts_duration - Get the duration field for an RTS frame
4525 * @hw: pointer obtained from ieee80211_alloc_hw().
4526 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4527 * @frame_len: the length of the frame that is going to be protected by the RTS.
4528 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4529 *
4530 * If the RTS is generated in firmware, but the host system must provide
4531 * the duration field, the low-level driver uses this function to receive
4532 * the duration field value in little-endian byteorder.
4533 *
4534 * Return: The duration.
4535 */
4536__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
4537                              struct ieee80211_vif *vif, size_t frame_len,
4538                              const struct ieee80211_tx_info *frame_txctl);
4539
4540/**
4541 * ieee80211_ctstoself_get - CTS-to-self frame generation function
4542 * @hw: pointer obtained from ieee80211_alloc_hw().
4543 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4544 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
4545 * @frame_len: the frame length (in octets).
4546 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4547 * @cts: The buffer where to store the CTS-to-self frame.
4548 *
4549 * If the CTS-to-self frames are generated by the host system (i.e., not in
4550 * hardware/firmware), the low-level driver uses this function to receive
4551 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
4552 * for calling this function before and CTS-to-self frame is needed.
4553 */
4554void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
4555                             struct ieee80211_vif *vif,
4556                             const void *frame, size_t frame_len,
4557                             const struct ieee80211_tx_info *frame_txctl,
4558                             struct ieee80211_cts *cts);
4559
4560/**
4561 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
4562 * @hw: pointer obtained from ieee80211_alloc_hw().
4563 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4564 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
4565 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4566 *
4567 * If the CTS-to-self is generated in firmware, but the host system must provide
4568 * the duration field, the low-level driver uses this function to receive
4569 * the duration field value in little-endian byteorder.
4570 *
4571 * Return: The duration.
4572 */
4573__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
4574                                    struct ieee80211_vif *vif,
4575                                    size_t frame_len,
4576                                    const struct ieee80211_tx_info *frame_txctl);
4577
4578/**
4579 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
4580 * @hw: pointer obtained from ieee80211_alloc_hw().
4581 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4582 * @band: the band to calculate the frame duration on
4583 * @frame_len: the length of the frame.
4584 * @rate: the rate at which the frame is going to be transmitted.
4585 *
4586 * Calculate the duration field of some generic frame, given its
4587 * length and transmission rate (in 100kbps).
4588 *
4589 * Return: The duration.
4590 */
4591__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
4592                                        struct ieee80211_vif *vif,
4593                                        enum nl80211_band band,
4594                                        size_t frame_len,
4595                                        struct ieee80211_rate *rate);
4596
4597/**
4598 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
4599 * @hw: pointer as obtained from ieee80211_alloc_hw().
4600 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4601 *
4602 * Function for accessing buffered broadcast and multicast frames. If
4603 * hardware/firmware does not implement buffering of broadcast/multicast
4604 * frames when power saving is used, 802.11 code buffers them in the host
4605 * memory. The low-level driver uses this function to fetch next buffered
4606 * frame. In most cases, this is used when generating beacon frame.
4607 *
4608 * Return: A pointer to the next buffered skb or NULL if no more buffered
4609 * frames are available.
4610 *
4611 * Note: buffered frames are returned only after DTIM beacon frame was
4612 * generated with ieee80211_beacon_get() and the low-level driver must thus
4613 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
4614 * NULL if the previous generated beacon was not DTIM, so the low-level driver
4615 * does not need to check for DTIM beacons separately and should be able to
4616 * use common code for all beacons.
4617 */
4618struct sk_buff *
4619ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4620
4621/**
4622 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
4623 *
4624 * This function returns the TKIP phase 1 key for the given IV32.
4625 *
4626 * @keyconf: the parameter passed with the set key
4627 * @iv32: IV32 to get the P1K for
4628 * @p1k: a buffer to which the key will be written, as 5 u16 values
4629 */
4630void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
4631                               u32 iv32, u16 *p1k);
4632
4633/**
4634 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
4635 *
4636 * This function returns the TKIP phase 1 key for the IV32 taken
4637 * from the given packet.
4638 *
4639 * @keyconf: the parameter passed with the set key
4640 * @skb: the packet to take the IV32 value from that will be encrypted
4641 *      with this P1K
4642 * @p1k: a buffer to which the key will be written, as 5 u16 values
4643 */
4644static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
4645                                          struct sk_buff *skb, u16 *p1k)
4646{
4647        struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
4648        const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
4649        u32 iv32 = get_unaligned_le32(&data[4]);
4650
4651        ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
4652}
4653
4654/**
4655 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
4656 *
4657 * This function returns the TKIP phase 1 key for the given IV32
4658 * and transmitter address.
4659 *
4660 * @keyconf: the parameter passed with the set key
4661 * @ta: TA that will be used with the key
4662 * @iv32: IV32 to get the P1K for
4663 * @p1k: a buffer to which the key will be written, as 5 u16 values
4664 */
4665void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
4666                               const u8 *ta, u32 iv32, u16 *p1k);
4667
4668/**
4669 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
4670 *
4671 * This function computes the TKIP RC4 key for the IV values
4672 * in the packet.
4673 *
4674 * @keyconf: the parameter passed with the set key
4675 * @skb: the packet to take the IV32/IV16 values from that will be
4676 *      encrypted with this key
4677 * @p2k: a buffer to which the key will be written, 16 bytes
4678 */
4679void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
4680                            struct sk_buff *skb, u8 *p2k);
4681
4682/**
4683 * ieee80211_tkip_add_iv - write TKIP IV and Ext. IV to pos
4684 *
4685 * @pos: start of crypto header
4686 * @keyconf: the parameter passed with the set key
4687 * @pn: PN to add
4688 *
4689 * Returns: pointer to the octet following IVs (i.e. beginning of
4690 * the packet payload)
4691 *
4692 * This function writes the tkip IV value to pos (which should
4693 * point to the crypto header)
4694 */
4695u8 *ieee80211_tkip_add_iv(u8 *pos, struct ieee80211_key_conf *keyconf, u64 pn);
4696
4697/**
4698 * ieee80211_get_key_rx_seq - get key RX sequence counter
4699 *
4700 * @keyconf: the parameter passed with the set key
4701 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4702 *      the value on TID 0 is also used for non-QoS frames. For
4703 *      CMAC, only TID 0 is valid.
4704 * @seq: buffer to receive the sequence data
4705 *
4706 * This function allows a driver to retrieve the current RX IV/PNs
4707 * for the given key. It must not be called if IV checking is done
4708 * by the device and not by mac80211.
4709 *
4710 * Note that this function may only be called when no RX processing
4711 * can be done concurrently.
4712 */
4713void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
4714                              int tid, struct ieee80211_key_seq *seq);
4715
4716/**
4717 * ieee80211_set_key_rx_seq - set key RX sequence counter
4718 *
4719 * @keyconf: the parameter passed with the set key
4720 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4721 *      the value on TID 0 is also used for non-QoS frames. For
4722 *      CMAC, only TID 0 is valid.
4723 * @seq: new sequence data
4724 *
4725 * This function allows a driver to set the current RX IV/PNs for the
4726 * given key. This is useful when resuming from WoWLAN sleep and GTK
4727 * rekey may have been done while suspended. It should not be called
4728 * if IV checking is done by the device and not by mac80211.
4729 *
4730 * Note that this function may only be called when no RX processing
4731 * can be done concurrently.
4732 */
4733void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
4734                              int tid, struct ieee80211_key_seq *seq);
4735
4736/**
4737 * ieee80211_remove_key - remove the given key
4738 * @keyconf: the parameter passed with the set key
4739 *
4740 * Remove the given key. If the key was uploaded to the hardware at the
4741 * time this function is called, it is not deleted in the hardware but
4742 * instead assumed to have been removed already.
4743 *
4744 * Note that due to locking considerations this function can (currently)
4745 * only be called during key iteration (ieee80211_iter_keys().)
4746 */
4747void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
4748
4749/**
4750 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
4751 * @vif: the virtual interface to add the key on
4752 * @keyconf: new key data
4753 *
4754 * When GTK rekeying was done while the system was suspended, (a) new
4755 * key(s) will be available. These will be needed by mac80211 for proper
4756 * RX processing, so this function allows setting them.
4757 *
4758 * The function returns the newly allocated key structure, which will
4759 * have similar contents to the passed key configuration but point to
4760 * mac80211-owned memory. In case of errors, the function returns an
4761 * ERR_PTR(), use IS_ERR() etc.
4762 *
4763 * Note that this function assumes the key isn't added to hardware
4764 * acceleration, so no TX will be done with the key. Since it's a GTK
4765 * on managed (station) networks, this is true anyway. If the driver
4766 * calls this function from the resume callback and subsequently uses
4767 * the return code 1 to reconfigure the device, this key will be part
4768 * of the reconfiguration.
4769 *
4770 * Note that the driver should also call ieee80211_set_key_rx_seq()
4771 * for the new key for each TID to set up sequence counters properly.
4772 *
4773 * IMPORTANT: If this replaces a key that is present in the hardware,
4774 * then it will attempt to remove it during this call. In many cases
4775 * this isn't what you want, so call ieee80211_remove_key() first for
4776 * the key that's being replaced.
4777 */
4778struct ieee80211_key_conf *
4779ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
4780                        struct ieee80211_key_conf *keyconf);
4781
4782/**
4783 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
4784 * @vif: virtual interface the rekeying was done on
4785 * @bssid: The BSSID of the AP, for checking association
4786 * @replay_ctr: the new replay counter after GTK rekeying
4787 * @gfp: allocation flags
4788 */
4789void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
4790                                const u8 *replay_ctr, gfp_t gfp);
4791
4792/**
4793 * ieee80211_wake_queue - wake specific queue
4794 * @hw: pointer as obtained from ieee80211_alloc_hw().
4795 * @queue: queue number (counted from zero).
4796 *
4797 * Drivers should use this function instead of netif_wake_queue.
4798 */
4799void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
4800
4801/**
4802 * ieee80211_stop_queue - stop specific queue
4803 * @hw: pointer as obtained from ieee80211_alloc_hw().
4804 * @queue: queue number (counted from zero).
4805 *
4806 * Drivers should use this function instead of netif_stop_queue.
4807 */
4808void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
4809
4810/**
4811 * ieee80211_queue_stopped - test status of the queue
4812 * @hw: pointer as obtained from ieee80211_alloc_hw().
4813 * @queue: queue number (counted from zero).
4814 *
4815 * Drivers should use this function instead of netif_stop_queue.
4816 *
4817 * Return: %true if the queue is stopped. %false otherwise.
4818 */
4819
4820int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
4821
4822/**
4823 * ieee80211_stop_queues - stop all queues
4824 * @hw: pointer as obtained from ieee80211_alloc_hw().
4825 *
4826 * Drivers should use this function instead of netif_stop_queue.
4827 */
4828void ieee80211_stop_queues(struct ieee80211_hw *hw);
4829
4830/**
4831 * ieee80211_wake_queues - wake all queues
4832 * @hw: pointer as obtained from ieee80211_alloc_hw().
4833 *
4834 * Drivers should use this function instead of netif_wake_queue.
4835 */
4836void ieee80211_wake_queues(struct ieee80211_hw *hw);
4837
4838/**
4839 * ieee80211_scan_completed - completed hardware scan
4840 *
4841 * When hardware scan offload is used (i.e. the hw_scan() callback is
4842 * assigned) this function needs to be called by the driver to notify
4843 * mac80211 that the scan finished. This function can be called from
4844 * any context, including hardirq context.
4845 *
4846 * @hw: the hardware that finished the scan
4847 * @info: information about the completed scan
4848 */
4849void ieee80211_scan_completed(struct ieee80211_hw *hw,
4850                              struct cfg80211_scan_info *info);
4851
4852/**
4853 * ieee80211_sched_scan_results - got results from scheduled scan
4854 *
4855 * When a scheduled scan is running, this function needs to be called by the
4856 * driver whenever there are new scan results available.
4857 *
4858 * @hw: the hardware that is performing scheduled scans
4859 */
4860void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
4861
4862/**
4863 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
4864 *
4865 * When a scheduled scan is running, this function can be called by
4866 * the driver if it needs to stop the scan to perform another task.
4867 * Usual scenarios are drivers that cannot continue the scheduled scan
4868 * while associating, for instance.
4869 *
4870 * @hw: the hardware that is performing scheduled scans
4871 */
4872void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
4873
4874/**
4875 * enum ieee80211_interface_iteration_flags - interface iteration flags
4876 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
4877 *      been added to the driver; However, note that during hardware
4878 *      reconfiguration (after restart_hw) it will iterate over a new
4879 *      interface and over all the existing interfaces even if they
4880 *      haven't been re-added to the driver yet.
4881 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
4882 *      interfaces, even if they haven't been re-added to the driver yet.
4883 * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up).
4884 */
4885enum ieee80211_interface_iteration_flags {
4886        IEEE80211_IFACE_ITER_NORMAL     = 0,
4887        IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
4888        IEEE80211_IFACE_ITER_ACTIVE     = BIT(1),
4889};
4890
4891/**
4892 * ieee80211_iterate_interfaces - iterate interfaces
4893 *
4894 * This function iterates over the interfaces associated with a given
4895 * hardware and calls the callback for them. This includes active as well as
4896 * inactive interfaces. This function allows the iterator function to sleep.
4897 * Will iterate over a new interface during add_interface().
4898 *
4899 * @hw: the hardware struct of which the interfaces should be iterated over
4900 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4901 * @iterator: the iterator function to call
4902 * @data: first argument of the iterator function
4903 */
4904void ieee80211_iterate_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4905                                  void (*iterator)(void *data, u8 *mac,
4906                                                   struct ieee80211_vif *vif),
4907                                  void *data);
4908
4909/**
4910 * ieee80211_iterate_active_interfaces - iterate active interfaces
4911 *
4912 * This function iterates over the interfaces associated with a given
4913 * hardware that are currently active and calls the callback for them.
4914 * This function allows the iterator function to sleep, when the iterator
4915 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
4916 * be used.
4917 * Does not iterate over a new interface during add_interface().
4918 *
4919 * @hw: the hardware struct of which the interfaces should be iterated over
4920 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4921 * @iterator: the iterator function to call
4922 * @data: first argument of the iterator function
4923 */
4924static inline void
4925ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4926                                    void (*iterator)(void *data, u8 *mac,
4927                                                     struct ieee80211_vif *vif),
4928                                    void *data)
4929{
4930        ieee80211_iterate_interfaces(hw,
4931                                     iter_flags | IEEE80211_IFACE_ITER_ACTIVE,
4932                                     iterator, data);
4933}
4934
4935/**
4936 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
4937 *
4938 * This function iterates over the interfaces associated with a given
4939 * hardware that are currently active and calls the callback for them.
4940 * This function requires the iterator callback function to be atomic,
4941 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
4942 * Does not iterate over a new interface during add_interface().
4943 *
4944 * @hw: the hardware struct of which the interfaces should be iterated over
4945 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4946 * @iterator: the iterator function to call, cannot sleep
4947 * @data: first argument of the iterator function
4948 */
4949void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
4950                                                u32 iter_flags,
4951                                                void (*iterator)(void *data,
4952                                                    u8 *mac,
4953                                                    struct ieee80211_vif *vif),
4954                                                void *data);
4955
4956/**
4957 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
4958 *
4959 * This function iterates over the interfaces associated with a given
4960 * hardware that are currently active and calls the callback for them.
4961 * This version can only be used while holding the RTNL.
4962 *
4963 * @hw: the hardware struct of which the interfaces should be iterated over
4964 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4965 * @iterator: the iterator function to call, cannot sleep
4966 * @data: first argument of the iterator function
4967 */
4968void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw,
4969                                              u32 iter_flags,
4970                                              void (*iterator)(void *data,
4971                                                u8 *mac,
4972                                                struct ieee80211_vif *vif),
4973                                              void *data);
4974
4975/**
4976 * ieee80211_iterate_stations_atomic - iterate stations
4977 *
4978 * This function iterates over all stations associated with a given
4979 * hardware that are currently uploaded to the driver and calls the callback
4980 * function for them.
4981 * This function requires the iterator callback function to be atomic,
4982 *
4983 * @hw: the hardware struct of which the interfaces should be iterated over
4984 * @iterator: the iterator function to call, cannot sleep
4985 * @data: first argument of the iterator function
4986 */
4987void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw,
4988                                       void (*iterator)(void *data,
4989                                                struct ieee80211_sta *sta),
4990                                       void *data);
4991/**
4992 * ieee80211_queue_work - add work onto the mac80211 workqueue
4993 *
4994 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
4995 * This helper ensures drivers are not queueing work when they should not be.
4996 *
4997 * @hw: the hardware struct for the interface we are adding work for
4998 * @work: the work we want to add onto the mac80211 workqueue
4999 */
5000void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
5001
5002/**
5003 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
5004 *
5005 * Drivers and mac80211 use this to queue delayed work onto the mac80211
5006 * workqueue.
5007 *
5008 * @hw: the hardware struct for the interface we are adding work for
5009 * @dwork: delayable work to queue onto the mac80211 workqueue
5010 * @delay: number of jiffies to wait before queueing
5011 */
5012void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
5013                                  struct delayed_work *dwork,
5014                                  unsigned long delay);
5015
5016/**
5017 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
5018 * @sta: the station for which to start a BA session
5019 * @tid: the TID to BA on.
5020 * @timeout: session timeout value (in TUs)
5021 *
5022 * Return: success if addBA request was sent, failure otherwise
5023 *
5024 * Although mac80211/low level driver/user space application can estimate
5025 * the need to start aggregation on a certain RA/TID, the session level
5026 * will be managed by the mac80211.
5027 */
5028int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
5029                                  u16 timeout);
5030
5031/**
5032 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
5033 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5034 * @ra: receiver address of the BA session recipient.
5035 * @tid: the TID to BA on.
5036 *
5037 * This function must be called by low level driver once it has
5038 * finished with preparations for the BA session. It can be called
5039 * from any context.
5040 */
5041void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
5042                                      u16 tid);
5043
5044/**
5045 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
5046 * @sta: the station whose BA session to stop
5047 * @tid: the TID to stop BA.
5048 *
5049 * Return: negative error if the TID is invalid, or no aggregation active
5050 *
5051 * Although mac80211/low level driver/user space application can estimate
5052 * the need to stop aggregation on a certain RA/TID, the session level
5053 * will be managed by the mac80211.
5054 */
5055int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
5056
5057/**
5058 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
5059 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5060 * @ra: receiver address of the BA session recipient.
5061 * @tid: the desired TID to BA on.
5062 *
5063 * This function must be called by low level driver once it has
5064 * finished with preparations for the BA session tear down. It
5065 * can be called from any context.
5066 */
5067void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
5068                                     u16 tid);
5069
5070/**
5071 * ieee80211_find_sta - find a station
5072 *
5073 * @vif: virtual interface to look for station on
5074 * @addr: station's address
5075 *
5076 * Return: The station, if found. %NULL otherwise.
5077 *
5078 * Note: This function must be called under RCU lock and the
5079 * resulting pointer is only valid under RCU lock as well.
5080 */
5081struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
5082                                         const u8 *addr);
5083
5084/**
5085 * ieee80211_find_sta_by_ifaddr - find a station on hardware
5086 *
5087 * @hw: pointer as obtained from ieee80211_alloc_hw()
5088 * @addr: remote station's address
5089 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
5090 *
5091 * Return: The station, if found. %NULL otherwise.
5092 *
5093 * Note: This function must be called under RCU lock and the
5094 * resulting pointer is only valid under RCU lock as well.
5095 *
5096 * NOTE: You may pass NULL for localaddr, but then you will just get
5097 *      the first STA that matches the remote address 'addr'.
5098 *      We can have multiple STA associated with multiple
5099 *      logical stations (e.g. consider a station connecting to another
5100 *      BSSID on the same AP hardware without disconnecting first).
5101 *      In this case, the result of this method with localaddr NULL
5102 *      is not reliable.
5103 *
5104 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
5105 */
5106struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
5107                                               const u8 *addr,
5108                                               const u8 *localaddr);
5109
5110/**
5111 * ieee80211_sta_block_awake - block station from waking up
5112 * @hw: the hardware
5113 * @pubsta: the station
5114 * @block: whether to block or unblock
5115 *
5116 * Some devices require that all frames that are on the queues
5117 * for a specific station that went to sleep are flushed before
5118 * a poll response or frames after the station woke up can be
5119 * delivered to that it. Note that such frames must be rejected
5120 * by the driver as filtered, with the appropriate status flag.
5121 *
5122 * This function allows implementing this mode in a race-free
5123 * manner.
5124 *
5125 * To do this, a driver must keep track of the number of frames
5126 * still enqueued for a specific station. If this number is not
5127 * zero when the station goes to sleep, the driver must call
5128 * this function to force mac80211 to consider the station to
5129 * be asleep regardless of the station's actual state. Once the
5130 * number of outstanding frames reaches zero, the driver must
5131 * call this function again to unblock the station. That will
5132 * cause mac80211 to be able to send ps-poll responses, and if
5133 * the station queried in the meantime then frames will also
5134 * be sent out as a result of this. Additionally, the driver
5135 * will be notified that the station woke up some time after
5136 * it is unblocked, regardless of whether the station actually
5137 * woke up while blocked or not.
5138 */
5139void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
5140                               struct ieee80211_sta *pubsta, bool block);
5141
5142/**
5143 * ieee80211_sta_eosp - notify mac80211 about end of SP
5144 * @pubsta: the station
5145 *
5146 * When a device transmits frames in a way that it can't tell
5147 * mac80211 in the TX status about the EOSP, it must clear the
5148 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
5149 * This applies for PS-Poll as well as uAPSD.
5150 *
5151 * Note that just like with _tx_status() and _rx() drivers must
5152 * not mix calls to irqsafe/non-irqsafe versions, this function
5153 * must not be mixed with those either. Use the all irqsafe, or
5154 * all non-irqsafe, don't mix!
5155 *
5156 * NB: the _irqsafe version of this function doesn't exist, no
5157 *     driver needs it right now. Don't call this function if
5158 *     you'd need the _irqsafe version, look at the git history
5159 *     and restore the _irqsafe version!
5160 */
5161void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
5162
5163/**
5164 * ieee80211_send_eosp_nullfunc - ask mac80211 to send NDP with EOSP
5165 * @pubsta: the station
5166 * @tid: the tid of the NDP
5167 *
5168 * Sometimes the device understands that it needs to close
5169 * the Service Period unexpectedly. This can happen when
5170 * sending frames that are filling holes in the BA window.
5171 * In this case, the device can ask mac80211 to send a
5172 * Nullfunc frame with EOSP set. When that happens, the
5173 * driver must have called ieee80211_sta_set_buffered() to
5174 * let mac80211 know that there are no buffered frames any
5175 * more, otherwise mac80211 will get the more_data bit wrong.
5176 * The low level driver must have made sure that the frame
5177 * will be sent despite the station being in power-save.
5178 * Mac80211 won't call allow_buffered_frames().
5179 * Note that calling this function, doesn't exempt the driver
5180 * from closing the EOSP properly, it will still have to call
5181 * ieee80211_sta_eosp when the NDP is sent.
5182 */
5183void ieee80211_send_eosp_nullfunc(struct ieee80211_sta *pubsta, int tid);
5184
5185/**
5186 * ieee80211_iter_keys - iterate keys programmed into the device
5187 * @hw: pointer obtained from ieee80211_alloc_hw()
5188 * @vif: virtual interface to iterate, may be %NULL for all
5189 * @iter: iterator function that will be called for each key
5190 * @iter_data: custom data to pass to the iterator function
5191 *
5192 * This function can be used to iterate all the keys known to
5193 * mac80211, even those that weren't previously programmed into
5194 * the device. This is intended for use in WoWLAN if the device
5195 * needs reprogramming of the keys during suspend. Note that due
5196 * to locking reasons, it is also only safe to call this at few
5197 * spots since it must hold the RTNL and be able to sleep.
5198 *
5199 * The order in which the keys are iterated matches the order
5200 * in which they were originally installed and handed to the
5201 * set_key callback.
5202 */
5203void ieee80211_iter_keys(struct ieee80211_hw *hw,
5204                         struct ieee80211_vif *vif,
5205                         void (*iter)(struct ieee80211_hw *hw,
5206                                      struct ieee80211_vif *vif,
5207                                      struct ieee80211_sta *sta,
5208                                      struct ieee80211_key_conf *key,
5209                                      void *data),
5210                         void *iter_data);
5211
5212/**
5213 * ieee80211_iter_keys_rcu - iterate keys programmed into the device
5214 * @hw: pointer obtained from ieee80211_alloc_hw()
5215 * @vif: virtual interface to iterate, may be %NULL for all
5216 * @iter: iterator function that will be called for each key
5217 * @iter_data: custom data to pass to the iterator function
5218 *
5219 * This function can be used to iterate all the keys known to
5220 * mac80211, even those that weren't previously programmed into
5221 * the device. Note that due to locking reasons, keys of station
5222 * in removal process will be skipped.
5223 *
5224 * This function requires being called in an RCU critical section,
5225 * and thus iter must be atomic.
5226 */
5227void ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
5228                             struct ieee80211_vif *vif,
5229                             void (*iter)(struct ieee80211_hw *hw,
5230                                          struct ieee80211_vif *vif,
5231                                          struct ieee80211_sta *sta,
5232                                          struct ieee80211_key_conf *key,
5233                                          void *data),
5234                             void *iter_data);
5235
5236/**
5237 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
5238 * @hw: pointre obtained from ieee80211_alloc_hw().
5239 * @iter: iterator function
5240 * @iter_data: data passed to iterator function
5241 *
5242 * Iterate all active channel contexts. This function is atomic and
5243 * doesn't acquire any locks internally that might be held in other
5244 * places while calling into the driver.
5245 *
5246 * The iterator will not find a context that's being added (during
5247 * the driver callback to add it) but will find it while it's being
5248 * removed.
5249 *
5250 * Note that during hardware restart, all contexts that existed
5251 * before the restart are considered already present so will be
5252 * found while iterating, whether they've been re-added already
5253 * or not.
5254 */
5255void ieee80211_iter_chan_contexts_atomic(
5256        struct ieee80211_hw *hw,
5257        void (*iter)(struct ieee80211_hw *hw,
5258                     struct ieee80211_chanctx_conf *chanctx_conf,
5259                     void *data),
5260        void *iter_data);
5261
5262/**
5263 * ieee80211_ap_probereq_get - retrieve a Probe Request template
5264 * @hw: pointer obtained from ieee80211_alloc_hw().
5265 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5266 *
5267 * Creates a Probe Request template which can, for example, be uploaded to
5268 * hardware. The template is filled with bssid, ssid and supported rate
5269 * information. This function must only be called from within the
5270 * .bss_info_changed callback function and only in managed mode. The function
5271 * is only useful when the interface is associated, otherwise it will return
5272 * %NULL.
5273 *
5274 * Return: The Probe Request template. %NULL on error.
5275 */
5276struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
5277                                          struct ieee80211_vif *vif);
5278
5279/**
5280 * ieee80211_beacon_loss - inform hardware does not receive beacons
5281 *
5282 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5283 *
5284 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
5285 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
5286 * hardware is not receiving beacons with this function.
5287 */
5288void ieee80211_beacon_loss(struct ieee80211_vif *vif);
5289
5290/**
5291 * ieee80211_connection_loss - inform hardware has lost connection to the AP
5292 *
5293 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5294 *
5295 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
5296 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
5297 * needs to inform if the connection to the AP has been lost.
5298 * The function may also be called if the connection needs to be terminated
5299 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
5300 *
5301 * This function will cause immediate change to disassociated state,
5302 * without connection recovery attempts.
5303 */
5304void ieee80211_connection_loss(struct ieee80211_vif *vif);
5305
5306/**
5307 * ieee80211_resume_disconnect - disconnect from AP after resume
5308 *
5309 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5310 *
5311 * Instructs mac80211 to disconnect from the AP after resume.
5312 * Drivers can use this after WoWLAN if they know that the
5313 * connection cannot be kept up, for example because keys were
5314 * used while the device was asleep but the replay counters or
5315 * similar cannot be retrieved from the device during resume.
5316 *
5317 * Note that due to implementation issues, if the driver uses
5318 * the reconfiguration functionality during resume the interface
5319 * will still be added as associated first during resume and then
5320 * disconnect normally later.
5321 *
5322 * This function can only be called from the resume callback and
5323 * the driver must not be holding any of its own locks while it
5324 * calls this function, or at least not any locks it needs in the
5325 * key configuration paths (if it supports HW crypto).
5326 */
5327void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
5328
5329/**
5330 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
5331 *      rssi threshold triggered
5332 *
5333 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5334 * @rssi_event: the RSSI trigger event type
5335 * @rssi_level: new RSSI level value or 0 if not available
5336 * @gfp: context flags
5337 *
5338 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
5339 * monitoring is configured with an rssi threshold, the driver will inform
5340 * whenever the rssi level reaches the threshold.
5341 */
5342void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
5343                               enum nl80211_cqm_rssi_threshold_event rssi_event,
5344                               s32 rssi_level,
5345                               gfp_t gfp);
5346
5347/**
5348 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
5349 *
5350 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5351 * @gfp: context flags
5352 */
5353void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp);
5354
5355/**
5356 * ieee80211_radar_detected - inform that a radar was detected
5357 *
5358 * @hw: pointer as obtained from ieee80211_alloc_hw()
5359 */
5360void ieee80211_radar_detected(struct ieee80211_hw *hw);
5361
5362/**
5363 * ieee80211_chswitch_done - Complete channel switch process
5364 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5365 * @success: make the channel switch successful or not
5366 *
5367 * Complete the channel switch post-process: set the new operational channel
5368 * and wake up the suspended queues.
5369 */
5370void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
5371
5372/**
5373 * ieee80211_request_smps - request SM PS transition
5374 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5375 * @smps_mode: new SM PS mode
5376 *
5377 * This allows the driver to request an SM PS transition in managed
5378 * mode. This is useful when the driver has more information than
5379 * the stack about possible interference, for example by bluetooth.
5380 */
5381void ieee80211_request_smps(struct ieee80211_vif *vif,
5382                            enum ieee80211_smps_mode smps_mode);
5383
5384/**
5385 * ieee80211_ready_on_channel - notification of remain-on-channel start
5386 * @hw: pointer as obtained from ieee80211_alloc_hw()
5387 */
5388void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
5389
5390/**
5391 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
5392 * @hw: pointer as obtained from ieee80211_alloc_hw()
5393 */
5394void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
5395
5396/**
5397 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
5398 *
5399 * in order not to harm the system performance and user experience, the device
5400 * may request not to allow any rx ba session and tear down existing rx ba
5401 * sessions based on system constraints such as periodic BT activity that needs
5402 * to limit wlan activity (eg.sco or a2dp)."
5403 * in such cases, the intention is to limit the duration of the rx ppdu and
5404 * therefore prevent the peer device to use a-mpdu aggregation.
5405 *
5406 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5407 * @ba_rx_bitmap: Bit map of open rx ba per tid
5408 * @addr: & to bssid mac address
5409 */
5410void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
5411                                  const u8 *addr);
5412
5413/**
5414 * ieee80211_mark_rx_ba_filtered_frames - move RX BA window and mark filtered
5415 * @pubsta: station struct
5416 * @tid: the session's TID
5417 * @ssn: starting sequence number of the bitmap, all frames before this are
5418 *      assumed to be out of the window after the call
5419 * @filtered: bitmap of filtered frames, BIT(0) is the @ssn entry etc.
5420 * @received_mpdus: number of received mpdus in firmware
5421 *
5422 * This function moves the BA window and releases all frames before @ssn, and
5423 * marks frames marked in the bitmap as having been filtered. Afterwards, it
5424 * checks if any frames in the window starting from @ssn can now be released
5425 * (in case they were only waiting for frames that were filtered.)
5426 */
5427void ieee80211_mark_rx_ba_filtered_frames(struct ieee80211_sta *pubsta, u8 tid,
5428                                          u16 ssn, u64 filtered,
5429                                          u16 received_mpdus);
5430
5431/**
5432 * ieee80211_send_bar - send a BlockAckReq frame
5433 *
5434 * can be used to flush pending frames from the peer's aggregation reorder
5435 * buffer.
5436 *
5437 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5438 * @ra: the peer's destination address
5439 * @tid: the TID of the aggregation session
5440 * @ssn: the new starting sequence number for the receiver
5441 */
5442void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
5443
5444void ieee80211_manage_rx_ba_offl(struct ieee80211_vif *vif, const u8 *addr,
5445                                 unsigned int bit);
5446
5447/**
5448 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
5449 *
5450 * Some device drivers may offload part of the Rx aggregation flow including
5451 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5452 * reordering.
5453 *
5454 * Create structures responsible for reordering so device drivers may call here
5455 * when they complete AddBa negotiation.
5456 *
5457 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5458 * @addr: station mac address
5459 * @tid: the rx tid
5460 */
5461static inline void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
5462                                                      const u8 *addr, u16 tid)
5463{
5464        if (WARN_ON(tid >= IEEE80211_NUM_TIDS))
5465                return;
5466        ieee80211_manage_rx_ba_offl(vif, addr, tid);
5467}
5468
5469/**
5470 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
5471 *
5472 * Some device drivers may offload part of the Rx aggregation flow including
5473 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5474 * reordering.
5475 *
5476 * Destroy structures responsible for reordering so device drivers may call here
5477 * when they complete DelBa negotiation.
5478 *
5479 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5480 * @addr: station mac address
5481 * @tid: the rx tid
5482 */
5483static inline void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
5484                                                     const u8 *addr, u16 tid)
5485{
5486        if (WARN_ON(tid >= IEEE80211_NUM_TIDS))
5487                return;
5488        ieee80211_manage_rx_ba_offl(vif, addr, tid + IEEE80211_NUM_TIDS);
5489}
5490
5491/**
5492 * ieee80211_rx_ba_timer_expired - stop a Rx BA session due to timeout
5493 *
5494 * Some device drivers do not offload AddBa/DelBa negotiation, but handle rx
5495 * buffer reording internally, and therefore also handle the session timer.
5496 *
5497 * Trigger the timeout flow, which sends a DelBa.
5498 *
5499 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5500 * @addr: station mac address
5501 * @tid: the rx tid
5502 */
5503void ieee80211_rx_ba_timer_expired(struct ieee80211_vif *vif,
5504                                   const u8 *addr, unsigned int tid);
5505
5506/* Rate control API */
5507
5508/**
5509 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
5510 *
5511 * @hw: The hardware the algorithm is invoked for.
5512 * @sband: The band this frame is being transmitted on.
5513 * @bss_conf: the current BSS configuration
5514 * @skb: the skb that will be transmitted, the control information in it needs
5515 *      to be filled in
5516 * @reported_rate: The rate control algorithm can fill this in to indicate
5517 *      which rate should be reported to userspace as the current rate and
5518 *      used for rate calculations in the mesh network.
5519 * @rts: whether RTS will be used for this frame because it is longer than the
5520 *      RTS threshold
5521 * @short_preamble: whether mac80211 will request short-preamble transmission
5522 *      if the selected rate supports it
5523 * @rate_idx_mask: user-requested (legacy) rate mask
5524 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
5525 * @bss: whether this frame is sent out in AP or IBSS mode
5526 */
5527struct ieee80211_tx_rate_control {
5528        struct ieee80211_hw *hw;
5529        struct ieee80211_supported_band *sband;
5530        struct ieee80211_bss_conf *bss_conf;
5531        struct sk_buff *skb;
5532        struct ieee80211_tx_rate reported_rate;
5533        bool rts, short_preamble;
5534        u32 rate_idx_mask;
5535        u8 *rate_idx_mcs_mask;
5536        bool bss;
5537};
5538
5539struct rate_control_ops {
5540        const char *name;
5541        void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
5542        void (*free)(void *priv);
5543
5544        void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
5545        void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
5546                          struct cfg80211_chan_def *chandef,
5547                          struct ieee80211_sta *sta, void *priv_sta);
5548        void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
5549                            struct cfg80211_chan_def *chandef,
5550                            struct ieee80211_sta *sta, void *priv_sta,
5551                            u32 changed);
5552        void (*free_sta)(void *priv, struct ieee80211_sta *sta,
5553                         void *priv_sta);
5554
5555        void (*tx_status_ext)(void *priv,
5556                              struct ieee80211_supported_band *sband,
5557                              void *priv_sta, struct ieee80211_tx_status *st);
5558        void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
5559                          struct ieee80211_sta *sta, void *priv_sta,
5560                          struct sk_buff *skb);
5561        void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
5562                         struct ieee80211_tx_rate_control *txrc);
5563
5564        void (*add_sta_debugfs)(void *priv, void *priv_sta,
5565                                struct dentry *dir);
5566        void (*remove_sta_debugfs)(void *priv, void *priv_sta);
5567
5568        u32 (*get_expected_throughput)(void *priv_sta);
5569};
5570
5571static inline int rate_supported(struct ieee80211_sta *sta,
5572                                 enum nl80211_band band,
5573                                 int index)
5574{
5575        return (sta == NULL || sta->supp_rates[band] & BIT(index));
5576}
5577
5578/**
5579 * rate_control_send_low - helper for drivers for management/no-ack frames
5580 *
5581 * Rate control algorithms that agree to use the lowest rate to
5582 * send management frames and NO_ACK data with the respective hw
5583 * retries should use this in the beginning of their mac80211 get_rate
5584 * callback. If true is returned the rate control can simply return.
5585 * If false is returned we guarantee that sta and sta and priv_sta is
5586 * not null.
5587 *
5588 * Rate control algorithms wishing to do more intelligent selection of
5589 * rate for multicast/broadcast frames may choose to not use this.
5590 *
5591 * @sta: &struct ieee80211_sta pointer to the target destination. Note
5592 *      that this may be null.
5593 * @priv_sta: private rate control structure. This may be null.
5594 * @txrc: rate control information we sholud populate for mac80211.
5595 */
5596bool rate_control_send_low(struct ieee80211_sta *sta,
5597                           void *priv_sta,
5598                           struct ieee80211_tx_rate_control *txrc);
5599
5600
5601static inline s8
5602rate_lowest_index(struct ieee80211_supported_band *sband,
5603                  struct ieee80211_sta *sta)
5604{
5605        int i;
5606
5607        for (i = 0; i < sband->n_bitrates; i++)
5608                if (rate_supported(sta, sband->band, i))
5609                        return i;
5610
5611        /* warn when we cannot find a rate. */
5612        WARN_ON_ONCE(1);
5613
5614        /* and return 0 (the lowest index) */
5615        return 0;
5616}
5617
5618static inline
5619bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
5620                              struct ieee80211_sta *sta)
5621{
5622        unsigned int i;
5623
5624        for (i = 0; i < sband->n_bitrates; i++)
5625                if (rate_supported(sta, sband->band, i))
5626                        return true;
5627        return false;
5628}
5629
5630/**
5631 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
5632 *
5633 * When not doing a rate control probe to test rates, rate control should pass
5634 * its rate selection to mac80211. If the driver supports receiving a station
5635 * rate table, it will use it to ensure that frames are always sent based on
5636 * the most recent rate control module decision.
5637 *
5638 * @hw: pointer as obtained from ieee80211_alloc_hw()
5639 * @pubsta: &struct ieee80211_sta pointer to the target destination.
5640 * @rates: new tx rate set to be used for this station.
5641 */
5642int rate_control_set_rates(struct ieee80211_hw *hw,
5643                           struct ieee80211_sta *pubsta,
5644                           struct ieee80211_sta_rates *rates);
5645
5646int ieee80211_rate_control_register(const struct rate_control_ops *ops);
5647void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
5648
5649static inline bool
5650conf_is_ht20(struct ieee80211_conf *conf)
5651{
5652        return conf->chandef.width == NL80211_CHAN_WIDTH_20;
5653}
5654
5655static inline bool
5656conf_is_ht40_minus(struct ieee80211_conf *conf)
5657{
5658        return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5659               conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
5660}
5661
5662static inline bool
5663conf_is_ht40_plus(struct ieee80211_conf *conf)
5664{
5665        return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5666               conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
5667}
5668
5669static inline bool
5670conf_is_ht40(struct ieee80211_conf *conf)
5671{
5672        return conf->chandef.width == NL80211_CHAN_WIDTH_40;
5673}
5674
5675static inline bool
5676conf_is_ht(struct ieee80211_conf *conf)
5677{
5678        return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
5679                (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
5680                (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
5681}
5682
5683static inline enum nl80211_iftype
5684ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
5685{
5686        if (p2p) {
5687                switch (type) {
5688                case NL80211_IFTYPE_STATION:
5689                        return NL80211_IFTYPE_P2P_CLIENT;
5690                case NL80211_IFTYPE_AP:
5691                        return NL80211_IFTYPE_P2P_GO;
5692                default:
5693                        break;
5694                }
5695        }
5696        return type;
5697}
5698
5699static inline enum nl80211_iftype
5700ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
5701{
5702        return ieee80211_iftype_p2p(vif->type, vif->p2p);
5703}
5704
5705/**
5706 * ieee80211_update_mu_groups - set the VHT MU-MIMO groud data
5707 *
5708 * @vif: the specified virtual interface
5709 * @membership: 64 bits array - a bit is set if station is member of the group
5710 * @position: 2 bits per group id indicating the position in the group
5711 *
5712 * Note: This function assumes that the given vif is valid and the position and
5713 * membership data is of the correct size and are in the same byte order as the
5714 * matching GroupId management frame.
5715 * Calls to this function need to be serialized with RX path.
5716 */
5717void ieee80211_update_mu_groups(struct ieee80211_vif *vif,
5718                                const u8 *membership, const u8 *position);
5719
5720void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
5721                                   int rssi_min_thold,
5722                                   int rssi_max_thold);
5723
5724void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
5725
5726/**
5727 * ieee80211_ave_rssi - report the average RSSI for the specified interface
5728 *
5729 * @vif: the specified virtual interface
5730 *
5731 * Note: This function assumes that the given vif is valid.
5732 *
5733 * Return: The average RSSI value for the requested interface, or 0 if not
5734 * applicable.
5735 */
5736int ieee80211_ave_rssi(struct ieee80211_vif *vif);
5737
5738/**
5739 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
5740 * @vif: virtual interface
5741 * @wakeup: wakeup reason(s)
5742 * @gfp: allocation flags
5743 *
5744 * See cfg80211_report_wowlan_wakeup().
5745 */
5746void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
5747                                    struct cfg80211_wowlan_wakeup *wakeup,
5748                                    gfp_t gfp);
5749
5750/**
5751 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
5752 * @hw: pointer as obtained from ieee80211_alloc_hw()
5753 * @vif: virtual interface
5754 * @skb: frame to be sent from within the driver
5755 * @band: the band to transmit on
5756 * @sta: optional pointer to get the station to send the frame to
5757 *
5758 * Note: must be called under RCU lock
5759 */
5760bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
5761                              struct ieee80211_vif *vif, struct sk_buff *skb,
5762                              int band, struct ieee80211_sta **sta);
5763
5764/**
5765 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
5766 *
5767 * @next_tsf: TSF timestamp of the next absent state change
5768 * @has_next_tsf: next absent state change event pending
5769 *
5770 * @absent: descriptor bitmask, set if GO is currently absent
5771 *
5772 * private:
5773 *
5774 * @count: count fields from the NoA descriptors
5775 * @desc: adjusted data from the NoA
5776 */
5777struct ieee80211_noa_data {
5778        u32 next_tsf;
5779        bool has_next_tsf;
5780
5781        u8 absent;
5782
5783        u8 count[IEEE80211_P2P_NOA_DESC_MAX];
5784        struct {
5785                u32 start;
5786                u32 duration;
5787                u32 interval;
5788        } desc[IEEE80211_P2P_NOA_DESC_MAX];
5789};
5790
5791/**
5792 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
5793 *
5794 * @attr: P2P NoA IE
5795 * @data: NoA tracking data
5796 * @tsf: current TSF timestamp
5797 *
5798 * Return: number of successfully parsed descriptors
5799 */
5800int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
5801                            struct ieee80211_noa_data *data, u32 tsf);
5802
5803/**
5804 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
5805 *
5806 * @data: NoA tracking data
5807 * @tsf: current TSF timestamp
5808 */
5809void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
5810
5811/**
5812 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
5813 * @vif: virtual interface
5814 * @peer: the peer's destination address
5815 * @oper: the requested TDLS operation
5816 * @reason_code: reason code for the operation, valid for TDLS teardown
5817 * @gfp: allocation flags
5818 *
5819 * See cfg80211_tdls_oper_request().
5820 */
5821void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
5822                                 enum nl80211_tdls_operation oper,
5823                                 u16 reason_code, gfp_t gfp);
5824
5825/**
5826 * ieee80211_reserve_tid - request to reserve a specific TID
5827 *
5828 * There is sometimes a need (such as in TDLS) for blocking the driver from
5829 * using a specific TID so that the FW can use it for certain operations such
5830 * as sending PTI requests. To make sure that the driver doesn't use that TID,
5831 * this function must be called as it flushes out packets on this TID and marks
5832 * it as blocked, so that any transmit for the station on this TID will be
5833 * redirected to the alternative TID in the same AC.
5834 *
5835 * Note that this function blocks and may call back into the driver, so it
5836 * should be called without driver locks held. Also note this function should
5837 * only be called from the driver's @sta_state callback.
5838 *
5839 * @sta: the station to reserve the TID for
5840 * @tid: the TID to reserve
5841 *
5842 * Returns: 0 on success, else on failure
5843 */
5844int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid);
5845
5846/**
5847 * ieee80211_unreserve_tid - request to unreserve a specific TID
5848 *
5849 * Once there is no longer any need for reserving a certain TID, this function
5850 * should be called, and no longer will packets have their TID modified for
5851 * preventing use of this TID in the driver.
5852 *
5853 * Note that this function blocks and acquires a lock, so it should be called
5854 * without driver locks held. Also note this function should only be called
5855 * from the driver's @sta_state callback.
5856 *
5857 * @sta: the station
5858 * @tid: the TID to unreserve
5859 */
5860void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid);
5861
5862/**
5863 * ieee80211_tx_dequeue - dequeue a packet from a software tx queue
5864 *
5865 * @hw: pointer as obtained from ieee80211_alloc_hw()
5866 * @txq: pointer obtained from station or virtual interface
5867 *
5868 * Returns the skb if successful, %NULL if no frame was available.
5869 */
5870struct sk_buff *ieee80211_tx_dequeue(struct ieee80211_hw *hw,
5871                                     struct ieee80211_txq *txq);
5872
5873/**
5874 * ieee80211_txq_get_depth - get pending frame/byte count of given txq
5875 *
5876 * The values are not guaranteed to be coherent with regard to each other, i.e.
5877 * txq state can change half-way of this function and the caller may end up
5878 * with "new" frame_cnt and "old" byte_cnt or vice-versa.
5879 *
5880 * @txq: pointer obtained from station or virtual interface
5881 * @frame_cnt: pointer to store frame count
5882 * @byte_cnt: pointer to store byte count
5883 */
5884void ieee80211_txq_get_depth(struct ieee80211_txq *txq,
5885                             unsigned long *frame_cnt,
5886                             unsigned long *byte_cnt);
5887
5888/**
5889 * ieee80211_nan_func_terminated - notify about NAN function termination.
5890 *
5891 * This function is used to notify mac80211 about NAN function termination.
5892 * Note that this function can't be called from hard irq.
5893 *
5894 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5895 * @inst_id: the local instance id
5896 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
5897 * @gfp: allocation flags
5898 */
5899void ieee80211_nan_func_terminated(struct ieee80211_vif *vif,
5900                                   u8 inst_id,
5901                                   enum nl80211_nan_func_term_reason reason,
5902                                   gfp_t gfp);
5903
5904/**
5905 * ieee80211_nan_func_match - notify about NAN function match event.
5906 *
5907 * This function is used to notify mac80211 about NAN function match. The
5908 * cookie inside the match struct will be assigned by mac80211.
5909 * Note that this function can't be called from hard irq.
5910 *
5911 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5912 * @match: match event information
5913 * @gfp: allocation flags
5914 */
5915void ieee80211_nan_func_match(struct ieee80211_vif *vif,
5916                              struct cfg80211_nan_match_params *match,
5917                              gfp_t gfp);
5918
5919#endif /* MAC80211_H */
5920