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