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