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