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