mac80211.h revision f1e3e0515646dd0f4c783c1c39839d2706501344
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 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13#ifndef MAC80211_H
14#define MAC80211_H
15
16#include <linux/bug.h>
17#include <linux/kernel.h>
18#include <linux/if_ether.h>
19#include <linux/skbuff.h>
20#include <linux/ieee80211.h>
21#include <net/cfg80211.h>
22#include <asm/unaligned.h>
23
24/**
25 * DOC: Introduction
26 *
27 * mac80211 is the Linux stack for 802.11 hardware that implements
28 * only partial functionality in hard- or firmware. This document
29 * defines the interface between mac80211 and low-level hardware
30 * drivers.
31 */
32
33/**
34 * DOC: Calling mac80211 from interrupts
35 *
36 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
37 * called in hardware interrupt context. The low-level driver must not call any
38 * other functions in hardware interrupt context. If there is a need for such
39 * call, the low-level driver should first ACK the interrupt and perform the
40 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
41 * tasklet function.
42 *
43 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
44 *	 use the non-IRQ-safe functions!
45 */
46
47/**
48 * DOC: Warning
49 *
50 * If you're reading this document and not the header file itself, it will
51 * be incomplete because not all documentation has been converted yet.
52 */
53
54/**
55 * DOC: Frame format
56 *
57 * As a general rule, when frames are passed between mac80211 and the driver,
58 * they start with the IEEE 802.11 header and include the same octets that are
59 * sent over the air except for the FCS which should be calculated by the
60 * hardware.
61 *
62 * There are, however, various exceptions to this rule for advanced features:
63 *
64 * The first exception is for hardware encryption and decryption offload
65 * where the IV/ICV may or may not be generated in hardware.
66 *
67 * Secondly, when the hardware handles fragmentation, the frame handed to
68 * the driver from mac80211 is the MSDU, not the MPDU.
69 *
70 * Finally, for received frames, the driver is able to indicate that it has
71 * filled a radiotap header and put that in front of the frame; if it does
72 * not do so then mac80211 may add this under certain circumstances.
73 */
74
75/**
76 * DOC: mac80211 workqueue
77 *
78 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
79 * The workqueue is a single threaded workqueue and can only be accessed by
80 * helpers for sanity checking. Drivers must ensure all work added onto the
81 * mac80211 workqueue should be cancelled on the driver stop() callback.
82 *
83 * mac80211 will flushed the workqueue upon interface removal and during
84 * suspend.
85 *
86 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
87 *
88 */
89
90struct device;
91
92/**
93 * enum ieee80211_max_queues - maximum number of queues
94 *
95 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
96 */
97enum ieee80211_max_queues {
98	IEEE80211_MAX_QUEUES =		16,
99};
100
101#define IEEE80211_INVAL_HW_QUEUE	0xff
102
103/**
104 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
105 * @IEEE80211_AC_VO: voice
106 * @IEEE80211_AC_VI: video
107 * @IEEE80211_AC_BE: best effort
108 * @IEEE80211_AC_BK: background
109 */
110enum ieee80211_ac_numbers {
111	IEEE80211_AC_VO		= 0,
112	IEEE80211_AC_VI		= 1,
113	IEEE80211_AC_BE		= 2,
114	IEEE80211_AC_BK		= 3,
115};
116#define IEEE80211_NUM_ACS	4
117
118/**
119 * struct ieee80211_tx_queue_params - transmit queue configuration
120 *
121 * The information provided in this structure is required for QoS
122 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
123 *
124 * @aifs: arbitration interframe space [0..255]
125 * @cw_min: minimum contention window [a value of the form
126 *	2^n-1 in the range 1..32767]
127 * @cw_max: maximum contention window [like @cw_min]
128 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
129 * @uapsd: is U-APSD mode enabled for the queue
130 */
131struct ieee80211_tx_queue_params {
132	u16 txop;
133	u16 cw_min;
134	u16 cw_max;
135	u8 aifs;
136	bool uapsd;
137};
138
139struct ieee80211_low_level_stats {
140	unsigned int dot11ACKFailureCount;
141	unsigned int dot11RTSFailureCount;
142	unsigned int dot11FCSErrorCount;
143	unsigned int dot11RTSSuccessCount;
144};
145
146/**
147 * enum ieee80211_chanctx_change - change flag for channel context
148 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
149 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
150 */
151enum ieee80211_chanctx_change {
152	IEEE80211_CHANCTX_CHANGE_WIDTH		= BIT(0),
153	IEEE80211_CHANCTX_CHANGE_RX_CHAINS	= BIT(1),
154};
155
156/**
157 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
158 *
159 * This is the driver-visible part. The ieee80211_chanctx
160 * that contains it is visible in mac80211 only.
161 *
162 * @def: the channel definition
163 * @rx_chains_static: The number of RX chains that must always be
164 *	active on the channel to receive MIMO transmissions
165 * @rx_chains_dynamic: The number of RX chains that must be enabled
166 *	after RTS/CTS handshake to receive SMPS MIMO transmissions;
167 *	this will always be >= @rx_chains_static.
168 * @drv_priv: data area for driver use, will always be aligned to
169 *	sizeof(void *), size is determined in hw information.
170 */
171struct ieee80211_chanctx_conf {
172	struct cfg80211_chan_def def;
173
174	u8 rx_chains_static, rx_chains_dynamic;
175
176	u8 drv_priv[0] __aligned(sizeof(void *));
177};
178
179/**
180 * enum ieee80211_bss_change - BSS change notification flags
181 *
182 * These flags are used with the bss_info_changed() callback
183 * to indicate which BSS parameter changed.
184 *
185 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
186 *	also implies a change in the AID.
187 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
188 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
189 * @BSS_CHANGED_ERP_SLOT: slot timing changed
190 * @BSS_CHANGED_HT: 802.11n parameters changed
191 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
192 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
193 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
194 *	reason (IBSS and managed mode)
195 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
196 *	new beacon (beaconing modes)
197 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
198 *	enabled/disabled (beaconing modes)
199 * @BSS_CHANGED_CQM: Connection quality monitor config changed
200 * @BSS_CHANGED_IBSS: IBSS join status changed
201 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
202 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
203 *	that it is only ever disabled for station mode.
204 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
205 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP mode)
206 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
207 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
208 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
209 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
210 *	changed (currently only in P2P client mode, GO mode will be later)
211 * @BSS_CHANGED_DTIM_PERIOD: the DTIM period value was changed (set when
212 *	it becomes valid, managed mode only)
213 */
214enum ieee80211_bss_change {
215	BSS_CHANGED_ASSOC		= 1<<0,
216	BSS_CHANGED_ERP_CTS_PROT	= 1<<1,
217	BSS_CHANGED_ERP_PREAMBLE	= 1<<2,
218	BSS_CHANGED_ERP_SLOT		= 1<<3,
219	BSS_CHANGED_HT			= 1<<4,
220	BSS_CHANGED_BASIC_RATES		= 1<<5,
221	BSS_CHANGED_BEACON_INT		= 1<<6,
222	BSS_CHANGED_BSSID		= 1<<7,
223	BSS_CHANGED_BEACON		= 1<<8,
224	BSS_CHANGED_BEACON_ENABLED	= 1<<9,
225	BSS_CHANGED_CQM			= 1<<10,
226	BSS_CHANGED_IBSS		= 1<<11,
227	BSS_CHANGED_ARP_FILTER		= 1<<12,
228	BSS_CHANGED_QOS			= 1<<13,
229	BSS_CHANGED_IDLE		= 1<<14,
230	BSS_CHANGED_SSID		= 1<<15,
231	BSS_CHANGED_AP_PROBE_RESP	= 1<<16,
232	BSS_CHANGED_PS			= 1<<17,
233	BSS_CHANGED_TXPOWER		= 1<<18,
234	BSS_CHANGED_P2P_PS		= 1<<19,
235	BSS_CHANGED_DTIM_PERIOD		= 1<<20,
236
237	/* when adding here, make sure to change ieee80211_reconfig */
238};
239
240/*
241 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
242 * of addresses for an interface increase beyond this value, hardware ARP
243 * filtering will be disabled.
244 */
245#define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
246
247/**
248 * enum ieee80211_rssi_event - RSSI threshold event
249 * An indicator for when RSSI goes below/above a certain threshold.
250 * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
251 * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
252 */
253enum ieee80211_rssi_event {
254	RSSI_EVENT_HIGH,
255	RSSI_EVENT_LOW,
256};
257
258/**
259 * struct ieee80211_bss_conf - holds the BSS's changing parameters
260 *
261 * This structure keeps information about a BSS (and an association
262 * to that BSS) that can change during the lifetime of the BSS.
263 *
264 * @assoc: association status
265 * @ibss_joined: indicates whether this station is part of an IBSS
266 *	or not
267 * @ibss_creator: indicates if a new IBSS network is being created
268 * @aid: association ID number, valid only when @assoc is true
269 * @use_cts_prot: use CTS protection
270 * @use_short_preamble: use 802.11b short preamble;
271 *	if the hardware cannot handle this it must set the
272 *	IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
273 * @use_short_slot: use short slot time (only relevant for ERP);
274 *	if the hardware cannot handle this it must set the
275 *	IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
276 * @dtim_period: num of beacons before the next DTIM, for beaconing,
277 *	valid in station mode only if after the driver was notified
278 *	with the %BSS_CHANGED_DTIM_PERIOD flag, will be non-zero then.
279 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
280 *	as it may have been received during scanning long ago). If the
281 *	HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
282 *	only come from a beacon, but might not become valid until after
283 *	association when a beacon is received (which is notified with the
284 *	%BSS_CHANGED_DTIM flag.)
285 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
286 *	the driver/device can use this to calculate synchronisation
287 *	(see @sync_tsf)
288 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
289 *	is requested, see @sync_tsf/@sync_device_ts.
290 * @beacon_int: beacon interval
291 * @assoc_capability: capabilities taken from assoc resp
292 * @basic_rates: bitmap of basic rates, each bit stands for an
293 *	index into the rate table configured by the driver in
294 *	the current band.
295 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
296 * @bssid: The BSSID for this BSS
297 * @enable_beacon: whether beaconing should be enabled or not
298 * @chandef: Channel definition for this BSS -- the hardware might be
299 *	configured a higher bandwidth than this BSS uses, for example.
300 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
301 *	This field is only valid when the channel type is one of the HT types.
302 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
303 *	implies disabled
304 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
305 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
306 *	may filter ARP queries targeted for other addresses than listed here.
307 *	The driver must allow ARP queries targeted for all address listed here
308 *	to pass through. An empty list implies no ARP queries need to pass.
309 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
310 *	may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
311 *	array size), it's up to the driver what to do in that case.
312 * @qos: This is a QoS-enabled BSS.
313 * @idle: This interface is idle. There's also a global idle flag in the
314 *	hardware config which may be more appropriate depending on what
315 *	your driver/device needs to do.
316 * @ps: power-save mode (STA only). This flag is NOT affected by
317 *	offchannel/dynamic_ps operations.
318 * @ssid: The SSID of the current vif. Only valid in AP-mode.
319 * @ssid_len: Length of SSID given in @ssid.
320 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
321 * @txpower: TX power in dBm
322 * @p2p_ctwindow: P2P CTWindow, only for P2P client interfaces
323 * @p2p_oppps: P2P opportunistic PS is enabled
324 */
325struct ieee80211_bss_conf {
326	const u8 *bssid;
327	/* association related data */
328	bool assoc, ibss_joined;
329	bool ibss_creator;
330	u16 aid;
331	/* erp related data */
332	bool use_cts_prot;
333	bool use_short_preamble;
334	bool use_short_slot;
335	bool enable_beacon;
336	u8 dtim_period;
337	u16 beacon_int;
338	u16 assoc_capability;
339	u64 sync_tsf;
340	u32 sync_device_ts;
341	u8 sync_dtim_count;
342	u32 basic_rates;
343	int mcast_rate[IEEE80211_NUM_BANDS];
344	u16 ht_operation_mode;
345	s32 cqm_rssi_thold;
346	u32 cqm_rssi_hyst;
347	struct cfg80211_chan_def chandef;
348	__be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
349	int arp_addr_cnt;
350	bool qos;
351	bool idle;
352	bool ps;
353	u8 ssid[IEEE80211_MAX_SSID_LEN];
354	size_t ssid_len;
355	bool hidden_ssid;
356	int txpower;
357	u8 p2p_ctwindow;
358	bool p2p_oppps;
359};
360
361/**
362 * enum mac80211_tx_control_flags - flags to describe transmission information/status
363 *
364 * These flags are used with the @flags member of &ieee80211_tx_info.
365 *
366 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
367 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
368 *	number to this frame, taking care of not overwriting the fragment
369 *	number and increasing the sequence number only when the
370 *	IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
371 *	assign sequence numbers to QoS-data frames but cannot do so correctly
372 *	for non-QoS-data and management frames because beacons need them from
373 *	that counter as well and mac80211 cannot guarantee proper sequencing.
374 *	If this flag is set, the driver should instruct the hardware to
375 *	assign a sequence number to the frame or assign one itself. Cf. IEEE
376 *	802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
377 *	beacons and always be clear for frames without a sequence number field.
378 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
379 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
380 *	station
381 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
382 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
383 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
384 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
385 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
386 *	because the destination STA was in powersave mode. Note that to
387 *	avoid race conditions, the filter must be set by the hardware or
388 *	firmware upon receiving a frame that indicates that the station
389 *	went to sleep (must be done on device to filter frames already on
390 *	the queue) and may only be unset after mac80211 gives the OK for
391 *	that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
392 *	since only then is it guaranteed that no more frames are in the
393 *	hardware queue.
394 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
395 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
396 * 	is for the whole aggregation.
397 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
398 * 	so consider using block ack request (BAR).
399 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
400 *	set by rate control algorithms to indicate probe rate, will
401 *	be cleared for fragmented frames (except on the last fragment)
402 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
403 *	used to indicate that a pending frame requires TX processing before
404 *	it can be sent out.
405 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
406 *	used to indicate that a frame was already retried due to PS
407 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
408 *	used to indicate frame should not be encrypted
409 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
410 *	frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
411 *	be sent although the station is in powersave mode.
412 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
413 *	transmit function after the current frame, this can be used
414 *	by drivers to kick the DMA queue only if unset or when the
415 *	queue gets full.
416 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
417 *	after TX status because the destination was asleep, it must not
418 *	be modified again (no seqno assignment, crypto, etc.)
419 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
420 *	code for connection establishment, this indicates that its status
421 *	should kick the MLME state machine.
422 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
423 *	MLME command (internal to mac80211 to figure out whether to send TX
424 *	status to user space)
425 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
426 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
427 *	frame and selects the maximum number of streams that it can use.
428 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
429 *	the off-channel channel when a remain-on-channel offload is done
430 *	in hardware -- normal packets still flow and are expected to be
431 *	handled properly by the device.
432 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
433 *	testing. It will be sent out with incorrect Michael MIC key to allow
434 *	TKIP countermeasures to be tested.
435 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
436 *	This flag is actually used for management frame especially for P2P
437 *	frames not being sent at CCK rate in 2GHz band.
438 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
439 *	when its status is reported the service period ends. For frames in
440 *	an SP that mac80211 transmits, it is already set; for driver frames
441 *	the driver may set this flag. It is also used to do the same for
442 *	PS-Poll responses.
443 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
444 *	This flag is used to send nullfunc frame at minimum rate when
445 *	the nullfunc is used for connection monitoring purpose.
446 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
447 *	would be fragmented by size (this is optional, only used for
448 *	monitor injection).
449 *
450 * Note: If you have to add new flags to the enumeration, then don't
451 *	 forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
452 */
453enum mac80211_tx_control_flags {
454	IEEE80211_TX_CTL_REQ_TX_STATUS		= BIT(0),
455	IEEE80211_TX_CTL_ASSIGN_SEQ		= BIT(1),
456	IEEE80211_TX_CTL_NO_ACK			= BIT(2),
457	IEEE80211_TX_CTL_CLEAR_PS_FILT		= BIT(3),
458	IEEE80211_TX_CTL_FIRST_FRAGMENT		= BIT(4),
459	IEEE80211_TX_CTL_SEND_AFTER_DTIM	= BIT(5),
460	IEEE80211_TX_CTL_AMPDU			= BIT(6),
461	IEEE80211_TX_CTL_INJECTED		= BIT(7),
462	IEEE80211_TX_STAT_TX_FILTERED		= BIT(8),
463	IEEE80211_TX_STAT_ACK			= BIT(9),
464	IEEE80211_TX_STAT_AMPDU			= BIT(10),
465	IEEE80211_TX_STAT_AMPDU_NO_BACK		= BIT(11),
466	IEEE80211_TX_CTL_RATE_CTRL_PROBE	= BIT(12),
467	IEEE80211_TX_INTFL_NEED_TXPROCESSING	= BIT(14),
468	IEEE80211_TX_INTFL_RETRIED		= BIT(15),
469	IEEE80211_TX_INTFL_DONT_ENCRYPT		= BIT(16),
470	IEEE80211_TX_CTL_NO_PS_BUFFER		= BIT(17),
471	IEEE80211_TX_CTL_MORE_FRAMES		= BIT(18),
472	IEEE80211_TX_INTFL_RETRANSMISSION	= BIT(19),
473	IEEE80211_TX_INTFL_MLME_CONN_TX		= BIT(20),
474	IEEE80211_TX_INTFL_NL80211_FRAME_TX	= BIT(21),
475	IEEE80211_TX_CTL_LDPC			= BIT(22),
476	IEEE80211_TX_CTL_STBC			= BIT(23) | BIT(24),
477	IEEE80211_TX_CTL_TX_OFFCHAN		= BIT(25),
478	IEEE80211_TX_INTFL_TKIP_MIC_FAILURE	= BIT(26),
479	IEEE80211_TX_CTL_NO_CCK_RATE		= BIT(27),
480	IEEE80211_TX_STATUS_EOSP		= BIT(28),
481	IEEE80211_TX_CTL_USE_MINRATE		= BIT(29),
482	IEEE80211_TX_CTL_DONTFRAG		= BIT(30),
483};
484
485#define IEEE80211_TX_CTL_STBC_SHIFT		23
486
487/*
488 * This definition is used as a mask to clear all temporary flags, which are
489 * set by the tx handlers for each transmission attempt by the mac80211 stack.
490 */
491#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK |		      \
492	IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT |    \
493	IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU |	      \
494	IEEE80211_TX_STAT_TX_FILTERED |	IEEE80211_TX_STAT_ACK |		      \
495	IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK |	      \
496	IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER |    \
497	IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC |		      \
498	IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
499
500/**
501 * enum mac80211_rate_control_flags - per-rate flags set by the
502 *	Rate Control algorithm.
503 *
504 * These flags are set by the Rate control algorithm for each rate during tx,
505 * in the @flags member of struct ieee80211_tx_rate.
506 *
507 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
508 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
509 *	This is set if the current BSS requires ERP protection.
510 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
511 * @IEEE80211_TX_RC_MCS: HT rate.
512 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
513 *	into a higher 4 bits (Nss) and lower 4 bits (MCS number)
514 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
515 *	Greenfield mode.
516 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
517 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
518 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
519 *	(80+80 isn't supported yet)
520 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
521 *	adjacent 20 MHz channels, if the current channel type is
522 *	NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
523 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
524 */
525enum mac80211_rate_control_flags {
526	IEEE80211_TX_RC_USE_RTS_CTS		= BIT(0),
527	IEEE80211_TX_RC_USE_CTS_PROTECT		= BIT(1),
528	IEEE80211_TX_RC_USE_SHORT_PREAMBLE	= BIT(2),
529
530	/* rate index is an HT/VHT MCS instead of an index */
531	IEEE80211_TX_RC_MCS			= BIT(3),
532	IEEE80211_TX_RC_GREEN_FIELD		= BIT(4),
533	IEEE80211_TX_RC_40_MHZ_WIDTH		= BIT(5),
534	IEEE80211_TX_RC_DUP_DATA		= BIT(6),
535	IEEE80211_TX_RC_SHORT_GI		= BIT(7),
536	IEEE80211_TX_RC_VHT_MCS			= BIT(8),
537	IEEE80211_TX_RC_80_MHZ_WIDTH		= BIT(9),
538	IEEE80211_TX_RC_160_MHZ_WIDTH		= BIT(10),
539};
540
541
542/* there are 40 bytes if you don't need the rateset to be kept */
543#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
544
545/* if you do need the rateset, then you have less space */
546#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
547
548/* maximum number of rate stages */
549#define IEEE80211_TX_MAX_RATES	4
550
551/**
552 * struct ieee80211_tx_rate - rate selection/status
553 *
554 * @idx: rate index to attempt to send with
555 * @flags: rate control flags (&enum mac80211_rate_control_flags)
556 * @count: number of tries in this rate before going to the next rate
557 *
558 * A value of -1 for @idx indicates an invalid rate and, if used
559 * in an array of retry rates, that no more rates should be tried.
560 *
561 * When used for transmit status reporting, the driver should
562 * always report the rate along with the flags it used.
563 *
564 * &struct ieee80211_tx_info contains an array of these structs
565 * in the control information, and it will be filled by the rate
566 * control algorithm according to what should be sent. For example,
567 * if this array contains, in the format { <idx>, <count> } the
568 * information
569 *    { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
570 * then this means that the frame should be transmitted
571 * up to twice at rate 3, up to twice at rate 2, and up to four
572 * times at rate 1 if it doesn't get acknowledged. Say it gets
573 * acknowledged by the peer after the fifth attempt, the status
574 * information should then contain
575 *   { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
576 * since it was transmitted twice at rate 3, twice at rate 2
577 * and once at rate 1 after which we received an acknowledgement.
578 */
579struct ieee80211_tx_rate {
580	s8 idx;
581	u16 count:5,
582	    flags:11;
583} __packed;
584
585#define IEEE80211_MAX_TX_RETRY		31
586
587static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
588					  u8 mcs, u8 nss)
589{
590	WARN_ON(mcs & ~0xF);
591	WARN_ON(nss & ~0x7);
592	rate->idx = (nss << 4) | mcs;
593}
594
595static inline u8
596ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
597{
598	return rate->idx & 0xF;
599}
600
601static inline u8
602ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
603{
604	return rate->idx >> 4;
605}
606
607/**
608 * struct ieee80211_tx_info - skb transmit information
609 *
610 * This structure is placed in skb->cb for three uses:
611 *  (1) mac80211 TX control - mac80211 tells the driver what to do
612 *  (2) driver internal use (if applicable)
613 *  (3) TX status information - driver tells mac80211 what happened
614 *
615 * @flags: transmit info flags, defined above
616 * @band: the band to transmit on (use for checking for races)
617 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
618 * @ack_frame_id: internal frame ID for TX status, used internally
619 * @control: union for control data
620 * @status: union for status data
621 * @driver_data: array of driver_data pointers
622 * @ampdu_ack_len: number of acked aggregated frames.
623 * 	relevant only if IEEE80211_TX_STAT_AMPDU was set.
624 * @ampdu_len: number of aggregated frames.
625 * 	relevant only if IEEE80211_TX_STAT_AMPDU was set.
626 * @ack_signal: signal strength of the ACK frame
627 */
628struct ieee80211_tx_info {
629	/* common information */
630	u32 flags;
631	u8 band;
632
633	u8 hw_queue;
634
635	u16 ack_frame_id;
636
637	union {
638		struct {
639			union {
640				/* rate control */
641				struct {
642					struct ieee80211_tx_rate rates[
643						IEEE80211_TX_MAX_RATES];
644					s8 rts_cts_rate_idx;
645					/* 3 bytes free */
646				};
647				/* only needed before rate control */
648				unsigned long jiffies;
649			};
650			/* NB: vif can be NULL for injected frames */
651			struct ieee80211_vif *vif;
652			struct ieee80211_key_conf *hw_key;
653			/* 8 bytes free */
654		} control;
655		struct {
656			struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
657			int ack_signal;
658			u8 ampdu_ack_len;
659			u8 ampdu_len;
660			u8 antenna;
661			/* 21 bytes free */
662		} status;
663		struct {
664			struct ieee80211_tx_rate driver_rates[
665				IEEE80211_TX_MAX_RATES];
666			void *rate_driver_data[
667				IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
668		};
669		void *driver_data[
670			IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
671	};
672};
673
674/**
675 * struct ieee80211_sched_scan_ies - scheduled scan IEs
676 *
677 * This structure is used to pass the appropriate IEs to be used in scheduled
678 * scans for all bands.  It contains both the IEs passed from the userspace
679 * and the ones generated by mac80211.
680 *
681 * @ie: array with the IEs for each supported band
682 * @len: array with the total length of the IEs for each band
683 */
684struct ieee80211_sched_scan_ies {
685	u8 *ie[IEEE80211_NUM_BANDS];
686	size_t len[IEEE80211_NUM_BANDS];
687};
688
689static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
690{
691	return (struct ieee80211_tx_info *)skb->cb;
692}
693
694static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
695{
696	return (struct ieee80211_rx_status *)skb->cb;
697}
698
699/**
700 * ieee80211_tx_info_clear_status - clear TX status
701 *
702 * @info: The &struct ieee80211_tx_info to be cleared.
703 *
704 * When the driver passes an skb back to mac80211, it must report
705 * a number of things in TX status. This function clears everything
706 * in the TX status but the rate control information (it does clear
707 * the count since you need to fill that in anyway).
708 *
709 * NOTE: You can only use this function if you do NOT use
710 *	 info->driver_data! Use info->rate_driver_data
711 *	 instead if you need only the less space that allows.
712 */
713static inline void
714ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
715{
716	int i;
717
718	BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
719		     offsetof(struct ieee80211_tx_info, control.rates));
720	BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
721		     offsetof(struct ieee80211_tx_info, driver_rates));
722	BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
723	/* clear the rate counts */
724	for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
725		info->status.rates[i].count = 0;
726
727	BUILD_BUG_ON(
728	    offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
729	memset(&info->status.ampdu_ack_len, 0,
730	       sizeof(struct ieee80211_tx_info) -
731	       offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
732}
733
734
735/**
736 * enum mac80211_rx_flags - receive flags
737 *
738 * These flags are used with the @flag member of &struct ieee80211_rx_status.
739 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
740 *	Use together with %RX_FLAG_MMIC_STRIPPED.
741 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
742 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
743 *	verification has been done by the hardware.
744 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
745 *	If this flag is set, the stack cannot do any replay detection
746 *	hence the driver or hardware will have to do that.
747 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
748 *	the frame.
749 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
750 *	the frame.
751 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
752 *	field) is valid and contains the time the first symbol of the MPDU
753 *	was received. This is useful in monitor mode and for proper IBSS
754 *	merging.
755 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
756 *	field) is valid and contains the time the last symbol of the MPDU
757 *	(including FCS) was received.
758 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
759 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
760 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
761 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
762 * @RX_FLAG_80MHZ: 80 MHz was used
763 * @RX_FLAG_80P80MHZ: 80+80 MHz was used
764 * @RX_FLAG_160MHZ: 160 MHz was used
765 * @RX_FLAG_SHORT_GI: Short guard interval was used
766 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
767 *	Valid only for data frames (mainly A-MPDU)
768 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
769 *	the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
770 *	to hw.radiotap_mcs_details to advertise that fact
771 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
772 *	number (@ampdu_reference) must be populated and be a distinct number for
773 *	each A-MPDU
774 * @RX_FLAG_AMPDU_REPORT_ZEROLEN: driver reports 0-length subframes
775 * @RX_FLAG_AMPDU_IS_ZEROLEN: This is a zero-length subframe, for
776 *	monitoring purposes only
777 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
778 *	subframes of a single A-MPDU
779 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
780 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
781 *	on this subframe
782 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
783 *	is stored in the @ampdu_delimiter_crc field)
784 */
785enum mac80211_rx_flags {
786	RX_FLAG_MMIC_ERROR		= BIT(0),
787	RX_FLAG_DECRYPTED		= BIT(1),
788	RX_FLAG_MMIC_STRIPPED		= BIT(3),
789	RX_FLAG_IV_STRIPPED		= BIT(4),
790	RX_FLAG_FAILED_FCS_CRC		= BIT(5),
791	RX_FLAG_FAILED_PLCP_CRC 	= BIT(6),
792	RX_FLAG_MACTIME_START		= BIT(7),
793	RX_FLAG_SHORTPRE		= BIT(8),
794	RX_FLAG_HT			= BIT(9),
795	RX_FLAG_40MHZ			= BIT(10),
796	RX_FLAG_SHORT_GI		= BIT(11),
797	RX_FLAG_NO_SIGNAL_VAL		= BIT(12),
798	RX_FLAG_HT_GF			= BIT(13),
799	RX_FLAG_AMPDU_DETAILS		= BIT(14),
800	RX_FLAG_AMPDU_REPORT_ZEROLEN	= BIT(15),
801	RX_FLAG_AMPDU_IS_ZEROLEN	= BIT(16),
802	RX_FLAG_AMPDU_LAST_KNOWN	= BIT(17),
803	RX_FLAG_AMPDU_IS_LAST		= BIT(18),
804	RX_FLAG_AMPDU_DELIM_CRC_ERROR	= BIT(19),
805	RX_FLAG_AMPDU_DELIM_CRC_KNOWN	= BIT(20),
806	RX_FLAG_MACTIME_END		= BIT(21),
807	RX_FLAG_VHT			= BIT(22),
808	RX_FLAG_80MHZ			= BIT(23),
809	RX_FLAG_80P80MHZ		= BIT(24),
810	RX_FLAG_160MHZ			= BIT(25),
811};
812
813/**
814 * struct ieee80211_rx_status - receive status
815 *
816 * The low-level driver should provide this information (the subset
817 * supported by hardware) to the 802.11 code with each received
818 * frame, in the skb's control buffer (cb).
819 *
820 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
821 * 	(TSF) timer when the first data symbol (MPDU) arrived at the hardware.
822 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
823 *	it but can store it and pass it back to the driver for synchronisation
824 * @band: the active band when this frame was received
825 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
826 * @signal: signal strength when receiving this frame, either in dBm, in dB or
827 *	unspecified depending on the hardware capabilities flags
828 *	@IEEE80211_HW_SIGNAL_*
829 * @antenna: antenna used
830 * @rate_idx: index of data rate into band's supported rates or MCS index if
831 *	HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
832 * @vht_nss: number of streams (VHT only)
833 * @flag: %RX_FLAG_*
834 * @rx_flags: internal RX flags for mac80211
835 * @ampdu_reference: A-MPDU reference number, must be a different value for
836 *	each A-MPDU but the same for each subframe within one A-MPDU
837 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
838 * @vendor_radiotap_bitmap: radiotap vendor namespace presence bitmap
839 * @vendor_radiotap_len: radiotap vendor namespace length
840 * @vendor_radiotap_align: radiotap vendor namespace alignment. Note
841 *	that the actual data must be at the start of the SKB data
842 *	already.
843 * @vendor_radiotap_oui: radiotap vendor namespace OUI
844 * @vendor_radiotap_subns: radiotap vendor sub namespace
845 */
846struct ieee80211_rx_status {
847	u64 mactime;
848	u32 device_timestamp;
849	u32 ampdu_reference;
850	u32 flag;
851	u32 vendor_radiotap_bitmap;
852	u16 vendor_radiotap_len;
853	u16 freq;
854	u8 rate_idx;
855	u8 vht_nss;
856	u8 rx_flags;
857	u8 band;
858	u8 antenna;
859	s8 signal;
860	u8 ampdu_delimiter_crc;
861	u8 vendor_radiotap_align;
862	u8 vendor_radiotap_oui[3];
863	u8 vendor_radiotap_subns;
864};
865
866/**
867 * enum ieee80211_conf_flags - configuration flags
868 *
869 * Flags to define PHY configuration options
870 *
871 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
872 *	to determine for example whether to calculate timestamps for packets
873 *	or not, do not use instead of filter flags!
874 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
875 *	This is the power save mode defined by IEEE 802.11-2007 section 11.2,
876 *	meaning that the hardware still wakes up for beacons, is able to
877 *	transmit frames and receive the possible acknowledgment frames.
878 *	Not to be confused with hardware specific wakeup/sleep states,
879 *	driver is responsible for that. See the section "Powersave support"
880 *	for more.
881 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
882 *	the driver should be prepared to handle configuration requests but
883 *	may turn the device off as much as possible. Typically, this flag will
884 *	be set when an interface is set UP but not associated or scanning, but
885 *	it can also be unset in that case when monitor interfaces are active.
886 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
887 *	operating channel.
888 */
889enum ieee80211_conf_flags {
890	IEEE80211_CONF_MONITOR		= (1<<0),
891	IEEE80211_CONF_PS		= (1<<1),
892	IEEE80211_CONF_IDLE		= (1<<2),
893	IEEE80211_CONF_OFFCHANNEL	= (1<<3),
894};
895
896
897/**
898 * enum ieee80211_conf_changed - denotes which configuration changed
899 *
900 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
901 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
902 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
903 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
904 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
905 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
906 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
907 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
908 *	Note that this is only valid if channel contexts are not used,
909 *	otherwise each channel context has the number of chains listed.
910 */
911enum ieee80211_conf_changed {
912	IEEE80211_CONF_CHANGE_SMPS		= BIT(1),
913	IEEE80211_CONF_CHANGE_LISTEN_INTERVAL	= BIT(2),
914	IEEE80211_CONF_CHANGE_MONITOR		= BIT(3),
915	IEEE80211_CONF_CHANGE_PS		= BIT(4),
916	IEEE80211_CONF_CHANGE_POWER		= BIT(5),
917	IEEE80211_CONF_CHANGE_CHANNEL		= BIT(6),
918	IEEE80211_CONF_CHANGE_RETRY_LIMITS	= BIT(7),
919	IEEE80211_CONF_CHANGE_IDLE		= BIT(8),
920};
921
922/**
923 * enum ieee80211_smps_mode - spatial multiplexing power save mode
924 *
925 * @IEEE80211_SMPS_AUTOMATIC: automatic
926 * @IEEE80211_SMPS_OFF: off
927 * @IEEE80211_SMPS_STATIC: static
928 * @IEEE80211_SMPS_DYNAMIC: dynamic
929 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
930 */
931enum ieee80211_smps_mode {
932	IEEE80211_SMPS_AUTOMATIC,
933	IEEE80211_SMPS_OFF,
934	IEEE80211_SMPS_STATIC,
935	IEEE80211_SMPS_DYNAMIC,
936
937	/* keep last */
938	IEEE80211_SMPS_NUM_MODES,
939};
940
941/**
942 * struct ieee80211_conf - configuration of the device
943 *
944 * This struct indicates how the driver shall configure the hardware.
945 *
946 * @flags: configuration flags defined above
947 *
948 * @listen_interval: listen interval in units of beacon interval
949 * @max_sleep_period: the maximum number of beacon intervals to sleep for
950 *	before checking the beacon for a TIM bit (managed mode only); this
951 *	value will be only achievable between DTIM frames, the hardware
952 *	needs to check for the multicast traffic bit in DTIM beacons.
953 *	This variable is valid only when the CONF_PS flag is set.
954 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
955 *	in power saving. Power saving will not be enabled until a beacon
956 *	has been received and the DTIM period is known.
957 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
958 *	powersave documentation below. This variable is valid only when
959 *	the CONF_PS flag is set.
960 *
961 * @power_level: requested transmit power (in dBm), backward compatibility
962 *	value only that is set to the minimum of all interfaces
963 *
964 * @channel: the channel to tune to
965 * @channel_type: the channel (HT) type
966 *
967 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
968 *    (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
969 *    but actually means the number of transmissions not the number of retries
970 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
971 *    frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
972 *    number of transmissions not the number of retries
973 *
974 * @smps_mode: spatial multiplexing powersave mode; note that
975 *	%IEEE80211_SMPS_STATIC is used when the device is not
976 *	configured for an HT channel.
977 *	Note that this is only valid if channel contexts are not used,
978 *	otherwise each channel context has the number of chains listed.
979 */
980struct ieee80211_conf {
981	u32 flags;
982	int power_level, dynamic_ps_timeout;
983	int max_sleep_period;
984
985	u16 listen_interval;
986	u8 ps_dtim_period;
987
988	u8 long_frame_max_tx_count, short_frame_max_tx_count;
989
990	struct ieee80211_channel *channel;
991	enum nl80211_channel_type channel_type;
992	enum ieee80211_smps_mode smps_mode;
993};
994
995/**
996 * struct ieee80211_channel_switch - holds the channel switch data
997 *
998 * The information provided in this structure is required for channel switch
999 * operation.
1000 *
1001 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1002 *	Function (TSF) timer when the frame containing the channel switch
1003 *	announcement was received. This is simply the rx.mactime parameter
1004 *	the driver passed into mac80211.
1005 * @block_tx: Indicates whether transmission must be blocked before the
1006 *	scheduled channel switch, as indicated by the AP.
1007 * @channel: the new channel to switch to
1008 * @count: the number of TBTT's until the channel switch event
1009 */
1010struct ieee80211_channel_switch {
1011	u64 timestamp;
1012	bool block_tx;
1013	struct ieee80211_channel *channel;
1014	u8 count;
1015};
1016
1017/**
1018 * enum ieee80211_vif_flags - virtual interface flags
1019 *
1020 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1021 *	on this virtual interface to avoid unnecessary CPU wakeups
1022 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1023 *	monitoring on this virtual interface -- i.e. it can monitor
1024 *	connection quality related parameters, such as the RSSI level and
1025 *	provide notifications if configured trigger levels are reached.
1026 */
1027enum ieee80211_vif_flags {
1028	IEEE80211_VIF_BEACON_FILTER		= BIT(0),
1029	IEEE80211_VIF_SUPPORTS_CQM_RSSI		= BIT(1),
1030};
1031
1032/**
1033 * struct ieee80211_vif - per-interface data
1034 *
1035 * Data in this structure is continually present for driver
1036 * use during the life of a virtual interface.
1037 *
1038 * @type: type of this virtual interface
1039 * @bss_conf: BSS configuration for this interface, either our own
1040 *	or the BSS we're associated to
1041 * @addr: address of this interface
1042 * @p2p: indicates whether this AP or STA interface is a p2p
1043 *	interface, i.e. a GO or p2p-sta respectively
1044 * @driver_flags: flags/capabilities the driver has for this interface,
1045 *	these need to be set (or cleared) when the interface is added
1046 *	or, if supported by the driver, the interface type is changed
1047 *	at runtime, mac80211 will never touch this field
1048 * @hw_queue: hardware queue for each AC
1049 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1050 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1051 *	when it is not assigned. This pointer is RCU-protected due to the TX
1052 *	path needing to access it; even though the netdev carrier will always
1053 *	be off when it is %NULL there can still be races and packets could be
1054 *	processed after it switches back to %NULL.
1055 * @drv_priv: data area for driver use, will always be aligned to
1056 *	sizeof(void *).
1057 */
1058struct ieee80211_vif {
1059	enum nl80211_iftype type;
1060	struct ieee80211_bss_conf bss_conf;
1061	u8 addr[ETH_ALEN];
1062	bool p2p;
1063
1064	u8 cab_queue;
1065	u8 hw_queue[IEEE80211_NUM_ACS];
1066
1067	struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1068
1069	u32 driver_flags;
1070
1071	/* must be last */
1072	u8 drv_priv[0] __aligned(sizeof(void *));
1073};
1074
1075static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1076{
1077#ifdef CONFIG_MAC80211_MESH
1078	return vif->type == NL80211_IFTYPE_MESH_POINT;
1079#endif
1080	return false;
1081}
1082
1083/**
1084 * enum ieee80211_key_flags - key flags
1085 *
1086 * These flags are used for communication about keys between the driver
1087 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1088 *
1089 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
1090 *	that the STA this key will be used with could be using QoS.
1091 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1092 *	driver to indicate that it requires IV generation for this
1093 *	particular key.
1094 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1095 *	the driver for a TKIP key if it requires Michael MIC
1096 *	generation in software.
1097 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1098 *	that the key is pairwise rather then a shared key.
1099 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1100 *	CCMP key if it requires CCMP encryption of management frames (MFP) to
1101 *	be done in software.
1102 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1103 *	if space should be prepared for the IV, but the IV
1104 *	itself should not be generated. Do not set together with
1105 *	@IEEE80211_KEY_FLAG_GENERATE_IV on the same key.
1106 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1107 *	management frames. The flag can help drivers that have a hardware
1108 *	crypto implementation that doesn't deal with management frames
1109 *	properly by allowing them to not upload the keys to hardware and
1110 *	fall back to software crypto. Note that this flag deals only with
1111 *	RX, if your crypto engine can't deal with TX you can also set the
1112 *	%IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1113 */
1114enum ieee80211_key_flags {
1115	IEEE80211_KEY_FLAG_WMM_STA	= 1<<0,
1116	IEEE80211_KEY_FLAG_GENERATE_IV	= 1<<1,
1117	IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
1118	IEEE80211_KEY_FLAG_PAIRWISE	= 1<<3,
1119	IEEE80211_KEY_FLAG_SW_MGMT_TX	= 1<<4,
1120	IEEE80211_KEY_FLAG_PUT_IV_SPACE = 1<<5,
1121	IEEE80211_KEY_FLAG_RX_MGMT	= 1<<6,
1122};
1123
1124/**
1125 * struct ieee80211_key_conf - key information
1126 *
1127 * This key information is given by mac80211 to the driver by
1128 * the set_key() callback in &struct ieee80211_ops.
1129 *
1130 * @hw_key_idx: To be set by the driver, this is the key index the driver
1131 *	wants to be given when a frame is transmitted and needs to be
1132 *	encrypted in hardware.
1133 * @cipher: The key's cipher suite selector.
1134 * @flags: key flags, see &enum ieee80211_key_flags.
1135 * @keyidx: the key index (0-3)
1136 * @keylen: key material length
1137 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1138 * 	data block:
1139 * 	- Temporal Encryption Key (128 bits)
1140 * 	- Temporal Authenticator Tx MIC Key (64 bits)
1141 * 	- Temporal Authenticator Rx MIC Key (64 bits)
1142 * @icv_len: The ICV length for this key type
1143 * @iv_len: The IV length for this key type
1144 */
1145struct ieee80211_key_conf {
1146	u32 cipher;
1147	u8 icv_len;
1148	u8 iv_len;
1149	u8 hw_key_idx;
1150	u8 flags;
1151	s8 keyidx;
1152	u8 keylen;
1153	u8 key[0];
1154};
1155
1156/**
1157 * enum set_key_cmd - key command
1158 *
1159 * Used with the set_key() callback in &struct ieee80211_ops, this
1160 * indicates whether a key is being removed or added.
1161 *
1162 * @SET_KEY: a key is set
1163 * @DISABLE_KEY: a key must be disabled
1164 */
1165enum set_key_cmd {
1166	SET_KEY, DISABLE_KEY,
1167};
1168
1169/**
1170 * enum ieee80211_sta_state - station state
1171 *
1172 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1173 *	this is a special state for add/remove transitions
1174 * @IEEE80211_STA_NONE: station exists without special state
1175 * @IEEE80211_STA_AUTH: station is authenticated
1176 * @IEEE80211_STA_ASSOC: station is associated
1177 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1178 */
1179enum ieee80211_sta_state {
1180	/* NOTE: These need to be ordered correctly! */
1181	IEEE80211_STA_NOTEXIST,
1182	IEEE80211_STA_NONE,
1183	IEEE80211_STA_AUTH,
1184	IEEE80211_STA_ASSOC,
1185	IEEE80211_STA_AUTHORIZED,
1186};
1187
1188/**
1189 * struct ieee80211_sta - station table entry
1190 *
1191 * A station table entry represents a station we are possibly
1192 * communicating with. Since stations are RCU-managed in
1193 * mac80211, any ieee80211_sta pointer you get access to must
1194 * either be protected by rcu_read_lock() explicitly or implicitly,
1195 * or you must take good care to not use such a pointer after a
1196 * call to your sta_remove callback that removed it.
1197 *
1198 * @addr: MAC address
1199 * @aid: AID we assigned to the station if we're an AP
1200 * @supp_rates: Bitmap of supported rates (per band)
1201 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
1202 * @vht_cap: VHT capabilities of this STA; Not restricting any capabilities
1203 * 	of remote STA. Taking as is.
1204 * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
1205 * @drv_priv: data area for driver use, will always be aligned to
1206 *	sizeof(void *), size is determined in hw information.
1207 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1208 *	if wme is supported.
1209 * @max_sp: max Service Period. Only valid if wme is supported.
1210 */
1211struct ieee80211_sta {
1212	u32 supp_rates[IEEE80211_NUM_BANDS];
1213	u8 addr[ETH_ALEN];
1214	u16 aid;
1215	struct ieee80211_sta_ht_cap ht_cap;
1216	struct ieee80211_sta_vht_cap vht_cap;
1217	bool wme;
1218	u8 uapsd_queues;
1219	u8 max_sp;
1220
1221	/* must be last */
1222	u8 drv_priv[0] __aligned(sizeof(void *));
1223};
1224
1225/**
1226 * enum sta_notify_cmd - sta notify command
1227 *
1228 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1229 * indicates if an associated station made a power state transition.
1230 *
1231 * @STA_NOTIFY_SLEEP: a station is now sleeping
1232 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1233 */
1234enum sta_notify_cmd {
1235	STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1236};
1237
1238/**
1239 * struct ieee80211_tx_control - TX control data
1240 *
1241 * @sta: station table entry, this sta pointer may be NULL and
1242 * 	it is not allowed to copy the pointer, due to RCU.
1243 */
1244struct ieee80211_tx_control {
1245	struct ieee80211_sta *sta;
1246};
1247
1248/**
1249 * enum ieee80211_hw_flags - hardware flags
1250 *
1251 * These flags are used to indicate hardware capabilities to
1252 * the stack. Generally, flags here should have their meaning
1253 * done in a way that the simplest hardware doesn't need setting
1254 * any particular flags. There are some exceptions to this rule,
1255 * however, so you are advised to review these flags carefully.
1256 *
1257 * @IEEE80211_HW_HAS_RATE_CONTROL:
1258 *	The hardware or firmware includes rate control, and cannot be
1259 *	controlled by the stack. As such, no rate control algorithm
1260 *	should be instantiated, and the TX rate reported to userspace
1261 *	will be taken from the TX status instead of the rate control
1262 *	algorithm.
1263 *	Note that this requires that the driver implement a number of
1264 *	callbacks so it has the correct information, it needs to have
1265 *	the @set_rts_threshold callback and must look at the BSS config
1266 *	@use_cts_prot for G/N protection, @use_short_slot for slot
1267 *	timing in 2.4 GHz and @use_short_preamble for preambles for
1268 *	CCK frames.
1269 *
1270 * @IEEE80211_HW_RX_INCLUDES_FCS:
1271 *	Indicates that received frames passed to the stack include
1272 *	the FCS at the end.
1273 *
1274 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1275 *	Some wireless LAN chipsets buffer broadcast/multicast frames
1276 *	for power saving stations in the hardware/firmware and others
1277 *	rely on the host system for such buffering. This option is used
1278 *	to configure the IEEE 802.11 upper layer to buffer broadcast and
1279 *	multicast frames when there are power saving stations so that
1280 *	the driver can fetch them with ieee80211_get_buffered_bc().
1281 *
1282 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1283 *	Hardware is not capable of short slot operation on the 2.4 GHz band.
1284 *
1285 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1286 *	Hardware is not capable of receiving frames with short preamble on
1287 *	the 2.4 GHz band.
1288 *
1289 * @IEEE80211_HW_SIGNAL_UNSPEC:
1290 *	Hardware can provide signal values but we don't know its units. We
1291 *	expect values between 0 and @max_signal.
1292 *	If possible please provide dB or dBm instead.
1293 *
1294 * @IEEE80211_HW_SIGNAL_DBM:
1295 *	Hardware gives signal values in dBm, decibel difference from
1296 *	one milliwatt. This is the preferred method since it is standardized
1297 *	between different devices. @max_signal does not need to be set.
1298 *
1299 * @IEEE80211_HW_SPECTRUM_MGMT:
1300 * 	Hardware supports spectrum management defined in 802.11h
1301 * 	Measurement, Channel Switch, Quieting, TPC
1302 *
1303 * @IEEE80211_HW_AMPDU_AGGREGATION:
1304 *	Hardware supports 11n A-MPDU aggregation.
1305 *
1306 * @IEEE80211_HW_SUPPORTS_PS:
1307 *	Hardware has power save support (i.e. can go to sleep).
1308 *
1309 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1310 *	Hardware requires nullfunc frame handling in stack, implies
1311 *	stack support for dynamic PS.
1312 *
1313 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1314 *	Hardware has support for dynamic PS.
1315 *
1316 * @IEEE80211_HW_MFP_CAPABLE:
1317 *	Hardware supports management frame protection (MFP, IEEE 802.11w).
1318 *
1319 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1320 *	Hardware supports static spatial multiplexing powersave,
1321 *	ie. can turn off all but one chain even on HT connections
1322 *	that should be using more chains.
1323 *
1324 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1325 *	Hardware supports dynamic spatial multiplexing powersave,
1326 *	ie. can turn off all but one chain and then wake the rest
1327 *	up as required after, for example, rts/cts handshake.
1328 *
1329 * @IEEE80211_HW_SUPPORTS_UAPSD:
1330 *	Hardware supports Unscheduled Automatic Power Save Delivery
1331 *	(U-APSD) in managed mode. The mode is configured with
1332 *	conf_tx() operation.
1333 *
1334 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1335 *	Hardware can provide ack status reports of Tx frames to
1336 *	the stack.
1337 *
1338 * @IEEE80211_HW_CONNECTION_MONITOR:
1339 *      The hardware performs its own connection monitoring, including
1340 *      periodic keep-alives to the AP and probing the AP on beacon loss.
1341 *      When this flag is set, signaling beacon-loss will cause an immediate
1342 *      change to disassociated state.
1343 *
1344 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1345 *	This device needs to get data from beacon before association (i.e.
1346 *	dtim_period).
1347 *
1348 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1349 *	per-station GTKs as used by IBSS RSN or during fast transition. If
1350 *	the device doesn't support per-station GTKs, but can be asked not
1351 *	to decrypt group addressed frames, then IBSS RSN support is still
1352 *	possible but software crypto will be used. Advertise the wiphy flag
1353 *	only in that case.
1354 *
1355 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1356 *	autonomously manages the PS status of connected stations. When
1357 *	this flag is set mac80211 will not trigger PS mode for connected
1358 *	stations based on the PM bit of incoming frames.
1359 *	Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1360 *	the PS mode of connected stations.
1361 *
1362 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1363 *	setup strictly in HW. mac80211 should not attempt to do this in
1364 *	software.
1365 *
1366 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1367 *	a virtual monitor interface when monitor interfaces are the only
1368 *	active interfaces.
1369 *
1370 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1371 *	queue mapping in order to use different queues (not just one per AC)
1372 *	for different virtual interfaces. See the doc section on HW queue
1373 *	control for more details.
1374 *
1375 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1376 *	P2P Interface. This will be honoured even if more than one interface
1377 *	is supported.
1378 *
1379 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
1380 *	only, to allow getting TBTT of a DTIM beacon.
1381 */
1382enum ieee80211_hw_flags {
1383	IEEE80211_HW_HAS_RATE_CONTROL			= 1<<0,
1384	IEEE80211_HW_RX_INCLUDES_FCS			= 1<<1,
1385	IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING	= 1<<2,
1386	IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE		= 1<<3,
1387	IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE	= 1<<4,
1388	IEEE80211_HW_SIGNAL_UNSPEC			= 1<<5,
1389	IEEE80211_HW_SIGNAL_DBM				= 1<<6,
1390	IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC		= 1<<7,
1391	IEEE80211_HW_SPECTRUM_MGMT			= 1<<8,
1392	IEEE80211_HW_AMPDU_AGGREGATION			= 1<<9,
1393	IEEE80211_HW_SUPPORTS_PS			= 1<<10,
1394	IEEE80211_HW_PS_NULLFUNC_STACK			= 1<<11,
1395	IEEE80211_HW_SUPPORTS_DYNAMIC_PS		= 1<<12,
1396	IEEE80211_HW_MFP_CAPABLE			= 1<<13,
1397	IEEE80211_HW_WANT_MONITOR_VIF			= 1<<14,
1398	IEEE80211_HW_SUPPORTS_STATIC_SMPS		= 1<<15,
1399	IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS		= 1<<16,
1400	IEEE80211_HW_SUPPORTS_UAPSD			= 1<<17,
1401	IEEE80211_HW_REPORTS_TX_ACK_STATUS		= 1<<18,
1402	IEEE80211_HW_CONNECTION_MONITOR			= 1<<19,
1403	IEEE80211_HW_QUEUE_CONTROL			= 1<<20,
1404	IEEE80211_HW_SUPPORTS_PER_STA_GTK		= 1<<21,
1405	IEEE80211_HW_AP_LINK_PS				= 1<<22,
1406	IEEE80211_HW_TX_AMPDU_SETUP_IN_HW		= 1<<23,
1407	IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF		= 1<<25,
1408	IEEE80211_HW_TIMING_BEACON_ONLY			= 1<<26,
1409};
1410
1411/**
1412 * struct ieee80211_hw - hardware information and state
1413 *
1414 * This structure contains the configuration and hardware
1415 * information for an 802.11 PHY.
1416 *
1417 * @wiphy: This points to the &struct wiphy allocated for this
1418 *	802.11 PHY. You must fill in the @perm_addr and @dev
1419 *	members of this structure using SET_IEEE80211_DEV()
1420 *	and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1421 *	bands (with channels, bitrates) are registered here.
1422 *
1423 * @conf: &struct ieee80211_conf, device configuration, don't use.
1424 *
1425 * @priv: pointer to private area that was allocated for driver use
1426 *	along with this structure.
1427 *
1428 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1429 *
1430 * @extra_tx_headroom: headroom to reserve in each transmit skb
1431 *	for use by the driver (e.g. for transmit headers.)
1432 *
1433 * @channel_change_time: time (in microseconds) it takes to change channels.
1434 *
1435 * @max_signal: Maximum value for signal (rssi) in RX information, used
1436 *     only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1437 *
1438 * @max_listen_interval: max listen interval in units of beacon interval
1439 *     that HW supports
1440 *
1441 * @queues: number of available hardware transmit queues for
1442 *	data packets. WMM/QoS requires at least four, these
1443 *	queues need to have configurable access parameters.
1444 *
1445 * @rate_control_algorithm: rate control algorithm for this hardware.
1446 *	If unset (NULL), the default algorithm will be used. Must be
1447 *	set before calling ieee80211_register_hw().
1448 *
1449 * @vif_data_size: size (in bytes) of the drv_priv data area
1450 *	within &struct ieee80211_vif.
1451 * @sta_data_size: size (in bytes) of the drv_priv data area
1452 *	within &struct ieee80211_sta.
1453 * @chanctx_data_size: size (in bytes) of the drv_priv data area
1454 *	within &struct ieee80211_chanctx_conf.
1455 *
1456 * @max_rates: maximum number of alternate rate retry stages the hw
1457 *	can handle.
1458 * @max_report_rates: maximum number of alternate rate retry stages
1459 *	the hw can report back.
1460 * @max_rate_tries: maximum number of tries for each stage
1461 *
1462 * @napi_weight: weight used for NAPI polling.  You must specify an
1463 *	appropriate value here if a napi_poll operation is provided
1464 *	by your driver.
1465 *
1466 * @max_rx_aggregation_subframes: maximum buffer size (number of
1467 *	sub-frames) to be used for A-MPDU block ack receiver
1468 *	aggregation.
1469 *	This is only relevant if the device has restrictions on the
1470 *	number of subframes, if it relies on mac80211 to do reordering
1471 *	it shouldn't be set.
1472 *
1473 * @max_tx_aggregation_subframes: maximum number of subframes in an
1474 *	aggregate an HT driver will transmit, used by the peer as a
1475 *	hint to size its reorder buffer.
1476 *
1477 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
1478 *	(if %IEEE80211_HW_QUEUE_CONTROL is set)
1479 *
1480 * @radiotap_mcs_details: lists which MCS information can the HW
1481 *	reports, by default it is set to _MCS, _GI and _BW but doesn't
1482 *	include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
1483 *	adding _BW is supported today.
1484 *
1485 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
1486 *	the default is _GI | _BANDWIDTH.
1487 *	Use the %IEEE80211_RADIOTAP_VHT_KNOWN_* values.
1488 *
1489 * @netdev_features: netdev features to be set in each netdev created
1490 *	from this HW. Note only HW checksum features are currently
1491 *	compatible with mac80211. Other feature bits will be rejected.
1492 */
1493struct ieee80211_hw {
1494	struct ieee80211_conf conf;
1495	struct wiphy *wiphy;
1496	const char *rate_control_algorithm;
1497	void *priv;
1498	u32 flags;
1499	unsigned int extra_tx_headroom;
1500	int channel_change_time;
1501	int vif_data_size;
1502	int sta_data_size;
1503	int chanctx_data_size;
1504	int napi_weight;
1505	u16 queues;
1506	u16 max_listen_interval;
1507	s8 max_signal;
1508	u8 max_rates;
1509	u8 max_report_rates;
1510	u8 max_rate_tries;
1511	u8 max_rx_aggregation_subframes;
1512	u8 max_tx_aggregation_subframes;
1513	u8 offchannel_tx_hw_queue;
1514	u8 radiotap_mcs_details;
1515	u16 radiotap_vht_details;
1516	netdev_features_t netdev_features;
1517};
1518
1519/**
1520 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1521 *
1522 * @wiphy: the &struct wiphy which we want to query
1523 *
1524 * mac80211 drivers can use this to get to their respective
1525 * &struct ieee80211_hw. Drivers wishing to get to their own private
1526 * structure can then access it via hw->priv. Note that mac802111 drivers should
1527 * not use wiphy_priv() to try to get their private driver structure as this
1528 * is already used internally by mac80211.
1529 *
1530 * Return: The mac80211 driver hw struct of @wiphy.
1531 */
1532struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1533
1534/**
1535 * SET_IEEE80211_DEV - set device for 802.11 hardware
1536 *
1537 * @hw: the &struct ieee80211_hw to set the device for
1538 * @dev: the &struct device of this 802.11 device
1539 */
1540static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1541{
1542	set_wiphy_dev(hw->wiphy, dev);
1543}
1544
1545/**
1546 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1547 *
1548 * @hw: the &struct ieee80211_hw to set the MAC address for
1549 * @addr: the address to set
1550 */
1551static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1552{
1553	memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1554}
1555
1556static inline struct ieee80211_rate *
1557ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1558		      const struct ieee80211_tx_info *c)
1559{
1560	if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
1561		return NULL;
1562	return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1563}
1564
1565static inline struct ieee80211_rate *
1566ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1567			   const struct ieee80211_tx_info *c)
1568{
1569	if (c->control.rts_cts_rate_idx < 0)
1570		return NULL;
1571	return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1572}
1573
1574static inline struct ieee80211_rate *
1575ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1576			     const struct ieee80211_tx_info *c, int idx)
1577{
1578	if (c->control.rates[idx + 1].idx < 0)
1579		return NULL;
1580	return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1581}
1582
1583/**
1584 * ieee80211_free_txskb - free TX skb
1585 * @hw: the hardware
1586 * @skb: the skb
1587 *
1588 * Free a transmit skb. Use this funtion when some failure
1589 * to transmit happened and thus status cannot be reported.
1590 */
1591void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
1592
1593/**
1594 * DOC: Hardware crypto acceleration
1595 *
1596 * mac80211 is capable of taking advantage of many hardware
1597 * acceleration designs for encryption and decryption operations.
1598 *
1599 * The set_key() callback in the &struct ieee80211_ops for a given
1600 * device is called to enable hardware acceleration of encryption and
1601 * decryption. The callback takes a @sta parameter that will be NULL
1602 * for default keys or keys used for transmission only, or point to
1603 * the station information for the peer for individual keys.
1604 * Multiple transmission keys with the same key index may be used when
1605 * VLANs are configured for an access point.
1606 *
1607 * When transmitting, the TX control data will use the @hw_key_idx
1608 * selected by the driver by modifying the &struct ieee80211_key_conf
1609 * pointed to by the @key parameter to the set_key() function.
1610 *
1611 * The set_key() call for the %SET_KEY command should return 0 if
1612 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1613 * added; if you return 0 then hw_key_idx must be assigned to the
1614 * hardware key index, you are free to use the full u8 range.
1615 *
1616 * When the cmd is %DISABLE_KEY then it must succeed.
1617 *
1618 * Note that it is permissible to not decrypt a frame even if a key
1619 * for it has been uploaded to hardware, the stack will not make any
1620 * decision based on whether a key has been uploaded or not but rather
1621 * based on the receive flags.
1622 *
1623 * The &struct ieee80211_key_conf structure pointed to by the @key
1624 * parameter is guaranteed to be valid until another call to set_key()
1625 * removes it, but it can only be used as a cookie to differentiate
1626 * keys.
1627 *
1628 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1629 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1630 * handler.
1631 * The update_tkip_key() call updates the driver with the new phase 1 key.
1632 * This happens every time the iv16 wraps around (every 65536 packets). The
1633 * set_key() call will happen only once for each key (unless the AP did
1634 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1635 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1636 * handler is software decryption with wrap around of iv16.
1637 *
1638 * The set_default_unicast_key() call updates the default WEP key index
1639 * configured to the hardware for WEP encryption type. This is required
1640 * for devices that support offload of data packets (e.g. ARP responses).
1641 */
1642
1643/**
1644 * DOC: Powersave support
1645 *
1646 * mac80211 has support for various powersave implementations.
1647 *
1648 * First, it can support hardware that handles all powersaving by itself,
1649 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1650 * flag. In that case, it will be told about the desired powersave mode
1651 * with the %IEEE80211_CONF_PS flag depending on the association status.
1652 * The hardware must take care of sending nullfunc frames when necessary,
1653 * i.e. when entering and leaving powersave mode. The hardware is required
1654 * to look at the AID in beacons and signal to the AP that it woke up when
1655 * it finds traffic directed to it.
1656 *
1657 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1658 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1659 * with hardware wakeup and sleep states. Driver is responsible for waking
1660 * up the hardware before issuing commands to the hardware and putting it
1661 * back to sleep at appropriate times.
1662 *
1663 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1664 * buffered multicast/broadcast frames after the beacon. Also it must be
1665 * possible to send frames and receive the acknowledment frame.
1666 *
1667 * Other hardware designs cannot send nullfunc frames by themselves and also
1668 * need software support for parsing the TIM bitmap. This is also supported
1669 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1670 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1671 * required to pass up beacons. The hardware is still required to handle
1672 * waking up for multicast traffic; if it cannot the driver must handle that
1673 * as best as it can, mac80211 is too slow to do that.
1674 *
1675 * Dynamic powersave is an extension to normal powersave in which the
1676 * hardware stays awake for a user-specified period of time after sending a
1677 * frame so that reply frames need not be buffered and therefore delayed to
1678 * the next wakeup. It's compromise of getting good enough latency when
1679 * there's data traffic and still saving significantly power in idle
1680 * periods.
1681 *
1682 * Dynamic powersave is simply supported by mac80211 enabling and disabling
1683 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1684 * flag and mac80211 will handle everything automatically. Additionally,
1685 * hardware having support for the dynamic PS feature may set the
1686 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1687 * dynamic PS mode itself. The driver needs to look at the
1688 * @dynamic_ps_timeout hardware configuration value and use it that value
1689 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1690 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1691 * enabled whenever user has enabled powersave.
1692 *
1693 * Driver informs U-APSD client support by enabling
1694 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1695 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1696 * Nullfunc frames and stay awake until the service period has ended. To
1697 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1698 * from that AC are transmitted with powersave enabled.
1699 *
1700 * Note: U-APSD client mode is not yet supported with
1701 * %IEEE80211_HW_PS_NULLFUNC_STACK.
1702 */
1703
1704/**
1705 * DOC: Beacon filter support
1706 *
1707 * Some hardware have beacon filter support to reduce host cpu wakeups
1708 * which will reduce system power consumption. It usually works so that
1709 * the firmware creates a checksum of the beacon but omits all constantly
1710 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1711 * beacon is forwarded to the host, otherwise it will be just dropped. That
1712 * way the host will only receive beacons where some relevant information
1713 * (for example ERP protection or WMM settings) have changed.
1714 *
1715 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
1716 * interface capability. The driver needs to enable beacon filter support
1717 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1718 * power save is enabled, the stack will not check for beacon loss and the
1719 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1720 *
1721 * The time (or number of beacons missed) until the firmware notifies the
1722 * driver of a beacon loss event (which in turn causes the driver to call
1723 * ieee80211_beacon_loss()) should be configurable and will be controlled
1724 * by mac80211 and the roaming algorithm in the future.
1725 *
1726 * Since there may be constantly changing information elements that nothing
1727 * in the software stack cares about, we will, in the future, have mac80211
1728 * tell the driver which information elements are interesting in the sense
1729 * that we want to see changes in them. This will include
1730 *  - a list of information element IDs
1731 *  - a list of OUIs for the vendor information element
1732 *
1733 * Ideally, the hardware would filter out any beacons without changes in the
1734 * requested elements, but if it cannot support that it may, at the expense
1735 * of some efficiency, filter out only a subset. For example, if the device
1736 * doesn't support checking for OUIs it should pass up all changes in all
1737 * vendor information elements.
1738 *
1739 * Note that change, for the sake of simplification, also includes information
1740 * elements appearing or disappearing from the beacon.
1741 *
1742 * Some hardware supports an "ignore list" instead, just make sure nothing
1743 * that was requested is on the ignore list, and include commonly changing
1744 * information element IDs in the ignore list, for example 11 (BSS load) and
1745 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1746 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1747 * it could also include some currently unused IDs.
1748 *
1749 *
1750 * In addition to these capabilities, hardware should support notifying the
1751 * host of changes in the beacon RSSI. This is relevant to implement roaming
1752 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1753 * the received data packets). This can consist in notifying the host when
1754 * the RSSI changes significantly or when it drops below or rises above
1755 * configurable thresholds. In the future these thresholds will also be
1756 * configured by mac80211 (which gets them from userspace) to implement
1757 * them as the roaming algorithm requires.
1758 *
1759 * If the hardware cannot implement this, the driver should ask it to
1760 * periodically pass beacon frames to the host so that software can do the
1761 * signal strength threshold checking.
1762 */
1763
1764/**
1765 * DOC: Spatial multiplexing power save
1766 *
1767 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1768 * power in an 802.11n implementation. For details on the mechanism
1769 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1770 * "11.2.3 SM power save".
1771 *
1772 * The mac80211 implementation is capable of sending action frames
1773 * to update the AP about the station's SMPS mode, and will instruct
1774 * the driver to enter the specific mode. It will also announce the
1775 * requested SMPS mode during the association handshake. Hardware
1776 * support for this feature is required, and can be indicated by
1777 * hardware flags.
1778 *
1779 * The default mode will be "automatic", which nl80211/cfg80211
1780 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1781 * turned off otherwise.
1782 *
1783 * To support this feature, the driver must set the appropriate
1784 * hardware support flags, and handle the SMPS flag to the config()
1785 * operation. It will then with this mechanism be instructed to
1786 * enter the requested SMPS mode while associated to an HT AP.
1787 */
1788
1789/**
1790 * DOC: Frame filtering
1791 *
1792 * mac80211 requires to see many management frames for proper
1793 * operation, and users may want to see many more frames when
1794 * in monitor mode. However, for best CPU usage and power consumption,
1795 * having as few frames as possible percolate through the stack is
1796 * desirable. Hence, the hardware should filter as much as possible.
1797 *
1798 * To achieve this, mac80211 uses filter flags (see below) to tell
1799 * the driver's configure_filter() function which frames should be
1800 * passed to mac80211 and which should be filtered out.
1801 *
1802 * Before configure_filter() is invoked, the prepare_multicast()
1803 * callback is invoked with the parameters @mc_count and @mc_list
1804 * for the combined multicast address list of all virtual interfaces.
1805 * It's use is optional, and it returns a u64 that is passed to
1806 * configure_filter(). Additionally, configure_filter() has the
1807 * arguments @changed_flags telling which flags were changed and
1808 * @total_flags with the new flag states.
1809 *
1810 * If your device has no multicast address filters your driver will
1811 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1812 * parameter to see whether multicast frames should be accepted
1813 * or dropped.
1814 *
1815 * All unsupported flags in @total_flags must be cleared.
1816 * Hardware does not support a flag if it is incapable of _passing_
1817 * the frame to the stack. Otherwise the driver must ignore
1818 * the flag, but not clear it.
1819 * You must _only_ clear the flag (announce no support for the
1820 * flag to mac80211) if you are not able to pass the packet type
1821 * to the stack (so the hardware always filters it).
1822 * So for example, you should clear @FIF_CONTROL, if your hardware
1823 * always filters control frames. If your hardware always passes
1824 * control frames to the kernel and is incapable of filtering them,
1825 * you do _not_ clear the @FIF_CONTROL flag.
1826 * This rule applies to all other FIF flags as well.
1827 */
1828
1829/**
1830 * DOC: AP support for powersaving clients
1831 *
1832 * In order to implement AP and P2P GO modes, mac80211 has support for
1833 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
1834 * There currently is no support for sAPSD.
1835 *
1836 * There is one assumption that mac80211 makes, namely that a client
1837 * will not poll with PS-Poll and trigger with uAPSD at the same time.
1838 * Both are supported, and both can be used by the same client, but
1839 * they can't be used concurrently by the same client. This simplifies
1840 * the driver code.
1841 *
1842 * The first thing to keep in mind is that there is a flag for complete
1843 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
1844 * mac80211 expects the driver to handle most of the state machine for
1845 * powersaving clients and will ignore the PM bit in incoming frames.
1846 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
1847 * stations' powersave transitions. In this mode, mac80211 also doesn't
1848 * handle PS-Poll/uAPSD.
1849 *
1850 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
1851 * PM bit in incoming frames for client powersave transitions. When a
1852 * station goes to sleep, we will stop transmitting to it. There is,
1853 * however, a race condition: a station might go to sleep while there is
1854 * data buffered on hardware queues. If the device has support for this
1855 * it will reject frames, and the driver should give the frames back to
1856 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
1857 * cause mac80211 to retry the frame when the station wakes up. The
1858 * driver is also notified of powersave transitions by calling its
1859 * @sta_notify callback.
1860 *
1861 * When the station is asleep, it has three choices: it can wake up,
1862 * it can PS-Poll, or it can possibly start a uAPSD service period.
1863 * Waking up is implemented by simply transmitting all buffered (and
1864 * filtered) frames to the station. This is the easiest case. When
1865 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
1866 * will inform the driver of this with the @allow_buffered_frames
1867 * callback; this callback is optional. mac80211 will then transmit
1868 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
1869 * on each frame. The last frame in the service period (or the only
1870 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
1871 * indicate that it ends the service period; as this frame must have
1872 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
1873 * When TX status is reported for this frame, the service period is
1874 * marked has having ended and a new one can be started by the peer.
1875 *
1876 * Additionally, non-bufferable MMPDUs can also be transmitted by
1877 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
1878 *
1879 * Another race condition can happen on some devices like iwlwifi
1880 * when there are frames queued for the station and it wakes up
1881 * or polls; the frames that are already queued could end up being
1882 * transmitted first instead, causing reordering and/or wrong
1883 * processing of the EOSP. The cause is that allowing frames to be
1884 * transmitted to a certain station is out-of-band communication to
1885 * the device. To allow this problem to be solved, the driver can
1886 * call ieee80211_sta_block_awake() if frames are buffered when it
1887 * is notified that the station went to sleep. When all these frames
1888 * have been filtered (see above), it must call the function again
1889 * to indicate that the station is no longer blocked.
1890 *
1891 * If the driver buffers frames in the driver for aggregation in any
1892 * way, it must use the ieee80211_sta_set_buffered() call when it is
1893 * notified of the station going to sleep to inform mac80211 of any
1894 * TIDs that have frames buffered. Note that when a station wakes up
1895 * this information is reset (hence the requirement to call it when
1896 * informed of the station going to sleep). Then, when a service
1897 * period starts for any reason, @release_buffered_frames is called
1898 * with the number of frames to be released and which TIDs they are
1899 * to come from. In this case, the driver is responsible for setting
1900 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
1901 * to help the @more_data paramter is passed to tell the driver if
1902 * there is more data on other TIDs -- the TIDs to release frames
1903 * from are ignored since mac80211 doesn't know how many frames the
1904 * buffers for those TIDs contain.
1905 *
1906 * If the driver also implement GO mode, where absence periods may
1907 * shorten service periods (or abort PS-Poll responses), it must
1908 * filter those response frames except in the case of frames that
1909 * are buffered in the driver -- those must remain buffered to avoid
1910 * reordering. Because it is possible that no frames are released
1911 * in this case, the driver must call ieee80211_sta_eosp_irqsafe()
1912 * to indicate to mac80211 that the service period ended anyway.
1913 *
1914 * Finally, if frames from multiple TIDs are released from mac80211
1915 * but the driver might reorder them, it must clear & set the flags
1916 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
1917 * and also take care of the EOSP and MORE_DATA bits in the frame.
1918 * The driver may also use ieee80211_sta_eosp_irqsafe() in this case.
1919 */
1920
1921/**
1922 * DOC: HW queue control
1923 *
1924 * Before HW queue control was introduced, mac80211 only had a single static
1925 * assignment of per-interface AC software queues to hardware queues. This
1926 * was problematic for a few reasons:
1927 * 1) off-channel transmissions might get stuck behind other frames
1928 * 2) multiple virtual interfaces couldn't be handled correctly
1929 * 3) after-DTIM frames could get stuck behind other frames
1930 *
1931 * To solve this, hardware typically uses multiple different queues for all
1932 * the different usages, and this needs to be propagated into mac80211 so it
1933 * won't have the same problem with the software queues.
1934 *
1935 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
1936 * flag that tells it that the driver implements its own queue control. To do
1937 * so, the driver will set up the various queues in each &struct ieee80211_vif
1938 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
1939 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
1940 * if necessary will queue the frame on the right software queue that mirrors
1941 * the hardware queue.
1942 * Additionally, the driver has to then use these HW queue IDs for the queue
1943 * management functions (ieee80211_stop_queue() et al.)
1944 *
1945 * The driver is free to set up the queue mappings as needed, multiple virtual
1946 * interfaces may map to the same hardware queues if needed. The setup has to
1947 * happen during add_interface or change_interface callbacks. For example, a
1948 * driver supporting station+station and station+AP modes might decide to have
1949 * 10 hardware queues to handle different scenarios:
1950 *
1951 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
1952 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
1953 * after-DTIM queue for AP:   8
1954 * off-channel queue:         9
1955 *
1956 * It would then set up the hardware like this:
1957 *   hw.offchannel_tx_hw_queue = 9
1958 *
1959 * and the first virtual interface that is added as follows:
1960 *   vif.hw_queue[IEEE80211_AC_VO] = 0
1961 *   vif.hw_queue[IEEE80211_AC_VI] = 1
1962 *   vif.hw_queue[IEEE80211_AC_BE] = 2
1963 *   vif.hw_queue[IEEE80211_AC_BK] = 3
1964 *   vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
1965 * and the second virtual interface with 4-7.
1966 *
1967 * If queue 6 gets full, for example, mac80211 would only stop the second
1968 * virtual interface's BE queue since virtual interface queues are per AC.
1969 *
1970 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
1971 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
1972 * queue could potentially be shared since mac80211 will look at cab_queue when
1973 * a queue is stopped/woken even if the interface is not in AP mode.
1974 */
1975
1976/**
1977 * enum ieee80211_filter_flags - hardware filter flags
1978 *
1979 * These flags determine what the filter in hardware should be
1980 * programmed to let through and what should not be passed to the
1981 * stack. It is always safe to pass more frames than requested,
1982 * but this has negative impact on power consumption.
1983 *
1984 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1985 *	think of the BSS as your network segment and then this corresponds
1986 *	to the regular ethernet device promiscuous mode.
1987 *
1988 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1989 *	by the user or if the hardware is not capable of filtering by
1990 *	multicast address.
1991 *
1992 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1993 *	%RX_FLAG_FAILED_FCS_CRC for them)
1994 *
1995 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1996 *	the %RX_FLAG_FAILED_PLCP_CRC for them
1997 *
1998 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1999 *	to the hardware that it should not filter beacons or probe responses
2000 *	by BSSID. Filtering them can greatly reduce the amount of processing
2001 *	mac80211 needs to do and the amount of CPU wakeups, so you should
2002 *	honour this flag if possible.
2003 *
2004 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
2005 * 	is not set then only those addressed to this station.
2006 *
2007 * @FIF_OTHER_BSS: pass frames destined to other BSSes
2008 *
2009 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
2010 * 	those addressed to this station.
2011 *
2012 * @FIF_PROBE_REQ: pass probe request frames
2013 */
2014enum ieee80211_filter_flags {
2015	FIF_PROMISC_IN_BSS	= 1<<0,
2016	FIF_ALLMULTI		= 1<<1,
2017	FIF_FCSFAIL		= 1<<2,
2018	FIF_PLCPFAIL		= 1<<3,
2019	FIF_BCN_PRBRESP_PROMISC	= 1<<4,
2020	FIF_CONTROL		= 1<<5,
2021	FIF_OTHER_BSS		= 1<<6,
2022	FIF_PSPOLL		= 1<<7,
2023	FIF_PROBE_REQ		= 1<<8,
2024};
2025
2026/**
2027 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2028 *
2029 * These flags are used with the ampdu_action() callback in
2030 * &struct ieee80211_ops to indicate which action is needed.
2031 *
2032 * Note that drivers MUST be able to deal with a TX aggregation
2033 * session being stopped even before they OK'ed starting it by
2034 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2035 * might receive the addBA frame and send a delBA right away!
2036 *
2037 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2038 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2039 * @IEEE80211_AMPDU_TX_START: start TX aggregation
2040 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2041 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2042 *	queued packets, now unaggregated. After all packets are transmitted the
2043 *	driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2044 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2045 *	called when the station is removed. There's no need or reason to call
2046 *	ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2047 *	session is gone and removes the station.
2048 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2049 *	but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2050 *	now the connection is dropped and the station will be removed. Drivers
2051 *	should clean up and drop remaining packets when this is called.
2052 */
2053enum ieee80211_ampdu_mlme_action {
2054	IEEE80211_AMPDU_RX_START,
2055	IEEE80211_AMPDU_RX_STOP,
2056	IEEE80211_AMPDU_TX_START,
2057	IEEE80211_AMPDU_TX_STOP_CONT,
2058	IEEE80211_AMPDU_TX_STOP_FLUSH,
2059	IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
2060	IEEE80211_AMPDU_TX_OPERATIONAL,
2061};
2062
2063/**
2064 * enum ieee80211_frame_release_type - frame release reason
2065 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2066 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2067 *	frame received on trigger-enabled AC
2068 */
2069enum ieee80211_frame_release_type {
2070	IEEE80211_FRAME_RELEASE_PSPOLL,
2071	IEEE80211_FRAME_RELEASE_UAPSD,
2072};
2073
2074/**
2075 * enum ieee80211_rate_control_changed - flags to indicate what changed
2076 *
2077 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2078 *	to this station changed.
2079 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2080 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2081 *	changed (in IBSS mode) due to discovering more information about
2082 *	the peer.
2083 */
2084enum ieee80211_rate_control_changed {
2085	IEEE80211_RC_BW_CHANGED		= BIT(0),
2086	IEEE80211_RC_SMPS_CHANGED	= BIT(1),
2087	IEEE80211_RC_SUPP_RATES_CHANGED	= BIT(2),
2088};
2089
2090/**
2091 * struct ieee80211_ops - callbacks from mac80211 to the driver
2092 *
2093 * This structure contains various callbacks that the driver may
2094 * handle or, in some cases, must handle, for example to configure
2095 * the hardware to a new channel or to transmit a frame.
2096 *
2097 * @tx: Handler that 802.11 module calls for each transmitted frame.
2098 *	skb contains the buffer starting from the IEEE 802.11 header.
2099 *	The low-level driver should send the frame out based on
2100 *	configuration in the TX control data. This handler should,
2101 *	preferably, never fail and stop queues appropriately.
2102 *	Must be atomic.
2103 *
2104 * @start: Called before the first netdevice attached to the hardware
2105 *	is enabled. This should turn on the hardware and must turn on
2106 *	frame reception (for possibly enabled monitor interfaces.)
2107 *	Returns negative error codes, these may be seen in userspace,
2108 *	or zero.
2109 *	When the device is started it should not have a MAC address
2110 *	to avoid acknowledging frames before a non-monitor device
2111 *	is added.
2112 *	Must be implemented and can sleep.
2113 *
2114 * @stop: Called after last netdevice attached to the hardware
2115 *	is disabled. This should turn off the hardware (at least
2116 *	it must turn off frame reception.)
2117 *	May be called right after add_interface if that rejects
2118 *	an interface. If you added any work onto the mac80211 workqueue
2119 *	you should ensure to cancel it on this callback.
2120 *	Must be implemented and can sleep.
2121 *
2122 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2123 *	stop transmitting and doing any other configuration, and then
2124 *	ask the device to suspend. This is only invoked when WoWLAN is
2125 *	configured, otherwise the device is deconfigured completely and
2126 *	reconfigured at resume time.
2127 *	The driver may also impose special conditions under which it
2128 *	wants to use the "normal" suspend (deconfigure), say if it only
2129 *	supports WoWLAN when the device is associated. In this case, it
2130 *	must return 1 from this function.
2131 *
2132 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2133 *	now resuming its operation, after this the device must be fully
2134 *	functional again. If this returns an error, the only way out is
2135 *	to also unregister the device. If it returns 1, then mac80211
2136 *	will also go through the regular complete restart on resume.
2137 *
2138 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2139 *	modified. The reason is that device_set_wakeup_enable() is
2140 *	supposed to be called when the configuration changes, not only
2141 *	in suspend().
2142 *
2143 * @add_interface: Called when a netdevice attached to the hardware is
2144 *	enabled. Because it is not called for monitor mode devices, @start
2145 *	and @stop must be implemented.
2146 *	The driver should perform any initialization it needs before
2147 *	the device can be enabled. The initial configuration for the
2148 *	interface is given in the conf parameter.
2149 *	The callback may refuse to add an interface by returning a
2150 *	negative error code (which will be seen in userspace.)
2151 *	Must be implemented and can sleep.
2152 *
2153 * @change_interface: Called when a netdevice changes type. This callback
2154 *	is optional, but only if it is supported can interface types be
2155 *	switched while the interface is UP. The callback may sleep.
2156 *	Note that while an interface is being switched, it will not be
2157 *	found by the interface iteration callbacks.
2158 *
2159 * @remove_interface: Notifies a driver that an interface is going down.
2160 *	The @stop callback is called after this if it is the last interface
2161 *	and no monitor interfaces are present.
2162 *	When all interfaces are removed, the MAC address in the hardware
2163 *	must be cleared so the device no longer acknowledges packets,
2164 *	the mac_addr member of the conf structure is, however, set to the
2165 *	MAC address of the device going away.
2166 *	Hence, this callback must be implemented. It can sleep.
2167 *
2168 * @add_interface_debugfs: Drivers can use this callback to add debugfs files
2169 *	when a vif is added to mac80211. This callback and
2170 *	@remove_interface_debugfs should be within a CONFIG_MAC80211_DEBUGFS
2171 *	conditional. @remove_interface_debugfs must be provided for cleanup.
2172 *	This callback can sleep.
2173 *
2174 * @remove_interface_debugfs: Remove the debugfs files which were added using
2175 *	@add_interface_debugfs. This callback must remove all debugfs entries
2176 *	that were added because mac80211 only removes interface debugfs when the
2177 *	interface is destroyed, not when it is removed from the driver.
2178 *	This callback can sleep.
2179 *
2180 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2181 *	function to change hardware configuration, e.g., channel.
2182 *	This function should never fail but returns a negative error code
2183 *	if it does. The callback can sleep.
2184 *
2185 * @bss_info_changed: Handler for configuration requests related to BSS
2186 *	parameters that may vary during BSS's lifespan, and may affect low
2187 *	level driver (e.g. assoc/disassoc status, erp parameters).
2188 *	This function should not be used if no BSS has been set, unless
2189 *	for association indication. The @changed parameter indicates which
2190 *	of the bss parameters has changed when a call is made. The callback
2191 *	can sleep.
2192 *
2193 * @prepare_multicast: Prepare for multicast filter configuration.
2194 *	This callback is optional, and its return value is passed
2195 *	to configure_filter(). This callback must be atomic.
2196 *
2197 * @configure_filter: Configure the device's RX filter.
2198 *	See the section "Frame filtering" for more information.
2199 *	This callback must be implemented and can sleep.
2200 *
2201 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
2202 * 	must be set or cleared for a given STA. Must be atomic.
2203 *
2204 * @set_key: See the section "Hardware crypto acceleration"
2205 *	This callback is only called between add_interface and
2206 *	remove_interface calls, i.e. while the given virtual interface
2207 *	is enabled.
2208 *	Returns a negative error code if the key can't be added.
2209 *	The callback can sleep.
2210 *
2211 * @update_tkip_key: See the section "Hardware crypto acceleration"
2212 * 	This callback will be called in the context of Rx. Called for drivers
2213 * 	which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
2214 *	The callback must be atomic.
2215 *
2216 * @set_rekey_data: If the device supports GTK rekeying, for example while the
2217 *	host is suspended, it can assign this callback to retrieve the data
2218 *	necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2219 *	After rekeying was done it should (for example during resume) notify
2220 *	userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2221 *
2222 * @set_default_unicast_key: Set the default (unicast) key index, useful for
2223 *	WEP when the device sends data packets autonomously, e.g. for ARP
2224 *	offloading. The index can be 0-3, or -1 for unsetting it.
2225 *
2226 * @hw_scan: Ask the hardware to service the scan request, no need to start
2227 *	the scan state machine in stack. The scan must honour the channel
2228 *	configuration done by the regulatory agent in the wiphy's
2229 *	registered bands. The hardware (or the driver) needs to make sure
2230 *	that power save is disabled.
2231 *	The @req ie/ie_len members are rewritten by mac80211 to contain the
2232 *	entire IEs after the SSID, so that drivers need not look at these
2233 *	at all but just send them after the SSID -- mac80211 includes the
2234 *	(extended) supported rates and HT information (where applicable).
2235 *	When the scan finishes, ieee80211_scan_completed() must be called;
2236 *	note that it also must be called when the scan cannot finish due to
2237 *	any error unless this callback returned a negative error code.
2238 *	The callback can sleep.
2239 *
2240 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2241 *	The driver should ask the hardware to cancel the scan (if possible),
2242 *	but the scan will be completed only after the driver will call
2243 *	ieee80211_scan_completed().
2244 *	This callback is needed for wowlan, to prevent enqueueing a new
2245 *	scan_work after the low-level driver was already suspended.
2246 *	The callback can sleep.
2247 *
2248 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2249 *	specific intervals.  The driver must call the
2250 *	ieee80211_sched_scan_results() function whenever it finds results.
2251 *	This process will continue until sched_scan_stop is called.
2252 *
2253 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
2254 *
2255 * @sw_scan_start: Notifier function that is called just before a software scan
2256 *	is started. Can be NULL, if the driver doesn't need this notification.
2257 *	The callback can sleep.
2258 *
2259 * @sw_scan_complete: Notifier function that is called just after a
2260 *	software scan finished. Can be NULL, if the driver doesn't need
2261 *	this notification.
2262 *	The callback can sleep.
2263 *
2264 * @get_stats: Return low-level statistics.
2265 * 	Returns zero if statistics are available.
2266 *	The callback can sleep.
2267 *
2268 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
2269 *	callback should be provided to read the TKIP transmit IVs (both IV32
2270 *	and IV16) for the given key from hardware.
2271 *	The callback must be atomic.
2272 *
2273 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
2274 *	if the device does fragmentation by itself; if this callback is
2275 *	implemented then the stack will not do fragmentation.
2276 *	The callback can sleep.
2277 *
2278 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
2279 *	The callback can sleep.
2280 *
2281 * @sta_add: Notifies low level driver about addition of an associated station,
2282 *	AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2283 *
2284 * @sta_remove: Notifies low level driver about removal of an associated
2285 *	station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2286 *
2287 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
2288 *	when a station is added to mac80211's station list. This callback
2289 *	and @sta_remove_debugfs should be within a CONFIG_MAC80211_DEBUGFS
2290 *	conditional. This callback can sleep.
2291 *
2292 * @sta_remove_debugfs: Remove the debugfs files which were added using
2293 *	@sta_add_debugfs. This callback can sleep.
2294 *
2295 * @sta_notify: Notifies low level driver about power state transition of an
2296 *	associated station, AP,  IBSS/WDS/mesh peer etc. For a VIF operating
2297 *	in AP mode, this callback will not be called when the flag
2298 *	%IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
2299 *
2300 * @sta_state: Notifies low level driver about state transition of a
2301 *	station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
2302 *	This callback is mutually exclusive with @sta_add/@sta_remove.
2303 *	It must not fail for down transitions but may fail for transitions
2304 *	up the list of states.
2305 *	The callback can sleep.
2306 *
2307 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
2308 *	used to transmit to the station. The changes are advertised with bits
2309 *	from &enum ieee80211_rate_control_changed and the values are reflected
2310 *	in the station data. This callback should only be used when the driver
2311 *	uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
2312 *	otherwise the rate control algorithm is notified directly.
2313 *	Must be atomic.
2314 *
2315 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
2316 *	bursting) for a hardware TX queue.
2317 *	Returns a negative error code on failure.
2318 *	The callback can sleep.
2319 *
2320 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
2321 *	this is only used for IBSS mode BSSID merging and debugging. Is not a
2322 *	required function.
2323 *	The callback can sleep.
2324 *
2325 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
2326 *      Currently, this is only used for IBSS mode debugging. Is not a
2327 *	required function.
2328 *	The callback can sleep.
2329 *
2330 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
2331 *	with other STAs in the IBSS. This is only used in IBSS mode. This
2332 *	function is optional if the firmware/hardware takes full care of
2333 *	TSF synchronization.
2334 *	The callback can sleep.
2335 *
2336 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
2337 *	This is needed only for IBSS mode and the result of this function is
2338 *	used to determine whether to reply to Probe Requests.
2339 *	Returns non-zero if this device sent the last beacon.
2340 *	The callback can sleep.
2341 *
2342 * @ampdu_action: Perform a certain A-MPDU action
2343 * 	The RA/TID combination determines the destination and TID we want
2344 * 	the ampdu action to be performed for. The action is defined through
2345 * 	ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
2346 * 	is the first frame we expect to perform the action on. Notice
2347 * 	that TX/RX_STOP can pass NULL for this parameter.
2348 *	The @buf_size parameter is only valid when the action is set to
2349 *	%IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
2350 *	buffer size (number of subframes) for this session -- the driver
2351 *	may neither send aggregates containing more subframes than this
2352 *	nor send aggregates in a way that lost frames would exceed the
2353 *	buffer size. If just limiting the aggregate size, this would be
2354 *	possible with a buf_size of 8:
2355 *	 - TX: 1.....7
2356 *	 - RX:  2....7 (lost frame #1)
2357 *	 - TX:        8..1...
2358 *	which is invalid since #1 was now re-transmitted well past the
2359 *	buffer size of 8. Correct ways to retransmit #1 would be:
2360 *	 - TX:       1 or 18 or 81
2361 *	Even "189" would be wrong since 1 could be lost again.
2362 *
2363 *	Returns a negative error code on failure.
2364 *	The callback can sleep.
2365 *
2366 * @get_survey: Return per-channel survey information
2367 *
2368 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
2369 *	need to set wiphy->rfkill_poll to %true before registration,
2370 *	and need to call wiphy_rfkill_set_hw_state() in the callback.
2371 *	The callback can sleep.
2372 *
2373 * @set_coverage_class: Set slot time for given coverage class as specified
2374 *	in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
2375 *	accordingly. This callback is not required and may sleep.
2376 *
2377 * @testmode_cmd: Implement a cfg80211 test mode command.
2378 *	The callback can sleep.
2379 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
2380 *
2381 * @flush: Flush all pending frames from the hardware queue, making sure
2382 *	that the hardware queues are empty. If the parameter @drop is set
2383 *	to %true, pending frames may be dropped. The callback can sleep.
2384 *
2385 * @channel_switch: Drivers that need (or want) to offload the channel
2386 *	switch operation for CSAs received from the AP may implement this
2387 *	callback. They must then call ieee80211_chswitch_done() to indicate
2388 *	completion of the channel switch.
2389 *
2390 * @napi_poll: Poll Rx queue for incoming data frames.
2391 *
2392 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2393 *	Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2394 *	reject TX/RX mask combinations they cannot support by returning -EINVAL
2395 *	(also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2396 *
2397 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2398 *
2399 * @remain_on_channel: Starts an off-channel period on the given channel, must
2400 *	call back to ieee80211_ready_on_channel() when on that channel. Note
2401 *	that normal channel traffic is not stopped as this is intended for hw
2402 *	offload. Frames to transmit on the off-channel channel are transmitted
2403 *	normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
2404 *	duration (which will always be non-zero) expires, the driver must call
2405 *	ieee80211_remain_on_channel_expired().
2406 *	Note that this callback may be called while the device is in IDLE and
2407 *	must be accepted in this case.
2408 *	This callback may sleep.
2409 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
2410 *	aborted before it expires. This callback may sleep.
2411 *
2412 * @set_ringparam: Set tx and rx ring sizes.
2413 *
2414 * @get_ringparam: Get tx and rx ring current and maximum sizes.
2415 *
2416 * @tx_frames_pending: Check if there is any pending frame in the hardware
2417 *	queues before entering power save.
2418 *
2419 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
2420 *	when transmitting a frame. Currently only legacy rates are handled.
2421 *	The callback can sleep.
2422 * @rssi_callback: Notify driver when the average RSSI goes above/below
2423 *	thresholds that were registered previously. The callback can sleep.
2424 *
2425 * @release_buffered_frames: Release buffered frames according to the given
2426 *	parameters. In the case where the driver buffers some frames for
2427 *	sleeping stations mac80211 will use this callback to tell the driver
2428 *	to release some frames, either for PS-poll or uAPSD.
2429 *	Note that if the @more_data paramter is %false the driver must check
2430 *	if there are more frames on the given TIDs, and if there are more than
2431 *	the frames being released then it must still set the more-data bit in
2432 *	the frame. If the @more_data parameter is %true, then of course the
2433 *	more-data bit must always be set.
2434 *	The @tids parameter tells the driver which TIDs to release frames
2435 *	from, for PS-poll it will always have only a single bit set.
2436 *	In the case this is used for a PS-poll initiated release, the
2437 *	@num_frames parameter will always be 1 so code can be shared. In
2438 *	this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
2439 *	on the TX status (and must report TX status) so that the PS-poll
2440 *	period is properly ended. This is used to avoid sending multiple
2441 *	responses for a retried PS-poll frame.
2442 *	In the case this is used for uAPSD, the @num_frames parameter may be
2443 *	bigger than one, but the driver may send fewer frames (it must send
2444 *	at least one, however). In this case it is also responsible for
2445 *	setting the EOSP flag in the QoS header of the frames. Also, when the
2446 *	service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
2447 *	on the last frame in the SP. Alternatively, it may call the function
2448 *	ieee80211_sta_eosp_irqsafe() to inform mac80211 of the end of the SP.
2449 *	This callback must be atomic.
2450 * @allow_buffered_frames: Prepare device to allow the given number of frames
2451 *	to go out to the given station. The frames will be sent by mac80211
2452 *	via the usual TX path after this call. The TX information for frames
2453 *	released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
2454 *	and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
2455 *	frames from multiple TIDs are released and the driver might reorder
2456 *	them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
2457 *	on the last frame and clear it on all others and also handle the EOSP
2458 *	bit in the QoS header correctly. Alternatively, it can also call the
2459 *	ieee80211_sta_eosp_irqsafe() function.
2460 *	The @tids parameter is a bitmap and tells the driver which TIDs the
2461 *	frames will be on; it will at most have two bits set.
2462 *	This callback must be atomic.
2463 *
2464 * @get_et_sset_count:  Ethtool API to get string-set count.
2465 *
2466 * @get_et_stats:  Ethtool API to get a set of u64 stats.
2467 *
2468 * @get_et_strings:  Ethtool API to get a set of strings to describe stats
2469 *	and perhaps other supported types of ethtool data-sets.
2470 *
2471 * @get_rssi: Get current signal strength in dBm, the function is optional
2472 *	and can sleep.
2473 *
2474 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
2475 *	before associated. In multi-channel scenarios, a virtual interface is
2476 *	bound to a channel before it is associated, but as it isn't associated
2477 *	yet it need not necessarily be given airtime, in particular since any
2478 *	transmission to a P2P GO needs to be synchronized against the GO's
2479 *	powersave state. mac80211 will call this function before transmitting a
2480 *	management frame prior to having successfully associated to allow the
2481 *	driver to give it channel time for the transmission, to get a response
2482 *	and to be able to synchronize with the GO.
2483 *	The callback will be called before each transmission and upon return
2484 *	mac80211 will transmit the frame right away.
2485 *	The callback is optional and can (should!) sleep.
2486 *
2487 * @add_chanctx: Notifies device driver about new channel context creation.
2488 * @remove_chanctx: Notifies device driver about channel context destruction.
2489 * @change_chanctx: Notifies device driver about channel context changes that
2490 *	may happen when combining different virtual interfaces on the same
2491 *	channel context with different settings
2492 * @assign_vif_chanctx: Notifies device driver about channel context being bound
2493 *	to vif. Possible use is for hw queue remapping.
2494 * @unassign_vif_chanctx: Notifies device driver about channel context being
2495 *	unbound from vif.
2496 * @start_ap: Start operation on the AP interface, this is called after all the
2497 *	information in bss_conf is set and beacon can be retrieved. A channel
2498 *	context is bound before this is called. Note that if the driver uses
2499 *	software scan or ROC, this (and @stop_ap) isn't called when the AP is
2500 *	just "paused" for scanning/ROC, which is indicated by the beacon being
2501 *	disabled/enabled via @bss_info_changed.
2502 * @stop_ap: Stop operation on the AP interface.
2503 *
2504 * @restart_complete: Called after a call to ieee80211_restart_hw(), when the
2505 *	reconfiguration has completed. This can help the driver implement the
2506 *	reconfiguration step. Also called when reconfiguring because the
2507 *	driver's resume function returned 1, as this is just like an "inline"
2508 *	hardware restart. This callback may sleep.
2509 *
2510 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
2511 *	Currently, this is only called for managed or P2P client interfaces.
2512 *	This callback is optional; it must not sleep.
2513 */
2514struct ieee80211_ops {
2515	void (*tx)(struct ieee80211_hw *hw,
2516		   struct ieee80211_tx_control *control,
2517		   struct sk_buff *skb);
2518	int (*start)(struct ieee80211_hw *hw);
2519	void (*stop)(struct ieee80211_hw *hw);
2520#ifdef CONFIG_PM
2521	int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
2522	int (*resume)(struct ieee80211_hw *hw);
2523	void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
2524#endif
2525	int (*add_interface)(struct ieee80211_hw *hw,
2526			     struct ieee80211_vif *vif);
2527	int (*change_interface)(struct ieee80211_hw *hw,
2528				struct ieee80211_vif *vif,
2529				enum nl80211_iftype new_type, bool p2p);
2530	void (*remove_interface)(struct ieee80211_hw *hw,
2531				 struct ieee80211_vif *vif);
2532	int (*config)(struct ieee80211_hw *hw, u32 changed);
2533	void (*bss_info_changed)(struct ieee80211_hw *hw,
2534				 struct ieee80211_vif *vif,
2535				 struct ieee80211_bss_conf *info,
2536				 u32 changed);
2537
2538	int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2539	void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2540
2541	u64 (*prepare_multicast)(struct ieee80211_hw *hw,
2542				 struct netdev_hw_addr_list *mc_list);
2543	void (*configure_filter)(struct ieee80211_hw *hw,
2544				 unsigned int changed_flags,
2545				 unsigned int *total_flags,
2546				 u64 multicast);
2547	int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
2548		       bool set);
2549	int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
2550		       struct ieee80211_vif *vif, struct ieee80211_sta *sta,
2551		       struct ieee80211_key_conf *key);
2552	void (*update_tkip_key)(struct ieee80211_hw *hw,
2553				struct ieee80211_vif *vif,
2554				struct ieee80211_key_conf *conf,
2555				struct ieee80211_sta *sta,
2556				u32 iv32, u16 *phase1key);
2557	void (*set_rekey_data)(struct ieee80211_hw *hw,
2558			       struct ieee80211_vif *vif,
2559			       struct cfg80211_gtk_rekey_data *data);
2560	void (*set_default_unicast_key)(struct ieee80211_hw *hw,
2561					struct ieee80211_vif *vif, int idx);
2562	int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2563		       struct cfg80211_scan_request *req);
2564	void (*cancel_hw_scan)(struct ieee80211_hw *hw,
2565			       struct ieee80211_vif *vif);
2566	int (*sched_scan_start)(struct ieee80211_hw *hw,
2567				struct ieee80211_vif *vif,
2568				struct cfg80211_sched_scan_request *req,
2569				struct ieee80211_sched_scan_ies *ies);
2570	void (*sched_scan_stop)(struct ieee80211_hw *hw,
2571			       struct ieee80211_vif *vif);
2572	void (*sw_scan_start)(struct ieee80211_hw *hw);
2573	void (*sw_scan_complete)(struct ieee80211_hw *hw);
2574	int (*get_stats)(struct ieee80211_hw *hw,
2575			 struct ieee80211_low_level_stats *stats);
2576	void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
2577			     u32 *iv32, u16 *iv16);
2578	int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
2579	int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
2580	int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2581		       struct ieee80211_sta *sta);
2582	int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2583			  struct ieee80211_sta *sta);
2584#ifdef CONFIG_MAC80211_DEBUGFS
2585	void (*sta_add_debugfs)(struct ieee80211_hw *hw,
2586				struct ieee80211_vif *vif,
2587				struct ieee80211_sta *sta,
2588				struct dentry *dir);
2589	void (*sta_remove_debugfs)(struct ieee80211_hw *hw,
2590				   struct ieee80211_vif *vif,
2591				   struct ieee80211_sta *sta,
2592				   struct dentry *dir);
2593	void (*add_interface_debugfs)(struct ieee80211_hw *hw,
2594				      struct ieee80211_vif *vif,
2595				      struct dentry *dir);
2596	void (*remove_interface_debugfs)(struct ieee80211_hw *hw,
2597					 struct ieee80211_vif *vif,
2598					 struct dentry *dir);
2599#endif
2600	void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2601			enum sta_notify_cmd, struct ieee80211_sta *sta);
2602	int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2603			 struct ieee80211_sta *sta,
2604			 enum ieee80211_sta_state old_state,
2605			 enum ieee80211_sta_state new_state);
2606	void (*sta_rc_update)(struct ieee80211_hw *hw,
2607			      struct ieee80211_vif *vif,
2608			      struct ieee80211_sta *sta,
2609			      u32 changed);
2610	int (*conf_tx)(struct ieee80211_hw *hw,
2611		       struct ieee80211_vif *vif, u16 ac,
2612		       const struct ieee80211_tx_queue_params *params);
2613	u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2614	void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2615			u64 tsf);
2616	void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2617	int (*tx_last_beacon)(struct ieee80211_hw *hw);
2618	int (*ampdu_action)(struct ieee80211_hw *hw,
2619			    struct ieee80211_vif *vif,
2620			    enum ieee80211_ampdu_mlme_action action,
2621			    struct ieee80211_sta *sta, u16 tid, u16 *ssn,
2622			    u8 buf_size);
2623	int (*get_survey)(struct ieee80211_hw *hw, int idx,
2624		struct survey_info *survey);
2625	void (*rfkill_poll)(struct ieee80211_hw *hw);
2626	void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
2627#ifdef CONFIG_NL80211_TESTMODE
2628	int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
2629	int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
2630			     struct netlink_callback *cb,
2631			     void *data, int len);
2632#endif
2633	void (*flush)(struct ieee80211_hw *hw, bool drop);
2634	void (*channel_switch)(struct ieee80211_hw *hw,
2635			       struct ieee80211_channel_switch *ch_switch);
2636	int (*napi_poll)(struct ieee80211_hw *hw, int budget);
2637	int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
2638	int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
2639
2640	int (*remain_on_channel)(struct ieee80211_hw *hw,
2641				 struct ieee80211_vif *vif,
2642				 struct ieee80211_channel *chan,
2643				 int duration);
2644	int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
2645	int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
2646	void (*get_ringparam)(struct ieee80211_hw *hw,
2647			      u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
2648	bool (*tx_frames_pending)(struct ieee80211_hw *hw);
2649	int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2650				const struct cfg80211_bitrate_mask *mask);
2651	void (*rssi_callback)(struct ieee80211_hw *hw,
2652			      struct ieee80211_vif *vif,
2653			      enum ieee80211_rssi_event rssi_event);
2654
2655	void (*allow_buffered_frames)(struct ieee80211_hw *hw,
2656				      struct ieee80211_sta *sta,
2657				      u16 tids, int num_frames,
2658				      enum ieee80211_frame_release_type reason,
2659				      bool more_data);
2660	void (*release_buffered_frames)(struct ieee80211_hw *hw,
2661					struct ieee80211_sta *sta,
2662					u16 tids, int num_frames,
2663					enum ieee80211_frame_release_type reason,
2664					bool more_data);
2665
2666	int	(*get_et_sset_count)(struct ieee80211_hw *hw,
2667				     struct ieee80211_vif *vif, int sset);
2668	void	(*get_et_stats)(struct ieee80211_hw *hw,
2669				struct ieee80211_vif *vif,
2670				struct ethtool_stats *stats, u64 *data);
2671	void	(*get_et_strings)(struct ieee80211_hw *hw,
2672				  struct ieee80211_vif *vif,
2673				  u32 sset, u8 *data);
2674	int	(*get_rssi)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2675			    struct ieee80211_sta *sta, s8 *rssi_dbm);
2676
2677	void	(*mgd_prepare_tx)(struct ieee80211_hw *hw,
2678				  struct ieee80211_vif *vif);
2679
2680	int (*add_chanctx)(struct ieee80211_hw *hw,
2681			   struct ieee80211_chanctx_conf *ctx);
2682	void (*remove_chanctx)(struct ieee80211_hw *hw,
2683			       struct ieee80211_chanctx_conf *ctx);
2684	void (*change_chanctx)(struct ieee80211_hw *hw,
2685			       struct ieee80211_chanctx_conf *ctx,
2686			       u32 changed);
2687	int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
2688				  struct ieee80211_vif *vif,
2689				  struct ieee80211_chanctx_conf *ctx);
2690	void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
2691				     struct ieee80211_vif *vif,
2692				     struct ieee80211_chanctx_conf *ctx);
2693
2694	void (*restart_complete)(struct ieee80211_hw *hw);
2695
2696#if IS_ENABLED(CONFIG_IPV6)
2697	void (*ipv6_addr_change)(struct ieee80211_hw *hw,
2698				 struct ieee80211_vif *vif,
2699				 struct inet6_dev *idev);
2700#endif
2701};
2702
2703/**
2704 * ieee80211_alloc_hw -  Allocate a new hardware device
2705 *
2706 * This must be called once for each hardware device. The returned pointer
2707 * must be used to refer to this device when calling other functions.
2708 * mac80211 allocates a private data area for the driver pointed to by
2709 * @priv in &struct ieee80211_hw, the size of this area is given as
2710 * @priv_data_len.
2711 *
2712 * @priv_data_len: length of private data
2713 * @ops: callbacks for this device
2714 *
2715 * Return: A pointer to the new hardware device, or %NULL on error.
2716 */
2717struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
2718					const struct ieee80211_ops *ops);
2719
2720/**
2721 * ieee80211_register_hw - Register hardware device
2722 *
2723 * You must call this function before any other functions in
2724 * mac80211. Note that before a hardware can be registered, you
2725 * need to fill the contained wiphy's information.
2726 *
2727 * @hw: the device to register as returned by ieee80211_alloc_hw()
2728 *
2729 * Return: 0 on success. An error code otherwise.
2730 */
2731int ieee80211_register_hw(struct ieee80211_hw *hw);
2732
2733/**
2734 * struct ieee80211_tpt_blink - throughput blink description
2735 * @throughput: throughput in Kbit/sec
2736 * @blink_time: blink time in milliseconds
2737 *	(full cycle, ie. one off + one on period)
2738 */
2739struct ieee80211_tpt_blink {
2740	int throughput;
2741	int blink_time;
2742};
2743
2744/**
2745 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
2746 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
2747 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
2748 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
2749 *	interface is connected in some way, including being an AP
2750 */
2751enum ieee80211_tpt_led_trigger_flags {
2752	IEEE80211_TPT_LEDTRIG_FL_RADIO		= BIT(0),
2753	IEEE80211_TPT_LEDTRIG_FL_WORK		= BIT(1),
2754	IEEE80211_TPT_LEDTRIG_FL_CONNECTED	= BIT(2),
2755};
2756
2757#ifdef CONFIG_MAC80211_LEDS
2758extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
2759extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
2760extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
2761extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
2762extern char *__ieee80211_create_tpt_led_trigger(
2763				struct ieee80211_hw *hw, unsigned int flags,
2764				const struct ieee80211_tpt_blink *blink_table,
2765				unsigned int blink_table_len);
2766#endif
2767/**
2768 * ieee80211_get_tx_led_name - get name of TX LED
2769 *
2770 * mac80211 creates a transmit LED trigger for each wireless hardware
2771 * that can be used to drive LEDs if your driver registers a LED device.
2772 * This function returns the name (or %NULL if not configured for LEDs)
2773 * of the trigger so you can automatically link the LED device.
2774 *
2775 * @hw: the hardware to get the LED trigger name for
2776 *
2777 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
2778 */
2779static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
2780{
2781#ifdef CONFIG_MAC80211_LEDS
2782	return __ieee80211_get_tx_led_name(hw);
2783#else
2784	return NULL;
2785#endif
2786}
2787
2788/**
2789 * ieee80211_get_rx_led_name - get name of RX LED
2790 *
2791 * mac80211 creates a receive LED trigger for each wireless hardware
2792 * that can be used to drive LEDs if your driver registers a LED device.
2793 * This function returns the name (or %NULL if not configured for LEDs)
2794 * of the trigger so you can automatically link the LED device.
2795 *
2796 * @hw: the hardware to get the LED trigger name for
2797 *
2798 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
2799 */
2800static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
2801{
2802#ifdef CONFIG_MAC80211_LEDS
2803	return __ieee80211_get_rx_led_name(hw);
2804#else
2805	return NULL;
2806#endif
2807}
2808
2809/**
2810 * ieee80211_get_assoc_led_name - get name of association LED
2811 *
2812 * mac80211 creates a association LED trigger for each wireless hardware
2813 * that can be used to drive LEDs if your driver registers a LED device.
2814 * This function returns the name (or %NULL if not configured for LEDs)
2815 * of the trigger so you can automatically link the LED device.
2816 *
2817 * @hw: the hardware to get the LED trigger name for
2818 *
2819 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
2820 */
2821static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
2822{
2823#ifdef CONFIG_MAC80211_LEDS
2824	return __ieee80211_get_assoc_led_name(hw);
2825#else
2826	return NULL;
2827#endif
2828}
2829
2830/**
2831 * ieee80211_get_radio_led_name - get name of radio LED
2832 *
2833 * mac80211 creates a radio change LED trigger for each wireless hardware
2834 * that can be used to drive LEDs if your driver registers a LED device.
2835 * This function returns the name (or %NULL if not configured for LEDs)
2836 * of the trigger so you can automatically link the LED device.
2837 *
2838 * @hw: the hardware to get the LED trigger name for
2839 *
2840 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
2841 */
2842static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
2843{
2844#ifdef CONFIG_MAC80211_LEDS
2845	return __ieee80211_get_radio_led_name(hw);
2846#else
2847	return NULL;
2848#endif
2849}
2850
2851/**
2852 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
2853 * @hw: the hardware to create the trigger for
2854 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
2855 * @blink_table: the blink table -- needs to be ordered by throughput
2856 * @blink_table_len: size of the blink table
2857 *
2858 * Return: %NULL (in case of error, or if no LED triggers are
2859 * configured) or the name of the new trigger.
2860 *
2861 * Note: This function must be called before ieee80211_register_hw().
2862 */
2863static inline char *
2864ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
2865				 const struct ieee80211_tpt_blink *blink_table,
2866				 unsigned int blink_table_len)
2867{
2868#ifdef CONFIG_MAC80211_LEDS
2869	return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
2870						  blink_table_len);
2871#else
2872	return NULL;
2873#endif
2874}
2875
2876/**
2877 * ieee80211_unregister_hw - Unregister a hardware device
2878 *
2879 * This function instructs mac80211 to free allocated resources
2880 * and unregister netdevices from the networking subsystem.
2881 *
2882 * @hw: the hardware to unregister
2883 */
2884void ieee80211_unregister_hw(struct ieee80211_hw *hw);
2885
2886/**
2887 * ieee80211_free_hw - free hardware descriptor
2888 *
2889 * This function frees everything that was allocated, including the
2890 * private data for the driver. You must call ieee80211_unregister_hw()
2891 * before calling this function.
2892 *
2893 * @hw: the hardware to free
2894 */
2895void ieee80211_free_hw(struct ieee80211_hw *hw);
2896
2897/**
2898 * ieee80211_restart_hw - restart hardware completely
2899 *
2900 * Call this function when the hardware was restarted for some reason
2901 * (hardware error, ...) and the driver is unable to restore its state
2902 * by itself. mac80211 assumes that at this point the driver/hardware
2903 * is completely uninitialised and stopped, it starts the process by
2904 * calling the ->start() operation. The driver will need to reset all
2905 * internal state that it has prior to calling this function.
2906 *
2907 * @hw: the hardware to restart
2908 */
2909void ieee80211_restart_hw(struct ieee80211_hw *hw);
2910
2911/** ieee80211_napi_schedule - schedule NAPI poll
2912 *
2913 * Use this function to schedule NAPI polling on a device.
2914 *
2915 * @hw: the hardware to start polling
2916 */
2917void ieee80211_napi_schedule(struct ieee80211_hw *hw);
2918
2919/** ieee80211_napi_complete - complete NAPI polling
2920 *
2921 * Use this function to finish NAPI polling on a device.
2922 *
2923 * @hw: the hardware to stop polling
2924 */
2925void ieee80211_napi_complete(struct ieee80211_hw *hw);
2926
2927/**
2928 * ieee80211_rx - receive frame
2929 *
2930 * Use this function to hand received frames to mac80211. The receive
2931 * buffer in @skb must start with an IEEE 802.11 header. In case of a
2932 * paged @skb is used, the driver is recommended to put the ieee80211
2933 * header of the frame on the linear part of the @skb to avoid memory
2934 * allocation and/or memcpy by the stack.
2935 *
2936 * This function may not be called in IRQ context. Calls to this function
2937 * for a single hardware must be synchronized against each other. Calls to
2938 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
2939 * mixed for a single hardware.
2940 *
2941 * In process context use instead ieee80211_rx_ni().
2942 *
2943 * @hw: the hardware this frame came in on
2944 * @skb: the buffer to receive, owned by mac80211 after this call
2945 */
2946void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
2947
2948/**
2949 * ieee80211_rx_irqsafe - receive frame
2950 *
2951 * Like ieee80211_rx() but can be called in IRQ context
2952 * (internally defers to a tasklet.)
2953 *
2954 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
2955 * be mixed for a single hardware.
2956 *
2957 * @hw: the hardware this frame came in on
2958 * @skb: the buffer to receive, owned by mac80211 after this call
2959 */
2960void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
2961
2962/**
2963 * ieee80211_rx_ni - receive frame (in process context)
2964 *
2965 * Like ieee80211_rx() but can be called in process context
2966 * (internally disables bottom halves).
2967 *
2968 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
2969 * not be mixed for a single hardware.
2970 *
2971 * @hw: the hardware this frame came in on
2972 * @skb: the buffer to receive, owned by mac80211 after this call
2973 */
2974static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
2975				   struct sk_buff *skb)
2976{
2977	local_bh_disable();
2978	ieee80211_rx(hw, skb);
2979	local_bh_enable();
2980}
2981
2982/**
2983 * ieee80211_sta_ps_transition - PS transition for connected sta
2984 *
2985 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
2986 * flag set, use this function to inform mac80211 about a connected station
2987 * entering/leaving PS mode.
2988 *
2989 * This function may not be called in IRQ context or with softirqs enabled.
2990 *
2991 * Calls to this function for a single hardware must be synchronized against
2992 * each other.
2993 *
2994 * @sta: currently connected sta
2995 * @start: start or stop PS
2996 *
2997 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
2998 */
2999int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
3000
3001/**
3002 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
3003 *                                  (in process context)
3004 *
3005 * Like ieee80211_sta_ps_transition() but can be called in process context
3006 * (internally disables bottom halves). Concurrent call restriction still
3007 * applies.
3008 *
3009 * @sta: currently connected sta
3010 * @start: start or stop PS
3011 *
3012 * Return: Like ieee80211_sta_ps_transition().
3013 */
3014static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
3015						  bool start)
3016{
3017	int ret;
3018
3019	local_bh_disable();
3020	ret = ieee80211_sta_ps_transition(sta, start);
3021	local_bh_enable();
3022
3023	return ret;
3024}
3025
3026/*
3027 * The TX headroom reserved by mac80211 for its own tx_status functions.
3028 * This is enough for the radiotap header.
3029 */
3030#define IEEE80211_TX_STATUS_HEADROOM	14
3031
3032/**
3033 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
3034 * @sta: &struct ieee80211_sta pointer for the sleeping station
3035 * @tid: the TID that has buffered frames
3036 * @buffered: indicates whether or not frames are buffered for this TID
3037 *
3038 * If a driver buffers frames for a powersave station instead of passing
3039 * them back to mac80211 for retransmission, the station may still need
3040 * to be told that there are buffered frames via the TIM bit.
3041 *
3042 * This function informs mac80211 whether or not there are frames that are
3043 * buffered in the driver for a given TID; mac80211 can then use this data
3044 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
3045 * call! Beware of the locking!)
3046 *
3047 * If all frames are released to the station (due to PS-poll or uAPSD)
3048 * then the driver needs to inform mac80211 that there no longer are
3049 * frames buffered. However, when the station wakes up mac80211 assumes
3050 * that all buffered frames will be transmitted and clears this data,
3051 * drivers need to make sure they inform mac80211 about all buffered
3052 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
3053 *
3054 * Note that technically mac80211 only needs to know this per AC, not per
3055 * TID, but since driver buffering will inevitably happen per TID (since
3056 * it is related to aggregation) it is easier to make mac80211 map the
3057 * TID to the AC as required instead of keeping track in all drivers that
3058 * use this API.
3059 */
3060void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
3061				u8 tid, bool buffered);
3062
3063/**
3064 * ieee80211_tx_status - transmit status callback
3065 *
3066 * Call this function for all transmitted frames after they have been
3067 * transmitted. It is permissible to not call this function for
3068 * multicast frames but this can affect statistics.
3069 *
3070 * This function may not be called in IRQ context. Calls to this function
3071 * for a single hardware must be synchronized against each other. Calls
3072 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
3073 * may not be mixed for a single hardware.
3074 *
3075 * @hw: the hardware the frame was transmitted by
3076 * @skb: the frame that was transmitted, owned by mac80211 after this call
3077 */
3078void ieee80211_tx_status(struct ieee80211_hw *hw,
3079			 struct sk_buff *skb);
3080
3081/**
3082 * ieee80211_tx_status_ni - transmit status callback (in process context)
3083 *
3084 * Like ieee80211_tx_status() but can be called in process context.
3085 *
3086 * Calls to this function, ieee80211_tx_status() and
3087 * ieee80211_tx_status_irqsafe() may not be mixed
3088 * for a single hardware.
3089 *
3090 * @hw: the hardware the frame was transmitted by
3091 * @skb: the frame that was transmitted, owned by mac80211 after this call
3092 */
3093static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
3094					  struct sk_buff *skb)
3095{
3096	local_bh_disable();
3097	ieee80211_tx_status(hw, skb);
3098	local_bh_enable();
3099}
3100
3101/**
3102 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
3103 *
3104 * Like ieee80211_tx_status() but can be called in IRQ context
3105 * (internally defers to a tasklet.)
3106 *
3107 * Calls to this function, ieee80211_tx_status() and
3108 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
3109 *
3110 * @hw: the hardware the frame was transmitted by
3111 * @skb: the frame that was transmitted, owned by mac80211 after this call
3112 */
3113void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
3114				 struct sk_buff *skb);
3115
3116/**
3117 * ieee80211_report_low_ack - report non-responding station
3118 *
3119 * When operating in AP-mode, call this function to report a non-responding
3120 * connected STA.
3121 *
3122 * @sta: the non-responding connected sta
3123 * @num_packets: number of packets sent to @sta without a response
3124 */
3125void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
3126
3127/**
3128 * ieee80211_beacon_get_tim - beacon generation function
3129 * @hw: pointer obtained from ieee80211_alloc_hw().
3130 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3131 * @tim_offset: pointer to variable that will receive the TIM IE offset.
3132 *	Set to 0 if invalid (in non-AP modes).
3133 * @tim_length: pointer to variable that will receive the TIM IE length,
3134 *	(including the ID and length bytes!).
3135 *	Set to 0 if invalid (in non-AP modes).
3136 *
3137 * If the driver implements beaconing modes, it must use this function to
3138 * obtain the beacon frame/template.
3139 *
3140 * If the beacon frames are generated by the host system (i.e., not in
3141 * hardware/firmware), the driver uses this function to get each beacon
3142 * frame from mac80211 -- it is responsible for calling this function
3143 * before the beacon is needed (e.g. based on hardware interrupt).
3144 *
3145 * If the beacon frames are generated by the device, then the driver
3146 * must use the returned beacon as the template and change the TIM IE
3147 * according to the current DTIM parameters/TIM bitmap.
3148 *
3149 * The driver is responsible for freeing the returned skb.
3150 *
3151 * Return: The beacon template. %NULL on error.
3152 */
3153struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
3154					 struct ieee80211_vif *vif,
3155					 u16 *tim_offset, u16 *tim_length);
3156
3157/**
3158 * ieee80211_beacon_get - beacon generation function
3159 * @hw: pointer obtained from ieee80211_alloc_hw().
3160 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3161 *
3162 * See ieee80211_beacon_get_tim().
3163 *
3164 * Return: See ieee80211_beacon_get_tim().
3165 */
3166static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
3167						   struct ieee80211_vif *vif)
3168{
3169	return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
3170}
3171
3172/**
3173 * ieee80211_proberesp_get - retrieve a Probe Response template
3174 * @hw: pointer obtained from ieee80211_alloc_hw().
3175 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3176 *
3177 * Creates a Probe Response template which can, for example, be uploaded to
3178 * hardware. The destination address should be set by the caller.
3179 *
3180 * Can only be called in AP mode.
3181 *
3182 * Return: The Probe Response template. %NULL on error.
3183 */
3184struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
3185					struct ieee80211_vif *vif);
3186
3187/**
3188 * ieee80211_pspoll_get - retrieve a PS Poll template
3189 * @hw: pointer obtained from ieee80211_alloc_hw().
3190 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3191 *
3192 * Creates a PS Poll a template which can, for example, uploaded to
3193 * hardware. The template must be updated after association so that correct
3194 * AID, BSSID and MAC address is used.
3195 *
3196 * Note: Caller (or hardware) is responsible for setting the
3197 * &IEEE80211_FCTL_PM bit.
3198 *
3199 * Return: The PS Poll template. %NULL on error.
3200 */
3201struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
3202				     struct ieee80211_vif *vif);
3203
3204/**
3205 * ieee80211_nullfunc_get - retrieve a nullfunc template
3206 * @hw: pointer obtained from ieee80211_alloc_hw().
3207 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3208 *
3209 * Creates a Nullfunc template which can, for example, uploaded to
3210 * hardware. The template must be updated after association so that correct
3211 * BSSID and address is used.
3212 *
3213 * Note: Caller (or hardware) is responsible for setting the
3214 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
3215 *
3216 * Return: The nullfunc template. %NULL on error.
3217 */
3218struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
3219				       struct ieee80211_vif *vif);
3220
3221/**
3222 * ieee80211_probereq_get - retrieve a Probe Request template
3223 * @hw: pointer obtained from ieee80211_alloc_hw().
3224 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3225 * @ssid: SSID buffer
3226 * @ssid_len: length of SSID
3227 * @tailroom: tailroom to reserve at end of SKB for IEs
3228 *
3229 * Creates a Probe Request template which can, for example, be uploaded to
3230 * hardware.
3231 *
3232 * Return: The Probe Request template. %NULL on error.
3233 */
3234struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
3235				       struct ieee80211_vif *vif,
3236				       const u8 *ssid, size_t ssid_len,
3237				       size_t tailroom);
3238
3239/**
3240 * ieee80211_rts_get - RTS frame generation function
3241 * @hw: pointer obtained from ieee80211_alloc_hw().
3242 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3243 * @frame: pointer to the frame that is going to be protected by the RTS.
3244 * @frame_len: the frame length (in octets).
3245 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3246 * @rts: The buffer where to store the RTS frame.
3247 *
3248 * If the RTS frames are generated by the host system (i.e., not in
3249 * hardware/firmware), the low-level driver uses this function to receive
3250 * the next RTS frame from the 802.11 code. The low-level is responsible
3251 * for calling this function before and RTS frame is needed.
3252 */
3253void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3254		       const void *frame, size_t frame_len,
3255		       const struct ieee80211_tx_info *frame_txctl,
3256		       struct ieee80211_rts *rts);
3257
3258/**
3259 * ieee80211_rts_duration - Get the duration field for an RTS frame
3260 * @hw: pointer obtained from ieee80211_alloc_hw().
3261 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3262 * @frame_len: the length of the frame that is going to be protected by the RTS.
3263 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3264 *
3265 * If the RTS is generated in firmware, but the host system must provide
3266 * the duration field, the low-level driver uses this function to receive
3267 * the duration field value in little-endian byteorder.
3268 *
3269 * Return: The duration.
3270 */
3271__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
3272			      struct ieee80211_vif *vif, size_t frame_len,
3273			      const struct ieee80211_tx_info *frame_txctl);
3274
3275/**
3276 * ieee80211_ctstoself_get - CTS-to-self frame generation function
3277 * @hw: pointer obtained from ieee80211_alloc_hw().
3278 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3279 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
3280 * @frame_len: the frame length (in octets).
3281 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3282 * @cts: The buffer where to store the CTS-to-self frame.
3283 *
3284 * If the CTS-to-self frames are generated by the host system (i.e., not in
3285 * hardware/firmware), the low-level driver uses this function to receive
3286 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
3287 * for calling this function before and CTS-to-self frame is needed.
3288 */
3289void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
3290			     struct ieee80211_vif *vif,
3291			     const void *frame, size_t frame_len,
3292			     const struct ieee80211_tx_info *frame_txctl,
3293			     struct ieee80211_cts *cts);
3294
3295/**
3296 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
3297 * @hw: pointer obtained from ieee80211_alloc_hw().
3298 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3299 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
3300 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3301 *
3302 * If the CTS-to-self is generated in firmware, but the host system must provide
3303 * the duration field, the low-level driver uses this function to receive
3304 * the duration field value in little-endian byteorder.
3305 *
3306 * Return: The duration.
3307 */
3308__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
3309				    struct ieee80211_vif *vif,
3310				    size_t frame_len,
3311				    const struct ieee80211_tx_info *frame_txctl);
3312
3313/**
3314 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
3315 * @hw: pointer obtained from ieee80211_alloc_hw().
3316 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3317 * @band: the band to calculate the frame duration on
3318 * @frame_len: the length of the frame.
3319 * @rate: the rate at which the frame is going to be transmitted.
3320 *
3321 * Calculate the duration field of some generic frame, given its
3322 * length and transmission rate (in 100kbps).
3323 *
3324 * Return: The duration.
3325 */
3326__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
3327					struct ieee80211_vif *vif,
3328					enum ieee80211_band band,
3329					size_t frame_len,
3330					struct ieee80211_rate *rate);
3331
3332/**
3333 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
3334 * @hw: pointer as obtained from ieee80211_alloc_hw().
3335 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3336 *
3337 * Function for accessing buffered broadcast and multicast frames. If
3338 * hardware/firmware does not implement buffering of broadcast/multicast
3339 * frames when power saving is used, 802.11 code buffers them in the host
3340 * memory. The low-level driver uses this function to fetch next buffered
3341 * frame. In most cases, this is used when generating beacon frame.
3342 *
3343 * Return: A pointer to the next buffered skb or NULL if no more buffered
3344 * frames are available.
3345 *
3346 * Note: buffered frames are returned only after DTIM beacon frame was
3347 * generated with ieee80211_beacon_get() and the low-level driver must thus
3348 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
3349 * NULL if the previous generated beacon was not DTIM, so the low-level driver
3350 * does not need to check for DTIM beacons separately and should be able to
3351 * use common code for all beacons.
3352 */
3353struct sk_buff *
3354ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3355
3356/**
3357 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
3358 *
3359 * This function returns the TKIP phase 1 key for the given IV32.
3360 *
3361 * @keyconf: the parameter passed with the set key
3362 * @iv32: IV32 to get the P1K for
3363 * @p1k: a buffer to which the key will be written, as 5 u16 values
3364 */
3365void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
3366			       u32 iv32, u16 *p1k);
3367
3368/**
3369 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
3370 *
3371 * This function returns the TKIP phase 1 key for the IV32 taken
3372 * from the given packet.
3373 *
3374 * @keyconf: the parameter passed with the set key
3375 * @skb: the packet to take the IV32 value from that will be encrypted
3376 *	with this P1K
3377 * @p1k: a buffer to which the key will be written, as 5 u16 values
3378 */
3379static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
3380					  struct sk_buff *skb, u16 *p1k)
3381{
3382	struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
3383	const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
3384	u32 iv32 = get_unaligned_le32(&data[4]);
3385
3386	ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
3387}
3388
3389/**
3390 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
3391 *
3392 * This function returns the TKIP phase 1 key for the given IV32
3393 * and transmitter address.
3394 *
3395 * @keyconf: the parameter passed with the set key
3396 * @ta: TA that will be used with the key
3397 * @iv32: IV32 to get the P1K for
3398 * @p1k: a buffer to which the key will be written, as 5 u16 values
3399 */
3400void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
3401			       const u8 *ta, u32 iv32, u16 *p1k);
3402
3403/**
3404 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
3405 *
3406 * This function computes the TKIP RC4 key for the IV values
3407 * in the packet.
3408 *
3409 * @keyconf: the parameter passed with the set key
3410 * @skb: the packet to take the IV32/IV16 values from that will be
3411 *	encrypted with this key
3412 * @p2k: a buffer to which the key will be written, 16 bytes
3413 */
3414void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
3415			    struct sk_buff *skb, u8 *p2k);
3416
3417/**
3418 * ieee80211_aes_cmac_calculate_k1_k2 - calculate the AES-CMAC sub keys
3419 *
3420 * This function computes the two AES-CMAC sub-keys, based on the
3421 * previously installed master key.
3422 *
3423 * @keyconf: the parameter passed with the set key
3424 * @k1: a buffer to be filled with the 1st sub-key
3425 * @k2: a buffer to be filled with the 2nd sub-key
3426 */
3427void ieee80211_aes_cmac_calculate_k1_k2(struct ieee80211_key_conf *keyconf,
3428					u8 *k1, u8 *k2);
3429
3430/**
3431 * struct ieee80211_key_seq - key sequence counter
3432 *
3433 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
3434 * @ccmp: PN data, most significant byte first (big endian,
3435 *	reverse order than in packet)
3436 * @aes_cmac: PN data, most significant byte first (big endian,
3437 *	reverse order than in packet)
3438 */
3439struct ieee80211_key_seq {
3440	union {
3441		struct {
3442			u32 iv32;
3443			u16 iv16;
3444		} tkip;
3445		struct {
3446			u8 pn[6];
3447		} ccmp;
3448		struct {
3449			u8 pn[6];
3450		} aes_cmac;
3451	};
3452};
3453
3454/**
3455 * ieee80211_get_key_tx_seq - get key TX sequence counter
3456 *
3457 * @keyconf: the parameter passed with the set key
3458 * @seq: buffer to receive the sequence data
3459 *
3460 * This function allows a driver to retrieve the current TX IV/PN
3461 * for the given key. It must not be called if IV generation is
3462 * offloaded to the device.
3463 *
3464 * Note that this function may only be called when no TX processing
3465 * can be done concurrently, for example when queues are stopped
3466 * and the stop has been synchronized.
3467 */
3468void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
3469			      struct ieee80211_key_seq *seq);
3470
3471/**
3472 * ieee80211_get_key_rx_seq - get key RX sequence counter
3473 *
3474 * @keyconf: the parameter passed with the set key
3475 * @tid: The TID, or -1 for the management frame value (CCMP only);
3476 *	the value on TID 0 is also used for non-QoS frames. For
3477 *	CMAC, only TID 0 is valid.
3478 * @seq: buffer to receive the sequence data
3479 *
3480 * This function allows a driver to retrieve the current RX IV/PNs
3481 * for the given key. It must not be called if IV checking is done
3482 * by the device and not by mac80211.
3483 *
3484 * Note that this function may only be called when no RX processing
3485 * can be done concurrently.
3486 */
3487void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
3488			      int tid, struct ieee80211_key_seq *seq);
3489
3490/**
3491 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
3492 * @vif: virtual interface the rekeying was done on
3493 * @bssid: The BSSID of the AP, for checking association
3494 * @replay_ctr: the new replay counter after GTK rekeying
3495 * @gfp: allocation flags
3496 */
3497void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
3498				const u8 *replay_ctr, gfp_t gfp);
3499
3500/**
3501 * ieee80211_wake_queue - wake specific queue
3502 * @hw: pointer as obtained from ieee80211_alloc_hw().
3503 * @queue: queue number (counted from zero).
3504 *
3505 * Drivers should use this function instead of netif_wake_queue.
3506 */
3507void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
3508
3509/**
3510 * ieee80211_stop_queue - stop specific queue
3511 * @hw: pointer as obtained from ieee80211_alloc_hw().
3512 * @queue: queue number (counted from zero).
3513 *
3514 * Drivers should use this function instead of netif_stop_queue.
3515 */
3516void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
3517
3518/**
3519 * ieee80211_queue_stopped - test status of the queue
3520 * @hw: pointer as obtained from ieee80211_alloc_hw().
3521 * @queue: queue number (counted from zero).
3522 *
3523 * Drivers should use this function instead of netif_stop_queue.
3524 *
3525 * Return: %true if the queue is stopped. %false otherwise.
3526 */
3527
3528int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
3529
3530/**
3531 * ieee80211_stop_queues - stop all queues
3532 * @hw: pointer as obtained from ieee80211_alloc_hw().
3533 *
3534 * Drivers should use this function instead of netif_stop_queue.
3535 */
3536void ieee80211_stop_queues(struct ieee80211_hw *hw);
3537
3538/**
3539 * ieee80211_wake_queues - wake all queues
3540 * @hw: pointer as obtained from ieee80211_alloc_hw().
3541 *
3542 * Drivers should use this function instead of netif_wake_queue.
3543 */
3544void ieee80211_wake_queues(struct ieee80211_hw *hw);
3545
3546/**
3547 * ieee80211_scan_completed - completed hardware scan
3548 *
3549 * When hardware scan offload is used (i.e. the hw_scan() callback is
3550 * assigned) this function needs to be called by the driver to notify
3551 * mac80211 that the scan finished. This function can be called from
3552 * any context, including hardirq context.
3553 *
3554 * @hw: the hardware that finished the scan
3555 * @aborted: set to true if scan was aborted
3556 */
3557void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
3558
3559/**
3560 * ieee80211_sched_scan_results - got results from scheduled scan
3561 *
3562 * When a scheduled scan is running, this function needs to be called by the
3563 * driver whenever there are new scan results available.
3564 *
3565 * @hw: the hardware that is performing scheduled scans
3566 */
3567void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
3568
3569/**
3570 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
3571 *
3572 * When a scheduled scan is running, this function can be called by
3573 * the driver if it needs to stop the scan to perform another task.
3574 * Usual scenarios are drivers that cannot continue the scheduled scan
3575 * while associating, for instance.
3576 *
3577 * @hw: the hardware that is performing scheduled scans
3578 */
3579void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
3580
3581/**
3582 * enum ieee80211_interface_iteration_flags - interface iteration flags
3583 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
3584 *	been added to the driver; However, note that during hardware
3585 *	reconfiguration (after restart_hw) it will iterate over a new
3586 *	interface and over all the existing interfaces even if they
3587 *	haven't been re-added to the driver yet.
3588 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
3589 *	interfaces, even if they haven't been re-added to the driver yet.
3590 */
3591enum ieee80211_interface_iteration_flags {
3592	IEEE80211_IFACE_ITER_NORMAL	= 0,
3593	IEEE80211_IFACE_ITER_RESUME_ALL	= BIT(0),
3594};
3595
3596/**
3597 * ieee80211_iterate_active_interfaces - iterate active interfaces
3598 *
3599 * This function iterates over the interfaces associated with a given
3600 * hardware that are currently active and calls the callback for them.
3601 * This function allows the iterator function to sleep, when the iterator
3602 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
3603 * be used.
3604 * Does not iterate over a new interface during add_interface().
3605 *
3606 * @hw: the hardware struct of which the interfaces should be iterated over
3607 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
3608 * @iterator: the iterator function to call
3609 * @data: first argument of the iterator function
3610 */
3611void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
3612					 u32 iter_flags,
3613					 void (*iterator)(void *data, u8 *mac,
3614						struct ieee80211_vif *vif),
3615					 void *data);
3616
3617/**
3618 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
3619 *
3620 * This function iterates over the interfaces associated with a given
3621 * hardware that are currently active and calls the callback for them.
3622 * This function requires the iterator callback function to be atomic,
3623 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
3624 * Does not iterate over a new interface during add_interface().
3625 *
3626 * @hw: the hardware struct of which the interfaces should be iterated over
3627 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
3628 * @iterator: the iterator function to call, cannot sleep
3629 * @data: first argument of the iterator function
3630 */
3631void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
3632						u32 iter_flags,
3633						void (*iterator)(void *data,
3634						    u8 *mac,
3635						    struct ieee80211_vif *vif),
3636						void *data);
3637
3638/**
3639 * ieee80211_queue_work - add work onto the mac80211 workqueue
3640 *
3641 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
3642 * This helper ensures drivers are not queueing work when they should not be.
3643 *
3644 * @hw: the hardware struct for the interface we are adding work for
3645 * @work: the work we want to add onto the mac80211 workqueue
3646 */
3647void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
3648
3649/**
3650 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
3651 *
3652 * Drivers and mac80211 use this to queue delayed work onto the mac80211
3653 * workqueue.
3654 *
3655 * @hw: the hardware struct for the interface we are adding work for
3656 * @dwork: delayable work to queue onto the mac80211 workqueue
3657 * @delay: number of jiffies to wait before queueing
3658 */
3659void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
3660				  struct delayed_work *dwork,
3661				  unsigned long delay);
3662
3663/**
3664 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
3665 * @sta: the station for which to start a BA session
3666 * @tid: the TID to BA on.
3667 * @timeout: session timeout value (in TUs)
3668 *
3669 * Return: success if addBA request was sent, failure otherwise
3670 *
3671 * Although mac80211/low level driver/user space application can estimate
3672 * the need to start aggregation on a certain RA/TID, the session level
3673 * will be managed by the mac80211.
3674 */
3675int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
3676				  u16 timeout);
3677
3678/**
3679 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
3680 * @vif: &struct ieee80211_vif pointer from the add_interface callback
3681 * @ra: receiver address of the BA session recipient.
3682 * @tid: the TID to BA on.
3683 *
3684 * This function must be called by low level driver once it has
3685 * finished with preparations for the BA session. It can be called
3686 * from any context.
3687 */
3688void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
3689				      u16 tid);
3690
3691/**
3692 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
3693 * @sta: the station whose BA session to stop
3694 * @tid: the TID to stop BA.
3695 *
3696 * Return: negative error if the TID is invalid, or no aggregation active
3697 *
3698 * Although mac80211/low level driver/user space application can estimate
3699 * the need to stop aggregation on a certain RA/TID, the session level
3700 * will be managed by the mac80211.
3701 */
3702int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
3703
3704/**
3705 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
3706 * @vif: &struct ieee80211_vif pointer from the add_interface callback
3707 * @ra: receiver address of the BA session recipient.
3708 * @tid: the desired TID to BA on.
3709 *
3710 * This function must be called by low level driver once it has
3711 * finished with preparations for the BA session tear down. It
3712 * can be called from any context.
3713 */
3714void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
3715				     u16 tid);
3716
3717/**
3718 * ieee80211_find_sta - find a station
3719 *
3720 * @vif: virtual interface to look for station on
3721 * @addr: station's address
3722 *
3723 * Return: The station, if found. %NULL otherwise.
3724 *
3725 * Note: This function must be called under RCU lock and the
3726 * resulting pointer is only valid under RCU lock as well.
3727 */
3728struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
3729					 const u8 *addr);
3730
3731/**
3732 * ieee80211_find_sta_by_ifaddr - find a station on hardware
3733 *
3734 * @hw: pointer as obtained from ieee80211_alloc_hw()
3735 * @addr: remote station's address
3736 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
3737 *
3738 * Return: The station, if found. %NULL otherwise.
3739 *
3740 * Note: This function must be called under RCU lock and the
3741 * resulting pointer is only valid under RCU lock as well.
3742 *
3743 * NOTE: You may pass NULL for localaddr, but then you will just get
3744 *      the first STA that matches the remote address 'addr'.
3745 *      We can have multiple STA associated with multiple
3746 *      logical stations (e.g. consider a station connecting to another
3747 *      BSSID on the same AP hardware without disconnecting first).
3748 *      In this case, the result of this method with localaddr NULL
3749 *      is not reliable.
3750 *
3751 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
3752 */
3753struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
3754					       const u8 *addr,
3755					       const u8 *localaddr);
3756
3757/**
3758 * ieee80211_sta_block_awake - block station from waking up
3759 * @hw: the hardware
3760 * @pubsta: the station
3761 * @block: whether to block or unblock
3762 *
3763 * Some devices require that all frames that are on the queues
3764 * for a specific station that went to sleep are flushed before
3765 * a poll response or frames after the station woke up can be
3766 * delivered to that it. Note that such frames must be rejected
3767 * by the driver as filtered, with the appropriate status flag.
3768 *
3769 * This function allows implementing this mode in a race-free
3770 * manner.
3771 *
3772 * To do this, a driver must keep track of the number of frames
3773 * still enqueued for a specific station. If this number is not
3774 * zero when the station goes to sleep, the driver must call
3775 * this function to force mac80211 to consider the station to
3776 * be asleep regardless of the station's actual state. Once the
3777 * number of outstanding frames reaches zero, the driver must
3778 * call this function again to unblock the station. That will
3779 * cause mac80211 to be able to send ps-poll responses, and if
3780 * the station queried in the meantime then frames will also
3781 * be sent out as a result of this. Additionally, the driver
3782 * will be notified that the station woke up some time after
3783 * it is unblocked, regardless of whether the station actually
3784 * woke up while blocked or not.
3785 */
3786void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
3787			       struct ieee80211_sta *pubsta, bool block);
3788
3789/**
3790 * ieee80211_sta_eosp - notify mac80211 about end of SP
3791 * @pubsta: the station
3792 *
3793 * When a device transmits frames in a way that it can't tell
3794 * mac80211 in the TX status about the EOSP, it must clear the
3795 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
3796 * This applies for PS-Poll as well as uAPSD.
3797 *
3798 * Note that there is no non-_irqsafe version right now as
3799 * it wasn't needed, but just like _tx_status() and _rx()
3800 * must not be mixed in irqsafe/non-irqsafe versions, this
3801 * function must not be mixed with those either. Use the
3802 * all irqsafe, or all non-irqsafe, don't mix! If you need
3803 * the non-irqsafe version of this, you need to add it.
3804 */
3805void ieee80211_sta_eosp_irqsafe(struct ieee80211_sta *pubsta);
3806
3807/**
3808 * ieee80211_iter_keys - iterate keys programmed into the device
3809 * @hw: pointer obtained from ieee80211_alloc_hw()
3810 * @vif: virtual interface to iterate, may be %NULL for all
3811 * @iter: iterator function that will be called for each key
3812 * @iter_data: custom data to pass to the iterator function
3813 *
3814 * This function can be used to iterate all the keys known to
3815 * mac80211, even those that weren't previously programmed into
3816 * the device. This is intended for use in WoWLAN if the device
3817 * needs reprogramming of the keys during suspend. Note that due
3818 * to locking reasons, it is also only safe to call this at few
3819 * spots since it must hold the RTNL and be able to sleep.
3820 *
3821 * The order in which the keys are iterated matches the order
3822 * in which they were originally installed and handed to the
3823 * set_key callback.
3824 */
3825void ieee80211_iter_keys(struct ieee80211_hw *hw,
3826			 struct ieee80211_vif *vif,
3827			 void (*iter)(struct ieee80211_hw *hw,
3828				      struct ieee80211_vif *vif,
3829				      struct ieee80211_sta *sta,
3830				      struct ieee80211_key_conf *key,
3831				      void *data),
3832			 void *iter_data);
3833
3834/**
3835 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
3836 * @hw: pointre obtained from ieee80211_alloc_hw().
3837 * @iter: iterator function
3838 * @iter_data: data passed to iterator function
3839 *
3840 * Iterate all active channel contexts. This function is atomic and
3841 * doesn't acquire any locks internally that might be held in other
3842 * places while calling into the driver.
3843 *
3844 * The iterator will not find a context that's being added (during
3845 * the driver callback to add it) but will find it while it's being
3846 * removed.
3847 *
3848 * Note that during hardware restart, all contexts that existed
3849 * before the restart are considered already present so will be
3850 * found while iterating, whether they've been re-added already
3851 * or not.
3852 */
3853void ieee80211_iter_chan_contexts_atomic(
3854	struct ieee80211_hw *hw,
3855	void (*iter)(struct ieee80211_hw *hw,
3856		     struct ieee80211_chanctx_conf *chanctx_conf,
3857		     void *data),
3858	void *iter_data);
3859
3860/**
3861 * ieee80211_ap_probereq_get - retrieve a Probe Request template
3862 * @hw: pointer obtained from ieee80211_alloc_hw().
3863 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3864 *
3865 * Creates a Probe Request template which can, for example, be uploaded to
3866 * hardware. The template is filled with bssid, ssid and supported rate
3867 * information. This function must only be called from within the
3868 * .bss_info_changed callback function and only in managed mode. The function
3869 * is only useful when the interface is associated, otherwise it will return
3870 * %NULL.
3871 *
3872 * Return: The Probe Request template. %NULL on error.
3873 */
3874struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
3875					  struct ieee80211_vif *vif);
3876
3877/**
3878 * ieee80211_beacon_loss - inform hardware does not receive beacons
3879 *
3880 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3881 *
3882 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
3883 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
3884 * hardware is not receiving beacons with this function.
3885 */
3886void ieee80211_beacon_loss(struct ieee80211_vif *vif);
3887
3888/**
3889 * ieee80211_connection_loss - inform hardware has lost connection to the AP
3890 *
3891 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3892 *
3893 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
3894 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
3895 * needs to inform if the connection to the AP has been lost.
3896 * The function may also be called if the connection needs to be terminated
3897 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
3898 *
3899 * This function will cause immediate change to disassociated state,
3900 * without connection recovery attempts.
3901 */
3902void ieee80211_connection_loss(struct ieee80211_vif *vif);
3903
3904/**
3905 * ieee80211_resume_disconnect - disconnect from AP after resume
3906 *
3907 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3908 *
3909 * Instructs mac80211 to disconnect from the AP after resume.
3910 * Drivers can use this after WoWLAN if they know that the
3911 * connection cannot be kept up, for example because keys were
3912 * used while the device was asleep but the replay counters or
3913 * similar cannot be retrieved from the device during resume.
3914 *
3915 * Note that due to implementation issues, if the driver uses
3916 * the reconfiguration functionality during resume the interface
3917 * will still be added as associated first during resume and then
3918 * disconnect normally later.
3919 *
3920 * This function can only be called from the resume callback and
3921 * the driver must not be holding any of its own locks while it
3922 * calls this function, or at least not any locks it needs in the
3923 * key configuration paths (if it supports HW crypto).
3924 */
3925void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
3926
3927/**
3928 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
3929 *	rssi threshold triggered
3930 *
3931 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3932 * @rssi_event: the RSSI trigger event type
3933 * @gfp: context flags
3934 *
3935 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
3936 * monitoring is configured with an rssi threshold, the driver will inform
3937 * whenever the rssi level reaches the threshold.
3938 */
3939void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
3940			       enum nl80211_cqm_rssi_threshold_event rssi_event,
3941			       gfp_t gfp);
3942
3943/**
3944 * ieee80211_chswitch_done - Complete channel switch process
3945 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3946 * @success: make the channel switch successful or not
3947 *
3948 * Complete the channel switch post-process: set the new operational channel
3949 * and wake up the suspended queues.
3950 */
3951void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
3952
3953/**
3954 * ieee80211_request_smps - request SM PS transition
3955 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3956 * @smps_mode: new SM PS mode
3957 *
3958 * This allows the driver to request an SM PS transition in managed
3959 * mode. This is useful when the driver has more information than
3960 * the stack about possible interference, for example by bluetooth.
3961 */
3962void ieee80211_request_smps(struct ieee80211_vif *vif,
3963			    enum ieee80211_smps_mode smps_mode);
3964
3965/**
3966 * ieee80211_ready_on_channel - notification of remain-on-channel start
3967 * @hw: pointer as obtained from ieee80211_alloc_hw()
3968 */
3969void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
3970
3971/**
3972 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
3973 * @hw: pointer as obtained from ieee80211_alloc_hw()
3974 */
3975void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
3976
3977/**
3978 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
3979 *
3980 * in order not to harm the system performance and user experience, the device
3981 * may request not to allow any rx ba session and tear down existing rx ba
3982 * sessions based on system constraints such as periodic BT activity that needs
3983 * to limit wlan activity (eg.sco or a2dp)."
3984 * in such cases, the intention is to limit the duration of the rx ppdu and
3985 * therefore prevent the peer device to use a-mpdu aggregation.
3986 *
3987 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3988 * @ba_rx_bitmap: Bit map of open rx ba per tid
3989 * @addr: & to bssid mac address
3990 */
3991void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
3992				  const u8 *addr);
3993
3994/**
3995 * ieee80211_send_bar - send a BlockAckReq frame
3996 *
3997 * can be used to flush pending frames from the peer's aggregation reorder
3998 * buffer.
3999 *
4000 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4001 * @ra: the peer's destination address
4002 * @tid: the TID of the aggregation session
4003 * @ssn: the new starting sequence number for the receiver
4004 */
4005void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
4006
4007/* Rate control API */
4008
4009/**
4010 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
4011 *
4012 * @hw: The hardware the algorithm is invoked for.
4013 * @sband: The band this frame is being transmitted on.
4014 * @bss_conf: the current BSS configuration
4015 * @skb: the skb that will be transmitted, the control information in it needs
4016 *	to be filled in
4017 * @reported_rate: The rate control algorithm can fill this in to indicate
4018 *	which rate should be reported to userspace as the current rate and
4019 *	used for rate calculations in the mesh network.
4020 * @rts: whether RTS will be used for this frame because it is longer than the
4021 *	RTS threshold
4022 * @short_preamble: whether mac80211 will request short-preamble transmission
4023 *	if the selected rate supports it
4024 * @max_rate_idx: user-requested maximum (legacy) rate
4025 *	(deprecated; this will be removed once drivers get updated to use
4026 *	rate_idx_mask)
4027 * @rate_idx_mask: user-requested (legacy) rate mask
4028 * @rate_idx_mcs_mask: user-requested MCS rate mask
4029 * @bss: whether this frame is sent out in AP or IBSS mode
4030 */
4031struct ieee80211_tx_rate_control {
4032	struct ieee80211_hw *hw;
4033	struct ieee80211_supported_band *sband;
4034	struct ieee80211_bss_conf *bss_conf;
4035	struct sk_buff *skb;
4036	struct ieee80211_tx_rate reported_rate;
4037	bool rts, short_preamble;
4038	u8 max_rate_idx;
4039	u32 rate_idx_mask;
4040	u8 rate_idx_mcs_mask[IEEE80211_HT_MCS_MASK_LEN];
4041	bool bss;
4042};
4043
4044struct rate_control_ops {
4045	struct module *module;
4046	const char *name;
4047	void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
4048	void (*free)(void *priv);
4049
4050	void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
4051	void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
4052			  struct ieee80211_sta *sta, void *priv_sta);
4053	void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
4054			    struct ieee80211_sta *sta, void *priv_sta,
4055			    u32 changed);
4056	void (*free_sta)(void *priv, struct ieee80211_sta *sta,
4057			 void *priv_sta);
4058
4059	void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
4060			  struct ieee80211_sta *sta, void *priv_sta,
4061			  struct sk_buff *skb);
4062	void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
4063			 struct ieee80211_tx_rate_control *txrc);
4064
4065	void (*add_sta_debugfs)(void *priv, void *priv_sta,
4066				struct dentry *dir);
4067	void (*remove_sta_debugfs)(void *priv, void *priv_sta);
4068};
4069
4070static inline int rate_supported(struct ieee80211_sta *sta,
4071				 enum ieee80211_band band,
4072				 int index)
4073{
4074	return (sta == NULL || sta->supp_rates[band] & BIT(index));
4075}
4076
4077/**
4078 * rate_control_send_low - helper for drivers for management/no-ack frames
4079 *
4080 * Rate control algorithms that agree to use the lowest rate to
4081 * send management frames and NO_ACK data with the respective hw
4082 * retries should use this in the beginning of their mac80211 get_rate
4083 * callback. If true is returned the rate control can simply return.
4084 * If false is returned we guarantee that sta and sta and priv_sta is
4085 * not null.
4086 *
4087 * Rate control algorithms wishing to do more intelligent selection of
4088 * rate for multicast/broadcast frames may choose to not use this.
4089 *
4090 * @sta: &struct ieee80211_sta pointer to the target destination. Note
4091 * 	that this may be null.
4092 * @priv_sta: private rate control structure. This may be null.
4093 * @txrc: rate control information we sholud populate for mac80211.
4094 */
4095bool rate_control_send_low(struct ieee80211_sta *sta,
4096			   void *priv_sta,
4097			   struct ieee80211_tx_rate_control *txrc);
4098
4099
4100static inline s8
4101rate_lowest_index(struct ieee80211_supported_band *sband,
4102		  struct ieee80211_sta *sta)
4103{
4104	int i;
4105
4106	for (i = 0; i < sband->n_bitrates; i++)
4107		if (rate_supported(sta, sband->band, i))
4108			return i;
4109
4110	/* warn when we cannot find a rate. */
4111	WARN_ON_ONCE(1);
4112
4113	/* and return 0 (the lowest index) */
4114	return 0;
4115}
4116
4117static inline
4118bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
4119			      struct ieee80211_sta *sta)
4120{
4121	unsigned int i;
4122
4123	for (i = 0; i < sband->n_bitrates; i++)
4124		if (rate_supported(sta, sband->band, i))
4125			return true;
4126	return false;
4127}
4128
4129int ieee80211_rate_control_register(struct rate_control_ops *ops);
4130void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
4131
4132static inline bool
4133conf_is_ht20(struct ieee80211_conf *conf)
4134{
4135	return conf->channel_type == NL80211_CHAN_HT20;
4136}
4137
4138static inline bool
4139conf_is_ht40_minus(struct ieee80211_conf *conf)
4140{
4141	return conf->channel_type == NL80211_CHAN_HT40MINUS;
4142}
4143
4144static inline bool
4145conf_is_ht40_plus(struct ieee80211_conf *conf)
4146{
4147	return conf->channel_type == NL80211_CHAN_HT40PLUS;
4148}
4149
4150static inline bool
4151conf_is_ht40(struct ieee80211_conf *conf)
4152{
4153	return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
4154}
4155
4156static inline bool
4157conf_is_ht(struct ieee80211_conf *conf)
4158{
4159	return conf->channel_type != NL80211_CHAN_NO_HT;
4160}
4161
4162static inline enum nl80211_iftype
4163ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
4164{
4165	if (p2p) {
4166		switch (type) {
4167		case NL80211_IFTYPE_STATION:
4168			return NL80211_IFTYPE_P2P_CLIENT;
4169		case NL80211_IFTYPE_AP:
4170			return NL80211_IFTYPE_P2P_GO;
4171		default:
4172			break;
4173		}
4174	}
4175	return type;
4176}
4177
4178static inline enum nl80211_iftype
4179ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
4180{
4181	return ieee80211_iftype_p2p(vif->type, vif->p2p);
4182}
4183
4184void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
4185				   int rssi_min_thold,
4186				   int rssi_max_thold);
4187
4188void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
4189
4190/**
4191 * ieee80211_ave_rssi - report the average RSSI for the specified interface
4192 *
4193 * @vif: the specified virtual interface
4194 *
4195 * Note: This function assumes that the given vif is valid.
4196 *
4197 * Return: The average RSSI value for the requested interface, or 0 if not
4198 * applicable.
4199 */
4200int ieee80211_ave_rssi(struct ieee80211_vif *vif);
4201
4202/**
4203 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
4204 * @vif: virtual interface
4205 * @wakeup: wakeup reason(s)
4206 * @gfp: allocation flags
4207 *
4208 * See cfg80211_report_wowlan_wakeup().
4209 */
4210void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
4211				    struct cfg80211_wowlan_wakeup *wakeup,
4212				    gfp_t gfp);
4213
4214#endif /* MAC80211_H */
4215