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