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