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