~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/net/mac80211.h

Version: ~ [ linux-5.9 ] ~ [ linux-5.8.14 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.70 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.150 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.200 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.238 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.238 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.85 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp