]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - include/net/mac80211.h
Merge tag 'clk-fixes-for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git...
[mirror_ubuntu-zesty-kernel.git] / include / net / mac80211.h
CommitLineData
f0706e82 1/*
3017b80b
JB
2 * mac80211 <-> driver interface
3 *
f0706e82
JB
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
026331c4 6 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
d98ad83e 7 * Copyright 2013-2014 Intel Mobile Communications GmbH
f0706e82
JB
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
12 */
13
14#ifndef MAC80211_H
15#define MAC80211_H
16
187f1882 17#include <linux/bug.h>
f0706e82
JB
18#include <linux/kernel.h>
19#include <linux/if_ether.h>
20#include <linux/skbuff.h>
f0706e82 21#include <linux/ieee80211.h>
f0706e82 22#include <net/cfg80211.h>
42d98795 23#include <asm/unaligned.h>
f0706e82 24
75a5f0cc
JB
25/**
26 * DOC: Introduction
27 *
28 * mac80211 is the Linux stack for 802.11 hardware that implements
29 * only partial functionality in hard- or firmware. This document
30 * defines the interface between mac80211 and low-level hardware
31 * drivers.
32 */
33
34/**
35 * DOC: Calling mac80211 from interrupts
36 *
37 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
f0706e82
JB
38 * called in hardware interrupt context. The low-level driver must not call any
39 * other functions in hardware interrupt context. If there is a need for such
40 * call, the low-level driver should first ACK the interrupt and perform the
2485f710
JB
41 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
42 * tasklet function.
43 *
44 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
6ef307bc 45 * use the non-IRQ-safe functions!
f0706e82
JB
46 */
47
75a5f0cc
JB
48/**
49 * DOC: Warning
50 *
51 * If you're reading this document and not the header file itself, it will
52 * be incomplete because not all documentation has been converted yet.
53 */
54
55/**
56 * DOC: Frame format
57 *
58 * As a general rule, when frames are passed between mac80211 and the driver,
59 * they start with the IEEE 802.11 header and include the same octets that are
60 * sent over the air except for the FCS which should be calculated by the
61 * hardware.
62 *
63 * There are, however, various exceptions to this rule for advanced features:
64 *
65 * The first exception is for hardware encryption and decryption offload
66 * where the IV/ICV may or may not be generated in hardware.
67 *
68 * Secondly, when the hardware handles fragmentation, the frame handed to
69 * the driver from mac80211 is the MSDU, not the MPDU.
f0706e82
JB
70 */
71
42935eca
LR
72/**
73 * DOC: mac80211 workqueue
74 *
75 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
76 * The workqueue is a single threaded workqueue and can only be accessed by
77 * helpers for sanity checking. Drivers must ensure all work added onto the
78 * mac80211 workqueue should be cancelled on the driver stop() callback.
79 *
80 * mac80211 will flushed the workqueue upon interface removal and during
81 * suspend.
82 *
83 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
84 *
85 */
86
ba8c3d6f
FF
87/**
88 * DOC: mac80211 software tx queueing
89 *
90 * mac80211 provides an optional intermediate queueing implementation designed
91 * to allow the driver to keep hardware queues short and provide some fairness
92 * between different stations/interfaces.
93 * In this model, the driver pulls data frames from the mac80211 queue instead
94 * of letting mac80211 push them via drv_tx().
95 * Other frames (e.g. control or management) are still pushed using drv_tx().
96 *
97 * Drivers indicate that they use this model by implementing the .wake_tx_queue
98 * driver operation.
99 *
100 * Intermediate queues (struct ieee80211_txq) are kept per-sta per-tid, with a
101 * single per-vif queue for multicast data frames.
102 *
103 * The driver is expected to initialize its private per-queue data for stations
104 * and interfaces in the .add_interface and .sta_add ops.
105 *
106 * The driver can't access the queue directly. To dequeue a frame, it calls
107 * ieee80211_tx_dequeue(). Whenever mac80211 adds a new frame to a queue, it
108 * calls the .wake_tx_queue driver op.
109 *
110 * For AP powersave TIM handling, the driver only needs to indicate if it has
111 * buffered packets in the driver specific data structures by calling
112 * ieee80211_sta_set_buffered(). For frames buffered in the ieee80211_txq
113 * struct, mac80211 sets the appropriate TIM PVB bits and calls
114 * .release_buffered_frames().
115 * In that callback the driver is therefore expected to release its own
116 * buffered frames and afterwards also frames from the ieee80211_txq (obtained
117 * via the usual ieee80211_tx_dequeue).
118 */
119
313162d0
PG
120struct device;
121
e100bb64
JB
122/**
123 * enum ieee80211_max_queues - maximum number of queues
124 *
125 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
445ea4e8 126 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
e100bb64
JB
127 */
128enum ieee80211_max_queues {
3a25a8c8 129 IEEE80211_MAX_QUEUES = 16,
445ea4e8 130 IEEE80211_MAX_QUEUE_MAP = BIT(IEEE80211_MAX_QUEUES) - 1,
e100bb64
JB
131};
132
3a25a8c8
JB
133#define IEEE80211_INVAL_HW_QUEUE 0xff
134
4bce22b9
JB
135/**
136 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
137 * @IEEE80211_AC_VO: voice
138 * @IEEE80211_AC_VI: video
139 * @IEEE80211_AC_BE: best effort
140 * @IEEE80211_AC_BK: background
141 */
142enum ieee80211_ac_numbers {
143 IEEE80211_AC_VO = 0,
144 IEEE80211_AC_VI = 1,
145 IEEE80211_AC_BE = 2,
146 IEEE80211_AC_BK = 3,
147};
948d887d 148#define IEEE80211_NUM_ACS 4
4bce22b9 149
6b301cdf
JB
150/**
151 * struct ieee80211_tx_queue_params - transmit queue configuration
152 *
153 * The information provided in this structure is required for QoS
3330d7be 154 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
6b301cdf 155 *
e37d4dff 156 * @aifs: arbitration interframe space [0..255]
f434b2d1
JB
157 * @cw_min: minimum contention window [a value of the form
158 * 2^n-1 in the range 1..32767]
6b301cdf 159 * @cw_max: maximum contention window [like @cw_min]
3330d7be 160 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
908f8d07 161 * @acm: is mandatory admission control required for the access category
9d173fc5 162 * @uapsd: is U-APSD mode enabled for the queue
6b301cdf 163 */
f0706e82 164struct ieee80211_tx_queue_params {
f434b2d1 165 u16 txop;
3330d7be
JB
166 u16 cw_min;
167 u16 cw_max;
f434b2d1 168 u8 aifs;
908f8d07 169 bool acm;
ab13315a 170 bool uapsd;
f0706e82
JB
171};
172
f0706e82
JB
173struct ieee80211_low_level_stats {
174 unsigned int dot11ACKFailureCount;
175 unsigned int dot11RTSFailureCount;
176 unsigned int dot11FCSErrorCount;
177 unsigned int dot11RTSSuccessCount;
178};
179
d01a1e65
MK
180/**
181 * enum ieee80211_chanctx_change - change flag for channel context
4bf88530 182 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
04ecd257 183 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
164eb02d 184 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
73da7d5b
SW
185 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
186 * this is used only with channel switching with CSA
21f659bf 187 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
d01a1e65
MK
188 */
189enum ieee80211_chanctx_change {
4bf88530 190 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0),
04ecd257 191 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1),
164eb02d 192 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2),
73da7d5b 193 IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(3),
21f659bf 194 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH = BIT(4),
d01a1e65
MK
195};
196
197/**
198 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
199 *
200 * This is the driver-visible part. The ieee80211_chanctx
201 * that contains it is visible in mac80211 only.
202 *
4bf88530 203 * @def: the channel definition
21f659bf 204 * @min_def: the minimum channel definition currently required.
04ecd257
JB
205 * @rx_chains_static: The number of RX chains that must always be
206 * active on the channel to receive MIMO transmissions
207 * @rx_chains_dynamic: The number of RX chains that must be enabled
208 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
5d7fad48 209 * this will always be >= @rx_chains_static.
164eb02d 210 * @radar_enabled: whether radar detection is enabled on this channel.
d01a1e65
MK
211 * @drv_priv: data area for driver use, will always be aligned to
212 * sizeof(void *), size is determined in hw information.
213 */
214struct ieee80211_chanctx_conf {
4bf88530 215 struct cfg80211_chan_def def;
21f659bf 216 struct cfg80211_chan_def min_def;
d01a1e65 217
04ecd257
JB
218 u8 rx_chains_static, rx_chains_dynamic;
219
164eb02d
SW
220 bool radar_enabled;
221
1c06ef98 222 u8 drv_priv[0] __aligned(sizeof(void *));
d01a1e65
MK
223};
224
1a5f0c13
LC
225/**
226 * enum ieee80211_chanctx_switch_mode - channel context switch mode
227 * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already
228 * exist (and will continue to exist), but the virtual interface
229 * needs to be switched from one to the other.
230 * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop
231 * to exist with this call, the new context doesn't exist but
232 * will be active after this call, the virtual interface switches
233 * from the old to the new (note that the driver may of course
234 * implement this as an on-the-fly chandef switch of the existing
235 * hardware context, but the mac80211 pointer for the old context
236 * will cease to exist and only the new one will later be used
237 * for changes/removal.)
238 */
239enum ieee80211_chanctx_switch_mode {
240 CHANCTX_SWMODE_REASSIGN_VIF,
241 CHANCTX_SWMODE_SWAP_CONTEXTS,
242};
243
244/**
245 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information
246 *
247 * This is structure is used to pass information about a vif that
248 * needs to switch from one chanctx to another. The
249 * &ieee80211_chanctx_switch_mode defines how the switch should be
250 * done.
251 *
252 * @vif: the vif that should be switched from old_ctx to new_ctx
253 * @old_ctx: the old context to which the vif was assigned
254 * @new_ctx: the new context to which the vif must be assigned
255 */
256struct ieee80211_vif_chanctx_switch {
257 struct ieee80211_vif *vif;
258 struct ieee80211_chanctx_conf *old_ctx;
259 struct ieee80211_chanctx_conf *new_ctx;
260};
261
471b3efd
JB
262/**
263 * enum ieee80211_bss_change - BSS change notification flags
264 *
265 * These flags are used with the bss_info_changed() callback
266 * to indicate which BSS parameter changed.
267 *
268 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
269 * also implies a change in the AID.
270 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
271 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
9f1ba906 272 * @BSS_CHANGED_ERP_SLOT: slot timing changed
38668c05 273 * @BSS_CHANGED_HT: 802.11n parameters changed
96dd22ac 274 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
57c4d7b4 275 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
2d0ddec5
JB
276 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
277 * reason (IBSS and managed mode)
278 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
279 * new beacon (beaconing modes)
280 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
281 * enabled/disabled (beaconing modes)
a97c13c3 282 * @BSS_CHANGED_CQM: Connection quality monitor config changed
8fc214ba 283 * @BSS_CHANGED_IBSS: IBSS join status changed
68542962 284 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
4ced3f74
JB
285 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
286 * that it is only ever disabled for station mode.
7da7cc1d 287 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
0ca54f6c 288 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
02945821 289 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
ab095877 290 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
1ea6f9c0 291 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
488dd7b5
JB
292 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
293 * changed (currently only in P2P client mode, GO mode will be later)
989c6505
AB
294 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
295 * currently dtim_period only is under consideration.
2c9b7359
JB
296 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
297 * note that this is only called when it changes after the channel
298 * context had been assigned.
239281f8 299 * @BSS_CHANGED_OCB: OCB join status changed
471b3efd
JB
300 */
301enum ieee80211_bss_change {
302 BSS_CHANGED_ASSOC = 1<<0,
303 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
304 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
9f1ba906 305 BSS_CHANGED_ERP_SLOT = 1<<3,
a7ce1c94 306 BSS_CHANGED_HT = 1<<4,
96dd22ac 307 BSS_CHANGED_BASIC_RATES = 1<<5,
57c4d7b4 308 BSS_CHANGED_BEACON_INT = 1<<6,
2d0ddec5
JB
309 BSS_CHANGED_BSSID = 1<<7,
310 BSS_CHANGED_BEACON = 1<<8,
311 BSS_CHANGED_BEACON_ENABLED = 1<<9,
a97c13c3 312 BSS_CHANGED_CQM = 1<<10,
8fc214ba 313 BSS_CHANGED_IBSS = 1<<11,
68542962 314 BSS_CHANGED_ARP_FILTER = 1<<12,
4ced3f74 315 BSS_CHANGED_QOS = 1<<13,
7da7cc1d 316 BSS_CHANGED_IDLE = 1<<14,
7827493b 317 BSS_CHANGED_SSID = 1<<15,
02945821 318 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
ab095877 319 BSS_CHANGED_PS = 1<<17,
1ea6f9c0 320 BSS_CHANGED_TXPOWER = 1<<18,
488dd7b5 321 BSS_CHANGED_P2P_PS = 1<<19,
989c6505 322 BSS_CHANGED_BEACON_INFO = 1<<20,
2c9b7359 323 BSS_CHANGED_BANDWIDTH = 1<<21,
239281f8 324 BSS_CHANGED_OCB = 1<<22,
ac8dd506
JB
325
326 /* when adding here, make sure to change ieee80211_reconfig */
471b3efd
JB
327};
328
68542962
JO
329/*
330 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
331 * of addresses for an interface increase beyond this value, hardware ARP
332 * filtering will be disabled.
333 */
334#define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
335
615f7b9b 336/**
a8182929
EG
337 * enum ieee80211_event_type - event to be notified to the low level driver
338 * @RSSI_EVENT: AP's rssi crossed the a threshold set by the driver.
a9409093 339 * @MLME_EVENT: event related to MLME
6382246e 340 * @BAR_RX_EVENT: a BAR was received
b497de63
EG
341 * @BA_FRAME_TIMEOUT: Frames were released from the reordering buffer because
342 * they timed out. This won't be called for each frame released, but only
343 * once each time the timeout triggers.
615f7b9b 344 */
a8182929
EG
345enum ieee80211_event_type {
346 RSSI_EVENT,
a9409093 347 MLME_EVENT,
6382246e 348 BAR_RX_EVENT,
b497de63 349 BA_FRAME_TIMEOUT,
a8182929
EG
350};
351
352/**
353 * enum ieee80211_rssi_event_data - relevant when event type is %RSSI_EVENT
354 * @RSSI_EVENT_HIGH: AP's rssi went below the threshold set by the driver.
355 * @RSSI_EVENT_LOW: AP's rssi went above the threshold set by the driver.
356 */
357enum ieee80211_rssi_event_data {
615f7b9b
MV
358 RSSI_EVENT_HIGH,
359 RSSI_EVENT_LOW,
360};
361
a8182929 362/**
a839e463 363 * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT
a8182929
EG
364 * @data: See &enum ieee80211_rssi_event_data
365 */
366struct ieee80211_rssi_event {
367 enum ieee80211_rssi_event_data data;
368};
369
a9409093
EG
370/**
371 * enum ieee80211_mlme_event_data - relevant when event type is %MLME_EVENT
372 * @AUTH_EVENT: the MLME operation is authentication
d0d1a12f 373 * @ASSOC_EVENT: the MLME operation is association
a90faa9d
EG
374 * @DEAUTH_RX_EVENT: deauth received..
375 * @DEAUTH_TX_EVENT: deauth sent.
a9409093
EG
376 */
377enum ieee80211_mlme_event_data {
378 AUTH_EVENT,
d0d1a12f 379 ASSOC_EVENT,
a90faa9d
EG
380 DEAUTH_RX_EVENT,
381 DEAUTH_TX_EVENT,
a9409093
EG
382};
383
384/**
385 * enum ieee80211_mlme_event_status - relevant when event type is %MLME_EVENT
386 * @MLME_SUCCESS: the MLME operation completed successfully.
387 * @MLME_DENIED: the MLME operation was denied by the peer.
388 * @MLME_TIMEOUT: the MLME operation timed out.
389 */
390enum ieee80211_mlme_event_status {
391 MLME_SUCCESS,
392 MLME_DENIED,
393 MLME_TIMEOUT,
394};
395
396/**
a839e463 397 * struct ieee80211_mlme_event - data attached to an %MLME_EVENT
a9409093
EG
398 * @data: See &enum ieee80211_mlme_event_data
399 * @status: See &enum ieee80211_mlme_event_status
400 * @reason: the reason code if applicable
401 */
402struct ieee80211_mlme_event {
403 enum ieee80211_mlme_event_data data;
404 enum ieee80211_mlme_event_status status;
405 u16 reason;
406};
407
6382246e
EG
408/**
409 * struct ieee80211_ba_event - data attached for BlockAck related events
410 * @sta: pointer to the &ieee80211_sta to which this event relates
411 * @tid: the tid
b497de63 412 * @ssn: the starting sequence number (for %BAR_RX_EVENT)
6382246e
EG
413 */
414struct ieee80211_ba_event {
415 struct ieee80211_sta *sta;
416 u16 tid;
417 u16 ssn;
418};
419
a8182929
EG
420/**
421 * struct ieee80211_event - event to be sent to the driver
a839e463 422 * @type: The event itself. See &enum ieee80211_event_type.
a8182929 423 * @rssi: relevant if &type is %RSSI_EVENT
a9409093 424 * @mlme: relevant if &type is %AUTH_EVENT
b497de63 425 * @ba: relevant if &type is %BAR_RX_EVENT or %BA_FRAME_TIMEOUT
6382246e 426 * @u:union holding the fields above
a8182929
EG
427 */
428struct ieee80211_event {
429 enum ieee80211_event_type type;
430 union {
431 struct ieee80211_rssi_event rssi;
a9409093 432 struct ieee80211_mlme_event mlme;
6382246e 433 struct ieee80211_ba_event ba;
a8182929
EG
434 } u;
435};
436
471b3efd
JB
437/**
438 * struct ieee80211_bss_conf - holds the BSS's changing parameters
439 *
440 * This structure keeps information about a BSS (and an association
441 * to that BSS) that can change during the lifetime of the BSS.
442 *
443 * @assoc: association status
8fc214ba
JB
444 * @ibss_joined: indicates whether this station is part of an IBSS
445 * or not
c13a765b 446 * @ibss_creator: indicates if a new IBSS network is being created
471b3efd
JB
447 * @aid: association ID number, valid only when @assoc is true
448 * @use_cts_prot: use CTS protection
ea1b2b45
JB
449 * @use_short_preamble: use 802.11b short preamble
450 * @use_short_slot: use short slot time (only relevant for ERP)
56007a02 451 * @dtim_period: num of beacons before the next DTIM, for beaconing,
c65dd147 452 * valid in station mode only if after the driver was notified
989c6505 453 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
8c358bcd 454 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
ef429dad
JB
455 * as it may have been received during scanning long ago). If the
456 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
457 * only come from a beacon, but might not become valid until after
458 * association when a beacon is received (which is notified with the
2ecc3905 459 * %BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice.
8c358bcd
JB
460 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
461 * the driver/device can use this to calculate synchronisation
2ecc3905 462 * (see @sync_tsf). See also sync_dtim_count important notice.
ef429dad
JB
463 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
464 * is requested, see @sync_tsf/@sync_device_ts.
2ecc3905
AB
465 * IMPORTANT: These three sync_* parameters would possibly be out of sync
466 * by the time the driver will use them. The synchronized view is currently
467 * guaranteed only in certain callbacks.
21c0cbe7 468 * @beacon_int: beacon interval
98f7dfd8 469 * @assoc_capability: capabilities taken from assoc resp
96dd22ac
JB
470 * @basic_rates: bitmap of basic rates, each bit stands for an
471 * index into the rate table configured by the driver in
472 * the current band.
817cee76 473 * @beacon_rate: associated AP's beacon TX rate
dd5b4cc7 474 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
2d0ddec5
JB
475 * @bssid: The BSSID for this BSS
476 * @enable_beacon: whether beaconing should be enabled or not
4bf88530
JB
477 * @chandef: Channel definition for this BSS -- the hardware might be
478 * configured a higher bandwidth than this BSS uses, for example.
074d46d1 479 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
22f66895
AA
480 * This field is only valid when the channel is a wide HT/VHT channel.
481 * Note that with TDLS this can be the case (channel is HT, protection must
482 * be used from this field) even when the BSS association isn't using HT.
a97c13c3
JO
483 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
484 * implies disabled
485 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
68542962
JO
486 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
487 * may filter ARP queries targeted for other addresses than listed here.
488 * The driver must allow ARP queries targeted for all address listed here
489 * to pass through. An empty list implies no ARP queries need to pass.
0f19b41e
JB
490 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
491 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
492 * array size), it's up to the driver what to do in that case.
4ced3f74 493 * @qos: This is a QoS-enabled BSS.
7da7cc1d
JB
494 * @idle: This interface is idle. There's also a global idle flag in the
495 * hardware config which may be more appropriate depending on what
496 * your driver/device needs to do.
ab095877
EP
497 * @ps: power-save mode (STA only). This flag is NOT affected by
498 * offchannel/dynamic_ps operations.
0ca54f6c 499 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
7827493b
AN
500 * @ssid_len: Length of SSID given in @ssid.
501 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
1ea6f9c0 502 * @txpower: TX power in dBm
db82d8a9
LB
503 * @txpower_type: TX power adjustment used to control per packet Transmit
504 * Power Control (TPC) in lower driver for the current vif. In particular
505 * TPC is enabled if value passed in %txpower_type is
506 * NL80211_TX_POWER_LIMITED (allow using less than specified from
507 * userspace), whereas TPC is disabled if %txpower_type is set to
508 * NL80211_TX_POWER_FIXED (use value configured from userspace)
67baf663 509 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
471b3efd
JB
510 */
511struct ieee80211_bss_conf {
2d0ddec5 512 const u8 *bssid;
471b3efd 513 /* association related data */
8fc214ba 514 bool assoc, ibss_joined;
c13a765b 515 bool ibss_creator;
471b3efd
JB
516 u16 aid;
517 /* erp related data */
518 bool use_cts_prot;
519 bool use_short_preamble;
9f1ba906 520 bool use_short_slot;
2d0ddec5 521 bool enable_beacon;
98f7dfd8 522 u8 dtim_period;
21c0cbe7
TW
523 u16 beacon_int;
524 u16 assoc_capability;
8c358bcd
JB
525 u64 sync_tsf;
526 u32 sync_device_ts;
ef429dad 527 u8 sync_dtim_count;
881d948c 528 u32 basic_rates;
817cee76 529 struct ieee80211_rate *beacon_rate;
dd5b4cc7 530 int mcast_rate[IEEE80211_NUM_BANDS];
9ed6bcce 531 u16 ht_operation_mode;
a97c13c3
JO
532 s32 cqm_rssi_thold;
533 u32 cqm_rssi_hyst;
4bf88530 534 struct cfg80211_chan_def chandef;
68542962 535 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
0f19b41e 536 int arp_addr_cnt;
4ced3f74 537 bool qos;
7da7cc1d 538 bool idle;
ab095877 539 bool ps;
7827493b
AN
540 u8 ssid[IEEE80211_MAX_SSID_LEN];
541 size_t ssid_len;
542 bool hidden_ssid;
1ea6f9c0 543 int txpower;
db82d8a9 544 enum nl80211_tx_power_setting txpower_type;
67baf663 545 struct ieee80211_p2p_noa_attr p2p_noa_attr;
471b3efd
JB
546};
547
11f4b1ce 548/**
af61a165 549 * enum mac80211_tx_info_flags - flags to describe transmission information/status
e039fa4a 550 *
6ef307bc 551 * These flags are used with the @flags member of &ieee80211_tx_info.
e039fa4a 552 *
7351c6bd 553 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
e6a9854b
JB
554 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
555 * number to this frame, taking care of not overwriting the fragment
556 * number and increasing the sequence number only when the
557 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
558 * assign sequence numbers to QoS-data frames but cannot do so correctly
559 * for non-QoS-data and management frames because beacons need them from
560 * that counter as well and mac80211 cannot guarantee proper sequencing.
561 * If this flag is set, the driver should instruct the hardware to
562 * assign a sequence number to the frame or assign one itself. Cf. IEEE
563 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
564 * beacons and always be clear for frames without a sequence number field.
e039fa4a 565 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
e039fa4a
JB
566 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
567 * station
e039fa4a 568 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
e039fa4a
JB
569 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
570 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
e6a9854b 571 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
e039fa4a 572 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
ab5b5342
JB
573 * because the destination STA was in powersave mode. Note that to
574 * avoid race conditions, the filter must be set by the hardware or
575 * firmware upon receiving a frame that indicates that the station
576 * went to sleep (must be done on device to filter frames already on
577 * the queue) and may only be unset after mac80211 gives the OK for
578 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
579 * since only then is it guaranteed that no more frames are in the
580 * hardware queue.
e039fa4a
JB
581 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
582 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
583 * is for the whole aggregation.
429a3805
RR
584 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
585 * so consider using block ack request (BAR).
e6a9854b
JB
586 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
587 * set by rate control algorithms to indicate probe rate, will
588 * be cleared for fragmented frames (except on the last fragment)
6c17b77b
SF
589 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
590 * that a frame can be transmitted while the queues are stopped for
591 * off-channel operation.
cd8ffc80
JB
592 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
593 * used to indicate that a pending frame requires TX processing before
594 * it can be sent out.
8f77f384
JB
595 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
596 * used to indicate that a frame was already retried due to PS
3b8d81e0
JB
597 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
598 * used to indicate frame should not be encrypted
02f2f1a9
JB
599 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
600 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
601 * be sent although the station is in powersave mode.
ad5351db
JB
602 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
603 * transmit function after the current frame, this can be used
604 * by drivers to kick the DMA queue only if unset or when the
605 * queue gets full.
c6fcf6bc
JB
606 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
607 * after TX status because the destination was asleep, it must not
608 * be modified again (no seqno assignment, crypto, etc.)
1672c0e3
JB
609 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
610 * code for connection establishment, this indicates that its status
611 * should kick the MLME state machine.
026331c4
JM
612 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
613 * MLME command (internal to mac80211 to figure out whether to send TX
614 * status to user space)
0a56bd0a 615 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
f79d9bad
FF
616 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
617 * frame and selects the maximum number of streams that it can use.
610dbc98
JB
618 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
619 * the off-channel channel when a remain-on-channel offload is done
620 * in hardware -- normal packets still flow and are expected to be
621 * handled properly by the device.
681d1190
JM
622 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
623 * testing. It will be sent out with incorrect Michael MIC key to allow
624 * TKIP countermeasures to be tested.
aad14ceb
RM
625 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
626 * This flag is actually used for management frame especially for P2P
627 * frames not being sent at CCK rate in 2GHz band.
47086fc5
JB
628 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
629 * when its status is reported the service period ends. For frames in
630 * an SP that mac80211 transmits, it is already set; for driver frames
deeaee19
JB
631 * the driver may set this flag. It is also used to do the same for
632 * PS-Poll responses.
b6f35301
RM
633 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
634 * This flag is used to send nullfunc frame at minimum rate when
635 * the nullfunc is used for connection monitoring purpose.
a26eb27a
JB
636 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
637 * would be fragmented by size (this is optional, only used for
638 * monitor injection).
5cf16616
SM
639 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
640 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
641 * any errors (like issues specific to the driver/HW).
642 * This flag must not be set for frames that don't request no-ack
643 * behaviour with IEEE80211_TX_CTL_NO_ACK.
eb7d3066
CL
644 *
645 * Note: If you have to add new flags to the enumeration, then don't
646 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
11f4b1ce 647 */
af61a165 648enum mac80211_tx_info_flags {
e039fa4a 649 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
e6a9854b
JB
650 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
651 IEEE80211_TX_CTL_NO_ACK = BIT(2),
652 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
653 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
654 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
655 IEEE80211_TX_CTL_AMPDU = BIT(6),
656 IEEE80211_TX_CTL_INJECTED = BIT(7),
657 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
658 IEEE80211_TX_STAT_ACK = BIT(9),
659 IEEE80211_TX_STAT_AMPDU = BIT(10),
660 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
661 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
6c17b77b 662 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
cd8ffc80 663 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
8f77f384 664 IEEE80211_TX_INTFL_RETRIED = BIT(15),
3b8d81e0 665 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
02f2f1a9 666 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
ad5351db 667 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
c6fcf6bc 668 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
1672c0e3 669 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
026331c4 670 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
0a56bd0a 671 IEEE80211_TX_CTL_LDPC = BIT(22),
f79d9bad 672 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
21f83589 673 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
681d1190 674 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
aad14ceb 675 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
47086fc5 676 IEEE80211_TX_STATUS_EOSP = BIT(28),
b6f35301 677 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
a26eb27a 678 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
5cf16616 679 IEEE80211_TX_STAT_NOACK_TRANSMITTED = BIT(31),
11f4b1ce
RR
680};
681
abe37c4b
JB
682#define IEEE80211_TX_CTL_STBC_SHIFT 23
683
af61a165
JB
684/**
685 * enum mac80211_tx_control_flags - flags to describe transmit control
686 *
687 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
688 * protocol frame (e.g. EAP)
6b127c71
SM
689 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
690 * frame (PS-Poll or uAPSD).
af61a165
JB
691 *
692 * These flags are used in tx_info->control.flags.
693 */
694enum mac80211_tx_control_flags {
695 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
6b127c71 696 IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1),
af61a165
JB
697};
698
eb7d3066
CL
699/*
700 * This definition is used as a mask to clear all temporary flags, which are
701 * set by the tx handlers for each transmission attempt by the mac80211 stack.
702 */
703#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
704 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
705 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
706 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
707 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
02f2f1a9 708 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
eb7d3066 709 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
47086fc5 710 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
eb7d3066 711
2134e7e7
S
712/**
713 * enum mac80211_rate_control_flags - per-rate flags set by the
714 * Rate Control algorithm.
715 *
716 * These flags are set by the Rate control algorithm for each rate during tx,
717 * in the @flags member of struct ieee80211_tx_rate.
718 *
719 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
720 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
721 * This is set if the current BSS requires ERP protection.
722 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
723 * @IEEE80211_TX_RC_MCS: HT rate.
8bc83c24
JB
724 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
725 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
2134e7e7
S
726 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
727 * Greenfield mode.
728 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
8bc83c24
JB
729 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
730 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
731 * (80+80 isn't supported yet)
2134e7e7
S
732 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
733 * adjacent 20 MHz channels, if the current channel type is
734 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
735 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
736 */
e6a9854b
JB
737enum mac80211_rate_control_flags {
738 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
739 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
740 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
741
8bc83c24 742 /* rate index is an HT/VHT MCS instead of an index */
e6a9854b
JB
743 IEEE80211_TX_RC_MCS = BIT(3),
744 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
745 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
746 IEEE80211_TX_RC_DUP_DATA = BIT(6),
747 IEEE80211_TX_RC_SHORT_GI = BIT(7),
8bc83c24
JB
748 IEEE80211_TX_RC_VHT_MCS = BIT(8),
749 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
750 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
e6a9854b
JB
751};
752
753
754/* there are 40 bytes if you don't need the rateset to be kept */
755#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
8318d78a 756
e6a9854b
JB
757/* if you do need the rateset, then you have less space */
758#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
1c014420 759
e6a9854b 760/* maximum number of rate stages */
e3e1a0bc 761#define IEEE80211_TX_MAX_RATES 4
870abdf6 762
0d528d85
FF
763/* maximum number of rate table entries */
764#define IEEE80211_TX_RATE_TABLE_SIZE 4
765
870abdf6 766/**
e6a9854b 767 * struct ieee80211_tx_rate - rate selection/status
870abdf6 768 *
e6a9854b
JB
769 * @idx: rate index to attempt to send with
770 * @flags: rate control flags (&enum mac80211_rate_control_flags)
e25cf4a6 771 * @count: number of tries in this rate before going to the next rate
e6a9854b
JB
772 *
773 * A value of -1 for @idx indicates an invalid rate and, if used
774 * in an array of retry rates, that no more rates should be tried.
775 *
776 * When used for transmit status reporting, the driver should
777 * always report the rate along with the flags it used.
c555b9b3
JB
778 *
779 * &struct ieee80211_tx_info contains an array of these structs
780 * in the control information, and it will be filled by the rate
781 * control algorithm according to what should be sent. For example,
782 * if this array contains, in the format { <idx>, <count> } the
783 * information
784 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
785 * then this means that the frame should be transmitted
786 * up to twice at rate 3, up to twice at rate 2, and up to four
787 * times at rate 1 if it doesn't get acknowledged. Say it gets
788 * acknowledged by the peer after the fifth attempt, the status
789 * information should then contain
790 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
791 * since it was transmitted twice at rate 3, twice at rate 2
792 * and once at rate 1 after which we received an acknowledgement.
870abdf6 793 */
e6a9854b
JB
794struct ieee80211_tx_rate {
795 s8 idx;
8bc83c24
JB
796 u16 count:5,
797 flags:11;
3f30fc15 798} __packed;
870abdf6 799
8bc83c24
JB
800#define IEEE80211_MAX_TX_RETRY 31
801
802static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
803 u8 mcs, u8 nss)
804{
805 WARN_ON(mcs & ~0xF);
6bc8312f
KB
806 WARN_ON((nss - 1) & ~0x7);
807 rate->idx = ((nss - 1) << 4) | mcs;
8bc83c24
JB
808}
809
810static inline u8
811ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
812{
813 return rate->idx & 0xF;
814}
815
816static inline u8
817ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
818{
6bc8312f 819 return (rate->idx >> 4) + 1;
8bc83c24
JB
820}
821
e039fa4a
JB
822/**
823 * struct ieee80211_tx_info - skb transmit information
824 *
825 * This structure is placed in skb->cb for three uses:
826 * (1) mac80211 TX control - mac80211 tells the driver what to do
827 * (2) driver internal use (if applicable)
828 * (3) TX status information - driver tells mac80211 what happened
829 *
830 * @flags: transmit info flags, defined above
e6a9854b 831 * @band: the band to transmit on (use for checking for races)
3a25a8c8 832 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
a729cff8 833 * @ack_frame_id: internal frame ID for TX status, used internally
6ef307bc
RD
834 * @control: union for control data
835 * @status: union for status data
836 * @driver_data: array of driver_data pointers
599bf6a4 837 * @ampdu_ack_len: number of acked aggregated frames.
93d95b12 838 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
599bf6a4 839 * @ampdu_len: number of aggregated frames.
93d95b12 840 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
e039fa4a 841 * @ack_signal: signal strength of the ACK frame
1c014420 842 */
e039fa4a
JB
843struct ieee80211_tx_info {
844 /* common information */
845 u32 flags;
846 u8 band;
e6a9854b 847
3a25a8c8 848 u8 hw_queue;
2e92e6f2 849
a729cff8 850 u16 ack_frame_id;
e039fa4a
JB
851
852 union {
853 struct {
e6a9854b
JB
854 union {
855 /* rate control */
856 struct {
857 struct ieee80211_tx_rate rates[
858 IEEE80211_TX_MAX_RATES];
859 s8 rts_cts_rate_idx;
991fec09
FF
860 u8 use_rts:1;
861 u8 use_cts_prot:1;
0d528d85
FF
862 u8 short_preamble:1;
863 u8 skip_table:1;
991fec09 864 /* 2 bytes free */
e6a9854b
JB
865 };
866 /* only needed before rate control */
867 unsigned long jiffies;
868 };
25d834e1 869 /* NB: vif can be NULL for injected frames */
e039fa4a
JB
870 struct ieee80211_vif *vif;
871 struct ieee80211_key_conf *hw_key;
af61a165
JB
872 u32 flags;
873 /* 4 bytes free */
e039fa4a 874 } control;
3b79af97
JB
875 struct {
876 u64 cookie;
877 } ack;
e039fa4a 878 struct {
e6a9854b 879 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
a0f995a5 880 s32 ack_signal;
e3e1a0bc 881 u8 ampdu_ack_len;
599bf6a4 882 u8 ampdu_len;
d748b464 883 u8 antenna;
02219b3a
JB
884 u16 tx_time;
885 void *status_driver_data[19 / sizeof(void *)];
e039fa4a 886 } status;
e6a9854b
JB
887 struct {
888 struct ieee80211_tx_rate driver_rates[
889 IEEE80211_TX_MAX_RATES];
0d528d85
FF
890 u8 pad[4];
891
e6a9854b
JB
892 void *rate_driver_data[
893 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
894 };
895 void *driver_data[
896 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
e039fa4a 897 };
f0706e82
JB
898};
899
c56ef672
DS
900/**
901 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
902 *
633e2713
DS
903 * This structure is used to point to different blocks of IEs in HW scan
904 * and scheduled scan. These blocks contain the IEs passed by userspace
905 * and the ones generated by mac80211.
c56ef672
DS
906 *
907 * @ies: pointers to band specific IEs.
908 * @len: lengths of band_specific IEs.
909 * @common_ies: IEs for all bands (especially vendor specific ones)
910 * @common_ie_len: length of the common_ies
911 */
912struct ieee80211_scan_ies {
913 const u8 *ies[IEEE80211_NUM_BANDS];
914 size_t len[IEEE80211_NUM_BANDS];
915 const u8 *common_ies;
916 size_t common_ie_len;
917};
918
919
e039fa4a
JB
920static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
921{
922 return (struct ieee80211_tx_info *)skb->cb;
923}
7ac1bd6a 924
f1d58c25
JB
925static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
926{
927 return (struct ieee80211_rx_status *)skb->cb;
928}
929
e6a9854b
JB
930/**
931 * ieee80211_tx_info_clear_status - clear TX status
932 *
933 * @info: The &struct ieee80211_tx_info to be cleared.
934 *
935 * When the driver passes an skb back to mac80211, it must report
936 * a number of things in TX status. This function clears everything
937 * in the TX status but the rate control information (it does clear
938 * the count since you need to fill that in anyway).
939 *
940 * NOTE: You can only use this function if you do NOT use
941 * info->driver_data! Use info->rate_driver_data
942 * instead if you need only the less space that allows.
943 */
944static inline void
945ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
946{
947 int i;
948
949 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
950 offsetof(struct ieee80211_tx_info, control.rates));
951 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
952 offsetof(struct ieee80211_tx_info, driver_rates));
953 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
954 /* clear the rate counts */
955 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
956 info->status.rates[i].count = 0;
957
958 BUILD_BUG_ON(
e3e1a0bc 959 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
e6a9854b
JB
960 memset(&info->status.ampdu_ack_len, 0,
961 sizeof(struct ieee80211_tx_info) -
962 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
963}
964
7ac1bd6a
JB
965
966/**
967 * enum mac80211_rx_flags - receive flags
968 *
969 * These flags are used with the @flag member of &struct ieee80211_rx_status.
970 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
971 * Use together with %RX_FLAG_MMIC_STRIPPED.
972 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
7ac1bd6a
JB
973 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
974 * verification has been done by the hardware.
975 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
976 * If this flag is set, the stack cannot do any replay detection
977 * hence the driver or hardware will have to do that.
981d94a8
JB
978 * @RX_FLAG_PN_VALIDATED: Currently only valid for CCMP/GCMP frames, this
979 * flag indicates that the PN was verified for replay protection.
980 * Note that this flag is also currently only supported when a frame
981 * is also decrypted (ie. @RX_FLAG_DECRYPTED must be set)
72abd81b
JB
982 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
983 * the frame.
984 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
985 * the frame.
f4bda337 986 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
6ebacbb7
JB
987 * field) is valid and contains the time the first symbol of the MPDU
988 * was received. This is useful in monitor mode and for proper IBSS
989 * merging.
f4bda337
TP
990 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
991 * field) is valid and contains the time the last symbol of the MPDU
992 * (including FCS) was received.
b4f28bbb 993 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
0fb8ca45 994 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
5614618e 995 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
0fb8ca45
JM
996 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
997 * @RX_FLAG_SHORT_GI: Short guard interval was used
fe8431f8
FF
998 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
999 * Valid only for data frames (mainly A-MPDU)
ac55d2fe
JB
1000 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
1001 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
1002 * to hw.radiotap_mcs_details to advertise that fact
4c298677
JB
1003 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
1004 * number (@ampdu_reference) must be populated and be a distinct number for
1005 * each A-MPDU
4c298677
JB
1006 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
1007 * subframes of a single A-MPDU
1008 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
1009 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
1010 * on this subframe
1011 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
1012 * is stored in the @ampdu_delimiter_crc field)
63c361f5 1013 * @RX_FLAG_LDPC: LDPC was used
786677d1 1014 * @RX_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
a5e70697
SW
1015 * @RX_FLAG_10MHZ: 10 MHz (half channel) was used
1016 * @RX_FLAG_5MHZ: 5 MHz (quarter channel) was used
0cfcefef
MK
1017 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
1018 * subframes instead of a one huge frame for performance reasons.
1019 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
1020 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
1021 * the 3rd (last) one must not have this flag set. The flag is used to
1022 * deal with retransmission/duplication recovery properly since A-MSDU
1023 * subframes share the same sequence number. Reported subframes can be
1024 * either regular MSDU or singly A-MSDUs. Subframes must not be
1025 * interleaved with other frames.
1f7bba79
JB
1026 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific
1027 * radiotap data in the skb->data (before the frame) as described by
1028 * the &struct ieee80211_vendor_radiotap.
7ac1bd6a
JB
1029 */
1030enum mac80211_rx_flags {
4c298677
JB
1031 RX_FLAG_MMIC_ERROR = BIT(0),
1032 RX_FLAG_DECRYPTED = BIT(1),
1033 RX_FLAG_MMIC_STRIPPED = BIT(3),
1034 RX_FLAG_IV_STRIPPED = BIT(4),
1035 RX_FLAG_FAILED_FCS_CRC = BIT(5),
1036 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
f4bda337 1037 RX_FLAG_MACTIME_START = BIT(7),
4c298677
JB
1038 RX_FLAG_SHORTPRE = BIT(8),
1039 RX_FLAG_HT = BIT(9),
1040 RX_FLAG_40MHZ = BIT(10),
1041 RX_FLAG_SHORT_GI = BIT(11),
1042 RX_FLAG_NO_SIGNAL_VAL = BIT(12),
1043 RX_FLAG_HT_GF = BIT(13),
1044 RX_FLAG_AMPDU_DETAILS = BIT(14),
981d94a8
JB
1045 RX_FLAG_PN_VALIDATED = BIT(15),
1046 /* bit 16 free */
4c298677
JB
1047 RX_FLAG_AMPDU_LAST_KNOWN = BIT(17),
1048 RX_FLAG_AMPDU_IS_LAST = BIT(18),
1049 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(19),
1050 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(20),
f4bda337 1051 RX_FLAG_MACTIME_END = BIT(21),
5614618e 1052 RX_FLAG_VHT = BIT(22),
63c361f5 1053 RX_FLAG_LDPC = BIT(23),
786677d1 1054 RX_FLAG_STBC_MASK = BIT(26) | BIT(27),
a5e70697
SW
1055 RX_FLAG_10MHZ = BIT(28),
1056 RX_FLAG_5MHZ = BIT(29),
0cfcefef 1057 RX_FLAG_AMSDU_MORE = BIT(30),
1f7bba79 1058 RX_FLAG_RADIOTAP_VENDOR_DATA = BIT(31),
7ac1bd6a
JB
1059};
1060
786677d1
OR
1061#define RX_FLAG_STBC_SHIFT 26
1062
1b8d242a
EG
1063/**
1064 * enum mac80211_rx_vht_flags - receive VHT flags
1065 *
1066 * These flags are used with the @vht_flag member of
1067 * &struct ieee80211_rx_status.
1068 * @RX_VHT_FLAG_80MHZ: 80 MHz was used
1b8d242a 1069 * @RX_VHT_FLAG_160MHZ: 160 MHz was used
fb378c23 1070 * @RX_VHT_FLAG_BF: packet was beamformed
1b8d242a
EG
1071 */
1072enum mac80211_rx_vht_flags {
1073 RX_VHT_FLAG_80MHZ = BIT(0),
f89903d5
JB
1074 RX_VHT_FLAG_160MHZ = BIT(1),
1075 RX_VHT_FLAG_BF = BIT(2),
1b8d242a
EG
1076};
1077
7ac1bd6a
JB
1078/**
1079 * struct ieee80211_rx_status - receive status
1080 *
1081 * The low-level driver should provide this information (the subset
1082 * supported by hardware) to the 802.11 code with each received
f1d58c25 1083 * frame, in the skb's control buffer (cb).
566bfe5a 1084 *
c132bec3
BR
1085 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
1086 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
8c358bcd
JB
1087 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
1088 * it but can store it and pass it back to the driver for synchronisation
8318d78a 1089 * @band: the active band when this frame was received
7ac1bd6a 1090 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
566bfe5a
BR
1091 * @signal: signal strength when receiving this frame, either in dBm, in dB or
1092 * unspecified depending on the hardware capabilities flags
1093 * @IEEE80211_HW_SIGNAL_*
ef0621e8
FF
1094 * @chains: bitmask of receive chains for which separate signal strength
1095 * values were filled.
1096 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
1097 * support dB or unspecified units)
7ac1bd6a 1098 * @antenna: antenna used
0fb8ca45 1099 * @rate_idx: index of data rate into band's supported rates or MCS index if
5614618e
JB
1100 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
1101 * @vht_nss: number of streams (VHT only)
7ac1bd6a 1102 * @flag: %RX_FLAG_*
1b8d242a 1103 * @vht_flag: %RX_VHT_FLAG_*
554891e6 1104 * @rx_flags: internal RX flags for mac80211
4c298677
JB
1105 * @ampdu_reference: A-MPDU reference number, must be a different value for
1106 * each A-MPDU but the same for each subframe within one A-MPDU
1107 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
7ac1bd6a 1108 */
f0706e82
JB
1109struct ieee80211_rx_status {
1110 u64 mactime;
8c358bcd 1111 u32 device_timestamp;
4c298677
JB
1112 u32 ampdu_reference;
1113 u32 flag;
30f42292 1114 u16 freq;
1b8d242a 1115 u8 vht_flag;
30f42292 1116 u8 rate_idx;
5614618e 1117 u8 vht_nss;
30f42292
JB
1118 u8 rx_flags;
1119 u8 band;
1120 u8 antenna;
1121 s8 signal;
ef0621e8
FF
1122 u8 chains;
1123 s8 chain_signal[IEEE80211_MAX_CHAINS];
4c298677 1124 u8 ampdu_delimiter_crc;
f0706e82
JB
1125};
1126
1f7bba79
JB
1127/**
1128 * struct ieee80211_vendor_radiotap - vendor radiotap data information
1129 * @present: presence bitmap for this vendor namespace
1130 * (this could be extended in the future if any vendor needs more
1131 * bits, the radiotap spec does allow for that)
1132 * @align: radiotap vendor namespace alignment. This defines the needed
1133 * alignment for the @data field below, not for the vendor namespace
1134 * description itself (which has a fixed 2-byte alignment)
1135 * Must be a power of two, and be set to at least 1!
1136 * @oui: radiotap vendor namespace OUI
1137 * @subns: radiotap vendor sub namespace
1138 * @len: radiotap vendor sub namespace skip length, if alignment is done
1139 * then that's added to this, i.e. this is only the length of the
1140 * @data field.
1141 * @pad: number of bytes of padding after the @data, this exists so that
1142 * the skb data alignment can be preserved even if the data has odd
1143 * length
1144 * @data: the actual vendor namespace data
1145 *
1146 * This struct, including the vendor data, goes into the skb->data before
1147 * the 802.11 header. It's split up in mac80211 using the align/oui/subns
1148 * data.
1149 */
1150struct ieee80211_vendor_radiotap {
1151 u32 present;
1152 u8 align;
1153 u8 oui[3];
1154 u8 subns;
1155 u8 pad;
1156 u16 len;
1157 u8 data[];
1158} __packed;
1159
6b301cdf
JB
1160/**
1161 * enum ieee80211_conf_flags - configuration flags
1162 *
1163 * Flags to define PHY configuration options
1164 *
0869aea0
JB
1165 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1166 * to determine for example whether to calculate timestamps for packets
1167 * or not, do not use instead of filter flags!
c99445b1
KV
1168 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1169 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1170 * meaning that the hardware still wakes up for beacons, is able to
1171 * transmit frames and receive the possible acknowledgment frames.
1172 * Not to be confused with hardware specific wakeup/sleep states,
1173 * driver is responsible for that. See the section "Powersave support"
1174 * for more.
5cff20e6
JB
1175 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1176 * the driver should be prepared to handle configuration requests but
1177 * may turn the device off as much as possible. Typically, this flag will
1178 * be set when an interface is set UP but not associated or scanning, but
1179 * it can also be unset in that case when monitor interfaces are active.
45521245
FF
1180 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1181 * operating channel.
6b301cdf
JB
1182 */
1183enum ieee80211_conf_flags {
0869aea0 1184 IEEE80211_CONF_MONITOR = (1<<0),
ae5eb026 1185 IEEE80211_CONF_PS = (1<<1),
5cff20e6 1186 IEEE80211_CONF_IDLE = (1<<2),
45521245 1187 IEEE80211_CONF_OFFCHANNEL = (1<<3),
6b301cdf 1188};
f0706e82 1189
7a5158ef 1190
e8975581
JB
1191/**
1192 * enum ieee80211_conf_changed - denotes which configuration changed
1193 *
e8975581 1194 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
0869aea0 1195 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
e255d5eb 1196 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
e8975581 1197 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
4797938c 1198 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
9124b077 1199 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
5cff20e6 1200 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
0f78231b 1201 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
04ecd257
JB
1202 * Note that this is only valid if channel contexts are not used,
1203 * otherwise each channel context has the number of chains listed.
e8975581
JB
1204 */
1205enum ieee80211_conf_changed {
0f78231b 1206 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
e8975581 1207 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
0869aea0 1208 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
e8975581 1209 IEEE80211_CONF_CHANGE_PS = BIT(4),
e255d5eb
JB
1210 IEEE80211_CONF_CHANGE_POWER = BIT(5),
1211 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
1212 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
5cff20e6 1213 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
e8975581
JB
1214};
1215
0f78231b
JB
1216/**
1217 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1218 *
9d173fc5
KV
1219 * @IEEE80211_SMPS_AUTOMATIC: automatic
1220 * @IEEE80211_SMPS_OFF: off
1221 * @IEEE80211_SMPS_STATIC: static
1222 * @IEEE80211_SMPS_DYNAMIC: dynamic
1223 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
0f78231b
JB
1224 */
1225enum ieee80211_smps_mode {
1226 IEEE80211_SMPS_AUTOMATIC,
1227 IEEE80211_SMPS_OFF,
1228 IEEE80211_SMPS_STATIC,
1229 IEEE80211_SMPS_DYNAMIC,
1230
1231 /* keep last */
1232 IEEE80211_SMPS_NUM_MODES,
1233};
1234
f0706e82
JB
1235/**
1236 * struct ieee80211_conf - configuration of the device
1237 *
1238 * This struct indicates how the driver shall configure the hardware.
1239 *
04fe2037
JB
1240 * @flags: configuration flags defined above
1241 *
ea95bba4 1242 * @listen_interval: listen interval in units of beacon interval
9ccebe61 1243 * @max_sleep_period: the maximum number of beacon intervals to sleep for
04fe2037
JB
1244 * before checking the beacon for a TIM bit (managed mode only); this
1245 * value will be only achievable between DTIM frames, the hardware
1246 * needs to check for the multicast traffic bit in DTIM beacons.
1247 * This variable is valid only when the CONF_PS flag is set.
56007a02
JB
1248 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1249 * in power saving. Power saving will not be enabled until a beacon
1250 * has been received and the DTIM period is known.
04fe2037
JB
1251 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1252 * powersave documentation below. This variable is valid only when
1253 * the CONF_PS flag is set.
1254 *
1ea6f9c0
JB
1255 * @power_level: requested transmit power (in dBm), backward compatibility
1256 * value only that is set to the minimum of all interfaces
04fe2037 1257 *
675a0b04 1258 * @chandef: the channel definition to tune to
164eb02d 1259 * @radar_enabled: whether radar detection is enabled
04fe2037 1260 *
9124b077 1261 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
ad24b0da
JB
1262 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1263 * but actually means the number of transmissions not the number of retries
9124b077 1264 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
ad24b0da
JB
1265 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1266 * number of transmissions not the number of retries
0f78231b
JB
1267 *
1268 * @smps_mode: spatial multiplexing powersave mode; note that
1269 * %IEEE80211_SMPS_STATIC is used when the device is not
04ecd257
JB
1270 * configured for an HT channel.
1271 * Note that this is only valid if channel contexts are not used,
1272 * otherwise each channel context has the number of chains listed.
f0706e82
JB
1273 */
1274struct ieee80211_conf {
6b301cdf 1275 u32 flags;
ff616381 1276 int power_level, dynamic_ps_timeout;
9ccebe61 1277 int max_sleep_period;
10816d40 1278
e8975581 1279 u16 listen_interval;
56007a02 1280 u8 ps_dtim_period;
e8975581 1281
9124b077
JB
1282 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1283
675a0b04 1284 struct cfg80211_chan_def chandef;
164eb02d 1285 bool radar_enabled;
0f78231b 1286 enum ieee80211_smps_mode smps_mode;
f0706e82
JB
1287};
1288
5ce6e438
JB
1289/**
1290 * struct ieee80211_channel_switch - holds the channel switch data
1291 *
1292 * The information provided in this structure is required for channel switch
1293 * operation.
1294 *
1295 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1296 * Function (TSF) timer when the frame containing the channel switch
1297 * announcement was received. This is simply the rx.mactime parameter
1298 * the driver passed into mac80211.
2ba45384
LC
1299 * @device_timestamp: arbitrary timestamp for the device, this is the
1300 * rx.device_timestamp parameter the driver passed to mac80211.
5ce6e438
JB
1301 * @block_tx: Indicates whether transmission must be blocked before the
1302 * scheduled channel switch, as indicated by the AP.
85220d71 1303 * @chandef: the new channel to switch to
5ce6e438
JB
1304 * @count: the number of TBTT's until the channel switch event
1305 */
1306struct ieee80211_channel_switch {
1307 u64 timestamp;
2ba45384 1308 u32 device_timestamp;
5ce6e438 1309 bool block_tx;
85220d71 1310 struct cfg80211_chan_def chandef;
5ce6e438
JB
1311 u8 count;
1312};
1313
c1288b12
JB
1314/**
1315 * enum ieee80211_vif_flags - virtual interface flags
1316 *
1317 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1318 * on this virtual interface to avoid unnecessary CPU wakeups
ea086359
JB
1319 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1320 * monitoring on this virtual interface -- i.e. it can monitor
1321 * connection quality related parameters, such as the RSSI level and
1322 * provide notifications if configured trigger levels are reached.
848955cc
JB
1323 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this
1324 * interface. This flag should be set during interface addition,
1325 * but may be set/cleared as late as authentication to an AP. It is
1326 * only valid for managed/station mode interfaces.
c1288b12
JB
1327 */
1328enum ieee80211_vif_flags {
1329 IEEE80211_VIF_BEACON_FILTER = BIT(0),
ea086359 1330 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
848955cc 1331 IEEE80211_VIF_SUPPORTS_UAPSD = BIT(2),
c1288b12
JB
1332};
1333
32bfd35d
JB
1334/**
1335 * struct ieee80211_vif - per-interface data
1336 *
1337 * Data in this structure is continually present for driver
1338 * use during the life of a virtual interface.
1339 *
51fb61e7 1340 * @type: type of this virtual interface
bda3933a
JB
1341 * @bss_conf: BSS configuration for this interface, either our own
1342 * or the BSS we're associated to
47846c9b 1343 * @addr: address of this interface
2ca27bcf
JB
1344 * @p2p: indicates whether this AP or STA interface is a p2p
1345 * interface, i.e. a GO or p2p-sta respectively
59af6928
MK
1346 * @csa_active: marks whether a channel switch is going on. Internally it is
1347 * write-protected by sdata_lock and local->mtx so holding either is fine
1348 * for read access.
c1288b12
JB
1349 * @driver_flags: flags/capabilities the driver has for this interface,
1350 * these need to be set (or cleared) when the interface is added
1351 * or, if supported by the driver, the interface type is changed
1352 * at runtime, mac80211 will never touch this field
3a25a8c8
JB
1353 * @hw_queue: hardware queue for each AC
1354 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
d01a1e65
MK
1355 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1356 * when it is not assigned. This pointer is RCU-protected due to the TX
1357 * path needing to access it; even though the netdev carrier will always
1358 * be off when it is %NULL there can still be races and packets could be
1359 * processed after it switches back to %NULL.
ddbfe860 1360 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
ad24b0da 1361 * interface debug files. Note that it will be NULL for the virtual
ddbfe860 1362 * monitor interface (if that is requested.)
32bfd35d
JB
1363 * @drv_priv: data area for driver use, will always be aligned to
1364 * sizeof(void *).
ba8c3d6f 1365 * @txq: the multicast data TX queue (if driver uses the TXQ abstraction)
32bfd35d
JB
1366 */
1367struct ieee80211_vif {
05c914fe 1368 enum nl80211_iftype type;
bda3933a 1369 struct ieee80211_bss_conf bss_conf;
47846c9b 1370 u8 addr[ETH_ALEN];
2ca27bcf 1371 bool p2p;
73da7d5b 1372 bool csa_active;
3a25a8c8
JB
1373
1374 u8 cab_queue;
1375 u8 hw_queue[IEEE80211_NUM_ACS];
1376
ba8c3d6f
FF
1377 struct ieee80211_txq *txq;
1378
d01a1e65
MK
1379 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1380
c1288b12 1381 u32 driver_flags;
3a25a8c8 1382
ddbfe860
SG
1383#ifdef CONFIG_MAC80211_DEBUGFS
1384 struct dentry *debugfs_dir;
1385#endif
1386
32bfd35d 1387 /* must be last */
1c06ef98 1388 u8 drv_priv[0] __aligned(sizeof(void *));
32bfd35d
JB
1389};
1390
902acc78
JB
1391static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1392{
1393#ifdef CONFIG_MAC80211_MESH
05c914fe 1394 return vif->type == NL80211_IFTYPE_MESH_POINT;
902acc78
JB
1395#endif
1396 return false;
1397}
1398
ad7e718c
JB
1399/**
1400 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1401 * @wdev: the wdev to get the vif for
1402 *
1403 * This can be used by mac80211 drivers with direct cfg80211 APIs
1404 * (like the vendor commands) that get a wdev.
1405 *
1406 * Note that this function may return %NULL if the given wdev isn't
1407 * associated with a vif that the driver knows about (e.g. monitor
1408 * or AP_VLAN interfaces.)
1409 */
1410struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1411
dc5a1ad7
EG
1412/**
1413 * ieee80211_vif_to_wdev - return a wdev struct from a vif
1414 * @vif: the vif to get the wdev for
1415 *
1416 * This can be used by mac80211 drivers with direct cfg80211 APIs
1417 * (like the vendor commands) that needs to get the wdev for a vif.
1418 *
1419 * Note that this function may return %NULL if the given wdev isn't
1420 * associated with a vif that the driver knows about (e.g. monitor
1421 * or AP_VLAN interfaces.)
1422 */
1423struct wireless_dev *ieee80211_vif_to_wdev(struct ieee80211_vif *vif);
1424
7ac1bd6a
JB
1425/**
1426 * enum ieee80211_key_flags - key flags
1427 *
1428 * These flags are used for communication about keys between the driver
1429 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1430 *
7ac1bd6a
JB
1431 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1432 * driver to indicate that it requires IV generation for this
db12847c
IY
1433 * particular key. Setting this flag does not necessarily mean that SKBs
1434 * will have sufficient tailroom for ICV or MIC.
7ac1bd6a
JB
1435 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1436 * the driver for a TKIP key if it requires Michael MIC
1437 * generation in software.
c6adbd21
ID
1438 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1439 * that the key is pairwise rather then a shared key.
e548c49e 1440 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
00b9cfa3
JM
1441 * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames
1442 * (MFP) to be done in software.
077a9154 1443 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
ee70108f 1444 * if space should be prepared for the IV, but the IV
077a9154 1445 * itself should not be generated. Do not set together with
db12847c
IY
1446 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1447 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
1448 * MIC.
e548c49e
JB
1449 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1450 * management frames. The flag can help drivers that have a hardware
1451 * crypto implementation that doesn't deal with management frames
1452 * properly by allowing them to not upload the keys to hardware and
1453 * fall back to software crypto. Note that this flag deals only with
1454 * RX, if your crypto engine can't deal with TX you can also set the
1455 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
17d38fa8 1456 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
00b9cfa3 1457 * driver for a CCMP/GCMP key to indicate that is requires IV generation
17d38fa8 1458 * only for managment frames (MFP).
db12847c
IY
1459 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the
1460 * driver for a key to indicate that sufficient tailroom must always
1461 * be reserved for ICV or MIC, even when HW encryption is enabled.
7848ba7d 1462 */
7ac1bd6a 1463enum ieee80211_key_flags {
17d38fa8
MK
1464 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0),
1465 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1),
1466 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2),
1467 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3),
1468 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4),
1469 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5),
1470 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6),
db12847c 1471 IEEE80211_KEY_FLAG_RESERVE_TAILROOM = BIT(7),
7ac1bd6a 1472};
11a843b7 1473
7ac1bd6a
JB
1474/**
1475 * struct ieee80211_key_conf - key information
1476 *
1477 * This key information is given by mac80211 to the driver by
1478 * the set_key() callback in &struct ieee80211_ops.
1479 *
1480 * @hw_key_idx: To be set by the driver, this is the key index the driver
1481 * wants to be given when a frame is transmitted and needs to be
6a7664d4 1482 * encrypted in hardware.
97359d12 1483 * @cipher: The key's cipher suite selector.
db388a56
JB
1484 * @tx_pn: PN used for TX on non-TKIP keys, may be used by the driver
1485 * as well if it needs to do software PN assignment by itself
1486 * (e.g. due to TSO)
7ac1bd6a
JB
1487 * @flags: key flags, see &enum ieee80211_key_flags.
1488 * @keyidx: the key index (0-3)
1489 * @keylen: key material length
ffd7891d
LR
1490 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1491 * data block:
1492 * - Temporal Encryption Key (128 bits)
1493 * - Temporal Authenticator Tx MIC Key (64 bits)
1494 * - Temporal Authenticator Rx MIC Key (64 bits)
dc822b5d
JB
1495 * @icv_len: The ICV length for this key type
1496 * @iv_len: The IV length for this key type
f9a060f4 1497 * @drv_priv: pointer for driver use
7ac1bd6a 1498 */
f0706e82 1499struct ieee80211_key_conf {
f9a060f4 1500 void *drv_priv;
db388a56 1501 atomic64_t tx_pn;
97359d12 1502 u32 cipher;
76708dee
FF
1503 u8 icv_len;
1504 u8 iv_len;
6a7664d4 1505 u8 hw_key_idx;
11a843b7 1506 u8 flags;
11a843b7 1507 s8 keyidx;
11a843b7 1508 u8 keylen;
f0706e82
JB
1509 u8 key[0];
1510};
1511
a31cf1c6
JB
1512#define IEEE80211_MAX_PN_LEN 16
1513
9352c19f
JB
1514/**
1515 * struct ieee80211_key_seq - key sequence counter
1516 *
1517 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
1518 * @ccmp: PN data, most significant byte first (big endian,
1519 * reverse order than in packet)
1520 * @aes_cmac: PN data, most significant byte first (big endian,
1521 * reverse order than in packet)
1522 * @aes_gmac: PN data, most significant byte first (big endian,
1523 * reverse order than in packet)
1524 * @gcmp: PN data, most significant byte first (big endian,
1525 * reverse order than in packet)
a31cf1c6 1526 * @hw: data for HW-only (e.g. cipher scheme) keys
9352c19f
JB
1527 */
1528struct ieee80211_key_seq {
1529 union {
1530 struct {
1531 u32 iv32;
1532 u16 iv16;
1533 } tkip;
1534 struct {
1535 u8 pn[6];
1536 } ccmp;
1537 struct {
1538 u8 pn[6];
1539 } aes_cmac;
1540 struct {
1541 u8 pn[6];
1542 } aes_gmac;
1543 struct {
1544 u8 pn[6];
1545 } gcmp;
a31cf1c6
JB
1546 struct {
1547 u8 seq[IEEE80211_MAX_PN_LEN];
1548 u8 seq_len;
1549 } hw;
9352c19f
JB
1550 };
1551};
1552
2475b1cc
MS
1553/**
1554 * struct ieee80211_cipher_scheme - cipher scheme
1555 *
1556 * This structure contains a cipher scheme information defining
1557 * the secure packet crypto handling.
1558 *
1559 * @cipher: a cipher suite selector
1560 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1561 * @hdr_len: a length of a security header used the cipher
1562 * @pn_len: a length of a packet number in the security header
1563 * @pn_off: an offset of pn from the beginning of the security header
1564 * @key_idx_off: an offset of key index byte in the security header
1565 * @key_idx_mask: a bit mask of key_idx bits
1566 * @key_idx_shift: a bit shift needed to get key_idx
1567 * key_idx value calculation:
1568 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1569 * @mic_len: a mic length in bytes
1570 */
1571struct ieee80211_cipher_scheme {
1572 u32 cipher;
1573 u16 iftype;
1574 u8 hdr_len;
1575 u8 pn_len;
1576 u8 pn_off;
1577 u8 key_idx_off;
1578 u8 key_idx_mask;
1579 u8 key_idx_shift;
1580 u8 mic_len;
1581};
1582
7ac1bd6a
JB
1583/**
1584 * enum set_key_cmd - key command
1585 *
1586 * Used with the set_key() callback in &struct ieee80211_ops, this
1587 * indicates whether a key is being removed or added.
1588 *
1589 * @SET_KEY: a key is set
1590 * @DISABLE_KEY: a key must be disabled
1591 */
ea49c359 1592enum set_key_cmd {
11a843b7 1593 SET_KEY, DISABLE_KEY,
ea49c359 1594};
f0706e82 1595
f09603a2
JB
1596/**
1597 * enum ieee80211_sta_state - station state
1598 *
1599 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1600 * this is a special state for add/remove transitions
1601 * @IEEE80211_STA_NONE: station exists without special state
1602 * @IEEE80211_STA_AUTH: station is authenticated
1603 * @IEEE80211_STA_ASSOC: station is associated
1604 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1605 */
1606enum ieee80211_sta_state {
1607 /* NOTE: These need to be ordered correctly! */
1608 IEEE80211_STA_NOTEXIST,
1609 IEEE80211_STA_NONE,
1610 IEEE80211_STA_AUTH,
1611 IEEE80211_STA_ASSOC,
1612 IEEE80211_STA_AUTHORIZED,
1613};
1614
e1a0c6b3
JB
1615/**
1616 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1617 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1618 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1619 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1620 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1621 * (including 80+80 MHz)
1622 *
1623 * Implementation note: 20 must be zero to be initialized
1624 * correctly, the values must be sorted.
1625 */
1626enum ieee80211_sta_rx_bandwidth {
1627 IEEE80211_STA_RX_BW_20 = 0,
1628 IEEE80211_STA_RX_BW_40,
1629 IEEE80211_STA_RX_BW_80,
1630 IEEE80211_STA_RX_BW_160,
1631};
1632
0d528d85
FF
1633/**
1634 * struct ieee80211_sta_rates - station rate selection table
1635 *
1636 * @rcu_head: RCU head used for freeing the table on update
03f831a6 1637 * @rate: transmit rates/flags to be used by default.
0d528d85
FF
1638 * Overriding entries per-packet is possible by using cb tx control.
1639 */
1640struct ieee80211_sta_rates {
1641 struct rcu_head rcu_head;
1642 struct {
1643 s8 idx;
1644 u8 count;
1645 u8 count_cts;
1646 u8 count_rts;
1647 u16 flags;
1648 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1649};
1650
17741cdc
JB
1651/**
1652 * struct ieee80211_sta - station table entry
1653 *
1654 * A station table entry represents a station we are possibly
1655 * communicating with. Since stations are RCU-managed in
1656 * mac80211, any ieee80211_sta pointer you get access to must
1657 * either be protected by rcu_read_lock() explicitly or implicitly,
1658 * or you must take good care to not use such a pointer after a
34e89507 1659 * call to your sta_remove callback that removed it.
17741cdc
JB
1660 *
1661 * @addr: MAC address
1662 * @aid: AID we assigned to the station if we're an AP
323ce79a 1663 * @supp_rates: Bitmap of supported rates (per band)
55d942f4
JB
1664 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1665 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
527871d7
JB
1666 * @wme: indicates whether the STA supports QoS/WME (if local devices does,
1667 * otherwise always false)
17741cdc
JB
1668 * @drv_priv: data area for driver use, will always be aligned to
1669 * sizeof(void *), size is determined in hw information.
910868db
EP
1670 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1671 * if wme is supported.
1672 * @max_sp: max Service Period. Only valid if wme is supported.
e1a0c6b3 1673 * @bandwidth: current bandwidth the station can receive with
8921d04e
JB
1674 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1675 * station can receive at the moment, changed by operating mode
1676 * notifications and capabilities. The value is only valid after
1677 * the station moves to associated state.
af0ed69b 1678 * @smps_mode: current SMPS mode (off, static or dynamic)
03f831a6 1679 * @rates: rate control selection table
0c4972cc 1680 * @tdls: indicates whether the STA is a TDLS peer
8b94148c
AN
1681 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
1682 * valid if the STA is a TDLS peer in the first place.
ba8c3d6f 1683 * @txq: per-TID data TX queues (if driver uses the TXQ abstraction)
17741cdc
JB
1684 */
1685struct ieee80211_sta {
881d948c 1686 u32 supp_rates[IEEE80211_NUM_BANDS];
17741cdc
JB
1687 u8 addr[ETH_ALEN];
1688 u16 aid;
d9fe60de 1689 struct ieee80211_sta_ht_cap ht_cap;
818255ea 1690 struct ieee80211_sta_vht_cap vht_cap;
39df600a 1691 bool wme;
9533b4ac
EP
1692 u8 uapsd_queues;
1693 u8 max_sp;
8921d04e 1694 u8 rx_nss;
e1a0c6b3 1695 enum ieee80211_sta_rx_bandwidth bandwidth;
af0ed69b 1696 enum ieee80211_smps_mode smps_mode;
0d528d85 1697 struct ieee80211_sta_rates __rcu *rates;
0c4972cc 1698 bool tdls;
8b94148c 1699 bool tdls_initiator;
17741cdc 1700
ba8c3d6f
FF
1701 struct ieee80211_txq *txq[IEEE80211_NUM_TIDS];
1702
17741cdc 1703 /* must be last */
1c06ef98 1704 u8 drv_priv[0] __aligned(sizeof(void *));
17741cdc
JB
1705};
1706
478f8d2b
TW
1707/**
1708 * enum sta_notify_cmd - sta notify command
1709 *
1710 * Used with the sta_notify() callback in &struct ieee80211_ops, this
38a6cc75 1711 * indicates if an associated station made a power state transition.
478f8d2b 1712 *
4571d3bf
CL
1713 * @STA_NOTIFY_SLEEP: a station is now sleeping
1714 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1715 */
89fad578 1716enum sta_notify_cmd {
4571d3bf
CL
1717 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1718};
1719
36323f81
TH
1720/**
1721 * struct ieee80211_tx_control - TX control data
1722 *
1723 * @sta: station table entry, this sta pointer may be NULL and
1724 * it is not allowed to copy the pointer, due to RCU.
1725 */
1726struct ieee80211_tx_control {
1727 struct ieee80211_sta *sta;
1728};
1729
ba8c3d6f
FF
1730/**
1731 * struct ieee80211_txq - Software intermediate tx queue
1732 *
1733 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1734 * @sta: station table entry, %NULL for per-vif queue
1735 * @tid: the TID for this queue (unused for per-vif queue)
1736 * @ac: the AC for this queue
f8bdbb58 1737 * @drv_priv: driver private area, sized by hw->txq_data_size
ba8c3d6f
FF
1738 *
1739 * The driver can obtain packets from this queue by calling
1740 * ieee80211_tx_dequeue().
1741 */
1742struct ieee80211_txq {
1743 struct ieee80211_vif *vif;
1744 struct ieee80211_sta *sta;
1745 u8 tid;
1746 u8 ac;
1747
1748 /* must be last */
1749 u8 drv_priv[0] __aligned(sizeof(void *));
1750};
1751
1bc0826c
JB
1752/**
1753 * enum ieee80211_hw_flags - hardware flags
1754 *
1755 * These flags are used to indicate hardware capabilities to
1756 * the stack. Generally, flags here should have their meaning
1757 * done in a way that the simplest hardware doesn't need setting
1758 * any particular flags. There are some exceptions to this rule,
1759 * however, so you are advised to review these flags carefully.
1760 *
af65cd96
JB
1761 * @IEEE80211_HW_HAS_RATE_CONTROL:
1762 * The hardware or firmware includes rate control, and cannot be
1763 * controlled by the stack. As such, no rate control algorithm
1764 * should be instantiated, and the TX rate reported to userspace
1765 * will be taken from the TX status instead of the rate control
1766 * algorithm.
1767 * Note that this requires that the driver implement a number of
1768 * callbacks so it has the correct information, it needs to have
1769 * the @set_rts_threshold callback and must look at the BSS config
1770 * @use_cts_prot for G/N protection, @use_short_slot for slot
1771 * timing in 2.4 GHz and @use_short_preamble for preambles for
1772 * CCK frames.
1773 *
1bc0826c
JB
1774 * @IEEE80211_HW_RX_INCLUDES_FCS:
1775 * Indicates that received frames passed to the stack include
1776 * the FCS at the end.
1777 *
1778 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1779 * Some wireless LAN chipsets buffer broadcast/multicast frames
1780 * for power saving stations in the hardware/firmware and others
1781 * rely on the host system for such buffering. This option is used
1782 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1783 * multicast frames when there are power saving stations so that
546c80c9 1784 * the driver can fetch them with ieee80211_get_buffered_bc().
1bc0826c 1785 *
566bfe5a
BR
1786 * @IEEE80211_HW_SIGNAL_UNSPEC:
1787 * Hardware can provide signal values but we don't know its units. We
1788 * expect values between 0 and @max_signal.
1789 * If possible please provide dB or dBm instead.
1790 *
566bfe5a
BR
1791 * @IEEE80211_HW_SIGNAL_DBM:
1792 * Hardware gives signal values in dBm, decibel difference from
1793 * one milliwatt. This is the preferred method since it is standardized
1794 * between different devices. @max_signal does not need to be set.
1795 *
06ff47bc
TW
1796 * @IEEE80211_HW_SPECTRUM_MGMT:
1797 * Hardware supports spectrum management defined in 802.11h
1798 * Measurement, Channel Switch, Quieting, TPC
8b30b1fe
S
1799 *
1800 * @IEEE80211_HW_AMPDU_AGGREGATION:
1801 * Hardware supports 11n A-MPDU aggregation.
520eb820 1802 *
4be8c387
JB
1803 * @IEEE80211_HW_SUPPORTS_PS:
1804 * Hardware has power save support (i.e. can go to sleep).
1805 *
1806 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1807 * Hardware requires nullfunc frame handling in stack, implies
1808 * stack support for dynamic PS.
1809 *
1810 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1811 * Hardware has support for dynamic PS.
4375d083
JM
1812 *
1813 * @IEEE80211_HW_MFP_CAPABLE:
1814 * Hardware supports management frame protection (MFP, IEEE 802.11w).
04de8381 1815 *
375177bf
VN
1816 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1817 * Hardware can provide ack status reports of Tx frames to
1818 * the stack.
1819 *
1e4dcd01 1820 * @IEEE80211_HW_CONNECTION_MONITOR:
ad24b0da
JB
1821 * The hardware performs its own connection monitoring, including
1822 * periodic keep-alives to the AP and probing the AP on beacon loss.
a97c13c3 1823 *
c65dd147
EG
1824 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1825 * This device needs to get data from beacon before association (i.e.
1826 * dtim_period).
e31b8213
JB
1827 *
1828 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1829 * per-station GTKs as used by IBSS RSN or during fast transition. If
1830 * the device doesn't support per-station GTKs, but can be asked not
1831 * to decrypt group addressed frames, then IBSS RSN support is still
1832 * possible but software crypto will be used. Advertise the wiphy flag
1833 * only in that case.
d057e5a3
AN
1834 *
1835 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1836 * autonomously manages the PS status of connected stations. When
1837 * this flag is set mac80211 will not trigger PS mode for connected
1838 * stations based on the PM bit of incoming frames.
1839 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1840 * the PS mode of connected stations.
edf6b784
AN
1841 *
1842 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1843 * setup strictly in HW. mac80211 should not attempt to do this in
1844 * software.
885bd8ec 1845 *
4b6f1dd6
JB
1846 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1847 * a virtual monitor interface when monitor interfaces are the only
1848 * active interfaces.
3a25a8c8 1849 *
e27513fb
BG
1850 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
1851 * be created. It is expected user-space will create vifs as
1852 * desired (and thus have them named as desired).
1853 *
fa7e1fbc
JB
1854 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the
1855 * crypto algorithms can be done in software - so don't automatically
1856 * try to fall back to it if hardware crypto fails, but do so only if
1857 * the driver returns 1. This also forces the driver to advertise its
1858 * supported cipher suites.
1859 *
17c18bf8
JB
1860 * @IEEE80211_HW_SUPPORT_FAST_XMIT: The driver/hardware supports fast-xmit,
1861 * this currently requires only the ability to calculate the duration
1862 * for frames.
1863 *
3a25a8c8
JB
1864 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1865 * queue mapping in order to use different queues (not just one per AC)
1866 * for different virtual interfaces. See the doc section on HW queue
1867 * control for more details.
6d71117a 1868 *
0d528d85
FF
1869 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
1870 * selection table provided by the rate control algorithm.
1871 *
6d71117a
JB
1872 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1873 * P2P Interface. This will be honoured even if more than one interface
1874 * is supported.
ef429dad
JB
1875 *
1876 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
1877 * only, to allow getting TBTT of a DTIM beacon.
7578d575 1878 *
919be62b
JB
1879 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
1880 * and can cope with CCK rates in an aggregation session (e.g. by not
1881 * using aggregation for such frames.)
1882 *
7578d575
AN
1883 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
1884 * for a single active channel while using channel contexts. When support
1885 * is not enabled the default action is to disconnect when getting the
1886 * CSA frame.
5d52ee81 1887 *
c70f59a2
IY
1888 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
1889 * or tailroom of TX skbs without copying them first.
1890 *
c526a467 1891 * @IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
c56ef672 1892 * in one command, mac80211 doesn't have to run separate scans per band.
30686bf7 1893 *
b98fb44f
AN
1894 * @IEEE80211_HW_TDLS_WIDER_BW: The device/driver supports wider bandwidth
1895 * than then BSS bandwidth for a TDLS link on the base channel.
1896 *
30686bf7 1897 * @NUM_IEEE80211_HW_FLAGS: number of hardware flags, used for sizing arrays
1bc0826c
JB
1898 */
1899enum ieee80211_hw_flags {
30686bf7
JB
1900 IEEE80211_HW_HAS_RATE_CONTROL,
1901 IEEE80211_HW_RX_INCLUDES_FCS,
1902 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING,
1903 IEEE80211_HW_SIGNAL_UNSPEC,
1904 IEEE80211_HW_SIGNAL_DBM,
1905 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC,
1906 IEEE80211_HW_SPECTRUM_MGMT,
1907 IEEE80211_HW_AMPDU_AGGREGATION,
1908 IEEE80211_HW_SUPPORTS_PS,
1909 IEEE80211_HW_PS_NULLFUNC_STACK,
1910 IEEE80211_HW_SUPPORTS_DYNAMIC_PS,
1911 IEEE80211_HW_MFP_CAPABLE,
1912 IEEE80211_HW_WANT_MONITOR_VIF,
1913 IEEE80211_HW_NO_AUTO_VIF,
1914 IEEE80211_HW_SW_CRYPTO_CONTROL,
1915 IEEE80211_HW_SUPPORT_FAST_XMIT,
1916 IEEE80211_HW_REPORTS_TX_ACK_STATUS,
1917 IEEE80211_HW_CONNECTION_MONITOR,
1918 IEEE80211_HW_QUEUE_CONTROL,
1919 IEEE80211_HW_SUPPORTS_PER_STA_GTK,
1920 IEEE80211_HW_AP_LINK_PS,
1921 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW,
1922 IEEE80211_HW_SUPPORTS_RC_TABLE,
1923 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF,
1924 IEEE80211_HW_TIMING_BEACON_ONLY,
1925 IEEE80211_HW_SUPPORTS_HT_CCK_RATES,
1926 IEEE80211_HW_CHANCTX_STA_CSA,
1927 IEEE80211_HW_SUPPORTS_CLONED_SKBS,
1928 IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS,
b98fb44f 1929 IEEE80211_HW_TDLS_WIDER_BW,
30686bf7
JB
1930
1931 /* keep last, obviously */
1932 NUM_IEEE80211_HW_FLAGS
1bc0826c
JB
1933};
1934
7ac1bd6a
JB
1935/**
1936 * struct ieee80211_hw - hardware information and state
75a5f0cc
JB
1937 *
1938 * This structure contains the configuration and hardware
1939 * information for an 802.11 PHY.
1940 *
1941 * @wiphy: This points to the &struct wiphy allocated for this
1942 * 802.11 PHY. You must fill in the @perm_addr and @dev
1943 * members of this structure using SET_IEEE80211_DEV()
8318d78a
JB
1944 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1945 * bands (with channels, bitrates) are registered here.
75a5f0cc
JB
1946 *
1947 * @conf: &struct ieee80211_conf, device configuration, don't use.
1948 *
75a5f0cc
JB
1949 * @priv: pointer to private area that was allocated for driver use
1950 * along with this structure.
1951 *
1952 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1953 *
1954 * @extra_tx_headroom: headroom to reserve in each transmit skb
1955 * for use by the driver (e.g. for transmit headers.)
1956 *
70dabeb7
FF
1957 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
1958 * Can be used by drivers to add extra IEs.
75a5f0cc 1959 *
566bfe5a 1960 * @max_signal: Maximum value for signal (rssi) in RX information, used
ad24b0da 1961 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
75a5f0cc 1962 *
ea95bba4 1963 * @max_listen_interval: max listen interval in units of beacon interval
ad24b0da 1964 * that HW supports
ea95bba4 1965 *
75a5f0cc 1966 * @queues: number of available hardware transmit queues for
e100bb64
JB
1967 * data packets. WMM/QoS requires at least four, these
1968 * queues need to have configurable access parameters.
1969 *
830f9038
JB
1970 * @rate_control_algorithm: rate control algorithm for this hardware.
1971 * If unset (NULL), the default algorithm will be used. Must be
1972 * set before calling ieee80211_register_hw().
32bfd35d
JB
1973 *
1974 * @vif_data_size: size (in bytes) of the drv_priv data area
1975 * within &struct ieee80211_vif.
17741cdc
JB
1976 * @sta_data_size: size (in bytes) of the drv_priv data area
1977 * within &struct ieee80211_sta.
d01a1e65
MK
1978 * @chanctx_data_size: size (in bytes) of the drv_priv data area
1979 * within &struct ieee80211_chanctx_conf.
ba8c3d6f
FF
1980 * @txq_data_size: size (in bytes) of the drv_priv data area
1981 * within @struct ieee80211_txq.
870abdf6 1982 *
78be49ec
HS
1983 * @max_rates: maximum number of alternate rate retry stages the hw
1984 * can handle.
1985 * @max_report_rates: maximum number of alternate rate retry stages
1986 * the hw can report back.
e6a9854b 1987 * @max_rate_tries: maximum number of tries for each stage
4e6cbfd0 1988 *
df6ba5d8
LC
1989 * @max_rx_aggregation_subframes: maximum buffer size (number of
1990 * sub-frames) to be used for A-MPDU block ack receiver
1991 * aggregation.
1992 * This is only relevant if the device has restrictions on the
1993 * number of subframes, if it relies on mac80211 to do reordering
1994 * it shouldn't be set.
5dd36bc9
JB
1995 *
1996 * @max_tx_aggregation_subframes: maximum number of subframes in an
1997 * aggregate an HT driver will transmit, used by the peer as a
1998 * hint to size its reorder buffer.
3a25a8c8
JB
1999 *
2000 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
2001 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
ac55d2fe
JB
2002 *
2003 * @radiotap_mcs_details: lists which MCS information can the HW
2004 * reports, by default it is set to _MCS, _GI and _BW but doesn't
2005 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
2006 * adding _BW is supported today.
72d78728 2007 *
51648921
JB
2008 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
2009 * the default is _GI | _BANDWIDTH.
2010 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_* values.
2011 *
72d78728 2012 * @netdev_features: netdev features to be set in each netdev created
680a0dab
JB
2013 * from this HW. Note that not all features are usable with mac80211,
2014 * other features will be rejected during HW registration.
219c3867
AB
2015 *
2016 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
2017 * for each access category if it is uAPSD trigger-enabled and delivery-
2018 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
2019 * Each bit corresponds to different AC. Value '1' in specific bit means
2020 * that corresponding AC is both trigger- and delivery-enabled. '0' means
2021 * neither enabled.
2022 *
2023 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
2024 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
2025 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
2475b1cc
MS
2026 *
2027 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
2028 * @cipher_schemes: a pointer to an array of cipher scheme definitions
2029 * supported by HW.
ba8c3d6f
FF
2030 *
2031 * @txq_ac_max_pending: maximum number of frames per AC pending in all txq
2032 * entries for a vif.
7ac1bd6a 2033 */
f0706e82 2034struct ieee80211_hw {
f0706e82 2035 struct ieee80211_conf conf;
75a5f0cc 2036 struct wiphy *wiphy;
830f9038 2037 const char *rate_control_algorithm;
f0706e82 2038 void *priv;
30686bf7 2039 unsigned long flags[BITS_TO_LONGS(NUM_IEEE80211_HW_FLAGS)];
f0706e82 2040 unsigned int extra_tx_headroom;
70dabeb7 2041 unsigned int extra_beacon_tailroom;
32bfd35d 2042 int vif_data_size;
17741cdc 2043 int sta_data_size;
d01a1e65 2044 int chanctx_data_size;
ba8c3d6f 2045 int txq_data_size;
ea95bba4 2046 u16 queues;
ea95bba4 2047 u16 max_listen_interval;
f0706e82 2048 s8 max_signal;
e6a9854b 2049 u8 max_rates;
78be49ec 2050 u8 max_report_rates;
e6a9854b 2051 u8 max_rate_tries;
df6ba5d8 2052 u8 max_rx_aggregation_subframes;
5dd36bc9 2053 u8 max_tx_aggregation_subframes;
3a25a8c8 2054 u8 offchannel_tx_hw_queue;
ac55d2fe 2055 u8 radiotap_mcs_details;
51648921 2056 u16 radiotap_vht_details;
72d78728 2057 netdev_features_t netdev_features;
219c3867
AB
2058 u8 uapsd_queues;
2059 u8 uapsd_max_sp_len;
2475b1cc
MS
2060 u8 n_cipher_schemes;
2061 const struct ieee80211_cipher_scheme *cipher_schemes;
ba8c3d6f 2062 int txq_ac_max_pending;
f0706e82
JB
2063};
2064
30686bf7
JB
2065static inline bool _ieee80211_hw_check(struct ieee80211_hw *hw,
2066 enum ieee80211_hw_flags flg)
2067{
2068 return test_bit(flg, hw->flags);
2069}
2070#define ieee80211_hw_check(hw, flg) _ieee80211_hw_check(hw, IEEE80211_HW_##flg)
2071
2072static inline void _ieee80211_hw_set(struct ieee80211_hw *hw,
2073 enum ieee80211_hw_flags flg)
2074{
2075 return __set_bit(flg, hw->flags);
2076}
2077#define ieee80211_hw_set(hw, flg) _ieee80211_hw_set(hw, IEEE80211_HW_##flg)
2078
c56ef672
DS
2079/**
2080 * struct ieee80211_scan_request - hw scan request
2081 *
2082 * @ies: pointers different parts of IEs (in req.ie)
2083 * @req: cfg80211 request.
2084 */
2085struct ieee80211_scan_request {
2086 struct ieee80211_scan_ies ies;
2087
2088 /* Keep last */
2089 struct cfg80211_scan_request req;
2090};
2091
8a4d32f3
AN
2092/**
2093 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
2094 *
2095 * @sta: peer this TDLS channel-switch request/response came from
2096 * @chandef: channel referenced in a TDLS channel-switch request
2097 * @action_code: see &enum ieee80211_tdls_actioncode
2098 * @status: channel-switch response status
2099 * @timestamp: time at which the frame was received
2100 * @switch_time: switch-timing parameter received in the frame
2101 * @switch_timeout: switch-timing parameter received in the frame
2102 * @tmpl_skb: TDLS switch-channel response template
2103 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
2104 */
2105struct ieee80211_tdls_ch_sw_params {
2106 struct ieee80211_sta *sta;
2107 struct cfg80211_chan_def *chandef;
2108 u8 action_code;
2109 u32 status;
2110 u32 timestamp;
2111 u16 switch_time;
2112 u16 switch_timeout;
2113 struct sk_buff *tmpl_skb;
2114 u32 ch_sw_tm_ie;
2115};
2116
9a95371a
LR
2117/**
2118 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
2119 *
2120 * @wiphy: the &struct wiphy which we want to query
2121 *
2122 * mac80211 drivers can use this to get to their respective
2123 * &struct ieee80211_hw. Drivers wishing to get to their own private
2124 * structure can then access it via hw->priv. Note that mac802111 drivers should
2125 * not use wiphy_priv() to try to get their private driver structure as this
2126 * is already used internally by mac80211.
0ae997dc
YB
2127 *
2128 * Return: The mac80211 driver hw struct of @wiphy.
9a95371a
LR
2129 */
2130struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
2131
75a5f0cc
JB
2132/**
2133 * SET_IEEE80211_DEV - set device for 802.11 hardware
2134 *
2135 * @hw: the &struct ieee80211_hw to set the device for
2136 * @dev: the &struct device of this 802.11 device
2137 */
f0706e82
JB
2138static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
2139{
2140 set_wiphy_dev(hw->wiphy, dev);
2141}
2142
75a5f0cc 2143/**
e37d4dff 2144 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
75a5f0cc
JB
2145 *
2146 * @hw: the &struct ieee80211_hw to set the MAC address for
2147 * @addr: the address to set
2148 */
f0706e82
JB
2149static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
2150{
2151 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
2152}
2153
2e92e6f2
JB
2154static inline struct ieee80211_rate *
2155ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
e039fa4a 2156 const struct ieee80211_tx_info *c)
2e92e6f2 2157{
aa331df0 2158 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
2e92e6f2 2159 return NULL;
e6a9854b 2160 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
2e92e6f2
JB
2161}
2162
2163static inline struct ieee80211_rate *
2164ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
e039fa4a 2165 const struct ieee80211_tx_info *c)
2e92e6f2 2166{
e039fa4a 2167 if (c->control.rts_cts_rate_idx < 0)
2e92e6f2 2168 return NULL;
e039fa4a 2169 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
2e92e6f2
JB
2170}
2171
2172static inline struct ieee80211_rate *
2173ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
870abdf6 2174 const struct ieee80211_tx_info *c, int idx)
2e92e6f2 2175{
e6a9854b 2176 if (c->control.rates[idx + 1].idx < 0)
2e92e6f2 2177 return NULL;
e6a9854b 2178 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
2e92e6f2
JB
2179}
2180
6096de7f
JB
2181/**
2182 * ieee80211_free_txskb - free TX skb
2183 * @hw: the hardware
2184 * @skb: the skb
2185 *
2186 * Free a transmit skb. Use this funtion when some failure
2187 * to transmit happened and thus status cannot be reported.
2188 */
2189void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
2190
75a5f0cc
JB
2191/**
2192 * DOC: Hardware crypto acceleration
2193 *
2194 * mac80211 is capable of taking advantage of many hardware
2195 * acceleration designs for encryption and decryption operations.
2196 *
2197 * The set_key() callback in the &struct ieee80211_ops for a given
2198 * device is called to enable hardware acceleration of encryption and
dc822b5d
JB
2199 * decryption. The callback takes a @sta parameter that will be NULL
2200 * for default keys or keys used for transmission only, or point to
2201 * the station information for the peer for individual keys.
75a5f0cc
JB
2202 * Multiple transmission keys with the same key index may be used when
2203 * VLANs are configured for an access point.
4150c572 2204 *
75a5f0cc
JB
2205 * When transmitting, the TX control data will use the @hw_key_idx
2206 * selected by the driver by modifying the &struct ieee80211_key_conf
2207 * pointed to by the @key parameter to the set_key() function.
2208 *
2209 * The set_key() call for the %SET_KEY command should return 0 if
2210 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
2211 * added; if you return 0 then hw_key_idx must be assigned to the
2212 * hardware key index, you are free to use the full u8 range.
2213 *
fa7e1fbc
JB
2214 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is
2215 * set, mac80211 will not automatically fall back to software crypto if
2216 * enabling hardware crypto failed. The set_key() call may also return the
2217 * value 1 to permit this specific key/algorithm to be done in software.
2218 *
75a5f0cc
JB
2219 * When the cmd is %DISABLE_KEY then it must succeed.
2220 *
2221 * Note that it is permissible to not decrypt a frame even if a key
2222 * for it has been uploaded to hardware, the stack will not make any
2223 * decision based on whether a key has been uploaded or not but rather
2224 * based on the receive flags.
2225 *
2226 * The &struct ieee80211_key_conf structure pointed to by the @key
2227 * parameter is guaranteed to be valid until another call to set_key()
2228 * removes it, but it can only be used as a cookie to differentiate
2229 * keys.
9ae4fda3
EG
2230 *
2231 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
2232 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
2233 * handler.
2234 * The update_tkip_key() call updates the driver with the new phase 1 key.
25985edc 2235 * This happens every time the iv16 wraps around (every 65536 packets). The
9ae4fda3
EG
2236 * set_key() call will happen only once for each key (unless the AP did
2237 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
e37d4dff 2238 * provided by update_tkip_key only. The trigger that makes mac80211 call this
9ae4fda3 2239 * handler is software decryption with wrap around of iv16.
de5fad81
YD
2240 *
2241 * The set_default_unicast_key() call updates the default WEP key index
2242 * configured to the hardware for WEP encryption type. This is required
2243 * for devices that support offload of data packets (e.g. ARP responses).
4150c572 2244 */
75a5f0cc 2245
4be8c387
JB
2246/**
2247 * DOC: Powersave support
2248 *
2249 * mac80211 has support for various powersave implementations.
2250 *
c99445b1
KV
2251 * First, it can support hardware that handles all powersaving by itself,
2252 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
2253 * flag. In that case, it will be told about the desired powersave mode
2254 * with the %IEEE80211_CONF_PS flag depending on the association status.
2255 * The hardware must take care of sending nullfunc frames when necessary,
2256 * i.e. when entering and leaving powersave mode. The hardware is required
2257 * to look at the AID in beacons and signal to the AP that it woke up when
2258 * it finds traffic directed to it.
2259 *
2260 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
2261 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
2262 * with hardware wakeup and sleep states. Driver is responsible for waking
2738bd68
BC
2263 * up the hardware before issuing commands to the hardware and putting it
2264 * back to sleep at appropriate times.
c99445b1
KV
2265 *
2266 * When PS is enabled, hardware needs to wakeup for beacons and receive the
2267 * buffered multicast/broadcast frames after the beacon. Also it must be
2268 * possible to send frames and receive the acknowledment frame.
4be8c387
JB
2269 *
2270 * Other hardware designs cannot send nullfunc frames by themselves and also
2271 * need software support for parsing the TIM bitmap. This is also supported
2272 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
2273 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
955394c9
JB
2274 * required to pass up beacons. The hardware is still required to handle
2275 * waking up for multicast traffic; if it cannot the driver must handle that
c99445b1
KV
2276 * as best as it can, mac80211 is too slow to do that.
2277 *
2278 * Dynamic powersave is an extension to normal powersave in which the
2279 * hardware stays awake for a user-specified period of time after sending a
2280 * frame so that reply frames need not be buffered and therefore delayed to
2281 * the next wakeup. It's compromise of getting good enough latency when
2282 * there's data traffic and still saving significantly power in idle
2283 * periods.
2284 *
2738bd68 2285 * Dynamic powersave is simply supported by mac80211 enabling and disabling
c99445b1
KV
2286 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
2287 * flag and mac80211 will handle everything automatically. Additionally,
2288 * hardware having support for the dynamic PS feature may set the
2289 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
2290 * dynamic PS mode itself. The driver needs to look at the
2291 * @dynamic_ps_timeout hardware configuration value and use it that value
2292 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
2293 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
2294 * enabled whenever user has enabled powersave.
2295 *
2296 * Driver informs U-APSD client support by enabling
848955cc 2297 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
e227867f 2298 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
c99445b1
KV
2299 * Nullfunc frames and stay awake until the service period has ended. To
2300 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
2301 * from that AC are transmitted with powersave enabled.
2302 *
2303 * Note: U-APSD client mode is not yet supported with
2304 * %IEEE80211_HW_PS_NULLFUNC_STACK.
4be8c387
JB
2305 */
2306
04de8381
KV
2307/**
2308 * DOC: Beacon filter support
2309 *
2310 * Some hardware have beacon filter support to reduce host cpu wakeups
42b2aa86 2311 * which will reduce system power consumption. It usually works so that
04de8381
KV
2312 * the firmware creates a checksum of the beacon but omits all constantly
2313 * changing elements (TSF, TIM etc). Whenever the checksum changes the
2314 * beacon is forwarded to the host, otherwise it will be just dropped. That
2315 * way the host will only receive beacons where some relevant information
2316 * (for example ERP protection or WMM settings) have changed.
2317 *
c1288b12
JB
2318 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
2319 * interface capability. The driver needs to enable beacon filter support
955394c9
JB
2320 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
2321 * power save is enabled, the stack will not check for beacon loss and the
2322 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
2323 *
2324 * The time (or number of beacons missed) until the firmware notifies the
2325 * driver of a beacon loss event (which in turn causes the driver to call
2326 * ieee80211_beacon_loss()) should be configurable and will be controlled
2327 * by mac80211 and the roaming algorithm in the future.
2328 *
2329 * Since there may be constantly changing information elements that nothing
2330 * in the software stack cares about, we will, in the future, have mac80211
2331 * tell the driver which information elements are interesting in the sense
2332 * that we want to see changes in them. This will include
2333 * - a list of information element IDs
2334 * - a list of OUIs for the vendor information element
2335 *
2336 * Ideally, the hardware would filter out any beacons without changes in the
2337 * requested elements, but if it cannot support that it may, at the expense
2338 * of some efficiency, filter out only a subset. For example, if the device
2339 * doesn't support checking for OUIs it should pass up all changes in all
2340 * vendor information elements.
2341 *
2342 * Note that change, for the sake of simplification, also includes information
2343 * elements appearing or disappearing from the beacon.
2344 *
2345 * Some hardware supports an "ignore list" instead, just make sure nothing
2346 * that was requested is on the ignore list, and include commonly changing
2347 * information element IDs in the ignore list, for example 11 (BSS load) and
2348 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2349 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2350 * it could also include some currently unused IDs.
2351 *
2352 *
2353 * In addition to these capabilities, hardware should support notifying the
2354 * host of changes in the beacon RSSI. This is relevant to implement roaming
2355 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2356 * the received data packets). This can consist in notifying the host when
2357 * the RSSI changes significantly or when it drops below or rises above
2358 * configurable thresholds. In the future these thresholds will also be
2359 * configured by mac80211 (which gets them from userspace) to implement
2360 * them as the roaming algorithm requires.
2361 *
2362 * If the hardware cannot implement this, the driver should ask it to
2363 * periodically pass beacon frames to the host so that software can do the
2364 * signal strength threshold checking.
04de8381
KV
2365 */
2366
0f78231b
JB
2367/**
2368 * DOC: Spatial multiplexing power save
2369 *
2370 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2371 * power in an 802.11n implementation. For details on the mechanism
2372 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2373 * "11.2.3 SM power save".
2374 *
2375 * The mac80211 implementation is capable of sending action frames
2376 * to update the AP about the station's SMPS mode, and will instruct
2377 * the driver to enter the specific mode. It will also announce the
2378 * requested SMPS mode during the association handshake. Hardware
2379 * support for this feature is required, and can be indicated by
2380 * hardware flags.
2381 *
2382 * The default mode will be "automatic", which nl80211/cfg80211
2383 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2384 * turned off otherwise.
2385 *
2386 * To support this feature, the driver must set the appropriate
2387 * hardware support flags, and handle the SMPS flag to the config()
2388 * operation. It will then with this mechanism be instructed to
2389 * enter the requested SMPS mode while associated to an HT AP.
2390 */
2391
75a5f0cc
JB
2392/**
2393 * DOC: Frame filtering
2394 *
2395 * mac80211 requires to see many management frames for proper
2396 * operation, and users may want to see many more frames when
2397 * in monitor mode. However, for best CPU usage and power consumption,
2398 * having as few frames as possible percolate through the stack is
2399 * desirable. Hence, the hardware should filter as much as possible.
2400 *
2401 * To achieve this, mac80211 uses filter flags (see below) to tell
2402 * the driver's configure_filter() function which frames should be
2403 * passed to mac80211 and which should be filtered out.
2404 *
3ac64bee
JB
2405 * Before configure_filter() is invoked, the prepare_multicast()
2406 * callback is invoked with the parameters @mc_count and @mc_list
2407 * for the combined multicast address list of all virtual interfaces.
2408 * It's use is optional, and it returns a u64 that is passed to
2409 * configure_filter(). Additionally, configure_filter() has the
2410 * arguments @changed_flags telling which flags were changed and
2411 * @total_flags with the new flag states.
75a5f0cc
JB
2412 *
2413 * If your device has no multicast address filters your driver will
2414 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2415 * parameter to see whether multicast frames should be accepted
2416 * or dropped.
2417 *
d0f5afbe
MB
2418 * All unsupported flags in @total_flags must be cleared.
2419 * Hardware does not support a flag if it is incapable of _passing_
2420 * the frame to the stack. Otherwise the driver must ignore
2421 * the flag, but not clear it.
2422 * You must _only_ clear the flag (announce no support for the
2423 * flag to mac80211) if you are not able to pass the packet type
2424 * to the stack (so the hardware always filters it).
2425 * So for example, you should clear @FIF_CONTROL, if your hardware
2426 * always filters control frames. If your hardware always passes
2427 * control frames to the kernel and is incapable of filtering them,
2428 * you do _not_ clear the @FIF_CONTROL flag.
2429 * This rule applies to all other FIF flags as well.
4150c572 2430 */
75a5f0cc 2431
4b801bc9
JB
2432/**
2433 * DOC: AP support for powersaving clients
2434 *
2435 * In order to implement AP and P2P GO modes, mac80211 has support for
2436 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2437 * There currently is no support for sAPSD.
2438 *
2439 * There is one assumption that mac80211 makes, namely that a client
2440 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2441 * Both are supported, and both can be used by the same client, but
2442 * they can't be used concurrently by the same client. This simplifies
2443 * the driver code.
2444 *
2445 * The first thing to keep in mind is that there is a flag for complete
2446 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2447 * mac80211 expects the driver to handle most of the state machine for
2448 * powersaving clients and will ignore the PM bit in incoming frames.
2449 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2450 * stations' powersave transitions. In this mode, mac80211 also doesn't
2451 * handle PS-Poll/uAPSD.
2452 *
2453 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2454 * PM bit in incoming frames for client powersave transitions. When a
2455 * station goes to sleep, we will stop transmitting to it. There is,
2456 * however, a race condition: a station might go to sleep while there is
2457 * data buffered on hardware queues. If the device has support for this
2458 * it will reject frames, and the driver should give the frames back to
2459 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2460 * cause mac80211 to retry the frame when the station wakes up. The
2461 * driver is also notified of powersave transitions by calling its
2462 * @sta_notify callback.
2463 *
2464 * When the station is asleep, it has three choices: it can wake up,
2465 * it can PS-Poll, or it can possibly start a uAPSD service period.
2466 * Waking up is implemented by simply transmitting all buffered (and
2467 * filtered) frames to the station. This is the easiest case. When
2468 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2469 * will inform the driver of this with the @allow_buffered_frames
2470 * callback; this callback is optional. mac80211 will then transmit
02f2f1a9 2471 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
4b801bc9
JB
2472 * on each frame. The last frame in the service period (or the only
2473 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2474 * indicate that it ends the service period; as this frame must have
2475 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2476 * When TX status is reported for this frame, the service period is
2477 * marked has having ended and a new one can be started by the peer.
2478 *
02f2f1a9
JB
2479 * Additionally, non-bufferable MMPDUs can also be transmitted by
2480 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2481 *
4b801bc9
JB
2482 * Another race condition can happen on some devices like iwlwifi
2483 * when there are frames queued for the station and it wakes up
2484 * or polls; the frames that are already queued could end up being
2485 * transmitted first instead, causing reordering and/or wrong
2486 * processing of the EOSP. The cause is that allowing frames to be
2487 * transmitted to a certain station is out-of-band communication to
2488 * the device. To allow this problem to be solved, the driver can
2489 * call ieee80211_sta_block_awake() if frames are buffered when it
2490 * is notified that the station went to sleep. When all these frames
2491 * have been filtered (see above), it must call the function again
2492 * to indicate that the station is no longer blocked.
2493 *
2494 * If the driver buffers frames in the driver for aggregation in any
2495 * way, it must use the ieee80211_sta_set_buffered() call when it is
2496 * notified of the station going to sleep to inform mac80211 of any
2497 * TIDs that have frames buffered. Note that when a station wakes up
2498 * this information is reset (hence the requirement to call it when
2499 * informed of the station going to sleep). Then, when a service
2500 * period starts for any reason, @release_buffered_frames is called
2501 * with the number of frames to be released and which TIDs they are
2502 * to come from. In this case, the driver is responsible for setting
2503 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
e227867f 2504 * to help the @more_data parameter is passed to tell the driver if
4b801bc9
JB
2505 * there is more data on other TIDs -- the TIDs to release frames
2506 * from are ignored since mac80211 doesn't know how many frames the
2507 * buffers for those TIDs contain.
2508 *
2509 * If the driver also implement GO mode, where absence periods may
2510 * shorten service periods (or abort PS-Poll responses), it must
2511 * filter those response frames except in the case of frames that
2512 * are buffered in the driver -- those must remain buffered to avoid
2513 * reordering. Because it is possible that no frames are released
e943789e 2514 * in this case, the driver must call ieee80211_sta_eosp()
4b801bc9
JB
2515 * to indicate to mac80211 that the service period ended anyway.
2516 *
2517 * Finally, if frames from multiple TIDs are released from mac80211
2518 * but the driver might reorder them, it must clear & set the flags
2519 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2520 * and also take care of the EOSP and MORE_DATA bits in the frame.
e943789e 2521 * The driver may also use ieee80211_sta_eosp() in this case.
b77cf4f8
JB
2522 *
2523 * Note that if the driver ever buffers frames other than QoS-data
2524 * frames, it must take care to never send a non-QoS-data frame as
2525 * the last frame in a service period, adding a QoS-nulldata frame
2526 * after a non-QoS-data frame if needed.
4b801bc9
JB
2527 */
2528
3a25a8c8
JB
2529/**
2530 * DOC: HW queue control
2531 *
2532 * Before HW queue control was introduced, mac80211 only had a single static
2533 * assignment of per-interface AC software queues to hardware queues. This
2534 * was problematic for a few reasons:
2535 * 1) off-channel transmissions might get stuck behind other frames
2536 * 2) multiple virtual interfaces couldn't be handled correctly
2537 * 3) after-DTIM frames could get stuck behind other frames
2538 *
2539 * To solve this, hardware typically uses multiple different queues for all
2540 * the different usages, and this needs to be propagated into mac80211 so it
2541 * won't have the same problem with the software queues.
2542 *
2543 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2544 * flag that tells it that the driver implements its own queue control. To do
2545 * so, the driver will set up the various queues in each &struct ieee80211_vif
2546 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2547 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2548 * if necessary will queue the frame on the right software queue that mirrors
2549 * the hardware queue.
2550 * Additionally, the driver has to then use these HW queue IDs for the queue
2551 * management functions (ieee80211_stop_queue() et al.)
2552 *
2553 * The driver is free to set up the queue mappings as needed, multiple virtual
2554 * interfaces may map to the same hardware queues if needed. The setup has to
2555 * happen during add_interface or change_interface callbacks. For example, a
2556 * driver supporting station+station and station+AP modes might decide to have
2557 * 10 hardware queues to handle different scenarios:
2558 *
2559 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2560 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2561 * after-DTIM queue for AP: 8
2562 * off-channel queue: 9
2563 *
2564 * It would then set up the hardware like this:
2565 * hw.offchannel_tx_hw_queue = 9
2566 *
2567 * and the first virtual interface that is added as follows:
2568 * vif.hw_queue[IEEE80211_AC_VO] = 0
2569 * vif.hw_queue[IEEE80211_AC_VI] = 1
2570 * vif.hw_queue[IEEE80211_AC_BE] = 2
2571 * vif.hw_queue[IEEE80211_AC_BK] = 3
2572 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2573 * and the second virtual interface with 4-7.
2574 *
2575 * If queue 6 gets full, for example, mac80211 would only stop the second
2576 * virtual interface's BE queue since virtual interface queues are per AC.
2577 *
2578 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2579 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2580 * queue could potentially be shared since mac80211 will look at cab_queue when
2581 * a queue is stopped/woken even if the interface is not in AP mode.
2582 */
2583
75a5f0cc
JB
2584/**
2585 * enum ieee80211_filter_flags - hardware filter flags
2586 *
2587 * These flags determine what the filter in hardware should be
2588 * programmed to let through and what should not be passed to the
2589 * stack. It is always safe to pass more frames than requested,
2590 * but this has negative impact on power consumption.
2591 *
75a5f0cc
JB
2592 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2593 * by the user or if the hardware is not capable of filtering by
2594 * multicast address.
2595 *
2596 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2597 * %RX_FLAG_FAILED_FCS_CRC for them)
2598 *
2599 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2600 * the %RX_FLAG_FAILED_PLCP_CRC for them
2601 *
2602 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2603 * to the hardware that it should not filter beacons or probe responses
2604 * by BSSID. Filtering them can greatly reduce the amount of processing
2605 * mac80211 needs to do and the amount of CPU wakeups, so you should
2606 * honour this flag if possible.
2607 *
df140465
JB
2608 * @FIF_CONTROL: pass control frames (except for PS Poll) addressed to this
2609 * station
75a5f0cc
JB
2610 *
2611 * @FIF_OTHER_BSS: pass frames destined to other BSSes
e3b90ca2 2612 *
c2d3955b 2613 * @FIF_PSPOLL: pass PS Poll frames
7be5086d
JB
2614 *
2615 * @FIF_PROBE_REQ: pass probe request frames
4150c572 2616 */
75a5f0cc 2617enum ieee80211_filter_flags {
75a5f0cc
JB
2618 FIF_ALLMULTI = 1<<1,
2619 FIF_FCSFAIL = 1<<2,
2620 FIF_PLCPFAIL = 1<<3,
2621 FIF_BCN_PRBRESP_PROMISC = 1<<4,
2622 FIF_CONTROL = 1<<5,
2623 FIF_OTHER_BSS = 1<<6,
e3b90ca2 2624 FIF_PSPOLL = 1<<7,
7be5086d 2625 FIF_PROBE_REQ = 1<<8,
75a5f0cc
JB
2626};
2627
1b7d03ac
RR
2628/**
2629 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2630 *
2631 * These flags are used with the ampdu_action() callback in
2632 * &struct ieee80211_ops to indicate which action is needed.
827d42c9
JB
2633 *
2634 * Note that drivers MUST be able to deal with a TX aggregation
2635 * session being stopped even before they OK'ed starting it by
5d22c89b 2636 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
827d42c9
JB
2637 * might receive the addBA frame and send a delBA right away!
2638 *
18b559d5
JB
2639 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2640 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2641 * @IEEE80211_AMPDU_TX_START: start TX aggregation
b1720231 2642 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
18b559d5
JB
2643 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2644 * queued packets, now unaggregated. After all packets are transmitted the
2645 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2646 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2647 * called when the station is removed. There's no need or reason to call
2648 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2649 * session is gone and removes the station.
2650 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2651 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2652 * now the connection is dropped and the station will be removed. Drivers
2653 * should clean up and drop remaining packets when this is called.
1b7d03ac
RR
2654 */
2655enum ieee80211_ampdu_mlme_action {
2656 IEEE80211_AMPDU_RX_START,
2657 IEEE80211_AMPDU_RX_STOP,
0df3ef45 2658 IEEE80211_AMPDU_TX_START,
18b559d5
JB
2659 IEEE80211_AMPDU_TX_STOP_CONT,
2660 IEEE80211_AMPDU_TX_STOP_FLUSH,
2661 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
b1720231 2662 IEEE80211_AMPDU_TX_OPERATIONAL,
1b7d03ac 2663};
75a5f0cc 2664
4049e09a
JB
2665/**
2666 * enum ieee80211_frame_release_type - frame release reason
2667 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
47086fc5
JB
2668 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2669 * frame received on trigger-enabled AC
4049e09a
JB
2670 */
2671enum ieee80211_frame_release_type {
2672 IEEE80211_FRAME_RELEASE_PSPOLL,
47086fc5 2673 IEEE80211_FRAME_RELEASE_UAPSD,
4049e09a
JB
2674};
2675
8f727ef3
JB
2676/**
2677 * enum ieee80211_rate_control_changed - flags to indicate what changed
2678 *
2679 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
e1a0c6b3
JB
2680 * to this station changed. The actual bandwidth is in the station
2681 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2682 * flag changes, for HT and VHT the bandwidth field changes.
8f727ef3 2683 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
e687f61e
AQ
2684 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2685 * changed (in IBSS mode) due to discovering more information about
2686 * the peer.
0af83d3d
JB
2687 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2688 * by the peer
8f727ef3
JB
2689 */
2690enum ieee80211_rate_control_changed {
2691 IEEE80211_RC_BW_CHANGED = BIT(0),
2692 IEEE80211_RC_SMPS_CHANGED = BIT(1),
e687f61e 2693 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
0af83d3d 2694 IEEE80211_RC_NSS_CHANGED = BIT(3),
8f727ef3
JB
2695};
2696
d339d5ca
IP
2697/**
2698 * enum ieee80211_roc_type - remain on channel type
2699 *
2700 * With the support for multi channel contexts and multi channel operations,
2701 * remain on channel operations might be limited/deferred/aborted by other
2702 * flows/operations which have higher priority (and vise versa).
2703 * Specifying the ROC type can be used by devices to prioritize the ROC
2704 * operations compared to other operations/flows.
2705 *
2706 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2707 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2708 * for sending managment frames offchannel.
2709 */
2710enum ieee80211_roc_type {
2711 IEEE80211_ROC_TYPE_NORMAL = 0,
2712 IEEE80211_ROC_TYPE_MGMT_TX,
2713};
2714
cf2c92d8
EP
2715/**
2716 * enum ieee80211_reconfig_complete_type - reconfig type
2717 *
2718 * This enum is used by the reconfig_complete() callback to indicate what
2719 * reconfiguration type was completed.
2720 *
2721 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
2722 * (also due to resume() callback returning 1)
2723 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
2724 * of wowlan configuration)
2725 */
2726enum ieee80211_reconfig_type {
2727 IEEE80211_RECONFIG_TYPE_RESTART,
2728 IEEE80211_RECONFIG_TYPE_SUSPEND,
2729};
2730
75a5f0cc
JB
2731/**
2732 * struct ieee80211_ops - callbacks from mac80211 to the driver
2733 *
2734 * This structure contains various callbacks that the driver may
2735 * handle or, in some cases, must handle, for example to configure
2736 * the hardware to a new channel or to transmit a frame.
2737 *
2738 * @tx: Handler that 802.11 module calls for each transmitted frame.
2739 * skb contains the buffer starting from the IEEE 802.11 header.
2740 * The low-level driver should send the frame out based on
eefce91a 2741 * configuration in the TX control data. This handler should,
11127e91 2742 * preferably, never fail and stop queues appropriately.
11127e91 2743 * Must be atomic.
75a5f0cc
JB
2744 *
2745 * @start: Called before the first netdevice attached to the hardware
2746 * is enabled. This should turn on the hardware and must turn on
2747 * frame reception (for possibly enabled monitor interfaces.)
2748 * Returns negative error codes, these may be seen in userspace,
2749 * or zero.
2750 * When the device is started it should not have a MAC address
2751 * to avoid acknowledging frames before a non-monitor device
2752 * is added.
e1781ed3 2753 * Must be implemented and can sleep.
75a5f0cc
JB
2754 *
2755 * @stop: Called after last netdevice attached to the hardware
2756 * is disabled. This should turn off the hardware (at least
2757 * it must turn off frame reception.)
2758 * May be called right after add_interface if that rejects
42935eca
LR
2759 * an interface. If you added any work onto the mac80211 workqueue
2760 * you should ensure to cancel it on this callback.
e1781ed3 2761 * Must be implemented and can sleep.
75a5f0cc 2762 *
eecc4800
JB
2763 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2764 * stop transmitting and doing any other configuration, and then
2765 * ask the device to suspend. This is only invoked when WoWLAN is
2766 * configured, otherwise the device is deconfigured completely and
2767 * reconfigured at resume time.
2b4562df
JB
2768 * The driver may also impose special conditions under which it
2769 * wants to use the "normal" suspend (deconfigure), say if it only
2770 * supports WoWLAN when the device is associated. In this case, it
2771 * must return 1 from this function.
eecc4800
JB
2772 *
2773 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2774 * now resuming its operation, after this the device must be fully
2775 * functional again. If this returns an error, the only way out is
2776 * to also unregister the device. If it returns 1, then mac80211
2777 * will also go through the regular complete restart on resume.
2778 *
d13e1414
JB
2779 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2780 * modified. The reason is that device_set_wakeup_enable() is
2781 * supposed to be called when the configuration changes, not only
2782 * in suspend().
2783 *
75a5f0cc 2784 * @add_interface: Called when a netdevice attached to the hardware is
e37d4dff 2785 * enabled. Because it is not called for monitor mode devices, @start
75a5f0cc
JB
2786 * and @stop must be implemented.
2787 * The driver should perform any initialization it needs before
2788 * the device can be enabled. The initial configuration for the
2789 * interface is given in the conf parameter.
2790 * The callback may refuse to add an interface by returning a
2791 * negative error code (which will be seen in userspace.)
e1781ed3 2792 * Must be implemented and can sleep.
75a5f0cc 2793 *
34d4bc4d
JB
2794 * @change_interface: Called when a netdevice changes type. This callback
2795 * is optional, but only if it is supported can interface types be
2796 * switched while the interface is UP. The callback may sleep.
2797 * Note that while an interface is being switched, it will not be
2798 * found by the interface iteration callbacks.
2799 *
75a5f0cc
JB
2800 * @remove_interface: Notifies a driver that an interface is going down.
2801 * The @stop callback is called after this if it is the last interface
2802 * and no monitor interfaces are present.
2803 * When all interfaces are removed, the MAC address in the hardware
2804 * must be cleared so the device no longer acknowledges packets,
2805 * the mac_addr member of the conf structure is, however, set to the
2806 * MAC address of the device going away.
e1781ed3 2807 * Hence, this callback must be implemented. It can sleep.
75a5f0cc
JB
2808 *
2809 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2810 * function to change hardware configuration, e.g., channel.
6dd1bf31 2811 * This function should never fail but returns a negative error code
e1781ed3 2812 * if it does. The callback can sleep.
75a5f0cc 2813 *
471b3efd
JB
2814 * @bss_info_changed: Handler for configuration requests related to BSS
2815 * parameters that may vary during BSS's lifespan, and may affect low
2816 * level driver (e.g. assoc/disassoc status, erp parameters).
2817 * This function should not be used if no BSS has been set, unless
2818 * for association indication. The @changed parameter indicates which
e1781ed3
KV
2819 * of the bss parameters has changed when a call is made. The callback
2820 * can sleep.
471b3efd 2821 *
3ac64bee
JB
2822 * @prepare_multicast: Prepare for multicast filter configuration.
2823 * This callback is optional, and its return value is passed
2824 * to configure_filter(). This callback must be atomic.
2825 *
75a5f0cc
JB
2826 * @configure_filter: Configure the device's RX filter.
2827 * See the section "Frame filtering" for more information.
e1781ed3 2828 * This callback must be implemented and can sleep.
75a5f0cc 2829 *
546c80c9 2830 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
17741cdc 2831 * must be set or cleared for a given STA. Must be atomic.
75a5f0cc
JB
2832 *
2833 * @set_key: See the section "Hardware crypto acceleration"
e1781ed3
KV
2834 * This callback is only called between add_interface and
2835 * remove_interface calls, i.e. while the given virtual interface
dc822b5d 2836 * is enabled.
6dd1bf31 2837 * Returns a negative error code if the key can't be added.
e1781ed3 2838 * The callback can sleep.
75a5f0cc 2839 *
9ae4fda3
EG
2840 * @update_tkip_key: See the section "Hardware crypto acceleration"
2841 * This callback will be called in the context of Rx. Called for drivers
2842 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
eb807fb2 2843 * The callback must be atomic.
9ae4fda3 2844 *
c68f4b89
JB
2845 * @set_rekey_data: If the device supports GTK rekeying, for example while the
2846 * host is suspended, it can assign this callback to retrieve the data
2847 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2848 * After rekeying was done it should (for example during resume) notify
2849 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2850 *
de5fad81
YD
2851 * @set_default_unicast_key: Set the default (unicast) key index, useful for
2852 * WEP when the device sends data packets autonomously, e.g. for ARP
2853 * offloading. The index can be 0-3, or -1 for unsetting it.
2854 *
75a5f0cc 2855 * @hw_scan: Ask the hardware to service the scan request, no need to start
8318d78a 2856 * the scan state machine in stack. The scan must honour the channel
9050bdd8
KV
2857 * configuration done by the regulatory agent in the wiphy's
2858 * registered bands. The hardware (or the driver) needs to make sure
de95a54b
JB
2859 * that power save is disabled.
2860 * The @req ie/ie_len members are rewritten by mac80211 to contain the
2861 * entire IEs after the SSID, so that drivers need not look at these
2862 * at all but just send them after the SSID -- mac80211 includes the
2863 * (extended) supported rates and HT information (where applicable).
2864 * When the scan finishes, ieee80211_scan_completed() must be called;
2865 * note that it also must be called when the scan cannot finish due to
2866 * any error unless this callback returned a negative error code.
e1781ed3 2867 * The callback can sleep.
75a5f0cc 2868 *
b856439b
EP
2869 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2870 * The driver should ask the hardware to cancel the scan (if possible),
2871 * but the scan will be completed only after the driver will call
2872 * ieee80211_scan_completed().
2873 * This callback is needed for wowlan, to prevent enqueueing a new
2874 * scan_work after the low-level driver was already suspended.
2875 * The callback can sleep.
2876 *
79f460ca
LC
2877 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2878 * specific intervals. The driver must call the
2879 * ieee80211_sched_scan_results() function whenever it finds results.
2880 * This process will continue until sched_scan_stop is called.
2881 *
2882 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
37e3308c 2883 * In this case, ieee80211_sched_scan_stopped() must not be called.
79f460ca 2884 *
80e775bf
MB
2885 * @sw_scan_start: Notifier function that is called just before a software scan
2886 * is started. Can be NULL, if the driver doesn't need this notification.
a344d677
JB
2887 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
2888 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
2889 * can use this parameter. The callback can sleep.
80e775bf 2890 *
e1781ed3
KV
2891 * @sw_scan_complete: Notifier function that is called just after a
2892 * software scan finished. Can be NULL, if the driver doesn't need
2893 * this notification.
2894 * The callback can sleep.
80e775bf 2895 *
6dd1bf31
BC
2896 * @get_stats: Return low-level statistics.
2897 * Returns zero if statistics are available.
e1781ed3 2898 * The callback can sleep.
75a5f0cc 2899 *
9352c19f
JB
2900 * @get_key_seq: If your device implements encryption in hardware and does
2901 * IV/PN assignment then this callback should be provided to read the
2902 * IV/PN for the given key from hardware.
e1781ed3 2903 * The callback must be atomic.
75a5f0cc 2904 *
f23a4780
AN
2905 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
2906 * if the device does fragmentation by itself; if this callback is
2907 * implemented then the stack will not do fragmentation.
2908 * The callback can sleep.
2909 *
75a5f0cc 2910 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
e1781ed3 2911 * The callback can sleep.
75a5f0cc 2912 *
34e89507
JB
2913 * @sta_add: Notifies low level driver about addition of an associated station,
2914 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2915 *
2916 * @sta_remove: Notifies low level driver about removal of an associated
6a9d1b91
JB
2917 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
2918 * returns it isn't safe to use the pointer, not even RCU protected;
2919 * no RCU grace period is guaranteed between returning here and freeing
2920 * the station. See @sta_pre_rcu_remove if needed.
2921 * This callback can sleep.
34e89507 2922 *
77d2ece6
SM
2923 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
2924 * when a station is added to mac80211's station list. This callback
2925 * and @sta_remove_debugfs should be within a CONFIG_MAC80211_DEBUGFS
2926 * conditional. This callback can sleep.
2927 *
2928 * @sta_remove_debugfs: Remove the debugfs files which were added using
2929 * @sta_add_debugfs. This callback can sleep.
2930 *
34e89507 2931 * @sta_notify: Notifies low level driver about power state transition of an
d057e5a3
AN
2932 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
2933 * in AP mode, this callback will not be called when the flag
2934 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
4571d3bf 2935 *
f09603a2
JB
2936 * @sta_state: Notifies low level driver about state transition of a
2937 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
2938 * This callback is mutually exclusive with @sta_add/@sta_remove.
2939 * It must not fail for down transitions but may fail for transitions
6a9d1b91
JB
2940 * up the list of states. Also note that after the callback returns it
2941 * isn't safe to use the pointer, not even RCU protected - no RCU grace
2942 * period is guaranteed between returning here and freeing the station.
2943 * See @sta_pre_rcu_remove if needed.
2944 * The callback can sleep.
2945 *
2946 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
2947 * synchronisation. This is useful if a driver needs to have station
2948 * pointers protected using RCU, it can then use this call to clear
2949 * the pointers instead of waiting for an RCU grace period to elapse
2950 * in @sta_state.
f09603a2
JB
2951 * The callback can sleep.
2952 *
8f727ef3
JB
2953 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
2954 * used to transmit to the station. The changes are advertised with bits
2955 * from &enum ieee80211_rate_control_changed and the values are reflected
2956 * in the station data. This callback should only be used when the driver
2957 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
2958 * otherwise the rate control algorithm is notified directly.
2959 * Must be atomic.
f815e2b3
JB
2960 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
2961 * is only used if the configured rate control algorithm actually uses
2962 * the new rate table API, and is therefore optional. Must be atomic.
8f727ef3 2963 *
2b9a7e1b
JB
2964 * @sta_statistics: Get statistics for this station. For example with beacon
2965 * filtering, the statistics kept by mac80211 might not be accurate, so
2966 * let the driver pre-fill the statistics. The driver can fill most of
2967 * the values (indicating which by setting the filled bitmap), but not
2968 * all of them make sense - see the source for which ones are possible.
2969 * Statistics that the driver doesn't fill will be filled by mac80211.
2970 * The callback can sleep.
2971 *
75a5f0cc 2972 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
fe3fa827 2973 * bursting) for a hardware TX queue.
6dd1bf31 2974 * Returns a negative error code on failure.
e1781ed3 2975 * The callback can sleep.
75a5f0cc 2976 *
75a5f0cc 2977 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
3b5d665b 2978 * this is only used for IBSS mode BSSID merging and debugging. Is not a
7b08b3b4 2979 * required function.
e1781ed3 2980 * The callback can sleep.
3b5d665b
AF
2981 *
2982 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
ad24b0da 2983 * Currently, this is only used for IBSS mode debugging. Is not a
7b08b3b4 2984 * required function.
e1781ed3 2985 * The callback can sleep.
75a5f0cc
JB
2986 *
2987 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
2988 * with other STAs in the IBSS. This is only used in IBSS mode. This
2989 * function is optional if the firmware/hardware takes full care of
2990 * TSF synchronization.
e1781ed3 2991 * The callback can sleep.
75a5f0cc 2992 *
75a5f0cc
JB
2993 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
2994 * This is needed only for IBSS mode and the result of this function is
2995 * used to determine whether to reply to Probe Requests.
6dd1bf31 2996 * Returns non-zero if this device sent the last beacon.
e1781ed3 2997 * The callback can sleep.
d3c990fb 2998 *
1b7d03ac
RR
2999 * @ampdu_action: Perform a certain A-MPDU action
3000 * The RA/TID combination determines the destination and TID we want
3001 * the ampdu action to be performed for. The action is defined through
3002 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
6dd1bf31 3003 * is the first frame we expect to perform the action on. Notice
0df3ef45 3004 * that TX/RX_STOP can pass NULL for this parameter.
0b01f030
JB
3005 * The @buf_size parameter is only valid when the action is set to
3006 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
5312c3f6
JB
3007 * buffer size (number of subframes) for this session -- the driver
3008 * may neither send aggregates containing more subframes than this
3009 * nor send aggregates in a way that lost frames would exceed the
3010 * buffer size. If just limiting the aggregate size, this would be
3011 * possible with a buf_size of 8:
3012 * - TX: 1.....7
3013 * - RX: 2....7 (lost frame #1)
3014 * - TX: 8..1...
3015 * which is invalid since #1 was now re-transmitted well past the
3016 * buffer size of 8. Correct ways to retransmit #1 would be:
3017 * - TX: 1 or 18 or 81
3018 * Even "189" would be wrong since 1 could be lost again.
3019 *
6dd1bf31 3020 * Returns a negative error code on failure.
85ad181e 3021 * The callback can sleep.
1f87f7d3 3022 *
4e8998f0
RD
3023 * @get_survey: Return per-channel survey information
3024 *
1f87f7d3
JB
3025 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
3026 * need to set wiphy->rfkill_poll to %true before registration,
3027 * and need to call wiphy_rfkill_set_hw_state() in the callback.
e1781ed3 3028 * The callback can sleep.
aff89a9b 3029 *
310bc676
LT
3030 * @set_coverage_class: Set slot time for given coverage class as specified
3031 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
a4bcaf55
LB
3032 * accordingly; coverage class equals to -1 to enable ACK timeout
3033 * estimation algorithm (dynack). To disable dynack set valid value for
3034 * coverage class. This callback is not required and may sleep.
310bc676 3035 *
52981cd7
DS
3036 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
3037 * be %NULL. The callback can sleep.
71063f0e 3038 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
a80f7c0b
JB
3039 *
3040 * @flush: Flush all pending frames from the hardware queue, making sure
39ecc01d
JB
3041 * that the hardware queues are empty. The @queues parameter is a bitmap
3042 * of queues to flush, which is useful if different virtual interfaces
3043 * use different hardware queues; it may also indicate all queues.
3044 * If the parameter @drop is set to %true, pending frames may be dropped.
77be2c54 3045 * Note that vif can be NULL.
39ecc01d 3046 * The callback can sleep.
5ce6e438
JB
3047 *
3048 * @channel_switch: Drivers that need (or want) to offload the channel
3049 * switch operation for CSAs received from the AP may implement this
3050 * callback. They must then call ieee80211_chswitch_done() to indicate
3051 * completion of the channel switch.
4e6cbfd0 3052 *
79b1c460
BR
3053 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3054 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3055 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3056 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3057 *
3058 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
4976b4eb
JB
3059 *
3060 * @remain_on_channel: Starts an off-channel period on the given channel, must
3061 * call back to ieee80211_ready_on_channel() when on that channel. Note
3062 * that normal channel traffic is not stopped as this is intended for hw
3063 * offload. Frames to transmit on the off-channel channel are transmitted
3064 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
3065 * duration (which will always be non-zero) expires, the driver must call
196ac1c1 3066 * ieee80211_remain_on_channel_expired().
196ac1c1
JB
3067 * Note that this callback may be called while the device is in IDLE and
3068 * must be accepted in this case.
3069 * This callback may sleep.
4976b4eb
JB
3070 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
3071 * aborted before it expires. This callback may sleep.
38c09159
JL
3072 *
3073 * @set_ringparam: Set tx and rx ring sizes.
3074 *
3075 * @get_ringparam: Get tx and rx ring current and maximum sizes.
e8306f98
VN
3076 *
3077 * @tx_frames_pending: Check if there is any pending frame in the hardware
3078 * queues before entering power save.
bdbfd6b5
SM
3079 *
3080 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
3081 * when transmitting a frame. Currently only legacy rates are handled.
3082 * The callback can sleep.
a8182929
EG
3083 * @event_callback: Notify driver about any event in mac80211. See
3084 * &enum ieee80211_event_type for the different types.
6382246e 3085 * The callback must be atomic.
4049e09a
JB
3086 *
3087 * @release_buffered_frames: Release buffered frames according to the given
3088 * parameters. In the case where the driver buffers some frames for
3089 * sleeping stations mac80211 will use this callback to tell the driver
3090 * to release some frames, either for PS-poll or uAPSD.
e227867f 3091 * Note that if the @more_data parameter is %false the driver must check
4049e09a
JB
3092 * if there are more frames on the given TIDs, and if there are more than
3093 * the frames being released then it must still set the more-data bit in
3094 * the frame. If the @more_data parameter is %true, then of course the
3095 * more-data bit must always be set.
3096 * The @tids parameter tells the driver which TIDs to release frames
3097 * from, for PS-poll it will always have only a single bit set.
deeaee19
JB
3098 * In the case this is used for a PS-poll initiated release, the
3099 * @num_frames parameter will always be 1 so code can be shared. In
3100 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
3101 * on the TX status (and must report TX status) so that the PS-poll
3102 * period is properly ended. This is used to avoid sending multiple
3103 * responses for a retried PS-poll frame.
4049e09a
JB
3104 * In the case this is used for uAPSD, the @num_frames parameter may be
3105 * bigger than one, but the driver may send fewer frames (it must send
3106 * at least one, however). In this case it is also responsible for
47086fc5
JB
3107 * setting the EOSP flag in the QoS header of the frames. Also, when the
3108 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
37fbd908 3109 * on the last frame in the SP. Alternatively, it may call the function
e943789e 3110 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
4049e09a 3111 * This callback must be atomic.
40b96408
JB
3112 * @allow_buffered_frames: Prepare device to allow the given number of frames
3113 * to go out to the given station. The frames will be sent by mac80211
3114 * via the usual TX path after this call. The TX information for frames
02f2f1a9 3115 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
40b96408
JB
3116 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
3117 * frames from multiple TIDs are released and the driver might reorder
3118 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
3119 * on the last frame and clear it on all others and also handle the EOSP
37fbd908 3120 * bit in the QoS header correctly. Alternatively, it can also call the
e943789e 3121 * ieee80211_sta_eosp() function.
40b96408
JB
3122 * The @tids parameter is a bitmap and tells the driver which TIDs the
3123 * frames will be on; it will at most have two bits set.
3124 * This callback must be atomic.
e352114f
BG
3125 *
3126 * @get_et_sset_count: Ethtool API to get string-set count.
3127 *
3128 * @get_et_stats: Ethtool API to get a set of u64 stats.
3129 *
3130 * @get_et_strings: Ethtool API to get a set of strings to describe stats
3131 * and perhaps other supported types of ethtool data-sets.
3132 *
a1845fc7
JB
3133 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
3134 * before associated. In multi-channel scenarios, a virtual interface is
3135 * bound to a channel before it is associated, but as it isn't associated
3136 * yet it need not necessarily be given airtime, in particular since any
3137 * transmission to a P2P GO needs to be synchronized against the GO's
3138 * powersave state. mac80211 will call this function before transmitting a
3139 * management frame prior to having successfully associated to allow the
3140 * driver to give it channel time for the transmission, to get a response
3141 * and to be able to synchronize with the GO.
3142 * The callback will be called before each transmission and upon return
3143 * mac80211 will transmit the frame right away.
3144 * The callback is optional and can (should!) sleep.
c3645eac 3145 *
ee10f2c7
AN
3146 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
3147 * a TDLS discovery-request, we expect a reply to arrive on the AP's
3148 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
3149 * setup-response is a direct packet not buffered by the AP.
3150 * mac80211 will call this function just before the transmission of a TDLS
3151 * discovery-request. The recommended period of protection is at least
3152 * 2 * (DTIM period).
3153 * The callback is optional and can sleep.
3154 *
c3645eac
MK
3155 * @add_chanctx: Notifies device driver about new channel context creation.
3156 * @remove_chanctx: Notifies device driver about channel context destruction.
3157 * @change_chanctx: Notifies device driver about channel context changes that
3158 * may happen when combining different virtual interfaces on the same
3159 * channel context with different settings
3160 * @assign_vif_chanctx: Notifies device driver about channel context being bound
3161 * to vif. Possible use is for hw queue remapping.
3162 * @unassign_vif_chanctx: Notifies device driver about channel context being
3163 * unbound from vif.
1a5f0c13
LC
3164 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
3165 * another, as specified in the list of
3166 * @ieee80211_vif_chanctx_switch passed to the driver, according
3167 * to the mode defined in &ieee80211_chanctx_switch_mode.
3168 *
1041638f
JB
3169 * @start_ap: Start operation on the AP interface, this is called after all the
3170 * information in bss_conf is set and beacon can be retrieved. A channel
3171 * context is bound before this is called. Note that if the driver uses
3172 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
3173 * just "paused" for scanning/ROC, which is indicated by the beacon being
3174 * disabled/enabled via @bss_info_changed.
3175 * @stop_ap: Stop operation on the AP interface.
9214ad7f 3176 *
cf2c92d8
EP
3177 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
3178 * during resume, when the reconfiguration has completed.
3179 * This can help the driver implement the reconfiguration step (and
3180 * indicate mac80211 is ready to receive frames).
3181 * This callback may sleep.
8f21b0ad 3182 *
a65240c1
JB
3183 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
3184 * Currently, this is only called for managed or P2P client interfaces.
3185 * This callback is optional; it must not sleep.
73da7d5b
SW
3186 *
3187 * @channel_switch_beacon: Starts a channel switch to a new channel.
3188 * Beacons are modified to include CSA or ECSA IEs before calling this
3189 * function. The corresponding count fields in these IEs must be
66e01cf9 3190 * decremented, and when they reach 1 the driver must call
73da7d5b
SW
3191 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
3192 * get the csa counter decremented by mac80211, but must check if it is
66e01cf9 3193 * 1 using ieee80211_csa_is_complete() after the beacon has been
73da7d5b 3194 * transmitted and then call ieee80211_csa_finish().
66e01cf9
LC
3195 * If the CSA count starts as zero or 1, this function will not be called,
3196 * since there won't be any time to beacon before the switch anyway.
6d027bcc
LC
3197 * @pre_channel_switch: This is an optional callback that is called
3198 * before a channel switch procedure is started (ie. when a STA
3199 * gets a CSA or an userspace initiated channel-switch), allowing
3200 * the driver to prepare for the channel switch.
f1d65583
LC
3201 * @post_channel_switch: This is an optional callback that is called
3202 * after a channel switch procedure is completed, allowing the
3203 * driver to go back to a normal configuration.
73da7d5b 3204 *
55fff501
JB
3205 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
3206 * information in bss_conf is set up and the beacon can be retrieved. A
3207 * channel context is bound before this is called.
3208 * @leave_ibss: Leave the IBSS again.
cca674d4
AQ
3209 *
3210 * @get_expected_throughput: extract the expected throughput towards the
3211 * specified station. The returned value is expressed in Kbps. It returns 0
3212 * if the RC algorithm does not have proper data to provide.
5b3dc42b
FF
3213 *
3214 * @get_txpower: get current maximum tx power (in dBm) based on configuration
3215 * and hardware limits.
a7a6bdd0
AN
3216 *
3217 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3218 * is responsible for continually initiating channel-switching operations
3219 * and returning to the base channel for communication with the AP. The
3220 * driver receives a channel-switch request template and the location of
3221 * the switch-timing IE within the template as part of the invocation.
3222 * The template is valid only within the call, and the driver can
3223 * optionally copy the skb for further re-use.
3224 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3225 * peers must be on the base channel when the call completes.
8a4d32f3
AN
3226 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
3227 * response) has been received from a remote peer. The driver gets
3228 * parameters parsed from the incoming frame and may use them to continue
3229 * an ongoing channel-switch operation. In addition, a channel-switch
3230 * response template is provided, together with the location of the
3231 * switch-timing IE within the template. The skb can only be used within
3232 * the function call.
ba8c3d6f
FF
3233 *
3234 * @wake_tx_queue: Called when new packets have been added to the queue.
75a5f0cc 3235 */
f0706e82 3236struct ieee80211_ops {
36323f81
TH
3237 void (*tx)(struct ieee80211_hw *hw,
3238 struct ieee80211_tx_control *control,
3239 struct sk_buff *skb);
4150c572 3240 int (*start)(struct ieee80211_hw *hw);
4150c572 3241 void (*stop)(struct ieee80211_hw *hw);
eecc4800
JB
3242#ifdef CONFIG_PM
3243 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
3244 int (*resume)(struct ieee80211_hw *hw);
6d52563f 3245 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
eecc4800 3246#endif
f0706e82 3247 int (*add_interface)(struct ieee80211_hw *hw,
1ed32e4f 3248 struct ieee80211_vif *vif);
34d4bc4d
JB
3249 int (*change_interface)(struct ieee80211_hw *hw,
3250 struct ieee80211_vif *vif,
2ca27bcf 3251 enum nl80211_iftype new_type, bool p2p);
f0706e82 3252 void (*remove_interface)(struct ieee80211_hw *hw,
1ed32e4f 3253 struct ieee80211_vif *vif);
e8975581 3254 int (*config)(struct ieee80211_hw *hw, u32 changed);
471b3efd
JB
3255 void (*bss_info_changed)(struct ieee80211_hw *hw,
3256 struct ieee80211_vif *vif,
3257 struct ieee80211_bss_conf *info,
3258 u32 changed);
b2abb6e2 3259
1041638f
JB
3260 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3261 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3262
3ac64bee 3263 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
22bedad3 3264 struct netdev_hw_addr_list *mc_list);
4150c572
JB
3265 void (*configure_filter)(struct ieee80211_hw *hw,
3266 unsigned int changed_flags,
3267 unsigned int *total_flags,
3ac64bee 3268 u64 multicast);
17741cdc
JB
3269 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
3270 bool set);
ea49c359 3271 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
dc822b5d 3272 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
11a843b7 3273 struct ieee80211_key_conf *key);
9ae4fda3 3274 void (*update_tkip_key)(struct ieee80211_hw *hw,
b3fbdcf4
JB
3275 struct ieee80211_vif *vif,
3276 struct ieee80211_key_conf *conf,
3277 struct ieee80211_sta *sta,
3278 u32 iv32, u16 *phase1key);
c68f4b89
JB
3279 void (*set_rekey_data)(struct ieee80211_hw *hw,
3280 struct ieee80211_vif *vif,
3281 struct cfg80211_gtk_rekey_data *data);
de5fad81
YD
3282 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
3283 struct ieee80211_vif *vif, int idx);
a060bbfe 3284 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
c56ef672 3285 struct ieee80211_scan_request *req);
b856439b
EP
3286 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
3287 struct ieee80211_vif *vif);
79f460ca
LC
3288 int (*sched_scan_start)(struct ieee80211_hw *hw,
3289 struct ieee80211_vif *vif,
3290 struct cfg80211_sched_scan_request *req,
633e2713 3291 struct ieee80211_scan_ies *ies);
37e3308c 3292 int (*sched_scan_stop)(struct ieee80211_hw *hw,
79f460ca 3293 struct ieee80211_vif *vif);
a344d677
JB
3294 void (*sw_scan_start)(struct ieee80211_hw *hw,
3295 struct ieee80211_vif *vif,
3296 const u8 *mac_addr);
3297 void (*sw_scan_complete)(struct ieee80211_hw *hw,
3298 struct ieee80211_vif *vif);
f0706e82
JB
3299 int (*get_stats)(struct ieee80211_hw *hw,
3300 struct ieee80211_low_level_stats *stats);
9352c19f
JB
3301 void (*get_key_seq)(struct ieee80211_hw *hw,
3302 struct ieee80211_key_conf *key,
3303 struct ieee80211_key_seq *seq);
f23a4780 3304 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
f0706e82 3305 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
34e89507
JB
3306 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3307 struct ieee80211_sta *sta);
3308 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3309 struct ieee80211_sta *sta);
77d2ece6
SM
3310#ifdef CONFIG_MAC80211_DEBUGFS
3311 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
3312 struct ieee80211_vif *vif,
3313 struct ieee80211_sta *sta,
3314 struct dentry *dir);
3315 void (*sta_remove_debugfs)(struct ieee80211_hw *hw,
3316 struct ieee80211_vif *vif,
3317 struct ieee80211_sta *sta,
3318 struct dentry *dir);
3319#endif
32bfd35d 3320 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
17741cdc 3321 enum sta_notify_cmd, struct ieee80211_sta *sta);
f09603a2
JB
3322 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3323 struct ieee80211_sta *sta,
3324 enum ieee80211_sta_state old_state,
3325 enum ieee80211_sta_state new_state);
6a9d1b91
JB
3326 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
3327 struct ieee80211_vif *vif,
3328 struct ieee80211_sta *sta);
8f727ef3
JB
3329 void (*sta_rc_update)(struct ieee80211_hw *hw,
3330 struct ieee80211_vif *vif,
3331 struct ieee80211_sta *sta,
3332 u32 changed);
f815e2b3
JB
3333 void (*sta_rate_tbl_update)(struct ieee80211_hw *hw,
3334 struct ieee80211_vif *vif,
3335 struct ieee80211_sta *sta);
2b9a7e1b
JB
3336 void (*sta_statistics)(struct ieee80211_hw *hw,
3337 struct ieee80211_vif *vif,
3338 struct ieee80211_sta *sta,
3339 struct station_info *sinfo);
8a3a3c85 3340 int (*conf_tx)(struct ieee80211_hw *hw,
a3304b0a 3341 struct ieee80211_vif *vif, u16 ac,
f0706e82 3342 const struct ieee80211_tx_queue_params *params);
37a41b4a
EP
3343 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3344 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3345 u64 tsf);
3346 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
f0706e82 3347 int (*tx_last_beacon)(struct ieee80211_hw *hw);
1b7d03ac 3348 int (*ampdu_action)(struct ieee80211_hw *hw,
c951ad35 3349 struct ieee80211_vif *vif,
1b7d03ac 3350 enum ieee80211_ampdu_mlme_action action,
0b01f030
JB
3351 struct ieee80211_sta *sta, u16 tid, u16 *ssn,
3352 u8 buf_size);
1289723e
HS
3353 int (*get_survey)(struct ieee80211_hw *hw, int idx,
3354 struct survey_info *survey);
1f87f7d3 3355 void (*rfkill_poll)(struct ieee80211_hw *hw);
a4bcaf55 3356 void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class);
aff89a9b 3357#ifdef CONFIG_NL80211_TESTMODE
52981cd7
DS
3358 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3359 void *data, int len);
71063f0e
WYG
3360 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
3361 struct netlink_callback *cb,
3362 void *data, int len);
aff89a9b 3363#endif
77be2c54
EG
3364 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3365 u32 queues, bool drop);
5ce6e438 3366 void (*channel_switch)(struct ieee80211_hw *hw,
0f791eb4 3367 struct ieee80211_vif *vif,
5ce6e438 3368 struct ieee80211_channel_switch *ch_switch);
15d96753
BR
3369 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
3370 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
21f83589
JB
3371
3372 int (*remain_on_channel)(struct ieee80211_hw *hw,
49884568 3373 struct ieee80211_vif *vif,
21f83589 3374 struct ieee80211_channel *chan,
d339d5ca
IP
3375 int duration,
3376 enum ieee80211_roc_type type);
21f83589 3377 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
38c09159
JL
3378 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
3379 void (*get_ringparam)(struct ieee80211_hw *hw,
3380 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
e8306f98 3381 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
bdbfd6b5
SM
3382 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3383 const struct cfg80211_bitrate_mask *mask);
a8182929
EG
3384 void (*event_callback)(struct ieee80211_hw *hw,
3385 struct ieee80211_vif *vif,
3386 const struct ieee80211_event *event);
4049e09a 3387
40b96408
JB
3388 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
3389 struct ieee80211_sta *sta,
3390 u16 tids, int num_frames,
3391 enum ieee80211_frame_release_type reason,
3392 bool more_data);
4049e09a
JB
3393 void (*release_buffered_frames)(struct ieee80211_hw *hw,
3394 struct ieee80211_sta *sta,
3395 u16 tids, int num_frames,
3396 enum ieee80211_frame_release_type reason,
3397 bool more_data);
e352114f
BG
3398
3399 int (*get_et_sset_count)(struct ieee80211_hw *hw,
3400 struct ieee80211_vif *vif, int sset);
3401 void (*get_et_stats)(struct ieee80211_hw *hw,
3402 struct ieee80211_vif *vif,
3403 struct ethtool_stats *stats, u64 *data);
3404 void (*get_et_strings)(struct ieee80211_hw *hw,
3405 struct ieee80211_vif *vif,
3406 u32 sset, u8 *data);
a1845fc7
JB
3407
3408 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
3409 struct ieee80211_vif *vif);
c3645eac 3410
ee10f2c7
AN
3411 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
3412 struct ieee80211_vif *vif);
3413
c3645eac
MK
3414 int (*add_chanctx)(struct ieee80211_hw *hw,
3415 struct ieee80211_chanctx_conf *ctx);
3416 void (*remove_chanctx)(struct ieee80211_hw *hw,
3417 struct ieee80211_chanctx_conf *ctx);
3418 void (*change_chanctx)(struct ieee80211_hw *hw,
3419 struct ieee80211_chanctx_conf *ctx,
3420 u32 changed);
3421 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
3422 struct ieee80211_vif *vif,
3423 struct ieee80211_chanctx_conf *ctx);
3424 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
3425 struct ieee80211_vif *vif,
3426 struct ieee80211_chanctx_conf *ctx);
1a5f0c13
LC
3427 int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
3428 struct ieee80211_vif_chanctx_switch *vifs,
3429 int n_vifs,
3430 enum ieee80211_chanctx_switch_mode mode);
9214ad7f 3431
cf2c92d8
EP
3432 void (*reconfig_complete)(struct ieee80211_hw *hw,
3433 enum ieee80211_reconfig_type reconfig_type);
a65240c1
JB
3434
3435#if IS_ENABLED(CONFIG_IPV6)
3436 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
3437 struct ieee80211_vif *vif,
3438 struct inet6_dev *idev);
3439#endif
73da7d5b
SW
3440 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
3441 struct ieee80211_vif *vif,
3442 struct cfg80211_chan_def *chandef);
6d027bcc
LC
3443 int (*pre_channel_switch)(struct ieee80211_hw *hw,
3444 struct ieee80211_vif *vif,
3445 struct ieee80211_channel_switch *ch_switch);
55fff501 3446
f1d65583
LC
3447 int (*post_channel_switch)(struct ieee80211_hw *hw,
3448 struct ieee80211_vif *vif);
3449
55fff501
JB
3450 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3451 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
cca674d4 3452 u32 (*get_expected_throughput)(struct ieee80211_sta *sta);
5b3dc42b
FF
3453 int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3454 int *dbm);
a7a6bdd0
AN
3455
3456 int (*tdls_channel_switch)(struct ieee80211_hw *hw,
3457 struct ieee80211_vif *vif,
3458 struct ieee80211_sta *sta, u8 oper_class,
3459 struct cfg80211_chan_def *chandef,
8a4d32f3 3460 struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie);
a7a6bdd0
AN
3461 void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw,
3462 struct ieee80211_vif *vif,
3463 struct ieee80211_sta *sta);
8a4d32f3
AN
3464 void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw,
3465 struct ieee80211_vif *vif,
3466 struct ieee80211_tdls_ch_sw_params *params);
ba8c3d6f
FF
3467
3468 void (*wake_tx_queue)(struct ieee80211_hw *hw,
3469 struct ieee80211_txq *txq);
f0706e82
JB
3470};
3471
75a5f0cc 3472/**
ad28757e 3473 * ieee80211_alloc_hw_nm - Allocate a new hardware device
75a5f0cc
JB
3474 *
3475 * This must be called once for each hardware device. The returned pointer
3476 * must be used to refer to this device when calling other functions.
3477 * mac80211 allocates a private data area for the driver pointed to by
3478 * @priv in &struct ieee80211_hw, the size of this area is given as
3479 * @priv_data_len.
3480 *
3481 * @priv_data_len: length of private data
3482 * @ops: callbacks for this device
ad28757e
BG
3483 * @requested_name: Requested name for this device.
3484 * NULL is valid value, and means use the default naming (phy%d)
0ae997dc
YB
3485 *
3486 * Return: A pointer to the new hardware device, or %NULL on error.
f0706e82 3487 */
ad28757e
BG
3488struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len,
3489 const struct ieee80211_ops *ops,
3490 const char *requested_name);
3491
3492/**
3493 * ieee80211_alloc_hw - Allocate a new hardware device
3494 *
3495 * This must be called once for each hardware device. The returned pointer
3496 * must be used to refer to this device when calling other functions.
3497 * mac80211 allocates a private data area for the driver pointed to by
3498 * @priv in &struct ieee80211_hw, the size of this area is given as
3499 * @priv_data_len.
3500 *
3501 * @priv_data_len: length of private data
3502 * @ops: callbacks for this device
3503 *
3504 * Return: A pointer to the new hardware device, or %NULL on error.
3505 */
3506static inline
f0706e82 3507struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
ad28757e
BG
3508 const struct ieee80211_ops *ops)
3509{
3510 return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL);
3511}
f0706e82 3512
75a5f0cc
JB
3513/**
3514 * ieee80211_register_hw - Register hardware device
3515 *
dbbea671
JB
3516 * You must call this function before any other functions in
3517 * mac80211. Note that before a hardware can be registered, you
3518 * need to fill the contained wiphy's information.
75a5f0cc
JB
3519 *
3520 * @hw: the device to register as returned by ieee80211_alloc_hw()
0ae997dc
YB
3521 *
3522 * Return: 0 on success. An error code otherwise.
75a5f0cc 3523 */
f0706e82
JB
3524int ieee80211_register_hw(struct ieee80211_hw *hw);
3525
e1e54068
JB
3526/**
3527 * struct ieee80211_tpt_blink - throughput blink description
3528 * @throughput: throughput in Kbit/sec
3529 * @blink_time: blink time in milliseconds
3530 * (full cycle, ie. one off + one on period)
3531 */
3532struct ieee80211_tpt_blink {
3533 int throughput;
3534 int blink_time;
3535};
3536
67408c8c
JB
3537/**
3538 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
3539 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
3540 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
3541 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
3542 * interface is connected in some way, including being an AP
3543 */
3544enum ieee80211_tpt_led_trigger_flags {
3545 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
3546 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
3547 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
3548};
3549
f0706e82 3550#ifdef CONFIG_MAC80211_LEDS
f5c4ae07
JB
3551const char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
3552const char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
3553const char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
3554const char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
3555const char *
3556__ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
3557 unsigned int flags,
3558 const struct ieee80211_tpt_blink *blink_table,
3559 unsigned int blink_table_len);
f0706e82 3560#endif
75a5f0cc
JB
3561/**
3562 * ieee80211_get_tx_led_name - get name of TX LED
3563 *
3564 * mac80211 creates a transmit LED trigger for each wireless hardware
3565 * that can be used to drive LEDs if your driver registers a LED device.
3566 * This function returns the name (or %NULL if not configured for LEDs)
3567 * of the trigger so you can automatically link the LED device.
3568 *
3569 * @hw: the hardware to get the LED trigger name for
0ae997dc
YB
3570 *
3571 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
75a5f0cc 3572 */
f5c4ae07 3573static inline const char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
f0706e82
JB
3574{
3575#ifdef CONFIG_MAC80211_LEDS
3576 return __ieee80211_get_tx_led_name(hw);
3577#else
3578 return NULL;
3579#endif
3580}
3581
75a5f0cc
JB
3582/**
3583 * ieee80211_get_rx_led_name - get name of RX LED
3584 *
3585 * mac80211 creates a receive LED trigger for each wireless hardware
3586 * that can be used to drive LEDs if your driver registers a LED device.
3587 * This function returns the name (or %NULL if not configured for LEDs)
3588 * of the trigger so you can automatically link the LED device.
3589 *
3590 * @hw: the hardware to get the LED trigger name for
0ae997dc
YB
3591 *
3592 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
75a5f0cc 3593 */
f5c4ae07 3594static inline const char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
f0706e82
JB
3595{
3596#ifdef CONFIG_MAC80211_LEDS
3597 return __ieee80211_get_rx_led_name(hw);
3598#else
3599 return NULL;
3600#endif
3601}
3602
cdcb006f
ID
3603/**
3604 * ieee80211_get_assoc_led_name - get name of association LED
3605 *
3606 * mac80211 creates a association LED trigger for each wireless hardware
3607 * that can be used to drive LEDs if your driver registers a LED device.
3608 * This function returns the name (or %NULL if not configured for LEDs)
3609 * of the trigger so you can automatically link the LED device.
3610 *
3611 * @hw: the hardware to get the LED trigger name for
0ae997dc
YB
3612 *
3613 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
cdcb006f 3614 */
f5c4ae07 3615static inline const char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
47f0c502
MB
3616{
3617#ifdef CONFIG_MAC80211_LEDS
3618 return __ieee80211_get_assoc_led_name(hw);
3619#else
3620 return NULL;
3621#endif
3622}
3623
cdcb006f
ID
3624/**
3625 * ieee80211_get_radio_led_name - get name of radio LED
3626 *
3627 * mac80211 creates a radio change LED trigger for each wireless hardware
3628 * that can be used to drive LEDs if your driver registers a LED device.
3629 * This function returns the name (or %NULL if not configured for LEDs)
3630 * of the trigger so you can automatically link the LED device.
3631 *
3632 * @hw: the hardware to get the LED trigger name for
0ae997dc
YB
3633 *
3634 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
cdcb006f 3635 */
f5c4ae07 3636static inline const char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
cdcb006f
ID
3637{
3638#ifdef CONFIG_MAC80211_LEDS
3639 return __ieee80211_get_radio_led_name(hw);
3640#else
3641 return NULL;
3642#endif
3643}
47f0c502 3644
e1e54068
JB
3645/**
3646 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
3647 * @hw: the hardware to create the trigger for
67408c8c 3648 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
e1e54068
JB
3649 * @blink_table: the blink table -- needs to be ordered by throughput
3650 * @blink_table_len: size of the blink table
3651 *
0ae997dc
YB
3652 * Return: %NULL (in case of error, or if no LED triggers are
3653 * configured) or the name of the new trigger.
3654 *
3655 * Note: This function must be called before ieee80211_register_hw().
e1e54068 3656 */
f5c4ae07 3657static inline const char *
67408c8c 3658ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
e1e54068
JB
3659 const struct ieee80211_tpt_blink *blink_table,
3660 unsigned int blink_table_len)
3661{
3662#ifdef CONFIG_MAC80211_LEDS
67408c8c 3663 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
e1e54068
JB
3664 blink_table_len);
3665#else
3666 return NULL;
3667#endif
3668}
3669
75a5f0cc
JB
3670/**
3671 * ieee80211_unregister_hw - Unregister a hardware device
3672 *
3673 * This function instructs mac80211 to free allocated resources
3674 * and unregister netdevices from the networking subsystem.
3675 *
3676 * @hw: the hardware to unregister
3677 */
f0706e82
JB
3678void ieee80211_unregister_hw(struct ieee80211_hw *hw);
3679
75a5f0cc
JB
3680/**
3681 * ieee80211_free_hw - free hardware descriptor
3682 *
3683 * This function frees everything that was allocated, including the
3684 * private data for the driver. You must call ieee80211_unregister_hw()
6ef307bc 3685 * before calling this function.
75a5f0cc
JB
3686 *
3687 * @hw: the hardware to free
3688 */
f0706e82
JB
3689void ieee80211_free_hw(struct ieee80211_hw *hw);
3690
f2753ddb
JB
3691/**
3692 * ieee80211_restart_hw - restart hardware completely
3693 *
3694 * Call this function when the hardware was restarted for some reason
3695 * (hardware error, ...) and the driver is unable to restore its state
3696 * by itself. mac80211 assumes that at this point the driver/hardware
3697 * is completely uninitialised and stopped, it starts the process by
3698 * calling the ->start() operation. The driver will need to reset all
3699 * internal state that it has prior to calling this function.
3700 *
3701 * @hw: the hardware to restart
3702 */
3703void ieee80211_restart_hw(struct ieee80211_hw *hw);
3704
06d181a8 3705/**
af9f9b22 3706 * ieee80211_rx_napi - receive frame from NAPI context
4e6cbfd0 3707 *
af9f9b22
JB
3708 * Use this function to hand received frames to mac80211. The receive
3709 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3710 * paged @skb is used, the driver is recommended to put the ieee80211
3711 * header of the frame on the linear part of the @skb to avoid memory
3712 * allocation and/or memcpy by the stack.
3713 *
3714 * This function may not be called in IRQ context. Calls to this function
3715 * for a single hardware must be synchronized against each other. Calls to
3716 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3717 * mixed for a single hardware. Must not run concurrently with
3718 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3719 *
3720 * This function must be called with BHs disabled.
3721 *
3722 * @hw: the hardware this frame came in on
3723 * @skb: the buffer to receive, owned by mac80211 after this call
3724 * @napi: the NAPI context
4e6cbfd0 3725 */
af9f9b22
JB
3726void ieee80211_rx_napi(struct ieee80211_hw *hw, struct sk_buff *skb,
3727 struct napi_struct *napi);
4e6cbfd0 3728
75a5f0cc
JB
3729/**
3730 * ieee80211_rx - receive frame
3731 *
3732 * Use this function to hand received frames to mac80211. The receive
e3cf8b3f
ZY
3733 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3734 * paged @skb is used, the driver is recommended to put the ieee80211
3735 * header of the frame on the linear part of the @skb to avoid memory
3736 * allocation and/or memcpy by the stack.
75a5f0cc 3737 *
2485f710 3738 * This function may not be called in IRQ context. Calls to this function
e36e49f7
KV
3739 * for a single hardware must be synchronized against each other. Calls to
3740 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
f6b3d85f
FF
3741 * mixed for a single hardware. Must not run concurrently with
3742 * ieee80211_tx_status() or ieee80211_tx_status_ni().
75a5f0cc 3743 *
e36e49f7 3744 * In process context use instead ieee80211_rx_ni().
d20ef63d 3745 *
75a5f0cc
JB
3746 * @hw: the hardware this frame came in on
3747 * @skb: the buffer to receive, owned by mac80211 after this call
75a5f0cc 3748 */
af9f9b22
JB
3749static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb)
3750{
3751 ieee80211_rx_napi(hw, skb, NULL);
3752}
75a5f0cc
JB
3753
3754/**
3755 * ieee80211_rx_irqsafe - receive frame
3756 *
3757 * Like ieee80211_rx() but can be called in IRQ context
2485f710
JB
3758 * (internally defers to a tasklet.)
3759 *
e36e49f7 3760 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
f6b3d85f
FF
3761 * be mixed for a single hardware.Must not run concurrently with
3762 * ieee80211_tx_status() or ieee80211_tx_status_ni().
75a5f0cc
JB
3763 *
3764 * @hw: the hardware this frame came in on
3765 * @skb: the buffer to receive, owned by mac80211 after this call
75a5f0cc 3766 */
f1d58c25 3767void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
f0706e82 3768
e36e49f7
KV
3769/**
3770 * ieee80211_rx_ni - receive frame (in process context)
3771 *
3772 * Like ieee80211_rx() but can be called in process context
3773 * (internally disables bottom halves).
3774 *
3775 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
f6b3d85f
FF
3776 * not be mixed for a single hardware. Must not run concurrently with
3777 * ieee80211_tx_status() or ieee80211_tx_status_ni().
e36e49f7
KV
3778 *
3779 * @hw: the hardware this frame came in on
3780 * @skb: the buffer to receive, owned by mac80211 after this call
3781 */
3782static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
3783 struct sk_buff *skb)
3784{
3785 local_bh_disable();
3786 ieee80211_rx(hw, skb);
3787 local_bh_enable();
3788}
3789
d057e5a3
AN
3790/**
3791 * ieee80211_sta_ps_transition - PS transition for connected sta
3792 *
3793 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
3794 * flag set, use this function to inform mac80211 about a connected station
3795 * entering/leaving PS mode.
3796 *
3797 * This function may not be called in IRQ context or with softirqs enabled.
3798 *
3799 * Calls to this function for a single hardware must be synchronized against
3800 * each other.
3801 *
d057e5a3
AN
3802 * @sta: currently connected sta
3803 * @start: start or stop PS
0ae997dc
YB
3804 *
3805 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
d057e5a3
AN
3806 */
3807int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
3808
3809/**
3810 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
3811 * (in process context)
3812 *
3813 * Like ieee80211_sta_ps_transition() but can be called in process context
3814 * (internally disables bottom halves). Concurrent call restriction still
3815 * applies.
3816 *
3817 * @sta: currently connected sta
3818 * @start: start or stop PS
0ae997dc
YB
3819 *
3820 * Return: Like ieee80211_sta_ps_transition().
d057e5a3
AN
3821 */
3822static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
3823 bool start)
3824{
3825 int ret;
3826
3827 local_bh_disable();
3828 ret = ieee80211_sta_ps_transition(sta, start);
3829 local_bh_enable();
3830
3831 return ret;
3832}
3833
d24deb25
GW
3834/*
3835 * The TX headroom reserved by mac80211 for its own tx_status functions.
3836 * This is enough for the radiotap header.
3837 */
7f2a5e21 3838#define IEEE80211_TX_STATUS_HEADROOM 14
d24deb25 3839
dcf55fb5 3840/**
042ec453 3841 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
bdfbe804 3842 * @sta: &struct ieee80211_sta pointer for the sleeping station
042ec453
JB
3843 * @tid: the TID that has buffered frames
3844 * @buffered: indicates whether or not frames are buffered for this TID
dcf55fb5
FF
3845 *
3846 * If a driver buffers frames for a powersave station instead of passing
042ec453
JB
3847 * them back to mac80211 for retransmission, the station may still need
3848 * to be told that there are buffered frames via the TIM bit.
3849 *
3850 * This function informs mac80211 whether or not there are frames that are
3851 * buffered in the driver for a given TID; mac80211 can then use this data
3852 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
3853 * call! Beware of the locking!)
3854 *
3855 * If all frames are released to the station (due to PS-poll or uAPSD)
3856 * then the driver needs to inform mac80211 that there no longer are
3857 * frames buffered. However, when the station wakes up mac80211 assumes
3858 * that all buffered frames will be transmitted and clears this data,
3859 * drivers need to make sure they inform mac80211 about all buffered
3860 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
3861 *
3862 * Note that technically mac80211 only needs to know this per AC, not per
3863 * TID, but since driver buffering will inevitably happen per TID (since
3864 * it is related to aggregation) it is easier to make mac80211 map the
3865 * TID to the AC as required instead of keeping track in all drivers that
3866 * use this API.
3867 */
3868void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
3869 u8 tid, bool buffered);
dcf55fb5 3870
0d528d85
FF
3871/**
3872 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
3873 *
3874 * Call this function in a driver with per-packet rate selection support
3875 * to combine the rate info in the packet tx info with the most recent
3876 * rate selection table for the station entry.
3877 *
3878 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3879 * @sta: the receiver station to which this packet is sent.
3880 * @skb: the frame to be transmitted.
3881 * @dest: buffer for extracted rate/retry information
3882 * @max_rates: maximum number of rates to fetch
3883 */
3884void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
3885 struct ieee80211_sta *sta,
3886 struct sk_buff *skb,
3887 struct ieee80211_tx_rate *dest,
3888 int max_rates);
3889
75a5f0cc
JB
3890/**
3891 * ieee80211_tx_status - transmit status callback
3892 *
3893 * Call this function for all transmitted frames after they have been
3894 * transmitted. It is permissible to not call this function for
3895 * multicast frames but this can affect statistics.
3896 *
2485f710
JB
3897 * This function may not be called in IRQ context. Calls to this function
3898 * for a single hardware must be synchronized against each other. Calls
20ed3166 3899 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
f6b3d85f
FF
3900 * may not be mixed for a single hardware. Must not run concurrently with
3901 * ieee80211_rx() or ieee80211_rx_ni().
2485f710 3902 *
75a5f0cc
JB
3903 * @hw: the hardware the frame was transmitted by
3904 * @skb: the frame that was transmitted, owned by mac80211 after this call
75a5f0cc 3905 */
f0706e82 3906void ieee80211_tx_status(struct ieee80211_hw *hw,
e039fa4a 3907 struct sk_buff *skb);
2485f710 3908
f027c2ac
FF
3909/**
3910 * ieee80211_tx_status_noskb - transmit status callback without skb
3911 *
3912 * This function can be used as a replacement for ieee80211_tx_status
3913 * in drivers that cannot reliably map tx status information back to
3914 * specific skbs.
3915 *
3916 * Calls to this function for a single hardware must be synchronized
3917 * against each other. Calls to this function, ieee80211_tx_status_ni()
3918 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
3919 *
3920 * @hw: the hardware the frame was transmitted by
3921 * @sta: the receiver station to which this packet is sent
3922 * (NULL for multicast packets)
3923 * @info: tx status information
3924 */
3925void ieee80211_tx_status_noskb(struct ieee80211_hw *hw,
3926 struct ieee80211_sta *sta,
3927 struct ieee80211_tx_info *info);
3928
20ed3166
JS
3929/**
3930 * ieee80211_tx_status_ni - transmit status callback (in process context)
3931 *
3932 * Like ieee80211_tx_status() but can be called in process context.
3933 *
3934 * Calls to this function, ieee80211_tx_status() and
3935 * ieee80211_tx_status_irqsafe() may not be mixed
3936 * for a single hardware.
3937 *
3938 * @hw: the hardware the frame was transmitted by
3939 * @skb: the frame that was transmitted, owned by mac80211 after this call
3940 */
3941static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
3942 struct sk_buff *skb)
3943{
3944 local_bh_disable();
3945 ieee80211_tx_status(hw, skb);
3946 local_bh_enable();
3947}
3948
2485f710 3949/**
6ef307bc 3950 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
2485f710
JB
3951 *
3952 * Like ieee80211_tx_status() but can be called in IRQ context
3953 * (internally defers to a tasklet.)
3954 *
20ed3166
JS
3955 * Calls to this function, ieee80211_tx_status() and
3956 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
2485f710
JB
3957 *
3958 * @hw: the hardware the frame was transmitted by
3959 * @skb: the frame that was transmitted, owned by mac80211 after this call
2485f710 3960 */
f0706e82 3961void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
e039fa4a 3962 struct sk_buff *skb);
f0706e82 3963
8178d38b
AN
3964/**
3965 * ieee80211_report_low_ack - report non-responding station
3966 *
3967 * When operating in AP-mode, call this function to report a non-responding
3968 * connected STA.
3969 *
3970 * @sta: the non-responding connected sta
3971 * @num_packets: number of packets sent to @sta without a response
3972 */
3973void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
3974
1af586c9
AO
3975#define IEEE80211_MAX_CSA_COUNTERS_NUM 2
3976
6ec8c332
AO
3977/**
3978 * struct ieee80211_mutable_offsets - mutable beacon offsets
3979 * @tim_offset: position of TIM element
3980 * @tim_length: size of TIM element
8d77ec85
LC
3981 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets
3982 * to CSA counters. This array can contain zero values which
3983 * should be ignored.
6ec8c332
AO
3984 */
3985struct ieee80211_mutable_offsets {
3986 u16 tim_offset;
3987 u16 tim_length;
1af586c9
AO
3988
3989 u16 csa_counter_offs[IEEE80211_MAX_CSA_COUNTERS_NUM];
6ec8c332
AO
3990};
3991
3992/**
3993 * ieee80211_beacon_get_template - beacon template generation function
3994 * @hw: pointer obtained from ieee80211_alloc_hw().
3995 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3996 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
3997 * receive the offsets that may be updated by the driver.
3998 *
3999 * If the driver implements beaconing modes, it must use this function to
4000 * obtain the beacon template.
4001 *
4002 * This function should be used if the beacon frames are generated by the
4003 * device, and then the driver must use the returned beacon as the template
1af586c9
AO
4004 * The driver or the device are responsible to update the DTIM and, when
4005 * applicable, the CSA count.
6ec8c332
AO
4006 *
4007 * The driver is responsible for freeing the returned skb.
4008 *
4009 * Return: The beacon template. %NULL on error.
4010 */
4011struct sk_buff *
4012ieee80211_beacon_get_template(struct ieee80211_hw *hw,
4013 struct ieee80211_vif *vif,
4014 struct ieee80211_mutable_offsets *offs);
4015
f0706e82 4016/**
eddcbb94 4017 * ieee80211_beacon_get_tim - beacon generation function
f0706e82 4018 * @hw: pointer obtained from ieee80211_alloc_hw().
1ed32e4f 4019 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
eddcbb94
JB
4020 * @tim_offset: pointer to variable that will receive the TIM IE offset.
4021 * Set to 0 if invalid (in non-AP modes).
4022 * @tim_length: pointer to variable that will receive the TIM IE length,
4023 * (including the ID and length bytes!).
4024 * Set to 0 if invalid (in non-AP modes).
4025 *
4026 * If the driver implements beaconing modes, it must use this function to
6ec8c332 4027 * obtain the beacon frame.
f0706e82
JB
4028 *
4029 * If the beacon frames are generated by the host system (i.e., not in
eddcbb94 4030 * hardware/firmware), the driver uses this function to get each beacon
6ec8c332
AO
4031 * frame from mac80211 -- it is responsible for calling this function exactly
4032 * once before the beacon is needed (e.g. based on hardware interrupt).
eddcbb94
JB
4033 *
4034 * The driver is responsible for freeing the returned skb.
0ae997dc
YB
4035 *
4036 * Return: The beacon template. %NULL on error.
eddcbb94
JB
4037 */
4038struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
4039 struct ieee80211_vif *vif,
4040 u16 *tim_offset, u16 *tim_length);
4041
4042/**
4043 * ieee80211_beacon_get - beacon generation function
4044 * @hw: pointer obtained from ieee80211_alloc_hw().
1ed32e4f 4045 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
eddcbb94
JB
4046 *
4047 * See ieee80211_beacon_get_tim().
0ae997dc
YB
4048 *
4049 * Return: See ieee80211_beacon_get_tim().
f0706e82 4050 */
eddcbb94
JB
4051static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
4052 struct ieee80211_vif *vif)
4053{
4054 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
4055}
f0706e82 4056
1af586c9
AO
4057/**
4058 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter
4059 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4060 *
4061 * The csa counter should be updated after each beacon transmission.
4062 * This function is called implicitly when
4063 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
4064 * beacon frames are generated by the device, the driver should call this
4065 * function after each beacon transmission to sync mac80211's csa counters.
4066 *
4067 * Return: new csa counter value
4068 */
4069u8 ieee80211_csa_update_counter(struct ieee80211_vif *vif);
4070
73da7d5b
SW
4071/**
4072 * ieee80211_csa_finish - notify mac80211 about channel switch
4073 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4074 *
4075 * After a channel switch announcement was scheduled and the counter in this
66e01cf9 4076 * announcement hits 1, this function must be called by the driver to
73da7d5b
SW
4077 * notify mac80211 that the channel can be changed.
4078 */
4079void ieee80211_csa_finish(struct ieee80211_vif *vif);
4080
4081/**
66e01cf9 4082 * ieee80211_csa_is_complete - find out if counters reached 1
73da7d5b
SW
4083 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4084 *
4085 * This function returns whether the channel switch counters reached zero.
4086 */
4087bool ieee80211_csa_is_complete(struct ieee80211_vif *vif);
4088
4089
02945821
AN
4090/**
4091 * ieee80211_proberesp_get - retrieve a Probe Response template
4092 * @hw: pointer obtained from ieee80211_alloc_hw().
4093 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4094 *
4095 * Creates a Probe Response template which can, for example, be uploaded to
4096 * hardware. The destination address should be set by the caller.
4097 *
4098 * Can only be called in AP mode.
0ae997dc
YB
4099 *
4100 * Return: The Probe Response template. %NULL on error.
02945821
AN
4101 */
4102struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
4103 struct ieee80211_vif *vif);
4104
7044cc56
KV
4105/**
4106 * ieee80211_pspoll_get - retrieve a PS Poll template
4107 * @hw: pointer obtained from ieee80211_alloc_hw().
4108 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4109 *
4110 * Creates a PS Poll a template which can, for example, uploaded to
4111 * hardware. The template must be updated after association so that correct
4112 * AID, BSSID and MAC address is used.
4113 *
4114 * Note: Caller (or hardware) is responsible for setting the
4115 * &IEEE80211_FCTL_PM bit.
0ae997dc
YB
4116 *
4117 * Return: The PS Poll template. %NULL on error.
7044cc56
KV
4118 */
4119struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
4120 struct ieee80211_vif *vif);
4121
4122/**
4123 * ieee80211_nullfunc_get - retrieve a nullfunc template
4124 * @hw: pointer obtained from ieee80211_alloc_hw().
4125 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4126 *
4127 * Creates a Nullfunc template which can, for example, uploaded to
4128 * hardware. The template must be updated after association so that correct
4129 * BSSID and address is used.
4130 *
4131 * Note: Caller (or hardware) is responsible for setting the
4132 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
0ae997dc
YB
4133 *
4134 * Return: The nullfunc template. %NULL on error.
7044cc56
KV
4135 */
4136struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
4137 struct ieee80211_vif *vif);
4138
05e54ea6
KV
4139/**
4140 * ieee80211_probereq_get - retrieve a Probe Request template
4141 * @hw: pointer obtained from ieee80211_alloc_hw().
a344d677 4142 * @src_addr: source MAC address
05e54ea6
KV
4143 * @ssid: SSID buffer
4144 * @ssid_len: length of SSID
b9a9ada1 4145 * @tailroom: tailroom to reserve at end of SKB for IEs
05e54ea6
KV
4146 *
4147 * Creates a Probe Request template which can, for example, be uploaded to
4148 * hardware.
0ae997dc
YB
4149 *
4150 * Return: The Probe Request template. %NULL on error.
05e54ea6
KV
4151 */
4152struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
a344d677 4153 const u8 *src_addr,
05e54ea6 4154 const u8 *ssid, size_t ssid_len,
b9a9ada1 4155 size_t tailroom);
05e54ea6 4156
f0706e82
JB
4157/**
4158 * ieee80211_rts_get - RTS frame generation function
4159 * @hw: pointer obtained from ieee80211_alloc_hw().
1ed32e4f 4160 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
f0706e82
JB
4161 * @frame: pointer to the frame that is going to be protected by the RTS.
4162 * @frame_len: the frame length (in octets).
e039fa4a 4163 * @frame_txctl: &struct ieee80211_tx_info of the frame.
f0706e82
JB
4164 * @rts: The buffer where to store the RTS frame.
4165 *
4166 * If the RTS frames are generated by the host system (i.e., not in
4167 * hardware/firmware), the low-level driver uses this function to receive
4168 * the next RTS frame from the 802.11 code. The low-level is responsible
4169 * for calling this function before and RTS frame is needed.
4170 */
32bfd35d 4171void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
f0706e82 4172 const void *frame, size_t frame_len,
e039fa4a 4173 const struct ieee80211_tx_info *frame_txctl,
f0706e82
JB
4174 struct ieee80211_rts *rts);
4175
4176/**
4177 * ieee80211_rts_duration - Get the duration field for an RTS frame
4178 * @hw: pointer obtained from ieee80211_alloc_hw().
1ed32e4f 4179 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
f0706e82 4180 * @frame_len: the length of the frame that is going to be protected by the RTS.
e039fa4a 4181 * @frame_txctl: &struct ieee80211_tx_info of the frame.
f0706e82
JB
4182 *
4183 * If the RTS is generated in firmware, but the host system must provide
4184 * the duration field, the low-level driver uses this function to receive
4185 * the duration field value in little-endian byteorder.
0ae997dc
YB
4186 *
4187 * Return: The duration.
f0706e82 4188 */
32bfd35d
JB
4189__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
4190 struct ieee80211_vif *vif, size_t frame_len,
e039fa4a 4191 const struct ieee80211_tx_info *frame_txctl);
f0706e82
JB
4192
4193/**
4194 * ieee80211_ctstoself_get - CTS-to-self frame generation function
4195 * @hw: pointer obtained from ieee80211_alloc_hw().
1ed32e4f 4196 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
f0706e82
JB
4197 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
4198 * @frame_len: the frame length (in octets).
e039fa4a 4199 * @frame_txctl: &struct ieee80211_tx_info of the frame.
f0706e82
JB
4200 * @cts: The buffer where to store the CTS-to-self frame.
4201 *
4202 * If the CTS-to-self frames are generated by the host system (i.e., not in
4203 * hardware/firmware), the low-level driver uses this function to receive
4204 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
4205 * for calling this function before and CTS-to-self frame is needed.
4206 */
32bfd35d
JB
4207void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
4208 struct ieee80211_vif *vif,
f0706e82 4209 const void *frame, size_t frame_len,
e039fa4a 4210 const struct ieee80211_tx_info *frame_txctl,
f0706e82
JB
4211 struct ieee80211_cts *cts);
4212
4213/**
4214 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
4215 * @hw: pointer obtained from ieee80211_alloc_hw().
1ed32e4f 4216 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
f0706e82 4217 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
e039fa4a 4218 * @frame_txctl: &struct ieee80211_tx_info of the frame.
f0706e82
JB
4219 *
4220 * If the CTS-to-self is generated in firmware, but the host system must provide
4221 * the duration field, the low-level driver uses this function to receive
4222 * the duration field value in little-endian byteorder.
0ae997dc
YB
4223 *
4224 * Return: The duration.
f0706e82 4225 */
32bfd35d
JB
4226__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
4227 struct ieee80211_vif *vif,
f0706e82 4228 size_t frame_len,
e039fa4a 4229 const struct ieee80211_tx_info *frame_txctl);
f0706e82
JB
4230
4231/**
4232 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
4233 * @hw: pointer obtained from ieee80211_alloc_hw().
1ed32e4f 4234 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
d13e1414 4235 * @band: the band to calculate the frame duration on
f0706e82 4236 * @frame_len: the length of the frame.
8318d78a 4237 * @rate: the rate at which the frame is going to be transmitted.
f0706e82
JB
4238 *
4239 * Calculate the duration field of some generic frame, given its
4240 * length and transmission rate (in 100kbps).
0ae997dc
YB
4241 *
4242 * Return: The duration.
f0706e82 4243 */
32bfd35d
JB
4244__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
4245 struct ieee80211_vif *vif,
4ee73f33 4246 enum ieee80211_band band,
f0706e82 4247 size_t frame_len,
8318d78a 4248 struct ieee80211_rate *rate);
f0706e82
JB
4249
4250/**
4251 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
4252 * @hw: pointer as obtained from ieee80211_alloc_hw().
1ed32e4f 4253 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
f0706e82
JB
4254 *
4255 * Function for accessing buffered broadcast and multicast frames. If
4256 * hardware/firmware does not implement buffering of broadcast/multicast
4257 * frames when power saving is used, 802.11 code buffers them in the host
4258 * memory. The low-level driver uses this function to fetch next buffered
0ae997dc
YB
4259 * frame. In most cases, this is used when generating beacon frame.
4260 *
4261 * Return: A pointer to the next buffered skb or NULL if no more buffered
4262 * frames are available.
f0706e82
JB
4263 *
4264 * Note: buffered frames are returned only after DTIM beacon frame was
4265 * generated with ieee80211_beacon_get() and the low-level driver must thus
4266 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
4267 * NULL if the previous generated beacon was not DTIM, so the low-level driver
4268 * does not need to check for DTIM beacons separately and should be able to
4269 * use common code for all beacons.
4270 */
4271struct sk_buff *
e039fa4a 4272ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
f0706e82 4273
42d98795
JB
4274/**
4275 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
4276 *
4277 * This function returns the TKIP phase 1 key for the given IV32.
4278 *
4279 * @keyconf: the parameter passed with the set key
4280 * @iv32: IV32 to get the P1K for
4281 * @p1k: a buffer to which the key will be written, as 5 u16 values
4282 */
4283void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
4284 u32 iv32, u16 *p1k);
4285
5d2cdcd4 4286/**
523b02ea
JB
4287 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
4288 *
4289 * This function returns the TKIP phase 1 key for the IV32 taken
4290 * from the given packet.
4291 *
4292 * @keyconf: the parameter passed with the set key
4293 * @skb: the packet to take the IV32 value from that will be encrypted
4294 * with this P1K
4295 * @p1k: a buffer to which the key will be written, as 5 u16 values
4296 */
42d98795
JB
4297static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
4298 struct sk_buff *skb, u16 *p1k)
4299{
4300 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
4301 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
4302 u32 iv32 = get_unaligned_le32(&data[4]);
4303
4304 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
4305}
523b02ea 4306
8bca5d81
JB
4307/**
4308 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
4309 *
4310 * This function returns the TKIP phase 1 key for the given IV32
4311 * and transmitter address.
4312 *
4313 * @keyconf: the parameter passed with the set key
4314 * @ta: TA that will be used with the key
4315 * @iv32: IV32 to get the P1K for
4316 * @p1k: a buffer to which the key will be written, as 5 u16 values
4317 */
4318void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
4319 const u8 *ta, u32 iv32, u16 *p1k);
4320
523b02ea
JB
4321/**
4322 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
5d2cdcd4 4323 *
523b02ea
JB
4324 * This function computes the TKIP RC4 key for the IV values
4325 * in the packet.
5d2cdcd4
EG
4326 *
4327 * @keyconf: the parameter passed with the set key
523b02ea
JB
4328 * @skb: the packet to take the IV32/IV16 values from that will be
4329 * encrypted with this key
4330 * @p2k: a buffer to which the key will be written, 16 bytes
5d2cdcd4 4331 */
523b02ea
JB
4332void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
4333 struct sk_buff *skb, u8 *p2k);
c68f4b89 4334
3ea542d3
JB
4335/**
4336 * ieee80211_get_key_tx_seq - get key TX sequence counter
4337 *
4338 * @keyconf: the parameter passed with the set key
4339 * @seq: buffer to receive the sequence data
4340 *
4341 * This function allows a driver to retrieve the current TX IV/PN
4342 * for the given key. It must not be called if IV generation is
4343 * offloaded to the device.
4344 *
4345 * Note that this function may only be called when no TX processing
4346 * can be done concurrently, for example when queues are stopped
4347 * and the stop has been synchronized.
4348 */
4349void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
4350 struct ieee80211_key_seq *seq);
4351
4352/**
4353 * ieee80211_get_key_rx_seq - get key RX sequence counter
4354 *
4355 * @keyconf: the parameter passed with the set key
00b9cfa3 4356 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
3ea542d3
JB
4357 * the value on TID 0 is also used for non-QoS frames. For
4358 * CMAC, only TID 0 is valid.
4359 * @seq: buffer to receive the sequence data
4360 *
4361 * This function allows a driver to retrieve the current RX IV/PNs
4362 * for the given key. It must not be called if IV checking is done
4363 * by the device and not by mac80211.
4364 *
4365 * Note that this function may only be called when no RX processing
4366 * can be done concurrently.
4367 */
4368void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
4369 int tid, struct ieee80211_key_seq *seq);
4370
27b3eb9c
JB
4371/**
4372 * ieee80211_set_key_tx_seq - set key TX sequence counter
4373 *
4374 * @keyconf: the parameter passed with the set key
4375 * @seq: new sequence data
4376 *
4377 * This function allows a driver to set the current TX IV/PNs for the
4378 * given key. This is useful when resuming from WoWLAN sleep and the
4379 * device may have transmitted frames using the PTK, e.g. replies to
4380 * ARP requests.
4381 *
4382 * Note that this function may only be called when no TX processing
4383 * can be done concurrently.
4384 */
4385void ieee80211_set_key_tx_seq(struct ieee80211_key_conf *keyconf,
4386 struct ieee80211_key_seq *seq);
4387
4388/**
4389 * ieee80211_set_key_rx_seq - set key RX sequence counter
4390 *
4391 * @keyconf: the parameter passed with the set key
00b9cfa3 4392 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
27b3eb9c
JB
4393 * the value on TID 0 is also used for non-QoS frames. For
4394 * CMAC, only TID 0 is valid.
4395 * @seq: new sequence data
4396 *
4397 * This function allows a driver to set the current RX IV/PNs for the
4398 * given key. This is useful when resuming from WoWLAN sleep and GTK
4399 * rekey may have been done while suspended. It should not be called
4400 * if IV checking is done by the device and not by mac80211.
4401 *
4402 * Note that this function may only be called when no RX processing
4403 * can be done concurrently.
4404 */
4405void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
4406 int tid, struct ieee80211_key_seq *seq);
4407
4408/**
4409 * ieee80211_remove_key - remove the given key
4410 * @keyconf: the parameter passed with the set key
4411 *
4412 * Remove the given key. If the key was uploaded to the hardware at the
4413 * time this function is called, it is not deleted in the hardware but
4414 * instead assumed to have been removed already.
4415 *
4416 * Note that due to locking considerations this function can (currently)
4417 * only be called during key iteration (ieee80211_iter_keys().)
4418 */
4419void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
4420
4421/**
4422 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
4423 * @vif: the virtual interface to add the key on
4424 * @keyconf: new key data
4425 *
4426 * When GTK rekeying was done while the system was suspended, (a) new
4427 * key(s) will be available. These will be needed by mac80211 for proper
4428 * RX processing, so this function allows setting them.
4429 *
4430 * The function returns the newly allocated key structure, which will
4431 * have similar contents to the passed key configuration but point to
4432 * mac80211-owned memory. In case of errors, the function returns an
4433 * ERR_PTR(), use IS_ERR() etc.
4434 *
4435 * Note that this function assumes the key isn't added to hardware
4436 * acceleration, so no TX will be done with the key. Since it's a GTK
4437 * on managed (station) networks, this is true anyway. If the driver
4438 * calls this function from the resume callback and subsequently uses
4439 * the return code 1 to reconfigure the device, this key will be part
4440 * of the reconfiguration.
4441 *
4442 * Note that the driver should also call ieee80211_set_key_rx_seq()
4443 * for the new key for each TID to set up sequence counters properly.
4444 *
4445 * IMPORTANT: If this replaces a key that is present in the hardware,
4446 * then it will attempt to remove it during this call. In many cases
4447 * this isn't what you want, so call ieee80211_remove_key() first for
4448 * the key that's being replaced.
4449 */
4450struct ieee80211_key_conf *
4451ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
4452 struct ieee80211_key_conf *keyconf);
4453
c68f4b89
JB
4454/**
4455 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
4456 * @vif: virtual interface the rekeying was done on
4457 * @bssid: The BSSID of the AP, for checking association
4458 * @replay_ctr: the new replay counter after GTK rekeying
4459 * @gfp: allocation flags
4460 */
4461void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
4462 const u8 *replay_ctr, gfp_t gfp);
4463
f0706e82
JB
4464/**
4465 * ieee80211_wake_queue - wake specific queue
4466 * @hw: pointer as obtained from ieee80211_alloc_hw().
4467 * @queue: queue number (counted from zero).
4468 *
4469 * Drivers should use this function instead of netif_wake_queue.
4470 */
4471void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
4472
4473/**
4474 * ieee80211_stop_queue - stop specific queue
4475 * @hw: pointer as obtained from ieee80211_alloc_hw().
4476 * @queue: queue number (counted from zero).
4477 *
4478 * Drivers should use this function instead of netif_stop_queue.
4479 */
4480void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
4481
92ab8535
TW
4482/**
4483 * ieee80211_queue_stopped - test status of the queue
4484 * @hw: pointer as obtained from ieee80211_alloc_hw().
4485 * @queue: queue number (counted from zero).
4486 *
4487 * Drivers should use this function instead of netif_stop_queue.
0ae997dc
YB
4488 *
4489 * Return: %true if the queue is stopped. %false otherwise.
92ab8535
TW
4490 */
4491
4492int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
4493
f0706e82
JB
4494/**
4495 * ieee80211_stop_queues - stop all queues
4496 * @hw: pointer as obtained from ieee80211_alloc_hw().
4497 *
4498 * Drivers should use this function instead of netif_stop_queue.
4499 */
4500void ieee80211_stop_queues(struct ieee80211_hw *hw);
4501
4502/**
4503 * ieee80211_wake_queues - wake all queues
4504 * @hw: pointer as obtained from ieee80211_alloc_hw().
4505 *
4506 * Drivers should use this function instead of netif_wake_queue.
4507 */
4508void ieee80211_wake_queues(struct ieee80211_hw *hw);
4509
75a5f0cc
JB
4510/**
4511 * ieee80211_scan_completed - completed hardware scan
4512 *
4513 * When hardware scan offload is used (i.e. the hw_scan() callback is
4514 * assigned) this function needs to be called by the driver to notify
8789d459
JB
4515 * mac80211 that the scan finished. This function can be called from
4516 * any context, including hardirq context.
75a5f0cc
JB
4517 *
4518 * @hw: the hardware that finished the scan
2a519311 4519 * @aborted: set to true if scan was aborted
75a5f0cc 4520 */
2a519311 4521void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
f0706e82 4522
79f460ca
LC
4523/**
4524 * ieee80211_sched_scan_results - got results from scheduled scan
4525 *
4526 * When a scheduled scan is running, this function needs to be called by the
4527 * driver whenever there are new scan results available.
4528 *
4529 * @hw: the hardware that is performing scheduled scans
4530 */
4531void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
4532
4533/**
4534 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
4535 *
4536 * When a scheduled scan is running, this function can be called by
4537 * the driver if it needs to stop the scan to perform another task.
4538 * Usual scenarios are drivers that cannot continue the scheduled scan
4539 * while associating, for instance.
4540 *
4541 * @hw: the hardware that is performing scheduled scans
4542 */
4543void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
4544
8b2c9824
JB
4545/**
4546 * enum ieee80211_interface_iteration_flags - interface iteration flags
4547 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
4548 * been added to the driver; However, note that during hardware
4549 * reconfiguration (after restart_hw) it will iterate over a new
4550 * interface and over all the existing interfaces even if they
4551 * haven't been re-added to the driver yet.
4552 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
4553 * interfaces, even if they haven't been re-added to the driver yet.
3384d757 4554 * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up).
8b2c9824
JB
4555 */
4556enum ieee80211_interface_iteration_flags {
4557 IEEE80211_IFACE_ITER_NORMAL = 0,
4558 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
3384d757 4559 IEEE80211_IFACE_ITER_ACTIVE = BIT(1),
8b2c9824
JB
4560};
4561
3384d757
AN
4562/**
4563 * ieee80211_iterate_interfaces - iterate interfaces
4564 *
4565 * This function iterates over the interfaces associated with a given
4566 * hardware and calls the callback for them. This includes active as well as
4567 * inactive interfaces. This function allows the iterator function to sleep.
4568 * Will iterate over a new interface during add_interface().
4569 *
4570 * @hw: the hardware struct of which the interfaces should be iterated over
4571 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4572 * @iterator: the iterator function to call
4573 * @data: first argument of the iterator function
4574 */
4575void ieee80211_iterate_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4576 void (*iterator)(void *data, u8 *mac,
4577 struct ieee80211_vif *vif),
4578 void *data);
4579
dabeb344 4580/**
6ef307bc 4581 * ieee80211_iterate_active_interfaces - iterate active interfaces
dabeb344
JB
4582 *
4583 * This function iterates over the interfaces associated with a given
4584 * hardware that are currently active and calls the callback for them.
2f561feb
ID
4585 * This function allows the iterator function to sleep, when the iterator
4586 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
4587 * be used.
8b2c9824 4588 * Does not iterate over a new interface during add_interface().
dabeb344
JB
4589 *
4590 * @hw: the hardware struct of which the interfaces should be iterated over
8b2c9824 4591 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
2f561feb 4592 * @iterator: the iterator function to call
dabeb344
JB
4593 * @data: first argument of the iterator function
4594 */
3384d757
AN
4595static inline void
4596ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4597 void (*iterator)(void *data, u8 *mac,
4598 struct ieee80211_vif *vif),
4599 void *data)
4600{
4601 ieee80211_iterate_interfaces(hw,
4602 iter_flags | IEEE80211_IFACE_ITER_ACTIVE,
4603 iterator, data);
4604}
dabeb344 4605
2f561feb
ID
4606/**
4607 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
4608 *
4609 * This function iterates over the interfaces associated with a given
4610 * hardware that are currently active and calls the callback for them.
4611 * This function requires the iterator callback function to be atomic,
4612 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
8b2c9824 4613 * Does not iterate over a new interface during add_interface().
2f561feb
ID
4614 *
4615 * @hw: the hardware struct of which the interfaces should be iterated over
8b2c9824 4616 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
2f561feb
ID
4617 * @iterator: the iterator function to call, cannot sleep
4618 * @data: first argument of the iterator function
4619 */
4620void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
8b2c9824 4621 u32 iter_flags,
2f561feb
ID
4622 void (*iterator)(void *data,
4623 u8 *mac,
4624 struct ieee80211_vif *vif),
4625 void *data);
4626
c7c71066
JB
4627/**
4628 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
4629 *
4630 * This function iterates over the interfaces associated with a given
4631 * hardware that are currently active and calls the callback for them.
4632 * This version can only be used while holding the RTNL.
4633 *
4634 * @hw: the hardware struct of which the interfaces should be iterated over
4635 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4636 * @iterator: the iterator function to call, cannot sleep
4637 * @data: first argument of the iterator function
4638 */
4639void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw,
4640 u32 iter_flags,
4641 void (*iterator)(void *data,
4642 u8 *mac,
4643 struct ieee80211_vif *vif),
4644 void *data);
4645
0fc1e049
AN
4646/**
4647 * ieee80211_iterate_stations_atomic - iterate stations
4648 *
4649 * This function iterates over all stations associated with a given
4650 * hardware that are currently uploaded to the driver and calls the callback
4651 * function for them.
4652 * This function requires the iterator callback function to be atomic,
4653 *
4654 * @hw: the hardware struct of which the interfaces should be iterated over
4655 * @iterator: the iterator function to call, cannot sleep
4656 * @data: first argument of the iterator function
4657 */
4658void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw,
4659 void (*iterator)(void *data,
4660 struct ieee80211_sta *sta),
4661 void *data);
42935eca
LR
4662/**
4663 * ieee80211_queue_work - add work onto the mac80211 workqueue
4664 *
4665 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
4666 * This helper ensures drivers are not queueing work when they should not be.
4667 *
4668 * @hw: the hardware struct for the interface we are adding work for
4669 * @work: the work we want to add onto the mac80211 workqueue
4670 */
4671void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
4672
4673/**
4674 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
4675 *
4676 * Drivers and mac80211 use this to queue delayed work onto the mac80211
4677 * workqueue.
4678 *
4679 * @hw: the hardware struct for the interface we are adding work for
4680 * @dwork: delayable work to queue onto the mac80211 workqueue
4681 * @delay: number of jiffies to wait before queueing
4682 */
4683void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
4684 struct delayed_work *dwork,
4685 unsigned long delay);
4686
0df3ef45
RR
4687/**
4688 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
c951ad35 4689 * @sta: the station for which to start a BA session
0df3ef45 4690 * @tid: the TID to BA on.
bd2ce6e4 4691 * @timeout: session timeout value (in TUs)
ea2d8b59
RD
4692 *
4693 * Return: success if addBA request was sent, failure otherwise
0df3ef45
RR
4694 *
4695 * Although mac80211/low level driver/user space application can estimate
4696 * the need to start aggregation on a certain RA/TID, the session level
4697 * will be managed by the mac80211.
4698 */
bd2ce6e4
SM
4699int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
4700 u16 timeout);
0df3ef45 4701
0df3ef45
RR
4702/**
4703 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1ed32e4f 4704 * @vif: &struct ieee80211_vif pointer from the add_interface callback
0df3ef45
RR
4705 * @ra: receiver address of the BA session recipient.
4706 * @tid: the TID to BA on.
4707 *
4708 * This function must be called by low level driver once it has
5d22c89b
JB
4709 * finished with preparations for the BA session. It can be called
4710 * from any context.
0df3ef45 4711 */
c951ad35 4712void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
0df3ef45
RR
4713 u16 tid);
4714
4715/**
4716 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
c951ad35 4717 * @sta: the station whose BA session to stop
0df3ef45 4718 * @tid: the TID to stop BA.
ea2d8b59 4719 *
6a8579d0 4720 * Return: negative error if the TID is invalid, or no aggregation active
0df3ef45
RR
4721 *
4722 * Although mac80211/low level driver/user space application can estimate
4723 * the need to stop aggregation on a certain RA/TID, the session level
4724 * will be managed by the mac80211.
4725 */
6a8579d0 4726int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
0df3ef45 4727
0df3ef45
RR
4728/**
4729 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1ed32e4f 4730 * @vif: &struct ieee80211_vif pointer from the add_interface callback
0df3ef45
RR
4731 * @ra: receiver address of the BA session recipient.
4732 * @tid: the desired TID to BA on.
4733 *
4734 * This function must be called by low level driver once it has
5d22c89b
JB
4735 * finished with preparations for the BA session tear down. It
4736 * can be called from any context.
0df3ef45 4737 */
c951ad35 4738void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
0df3ef45
RR
4739 u16 tid);
4740
17741cdc
JB
4741/**
4742 * ieee80211_find_sta - find a station
4743 *
5ed176e1 4744 * @vif: virtual interface to look for station on
17741cdc
JB
4745 * @addr: station's address
4746 *
0ae997dc
YB
4747 * Return: The station, if found. %NULL otherwise.
4748 *
4749 * Note: This function must be called under RCU lock and the
17741cdc
JB
4750 * resulting pointer is only valid under RCU lock as well.
4751 */
5ed176e1 4752struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
17741cdc
JB
4753 const u8 *addr);
4754
5ed176e1 4755/**
686b9cb9 4756 * ieee80211_find_sta_by_ifaddr - find a station on hardware
5ed176e1
JB
4757 *
4758 * @hw: pointer as obtained from ieee80211_alloc_hw()
686b9cb9
BG
4759 * @addr: remote station's address
4760 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
5ed176e1 4761 *
0ae997dc
YB
4762 * Return: The station, if found. %NULL otherwise.
4763 *
4764 * Note: This function must be called under RCU lock and the
5ed176e1
JB
4765 * resulting pointer is only valid under RCU lock as well.
4766 *
686b9cb9
BG
4767 * NOTE: You may pass NULL for localaddr, but then you will just get
4768 * the first STA that matches the remote address 'addr'.
4769 * We can have multiple STA associated with multiple
4770 * logical stations (e.g. consider a station connecting to another
4771 * BSSID on the same AP hardware without disconnecting first).
4772 * In this case, the result of this method with localaddr NULL
4773 * is not reliable.
5ed176e1 4774 *
686b9cb9 4775 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
5ed176e1 4776 */
686b9cb9
BG
4777struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
4778 const u8 *addr,
4779 const u8 *localaddr);
5ed176e1 4780
af818581
JB
4781/**
4782 * ieee80211_sta_block_awake - block station from waking up
4783 * @hw: the hardware
4784 * @pubsta: the station
4785 * @block: whether to block or unblock
4786 *
4787 * Some devices require that all frames that are on the queues
4788 * for a specific station that went to sleep are flushed before
4789 * a poll response or frames after the station woke up can be
4790 * delivered to that it. Note that such frames must be rejected
4791 * by the driver as filtered, with the appropriate status flag.
4792 *
4793 * This function allows implementing this mode in a race-free
4794 * manner.
4795 *
4796 * To do this, a driver must keep track of the number of frames
4797 * still enqueued for a specific station. If this number is not
4798 * zero when the station goes to sleep, the driver must call
4799 * this function to force mac80211 to consider the station to
4800 * be asleep regardless of the station's actual state. Once the
4801 * number of outstanding frames reaches zero, the driver must
4802 * call this function again to unblock the station. That will
4803 * cause mac80211 to be able to send ps-poll responses, and if
4804 * the station queried in the meantime then frames will also
4805 * be sent out as a result of this. Additionally, the driver
4806 * will be notified that the station woke up some time after
4807 * it is unblocked, regardless of whether the station actually
4808 * woke up while blocked or not.
4809 */
4810void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
4811 struct ieee80211_sta *pubsta, bool block);
4812
37fbd908
JB
4813/**
4814 * ieee80211_sta_eosp - notify mac80211 about end of SP
4815 * @pubsta: the station
4816 *
4817 * When a device transmits frames in a way that it can't tell
4818 * mac80211 in the TX status about the EOSP, it must clear the
4819 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
4820 * This applies for PS-Poll as well as uAPSD.
4821 *
e943789e
JB
4822 * Note that just like with _tx_status() and _rx() drivers must
4823 * not mix calls to irqsafe/non-irqsafe versions, this function
4824 * must not be mixed with those either. Use the all irqsafe, or
4825 * all non-irqsafe, don't mix!
4826 *
4827 * NB: the _irqsafe version of this function doesn't exist, no
4828 * driver needs it right now. Don't call this function if
4829 * you'd need the _irqsafe version, look at the git history
4830 * and restore the _irqsafe version!
37fbd908 4831 */
e943789e 4832void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
37fbd908 4833
830af02f
JB
4834/**
4835 * ieee80211_iter_keys - iterate keys programmed into the device
4836 * @hw: pointer obtained from ieee80211_alloc_hw()
4837 * @vif: virtual interface to iterate, may be %NULL for all
4838 * @iter: iterator function that will be called for each key
4839 * @iter_data: custom data to pass to the iterator function
4840 *
4841 * This function can be used to iterate all the keys known to
4842 * mac80211, even those that weren't previously programmed into
4843 * the device. This is intended for use in WoWLAN if the device
4844 * needs reprogramming of the keys during suspend. Note that due
4845 * to locking reasons, it is also only safe to call this at few
4846 * spots since it must hold the RTNL and be able to sleep.
f850e00f
JB
4847 *
4848 * The order in which the keys are iterated matches the order
4849 * in which they were originally installed and handed to the
4850 * set_key callback.
830af02f
JB
4851 */
4852void ieee80211_iter_keys(struct ieee80211_hw *hw,
4853 struct ieee80211_vif *vif,
4854 void (*iter)(struct ieee80211_hw *hw,
4855 struct ieee80211_vif *vif,
4856 struct ieee80211_sta *sta,
4857 struct ieee80211_key_conf *key,
4858 void *data),
4859 void *iter_data);
4860
3448c005
JB
4861/**
4862 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
4863 * @hw: pointre obtained from ieee80211_alloc_hw().
4864 * @iter: iterator function
4865 * @iter_data: data passed to iterator function
4866 *
4867 * Iterate all active channel contexts. This function is atomic and
4868 * doesn't acquire any locks internally that might be held in other
4869 * places while calling into the driver.
4870 *
4871 * The iterator will not find a context that's being added (during
4872 * the driver callback to add it) but will find it while it's being
4873 * removed.
8a61af65
JB
4874 *
4875 * Note that during hardware restart, all contexts that existed
4876 * before the restart are considered already present so will be
4877 * found while iterating, whether they've been re-added already
4878 * or not.
3448c005
JB
4879 */
4880void ieee80211_iter_chan_contexts_atomic(
4881 struct ieee80211_hw *hw,
4882 void (*iter)(struct ieee80211_hw *hw,
4883 struct ieee80211_chanctx_conf *chanctx_conf,
4884 void *data),
4885 void *iter_data);
4886
a619a4c0
JO
4887/**
4888 * ieee80211_ap_probereq_get - retrieve a Probe Request template
4889 * @hw: pointer obtained from ieee80211_alloc_hw().
4890 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4891 *
4892 * Creates a Probe Request template which can, for example, be uploaded to
4893 * hardware. The template is filled with bssid, ssid and supported rate
4894 * information. This function must only be called from within the
4895 * .bss_info_changed callback function and only in managed mode. The function
4896 * is only useful when the interface is associated, otherwise it will return
0ae997dc
YB
4897 * %NULL.
4898 *
4899 * Return: The Probe Request template. %NULL on error.
a619a4c0
JO
4900 */
4901struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
4902 struct ieee80211_vif *vif);
4903
04de8381
KV
4904/**
4905 * ieee80211_beacon_loss - inform hardware does not receive beacons
4906 *
1ed32e4f 4907 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
04de8381 4908 *
c1288b12 4909 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
1e4dcd01 4910 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
04de8381
KV
4911 * hardware is not receiving beacons with this function.
4912 */
4913void ieee80211_beacon_loss(struct ieee80211_vif *vif);
4b7679a5 4914
1e4dcd01
JO
4915/**
4916 * ieee80211_connection_loss - inform hardware has lost connection to the AP
4917 *
4918 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4919 *
c1288b12 4920 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
1e4dcd01
JO
4921 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
4922 * needs to inform if the connection to the AP has been lost.
682bd38b
JB
4923 * The function may also be called if the connection needs to be terminated
4924 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
1e4dcd01
JO
4925 *
4926 * This function will cause immediate change to disassociated state,
4927 * without connection recovery attempts.
4928 */
4929void ieee80211_connection_loss(struct ieee80211_vif *vif);
4930
95acac61
JB
4931/**
4932 * ieee80211_resume_disconnect - disconnect from AP after resume
4933 *
4934 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4935 *
4936 * Instructs mac80211 to disconnect from the AP after resume.
4937 * Drivers can use this after WoWLAN if they know that the
4938 * connection cannot be kept up, for example because keys were
4939 * used while the device was asleep but the replay counters or
4940 * similar cannot be retrieved from the device during resume.
4941 *
4942 * Note that due to implementation issues, if the driver uses
4943 * the reconfiguration functionality during resume the interface
4944 * will still be added as associated first during resume and then
4945 * disconnect normally later.
4946 *
4947 * This function can only be called from the resume callback and
4948 * the driver must not be holding any of its own locks while it
4949 * calls this function, or at least not any locks it needs in the
4950 * key configuration paths (if it supports HW crypto).
4951 */
4952void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
f90754c1 4953
a97c13c3
JO
4954/**
4955 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
4956 * rssi threshold triggered
4957 *
4958 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4959 * @rssi_event: the RSSI trigger event type
4960 * @gfp: context flags
4961 *
ea086359 4962 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
a97c13c3
JO
4963 * monitoring is configured with an rssi threshold, the driver will inform
4964 * whenever the rssi level reaches the threshold.
4965 */
4966void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
4967 enum nl80211_cqm_rssi_threshold_event rssi_event,
4968 gfp_t gfp);
4969
98f03342
JB
4970/**
4971 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
4972 *
4973 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4974 * @gfp: context flags
4975 */
4976void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp);
4977
164eb02d
SW
4978/**
4979 * ieee80211_radar_detected - inform that a radar was detected
4980 *
4981 * @hw: pointer as obtained from ieee80211_alloc_hw()
4982 */
4983void ieee80211_radar_detected(struct ieee80211_hw *hw);
4984
5ce6e438
JB
4985/**
4986 * ieee80211_chswitch_done - Complete channel switch process
4987 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4988 * @success: make the channel switch successful or not
4989 *
4990 * Complete the channel switch post-process: set the new operational channel
4991 * and wake up the suspended queues.
4992 */
4993void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
4994
d1f5b7a3
JB
4995/**
4996 * ieee80211_request_smps - request SM PS transition
4997 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
633dd1ea 4998 * @smps_mode: new SM PS mode
d1f5b7a3
JB
4999 *
5000 * This allows the driver to request an SM PS transition in managed
5001 * mode. This is useful when the driver has more information than
5002 * the stack about possible interference, for example by bluetooth.
5003 */
5004void ieee80211_request_smps(struct ieee80211_vif *vif,
5005 enum ieee80211_smps_mode smps_mode);
5006
21f83589
JB
5007/**
5008 * ieee80211_ready_on_channel - notification of remain-on-channel start
5009 * @hw: pointer as obtained from ieee80211_alloc_hw()
5010 */
5011void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
5012
5013/**
5014 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
5015 * @hw: pointer as obtained from ieee80211_alloc_hw()
5016 */
5017void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
5018
f41ccd71
SL
5019/**
5020 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
5021 *
5022 * in order not to harm the system performance and user experience, the device
5023 * may request not to allow any rx ba session and tear down existing rx ba
5024 * sessions based on system constraints such as periodic BT activity that needs
5025 * to limit wlan activity (eg.sco or a2dp)."
5026 * in such cases, the intention is to limit the duration of the rx ppdu and
5027 * therefore prevent the peer device to use a-mpdu aggregation.
5028 *
5029 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5030 * @ba_rx_bitmap: Bit map of open rx ba per tid
5031 * @addr: & to bssid mac address
5032 */
5033void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
5034 const u8 *addr);
5035
8c771244
FF
5036/**
5037 * ieee80211_send_bar - send a BlockAckReq frame
5038 *
5039 * can be used to flush pending frames from the peer's aggregation reorder
5040 * buffer.
5041 *
5042 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5043 * @ra: the peer's destination address
5044 * @tid: the TID of the aggregation session
5045 * @ssn: the new starting sequence number for the receiver
5046 */
5047void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
5048
08cf42e8
MK
5049/**
5050 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
5051 *
5052 * Some device drivers may offload part of the Rx aggregation flow including
5053 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5054 * reordering.
5055 *
5056 * Create structures responsible for reordering so device drivers may call here
5057 * when they complete AddBa negotiation.
5058 *
5059 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5060 * @addr: station mac address
5061 * @tid: the rx tid
5062 */
5063void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
5064 const u8 *addr, u16 tid);
5065
5066/**
5067 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
5068 *
5069 * Some device drivers may offload part of the Rx aggregation flow including
5070 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5071 * reordering.
5072 *
5073 * Destroy structures responsible for reordering so device drivers may call here
5074 * when they complete DelBa negotiation.
5075 *
5076 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5077 * @addr: station mac address
5078 * @tid: the rx tid
5079 */
5080void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
5081 const u8 *addr, u16 tid);
5082
4b7679a5 5083/* Rate control API */
e6a9854b 5084
4b7679a5 5085/**
e6a9854b
JB
5086 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
5087 *
5088 * @hw: The hardware the algorithm is invoked for.
5089 * @sband: The band this frame is being transmitted on.
5090 * @bss_conf: the current BSS configuration
f44d4eb5
SW
5091 * @skb: the skb that will be transmitted, the control information in it needs
5092 * to be filled in
e6a9854b
JB
5093 * @reported_rate: The rate control algorithm can fill this in to indicate
5094 * which rate should be reported to userspace as the current rate and
5095 * used for rate calculations in the mesh network.
5096 * @rts: whether RTS will be used for this frame because it is longer than the
5097 * RTS threshold
5098 * @short_preamble: whether mac80211 will request short-preamble transmission
5099 * if the selected rate supports it
f44d4eb5 5100 * @max_rate_idx: user-requested maximum (legacy) rate
37eb0b16
JM
5101 * (deprecated; this will be removed once drivers get updated to use
5102 * rate_idx_mask)
f44d4eb5 5103 * @rate_idx_mask: user-requested (legacy) rate mask
2ffbe6d3 5104 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
8f0729b1 5105 * @bss: whether this frame is sent out in AP or IBSS mode
e6a9854b
JB
5106 */
5107struct ieee80211_tx_rate_control {
5108 struct ieee80211_hw *hw;
5109 struct ieee80211_supported_band *sband;
5110 struct ieee80211_bss_conf *bss_conf;
5111 struct sk_buff *skb;
5112 struct ieee80211_tx_rate reported_rate;
5113 bool rts, short_preamble;
5114 u8 max_rate_idx;
37eb0b16 5115 u32 rate_idx_mask;
2ffbe6d3 5116 u8 *rate_idx_mcs_mask;
8f0729b1 5117 bool bss;
4b7679a5
JB
5118};
5119
5120struct rate_control_ops {
4b7679a5
JB
5121 const char *name;
5122 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
4b7679a5
JB
5123 void (*free)(void *priv);
5124
5125 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
5126 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
3de805cf 5127 struct cfg80211_chan_def *chandef,
4b7679a5 5128 struct ieee80211_sta *sta, void *priv_sta);
81cb7623 5129 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
3de805cf 5130 struct cfg80211_chan_def *chandef,
64f68e5d
JB
5131 struct ieee80211_sta *sta, void *priv_sta,
5132 u32 changed);
4b7679a5
JB
5133 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
5134 void *priv_sta);
5135
f684565e
FF
5136 void (*tx_status_noskb)(void *priv,
5137 struct ieee80211_supported_band *sband,
5138 struct ieee80211_sta *sta, void *priv_sta,
5139 struct ieee80211_tx_info *info);
4b7679a5
JB
5140 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
5141 struct ieee80211_sta *sta, void *priv_sta,
5142 struct sk_buff *skb);
e6a9854b
JB
5143 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
5144 struct ieee80211_tx_rate_control *txrc);
4b7679a5
JB
5145
5146 void (*add_sta_debugfs)(void *priv, void *priv_sta,
5147 struct dentry *dir);
5148 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
cca674d4
AQ
5149
5150 u32 (*get_expected_throughput)(void *priv_sta);
4b7679a5
JB
5151};
5152
5153static inline int rate_supported(struct ieee80211_sta *sta,
5154 enum ieee80211_band band,
5155 int index)
5156{
5157 return (sta == NULL || sta->supp_rates[band] & BIT(index));
5158}
5159
4c6d4f5c
LR
5160/**
5161 * rate_control_send_low - helper for drivers for management/no-ack frames
5162 *
5163 * Rate control algorithms that agree to use the lowest rate to
5164 * send management frames and NO_ACK data with the respective hw
5165 * retries should use this in the beginning of their mac80211 get_rate
5166 * callback. If true is returned the rate control can simply return.
5167 * If false is returned we guarantee that sta and sta and priv_sta is
5168 * not null.
5169 *
5170 * Rate control algorithms wishing to do more intelligent selection of
5171 * rate for multicast/broadcast frames may choose to not use this.
5172 *
5173 * @sta: &struct ieee80211_sta pointer to the target destination. Note
5174 * that this may be null.
5175 * @priv_sta: private rate control structure. This may be null.
5176 * @txrc: rate control information we sholud populate for mac80211.
5177 */
5178bool rate_control_send_low(struct ieee80211_sta *sta,
5179 void *priv_sta,
5180 struct ieee80211_tx_rate_control *txrc);
5181
5182
4b7679a5
JB
5183static inline s8
5184rate_lowest_index(struct ieee80211_supported_band *sband,
5185 struct ieee80211_sta *sta)
5186{
5187 int i;
5188
5189 for (i = 0; i < sband->n_bitrates; i++)
5190 if (rate_supported(sta, sband->band, i))
5191 return i;
5192
5193 /* warn when we cannot find a rate. */
54d5026e 5194 WARN_ON_ONCE(1);
4b7679a5 5195
54d5026e 5196 /* and return 0 (the lowest index) */
4b7679a5
JB
5197 return 0;
5198}
5199
b770b43e
LR
5200static inline
5201bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
5202 struct ieee80211_sta *sta)
5203{
5204 unsigned int i;
5205
5206 for (i = 0; i < sband->n_bitrates; i++)
5207 if (rate_supported(sta, sband->band, i))
5208 return true;
5209 return false;
5210}
4b7679a5 5211
0d528d85
FF
5212/**
5213 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
5214 *
5215 * When not doing a rate control probe to test rates, rate control should pass
5216 * its rate selection to mac80211. If the driver supports receiving a station
5217 * rate table, it will use it to ensure that frames are always sent based on
5218 * the most recent rate control module decision.
5219 *
5220 * @hw: pointer as obtained from ieee80211_alloc_hw()
5221 * @pubsta: &struct ieee80211_sta pointer to the target destination.
5222 * @rates: new tx rate set to be used for this station.
5223 */
5224int rate_control_set_rates(struct ieee80211_hw *hw,
5225 struct ieee80211_sta *pubsta,
5226 struct ieee80211_sta_rates *rates);
5227
631ad703
JB
5228int ieee80211_rate_control_register(const struct rate_control_ops *ops);
5229void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
4b7679a5 5230
10c806b3
LR
5231static inline bool
5232conf_is_ht20(struct ieee80211_conf *conf)
5233{
675a0b04 5234 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
10c806b3
LR
5235}
5236
5237static inline bool
5238conf_is_ht40_minus(struct ieee80211_conf *conf)
5239{
675a0b04
KB
5240 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5241 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
10c806b3
LR
5242}
5243
5244static inline bool
5245conf_is_ht40_plus(struct ieee80211_conf *conf)
5246{
675a0b04
KB
5247 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5248 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
10c806b3
LR
5249}
5250
5251static inline bool
5252conf_is_ht40(struct ieee80211_conf *conf)
5253{
675a0b04 5254 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
10c806b3
LR
5255}
5256
5257static inline bool
5258conf_is_ht(struct ieee80211_conf *conf)
5259{
041f607d
RL
5260 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
5261 (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
5262 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
10c806b3
LR
5263}
5264
2ca27bcf
JB
5265static inline enum nl80211_iftype
5266ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
5267{
5268 if (p2p) {
5269 switch (type) {
5270 case NL80211_IFTYPE_STATION:
5271 return NL80211_IFTYPE_P2P_CLIENT;
5272 case NL80211_IFTYPE_AP:
5273 return NL80211_IFTYPE_P2P_GO;
5274 default:
5275 break;
5276 }
5277 }
5278 return type;
5279}
5280
5281static inline enum nl80211_iftype
5282ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
5283{
5284 return ieee80211_iftype_p2p(vif->type, vif->p2p);
5285}
5286
615f7b9b
MV
5287void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
5288 int rssi_min_thold,
5289 int rssi_max_thold);
5290
5291void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
768db343 5292
0d8a0a17 5293/**
0ae997dc 5294 * ieee80211_ave_rssi - report the average RSSI for the specified interface
0d8a0a17
WYG
5295 *
5296 * @vif: the specified virtual interface
5297 *
0ae997dc
YB
5298 * Note: This function assumes that the given vif is valid.
5299 *
5300 * Return: The average RSSI value for the requested interface, or 0 if not
5301 * applicable.
0d8a0a17 5302 */
1dae27f8
WYG
5303int ieee80211_ave_rssi(struct ieee80211_vif *vif);
5304
cd8f7cb4
JB
5305/**
5306 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
5307 * @vif: virtual interface
5308 * @wakeup: wakeup reason(s)
5309 * @gfp: allocation flags
5310 *
5311 * See cfg80211_report_wowlan_wakeup().
5312 */
5313void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
5314 struct cfg80211_wowlan_wakeup *wakeup,
5315 gfp_t gfp);
5316
06be6b14
FF
5317/**
5318 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
5319 * @hw: pointer as obtained from ieee80211_alloc_hw()
5320 * @vif: virtual interface
5321 * @skb: frame to be sent from within the driver
5322 * @band: the band to transmit on
5323 * @sta: optional pointer to get the station to send the frame to
5324 *
5325 * Note: must be called under RCU lock
5326 */
5327bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
5328 struct ieee80211_vif *vif, struct sk_buff *skb,
5329 int band, struct ieee80211_sta **sta);
5330
a7022e65
FF
5331/**
5332 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
5333 *
5334 * @next_tsf: TSF timestamp of the next absent state change
5335 * @has_next_tsf: next absent state change event pending
5336 *
5337 * @absent: descriptor bitmask, set if GO is currently absent
5338 *
5339 * private:
5340 *
5341 * @count: count fields from the NoA descriptors
5342 * @desc: adjusted data from the NoA
5343 */
5344struct ieee80211_noa_data {
5345 u32 next_tsf;
5346 bool has_next_tsf;
5347
5348 u8 absent;
5349
5350 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
5351 struct {
5352 u32 start;
5353 u32 duration;
5354 u32 interval;
5355 } desc[IEEE80211_P2P_NOA_DESC_MAX];
5356};
5357
5358/**
5359 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
5360 *
5361 * @attr: P2P NoA IE
5362 * @data: NoA tracking data
5363 * @tsf: current TSF timestamp
5364 *
5365 * Return: number of successfully parsed descriptors
5366 */
5367int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
5368 struct ieee80211_noa_data *data, u32 tsf);
5369
5370/**
5371 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
5372 *
5373 * @data: NoA tracking data
5374 * @tsf: current TSF timestamp
5375 */
5376void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
5377
c887f0d3
AN
5378/**
5379 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
5380 * @vif: virtual interface
5381 * @peer: the peer's destination address
5382 * @oper: the requested TDLS operation
5383 * @reason_code: reason code for the operation, valid for TDLS teardown
5384 * @gfp: allocation flags
5385 *
5386 * See cfg80211_tdls_oper_request().
5387 */
5388void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
5389 enum nl80211_tdls_operation oper,
5390 u16 reason_code, gfp_t gfp);
a7f3a768 5391
b6da911b
LK
5392/**
5393 * ieee80211_reserve_tid - request to reserve a specific TID
5394 *
5395 * There is sometimes a need (such as in TDLS) for blocking the driver from
5396 * using a specific TID so that the FW can use it for certain operations such
5397 * as sending PTI requests. To make sure that the driver doesn't use that TID,
5398 * this function must be called as it flushes out packets on this TID and marks
5399 * it as blocked, so that any transmit for the station on this TID will be
5400 * redirected to the alternative TID in the same AC.
5401 *
5402 * Note that this function blocks and may call back into the driver, so it
5403 * should be called without driver locks held. Also note this function should
5404 * only be called from the driver's @sta_state callback.
5405 *
5406 * @sta: the station to reserve the TID for
5407 * @tid: the TID to reserve
5408 *
5409 * Returns: 0 on success, else on failure
5410 */
5411int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid);
5412
5413/**
5414 * ieee80211_unreserve_tid - request to unreserve a specific TID
5415 *
5416 * Once there is no longer any need for reserving a certain TID, this function
5417 * should be called, and no longer will packets have their TID modified for
5418 * preventing use of this TID in the driver.
5419 *
5420 * Note that this function blocks and acquires a lock, so it should be called
5421 * without driver locks held. Also note this function should only be called
5422 * from the driver's @sta_state callback.
5423 *
5424 * @sta: the station
5425 * @tid: the TID to unreserve
5426 */
5427void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid);
5428
ba8c3d6f
FF
5429/**
5430 * ieee80211_tx_dequeue - dequeue a packet from a software tx queue
5431 *
5432 * @hw: pointer as obtained from ieee80211_alloc_hw()
5433 * @txq: pointer obtained from station or virtual interface
5434 *
5435 * Returns the skb if successful, %NULL if no frame was available.
5436 */
5437struct sk_buff *ieee80211_tx_dequeue(struct ieee80211_hw *hw,
5438 struct ieee80211_txq *txq);
f0706e82 5439#endif /* MAC80211_H */