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