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