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