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