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