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