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