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