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