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