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