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