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

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

Version: ~ [ linux-6.11-rc3 ] ~ [ linux-6.10.4 ] ~ [ linux-6.9.12 ] ~ [ linux-6.8.12 ] ~ [ linux-6.7.12 ] ~ [ linux-6.6.45 ] ~ [ linux-6.5.13 ] ~ [ linux-6.4.16 ] ~ [ linux-6.3.13 ] ~ [ linux-6.2.16 ] ~ [ linux-6.1.104 ] ~ [ linux-6.0.19 ] ~ [ linux-5.19.17 ] ~ [ linux-5.18.19 ] ~ [ linux-5.17.15 ] ~ [ linux-5.16.20 ] ~ [ linux-5.15.164 ] ~ [ linux-5.14.21 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.223 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.281 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.319 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.336 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.337 ] ~ [ linux-4.4.302 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.9 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

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

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

kernel.org | git.kernel.org | LWN.net | Project Home | 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.

sflogo.php