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