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