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