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