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