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

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

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

~ [ 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