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