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