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