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