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