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