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