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