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