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