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