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