blob: 382ebb862ea8fab897eccf8bb92470b45bb64aec [file] [log] [blame]
Thomas Gleixnerd2912cb2019-06-04 10:11:33 +02001/* SPDX-License-Identifier: GPL-2.0-only */
Jiri Bencf0706e82007-05-05 11:45:53 -07002/*
Johannes Berg3017b802007-08-28 17:01:53 -04003 * mac80211 <-> driver interface
4 *
Jiri Bencf0706e82007-05-05 11:45:53 -07005 * Copyright 2002-2005, Devicescape Software, Inc.
6 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
Jouni Malinen026331c2010-02-15 12:53:10 +02007 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
Johannes Bergd98ad832014-09-03 15:24:57 +03008 * Copyright 2013-2014 Intel Mobile Communications GmbH
Avraham Sterne38a0172017-04-26 10:58:47 +03009 * Copyright (C) 2015 - 2017 Intel Deutschland GmbH
Avraham Sternea5907d2022-02-02 10:49:47 +020010 * Copyright (C) 2018 - 2022 Intel Corporation
Jiri Bencf0706e82007-05-05 11:45:53 -070011 */
12
13#ifndef MAC80211_H
14#define MAC80211_H
15
Paul Gortmaker187f1882011-11-23 20:12:59 -050016#include <linux/bug.h>
Jiri Bencf0706e82007-05-05 11:45:53 -070017#include <linux/kernel.h>
18#include <linux/if_ether.h>
19#include <linux/skbuff.h>
Jiri Bencf0706e82007-05-05 11:45:53 -070020#include <linux/ieee80211.h>
Jiri Bencf0706e82007-05-05 11:45:53 -070021#include <net/cfg80211.h>
Michal Kazior5caa3282016-05-19 10:37:51 +020022#include <net/codel.h>
Luca Coelho41cbb0f2018-06-09 09:14:44 +030023#include <net/ieee80211_radiotap.h>
Johannes Berg42d987952011-07-07 18:58:01 +020024#include <asm/unaligned.h>
Jiri Bencf0706e82007-05-05 11:45:53 -070025
Johannes Berg75a5f0c2007-09-18 17:29:20 -040026/**
27 * DOC: Introduction
28 *
29 * mac80211 is the Linux stack for 802.11 hardware that implements
30 * only partial functionality in hard- or firmware. This document
31 * defines the interface between mac80211 and low-level hardware
32 * drivers.
33 */
34
35/**
36 * DOC: Calling mac80211 from interrupts
37 *
38 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
Jiri Bencf0706e82007-05-05 11:45:53 -070039 * called in hardware interrupt context. The low-level driver must not call any
40 * other functions in hardware interrupt context. If there is a need for such
41 * call, the low-level driver should first ACK the interrupt and perform the
Johannes Berg2485f712008-02-25 16:27:41 +010042 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
43 * tasklet function.
44 *
45 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
Randy Dunlap6ef307b2008-07-03 13:52:18 -070046 * use the non-IRQ-safe functions!
Jiri Bencf0706e82007-05-05 11:45:53 -070047 */
48
Johannes Berg75a5f0c2007-09-18 17:29:20 -040049/**
50 * DOC: Warning
Jiri Bencf0706e82007-05-05 11:45:53 -070051 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -040052 * If you're reading this document and not the header file itself, it will
53 * be incomplete because not all documentation has been converted yet.
54 */
55
56/**
57 * DOC: Frame format
Jiri Bencf0706e82007-05-05 11:45:53 -070058 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -040059 * As a general rule, when frames are passed between mac80211 and the driver,
60 * they start with the IEEE 802.11 header and include the same octets that are
61 * sent over the air except for the FCS which should be calculated by the
62 * hardware.
63 *
64 * There are, however, various exceptions to this rule for advanced features:
65 *
66 * The first exception is for hardware encryption and decryption offload
67 * where the IV/ICV may or may not be generated in hardware.
68 *
69 * Secondly, when the hardware handles fragmentation, the frame handed to
70 * the driver from mac80211 is the MSDU, not the MPDU.
Jiri Bencf0706e82007-05-05 11:45:53 -070071 */
72
Ron Rindjunsky10816d42007-11-26 16:14:30 +020073/**
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -040074 * DOC: mac80211 workqueue
75 *
76 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
77 * The workqueue is a single threaded workqueue and can only be accessed by
78 * helpers for sanity checking. Drivers must ensure all work added onto the
79 * mac80211 workqueue should be cancelled on the driver stop() callback.
80 *
81 * mac80211 will flushed the workqueue upon interface removal and during
82 * suspend.
83 *
84 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
85 *
86 */
87
Felix Fietkauba8c3d62015-03-27 21:30:37 +010088/**
89 * DOC: mac80211 software tx queueing
90 *
91 * mac80211 provides an optional intermediate queueing implementation designed
92 * to allow the driver to keep hardware queues short and provide some fairness
93 * between different stations/interfaces.
94 * In this model, the driver pulls data frames from the mac80211 queue instead
95 * of letting mac80211 push them via drv_tx().
96 * Other frames (e.g. control or management) are still pushed using drv_tx().
97 *
98 * Drivers indicate that they use this model by implementing the .wake_tx_queue
99 * driver operation.
100 *
Johannes Bergadf8ed02018-08-31 11:31:08 +0300101 * Intermediate queues (struct ieee80211_txq) are kept per-sta per-tid, with
102 * another per-sta for non-data/non-mgmt and bufferable management frames, and
103 * a single per-vif queue for multicast data frames.
Felix Fietkauba8c3d62015-03-27 21:30:37 +0100104 *
105 * The driver is expected to initialize its private per-queue data for stations
106 * and interfaces in the .add_interface and .sta_add ops.
107 *
Toke Høiland-Jørgensen18667602018-12-18 17:02:06 -0800108 * The driver can't access the queue directly. To dequeue a frame from a
109 * txq, it calls ieee80211_tx_dequeue(). Whenever mac80211 adds a new frame to a
110 * queue, it calls the .wake_tx_queue driver op.
111 *
112 * Drivers can optionally delegate responsibility for scheduling queues to
113 * mac80211, to take advantage of airtime fairness accounting. In this case, to
114 * obtain the next queue to pull frames from, the driver calls
115 * ieee80211_next_txq(). The driver is then expected to return the txq using
116 * ieee80211_return_txq().
Felix Fietkauba8c3d62015-03-27 21:30:37 +0100117 *
118 * For AP powersave TIM handling, the driver only needs to indicate if it has
119 * buffered packets in the driver specific data structures by calling
120 * ieee80211_sta_set_buffered(). For frames buffered in the ieee80211_txq
121 * struct, mac80211 sets the appropriate TIM PVB bits and calls
122 * .release_buffered_frames().
123 * In that callback the driver is therefore expected to release its own
124 * buffered frames and afterwards also frames from the ieee80211_txq (obtained
125 * via the usual ieee80211_tx_dequeue).
126 */
127
Paul Gortmaker313162d2012-01-30 11:46:54 -0500128struct device;
129
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -0400130/**
Johannes Berge100bb62008-04-30 18:51:21 +0200131 * enum ieee80211_max_queues - maximum number of queues
132 *
133 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
Johannes Berg445ea4e2013-02-13 12:25:28 +0100134 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
Johannes Berge100bb62008-04-30 18:51:21 +0200135 */
136enum ieee80211_max_queues {
Johannes Berg3a25a8c2012-04-03 16:28:50 +0200137 IEEE80211_MAX_QUEUES = 16,
Johannes Berg445ea4e2013-02-13 12:25:28 +0100138 IEEE80211_MAX_QUEUE_MAP = BIT(IEEE80211_MAX_QUEUES) - 1,
Johannes Berge100bb62008-04-30 18:51:21 +0200139};
140
Johannes Berg3a25a8c2012-04-03 16:28:50 +0200141#define IEEE80211_INVAL_HW_QUEUE 0xff
142
Johannes Berge100bb62008-04-30 18:51:21 +0200143/**
Johannes Berg4bce22b2010-11-16 11:49:58 -0800144 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
145 * @IEEE80211_AC_VO: voice
146 * @IEEE80211_AC_VI: video
147 * @IEEE80211_AC_BE: best effort
148 * @IEEE80211_AC_BK: background
149 */
150enum ieee80211_ac_numbers {
151 IEEE80211_AC_VO = 0,
152 IEEE80211_AC_VI = 1,
153 IEEE80211_AC_BE = 2,
154 IEEE80211_AC_BK = 3,
155};
156
157/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400158 * struct ieee80211_tx_queue_params - transmit queue configuration
159 *
160 * The information provided in this structure is required for QoS
Johannes Berg3330d7b2008-02-10 16:49:38 +0100161 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400162 *
Bob Copelande37d4df2008-10-20 21:20:27 -0400163 * @aifs: arbitration interframe space [0..255]
Johannes Bergf434b2d2008-07-10 11:22:31 +0200164 * @cw_min: minimum contention window [a value of the form
165 * 2^n-1 in the range 1..32767]
Johannes Berg6b301cd2007-09-18 17:29:20 -0400166 * @cw_max: maximum contention window [like @cw_min]
Johannes Berg3330d7b2008-02-10 16:49:38 +0100167 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
Alexander Bondar908f8d02013-04-07 09:53:30 +0300168 * @acm: is mandatory admission control required for the access category
Kalle Valo9d173fc2010-01-14 13:09:14 +0200169 * @uapsd: is U-APSD mode enabled for the queue
Luca Coelho41cbb0f2018-06-09 09:14:44 +0300170 * @mu_edca: is the MU EDCA configured
171 * @mu_edca_param_rec: MU EDCA Parameter Record for HE
Johannes Berg6b301cd2007-09-18 17:29:20 -0400172 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700173struct ieee80211_tx_queue_params {
Johannes Bergf434b2d2008-07-10 11:22:31 +0200174 u16 txop;
Johannes Berg3330d7b2008-02-10 16:49:38 +0100175 u16 cw_min;
176 u16 cw_max;
Johannes Bergf434b2d2008-07-10 11:22:31 +0200177 u8 aifs;
Alexander Bondar908f8d02013-04-07 09:53:30 +0300178 bool acm;
Kalle Valoab133152010-01-12 10:42:31 +0200179 bool uapsd;
Luca Coelho41cbb0f2018-06-09 09:14:44 +0300180 bool mu_edca;
181 struct ieee80211_he_mu_edca_param_ac_rec mu_edca_param_rec;
Jiri Bencf0706e82007-05-05 11:45:53 -0700182};
183
Jiri Bencf0706e82007-05-05 11:45:53 -0700184struct ieee80211_low_level_stats {
185 unsigned int dot11ACKFailureCount;
186 unsigned int dot11RTSFailureCount;
187 unsigned int dot11FCSErrorCount;
188 unsigned int dot11RTSSuccessCount;
189};
190
Johannes Berg471b3ef2007-12-28 14:32:58 +0100191/**
Michal Kaziord01a1e62012-06-26 14:37:16 +0200192 * enum ieee80211_chanctx_change - change flag for channel context
Johannes Berg4bf88532012-11-09 11:39:59 +0100193 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
Johannes Berg04ecd252012-09-11 14:34:12 +0200194 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
Simon Wunderlich164eb022013-02-08 18:16:20 +0100195 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
Simon Wunderlich73da7d52013-07-11 16:09:06 +0200196 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
197 * this is used only with channel switching with CSA
Eliad Peller21f659b2013-11-11 20:14:01 +0200198 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
Michal Kaziord01a1e62012-06-26 14:37:16 +0200199 */
200enum ieee80211_chanctx_change {
Johannes Berg4bf88532012-11-09 11:39:59 +0100201 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0),
Johannes Berg04ecd252012-09-11 14:34:12 +0200202 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1),
Simon Wunderlich164eb022013-02-08 18:16:20 +0100203 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2),
Simon Wunderlich73da7d52013-07-11 16:09:06 +0200204 IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(3),
Eliad Peller21f659b2013-11-11 20:14:01 +0200205 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH = BIT(4),
Michal Kaziord01a1e62012-06-26 14:37:16 +0200206};
207
208/**
209 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
210 *
211 * This is the driver-visible part. The ieee80211_chanctx
212 * that contains it is visible in mac80211 only.
213 *
Johannes Berg4bf88532012-11-09 11:39:59 +0100214 * @def: the channel definition
Eliad Peller21f659b2013-11-11 20:14:01 +0200215 * @min_def: the minimum channel definition currently required.
Johannes Berg04ecd252012-09-11 14:34:12 +0200216 * @rx_chains_static: The number of RX chains that must always be
217 * active on the channel to receive MIMO transmissions
218 * @rx_chains_dynamic: The number of RX chains that must be enabled
219 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
Simon Wunderlich5d7fad42012-11-30 19:17:28 +0100220 * this will always be >= @rx_chains_static.
Simon Wunderlich164eb022013-02-08 18:16:20 +0100221 * @radar_enabled: whether radar detection is enabled on this channel.
Michal Kaziord01a1e62012-06-26 14:37:16 +0200222 * @drv_priv: data area for driver use, will always be aligned to
223 * sizeof(void *), size is determined in hw information.
224 */
225struct ieee80211_chanctx_conf {
Johannes Berg4bf88532012-11-09 11:39:59 +0100226 struct cfg80211_chan_def def;
Eliad Peller21f659b2013-11-11 20:14:01 +0200227 struct cfg80211_chan_def min_def;
Michal Kaziord01a1e62012-06-26 14:37:16 +0200228
Johannes Berg04ecd252012-09-11 14:34:12 +0200229 u8 rx_chains_static, rx_chains_dynamic;
230
Simon Wunderlich164eb022013-02-08 18:16:20 +0100231 bool radar_enabled;
232
Gustavo A. R. Silva3c232152020-05-07 13:59:07 -0500233 u8 drv_priv[] __aligned(sizeof(void *));
Michal Kaziord01a1e62012-06-26 14:37:16 +0200234};
235
236/**
Luciano Coelho1a5f0c12014-05-23 14:33:12 +0300237 * enum ieee80211_chanctx_switch_mode - channel context switch mode
238 * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already
239 * exist (and will continue to exist), but the virtual interface
240 * needs to be switched from one to the other.
241 * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop
242 * to exist with this call, the new context doesn't exist but
243 * will be active after this call, the virtual interface switches
244 * from the old to the new (note that the driver may of course
245 * implement this as an on-the-fly chandef switch of the existing
246 * hardware context, but the mac80211 pointer for the old context
247 * will cease to exist and only the new one will later be used
248 * for changes/removal.)
249 */
250enum ieee80211_chanctx_switch_mode {
251 CHANCTX_SWMODE_REASSIGN_VIF,
252 CHANCTX_SWMODE_SWAP_CONTEXTS,
253};
254
255/**
256 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information
257 *
258 * This is structure is used to pass information about a vif that
259 * needs to switch from one chanctx to another. The
260 * &ieee80211_chanctx_switch_mode defines how the switch should be
261 * done.
262 *
263 * @vif: the vif that should be switched from old_ctx to new_ctx
264 * @old_ctx: the old context to which the vif was assigned
265 * @new_ctx: the new context to which the vif must be assigned
266 */
267struct ieee80211_vif_chanctx_switch {
268 struct ieee80211_vif *vif;
269 struct ieee80211_chanctx_conf *old_ctx;
270 struct ieee80211_chanctx_conf *new_ctx;
271};
272
273/**
Johannes Berg471b3ef2007-12-28 14:32:58 +0100274 * enum ieee80211_bss_change - BSS change notification flags
275 *
276 * These flags are used with the bss_info_changed() callback
277 * to indicate which BSS parameter changed.
278 *
279 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
280 * also implies a change in the AID.
281 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
282 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300283 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler38668c02008-03-28 16:33:32 -0700284 * @BSS_CHANGED_HT: 802.11n parameters changed
Johannes Berg96dd22a2008-09-11 00:01:57 +0200285 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200286 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200287 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
288 * reason (IBSS and managed mode)
289 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
290 * new beacon (beaconing modes)
291 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
292 * enabled/disabled (beaconing modes)
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200293 * @BSS_CHANGED_CQM: Connection quality monitor config changed
Johannes Berg8fc214b2010-04-28 17:40:43 +0200294 * @BSS_CHANGED_IBSS: IBSS join status changed
Juuso Oikarinen68542962010-06-09 13:43:26 +0300295 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
Johannes Berg4ced3f72010-07-19 16:39:04 +0200296 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
297 * that it is only ever disabled for station mode.
Johannes Berg7da7cc12010-08-05 17:02:38 +0200298 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
Marek Puzyniak0ca54f62013-04-10 13:19:13 +0200299 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
Arik Nemtsov02945822011-11-10 11:28:57 +0200300 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
Eliad Pellerab095872012-07-27 12:33:22 +0300301 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
Johannes Berg1ea6f9c2012-10-24 10:59:25 +0200302 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
Johannes Berg488dd7b2012-10-29 20:08:01 +0100303 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
Ayala Beker52cfa1d2016-03-17 15:41:39 +0200304 * changed
Alexander Bondar989c6502013-05-16 17:34:17 +0300305 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
306 * currently dtim_period only is under consideration.
Johannes Berg2c9b7352013-02-07 21:37:29 +0100307 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
308 * note that this is only called when it changes after the channel
309 * context had been assigned.
Rostislav Lisovy239281f2014-11-03 10:33:19 +0100310 * @BSS_CHANGED_OCB: OCB join status changed
Sara Sharon23a1f8d2015-12-08 16:04:31 +0200311 * @BSS_CHANGED_MU_GROUPS: VHT MU-MIMO group id or user position changed
Avraham Sterne38a0172017-04-26 10:58:47 +0300312 * @BSS_CHANGED_KEEP_ALIVE: keep alive options (idle period or protected
313 * keep alive) changed.
Pradeep Kumar Chitrapudcbe73c2018-03-22 12:18:03 -0700314 * @BSS_CHANGED_MCAST_RATE: Multicast Rate setting changed for this interface
Chris Packhamae4a50e2019-10-25 10:36:47 +1300315 * @BSS_CHANGED_FTM_RESPONDER: fine timing measurement request responder
Pradeep Kumar Chitrapubc847972018-10-03 20:19:20 -0700316 * functionality changed for this BSS (AP mode).
John Crispinc9d32452019-05-28 13:49:47 +0200317 * @BSS_CHANGED_TWT: TWT status changed
John Crispin1ced1692019-07-30 18:37:01 +0200318 * @BSS_CHANGED_HE_OBSS_PD: OBSS Packet Detection status changed.
John Crispindd56e902019-12-17 15:19:19 +0100319 * @BSS_CHANGED_HE_BSS_COLOR: BSS Color has changed
Aloka Dixit295b02c2020-09-11 00:05:31 +0000320 * @BSS_CHANGED_FILS_DISCOVERY: FILS discovery status changed.
Aloka Dixit632189a2020-09-11 00:33:01 +0000321 * @BSS_CHANGED_UNSOL_BCAST_PROBE_RESP: Unsolicited broadcast probe response
322 * status changed.
Pradeep Kumar Chitrapudcbe73c2018-03-22 12:18:03 -0700323 *
Johannes Berg471b3ef2007-12-28 14:32:58 +0100324 */
325enum ieee80211_bss_change {
326 BSS_CHANGED_ASSOC = 1<<0,
327 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
328 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300329 BSS_CHANGED_ERP_SLOT = 1<<3,
Alexander Simona7ce1c92011-09-18 00:16:45 +0200330 BSS_CHANGED_HT = 1<<4,
Johannes Berg96dd22a2008-09-11 00:01:57 +0200331 BSS_CHANGED_BASIC_RATES = 1<<5,
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200332 BSS_CHANGED_BEACON_INT = 1<<6,
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200333 BSS_CHANGED_BSSID = 1<<7,
334 BSS_CHANGED_BEACON = 1<<8,
335 BSS_CHANGED_BEACON_ENABLED = 1<<9,
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200336 BSS_CHANGED_CQM = 1<<10,
Johannes Berg8fc214b2010-04-28 17:40:43 +0200337 BSS_CHANGED_IBSS = 1<<11,
Juuso Oikarinen68542962010-06-09 13:43:26 +0300338 BSS_CHANGED_ARP_FILTER = 1<<12,
Johannes Berg4ced3f72010-07-19 16:39:04 +0200339 BSS_CHANGED_QOS = 1<<13,
Johannes Berg7da7cc12010-08-05 17:02:38 +0200340 BSS_CHANGED_IDLE = 1<<14,
Arik Nemtsov78274932011-09-04 11:11:32 +0300341 BSS_CHANGED_SSID = 1<<15,
Arik Nemtsov02945822011-11-10 11:28:57 +0200342 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
Eliad Pellerab095872012-07-27 12:33:22 +0300343 BSS_CHANGED_PS = 1<<17,
Johannes Berg1ea6f9c2012-10-24 10:59:25 +0200344 BSS_CHANGED_TXPOWER = 1<<18,
Johannes Berg488dd7b2012-10-29 20:08:01 +0100345 BSS_CHANGED_P2P_PS = 1<<19,
Alexander Bondar989c6502013-05-16 17:34:17 +0300346 BSS_CHANGED_BEACON_INFO = 1<<20,
Johannes Berg2c9b7352013-02-07 21:37:29 +0100347 BSS_CHANGED_BANDWIDTH = 1<<21,
Rostislav Lisovy239281f2014-11-03 10:33:19 +0100348 BSS_CHANGED_OCB = 1<<22,
Sara Sharon23a1f8d2015-12-08 16:04:31 +0200349 BSS_CHANGED_MU_GROUPS = 1<<23,
Avraham Sterne38a0172017-04-26 10:58:47 +0300350 BSS_CHANGED_KEEP_ALIVE = 1<<24,
Pradeep Kumar Chitrapudcbe73c2018-03-22 12:18:03 -0700351 BSS_CHANGED_MCAST_RATE = 1<<25,
Pradeep Kumar Chitrapubc847972018-10-03 20:19:20 -0700352 BSS_CHANGED_FTM_RESPONDER = 1<<26,
John Crispinc9d32452019-05-28 13:49:47 +0200353 BSS_CHANGED_TWT = 1<<27,
John Crispin1ced1692019-07-30 18:37:01 +0200354 BSS_CHANGED_HE_OBSS_PD = 1<<28,
John Crispindd56e902019-12-17 15:19:19 +0100355 BSS_CHANGED_HE_BSS_COLOR = 1<<29,
Aloka Dixit295b02c2020-09-11 00:05:31 +0000356 BSS_CHANGED_FILS_DISCOVERY = 1<<30,
Aloka Dixit632189a2020-09-11 00:33:01 +0000357 BSS_CHANGED_UNSOL_BCAST_PROBE_RESP = 1<<31,
Johannes Bergac8dd502010-05-05 09:44:02 +0200358
359 /* when adding here, make sure to change ieee80211_reconfig */
Johannes Berg471b3ef2007-12-28 14:32:58 +0100360};
361
Juuso Oikarinen68542962010-06-09 13:43:26 +0300362/*
363 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
364 * of addresses for an interface increase beyond this value, hardware ARP
365 * filtering will be disabled.
366 */
367#define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
368
Johannes Berg471b3ef2007-12-28 14:32:58 +0100369/**
Emmanuel Grumbacha8182922015-03-16 23:23:34 +0200370 * enum ieee80211_event_type - event to be notified to the low level driver
371 * @RSSI_EVENT: AP's rssi crossed the a threshold set by the driver.
Emmanuel Grumbacha9409092015-03-16 23:23:35 +0200372 * @MLME_EVENT: event related to MLME
Emmanuel Grumbach63822462015-04-20 22:53:37 +0300373 * @BAR_RX_EVENT: a BAR was received
Emmanuel Grumbachb497de62015-04-20 22:53:38 +0300374 * @BA_FRAME_TIMEOUT: Frames were released from the reordering buffer because
375 * they timed out. This won't be called for each frame released, but only
376 * once each time the timeout triggers.
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -0700377 */
Emmanuel Grumbacha8182922015-03-16 23:23:34 +0200378enum ieee80211_event_type {
379 RSSI_EVENT,
Emmanuel Grumbacha9409092015-03-16 23:23:35 +0200380 MLME_EVENT,
Emmanuel Grumbach63822462015-04-20 22:53:37 +0300381 BAR_RX_EVENT,
Emmanuel Grumbachb497de62015-04-20 22:53:38 +0300382 BA_FRAME_TIMEOUT,
Emmanuel Grumbacha8182922015-03-16 23:23:34 +0200383};
384
385/**
386 * enum ieee80211_rssi_event_data - relevant when event type is %RSSI_EVENT
387 * @RSSI_EVENT_HIGH: AP's rssi went below the threshold set by the driver.
388 * @RSSI_EVENT_LOW: AP's rssi went above the threshold set by the driver.
389 */
390enum ieee80211_rssi_event_data {
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -0700391 RSSI_EVENT_HIGH,
392 RSSI_EVENT_LOW,
393};
394
395/**
Jonathan Corbeta839e462015-04-13 18:27:35 +0200396 * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT
Emmanuel Grumbacha8182922015-03-16 23:23:34 +0200397 * @data: See &enum ieee80211_rssi_event_data
398 */
399struct ieee80211_rssi_event {
400 enum ieee80211_rssi_event_data data;
401};
402
403/**
Emmanuel Grumbacha9409092015-03-16 23:23:35 +0200404 * enum ieee80211_mlme_event_data - relevant when event type is %MLME_EVENT
405 * @AUTH_EVENT: the MLME operation is authentication
Emmanuel Grumbachd0d1a122015-03-16 23:23:36 +0200406 * @ASSOC_EVENT: the MLME operation is association
Emmanuel Grumbacha90faa92015-03-16 23:23:37 +0200407 * @DEAUTH_RX_EVENT: deauth received..
408 * @DEAUTH_TX_EVENT: deauth sent.
Emmanuel Grumbacha9409092015-03-16 23:23:35 +0200409 */
410enum ieee80211_mlme_event_data {
411 AUTH_EVENT,
Emmanuel Grumbachd0d1a122015-03-16 23:23:36 +0200412 ASSOC_EVENT,
Emmanuel Grumbacha90faa92015-03-16 23:23:37 +0200413 DEAUTH_RX_EVENT,
414 DEAUTH_TX_EVENT,
Emmanuel Grumbacha9409092015-03-16 23:23:35 +0200415};
416
417/**
418 * enum ieee80211_mlme_event_status - relevant when event type is %MLME_EVENT
419 * @MLME_SUCCESS: the MLME operation completed successfully.
420 * @MLME_DENIED: the MLME operation was denied by the peer.
421 * @MLME_TIMEOUT: the MLME operation timed out.
422 */
423enum ieee80211_mlme_event_status {
424 MLME_SUCCESS,
425 MLME_DENIED,
426 MLME_TIMEOUT,
427};
428
429/**
Jonathan Corbeta839e462015-04-13 18:27:35 +0200430 * struct ieee80211_mlme_event - data attached to an %MLME_EVENT
Emmanuel Grumbacha9409092015-03-16 23:23:35 +0200431 * @data: See &enum ieee80211_mlme_event_data
432 * @status: See &enum ieee80211_mlme_event_status
433 * @reason: the reason code if applicable
434 */
435struct ieee80211_mlme_event {
436 enum ieee80211_mlme_event_data data;
437 enum ieee80211_mlme_event_status status;
438 u16 reason;
439};
440
441/**
Emmanuel Grumbach63822462015-04-20 22:53:37 +0300442 * struct ieee80211_ba_event - data attached for BlockAck related events
443 * @sta: pointer to the &ieee80211_sta to which this event relates
444 * @tid: the tid
Emmanuel Grumbachb497de62015-04-20 22:53:38 +0300445 * @ssn: the starting sequence number (for %BAR_RX_EVENT)
Emmanuel Grumbach63822462015-04-20 22:53:37 +0300446 */
447struct ieee80211_ba_event {
448 struct ieee80211_sta *sta;
449 u16 tid;
450 u16 ssn;
451};
452
453/**
Emmanuel Grumbacha8182922015-03-16 23:23:34 +0200454 * struct ieee80211_event - event to be sent to the driver
Jonathan Corbeta839e462015-04-13 18:27:35 +0200455 * @type: The event itself. See &enum ieee80211_event_type.
Emmanuel Grumbacha8182922015-03-16 23:23:34 +0200456 * @rssi: relevant if &type is %RSSI_EVENT
Emmanuel Grumbacha9409092015-03-16 23:23:35 +0200457 * @mlme: relevant if &type is %AUTH_EVENT
Emmanuel Grumbachb497de62015-04-20 22:53:38 +0300458 * @ba: relevant if &type is %BAR_RX_EVENT or %BA_FRAME_TIMEOUT
Emmanuel Grumbach63822462015-04-20 22:53:37 +0300459 * @u:union holding the fields above
Emmanuel Grumbacha8182922015-03-16 23:23:34 +0200460 */
461struct ieee80211_event {
462 enum ieee80211_event_type type;
463 union {
464 struct ieee80211_rssi_event rssi;
Emmanuel Grumbacha9409092015-03-16 23:23:35 +0200465 struct ieee80211_mlme_event mlme;
Emmanuel Grumbach63822462015-04-20 22:53:37 +0300466 struct ieee80211_ba_event ba;
Emmanuel Grumbacha8182922015-03-16 23:23:34 +0200467 } u;
468};
469
470/**
Sara Sharon23a1f8d2015-12-08 16:04:31 +0200471 * struct ieee80211_mu_group_data - STA's VHT MU-MIMO group data
472 *
473 * This structure describes the group id data of VHT MU-MIMO
474 *
475 * @membership: 64 bits array - a bit is set if station is member of the group
476 * @position: 2 bits per group id indicating the position in the group
477 */
478struct ieee80211_mu_group_data {
479 u8 membership[WLAN_MEMBERSHIP_LEN];
480 u8 position[WLAN_USER_POSITION_LEN];
481};
482
483/**
Randy Dunlap3453de92018-12-06 12:58:30 -0800484 * struct ieee80211_ftm_responder_params - FTM responder parameters
Pradeep Kumar Chitrapubc847972018-10-03 20:19:20 -0700485 *
486 * @lci: LCI subelement content
487 * @civicloc: CIVIC location subelement content
488 * @lci_len: LCI data length
489 * @civicloc_len: Civic data length
490 */
491struct ieee80211_ftm_responder_params {
492 const u8 *lci;
493 const u8 *civicloc;
494 size_t lci_len;
495 size_t civicloc_len;
496};
497
498/**
Aloka Dixit295b02c2020-09-11 00:05:31 +0000499 * struct ieee80211_fils_discovery - FILS discovery parameters from
500 * IEEE Std 802.11ai-2016, Annex C.3 MIB detail.
501 *
502 * @min_interval: Minimum packet interval in TUs (0 - 10000)
503 * @max_interval: Maximum packet interval in TUs (0 - 10000)
504 */
505struct ieee80211_fils_discovery {
506 u32 min_interval;
507 u32 max_interval;
508};
509
510/**
Johannes Berg471b3ef2007-12-28 14:32:58 +0100511 * struct ieee80211_bss_conf - holds the BSS's changing parameters
512 *
513 * This structure keeps information about a BSS (and an association
514 * to that BSS) that can change during the lifetime of the BSS.
515 *
Luca Coelho41cbb0f2018-06-09 09:14:44 +0300516 * @htc_trig_based_pkt_ext: default PE in 4us units, if BSS supports HE
517 * @multi_sta_back_32bit: supports BA bitmap of 32-bits in Multi-STA BACK
518 * @uora_exists: is the UORA element advertised by AP
519 * @ack_enabled: indicates support to receive a multi-TID that solicits either
520 * ACK, BACK or both
521 * @uora_ocw_range: UORA element's OCW Range field
522 * @frame_time_rts_th: HE duration RTS threshold, in units of 32us
523 * @he_support: does this BSS support HE
Emmanuel Grumbach55ebd6e2018-12-15 11:03:04 +0200524 * @twt_requester: does this BSS support TWT requester (relevant for managed
525 * mode only, set if the AP advertises TWT responder role)
John Crispina0de1ca32019-05-28 13:49:48 +0200526 * @twt_responder: does this BSS support TWT requester (relevant for managed
527 * mode only, set if the AP advertises TWT responder role)
Shaul Triebitzd46b4ab82020-03-26 15:09:33 +0200528 * @twt_protected: does this BSS support protected TWT frames
Shaul Triebitzd8b26152021-06-18 13:41:35 +0300529 * @twt_broadcast: does this BSS support broadcast TWT
Johannes Berg471b3ef2007-12-28 14:32:58 +0100530 * @assoc: association status
Johannes Berg8fc214b2010-04-28 17:40:43 +0200531 * @ibss_joined: indicates whether this station is part of an IBSS
532 * or not
Sujith Manoharanc13a7652012-10-12 17:35:45 +0530533 * @ibss_creator: indicates if a new IBSS network is being created
Johannes Berg471b3ef2007-12-28 14:32:58 +0100534 * @aid: association ID number, valid only when @assoc is true
535 * @use_cts_prot: use CTS protection
Johannes Bergea1b2b452015-06-02 20:15:49 +0200536 * @use_short_preamble: use 802.11b short preamble
537 * @use_short_slot: use short slot time (only relevant for ERP)
Johannes Berg56007a02010-01-26 14:19:52 +0100538 * @dtim_period: num of beacons before the next DTIM, for beaconing,
Emmanuel Grumbachc65dd142012-12-12 10:12:24 +0200539 * valid in station mode only if after the driver was notified
Alexander Bondar989c6502013-05-16 17:34:17 +0300540 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
Johannes Berg8c358bc2012-05-22 22:13:05 +0200541 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
Johannes Bergef429da2013-02-05 17:48:40 +0100542 * as it may have been received during scanning long ago). If the
543 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
544 * only come from a beacon, but might not become valid until after
545 * association when a beacon is received (which is notified with the
Alexander Bondar2ecc3902015-03-01 09:10:00 +0200546 * %BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice.
Johannes Berg8c358bc2012-05-22 22:13:05 +0200547 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
548 * the driver/device can use this to calculate synchronisation
Alexander Bondar2ecc3902015-03-01 09:10:00 +0200549 * (see @sync_tsf). See also sync_dtim_count important notice.
Johannes Bergef429da2013-02-05 17:48:40 +0100550 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
551 * is requested, see @sync_tsf/@sync_device_ts.
Alexander Bondar2ecc3902015-03-01 09:10:00 +0200552 * IMPORTANT: These three sync_* parameters would possibly be out of sync
553 * by the time the driver will use them. The synchronized view is currently
554 * guaranteed only in certain callbacks.
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700555 * @beacon_int: beacon interval
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800556 * @assoc_capability: capabilities taken from assoc resp
Johannes Berg96dd22a2008-09-11 00:01:57 +0200557 * @basic_rates: bitmap of basic rates, each bit stands for an
558 * index into the rate table configured by the driver in
559 * the current band.
Alexander Bondar817cee72013-05-19 14:23:57 +0300560 * @beacon_rate: associated AP's beacon TX rate
Felix Fietkaudd5b4cc2010-11-22 20:58:24 +0100561 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200562 * @bssid: The BSSID for this BSS
563 * @enable_beacon: whether beaconing should be enabled or not
Johannes Berg4bf88532012-11-09 11:39:59 +0100564 * @chandef: Channel definition for this BSS -- the hardware might be
565 * configured a higher bandwidth than this BSS uses, for example.
Sara Sharon23a1f8d2015-12-08 16:04:31 +0200566 * @mu_group: VHT MU-MIMO group membership data
Johannes Berg074d46d2012-03-15 19:45:16 +0100567 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
Avri Altman22f66892015-08-18 16:52:07 +0300568 * This field is only valid when the channel is a wide HT/VHT channel.
569 * Note that with TDLS this can be the case (channel is HT, protection must
570 * be used from this field) even when the BSS association isn't using HT.
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200571 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
Johannes Berge86abc62015-10-22 17:35:14 +0200572 * implies disabled. As with the cfg80211 callback, a change here should
573 * cause an event to be sent indicating where the current value is in
574 * relation to the newly configured threshold.
Andrew Zaborowski2c3c5f8c2017-02-10 04:50:22 +0100575 * @cqm_rssi_low: Connection quality monitor RSSI lower threshold, a zero value
576 * implies disabled. This is an alternative mechanism to the single
577 * threshold event and can't be enabled simultaneously with it.
578 * @cqm_rssi_high: Connection quality monitor RSSI upper threshold.
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200579 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
Juuso Oikarinen68542962010-06-09 13:43:26 +0300580 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
581 * may filter ARP queries targeted for other addresses than listed here.
582 * The driver must allow ARP queries targeted for all address listed here
583 * to pass through. An empty list implies no ARP queries need to pass.
Johannes Berg0f19b412013-01-14 16:39:07 +0100584 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
585 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
586 * array size), it's up to the driver what to do in that case.
Johannes Berg4ced3f72010-07-19 16:39:04 +0200587 * @qos: This is a QoS-enabled BSS.
Johannes Berg7da7cc12010-08-05 17:02:38 +0200588 * @idle: This interface is idle. There's also a global idle flag in the
589 * hardware config which may be more appropriate depending on what
590 * your driver/device needs to do.
Eliad Pellerab095872012-07-27 12:33:22 +0300591 * @ps: power-save mode (STA only). This flag is NOT affected by
592 * offchannel/dynamic_ps operations.
Marek Puzyniak0ca54f62013-04-10 13:19:13 +0200593 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
Arik Nemtsov78274932011-09-04 11:11:32 +0300594 * @ssid_len: Length of SSID given in @ssid.
595 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
Ben Greeardb6d9e92019-12-17 10:30:57 -0800596 * @txpower: TX power in dBm. INT_MIN means not configured.
Lorenzo Bianconidb82d8a2015-01-14 12:55:08 +0100597 * @txpower_type: TX power adjustment used to control per packet Transmit
598 * Power Control (TPC) in lower driver for the current vif. In particular
599 * TPC is enabled if value passed in %txpower_type is
600 * NL80211_TX_POWER_LIMITED (allow using less than specified from
601 * userspace), whereas TPC is disabled if %txpower_type is set to
602 * NL80211_TX_POWER_FIXED (use value configured from userspace)
Janusz Dziedzic67baf662013-03-21 15:47:56 +0100603 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
Ayala Beker52cfa1d2016-03-17 15:41:39 +0200604 * @allow_p2p_go_ps: indication for AP or P2P GO interface, whether it's allowed
605 * to use P2P PS mechanism or not. AP/P2P GO is not allowed to use P2P PS
606 * if it has associated clients without P2P PS support.
Avraham Sterne38a0172017-04-26 10:58:47 +0300607 * @max_idle_period: the time period during which the station can refrain from
608 * transmitting frames to its associated AP without being disassociated.
609 * In units of 1000 TUs. Zero value indicates that the AP did not include
610 * a (valid) BSS Max Idle Period Element.
611 * @protected_keep_alive: if set, indicates that the station should send an RSN
612 * protected frame to the AP to reset the idle timer at the AP for the
613 * station.
Pradeep Kumar Chitrapubc847972018-10-03 20:19:20 -0700614 * @ftm_responder: whether to enable or disable fine timing measurement FTM
615 * responder functionality.
616 * @ftmr_params: configurable lci/civic parameter when enabling FTM responder.
Sara Sharon78ac51f2019-01-16 18:22:56 +0200617 * @nontransmitted: this BSS is a nontransmitted BSS profile
618 * @transmitter_bssid: the address of transmitter AP
619 * @bssid_index: index inside the multiple BSSID set
620 * @bssid_indicator: 2^bssid_indicator is the maximum number of APs in set
621 * @ema_ap: AP supports enhancements of discovery and advertisement of
622 * nontransmitted BSSIDs
623 * @profile_periodicity: the least number of beacon frames need to be received
624 * in order to discover all the nontransmitted BSSIDs in the set.
Pradeep Kumar Chitrapu70debba2020-10-20 11:31:08 -0700625 * @he_oper: HE operation information of the BSS (AP/Mesh) or of the AP we are
626 * connected to (STA)
John Crispin1ced1692019-07-30 18:37:01 +0200627 * @he_obss_pd: OBSS Packet Detection parameters.
John Crispindd56e902019-12-17 15:19:19 +0100628 * @he_bss_color: BSS coloring settings, if BSS supports HE
Aloka Dixit295b02c2020-09-11 00:05:31 +0000629 * @fils_discovery: FILS discovery configuration
Aloka Dixit632189a2020-09-11 00:33:01 +0000630 * @unsol_bcast_probe_resp_interval: Unsolicited broadcast probe response
631 * interval.
Thomas Pedersen1d00ce82020-09-21 19:28:15 -0700632 * @s1g: BSS is S1G BSS (affects Association Request format).
Rajkumar Manoharanba6ff702020-10-03 15:04:18 -0700633 * @beacon_tx_rate: The configured beacon transmit rate that needs to be passed
634 * to driver when rate control is offloaded to firmware.
Wen Gong405fca82021-09-24 06:00:47 -0400635 * @power_type: power type of BSS for 6 GHz
Wen Gong63214f02021-09-24 06:00:52 -0400636 * @tx_pwr_env: transmit power envelope array of BSS.
637 * @tx_pwr_env_num: number of @tx_pwr_env.
638 * @pwr_reduction: power constraint of BSS.
Ilan Peera1de6402022-02-14 17:30:02 +0100639 * @eht_support: does this BSS support EHT
Johannes Berg471b3ef2007-12-28 14:32:58 +0100640 */
641struct ieee80211_bss_conf {
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200642 const u8 *bssid;
Luca Coelho41cbb0f2018-06-09 09:14:44 +0300643 u8 htc_trig_based_pkt_ext;
Luca Coelho41cbb0f2018-06-09 09:14:44 +0300644 bool uora_exists;
Luca Coelho41cbb0f2018-06-09 09:14:44 +0300645 u8 uora_ocw_range;
646 u16 frame_time_rts_th;
647 bool he_support;
Emmanuel Grumbach55ebd6e2018-12-15 11:03:04 +0200648 bool twt_requester;
John Crispina0de1ca32019-05-28 13:49:48 +0200649 bool twt_responder;
Shaul Triebitzd46b4ab82020-03-26 15:09:33 +0200650 bool twt_protected;
Shaul Triebitzd8b26152021-06-18 13:41:35 +0300651 bool twt_broadcast;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100652 /* association related data */
Johannes Berg8fc214b2010-04-28 17:40:43 +0200653 bool assoc, ibss_joined;
Sujith Manoharanc13a7652012-10-12 17:35:45 +0530654 bool ibss_creator;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100655 u16 aid;
656 /* erp related data */
657 bool use_cts_prot;
658 bool use_short_preamble;
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300659 bool use_short_slot;
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200660 bool enable_beacon;
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800661 u8 dtim_period;
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700662 u16 beacon_int;
663 u16 assoc_capability;
Johannes Berg8c358bc2012-05-22 22:13:05 +0200664 u64 sync_tsf;
665 u32 sync_device_ts;
Johannes Bergef429da2013-02-05 17:48:40 +0100666 u8 sync_dtim_count;
Johannes Berg881d9482009-01-21 15:13:48 +0100667 u32 basic_rates;
Alexander Bondar817cee72013-05-19 14:23:57 +0300668 struct ieee80211_rate *beacon_rate;
Johannes Berg57fbcce2016-04-12 15:56:15 +0200669 int mcast_rate[NUM_NL80211_BANDS];
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200670 u16 ht_operation_mode;
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200671 s32 cqm_rssi_thold;
672 u32 cqm_rssi_hyst;
Andrew Zaborowski2c3c5f8c2017-02-10 04:50:22 +0100673 s32 cqm_rssi_low;
674 s32 cqm_rssi_high;
Johannes Berg4bf88532012-11-09 11:39:59 +0100675 struct cfg80211_chan_def chandef;
Sara Sharon23a1f8d2015-12-08 16:04:31 +0200676 struct ieee80211_mu_group_data mu_group;
Juuso Oikarinen68542962010-06-09 13:43:26 +0300677 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
Johannes Berg0f19b412013-01-14 16:39:07 +0100678 int arp_addr_cnt;
Johannes Berg4ced3f72010-07-19 16:39:04 +0200679 bool qos;
Johannes Berg7da7cc12010-08-05 17:02:38 +0200680 bool idle;
Eliad Pellerab095872012-07-27 12:33:22 +0300681 bool ps;
Arik Nemtsov78274932011-09-04 11:11:32 +0300682 u8 ssid[IEEE80211_MAX_SSID_LEN];
683 size_t ssid_len;
684 bool hidden_ssid;
Johannes Berg1ea6f9c2012-10-24 10:59:25 +0200685 int txpower;
Lorenzo Bianconidb82d8a2015-01-14 12:55:08 +0100686 enum nl80211_tx_power_setting txpower_type;
Janusz Dziedzic67baf662013-03-21 15:47:56 +0100687 struct ieee80211_p2p_noa_attr p2p_noa_attr;
Ayala Beker52cfa1d2016-03-17 15:41:39 +0200688 bool allow_p2p_go_ps;
Avraham Sterne38a0172017-04-26 10:58:47 +0300689 u16 max_idle_period;
690 bool protected_keep_alive;
Pradeep Kumar Chitrapubc847972018-10-03 20:19:20 -0700691 bool ftm_responder;
692 struct ieee80211_ftm_responder_params *ftmr_params;
Sara Sharon78ac51f2019-01-16 18:22:56 +0200693 /* Multiple BSSID data */
694 bool nontransmitted;
695 u8 transmitter_bssid[ETH_ALEN];
696 u8 bssid_index;
697 u8 bssid_indicator;
698 bool ema_ap;
699 u8 profile_periodicity;
Rajkumar Manoharan60689de2020-04-24 15:41:39 -0700700 struct {
701 u32 params;
702 u16 nss_set;
703 } he_oper;
John Crispin1ced1692019-07-30 18:37:01 +0200704 struct ieee80211_he_obss_pd he_obss_pd;
John Crispindd56e902019-12-17 15:19:19 +0100705 struct cfg80211_he_bss_color he_bss_color;
Aloka Dixit295b02c2020-09-11 00:05:31 +0000706 struct ieee80211_fils_discovery fils_discovery;
Aloka Dixit632189a2020-09-11 00:33:01 +0000707 u32 unsol_bcast_probe_resp_interval;
Thomas Pedersen1d00ce82020-09-21 19:28:15 -0700708 bool s1g;
Rajkumar Manoharanba6ff702020-10-03 15:04:18 -0700709 struct cfg80211_bitrate_mask beacon_tx_rate;
Wen Gong405fca82021-09-24 06:00:47 -0400710 enum ieee80211_ap_reg_power power_type;
Wen Gong63214f02021-09-24 06:00:52 -0400711 struct ieee80211_tx_pwr_env tx_pwr_env[IEEE80211_TPE_MAX_IE_COUNT];
712 u8 tx_pwr_env_num;
713 u8 pwr_reduction;
Ilan Peera1de6402022-02-14 17:30:02 +0100714 bool eht_support;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100715};
716
Ron Rindjunsky11f4b1ce2008-03-04 18:09:26 -0800717/**
Johannes Bergaf61a162013-07-02 18:09:12 +0200718 * enum mac80211_tx_info_flags - flags to describe transmission information/status
Ron Rindjunsky11f4b1ce2008-03-04 18:09:26 -0800719 *
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700720 * These flags are used with the @flags member of &ieee80211_tx_info.
Ron Rindjunsky11f4b1ce2008-03-04 18:09:26 -0800721 *
Johannes Berg7351c6b2009-11-19 01:08:30 +0100722 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
Johannes Berge6a98542008-10-21 12:40:02 +0200723 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
724 * number to this frame, taking care of not overwriting the fragment
725 * number and increasing the sequence number only when the
726 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
727 * assign sequence numbers to QoS-data frames but cannot do so correctly
728 * for non-QoS-data and management frames because beacons need them from
729 * that counter as well and mac80211 cannot guarantee proper sequencing.
730 * If this flag is set, the driver should instruct the hardware to
731 * assign a sequence number to the frame or assign one itself. Cf. IEEE
732 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
733 * beacons and always be clear for frames without a sequence number field.
Johannes Berge039fa42008-05-15 12:55:29 +0200734 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
Johannes Berge039fa42008-05-15 12:55:29 +0200735 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
736 * station
Johannes Berge039fa42008-05-15 12:55:29 +0200737 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
Johannes Berge039fa42008-05-15 12:55:29 +0200738 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
739 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
Johannes Berge6a98542008-10-21 12:40:02 +0200740 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
Johannes Berge039fa42008-05-15 12:55:29 +0200741 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
Johannes Bergab5b5342009-08-07 16:28:09 +0200742 * because the destination STA was in powersave mode. Note that to
743 * avoid race conditions, the filter must be set by the hardware or
744 * firmware upon receiving a frame that indicates that the station
745 * went to sleep (must be done on device to filter frames already on
746 * the queue) and may only be unset after mac80211 gives the OK for
747 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
748 * since only then is it guaranteed that no more frames are in the
749 * hardware queue.
Johannes Berge039fa42008-05-15 12:55:29 +0200750 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
751 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
752 * is for the whole aggregation.
Ron Rindjunsky429a3802008-07-01 14:16:03 +0300753 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
754 * so consider using block ack request (BAR).
Johannes Berge6a98542008-10-21 12:40:02 +0200755 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
756 * set by rate control algorithms to indicate probe rate, will
757 * be cleared for fragmented frames (except on the last fragment)
Seth Forshee6c17b772013-02-11 11:21:07 -0600758 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
759 * that a frame can be transmitted while the queues are stopped for
760 * off-channel operation.
Felix Fietkaucc20ff2c2020-09-08 14:36:57 +0200761 * @IEEE80211_TX_CTL_HW_80211_ENCAP: This frame uses hardware encapsulation
762 * (header conversion)
Johannes Berg8f77f382009-06-07 21:58:37 +0200763 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
764 * used to indicate that a frame was already retried due to PS
Johannes Berg3b8d81e02009-06-17 17:43:56 +0200765 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
766 * used to indicate frame should not be encrypted
Johannes Berg02f2f1a2012-02-27 12:18:30 +0100767 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
768 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
769 * be sent although the station is in powersave mode.
Johannes Bergad5351d2009-08-07 16:42:15 +0200770 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
771 * transmit function after the current frame, this can be used
772 * by drivers to kick the DMA queue only if unset or when the
773 * queue gets full.
Johannes Bergc6fcf6b2010-01-17 01:47:59 +0100774 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
775 * after TX status because the destination was asleep, it must not
776 * be modified again (no seqno assignment, crypto, etc.)
Johannes Berg1672c0e32013-01-29 15:02:27 +0100777 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
778 * code for connection establishment, this indicates that its status
779 * should kick the MLME state machine.
Jouni Malinen026331c2010-02-15 12:53:10 +0200780 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
781 * MLME command (internal to mac80211 to figure out whether to send TX
782 * status to user space)
Luis R. Rodriguez0a56bd02010-04-15 17:39:37 -0400783 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
Felix Fietkauf79d9ba2010-04-19 19:57:35 +0200784 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
785 * frame and selects the maximum number of streams that it can use.
Johannes Berg610dbc92011-01-06 22:36:44 +0100786 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
787 * the off-channel channel when a remain-on-channel offload is done
788 * in hardware -- normal packets still flow and are expected to be
789 * handled properly by the device.
Jouni Malinen681d1192011-02-03 18:35:19 +0200790 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
791 * testing. It will be sent out with incorrect Michael MIC key to allow
792 * TKIP countermeasures to be tested.
Rajkumar Manoharanaad14ce2011-09-25 14:53:31 +0530793 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
794 * This flag is actually used for management frame especially for P2P
795 * frames not being sent at CCK rate in 2GHz band.
Johannes Berg47086fc2011-09-29 16:04:33 +0200796 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
797 * when its status is reported the service period ends. For frames in
798 * an SP that mac80211 transmits, it is already set; for driver frames
Johannes Bergdeeaee192011-09-29 16:04:35 +0200799 * the driver may set this flag. It is also used to do the same for
800 * PS-Poll responses.
Rajkumar Manoharanb6f35302011-09-29 20:34:04 +0530801 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
802 * This flag is used to send nullfunc frame at minimum rate when
803 * the nullfunc is used for connection monitoring purpose.
Johannes Berga26eb272011-10-07 14:01:25 +0200804 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
805 * would be fragmented by size (this is optional, only used for
806 * monitor injection).
Sujith Manoharan5cf16612014-12-10 21:26:11 +0530807 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
808 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
809 * any errors (like issues specific to the driver/HW).
810 * This flag must not be set for frames that don't request no-ack
811 * behaviour with IEEE80211_TX_CTL_NO_ACK.
Christian Lampartereb7d3062010-09-21 21:36:18 +0200812 *
813 * Note: If you have to add new flags to the enumeration, then don't
814 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
Ron Rindjunsky11f4b1ce2008-03-04 18:09:26 -0800815 */
Johannes Bergaf61a162013-07-02 18:09:12 +0200816enum mac80211_tx_info_flags {
Johannes Berge039fa42008-05-15 12:55:29 +0200817 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
Johannes Berge6a98542008-10-21 12:40:02 +0200818 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
819 IEEE80211_TX_CTL_NO_ACK = BIT(2),
820 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
821 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
822 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
823 IEEE80211_TX_CTL_AMPDU = BIT(6),
824 IEEE80211_TX_CTL_INJECTED = BIT(7),
825 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
826 IEEE80211_TX_STAT_ACK = BIT(9),
827 IEEE80211_TX_STAT_AMPDU = BIT(10),
828 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
829 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
Seth Forshee6c17b772013-02-11 11:21:07 -0600830 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
Felix Fietkaucc20ff2c2020-09-08 14:36:57 +0200831 IEEE80211_TX_CTL_HW_80211_ENCAP = BIT(14),
Johannes Berg8f77f382009-06-07 21:58:37 +0200832 IEEE80211_TX_INTFL_RETRIED = BIT(15),
Johannes Berg3b8d81e02009-06-17 17:43:56 +0200833 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
Johannes Berg02f2f1a2012-02-27 12:18:30 +0100834 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
Johannes Bergad5351d2009-08-07 16:42:15 +0200835 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
Johannes Bergc6fcf6b2010-01-17 01:47:59 +0100836 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
Johannes Berg1672c0e32013-01-29 15:02:27 +0100837 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
Jouni Malinen026331c2010-02-15 12:53:10 +0200838 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
Luis R. Rodriguez0a56bd02010-04-15 17:39:37 -0400839 IEEE80211_TX_CTL_LDPC = BIT(22),
Felix Fietkauf79d9ba2010-04-19 19:57:35 +0200840 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
Johannes Berg21f83582010-12-18 17:20:47 +0100841 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
Jouni Malinen681d1192011-02-03 18:35:19 +0200842 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
Rajkumar Manoharanaad14ce2011-09-25 14:53:31 +0530843 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
Johannes Berg47086fc2011-09-29 16:04:33 +0200844 IEEE80211_TX_STATUS_EOSP = BIT(28),
Rajkumar Manoharanb6f35302011-09-29 20:34:04 +0530845 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
Johannes Berga26eb272011-10-07 14:01:25 +0200846 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
Sujith Manoharan5cf16612014-12-10 21:26:11 +0530847 IEEE80211_TX_STAT_NOACK_TRANSMITTED = BIT(31),
Johannes Berge6a98542008-10-21 12:40:02 +0200848};
849
Johannes Bergabe37c42010-06-07 11:12:27 +0200850#define IEEE80211_TX_CTL_STBC_SHIFT 23
851
Thomas Pedersen1821f8b2020-09-21 19:28:12 -0700852#define IEEE80211_TX_RC_S1G_MCS IEEE80211_TX_RC_VHT_MCS
853
Johannes Bergaf61a162013-07-02 18:09:12 +0200854/**
855 * enum mac80211_tx_control_flags - flags to describe transmit control
856 *
857 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
858 * protocol frame (e.g. EAP)
Sujith Manoharan6b127c72014-12-10 21:26:10 +0530859 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
860 * frame (PS-Poll or uAPSD).
Sven Eckelmanndfdfc2b2016-01-26 17:11:13 +0100861 * @IEEE80211_TX_CTRL_RATE_INJECT: This frame is injected with rate information
Felix Fietkau6e0456b2016-03-03 22:59:00 +0100862 * @IEEE80211_TX_CTRL_AMSDU: This frame is an A-MSDU frame
Toke Høiland-Jørgensenbb42f2d2016-09-22 19:04:20 +0200863 * @IEEE80211_TX_CTRL_FAST_XMIT: This frame is going through the fast_xmit path
Rajkumar Manoharan8828f812019-04-11 13:47:26 -0700864 * @IEEE80211_TX_CTRL_SKIP_MPATH_LOOKUP: This frame skips mesh path lookup
Felix Fietkaucc20ff2c2020-09-08 14:36:57 +0200865 * @IEEE80211_TX_INTCFL_NEED_TXPROCESSING: completely internal to mac80211,
866 * used to indicate that a pending frame requires TX processing before
867 * it can be sent out.
Mathy Vanhoefe02281e2020-07-23 14:01:49 +0400868 * @IEEE80211_TX_CTRL_NO_SEQNO: Do not overwrite the sequence number that
869 * has already been assigned to this frame.
Mathy Vanhoef30df8132020-11-04 10:18:19 +0400870 * @IEEE80211_TX_CTRL_DONT_REORDER: This frame should not be reordered
871 * relative to other frames that have this flag set, independent
872 * of their QoS TID or other priority field values.
Johannes Bergaf61a162013-07-02 18:09:12 +0200873 *
874 * These flags are used in tx_info->control.flags.
875 */
876enum mac80211_tx_control_flags {
877 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
Sujith Manoharan6b127c72014-12-10 21:26:10 +0530878 IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1),
Sven Eckelmanndfdfc2b2016-01-26 17:11:13 +0100879 IEEE80211_TX_CTRL_RATE_INJECT = BIT(2),
Felix Fietkau6e0456b2016-03-03 22:59:00 +0100880 IEEE80211_TX_CTRL_AMSDU = BIT(3),
Toke Høiland-Jørgensenbb42f2d2016-09-22 19:04:20 +0200881 IEEE80211_TX_CTRL_FAST_XMIT = BIT(4),
Rajkumar Manoharan8828f812019-04-11 13:47:26 -0700882 IEEE80211_TX_CTRL_SKIP_MPATH_LOOKUP = BIT(5),
Felix Fietkaucc20ff2c2020-09-08 14:36:57 +0200883 IEEE80211_TX_INTCFL_NEED_TXPROCESSING = BIT(6),
Mathy Vanhoefe02281e2020-07-23 14:01:49 +0400884 IEEE80211_TX_CTRL_NO_SEQNO = BIT(7),
Mathy Vanhoef30df8132020-11-04 10:18:19 +0400885 IEEE80211_TX_CTRL_DONT_REORDER = BIT(8),
Johannes Bergaf61a162013-07-02 18:09:12 +0200886};
887
Avraham Sternea5907d2022-02-02 10:49:47 +0200888/**
889 * enum mac80211_tx_status_flags - flags to describe transmit status
890 *
891 * @IEEE80211_TX_STATUS_ACK_SIGNAL_VALID: ACK signal is valid
892 *
893 * These flags are used in tx_info->status.flags.
894 */
895enum mac80211_tx_status_flags {
896 IEEE80211_TX_STATUS_ACK_SIGNAL_VALID = BIT(0),
897};
898
Christian Lampartereb7d3062010-09-21 21:36:18 +0200899/*
900 * This definition is used as a mask to clear all temporary flags, which are
901 * set by the tx handlers for each transmission attempt by the mac80211 stack.
902 */
903#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
904 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
905 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
906 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
907 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
Johannes Berg02f2f1a2012-02-27 12:18:30 +0100908 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
Christian Lampartereb7d3062010-09-21 21:36:18 +0200909 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
Johannes Berg47086fc2011-09-29 16:04:33 +0200910 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
Christian Lampartereb7d3062010-09-21 21:36:18 +0200911
Sujith2134e7e2009-01-22 09:00:52 +0530912/**
913 * enum mac80211_rate_control_flags - per-rate flags set by the
914 * Rate Control algorithm.
915 *
916 * These flags are set by the Rate control algorithm for each rate during tx,
917 * in the @flags member of struct ieee80211_tx_rate.
918 *
919 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
920 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
921 * This is set if the current BSS requires ERP protection.
922 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
923 * @IEEE80211_TX_RC_MCS: HT rate.
Johannes Berg8bc83c22012-11-09 18:38:32 +0100924 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
925 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
Sujith2134e7e2009-01-22 09:00:52 +0530926 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
927 * Greenfield mode.
928 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
Johannes Berg8bc83c22012-11-09 18:38:32 +0100929 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
930 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
931 * (80+80 isn't supported yet)
Sujith2134e7e2009-01-22 09:00:52 +0530932 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
933 * adjacent 20 MHz channels, if the current channel type is
934 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
935 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
936 */
Johannes Berge6a98542008-10-21 12:40:02 +0200937enum mac80211_rate_control_flags {
938 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
939 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
940 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
941
Johannes Berg8bc83c22012-11-09 18:38:32 +0100942 /* rate index is an HT/VHT MCS instead of an index */
Johannes Berge6a98542008-10-21 12:40:02 +0200943 IEEE80211_TX_RC_MCS = BIT(3),
944 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
945 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
946 IEEE80211_TX_RC_DUP_DATA = BIT(6),
947 IEEE80211_TX_RC_SHORT_GI = BIT(7),
Johannes Berg8bc83c22012-11-09 18:38:32 +0100948 IEEE80211_TX_RC_VHT_MCS = BIT(8),
949 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
950 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
Ron Rindjunsky11f4b1ce2008-03-04 18:09:26 -0800951};
952
Johannes Berge039fa42008-05-15 12:55:29 +0200953
Johannes Berge6a98542008-10-21 12:40:02 +0200954/* there are 40 bytes if you don't need the rateset to be kept */
955#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
Johannes Berge039fa42008-05-15 12:55:29 +0200956
Johannes Berge6a98542008-10-21 12:40:02 +0200957/* if you do need the rateset, then you have less space */
958#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
959
960/* maximum number of rate stages */
Thomas Huehne3e1a0b2012-07-02 19:46:16 +0200961#define IEEE80211_TX_MAX_RATES 4
Felix Fietkau870abdf2008-10-05 18:04:24 +0200962
Felix Fietkau0d528d82013-04-22 16:14:41 +0200963/* maximum number of rate table entries */
964#define IEEE80211_TX_RATE_TABLE_SIZE 4
965
Felix Fietkau870abdf2008-10-05 18:04:24 +0200966/**
Johannes Berge6a98542008-10-21 12:40:02 +0200967 * struct ieee80211_tx_rate - rate selection/status
Felix Fietkau870abdf2008-10-05 18:04:24 +0200968 *
Johannes Berge6a98542008-10-21 12:40:02 +0200969 * @idx: rate index to attempt to send with
970 * @flags: rate control flags (&enum mac80211_rate_control_flags)
Johannes Berge25cf4a2008-10-23 08:51:20 +0200971 * @count: number of tries in this rate before going to the next rate
Johannes Berge6a98542008-10-21 12:40:02 +0200972 *
973 * A value of -1 for @idx indicates an invalid rate and, if used
974 * in an array of retry rates, that no more rates should be tried.
975 *
976 * When used for transmit status reporting, the driver should
977 * always report the rate along with the flags it used.
Johannes Bergc555b9b2009-08-07 16:23:43 +0200978 *
979 * &struct ieee80211_tx_info contains an array of these structs
980 * in the control information, and it will be filled by the rate
981 * control algorithm according to what should be sent. For example,
982 * if this array contains, in the format { <idx>, <count> } the
Jani Nikulab4f7f4a2016-10-21 15:57:23 +0300983 * information::
984 *
Johannes Bergc555b9b2009-08-07 16:23:43 +0200985 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
Jani Nikulab4f7f4a2016-10-21 15:57:23 +0300986 *
Johannes Bergc555b9b2009-08-07 16:23:43 +0200987 * then this means that the frame should be transmitted
988 * up to twice at rate 3, up to twice at rate 2, and up to four
989 * times at rate 1 if it doesn't get acknowledged. Say it gets
990 * acknowledged by the peer after the fifth attempt, the status
Jani Nikulab4f7f4a2016-10-21 15:57:23 +0300991 * information should then contain::
992 *
Johannes Bergc555b9b2009-08-07 16:23:43 +0200993 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
Jani Nikulab4f7f4a2016-10-21 15:57:23 +0300994 *
Johannes Bergc555b9b2009-08-07 16:23:43 +0200995 * since it was transmitted twice at rate 3, twice at rate 2
996 * and once at rate 1 after which we received an acknowledgement.
Felix Fietkau870abdf2008-10-05 18:04:24 +0200997 */
Johannes Berge6a98542008-10-21 12:40:02 +0200998struct ieee80211_tx_rate {
999 s8 idx;
Johannes Berg8bc83c22012-11-09 18:38:32 +01001000 u16 count:5,
1001 flags:11;
Gustavo F. Padovan3f30fc12010-07-21 10:59:58 +00001002} __packed;
Felix Fietkau870abdf2008-10-05 18:04:24 +02001003
Johannes Berg8bc83c22012-11-09 18:38:32 +01001004#define IEEE80211_MAX_TX_RETRY 31
1005
1006static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
1007 u8 mcs, u8 nss)
1008{
1009 WARN_ON(mcs & ~0xF);
Karl Beldan6bc83122013-04-15 17:09:29 +02001010 WARN_ON((nss - 1) & ~0x7);
1011 rate->idx = ((nss - 1) << 4) | mcs;
Johannes Berg8bc83c22012-11-09 18:38:32 +01001012}
1013
1014static inline u8
1015ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
1016{
1017 return rate->idx & 0xF;
1018}
1019
1020static inline u8
1021ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
1022{
Karl Beldan6bc83122013-04-15 17:09:29 +02001023 return (rate->idx >> 4) + 1;
Johannes Berg8bc83c22012-11-09 18:38:32 +01001024}
1025
Johannes Berge039fa42008-05-15 12:55:29 +02001026/**
1027 * struct ieee80211_tx_info - skb transmit information
Ivo van Doorn1c014422008-04-17 19:41:02 +02001028 *
Johannes Berge039fa42008-05-15 12:55:29 +02001029 * This structure is placed in skb->cb for three uses:
1030 * (1) mac80211 TX control - mac80211 tells the driver what to do
1031 * (2) driver internal use (if applicable)
1032 * (3) TX status information - driver tells mac80211 what happened
1033 *
1034 * @flags: transmit info flags, defined above
Johannes Berge6a98542008-10-21 12:40:02 +02001035 * @band: the band to transmit on (use for checking for races)
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001036 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
Johannes Berga729cff2011-11-06 14:13:34 +01001037 * @ack_frame_id: internal frame ID for TX status, used internally
Toke Høiland-Jørgensen6912dae2019-10-23 11:59:00 +02001038 * @tx_time_est: TX time estimate in units of 4us, used internally
Johannes Berg7d419462019-02-01 11:53:32 +01001039 * @control: union part for control data
1040 * @control.rates: TX rates array to try
1041 * @control.rts_cts_rate_idx: rate for RTS or CTS
1042 * @control.use_rts: use RTS
1043 * @control.use_cts_prot: use RTS/CTS
1044 * @control.short_preamble: use short preamble (CCK only)
1045 * @control.skip_table: skip externally configured rate table
1046 * @control.jiffies: timestamp for expiry on powersave clients
1047 * @control.vif: virtual interface (may be NULL)
1048 * @control.hw_key: key to encrypt with (may be NULL)
1049 * @control.flags: control flags, see &enum mac80211_tx_control_flags
1050 * @control.enqueue_time: enqueue time (for iTXQs)
1051 * @driver_rates: alias to @control.rates to reserve space
1052 * @pad: padding
1053 * @rate_driver_data: driver use area if driver needs @control.rates
1054 * @status: union part for status data
1055 * @status.rates: attempted rates
1056 * @status.ack_signal: ACK signal
1057 * @status.ampdu_ack_len: AMPDU ack length
1058 * @status.ampdu_len: AMPDU length
1059 * @status.antenna: (legacy, kept only for iwlegacy)
Felix Fietkauc74114d2020-09-08 14:36:55 +02001060 * @status.tx_time: airtime consumed for transmission; note this is only
1061 * used for WMM AC, not for airtime fairness
Avraham Sternea5907d2022-02-02 10:49:47 +02001062 * @status.flags: status flags, see &enum mac80211_tx_status_flags
Johannes Berg7d419462019-02-01 11:53:32 +01001063 * @status.status_driver_data: driver use area
1064 * @ack: union part for pure ACK data
1065 * @ack.cookie: cookie for the ACK
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001066 * @driver_data: array of driver_data pointers
Felix Fietkau599bf6a2009-11-15 23:07:30 +01001067 * @ampdu_ack_len: number of acked aggregated frames.
Daniel Halperin93d95b12010-04-18 09:28:18 -07001068 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
Felix Fietkau599bf6a2009-11-15 23:07:30 +01001069 * @ampdu_len: number of aggregated frames.
Daniel Halperin93d95b12010-04-18 09:28:18 -07001070 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
Johannes Berge039fa42008-05-15 12:55:29 +02001071 * @ack_signal: signal strength of the ACK frame
Ivo van Doorn1c014422008-04-17 19:41:02 +02001072 */
Johannes Berge039fa42008-05-15 12:55:29 +02001073struct ieee80211_tx_info {
1074 /* common information */
1075 u32 flags;
Johannes Bergf2b18ba2020-01-15 12:25:50 +01001076 u32 band:3,
1077 ack_frame_id:13,
1078 hw_queue:4,
1079 tx_time_est:10;
1080 /* 2 free bits */
Johannes Berg8318d782008-01-24 19:38:38 +01001081
Johannes Berge039fa42008-05-15 12:55:29 +02001082 union {
1083 struct {
Johannes Berge6a98542008-10-21 12:40:02 +02001084 union {
1085 /* rate control */
1086 struct {
1087 struct ieee80211_tx_rate rates[
1088 IEEE80211_TX_MAX_RATES];
1089 s8 rts_cts_rate_idx;
Felix Fietkau991fec02013-04-16 13:38:43 +02001090 u8 use_rts:1;
1091 u8 use_cts_prot:1;
Felix Fietkau0d528d82013-04-22 16:14:41 +02001092 u8 short_preamble:1;
1093 u8 skip_table:1;
Felix Fietkau991fec02013-04-16 13:38:43 +02001094 /* 2 bytes free */
Johannes Berge6a98542008-10-21 12:40:02 +02001095 };
1096 /* only needed before rate control */
1097 unsigned long jiffies;
1098 };
Johannes Berg25d834e2008-09-12 22:52:47 +02001099 /* NB: vif can be NULL for injected frames */
Johannes Berg53168212017-06-22 12:20:30 +02001100 struct ieee80211_vif *vif;
Johannes Berge039fa42008-05-15 12:55:29 +02001101 struct ieee80211_key_conf *hw_key;
Johannes Bergaf61a162013-07-02 18:09:12 +02001102 u32 flags;
Johannes Berg53168212017-06-22 12:20:30 +02001103 codel_time_t enqueue_time;
Johannes Berge039fa42008-05-15 12:55:29 +02001104 } control;
1105 struct {
Johannes Berg3b79af92015-06-01 23:14:59 +02001106 u64 cookie;
1107 } ack;
1108 struct {
Johannes Berge6a98542008-10-21 12:40:02 +02001109 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
Eliad Pellera0f995a2014-03-13 14:30:47 +02001110 s32 ack_signal;
Thomas Huehne3e1a0b2012-07-02 19:46:16 +02001111 u8 ampdu_ack_len;
Felix Fietkau599bf6a2009-11-15 23:07:30 +01001112 u8 ampdu_len;
Johannes Bergd748b462012-03-28 11:04:23 +02001113 u8 antenna;
Johannes Berg02219b32014-10-07 10:38:50 +03001114 u16 tx_time;
Avraham Sternea5907d2022-02-02 10:49:47 +02001115 u8 flags;
1116 void *status_driver_data[18 / sizeof(void *)];
Johannes Berge039fa42008-05-15 12:55:29 +02001117 } status;
Johannes Berge6a98542008-10-21 12:40:02 +02001118 struct {
1119 struct ieee80211_tx_rate driver_rates[
1120 IEEE80211_TX_MAX_RATES];
Felix Fietkau0d528d82013-04-22 16:14:41 +02001121 u8 pad[4];
1122
Johannes Berge6a98542008-10-21 12:40:02 +02001123 void *rate_driver_data[
1124 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
1125 };
1126 void *driver_data[
1127 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
Johannes Berge039fa42008-05-15 12:55:29 +02001128 };
Jiri Bencf0706e82007-05-05 11:45:53 -07001129};
1130
Toke Høiland-Jørgensen7a892332019-11-18 22:06:10 -08001131static inline u16
1132ieee80211_info_set_tx_time_est(struct ieee80211_tx_info *info, u16 tx_time_est)
1133{
1134 /* We only have 10 bits in tx_time_est, so store airtime
1135 * in increments of 4us and clamp the maximum to 2**12-1
1136 */
1137 info->tx_time_est = min_t(u16, tx_time_est, 4095) >> 2;
1138 return info->tx_time_est << 2;
1139}
1140
1141static inline u16
1142ieee80211_info_get_tx_time_est(struct ieee80211_tx_info *info)
1143{
1144 return info->tx_time_est << 2;
1145}
1146
Luciano Coelho79f460c2011-05-11 17:09:36 +03001147/**
Chris Packhamae4a50e2019-10-25 10:36:47 +13001148 * struct ieee80211_tx_status - extended tx status info for rate control
Felix Fietkau18fb84d2017-04-26 17:11:35 +02001149 *
1150 * @sta: Station that the packet was transmitted for
1151 * @info: Basic tx status information
1152 * @skb: Packet skb (can be NULL if not provided by the driver)
John Crispincbe77dd2019-07-14 17:44:14 +02001153 * @rate: The TX rate that was used when sending the packet
Felix Fietkauf02dff92020-09-08 14:37:00 +02001154 * @free_list: list where processed skbs are stored to be free'd by the driver
Felix Fietkau18fb84d2017-04-26 17:11:35 +02001155 */
1156struct ieee80211_tx_status {
1157 struct ieee80211_sta *sta;
1158 struct ieee80211_tx_info *info;
1159 struct sk_buff *skb;
John Crispincbe77dd2019-07-14 17:44:14 +02001160 struct rate_info *rate;
Felix Fietkauf02dff92020-09-08 14:37:00 +02001161 struct list_head *free_list;
Felix Fietkau18fb84d2017-04-26 17:11:35 +02001162};
1163
1164/**
David Spinadelc56ef672014-02-05 15:21:13 +02001165 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
1166 *
David Spinadel633e2712014-02-06 16:15:23 +02001167 * This structure is used to point to different blocks of IEs in HW scan
1168 * and scheduled scan. These blocks contain the IEs passed by userspace
1169 * and the ones generated by mac80211.
David Spinadelc56ef672014-02-05 15:21:13 +02001170 *
1171 * @ies: pointers to band specific IEs.
1172 * @len: lengths of band_specific IEs.
1173 * @common_ies: IEs for all bands (especially vendor specific ones)
1174 * @common_ie_len: length of the common_ies
1175 */
1176struct ieee80211_scan_ies {
Johannes Berg57fbcce2016-04-12 15:56:15 +02001177 const u8 *ies[NUM_NL80211_BANDS];
1178 size_t len[NUM_NL80211_BANDS];
David Spinadelc56ef672014-02-05 15:21:13 +02001179 const u8 *common_ies;
1180 size_t common_ie_len;
1181};
1182
1183
Johannes Berge039fa42008-05-15 12:55:29 +02001184static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
1185{
1186 return (struct ieee80211_tx_info *)skb->cb;
1187}
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001188
Johannes Bergf1d58c22009-06-17 13:13:00 +02001189static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
1190{
1191 return (struct ieee80211_rx_status *)skb->cb;
1192}
1193
Johannes Berge6a98542008-10-21 12:40:02 +02001194/**
1195 * ieee80211_tx_info_clear_status - clear TX status
1196 *
1197 * @info: The &struct ieee80211_tx_info to be cleared.
1198 *
1199 * When the driver passes an skb back to mac80211, it must report
1200 * a number of things in TX status. This function clears everything
1201 * in the TX status but the rate control information (it does clear
1202 * the count since you need to fill that in anyway).
1203 *
1204 * NOTE: You can only use this function if you do NOT use
1205 * info->driver_data! Use info->rate_driver_data
1206 * instead if you need only the less space that allows.
1207 */
1208static inline void
1209ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
1210{
1211 int i;
1212
1213 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
1214 offsetof(struct ieee80211_tx_info, control.rates));
1215 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
1216 offsetof(struct ieee80211_tx_info, driver_rates));
1217 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
1218 /* clear the rate counts */
1219 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
1220 info->status.rates[i].count = 0;
Kees Cookfb5f6a02021-11-18 12:38:39 -08001221 memset_after(&info->status, 0, rates);
Johannes Berge6a98542008-10-21 12:40:02 +02001222}
1223
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001224
1225/**
1226 * enum mac80211_rx_flags - receive flags
1227 *
1228 * These flags are used with the @flag member of &struct ieee80211_rx_status.
1229 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
1230 * Use together with %RX_FLAG_MMIC_STRIPPED.
1231 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001232 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
1233 * verification has been done by the hardware.
David Spinadelcef0acd2016-11-21 16:58:40 +02001234 * @RX_FLAG_IV_STRIPPED: The IV and ICV are stripped from this frame.
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001235 * If this flag is set, the stack cannot do any replay detection
1236 * hence the driver or hardware will have to do that.
Johannes Berg981d94a2015-06-12 14:39:02 +02001237 * @RX_FLAG_PN_VALIDATED: Currently only valid for CCMP/GCMP frames, this
1238 * flag indicates that the PN was verified for replay protection.
1239 * Note that this flag is also currently only supported when a frame
1240 * is also decrypted (ie. @RX_FLAG_DECRYPTED must be set)
Luis de Bethencourt84ea3a182016-03-18 16:09:29 +00001241 * @RX_FLAG_DUP_VALIDATED: The driver should set this flag if it did
1242 * de-duplication by itself.
Johannes Berg72abd812007-09-17 01:29:22 -04001243 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
1244 * the frame.
1245 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
1246 * the frame.
Thomas Pedersenf4bda332012-11-13 10:46:27 -08001247 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
Johannes Berg6ebacbb2011-02-23 15:06:08 +01001248 * field) is valid and contains the time the first symbol of the MPDU
1249 * was received. This is useful in monitor mode and for proper IBSS
1250 * merging.
Thomas Pedersenf4bda332012-11-13 10:46:27 -08001251 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
1252 * field) is valid and contains the time the last symbol of the MPDU
1253 * (including FCS) was received.
Johannes Bergf4a0f0c2016-01-25 15:46:34 +02001254 * @RX_FLAG_MACTIME_PLCP_START: The timestamp passed in the RX status (@mactime
1255 * field) is valid and contains the time the SYNC preamble was received.
Felix Fietkaufe8431f2012-03-01 18:00:07 +01001256 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
1257 * Valid only for data frames (mainly A-MPDU)
Johannes Berg4c298672012-07-05 11:34:31 +02001258 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
1259 * number (@ampdu_reference) must be populated and be a distinct number for
1260 * each A-MPDU
Johannes Berg4c298672012-07-05 11:34:31 +02001261 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
1262 * subframes of a single A-MPDU
1263 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
1264 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
1265 * on this subframe
1266 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
1267 * is stored in the @ampdu_delimiter_crc field)
Sara Sharonf980ebc2016-02-24 11:49:45 +02001268 * @RX_FLAG_MIC_STRIPPED: The mic was stripped of this packet. Decryption was
1269 * done by the hardware
Grzegorz Bajorski17883042015-12-11 14:39:46 +01001270 * @RX_FLAG_ONLY_MONITOR: Report frame only to monitor interfaces without
1271 * processing it in any regular way.
1272 * This is useful if drivers offload some frames but still want to report
1273 * them for sniffing purposes.
1274 * @RX_FLAG_SKIP_MONITOR: Process and report frame to all interfaces except
1275 * monitor interfaces.
1276 * This is useful if drivers offload some frames but still want to report
1277 * them for sniffing purposes.
Michal Kazior0cfcefe2013-09-23 15:34:38 +02001278 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
1279 * subframes instead of a one huge frame for performance reasons.
1280 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
1281 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
1282 * the 3rd (last) one must not have this flag set. The flag is used to
1283 * deal with retransmission/duplication recovery properly since A-MSDU
1284 * subframes share the same sequence number. Reported subframes can be
1285 * either regular MSDU or singly A-MSDUs. Subframes must not be
1286 * interleaved with other frames.
Johannes Berg1f7bba72014-11-06 22:56:36 +01001287 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific
1288 * radiotap data in the skb->data (before the frame) as described by
1289 * the &struct ieee80211_vendor_radiotap.
Sara Sharonf631a772016-05-03 15:59:44 +03001290 * @RX_FLAG_ALLOW_SAME_PN: Allow the same PN as same packet before.
1291 * This is used for AMSDU subframes which can have the same PN as
1292 * the first subframe.
David Spinadelcef0acd2016-11-21 16:58:40 +02001293 * @RX_FLAG_ICV_STRIPPED: The ICV is stripped from this frame. CRC checking must
1294 * be done in the hardware.
Johannes Berg7299d6f2018-02-19 14:48:39 +02001295 * @RX_FLAG_AMPDU_EOF_BIT: Value of the EOF bit in the A-MPDU delimiter for this
1296 * frame
1297 * @RX_FLAG_AMPDU_EOF_BIT_KNOWN: The EOF value is known
Luca Coelho41cbb0f2018-06-09 09:14:44 +03001298 * @RX_FLAG_RADIOTAP_HE: HE radiotap data is present
1299 * (&struct ieee80211_radiotap_he, mac80211 will fill in
Johannes Berg7d419462019-02-01 11:53:32 +01001300 *
Luca Coelho41cbb0f2018-06-09 09:14:44 +03001301 * - DATA3_DATA_MCS
1302 * - DATA3_DATA_DCM
1303 * - DATA3_CODING
1304 * - DATA5_GI
1305 * - DATA5_DATA_BW_RU_ALLOC
1306 * - DATA6_NSTS
1307 * - DATA3_STBC
Johannes Berg7d419462019-02-01 11:53:32 +01001308 *
Luca Coelho41cbb0f2018-06-09 09:14:44 +03001309 * from the RX info data, so leave those zeroed when building this data)
1310 * @RX_FLAG_RADIOTAP_HE_MU: HE MU radiotap data is present
1311 * (&struct ieee80211_radiotap_he_mu)
Shaul Triebitzd1332e72018-08-31 11:31:20 +03001312 * @RX_FLAG_RADIOTAP_LSIG: L-SIG radiotap data is present
Shaul Triebitzc3d1f872018-09-05 08:06:06 +03001313 * @RX_FLAG_NO_PSDU: use the frame only for radiotap reporting, with
1314 * the "0-length PSDU" field included there. The value for it is
1315 * in &struct ieee80211_rx_status. Note that if this value isn't
1316 * known the frame shouldn't be reported.
Felix Fietkau80a915e2020-12-18 19:47:18 +01001317 * @RX_FLAG_8023: the frame has an 802.3 header (decap offload performed by
1318 * hardware or driver)
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001319 */
1320enum mac80211_rx_flags {
Johannes Berg4c298672012-07-05 11:34:31 +02001321 RX_FLAG_MMIC_ERROR = BIT(0),
1322 RX_FLAG_DECRYPTED = BIT(1),
Johannes Bergf4a0f0c2016-01-25 15:46:34 +02001323 RX_FLAG_MACTIME_PLCP_START = BIT(2),
Johannes Berg4c298672012-07-05 11:34:31 +02001324 RX_FLAG_MMIC_STRIPPED = BIT(3),
1325 RX_FLAG_IV_STRIPPED = BIT(4),
1326 RX_FLAG_FAILED_FCS_CRC = BIT(5),
1327 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
Thomas Pedersenf4bda332012-11-13 10:46:27 -08001328 RX_FLAG_MACTIME_START = BIT(7),
Johannes Berg7fdd69c2017-04-26 11:13:00 +02001329 RX_FLAG_NO_SIGNAL_VAL = BIT(8),
1330 RX_FLAG_AMPDU_DETAILS = BIT(9),
1331 RX_FLAG_PN_VALIDATED = BIT(10),
1332 RX_FLAG_DUP_VALIDATED = BIT(11),
1333 RX_FLAG_AMPDU_LAST_KNOWN = BIT(12),
1334 RX_FLAG_AMPDU_IS_LAST = BIT(13),
1335 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(14),
1336 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(15),
1337 RX_FLAG_MACTIME_END = BIT(16),
1338 RX_FLAG_ONLY_MONITOR = BIT(17),
1339 RX_FLAG_SKIP_MONITOR = BIT(18),
1340 RX_FLAG_AMSDU_MORE = BIT(19),
1341 RX_FLAG_RADIOTAP_VENDOR_DATA = BIT(20),
1342 RX_FLAG_MIC_STRIPPED = BIT(21),
1343 RX_FLAG_ALLOW_SAME_PN = BIT(22),
1344 RX_FLAG_ICV_STRIPPED = BIT(23),
Johannes Berg7299d6f2018-02-19 14:48:39 +02001345 RX_FLAG_AMPDU_EOF_BIT = BIT(24),
1346 RX_FLAG_AMPDU_EOF_BIT_KNOWN = BIT(25),
Luca Coelho41cbb0f2018-06-09 09:14:44 +03001347 RX_FLAG_RADIOTAP_HE = BIT(26),
1348 RX_FLAG_RADIOTAP_HE_MU = BIT(27),
Shaul Triebitzd1332e72018-08-31 11:31:20 +03001349 RX_FLAG_RADIOTAP_LSIG = BIT(28),
Shaul Triebitzc3d1f872018-09-05 08:06:06 +03001350 RX_FLAG_NO_PSDU = BIT(29),
Felix Fietkau80a915e2020-12-18 19:47:18 +01001351 RX_FLAG_8023 = BIT(30),
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001352};
1353
1354/**
Johannes Berg7fdd69c2017-04-26 11:13:00 +02001355 * enum mac80211_rx_encoding_flags - MCS & bandwidth flags
Emmanuel Grumbach1b8d2422014-02-05 16:37:11 +02001356 *
Johannes Berg7fdd69c2017-04-26 11:13:00 +02001357 * @RX_ENC_FLAG_SHORTPRE: Short preamble was used for this frame
Johannes Berg7fdd69c2017-04-26 11:13:00 +02001358 * @RX_ENC_FLAG_SHORT_GI: Short guard interval was used
1359 * @RX_ENC_FLAG_HT_GF: This frame was received in a HT-greenfield transmission,
1360 * if the driver fills this value it should add
1361 * %IEEE80211_RADIOTAP_MCS_HAVE_FMT
Johannes Berg7d419462019-02-01 11:53:32 +01001362 * to @hw.radiotap_mcs_details to advertise that fact.
Johannes Berg7fdd69c2017-04-26 11:13:00 +02001363 * @RX_ENC_FLAG_LDPC: LDPC was used
1364 * @RX_ENC_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
Johannes Berg7fdd69c2017-04-26 11:13:00 +02001365 * @RX_ENC_FLAG_BF: packet was beamformed
Emmanuel Grumbach1b8d2422014-02-05 16:37:11 +02001366 */
Johannes Berg7fdd69c2017-04-26 11:13:00 +02001367enum mac80211_rx_encoding_flags {
1368 RX_ENC_FLAG_SHORTPRE = BIT(0),
Johannes Bergda6a4352017-04-26 12:14:59 +02001369 RX_ENC_FLAG_SHORT_GI = BIT(2),
1370 RX_ENC_FLAG_HT_GF = BIT(3),
1371 RX_ENC_FLAG_STBC_MASK = BIT(4) | BIT(5),
1372 RX_ENC_FLAG_LDPC = BIT(6),
1373 RX_ENC_FLAG_BF = BIT(7),
Emmanuel Grumbach1b8d2422014-02-05 16:37:11 +02001374};
1375
Johannes Bergda6a4352017-04-26 12:14:59 +02001376#define RX_ENC_FLAG_STBC_SHIFT 4
1377
1378enum mac80211_rx_encoding {
1379 RX_ENC_LEGACY = 0,
1380 RX_ENC_HT,
1381 RX_ENC_VHT,
Luca Coelho41cbb0f2018-06-09 09:14:44 +03001382 RX_ENC_HE,
Johannes Bergda6a4352017-04-26 12:14:59 +02001383};
Johannes Berg7fdd69c2017-04-26 11:13:00 +02001384
Emmanuel Grumbach1b8d2422014-02-05 16:37:11 +02001385/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001386 * struct ieee80211_rx_status - receive status
1387 *
1388 * The low-level driver should provide this information (the subset
1389 * supported by hardware) to the 802.11 code with each received
Johannes Bergf1d58c22009-06-17 13:13:00 +02001390 * frame, in the skb's control buffer (cb).
Bruno Randolf566bfe52008-05-08 19:15:40 +02001391 *
Bruno Randolfc132bec2008-02-18 11:20:51 +09001392 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
1393 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
Johannes Berg162dd6a2016-02-23 23:05:06 +02001394 * @boottime_ns: CLOCK_BOOTTIME timestamp the frame was received at, this is
1395 * needed only for beacons and probe responses that update the scan cache.
Johannes Berg8c358bc2012-05-22 22:13:05 +02001396 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
1397 * it but can store it and pass it back to the driver for synchronisation
Johannes Berg8318d782008-01-24 19:38:38 +01001398 * @band: the active band when this frame was received
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001399 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
Johannes Berg4352a4d2015-12-08 16:04:35 +02001400 * This field must be set for management frames, but isn't strictly needed
1401 * for data (other) frames - for those it only affects radiotap reporting.
Thomas Pedersen3b23c1842020-04-01 18:18:05 -07001402 * @freq_offset: @freq has a positive offset of 500Khz.
Bruno Randolf566bfe52008-05-08 19:15:40 +02001403 * @signal: signal strength when receiving this frame, either in dBm, in dB or
1404 * unspecified depending on the hardware capabilities flags
1405 * @IEEE80211_HW_SIGNAL_*
Felix Fietkauef0621e2013-04-22 16:29:31 +02001406 * @chains: bitmask of receive chains for which separate signal strength
1407 * values were filled.
1408 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
1409 * support dB or unspecified units)
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001410 * @antenna: antenna used
Jouni Malinen0fb8ca42008-12-12 14:38:33 +02001411 * @rate_idx: index of data rate into band's supported rates or MCS index if
Johannes Berg56146182012-11-09 15:07:02 +01001412 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
Johannes Berg8613c942017-04-26 13:51:41 +02001413 * @nss: number of streams (VHT and HE only)
Jani Nikulab4f7f4a2016-10-21 15:57:23 +03001414 * @flag: %RX_FLAG_\*
Johannes Bergda6a4352017-04-26 12:14:59 +02001415 * @encoding: &enum mac80211_rx_encoding
1416 * @bw: &enum rate_info_bw
Johannes Berg7fdd69c2017-04-26 11:13:00 +02001417 * @enc_flags: uses bits from &enum mac80211_rx_encoding_flags
Luca Coelho41cbb0f2018-06-09 09:14:44 +03001418 * @he_ru: HE RU, from &enum nl80211_he_ru_alloc
1419 * @he_gi: HE GI, from &enum nl80211_he_gi
1420 * @he_dcm: HE DCM value
Johannes Berg554891e2010-09-24 12:38:25 +02001421 * @rx_flags: internal RX flags for mac80211
Johannes Berg4c298672012-07-05 11:34:31 +02001422 * @ampdu_reference: A-MPDU reference number, must be a different value for
1423 * each A-MPDU but the same for each subframe within one A-MPDU
1424 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
Shaul Triebitzc3d1f872018-09-05 08:06:06 +03001425 * @zero_length_psdu_type: radiotap type of the 0-length PSDU
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001426 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001427struct ieee80211_rx_status {
1428 u64 mactime;
Johannes Berg162dd6a2016-02-23 23:05:06 +02001429 u64 boottime_ns;
Johannes Berg8c358bc2012-05-22 22:13:05 +02001430 u32 device_timestamp;
Johannes Berg4c298672012-07-05 11:34:31 +02001431 u32 ampdu_reference;
Johannes Berg7fdd69c2017-04-26 11:13:00 +02001432 u32 flag;
Thomas Pedersen3b23c1842020-04-01 18:18:05 -07001433 u16 freq: 13, freq_offset: 1;
Johannes Bergda6a4352017-04-26 12:14:59 +02001434 u8 enc_flags;
Luca Coelho41cbb0f2018-06-09 09:14:44 +03001435 u8 encoding:2, bw:3, he_ru:3;
1436 u8 he_gi:2, he_dcm:1;
Johannes Berg30f42292012-07-05 13:14:18 +02001437 u8 rate_idx;
Johannes Berg8613c942017-04-26 13:51:41 +02001438 u8 nss;
Johannes Berg30f42292012-07-05 13:14:18 +02001439 u8 rx_flags;
1440 u8 band;
1441 u8 antenna;
1442 s8 signal;
Felix Fietkauef0621e2013-04-22 16:29:31 +02001443 u8 chains;
1444 s8 chain_signal[IEEE80211_MAX_CHAINS];
Johannes Berg4c298672012-07-05 11:34:31 +02001445 u8 ampdu_delimiter_crc;
Shaul Triebitzc3d1f872018-09-05 08:06:06 +03001446 u8 zero_length_psdu_type;
Jiri Bencf0706e82007-05-05 11:45:53 -07001447};
1448
Thomas Pedersen3b23c1842020-04-01 18:18:05 -07001449static inline u32
1450ieee80211_rx_status_to_khz(struct ieee80211_rx_status *rx_status)
1451{
1452 return MHZ_TO_KHZ(rx_status->freq) +
1453 (rx_status->freq_offset ? 500 : 0);
1454}
1455
Johannes Berg6b301cd2007-09-18 17:29:20 -04001456/**
Johannes Berg1f7bba72014-11-06 22:56:36 +01001457 * struct ieee80211_vendor_radiotap - vendor radiotap data information
1458 * @present: presence bitmap for this vendor namespace
1459 * (this could be extended in the future if any vendor needs more
1460 * bits, the radiotap spec does allow for that)
1461 * @align: radiotap vendor namespace alignment. This defines the needed
1462 * alignment for the @data field below, not for the vendor namespace
1463 * description itself (which has a fixed 2-byte alignment)
1464 * Must be a power of two, and be set to at least 1!
1465 * @oui: radiotap vendor namespace OUI
1466 * @subns: radiotap vendor sub namespace
1467 * @len: radiotap vendor sub namespace skip length, if alignment is done
1468 * then that's added to this, i.e. this is only the length of the
1469 * @data field.
1470 * @pad: number of bytes of padding after the @data, this exists so that
1471 * the skb data alignment can be preserved even if the data has odd
1472 * length
1473 * @data: the actual vendor namespace data
1474 *
1475 * This struct, including the vendor data, goes into the skb->data before
1476 * the 802.11 header. It's split up in mac80211 using the align/oui/subns
1477 * data.
1478 */
1479struct ieee80211_vendor_radiotap {
1480 u32 present;
1481 u8 align;
1482 u8 oui[3];
1483 u8 subns;
1484 u8 pad;
1485 u16 len;
1486 u8 data[];
1487} __packed;
1488
1489/**
Johannes Berg6b301cd2007-09-18 17:29:20 -04001490 * enum ieee80211_conf_flags - configuration flags
1491 *
1492 * Flags to define PHY configuration options
1493 *
Johannes Berg0869aea02009-10-28 10:03:35 +01001494 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1495 * to determine for example whether to calculate timestamps for packets
1496 * or not, do not use instead of filter flags!
Kalle Valoc99445b2010-01-14 13:09:21 +02001497 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1498 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1499 * meaning that the hardware still wakes up for beacons, is able to
1500 * transmit frames and receive the possible acknowledgment frames.
1501 * Not to be confused with hardware specific wakeup/sleep states,
1502 * driver is responsible for that. See the section "Powersave support"
1503 * for more.
Johannes Berg5cff20e2009-04-29 12:26:17 +02001504 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1505 * the driver should be prepared to handle configuration requests but
1506 * may turn the device off as much as possible. Typically, this flag will
1507 * be set when an interface is set UP but not associated or scanning, but
1508 * it can also be unset in that case when monitor interfaces are active.
Felix Fietkau45521242010-07-28 02:40:49 +02001509 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1510 * operating channel.
Johannes Berg6b301cd2007-09-18 17:29:20 -04001511 */
1512enum ieee80211_conf_flags {
Johannes Berg0869aea02009-10-28 10:03:35 +01001513 IEEE80211_CONF_MONITOR = (1<<0),
Johannes Bergae5eb022008-10-14 16:58:37 +02001514 IEEE80211_CONF_PS = (1<<1),
Johannes Berg5cff20e2009-04-29 12:26:17 +02001515 IEEE80211_CONF_IDLE = (1<<2),
Felix Fietkau45521242010-07-28 02:40:49 +02001516 IEEE80211_CONF_OFFCHANNEL = (1<<3),
Johannes Berg6b301cd2007-09-18 17:29:20 -04001517};
Jiri Bencf0706e82007-05-05 11:45:53 -07001518
Johannes Berg7a5158e2008-10-08 10:59:33 +02001519
Jiri Bencf0706e82007-05-05 11:45:53 -07001520/**
Johannes Berge8975582008-10-09 12:18:51 +02001521 * enum ieee80211_conf_changed - denotes which configuration changed
1522 *
Johannes Berge8975582008-10-09 12:18:51 +02001523 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
Johannes Berg0869aea02009-10-28 10:03:35 +01001524 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
Johannes Berge255d5e2009-04-22 12:40:07 +02001525 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
Johannes Berge8975582008-10-09 12:18:51 +02001526 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
Johannes Berg47979382009-01-07 10:13:27 +01001527 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
Johannes Berg9124b072008-10-14 19:17:54 +02001528 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
Johannes Berg5cff20e2009-04-29 12:26:17 +02001529 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
Johannes Berg0f782312009-12-01 13:37:02 +01001530 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
Johannes Berg04ecd252012-09-11 14:34:12 +02001531 * Note that this is only valid if channel contexts are not used,
1532 * otherwise each channel context has the number of chains listed.
Johannes Berge8975582008-10-09 12:18:51 +02001533 */
1534enum ieee80211_conf_changed {
Johannes Berg0f782312009-12-01 13:37:02 +01001535 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
Johannes Berge8975582008-10-09 12:18:51 +02001536 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
Johannes Berg0869aea02009-10-28 10:03:35 +01001537 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
Johannes Berge8975582008-10-09 12:18:51 +02001538 IEEE80211_CONF_CHANGE_PS = BIT(4),
Johannes Berge255d5e2009-04-22 12:40:07 +02001539 IEEE80211_CONF_CHANGE_POWER = BIT(5),
1540 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
1541 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
Johannes Berg5cff20e2009-04-29 12:26:17 +02001542 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
Johannes Berge8975582008-10-09 12:18:51 +02001543};
1544
1545/**
Johannes Berg0f782312009-12-01 13:37:02 +01001546 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1547 *
Kalle Valo9d173fc2010-01-14 13:09:14 +02001548 * @IEEE80211_SMPS_AUTOMATIC: automatic
1549 * @IEEE80211_SMPS_OFF: off
1550 * @IEEE80211_SMPS_STATIC: static
1551 * @IEEE80211_SMPS_DYNAMIC: dynamic
1552 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
Johannes Berg0f782312009-12-01 13:37:02 +01001553 */
1554enum ieee80211_smps_mode {
1555 IEEE80211_SMPS_AUTOMATIC,
1556 IEEE80211_SMPS_OFF,
1557 IEEE80211_SMPS_STATIC,
1558 IEEE80211_SMPS_DYNAMIC,
1559
1560 /* keep last */
1561 IEEE80211_SMPS_NUM_MODES,
1562};
1563
1564/**
Jiri Bencf0706e82007-05-05 11:45:53 -07001565 * struct ieee80211_conf - configuration of the device
1566 *
1567 * This struct indicates how the driver shall configure the hardware.
1568 *
Johannes Berg04fe2032009-04-22 18:44:37 +02001569 * @flags: configuration flags defined above
1570 *
Tomas Winklerea95bba2008-07-18 13:53:00 +08001571 * @listen_interval: listen interval in units of beacon interval
Johannes Berg56007a02010-01-26 14:19:52 +01001572 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1573 * in power saving. Power saving will not be enabled until a beacon
1574 * has been received and the DTIM period is known.
Johannes Berg04fe2032009-04-22 18:44:37 +02001575 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1576 * powersave documentation below. This variable is valid only when
1577 * the CONF_PS flag is set.
1578 *
Johannes Berg1ea6f9c2012-10-24 10:59:25 +02001579 * @power_level: requested transmit power (in dBm), backward compatibility
1580 * value only that is set to the minimum of all interfaces
Johannes Berg04fe2032009-04-22 18:44:37 +02001581 *
Karl Beldan675a0b02013-03-25 16:26:57 +01001582 * @chandef: the channel definition to tune to
Simon Wunderlich164eb022013-02-08 18:16:20 +01001583 * @radar_enabled: whether radar detection is enabled
Johannes Berg04fe2032009-04-22 18:44:37 +02001584 *
Johannes Berg9124b072008-10-14 19:17:54 +02001585 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
Johannes Bergad24b0d2013-07-05 11:53:28 +02001586 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1587 * but actually means the number of transmissions not the number of retries
Johannes Berg9124b072008-10-14 19:17:54 +02001588 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
Johannes Bergad24b0d2013-07-05 11:53:28 +02001589 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1590 * number of transmissions not the number of retries
Johannes Berg0f782312009-12-01 13:37:02 +01001591 *
1592 * @smps_mode: spatial multiplexing powersave mode; note that
1593 * %IEEE80211_SMPS_STATIC is used when the device is not
Johannes Berg04ecd252012-09-11 14:34:12 +02001594 * configured for an HT channel.
1595 * Note that this is only valid if channel contexts are not used,
1596 * otherwise each channel context has the number of chains listed.
Jiri Bencf0706e82007-05-05 11:45:53 -07001597 */
1598struct ieee80211_conf {
Johannes Berg6b301cd2007-09-18 17:29:20 -04001599 u32 flags;
Juuso Oikarinenff616382010-06-09 09:51:52 +03001600 int power_level, dynamic_ps_timeout;
Ron Rindjunsky10816d42007-11-26 16:14:30 +02001601
Johannes Berge8975582008-10-09 12:18:51 +02001602 u16 listen_interval;
Johannes Berg56007a02010-01-26 14:19:52 +01001603 u8 ps_dtim_period;
Johannes Berge8975582008-10-09 12:18:51 +02001604
Johannes Berg9124b072008-10-14 19:17:54 +02001605 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1606
Karl Beldan675a0b02013-03-25 16:26:57 +01001607 struct cfg80211_chan_def chandef;
Simon Wunderlich164eb022013-02-08 18:16:20 +01001608 bool radar_enabled;
Johannes Berg0f782312009-12-01 13:37:02 +01001609 enum ieee80211_smps_mode smps_mode;
Jiri Bencf0706e82007-05-05 11:45:53 -07001610};
1611
1612/**
Johannes Berg5ce6e432010-05-11 16:20:57 +02001613 * struct ieee80211_channel_switch - holds the channel switch data
1614 *
1615 * The information provided in this structure is required for channel switch
1616 * operation.
1617 *
1618 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1619 * Function (TSF) timer when the frame containing the channel switch
1620 * announcement was received. This is simply the rx.mactime parameter
1621 * the driver passed into mac80211.
Luciano Coelho2ba45382014-10-08 09:48:35 +03001622 * @device_timestamp: arbitrary timestamp for the device, this is the
1623 * rx.device_timestamp parameter the driver passed to mac80211.
Johannes Berg5ce6e432010-05-11 16:20:57 +02001624 * @block_tx: Indicates whether transmission must be blocked before the
1625 * scheduled channel switch, as indicated by the AP.
Johannes Berg85220d72013-03-25 18:29:27 +01001626 * @chandef: the new channel to switch to
Johannes Berg5ce6e432010-05-11 16:20:57 +02001627 * @count: the number of TBTT's until the channel switch event
Sara Sharonee145772019-02-06 13:17:09 +02001628 * @delay: maximum delay between the time the AP transmitted the last beacon in
1629 * current channel and the expected time of the first beacon in the new
1630 * channel, expressed in TU.
Johannes Berg5ce6e432010-05-11 16:20:57 +02001631 */
1632struct ieee80211_channel_switch {
1633 u64 timestamp;
Luciano Coelho2ba45382014-10-08 09:48:35 +03001634 u32 device_timestamp;
Johannes Berg5ce6e432010-05-11 16:20:57 +02001635 bool block_tx;
Johannes Berg85220d72013-03-25 18:29:27 +01001636 struct cfg80211_chan_def chandef;
Johannes Berg5ce6e432010-05-11 16:20:57 +02001637 u8 count;
Sara Sharonee145772019-02-06 13:17:09 +02001638 u32 delay;
Johannes Berg5ce6e432010-05-11 16:20:57 +02001639};
1640
1641/**
Johannes Bergc1288b12012-01-19 09:29:57 +01001642 * enum ieee80211_vif_flags - virtual interface flags
1643 *
1644 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1645 * on this virtual interface to avoid unnecessary CPU wakeups
Johannes Bergea086352012-01-19 09:29:58 +01001646 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1647 * monitoring on this virtual interface -- i.e. it can monitor
1648 * connection quality related parameters, such as the RSSI level and
1649 * provide notifications if configured trigger levels are reached.
Johannes Berg848955c2014-11-11 12:48:42 +01001650 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this
1651 * interface. This flag should be set during interface addition,
1652 * but may be set/cleared as late as authentication to an AP. It is
1653 * only valid for managed/station mode interfaces.
Janusz.Dziedzic@tieto.comb115b972015-10-27 08:38:40 +01001654 * @IEEE80211_VIF_GET_NOA_UPDATE: request to handle NOA attributes
1655 * and send P2P_PS notification to the driver if NOA changed, even
1656 * this is not pure P2P vif.
Johannes Bergc1288b12012-01-19 09:29:57 +01001657 */
1658enum ieee80211_vif_flags {
1659 IEEE80211_VIF_BEACON_FILTER = BIT(0),
Johannes Bergea086352012-01-19 09:29:58 +01001660 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
Johannes Berg848955c2014-11-11 12:48:42 +01001661 IEEE80211_VIF_SUPPORTS_UAPSD = BIT(2),
Janusz.Dziedzic@tieto.comb115b972015-10-27 08:38:40 +01001662 IEEE80211_VIF_GET_NOA_UPDATE = BIT(3),
Johannes Bergc1288b12012-01-19 09:29:57 +01001663};
1664
Felix Fietkau6aea26c2020-09-08 14:36:53 +02001665
1666/**
1667 * enum ieee80211_offload_flags - virtual interface offload flags
1668 *
1669 * @IEEE80211_OFFLOAD_ENCAP_ENABLED: tx encapsulation offload is enabled
1670 * The driver supports sending frames passed as 802.3 frames by mac80211.
1671 * It must also support sending 802.11 packets for the same interface.
1672 * @IEEE80211_OFFLOAD_ENCAP_4ADDR: support 4-address mode encapsulation offload
Felix Fietkau80a915e2020-12-18 19:47:18 +01001673 * @IEEE80211_OFFLOAD_DECAP_ENABLED: rx encapsulation offload is enabled
1674 * The driver supports passing received 802.11 frames as 802.3 frames to
1675 * mac80211.
Felix Fietkau6aea26c2020-09-08 14:36:53 +02001676 */
1677
1678enum ieee80211_offload_flags {
1679 IEEE80211_OFFLOAD_ENCAP_ENABLED = BIT(0),
1680 IEEE80211_OFFLOAD_ENCAP_4ADDR = BIT(1),
Felix Fietkau80a915e2020-12-18 19:47:18 +01001681 IEEE80211_OFFLOAD_DECAP_ENABLED = BIT(2),
Felix Fietkau6aea26c2020-09-08 14:36:53 +02001682};
1683
Johannes Bergc1288b12012-01-19 09:29:57 +01001684/**
Johannes Berg32bfd352007-12-19 01:31:26 +01001685 * struct ieee80211_vif - per-interface data
1686 *
1687 * Data in this structure is continually present for driver
1688 * use during the life of a virtual interface.
1689 *
Johannes Berg51fb61e2007-12-19 01:31:27 +01001690 * @type: type of this virtual interface
Johannes Bergbda39332008-10-11 01:51:51 +02001691 * @bss_conf: BSS configuration for this interface, either our own
1692 * or the BSS we're associated to
Johannes Berg47846c92009-11-25 17:46:19 +01001693 * @addr: address of this interface
Johannes Berg2ca27bc2010-09-16 14:58:23 +02001694 * @p2p: indicates whether this AP or STA interface is a p2p
1695 * interface, i.e. a GO or p2p-sta respectively
Michal Kazior59af6922014-04-09 15:10:59 +02001696 * @csa_active: marks whether a channel switch is going on. Internally it is
1697 * write-protected by sdata_lock and local->mtx so holding either is fine
1698 * for read access.
Sara Sharonb5a33d52016-02-16 12:48:18 +02001699 * @mu_mimo_owner: indicates interface owns MU-MIMO capability
Johannes Bergc1288b12012-01-19 09:29:57 +01001700 * @driver_flags: flags/capabilities the driver has for this interface,
1701 * these need to be set (or cleared) when the interface is added
1702 * or, if supported by the driver, the interface type is changed
1703 * at runtime, mac80211 will never touch this field
Felix Fietkau6aea26c2020-09-08 14:36:53 +02001704 * @offloaad_flags: hardware offload capabilities/flags for this interface.
1705 * These are initialized by mac80211 before calling .add_interface,
1706 * .change_interface or .update_vif_offload and updated by the driver
1707 * within these ops, based on supported features or runtime change
1708 * restrictions.
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001709 * @hw_queue: hardware queue for each AC
1710 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
Michal Kaziord01a1e62012-06-26 14:37:16 +02001711 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1712 * when it is not assigned. This pointer is RCU-protected due to the TX
1713 * path needing to access it; even though the netdev carrier will always
1714 * be off when it is %NULL there can still be races and packets could be
1715 * processed after it switches back to %NULL.
Stanislaw Gruszkaddbfe862013-03-08 14:46:14 +01001716 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
Johannes Bergad24b0d2013-07-05 11:53:28 +02001717 * interface debug files. Note that it will be NULL for the virtual
Stanislaw Gruszkaddbfe862013-03-08 14:46:14 +01001718 * monitor interface (if that is requested.)
Andrei Otcheretianski1b09b552015-08-15 22:39:50 +03001719 * @probe_req_reg: probe requests should be reported to mac80211 for this
1720 * interface.
Jouni Malinen873b1cf2020-04-21 17:48:15 +03001721 * @rx_mcast_action_reg: multicast Action frames should be reported to mac80211
1722 * for this interface.
Johannes Berg32bfd352007-12-19 01:31:26 +01001723 * @drv_priv: data area for driver use, will always be aligned to
Jani Nikulab4f7f4a2016-10-21 15:57:23 +03001724 * sizeof(void \*).
Felix Fietkauba8c3d62015-03-27 21:30:37 +01001725 * @txq: the multicast data TX queue (if driver uses the TXQ abstraction)
Manikanta Pubbisetty21a5d4c2018-07-11 00:12:53 +05301726 * @txqs_stopped: per AC flag to indicate that intermediate TXQs are stopped,
1727 * protected by fq->lock.
Johannes Berg7fba53e2020-09-18 13:21:16 +02001728 * @offload_flags: 802.3 -> 802.11 enapsulation offload flags, see
1729 * &enum ieee80211_offload_flags.
John Crispin5f9404a2021-07-02 19:44:08 +02001730 * @color_change_active: marks whether a color change is ongoing. Internally it is
1731 * write-protected by sdata_lock and local->mtx so holding either is fine
1732 * for read access.
1733 * @color_change_color: the bss color that will be used after the change.
John Crispin17196422021-09-15 19:54:35 -07001734 * @mbssid_tx_vif: Pointer to the transmitting interface if MBSSID is enabled.
Johannes Berg32bfd352007-12-19 01:31:26 +01001735 */
1736struct ieee80211_vif {
Johannes Berg05c914f2008-09-11 00:01:58 +02001737 enum nl80211_iftype type;
Johannes Bergbda39332008-10-11 01:51:51 +02001738 struct ieee80211_bss_conf bss_conf;
Michael Brauna3e2f4b2016-10-15 13:28:19 +02001739 u8 addr[ETH_ALEN] __aligned(2);
Johannes Berg2ca27bc2010-09-16 14:58:23 +02001740 bool p2p;
Simon Wunderlich73da7d52013-07-11 16:09:06 +02001741 bool csa_active;
Sara Sharonb5a33d52016-02-16 12:48:18 +02001742 bool mu_mimo_owner;
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001743
1744 u8 cab_queue;
1745 u8 hw_queue[IEEE80211_NUM_ACS];
1746
Felix Fietkauba8c3d62015-03-27 21:30:37 +01001747 struct ieee80211_txq *txq;
1748
Michal Kaziord01a1e62012-06-26 14:37:16 +02001749 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1750
Johannes Bergc1288b12012-01-19 09:29:57 +01001751 u32 driver_flags;
Felix Fietkau6aea26c2020-09-08 14:36:53 +02001752 u32 offload_flags;
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001753
Stanislaw Gruszkaddbfe862013-03-08 14:46:14 +01001754#ifdef CONFIG_MAC80211_DEBUGFS
1755 struct dentry *debugfs_dir;
1756#endif
1757
Johannes Berg6cd536f2020-04-17 12:43:01 +02001758 bool probe_req_reg;
Jouni Malinen873b1cf2020-04-21 17:48:15 +03001759 bool rx_mcast_action_reg;
Andrei Otcheretianski1b09b552015-08-15 22:39:50 +03001760
Manikanta Pubbisetty21a5d4c2018-07-11 00:12:53 +05301761 bool txqs_stopped[IEEE80211_NUM_ACS];
1762
John Crispin5f9404a2021-07-02 19:44:08 +02001763 bool color_change_active;
1764 u8 color_change_color;
1765
John Crispin17196422021-09-15 19:54:35 -07001766 struct ieee80211_vif *mbssid_tx_vif;
1767
Johannes Berg32bfd352007-12-19 01:31:26 +01001768 /* must be last */
Gustavo A. R. Silva3c232152020-05-07 13:59:07 -05001769 u8 drv_priv[] __aligned(sizeof(void *));
Johannes Berg32bfd352007-12-19 01:31:26 +01001770};
1771
Johannes Berg902acc72008-02-23 15:17:19 +01001772static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1773{
1774#ifdef CONFIG_MAC80211_MESH
Johannes Berg05c914f2008-09-11 00:01:58 +02001775 return vif->type == NL80211_IFTYPE_MESH_POINT;
Johannes Berg902acc72008-02-23 15:17:19 +01001776#endif
1777 return false;
1778}
1779
Johannes Berg32bfd352007-12-19 01:31:26 +01001780/**
Johannes Bergad7e7182013-11-13 13:37:47 +01001781 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1782 * @wdev: the wdev to get the vif for
1783 *
1784 * This can be used by mac80211 drivers with direct cfg80211 APIs
1785 * (like the vendor commands) that get a wdev.
1786 *
1787 * Note that this function may return %NULL if the given wdev isn't
1788 * associated with a vif that the driver knows about (e.g. monitor
1789 * or AP_VLAN interfaces.)
1790 */
1791struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1792
1793/**
Emmanuel Grumbachdc5a1ad2015-03-12 08:53:24 +02001794 * ieee80211_vif_to_wdev - return a wdev struct from a vif
1795 * @vif: the vif to get the wdev for
1796 *
1797 * This can be used by mac80211 drivers with direct cfg80211 APIs
1798 * (like the vendor commands) that needs to get the wdev for a vif.
Emmanuel Grumbachf30386a2021-04-09 12:40:19 +03001799 * This can also be useful to get the netdev associated to a vif.
Emmanuel Grumbachdc5a1ad2015-03-12 08:53:24 +02001800 */
1801struct wireless_dev *ieee80211_vif_to_wdev(struct ieee80211_vif *vif);
1802
1803/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001804 * enum ieee80211_key_flags - key flags
1805 *
1806 * These flags are used for communication about keys between the driver
1807 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1808 *
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001809 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1810 * driver to indicate that it requires IV generation for this
Ido Yarivdb128472015-01-06 08:39:02 -05001811 * particular key. Setting this flag does not necessarily mean that SKBs
1812 * will have sufficient tailroom for ICV or MIC.
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001813 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1814 * the driver for a TKIP key if it requires Michael MIC
1815 * generation in software.
Ivo van Doornc6adbd22008-04-17 21:11:18 +02001816 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1817 * that the key is pairwise rather then a shared key.
Johannes Berge548c492012-09-04 17:08:23 +02001818 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
Jouni Malinen00b9cfa2015-01-24 19:52:06 +02001819 * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames
1820 * (MFP) to be done in software.
Arik Nemtsov077a9152011-10-23 08:21:41 +02001821 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
Janusz.Dziedzic@tieto.comee701082012-05-09 08:11:20 +03001822 * if space should be prepared for the IV, but the IV
Arik Nemtsov077a9152011-10-23 08:21:41 +02001823 * itself should not be generated. Do not set together with
Ido Yarivdb128472015-01-06 08:39:02 -05001824 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1825 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
1826 * MIC.
Johannes Berge548c492012-09-04 17:08:23 +02001827 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1828 * management frames. The flag can help drivers that have a hardware
1829 * crypto implementation that doesn't deal with management frames
1830 * properly by allowing them to not upload the keys to hardware and
1831 * fall back to software crypto. Note that this flag deals only with
1832 * RX, if your crypto engine can't deal with TX you can also set the
1833 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
Marek Kwaczynski17d38fa2014-04-14 11:27:21 +02001834 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
Jouni Malinen00b9cfa2015-01-24 19:52:06 +02001835 * driver for a CCMP/GCMP key to indicate that is requires IV generation
Chris Packhamae4a50e2019-10-25 10:36:47 +13001836 * only for management frames (MFP).
Ido Yarivdb128472015-01-06 08:39:02 -05001837 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the
1838 * driver for a key to indicate that sufficient tailroom must always
1839 * be reserved for ICV or MIC, even when HW encryption is enabled.
David Spinadel9de18d82017-12-01 13:50:52 +02001840 * @IEEE80211_KEY_FLAG_PUT_MIC_SPACE: This flag should be set by the driver for
1841 * a TKIP key if it only requires MIC space. Do not set together with
1842 * @IEEE80211_KEY_FLAG_GENERATE_MMIC on the same key.
Alexander Wetzel96fc6ef2019-03-19 21:34:08 +01001843 * @IEEE80211_KEY_FLAG_NO_AUTO_TX: Key needs explicit Tx activation.
Lorenzo Bianconia0b44962019-07-16 00:09:19 +02001844 * @IEEE80211_KEY_FLAG_GENERATE_MMIE: This flag should be set by the driver
1845 * for a AES_CMAC key to indicate that it requires sequence number
1846 * generation only
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001847 */
1848enum ieee80211_key_flags {
Marek Kwaczynski17d38fa2014-04-14 11:27:21 +02001849 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0),
1850 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1),
1851 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2),
1852 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3),
1853 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4),
1854 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5),
1855 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6),
Ido Yarivdb128472015-01-06 08:39:02 -05001856 IEEE80211_KEY_FLAG_RESERVE_TAILROOM = BIT(7),
David Spinadel9de18d82017-12-01 13:50:52 +02001857 IEEE80211_KEY_FLAG_PUT_MIC_SPACE = BIT(8),
Alexander Wetzel96fc6ef2019-03-19 21:34:08 +01001858 IEEE80211_KEY_FLAG_NO_AUTO_TX = BIT(9),
Lorenzo Bianconia0b44962019-07-16 00:09:19 +02001859 IEEE80211_KEY_FLAG_GENERATE_MMIE = BIT(10),
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001860};
1861
1862/**
1863 * struct ieee80211_key_conf - key information
1864 *
1865 * This key information is given by mac80211 to the driver by
1866 * the set_key() callback in &struct ieee80211_ops.
1867 *
1868 * @hw_key_idx: To be set by the driver, this is the key index the driver
1869 * wants to be given when a frame is transmitted and needs to be
Johannes Berg6a7664d2007-09-14 11:10:25 -04001870 * encrypted in hardware.
Johannes Berg97359d12010-08-10 09:46:38 +02001871 * @cipher: The key's cipher suite selector.
Eliad Pellerf8079d42016-02-14 13:56:35 +02001872 * @tx_pn: PN used for TX keys, may be used by the driver as well if it
1873 * needs to do software PN assignment by itself (e.g. due to TSO)
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001874 * @flags: key flags, see &enum ieee80211_key_flags.
1875 * @keyidx: the key index (0-3)
1876 * @keylen: key material length
Luis R. Rodriguezffd78912008-06-21 10:02:46 -04001877 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1878 * data block:
1879 * - Temporal Encryption Key (128 bits)
1880 * - Temporal Authenticator Tx MIC Key (64 bits)
1881 * - Temporal Authenticator Rx MIC Key (64 bits)
Johannes Bergdc822b52008-12-29 12:55:09 +01001882 * @icv_len: The ICV length for this key type
1883 * @iv_len: The IV length for this key type
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001884 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001885struct ieee80211_key_conf {
Johannes Bergdb388a52015-06-01 15:36:51 +02001886 atomic64_t tx_pn;
Johannes Berg97359d12010-08-10 09:46:38 +02001887 u32 cipher;
Felix Fietkau76708de2008-10-05 18:02:48 +02001888 u8 icv_len;
1889 u8 iv_len;
Johannes Berg6a7664d2007-09-14 11:10:25 -04001890 u8 hw_key_idx;
Johannes Berg11a843b2007-08-28 17:01:55 -04001891 s8 keyidx;
David Spinadel9de18d82017-12-01 13:50:52 +02001892 u16 flags;
Johannes Berg11a843b2007-08-28 17:01:55 -04001893 u8 keylen;
Gustavo A. R. Silva3c232152020-05-07 13:59:07 -05001894 u8 key[];
Jiri Bencf0706e82007-05-05 11:45:53 -07001895};
1896
Johannes Berga31cf1c2015-04-20 18:21:58 +02001897#define IEEE80211_MAX_PN_LEN 16
1898
Eliad Pellerf8079d42016-02-14 13:56:35 +02001899#define TKIP_PN_TO_IV16(pn) ((u16)(pn & 0xffff))
1900#define TKIP_PN_TO_IV32(pn) ((u32)((pn >> 16) & 0xffffffff))
1901
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001902/**
Johannes Berg9352c192015-04-20 18:12:41 +02001903 * struct ieee80211_key_seq - key sequence counter
1904 *
1905 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
1906 * @ccmp: PN data, most significant byte first (big endian,
1907 * reverse order than in packet)
1908 * @aes_cmac: PN data, most significant byte first (big endian,
1909 * reverse order than in packet)
1910 * @aes_gmac: PN data, most significant byte first (big endian,
1911 * reverse order than in packet)
1912 * @gcmp: PN data, most significant byte first (big endian,
1913 * reverse order than in packet)
Johannes Berga31cf1c2015-04-20 18:21:58 +02001914 * @hw: data for HW-only (e.g. cipher scheme) keys
Johannes Berg9352c192015-04-20 18:12:41 +02001915 */
1916struct ieee80211_key_seq {
1917 union {
1918 struct {
1919 u32 iv32;
1920 u16 iv16;
1921 } tkip;
1922 struct {
1923 u8 pn[6];
1924 } ccmp;
1925 struct {
1926 u8 pn[6];
1927 } aes_cmac;
1928 struct {
1929 u8 pn[6];
1930 } aes_gmac;
1931 struct {
1932 u8 pn[6];
1933 } gcmp;
Johannes Berga31cf1c2015-04-20 18:21:58 +02001934 struct {
1935 u8 seq[IEEE80211_MAX_PN_LEN];
1936 u8 seq_len;
1937 } hw;
Johannes Berg9352c192015-04-20 18:12:41 +02001938 };
1939};
1940
1941/**
Max Stepanov2475b1cc2013-03-24 14:23:27 +02001942 * struct ieee80211_cipher_scheme - cipher scheme
1943 *
1944 * This structure contains a cipher scheme information defining
1945 * the secure packet crypto handling.
1946 *
1947 * @cipher: a cipher suite selector
1948 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1949 * @hdr_len: a length of a security header used the cipher
1950 * @pn_len: a length of a packet number in the security header
1951 * @pn_off: an offset of pn from the beginning of the security header
1952 * @key_idx_off: an offset of key index byte in the security header
1953 * @key_idx_mask: a bit mask of key_idx bits
1954 * @key_idx_shift: a bit shift needed to get key_idx
1955 * key_idx value calculation:
1956 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1957 * @mic_len: a mic length in bytes
1958 */
1959struct ieee80211_cipher_scheme {
1960 u32 cipher;
1961 u16 iftype;
1962 u8 hdr_len;
1963 u8 pn_len;
1964 u8 pn_off;
1965 u8 key_idx_off;
1966 u8 key_idx_mask;
1967 u8 key_idx_shift;
1968 u8 mic_len;
1969};
1970
1971/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001972 * enum set_key_cmd - key command
1973 *
1974 * Used with the set_key() callback in &struct ieee80211_ops, this
1975 * indicates whether a key is being removed or added.
1976 *
1977 * @SET_KEY: a key is set
1978 * @DISABLE_KEY: a key must be disabled
1979 */
Johannes Bergea49c352007-09-18 17:29:21 -04001980enum set_key_cmd {
Johannes Berg11a843b2007-08-28 17:01:55 -04001981 SET_KEY, DISABLE_KEY,
Johannes Bergea49c352007-09-18 17:29:21 -04001982};
Jiri Bencf0706e82007-05-05 11:45:53 -07001983
Tomas Winkler478f8d22007-09-30 13:52:37 +02001984/**
Johannes Bergf09603a2012-01-20 13:55:21 +01001985 * enum ieee80211_sta_state - station state
1986 *
1987 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1988 * this is a special state for add/remove transitions
1989 * @IEEE80211_STA_NONE: station exists without special state
1990 * @IEEE80211_STA_AUTH: station is authenticated
1991 * @IEEE80211_STA_ASSOC: station is associated
1992 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1993 */
1994enum ieee80211_sta_state {
1995 /* NOTE: These need to be ordered correctly! */
1996 IEEE80211_STA_NOTEXIST,
1997 IEEE80211_STA_NONE,
1998 IEEE80211_STA_AUTH,
1999 IEEE80211_STA_ASSOC,
2000 IEEE80211_STA_AUTHORIZED,
2001};
2002
2003/**
Johannes Berge1a0c6b2013-02-07 11:47:44 +01002004 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
2005 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
2006 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
2007 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
2008 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
2009 * (including 80+80 MHz)
Ilan Peer5dca2952022-02-14 17:30:00 +01002010 * @IEEE80211_STA_RX_BW_320: station can receive up to 320 MHz
Johannes Berge1a0c6b2013-02-07 11:47:44 +01002011 *
2012 * Implementation note: 20 must be zero to be initialized
2013 * correctly, the values must be sorted.
2014 */
2015enum ieee80211_sta_rx_bandwidth {
2016 IEEE80211_STA_RX_BW_20 = 0,
2017 IEEE80211_STA_RX_BW_40,
2018 IEEE80211_STA_RX_BW_80,
2019 IEEE80211_STA_RX_BW_160,
Ilan Peer5dca2952022-02-14 17:30:00 +01002020 IEEE80211_STA_RX_BW_320,
Johannes Berge1a0c6b2013-02-07 11:47:44 +01002021};
2022
2023/**
Felix Fietkau0d528d82013-04-22 16:14:41 +02002024 * struct ieee80211_sta_rates - station rate selection table
2025 *
2026 * @rcu_head: RCU head used for freeing the table on update
Robert P. J. Day03f831a2013-05-02 07:15:09 -04002027 * @rate: transmit rates/flags to be used by default.
Felix Fietkau0d528d82013-04-22 16:14:41 +02002028 * Overriding entries per-packet is possible by using cb tx control.
2029 */
2030struct ieee80211_sta_rates {
2031 struct rcu_head rcu_head;
2032 struct {
2033 s8 idx;
2034 u8 count;
2035 u8 count_cts;
2036 u8 count_rts;
2037 u16 flags;
2038 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
2039};
2040
2041/**
Ashok Raj Nagarajanba905bf2019-03-29 16:19:09 +05302042 * struct ieee80211_sta_txpwr - station txpower configuration
2043 *
2044 * Used to configure txpower for station.
2045 *
2046 * @power: indicates the tx power, in dBm, to be used when sending data frames
2047 * to the STA.
2048 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
2049 * will be less than or equal to specified from userspace, whereas if TPC
2050 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
2051 * NL80211_TX_POWER_FIXED is not a valid configuration option for
2052 * per peer TPC.
2053 */
2054struct ieee80211_sta_txpwr {
2055 s16 power;
2056 enum nl80211_tx_power_setting type;
2057};
2058
2059/**
Johannes Berg17741cd2008-09-11 00:02:02 +02002060 * struct ieee80211_sta - station table entry
2061 *
2062 * A station table entry represents a station we are possibly
2063 * communicating with. Since stations are RCU-managed in
2064 * mac80211, any ieee80211_sta pointer you get access to must
2065 * either be protected by rcu_read_lock() explicitly or implicitly,
2066 * or you must take good care to not use such a pointer after a
Johannes Berg34e89502010-02-03 13:59:58 +01002067 * call to your sta_remove callback that removed it.
Johannes Berg17741cd2008-09-11 00:02:02 +02002068 *
2069 * @addr: MAC address
2070 * @aid: AID we assigned to the station if we're an AP
Johannes Berg323ce792008-09-11 02:45:11 +02002071 * @supp_rates: Bitmap of supported rates (per band)
Johannes Berg55d942f2013-03-01 13:07:48 +01002072 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
2073 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
Luca Coelho41cbb0f2018-06-09 09:14:44 +03002074 * @he_cap: HE capabilities of this STA
Johannes Berg1bb9a8a2020-05-28 21:34:38 +02002075 * @he_6ghz_capa: on 6 GHz, holds the HE 6 GHz band capabilities
Ilan Peera1de6402022-02-14 17:30:02 +01002076 * @eht_cap: EHT capabilities of this STA
Maxim Altshul480dd462016-08-22 17:14:04 +03002077 * @max_rx_aggregation_subframes: maximal amount of frames in a single AMPDU
2078 * that this station is allowed to transmit to us.
2079 * Can be modified by driver.
Johannes Berg527871d2015-03-21 08:09:55 +01002080 * @wme: indicates whether the STA supports QoS/WME (if local devices does,
2081 * otherwise always false)
Johannes Berg17741cd2008-09-11 00:02:02 +02002082 * @drv_priv: data area for driver use, will always be aligned to
Jani Nikulab4f7f4a2016-10-21 15:57:23 +03002083 * sizeof(void \*), size is determined in hw information.
Eliad Peller910868d2011-09-11 09:46:55 +03002084 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
Emmanuel Grumbachf438ceb2016-10-18 23:12:12 +03002085 * if wme is supported. The bits order is like in
2086 * IEEE80211_WMM_IE_STA_QOSINFO_AC_*.
Eliad Peller910868d2011-09-11 09:46:55 +03002087 * @max_sp: max Service Period. Only valid if wme is supported.
Johannes Berge1a0c6b2013-02-07 11:47:44 +01002088 * @bandwidth: current bandwidth the station can receive with
Johannes Berg8921d042012-12-27 18:26:42 +01002089 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
2090 * station can receive at the moment, changed by operating mode
2091 * notifications and capabilities. The value is only valid after
2092 * the station moves to associated state.
Johannes Bergaf0ed692013-02-12 14:21:00 +01002093 * @smps_mode: current SMPS mode (off, static or dynamic)
Robert P. J. Day03f831a2013-05-02 07:15:09 -04002094 * @rates: rate control selection table
Arik Nemtsov0c4972c2014-05-01 10:17:27 +03002095 * @tdls: indicates whether the STA is a TDLS peer
Arik Nemtsov8b941482014-10-22 12:32:48 +03002096 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
2097 * valid if the STA is a TDLS peer in the first place.
Tamizh chelvam93f04902015-10-07 10:40:04 +05302098 * @mfp: indicates whether the STA uses management frame protection or not.
Emmanuel Grumbach506bcfa2015-12-13 15:41:05 +02002099 * @max_amsdu_subframes: indicates the maximal number of MSDUs in a single
2100 * A-MSDU. Taken from the Extended Capabilities element. 0 means
2101 * unlimited.
Ayala Beker52cfa1d2016-03-17 15:41:39 +02002102 * @support_p2p_ps: indicates whether the STA supports P2P PS mechanism or not.
Felix Fietkau6e0456b2016-03-03 22:59:00 +01002103 * @max_rc_amsdu_len: Maximum A-MSDU size in bytes recommended by rate control.
Sara Sharonedba6bd2018-09-05 08:06:10 +03002104 * @max_tid_amsdu_len: Maximum A-MSDU size in bytes for this TID
Qiujun Huang07e97332020-03-12 22:44:24 +08002105 * @txpwr: the station tx power configuration
Johannes Bergadf8ed02018-08-31 11:31:08 +03002106 * @txq: per-TID data TX queues (if driver uses the TXQ abstraction); note that
2107 * the last entry (%IEEE80211_NUM_TIDS) is used for non-data frames
Johannes Berg17741cd2008-09-11 00:02:02 +02002108 */
2109struct ieee80211_sta {
Johannes Berg57fbcce2016-04-12 15:56:15 +02002110 u32 supp_rates[NUM_NL80211_BANDS];
Johannes Berg17741cd2008-09-11 00:02:02 +02002111 u8 addr[ETH_ALEN];
2112 u16 aid;
Johannes Bergd9fe60d2008-10-09 12:13:49 +02002113 struct ieee80211_sta_ht_cap ht_cap;
Mahesh Palivela818255e2012-10-10 11:33:04 +00002114 struct ieee80211_sta_vht_cap vht_cap;
Luca Coelho41cbb0f2018-06-09 09:14:44 +03002115 struct ieee80211_sta_he_cap he_cap;
Johannes Berg1bb9a8a2020-05-28 21:34:38 +02002116 struct ieee80211_he_6ghz_capa he_6ghz_capa;
Ilan Peera1de6402022-02-14 17:30:02 +01002117 struct ieee80211_sta_eht_cap eht_cap;
Luca Coelho41cbb0f2018-06-09 09:14:44 +03002118 u16 max_rx_aggregation_subframes;
Arik Nemtsov39df6002011-06-27 23:58:45 +03002119 bool wme;
Eliad Peller9533b4a2011-08-23 14:37:47 +03002120 u8 uapsd_queues;
2121 u8 max_sp;
Johannes Berg8921d042012-12-27 18:26:42 +01002122 u8 rx_nss;
Johannes Berge1a0c6b2013-02-07 11:47:44 +01002123 enum ieee80211_sta_rx_bandwidth bandwidth;
Johannes Bergaf0ed692013-02-12 14:21:00 +01002124 enum ieee80211_smps_mode smps_mode;
Felix Fietkau0d528d82013-04-22 16:14:41 +02002125 struct ieee80211_sta_rates __rcu *rates;
Arik Nemtsov0c4972c2014-05-01 10:17:27 +03002126 bool tdls;
Arik Nemtsov8b941482014-10-22 12:32:48 +03002127 bool tdls_initiator;
Tamizh chelvam93f04902015-10-07 10:40:04 +05302128 bool mfp;
Emmanuel Grumbach506bcfa2015-12-13 15:41:05 +02002129 u8 max_amsdu_subframes;
Johannes Berg57eeb202017-01-13 11:12:01 +01002130
2131 /**
2132 * @max_amsdu_len:
2133 * indicates the maximal length of an A-MSDU in bytes.
2134 * This field is always valid for packets with a VHT preamble.
2135 * For packets with a HT preamble, additional limits apply:
2136 *
2137 * * If the skb is transmitted as part of a BA agreement, the
2138 * A-MSDU maximal size is min(max_amsdu_len, 4065) bytes.
Chris Packhamae4a50e2019-10-25 10:36:47 +13002139 * * If the skb is not part of a BA agreement, the A-MSDU maximal
Johannes Berg57eeb202017-01-13 11:12:01 +01002140 * size is min(max_amsdu_len, 7935) bytes.
2141 *
2142 * Both additional HT limits must be enforced by the low level
2143 * driver. This is defined by the spec (IEEE 802.11-2012 section
2144 * 8.3.2.2 NOTE 2).
2145 */
Emmanuel Grumbach506bcfa2015-12-13 15:41:05 +02002146 u16 max_amsdu_len;
Ayala Beker52cfa1d2016-03-17 15:41:39 +02002147 bool support_p2p_ps;
Felix Fietkau6e0456b2016-03-03 22:59:00 +01002148 u16 max_rc_amsdu_len;
Sara Sharonedba6bd2018-09-05 08:06:10 +03002149 u16 max_tid_amsdu_len[IEEE80211_NUM_TIDS];
Ashok Raj Nagarajanba905bf2019-03-29 16:19:09 +05302150 struct ieee80211_sta_txpwr txpwr;
Johannes Berg17741cd2008-09-11 00:02:02 +02002151
Johannes Bergadf8ed02018-08-31 11:31:08 +03002152 struct ieee80211_txq *txq[IEEE80211_NUM_TIDS + 1];
Felix Fietkauba8c3d62015-03-27 21:30:37 +01002153
Johannes Berg17741cd2008-09-11 00:02:02 +02002154 /* must be last */
Gustavo A. R. Silva3c232152020-05-07 13:59:07 -05002155 u8 drv_priv[] __aligned(sizeof(void *));
Johannes Berg17741cd2008-09-11 00:02:02 +02002156};
2157
2158/**
Tomas Winkler478f8d22007-09-30 13:52:37 +02002159 * enum sta_notify_cmd - sta notify command
2160 *
2161 * Used with the sta_notify() callback in &struct ieee80211_ops, this
Sujith38a6cc72010-05-19 11:32:30 +05302162 * indicates if an associated station made a power state transition.
Tomas Winkler478f8d22007-09-30 13:52:37 +02002163 *
Christian Lamparter4571d3b2008-11-30 00:48:41 +01002164 * @STA_NOTIFY_SLEEP: a station is now sleeping
2165 * @STA_NOTIFY_AWAKE: a sleeping station woke up
2166 */
Christian Lamparter89fad572008-12-09 16:28:06 +01002167enum sta_notify_cmd {
Christian Lamparter4571d3b2008-11-30 00:48:41 +01002168 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
2169};
2170
2171/**
Thomas Huehn36323f82012-07-23 21:33:42 +02002172 * struct ieee80211_tx_control - TX control data
2173 *
2174 * @sta: station table entry, this sta pointer may be NULL and
2175 * it is not allowed to copy the pointer, due to RCU.
2176 */
2177struct ieee80211_tx_control {
2178 struct ieee80211_sta *sta;
2179};
2180
2181/**
Felix Fietkauba8c3d62015-03-27 21:30:37 +01002182 * struct ieee80211_txq - Software intermediate tx queue
2183 *
2184 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2185 * @sta: station table entry, %NULL for per-vif queue
Johannes Bergadf8ed02018-08-31 11:31:08 +03002186 * @tid: the TID for this queue (unused for per-vif queue),
2187 * %IEEE80211_NUM_TIDS for non-data (if enabled)
Felix Fietkauba8c3d62015-03-27 21:30:37 +01002188 * @ac: the AC for this queue
Johannes Bergf8bdbb52015-05-20 15:04:53 +02002189 * @drv_priv: driver private area, sized by hw->txq_data_size
Felix Fietkauba8c3d62015-03-27 21:30:37 +01002190 *
2191 * The driver can obtain packets from this queue by calling
2192 * ieee80211_tx_dequeue().
2193 */
2194struct ieee80211_txq {
2195 struct ieee80211_vif *vif;
2196 struct ieee80211_sta *sta;
2197 u8 tid;
2198 u8 ac;
2199
2200 /* must be last */
Gustavo A. R. Silva3c232152020-05-07 13:59:07 -05002201 u8 drv_priv[] __aligned(sizeof(void *));
Felix Fietkauba8c3d62015-03-27 21:30:37 +01002202};
2203
2204/**
Johannes Berg1bc08262007-09-18 17:29:15 -04002205 * enum ieee80211_hw_flags - hardware flags
2206 *
2207 * These flags are used to indicate hardware capabilities to
2208 * the stack. Generally, flags here should have their meaning
2209 * done in a way that the simplest hardware doesn't need setting
2210 * any particular flags. There are some exceptions to this rule,
2211 * however, so you are advised to review these flags carefully.
2212 *
Johannes Bergaf65cd962009-11-17 18:18:36 +01002213 * @IEEE80211_HW_HAS_RATE_CONTROL:
2214 * The hardware or firmware includes rate control, and cannot be
2215 * controlled by the stack. As such, no rate control algorithm
2216 * should be instantiated, and the TX rate reported to userspace
2217 * will be taken from the TX status instead of the rate control
2218 * algorithm.
2219 * Note that this requires that the driver implement a number of
2220 * callbacks so it has the correct information, it needs to have
2221 * the @set_rts_threshold callback and must look at the BSS config
2222 * @use_cts_prot for G/N protection, @use_short_slot for slot
2223 * timing in 2.4 GHz and @use_short_preamble for preambles for
2224 * CCK frames.
2225 *
Johannes Berg1bc08262007-09-18 17:29:15 -04002226 * @IEEE80211_HW_RX_INCLUDES_FCS:
2227 * Indicates that received frames passed to the stack include
2228 * the FCS at the end.
2229 *
2230 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
2231 * Some wireless LAN chipsets buffer broadcast/multicast frames
2232 * for power saving stations in the hardware/firmware and others
2233 * rely on the host system for such buffering. This option is used
2234 * to configure the IEEE 802.11 upper layer to buffer broadcast and
2235 * multicast frames when there are power saving stations so that
Luis R. Rodriguez546c80c92008-08-14 11:43:20 -07002236 * the driver can fetch them with ieee80211_get_buffered_bc().
Johannes Berg1bc08262007-09-18 17:29:15 -04002237 *
Bruno Randolf566bfe52008-05-08 19:15:40 +02002238 * @IEEE80211_HW_SIGNAL_UNSPEC:
2239 * Hardware can provide signal values but we don't know its units. We
2240 * expect values between 0 and @max_signal.
2241 * If possible please provide dB or dBm instead.
2242 *
Bruno Randolf566bfe52008-05-08 19:15:40 +02002243 * @IEEE80211_HW_SIGNAL_DBM:
2244 * Hardware gives signal values in dBm, decibel difference from
2245 * one milliwatt. This is the preferred method since it is standardized
2246 * between different devices. @max_signal does not need to be set.
2247 *
Tomas Winkler06ff47b2008-06-18 17:53:44 +03002248 * @IEEE80211_HW_SPECTRUM_MGMT:
2249 * Hardware supports spectrum management defined in 802.11h
2250 * Measurement, Channel Switch, Quieting, TPC
Sujith8b30b1f2008-10-24 09:55:27 +05302251 *
2252 * @IEEE80211_HW_AMPDU_AGGREGATION:
2253 * Hardware supports 11n A-MPDU aggregation.
Kalle Valo520eb822008-12-18 23:35:27 +02002254 *
Johannes Berg4be8c382009-01-07 18:28:20 +01002255 * @IEEE80211_HW_SUPPORTS_PS:
2256 * Hardware has power save support (i.e. can go to sleep).
2257 *
2258 * @IEEE80211_HW_PS_NULLFUNC_STACK:
2259 * Hardware requires nullfunc frame handling in stack, implies
2260 * stack support for dynamic PS.
2261 *
2262 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
2263 * Hardware has support for dynamic PS.
Jouni Malinen4375d082009-01-08 13:32:11 +02002264 *
2265 * @IEEE80211_HW_MFP_CAPABLE:
2266 * Hardware supports management frame protection (MFP, IEEE 802.11w).
Kalle Valo04de8382009-03-22 21:57:35 +02002267 *
Vivek Natarajan375177b2010-02-09 14:50:28 +05302268 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
2269 * Hardware can provide ack status reports of Tx frames to
2270 * the stack.
2271 *
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02002272 * @IEEE80211_HW_CONNECTION_MONITOR:
Johannes Bergad24b0d2013-07-05 11:53:28 +02002273 * The hardware performs its own connection monitoring, including
2274 * periodic keep-alives to the AP and probing the AP on beacon loss.
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02002275 *
Emmanuel Grumbachc65dd142012-12-12 10:12:24 +02002276 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
2277 * This device needs to get data from beacon before association (i.e.
2278 * dtim_period).
Johannes Berge31b8212010-10-05 19:39:30 +02002279 *
2280 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
2281 * per-station GTKs as used by IBSS RSN or during fast transition. If
2282 * the device doesn't support per-station GTKs, but can be asked not
2283 * to decrypt group addressed frames, then IBSS RSN support is still
2284 * possible but software crypto will be used. Advertise the wiphy flag
2285 * only in that case.
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02002286 *
2287 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
2288 * autonomously manages the PS status of connected stations. When
2289 * this flag is set mac80211 will not trigger PS mode for connected
2290 * stations based on the PM bit of incoming frames.
2291 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
2292 * the PS mode of connected stations.
Arik Nemtsovedf6b782011-08-30 09:32:38 +03002293 *
2294 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
2295 * setup strictly in HW. mac80211 should not attempt to do this in
2296 * software.
Eliad Peller885bd8e2012-02-02 17:44:55 +02002297 *
Johannes Berg4b6f1dd2012-04-03 14:35:57 +02002298 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
2299 * a virtual monitor interface when monitor interfaces are the only
2300 * active interfaces.
Johannes Berg3a25a8c2012-04-03 16:28:50 +02002301 *
Ben Greeare27513f2014-10-22 12:23:03 -07002302 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
2303 * be created. It is expected user-space will create vifs as
2304 * desired (and thus have them named as desired).
2305 *
Johannes Bergfa7e1fb2015-01-22 18:44:19 +01002306 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the
2307 * crypto algorithms can be done in software - so don't automatically
2308 * try to fall back to it if hardware crypto fails, but do so only if
2309 * the driver returns 1. This also forces the driver to advertise its
2310 * supported cipher suites.
2311 *
Johannes Berg17c18bf2015-03-21 15:25:43 +01002312 * @IEEE80211_HW_SUPPORT_FAST_XMIT: The driver/hardware supports fast-xmit,
2313 * this currently requires only the ability to calculate the duration
2314 * for frames.
2315 *
Johannes Berg3a25a8c2012-04-03 16:28:50 +02002316 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
2317 * queue mapping in order to use different queues (not just one per AC)
2318 * for different virtual interfaces. See the doc section on HW queue
2319 * control for more details.
Johannes Berg6d711172012-06-19 17:19:44 +02002320 *
Felix Fietkau0d528d82013-04-22 16:14:41 +02002321 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
2322 * selection table provided by the rate control algorithm.
2323 *
Johannes Berg6d711172012-06-19 17:19:44 +02002324 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
2325 * P2P Interface. This will be honoured even if more than one interface
2326 * is supported.
Johannes Bergef429da2013-02-05 17:48:40 +01002327 *
2328 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
2329 * only, to allow getting TBTT of a DTIM beacon.
Arik Nemtsov7578d572013-09-01 17:15:51 +03002330 *
Johannes Berg919be622013-10-14 10:05:16 +02002331 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
2332 * and can cope with CCK rates in an aggregation session (e.g. by not
2333 * using aggregation for such frames.)
2334 *
Arik Nemtsov7578d572013-09-01 17:15:51 +03002335 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
2336 * for a single active channel while using channel contexts. When support
2337 * is not enabled the default action is to disconnect when getting the
2338 * CSA frame.
Luciano Coelho5d52ee82014-02-27 14:33:47 +02002339 *
Ido Yarivc70f59a2014-07-29 15:39:14 +03002340 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
2341 * or tailroom of TX skbs without copying them first.
2342 *
Johannes Bergc526a462015-06-02 20:32:00 +02002343 * @IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
David Spinadelc56ef672014-02-05 15:21:13 +02002344 * in one command, mac80211 doesn't have to run separate scans per band.
Johannes Berg30686bf2015-06-02 21:39:54 +02002345 *
Arik Nemtsovb98fb442015-06-10 20:42:59 +03002346 * @IEEE80211_HW_TDLS_WIDER_BW: The device/driver supports wider bandwidth
2347 * than then BSS bandwidth for a TDLS link on the base channel.
2348 *
Emmanuel Grumbach99e7ca42015-08-15 22:39:51 +03002349 * @IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU: The driver supports receiving A-MSDUs
2350 * within A-MPDU.
2351 *
Helmut Schaa35afa582015-09-09 09:46:32 +02002352 * @IEEE80211_HW_BEACON_TX_STATUS: The device/driver provides TX status
2353 * for sent beacons.
2354 *
Johannes Berg31104892015-10-22 17:35:19 +02002355 * @IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR: Hardware (or driver) requires that each
2356 * station has a unique address, i.e. each station entry can be identified
2357 * by just its MAC address; this prevents, for example, the same station
2358 * from connecting to two virtual AP interfaces at the same time.
2359 *
Sara Sharon412a6d82015-12-08 19:09:05 +02002360 * @IEEE80211_HW_SUPPORTS_REORDERING_BUFFER: Hardware (or driver) manages the
2361 * reordering buffer internally, guaranteeing mac80211 receives frames in
2362 * order and does not need to manage its own reorder buffer or BA session
2363 * timeout.
2364 *
Johannes Bergc9c59622016-03-31 20:02:11 +03002365 * @IEEE80211_HW_USES_RSS: The device uses RSS and thus requires parallel RX,
2366 * which implies using per-CPU station statistics.
2367 *
Felix Fietkau6e0456b2016-03-03 22:59:00 +01002368 * @IEEE80211_HW_TX_AMSDU: Hardware (or driver) supports software aggregated
2369 * A-MSDU frames. Requires software tx queueing and fast-xmit support.
2370 * When not using minstrel/minstrel_ht rate control, the driver must
2371 * limit the maximum A-MSDU size based on the current tx rate by setting
2372 * max_rc_amsdu_len in struct ieee80211_sta.
2373 *
2374 * @IEEE80211_HW_TX_FRAG_LIST: Hardware (or driver) supports sending frag_list
2375 * skbs, needed for zero-copy software A-MSDU.
2376 *
Rajkumar Manoharane8a24cd2016-09-14 12:48:32 +05302377 * @IEEE80211_HW_REPORTS_LOW_ACK: The driver (or firmware) reports low ack event
2378 * by ieee80211_report_low_ack() based on its own algorithm. For such
2379 * drivers, mac80211 packet loss mechanism will not be triggered and driver
2380 * is completely depending on firmware event for station kickout.
2381 *
Sara Sharonf3fe4e92016-10-18 23:12:11 +03002382 * @IEEE80211_HW_SUPPORTS_TX_FRAG: Hardware does fragmentation by itself.
2383 * The stack will not do fragmentation.
2384 * The callback for @set_frag_threshold should be set as well.
2385 *
Yingying Tange2fb1b82017-10-24 16:51:10 +08002386 * @IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA: Hardware supports buffer STA on
2387 * TDLS links.
2388 *
Ilan Peer94ba9272018-02-19 14:48:41 +02002389 * @IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP: The driver requires the
2390 * mgd_prepare_tx() callback to be called before transmission of a
2391 * deauthentication frame in case the association was completed but no
2392 * beacon was heard. This is required in multi-channel scenarios, where the
2393 * virtual interface might not be given air time for the transmission of
2394 * the frame, as it is not synced with the AP/P2P GO yet, and thus the
2395 * deauthentication frame might not be transmitted.
Randy Dunlapd1361b32018-04-26 18:17:31 -07002396 *
Ben Caradoc-Davies7c181f42018-03-19 12:57:44 +13002397 * @IEEE80211_HW_DOESNT_SUPPORT_QOS_NDP: The driver (or firmware) doesn't
2398 * support QoS NDP for AP probing - that's most likely a driver bug.
Ilan Peer94ba9272018-02-19 14:48:41 +02002399 *
Johannes Bergadf8ed02018-08-31 11:31:08 +03002400 * @IEEE80211_HW_BUFF_MMPDU_TXQ: use the TXQ for bufferable MMPDUs, this of
2401 * course requires the driver to use TXQs to start with.
2402 *
Johannes Berg09b4a4f2018-08-31 11:31:17 +03002403 * @IEEE80211_HW_SUPPORTS_VHT_EXT_NSS_BW: (Hardware) rate control supports VHT
2404 * extended NSS BW (dot11VHTExtendedNSSBWCapable). This flag will be set if
2405 * the selected rate control algorithm sets %RATE_CTRL_CAPA_VHT_EXT_NSS_BW
2406 * but if the rate control is built-in then it must be set by the driver.
2407 * See also the documentation for that flag.
2408 *
Sara Sharon0eeb2b62018-09-05 08:06:09 +03002409 * @IEEE80211_HW_STA_MMPDU_TXQ: use the extra non-TID per-station TXQ for all
2410 * MMPDUs on station interfaces. This of course requires the driver to use
2411 * TXQs to start with.
2412 *
Felix Fietkau77f7ffd2019-01-16 22:32:12 +01002413 * @IEEE80211_HW_TX_STATUS_NO_AMPDU_LEN: Driver does not report accurate A-MPDU
2414 * length in tx status information
2415 *
Sara Sharoncaf56332019-01-16 23:03:25 +02002416 * @IEEE80211_HW_SUPPORTS_MULTI_BSSID: Hardware supports multi BSSID
2417 *
2418 * @IEEE80211_HW_SUPPORTS_ONLY_HE_MULTI_BSSID: Hardware supports multi BSSID
2419 * only for HE APs. Applies if @IEEE80211_HW_SUPPORTS_MULTI_BSSID is set.
2420 *
Alexander Wetzeldc3998e2019-06-29 21:50:14 +02002421 * @IEEE80211_HW_AMPDU_KEYBORDER_SUPPORT: The card and driver is only
2422 * aggregating MPDUs with the same keyid, allowing mac80211 to keep Tx
2423 * A-MPDU sessions active while rekeying with Extended Key ID.
2424 *
Felix Fietkau6aea26c2020-09-08 14:36:53 +02002425 * @IEEE80211_HW_SUPPORTS_TX_ENCAP_OFFLOAD: Hardware supports tx encapsulation
2426 * offload
2427 *
Felix Fietkau80a915e2020-12-18 19:47:18 +01002428 * @IEEE80211_HW_SUPPORTS_RX_DECAP_OFFLOAD: Hardware supports rx decapsulation
2429 * offload
2430 *
Sriram R55f82052021-03-30 07:05:16 +05302431 * @IEEE80211_HW_SUPPORTS_CONC_MON_RX_DECAP: Hardware supports concurrent rx
2432 * decapsulation offload and passing raw 802.11 frames for monitor iface.
2433 * If this is supported, the driver must pass both 802.3 frames for real
2434 * usage and 802.11 frames with %RX_FLAG_ONLY_MONITOR set for monitor to
2435 * the stack.
2436 *
Johannes Berg30686bf2015-06-02 21:39:54 +02002437 * @NUM_IEEE80211_HW_FLAGS: number of hardware flags, used for sizing arrays
Johannes Berg1bc08262007-09-18 17:29:15 -04002438 */
2439enum ieee80211_hw_flags {
Johannes Berg30686bf2015-06-02 21:39:54 +02002440 IEEE80211_HW_HAS_RATE_CONTROL,
2441 IEEE80211_HW_RX_INCLUDES_FCS,
2442 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING,
2443 IEEE80211_HW_SIGNAL_UNSPEC,
2444 IEEE80211_HW_SIGNAL_DBM,
2445 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC,
2446 IEEE80211_HW_SPECTRUM_MGMT,
2447 IEEE80211_HW_AMPDU_AGGREGATION,
2448 IEEE80211_HW_SUPPORTS_PS,
2449 IEEE80211_HW_PS_NULLFUNC_STACK,
2450 IEEE80211_HW_SUPPORTS_DYNAMIC_PS,
2451 IEEE80211_HW_MFP_CAPABLE,
2452 IEEE80211_HW_WANT_MONITOR_VIF,
2453 IEEE80211_HW_NO_AUTO_VIF,
2454 IEEE80211_HW_SW_CRYPTO_CONTROL,
2455 IEEE80211_HW_SUPPORT_FAST_XMIT,
2456 IEEE80211_HW_REPORTS_TX_ACK_STATUS,
2457 IEEE80211_HW_CONNECTION_MONITOR,
2458 IEEE80211_HW_QUEUE_CONTROL,
2459 IEEE80211_HW_SUPPORTS_PER_STA_GTK,
2460 IEEE80211_HW_AP_LINK_PS,
2461 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW,
2462 IEEE80211_HW_SUPPORTS_RC_TABLE,
2463 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF,
2464 IEEE80211_HW_TIMING_BEACON_ONLY,
2465 IEEE80211_HW_SUPPORTS_HT_CCK_RATES,
2466 IEEE80211_HW_CHANCTX_STA_CSA,
2467 IEEE80211_HW_SUPPORTS_CLONED_SKBS,
2468 IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS,
Arik Nemtsovb98fb442015-06-10 20:42:59 +03002469 IEEE80211_HW_TDLS_WIDER_BW,
Emmanuel Grumbach99e7ca42015-08-15 22:39:51 +03002470 IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU,
Helmut Schaa35afa582015-09-09 09:46:32 +02002471 IEEE80211_HW_BEACON_TX_STATUS,
Johannes Berg31104892015-10-22 17:35:19 +02002472 IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR,
Sara Sharon412a6d82015-12-08 19:09:05 +02002473 IEEE80211_HW_SUPPORTS_REORDERING_BUFFER,
Johannes Bergc9c59622016-03-31 20:02:11 +03002474 IEEE80211_HW_USES_RSS,
Felix Fietkau6e0456b2016-03-03 22:59:00 +01002475 IEEE80211_HW_TX_AMSDU,
2476 IEEE80211_HW_TX_FRAG_LIST,
Rajkumar Manoharane8a24cd2016-09-14 12:48:32 +05302477 IEEE80211_HW_REPORTS_LOW_ACK,
Sara Sharonf3fe4e92016-10-18 23:12:11 +03002478 IEEE80211_HW_SUPPORTS_TX_FRAG,
Yingying Tange2fb1b82017-10-24 16:51:10 +08002479 IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA,
Ilan Peer94ba9272018-02-19 14:48:41 +02002480 IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP,
Ben Caradoc-Davies7c181f42018-03-19 12:57:44 +13002481 IEEE80211_HW_DOESNT_SUPPORT_QOS_NDP,
Johannes Bergadf8ed02018-08-31 11:31:08 +03002482 IEEE80211_HW_BUFF_MMPDU_TXQ,
Johannes Berg09b4a4f2018-08-31 11:31:17 +03002483 IEEE80211_HW_SUPPORTS_VHT_EXT_NSS_BW,
Sara Sharon0eeb2b62018-09-05 08:06:09 +03002484 IEEE80211_HW_STA_MMPDU_TXQ,
Felix Fietkau77f7ffd2019-01-16 22:32:12 +01002485 IEEE80211_HW_TX_STATUS_NO_AMPDU_LEN,
Sara Sharoncaf56332019-01-16 23:03:25 +02002486 IEEE80211_HW_SUPPORTS_MULTI_BSSID,
2487 IEEE80211_HW_SUPPORTS_ONLY_HE_MULTI_BSSID,
Alexander Wetzeldc3998e2019-06-29 21:50:14 +02002488 IEEE80211_HW_AMPDU_KEYBORDER_SUPPORT,
Felix Fietkau6aea26c2020-09-08 14:36:53 +02002489 IEEE80211_HW_SUPPORTS_TX_ENCAP_OFFLOAD,
Felix Fietkau80a915e2020-12-18 19:47:18 +01002490 IEEE80211_HW_SUPPORTS_RX_DECAP_OFFLOAD,
Sriram R55f82052021-03-30 07:05:16 +05302491 IEEE80211_HW_SUPPORTS_CONC_MON_RX_DECAP,
Johannes Berg30686bf2015-06-02 21:39:54 +02002492
2493 /* keep last, obviously */
2494 NUM_IEEE80211_HW_FLAGS
Johannes Berg1bc08262007-09-18 17:29:15 -04002495};
2496
Johannes Berg7ac1bd62007-09-14 11:10:25 -04002497/**
2498 * struct ieee80211_hw - hardware information and state
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002499 *
2500 * This structure contains the configuration and hardware
2501 * information for an 802.11 PHY.
2502 *
2503 * @wiphy: This points to the &struct wiphy allocated for this
2504 * 802.11 PHY. You must fill in the @perm_addr and @dev
2505 * members of this structure using SET_IEEE80211_DEV()
Johannes Berg8318d782008-01-24 19:38:38 +01002506 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
2507 * bands (with channels, bitrates) are registered here.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002508 *
2509 * @conf: &struct ieee80211_conf, device configuration, don't use.
2510 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002511 * @priv: pointer to private area that was allocated for driver use
2512 * along with this structure.
2513 *
2514 * @flags: hardware flags, see &enum ieee80211_hw_flags.
2515 *
2516 * @extra_tx_headroom: headroom to reserve in each transmit skb
2517 * for use by the driver (e.g. for transmit headers.)
2518 *
Felix Fietkau70dabeb2013-12-14 13:54:53 +01002519 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
2520 * Can be used by drivers to add extra IEs.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002521 *
Bruno Randolf566bfe52008-05-08 19:15:40 +02002522 * @max_signal: Maximum value for signal (rssi) in RX information, used
Johannes Bergad24b0d2013-07-05 11:53:28 +02002523 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002524 *
Tomas Winklerea95bba2008-07-18 13:53:00 +08002525 * @max_listen_interval: max listen interval in units of beacon interval
Johannes Bergad24b0d2013-07-05 11:53:28 +02002526 * that HW supports
Tomas Winklerea95bba2008-07-18 13:53:00 +08002527 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002528 * @queues: number of available hardware transmit queues for
Johannes Berge100bb62008-04-30 18:51:21 +02002529 * data packets. WMM/QoS requires at least four, these
2530 * queues need to have configurable access parameters.
2531 *
Johannes Berg830f9032007-10-28 14:51:05 +01002532 * @rate_control_algorithm: rate control algorithm for this hardware.
2533 * If unset (NULL), the default algorithm will be used. Must be
2534 * set before calling ieee80211_register_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01002535 *
2536 * @vif_data_size: size (in bytes) of the drv_priv data area
2537 * within &struct ieee80211_vif.
Johannes Berg17741cd2008-09-11 00:02:02 +02002538 * @sta_data_size: size (in bytes) of the drv_priv data area
2539 * within &struct ieee80211_sta.
Michal Kaziord01a1e62012-06-26 14:37:16 +02002540 * @chanctx_data_size: size (in bytes) of the drv_priv data area
2541 * within &struct ieee80211_chanctx_conf.
Felix Fietkauba8c3d62015-03-27 21:30:37 +01002542 * @txq_data_size: size (in bytes) of the drv_priv data area
2543 * within @struct ieee80211_txq.
Felix Fietkau870abdf2008-10-05 18:04:24 +02002544 *
Helmut Schaa78be49e2010-10-02 11:31:55 +02002545 * @max_rates: maximum number of alternate rate retry stages the hw
2546 * can handle.
2547 * @max_report_rates: maximum number of alternate rate retry stages
2548 * the hw can report back.
Johannes Berge6a98542008-10-21 12:40:02 +02002549 * @max_rate_tries: maximum number of tries for each stage
John W. Linville4e6cbfd2010-07-29 16:14:13 -04002550 *
Luciano Coelhodf6ba5d2011-01-12 15:26:30 +02002551 * @max_rx_aggregation_subframes: maximum buffer size (number of
2552 * sub-frames) to be used for A-MPDU block ack receiver
2553 * aggregation.
2554 * This is only relevant if the device has restrictions on the
2555 * number of subframes, if it relies on mac80211 to do reordering
2556 * it shouldn't be set.
Johannes Berg5dd36bc2011-01-18 13:52:23 +01002557 *
2558 * @max_tx_aggregation_subframes: maximum number of subframes in an
Luca Coelho41cbb0f2018-06-09 09:14:44 +03002559 * aggregate an HT/HE device will transmit. In HT AddBA we'll
2560 * advertise a constant value of 64 as some older APs crash if
2561 * the window size is smaller (an example is LinkSys WRT120N
2562 * with FW v1.0.07 build 002 Jun 18 2012).
2563 * For AddBA to HE capable peers this value will be used.
Johannes Berg3a25a8c2012-04-03 16:28:50 +02002564 *
Felix Fietkau6e0456b2016-03-03 22:59:00 +01002565 * @max_tx_fragments: maximum number of tx buffers per (A)-MSDU, sum
2566 * of 1 + skb_shinfo(skb)->nr_frags for each skb in the frag_list.
2567 *
Johannes Berg3a25a8c2012-04-03 16:28:50 +02002568 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
2569 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
Johannes Bergac55d2f2012-05-10 09:09:10 +02002570 *
2571 * @radiotap_mcs_details: lists which MCS information can the HW
2572 * reports, by default it is set to _MCS, _GI and _BW but doesn't
Jani Nikulab4f7f4a2016-10-21 15:57:23 +03002573 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_\* values, only
Johannes Bergac55d2f2012-05-10 09:09:10 +02002574 * adding _BW is supported today.
Arik Nemtsov72d78722012-05-10 16:18:26 +03002575 *
Johannes Berg51648922012-11-22 23:00:18 +01002576 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
2577 * the default is _GI | _BANDWIDTH.
Jani Nikulab4f7f4a2016-10-21 15:57:23 +03002578 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_\* values.
Johannes Berg51648922012-11-22 23:00:18 +01002579 *
Luca Coelho41cbb0f2018-06-09 09:14:44 +03002580 * @radiotap_he: HE radiotap validity flags
2581 *
Johannes Berg99ee7ca2016-08-29 23:25:17 +03002582 * @radiotap_timestamp: Information for the radiotap timestamp field; if the
Johannes Berg7d419462019-02-01 11:53:32 +01002583 * @units_pos member is set to a non-negative value then the timestamp
Johannes Berg99ee7ca2016-08-29 23:25:17 +03002584 * field will be added and populated from the &struct ieee80211_rx_status
Johannes Berg7d419462019-02-01 11:53:32 +01002585 * device_timestamp.
2586 * @radiotap_timestamp.units_pos: Must be set to a combination of a
2587 * IEEE80211_RADIOTAP_TIMESTAMP_UNIT_* and a
2588 * IEEE80211_RADIOTAP_TIMESTAMP_SPOS_* value.
2589 * @radiotap_timestamp.accuracy: If non-negative, fills the accuracy in the
2590 * radiotap field and the accuracy known flag will be set.
Johannes Berg99ee7ca2016-08-29 23:25:17 +03002591 *
Arik Nemtsov72d78722012-05-10 16:18:26 +03002592 * @netdev_features: netdev features to be set in each netdev created
Johannes Berg680a0da2015-04-13 16:58:25 +02002593 * from this HW. Note that not all features are usable with mac80211,
2594 * other features will be rejected during HW registration.
Alexander Bondar219c3862013-01-22 16:52:23 +02002595 *
2596 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
2597 * for each access category if it is uAPSD trigger-enabled and delivery-
2598 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
2599 * Each bit corresponds to different AC. Value '1' in specific bit means
2600 * that corresponding AC is both trigger- and delivery-enabled. '0' means
2601 * neither enabled.
2602 *
2603 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
2604 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
2605 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
Max Stepanov2475b1cc2013-03-24 14:23:27 +02002606 *
2607 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
2608 * @cipher_schemes: a pointer to an array of cipher scheme definitions
2609 * supported by HW.
Ayala Beker167e33f2016-09-20 17:31:20 +03002610 * @max_nan_de_entries: maximum number of NAN DE functions supported by the
2611 * device.
Wen Gong70e53662018-08-08 18:40:01 +08002612 *
2613 * @tx_sk_pacing_shift: Pacing shift to set on TCP sockets when frames from
2614 * them are encountered. The default should typically not be changed,
2615 * unless the driver has good reasons for needing more buffers.
Toke Høiland-Jørgensenb4809e92018-12-18 17:02:08 -08002616 *
Toke Høiland-Jørgensencb868802019-01-29 11:31:26 +01002617 * @weight_multiplier: Driver specific airtime weight multiplier used while
Toke Høiland-Jørgensenb4809e92018-12-18 17:02:08 -08002618 * refilling deficit of each TXQ.
Wen Gong06354662019-09-06 10:48:57 +08002619 *
2620 * @max_mtu: the max mtu could be set.
Johannes Berg7ac1bd62007-09-14 11:10:25 -04002621 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002622struct ieee80211_hw {
Jiri Bencf0706e82007-05-05 11:45:53 -07002623 struct ieee80211_conf conf;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002624 struct wiphy *wiphy;
Johannes Berg830f9032007-10-28 14:51:05 +01002625 const char *rate_control_algorithm;
Jiri Bencf0706e82007-05-05 11:45:53 -07002626 void *priv;
Johannes Berg30686bf2015-06-02 21:39:54 +02002627 unsigned long flags[BITS_TO_LONGS(NUM_IEEE80211_HW_FLAGS)];
Jiri Bencf0706e82007-05-05 11:45:53 -07002628 unsigned int extra_tx_headroom;
Felix Fietkau70dabeb2013-12-14 13:54:53 +01002629 unsigned int extra_beacon_tailroom;
Johannes Berg32bfd352007-12-19 01:31:26 +01002630 int vif_data_size;
Johannes Berg17741cd2008-09-11 00:02:02 +02002631 int sta_data_size;
Michal Kaziord01a1e62012-06-26 14:37:16 +02002632 int chanctx_data_size;
Felix Fietkauba8c3d62015-03-27 21:30:37 +01002633 int txq_data_size;
Tomas Winklerea95bba2008-07-18 13:53:00 +08002634 u16 queues;
Tomas Winklerea95bba2008-07-18 13:53:00 +08002635 u16 max_listen_interval;
Jiri Bencf0706e82007-05-05 11:45:53 -07002636 s8 max_signal;
Johannes Berge6a98542008-10-21 12:40:02 +02002637 u8 max_rates;
Helmut Schaa78be49e2010-10-02 11:31:55 +02002638 u8 max_report_rates;
Johannes Berge6a98542008-10-21 12:40:02 +02002639 u8 max_rate_tries;
Luca Coelho41cbb0f2018-06-09 09:14:44 +03002640 u16 max_rx_aggregation_subframes;
2641 u16 max_tx_aggregation_subframes;
Felix Fietkau6e0456b2016-03-03 22:59:00 +01002642 u8 max_tx_fragments;
Johannes Berg3a25a8c2012-04-03 16:28:50 +02002643 u8 offchannel_tx_hw_queue;
Johannes Bergac55d2f2012-05-10 09:09:10 +02002644 u8 radiotap_mcs_details;
Johannes Berg51648922012-11-22 23:00:18 +01002645 u16 radiotap_vht_details;
Johannes Berg99ee7ca2016-08-29 23:25:17 +03002646 struct {
2647 int units_pos;
2648 s16 accuracy;
2649 } radiotap_timestamp;
Arik Nemtsov72d78722012-05-10 16:18:26 +03002650 netdev_features_t netdev_features;
Alexander Bondar219c3862013-01-22 16:52:23 +02002651 u8 uapsd_queues;
2652 u8 uapsd_max_sp_len;
Max Stepanov2475b1cc2013-03-24 14:23:27 +02002653 u8 n_cipher_schemes;
2654 const struct ieee80211_cipher_scheme *cipher_schemes;
Ayala Beker167e33f2016-09-20 17:31:20 +03002655 u8 max_nan_de_entries;
Wen Gong70e53662018-08-08 18:40:01 +08002656 u8 tx_sk_pacing_shift;
Toke Høiland-Jørgensenb4809e92018-12-18 17:02:08 -08002657 u8 weight_multiplier;
Wen Gong06354662019-09-06 10:48:57 +08002658 u32 max_mtu;
Jiri Bencf0706e82007-05-05 11:45:53 -07002659};
2660
Johannes Berg30686bf2015-06-02 21:39:54 +02002661static inline bool _ieee80211_hw_check(struct ieee80211_hw *hw,
2662 enum ieee80211_hw_flags flg)
2663{
2664 return test_bit(flg, hw->flags);
2665}
2666#define ieee80211_hw_check(hw, flg) _ieee80211_hw_check(hw, IEEE80211_HW_##flg)
2667
2668static inline void _ieee80211_hw_set(struct ieee80211_hw *hw,
2669 enum ieee80211_hw_flags flg)
2670{
2671 return __set_bit(flg, hw->flags);
2672}
2673#define ieee80211_hw_set(hw, flg) _ieee80211_hw_set(hw, IEEE80211_HW_##flg)
2674
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002675/**
David Spinadelc56ef672014-02-05 15:21:13 +02002676 * struct ieee80211_scan_request - hw scan request
2677 *
2678 * @ies: pointers different parts of IEs (in req.ie)
2679 * @req: cfg80211 request.
2680 */
2681struct ieee80211_scan_request {
2682 struct ieee80211_scan_ies ies;
2683
2684 /* Keep last */
2685 struct cfg80211_scan_request req;
2686};
2687
2688/**
Arik Nemtsov8a4d32f2014-11-09 18:50:20 +02002689 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
2690 *
2691 * @sta: peer this TDLS channel-switch request/response came from
2692 * @chandef: channel referenced in a TDLS channel-switch request
2693 * @action_code: see &enum ieee80211_tdls_actioncode
2694 * @status: channel-switch response status
2695 * @timestamp: time at which the frame was received
2696 * @switch_time: switch-timing parameter received in the frame
2697 * @switch_timeout: switch-timing parameter received in the frame
2698 * @tmpl_skb: TDLS switch-channel response template
2699 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
2700 */
2701struct ieee80211_tdls_ch_sw_params {
2702 struct ieee80211_sta *sta;
2703 struct cfg80211_chan_def *chandef;
2704 u8 action_code;
2705 u32 status;
2706 u32 timestamp;
2707 u16 switch_time;
2708 u16 switch_timeout;
2709 struct sk_buff *tmpl_skb;
2710 u32 ch_sw_tm_ie;
2711};
2712
2713/**
Luis R. Rodriguez9a953712009-01-22 15:05:53 -08002714 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
2715 *
2716 * @wiphy: the &struct wiphy which we want to query
2717 *
2718 * mac80211 drivers can use this to get to their respective
2719 * &struct ieee80211_hw. Drivers wishing to get to their own private
2720 * structure can then access it via hw->priv. Note that mac802111 drivers should
2721 * not use wiphy_priv() to try to get their private driver structure as this
2722 * is already used internally by mac80211.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01002723 *
2724 * Return: The mac80211 driver hw struct of @wiphy.
Luis R. Rodriguez9a953712009-01-22 15:05:53 -08002725 */
2726struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
2727
2728/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002729 * SET_IEEE80211_DEV - set device for 802.11 hardware
2730 *
2731 * @hw: the &struct ieee80211_hw to set the device for
2732 * @dev: the &struct device of this 802.11 device
2733 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002734static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
2735{
2736 set_wiphy_dev(hw->wiphy, dev);
2737}
2738
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002739/**
Bob Copelande37d4df2008-10-20 21:20:27 -04002740 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002741 *
2742 * @hw: the &struct ieee80211_hw to set the MAC address for
2743 * @addr: the address to set
2744 */
Bjorn Andersson538dc902015-12-24 00:33:26 -08002745static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, const u8 *addr)
Jiri Bencf0706e82007-05-05 11:45:53 -07002746{
2747 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
2748}
2749
Johannes Berg2e92e6f2008-05-15 12:55:27 +02002750static inline struct ieee80211_rate *
2751ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02002752 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02002753{
Larry Fingeraa331df2012-04-06 16:35:53 -05002754 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
Johannes Berg2e92e6f2008-05-15 12:55:27 +02002755 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02002756 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02002757}
2758
2759static inline struct ieee80211_rate *
2760ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02002761 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02002762{
Johannes Berge039fa42008-05-15 12:55:29 +02002763 if (c->control.rts_cts_rate_idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02002764 return NULL;
Johannes Berge039fa42008-05-15 12:55:29 +02002765 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02002766}
2767
2768static inline struct ieee80211_rate *
2769ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
Felix Fietkau870abdf2008-10-05 18:04:24 +02002770 const struct ieee80211_tx_info *c, int idx)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02002771{
Johannes Berge6a98542008-10-21 12:40:02 +02002772 if (c->control.rates[idx + 1].idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02002773 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02002774 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02002775}
2776
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002777/**
Johannes Berg6096de72011-11-04 11:18:10 +01002778 * ieee80211_free_txskb - free TX skb
2779 * @hw: the hardware
2780 * @skb: the skb
2781 *
Joe Perches3f2aef12019-10-24 11:32:12 -07002782 * Free a transmit skb. Use this function when some failure
Johannes Berg6096de72011-11-04 11:18:10 +01002783 * to transmit happened and thus status cannot be reported.
2784 */
2785void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
2786
2787/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002788 * DOC: Hardware crypto acceleration
Johannes Berg4150c572007-09-17 01:29:23 -04002789 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002790 * mac80211 is capable of taking advantage of many hardware
2791 * acceleration designs for encryption and decryption operations.
2792 *
2793 * The set_key() callback in the &struct ieee80211_ops for a given
2794 * device is called to enable hardware acceleration of encryption and
Johannes Bergdc822b52008-12-29 12:55:09 +01002795 * decryption. The callback takes a @sta parameter that will be NULL
2796 * for default keys or keys used for transmission only, or point to
2797 * the station information for the peer for individual keys.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002798 * Multiple transmission keys with the same key index may be used when
2799 * VLANs are configured for an access point.
2800 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002801 * When transmitting, the TX control data will use the @hw_key_idx
2802 * selected by the driver by modifying the &struct ieee80211_key_conf
2803 * pointed to by the @key parameter to the set_key() function.
2804 *
2805 * The set_key() call for the %SET_KEY command should return 0 if
2806 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
2807 * added; if you return 0 then hw_key_idx must be assigned to the
2808 * hardware key index, you are free to use the full u8 range.
2809 *
Johannes Bergfa7e1fb2015-01-22 18:44:19 +01002810 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is
2811 * set, mac80211 will not automatically fall back to software crypto if
2812 * enabling hardware crypto failed. The set_key() call may also return the
2813 * value 1 to permit this specific key/algorithm to be done in software.
2814 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002815 * When the cmd is %DISABLE_KEY then it must succeed.
2816 *
2817 * Note that it is permissible to not decrypt a frame even if a key
2818 * for it has been uploaded to hardware, the stack will not make any
2819 * decision based on whether a key has been uploaded or not but rather
2820 * based on the receive flags.
2821 *
2822 * The &struct ieee80211_key_conf structure pointed to by the @key
2823 * parameter is guaranteed to be valid until another call to set_key()
2824 * removes it, but it can only be used as a cookie to differentiate
2825 * keys.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02002826 *
2827 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
2828 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
2829 * handler.
2830 * The update_tkip_key() call updates the driver with the new phase 1 key.
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002831 * This happens every time the iv16 wraps around (every 65536 packets). The
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02002832 * set_key() call will happen only once for each key (unless the AP did
2833 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
Bob Copelande37d4df2008-10-20 21:20:27 -04002834 * provided by update_tkip_key only. The trigger that makes mac80211 call this
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02002835 * handler is software decryption with wrap around of iv16.
Yoni Divinskyde5fad82012-05-30 11:36:39 +03002836 *
2837 * The set_default_unicast_key() call updates the default WEP key index
2838 * configured to the hardware for WEP encryption type. This is required
2839 * for devices that support offload of data packets (e.g. ARP responses).
Alexander Wetzel62872a92018-08-31 15:00:38 +02002840 *
2841 * Mac80211 drivers should set the @NL80211_EXT_FEATURE_CAN_REPLACE_PTK0 flag
Randy Dunlap66b239d2020-07-15 09:43:24 -07002842 * when they are able to replace in-use PTK keys according to the following
Alexander Wetzel62872a92018-08-31 15:00:38 +02002843 * requirements:
Alexander Wetzel33092ac2021-09-24 22:05:14 +02002844 * 1) They do not hand over frames decrypted with the old key to mac80211
2845 once the call to set_key() with command %DISABLE_KEY has been completed,
Alexander Wetzel62872a92018-08-31 15:00:38 +02002846 2) either drop or continue to use the old key for any outgoing frames queued
2847 at the time of the key deletion (including re-transmits),
2848 3) never send out a frame queued prior to the set_key() %SET_KEY command
Alexander Wetzel33092ac2021-09-24 22:05:14 +02002849 encrypted with the new key when also needing
2850 @IEEE80211_KEY_FLAG_GENERATE_IV and
Alexander Wetzel62872a92018-08-31 15:00:38 +02002851 4) never send out a frame unencrypted when it should be encrypted.
2852 Mac80211 will not queue any new frames for a deleted key to the driver.
Johannes Berg4150c572007-09-17 01:29:23 -04002853 */
Johannes Berg4150c572007-09-17 01:29:23 -04002854
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002855/**
Johannes Berg4be8c382009-01-07 18:28:20 +01002856 * DOC: Powersave support
2857 *
2858 * mac80211 has support for various powersave implementations.
2859 *
Kalle Valoc99445b2010-01-14 13:09:21 +02002860 * First, it can support hardware that handles all powersaving by itself,
2861 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
2862 * flag. In that case, it will be told about the desired powersave mode
2863 * with the %IEEE80211_CONF_PS flag depending on the association status.
2864 * The hardware must take care of sending nullfunc frames when necessary,
2865 * i.e. when entering and leaving powersave mode. The hardware is required
2866 * to look at the AID in beacons and signal to the AP that it woke up when
2867 * it finds traffic directed to it.
Johannes Berg4be8c382009-01-07 18:28:20 +01002868 *
Kalle Valoc99445b2010-01-14 13:09:21 +02002869 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
2870 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
2871 * with hardware wakeup and sleep states. Driver is responsible for waking
Bob Copeland2738bd62010-08-21 16:39:01 -04002872 * up the hardware before issuing commands to the hardware and putting it
2873 * back to sleep at appropriate times.
Kalle Valoc99445b2010-01-14 13:09:21 +02002874 *
2875 * When PS is enabled, hardware needs to wakeup for beacons and receive the
2876 * buffered multicast/broadcast frames after the beacon. Also it must be
2877 * possible to send frames and receive the acknowledment frame.
Johannes Berg4be8c382009-01-07 18:28:20 +01002878 *
2879 * Other hardware designs cannot send nullfunc frames by themselves and also
2880 * need software support for parsing the TIM bitmap. This is also supported
2881 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
2882 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
Johannes Berg955394c2009-04-16 17:04:25 +02002883 * required to pass up beacons. The hardware is still required to handle
2884 * waking up for multicast traffic; if it cannot the driver must handle that
Kalle Valoc99445b2010-01-14 13:09:21 +02002885 * as best as it can, mac80211 is too slow to do that.
Johannes Berg4be8c382009-01-07 18:28:20 +01002886 *
Kalle Valoc99445b2010-01-14 13:09:21 +02002887 * Dynamic powersave is an extension to normal powersave in which the
2888 * hardware stays awake for a user-specified period of time after sending a
2889 * frame so that reply frames need not be buffered and therefore delayed to
2890 * the next wakeup. It's compromise of getting good enough latency when
2891 * there's data traffic and still saving significantly power in idle
2892 * periods.
2893 *
Bob Copeland2738bd62010-08-21 16:39:01 -04002894 * Dynamic powersave is simply supported by mac80211 enabling and disabling
Kalle Valoc99445b2010-01-14 13:09:21 +02002895 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
2896 * flag and mac80211 will handle everything automatically. Additionally,
2897 * hardware having support for the dynamic PS feature may set the
2898 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
2899 * dynamic PS mode itself. The driver needs to look at the
2900 * @dynamic_ps_timeout hardware configuration value and use it that value
2901 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
2902 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
2903 * enabled whenever user has enabled powersave.
2904 *
2905 * Driver informs U-APSD client support by enabling
Johannes Berg848955c2014-11-11 12:48:42 +01002906 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
Masanari Iidae2278672014-02-18 22:54:36 +09002907 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
Kalle Valoc99445b2010-01-14 13:09:21 +02002908 * Nullfunc frames and stay awake until the service period has ended. To
2909 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
2910 * from that AC are transmitted with powersave enabled.
2911 *
2912 * Note: U-APSD client mode is not yet supported with
2913 * %IEEE80211_HW_PS_NULLFUNC_STACK.
Johannes Berg4be8c382009-01-07 18:28:20 +01002914 */
2915
2916/**
Kalle Valo04de8382009-03-22 21:57:35 +02002917 * DOC: Beacon filter support
2918 *
2919 * Some hardware have beacon filter support to reduce host cpu wakeups
Justin P. Mattock42b2aa82011-11-28 20:31:00 -08002920 * which will reduce system power consumption. It usually works so that
Kalle Valo04de8382009-03-22 21:57:35 +02002921 * the firmware creates a checksum of the beacon but omits all constantly
2922 * changing elements (TSF, TIM etc). Whenever the checksum changes the
2923 * beacon is forwarded to the host, otherwise it will be just dropped. That
2924 * way the host will only receive beacons where some relevant information
2925 * (for example ERP protection or WMM settings) have changed.
2926 *
Johannes Bergc1288b12012-01-19 09:29:57 +01002927 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
2928 * interface capability. The driver needs to enable beacon filter support
Johannes Berg955394c2009-04-16 17:04:25 +02002929 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
2930 * power save is enabled, the stack will not check for beacon loss and the
2931 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
2932 *
2933 * The time (or number of beacons missed) until the firmware notifies the
2934 * driver of a beacon loss event (which in turn causes the driver to call
2935 * ieee80211_beacon_loss()) should be configurable and will be controlled
2936 * by mac80211 and the roaming algorithm in the future.
2937 *
2938 * Since there may be constantly changing information elements that nothing
2939 * in the software stack cares about, we will, in the future, have mac80211
2940 * tell the driver which information elements are interesting in the sense
2941 * that we want to see changes in them. This will include
Jani Nikulab4f7f4a2016-10-21 15:57:23 +03002942 *
Johannes Berg955394c2009-04-16 17:04:25 +02002943 * - a list of information element IDs
2944 * - a list of OUIs for the vendor information element
2945 *
2946 * Ideally, the hardware would filter out any beacons without changes in the
2947 * requested elements, but if it cannot support that it may, at the expense
2948 * of some efficiency, filter out only a subset. For example, if the device
2949 * doesn't support checking for OUIs it should pass up all changes in all
2950 * vendor information elements.
2951 *
2952 * Note that change, for the sake of simplification, also includes information
2953 * elements appearing or disappearing from the beacon.
2954 *
2955 * Some hardware supports an "ignore list" instead, just make sure nothing
2956 * that was requested is on the ignore list, and include commonly changing
2957 * information element IDs in the ignore list, for example 11 (BSS load) and
2958 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2959 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2960 * it could also include some currently unused IDs.
2961 *
2962 *
2963 * In addition to these capabilities, hardware should support notifying the
2964 * host of changes in the beacon RSSI. This is relevant to implement roaming
2965 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2966 * the received data packets). This can consist in notifying the host when
2967 * the RSSI changes significantly or when it drops below or rises above
2968 * configurable thresholds. In the future these thresholds will also be
2969 * configured by mac80211 (which gets them from userspace) to implement
2970 * them as the roaming algorithm requires.
2971 *
2972 * If the hardware cannot implement this, the driver should ask it to
2973 * periodically pass beacon frames to the host so that software can do the
2974 * signal strength threshold checking.
Kalle Valo04de8382009-03-22 21:57:35 +02002975 */
2976
2977/**
Johannes Berg0f782312009-12-01 13:37:02 +01002978 * DOC: Spatial multiplexing power save
2979 *
2980 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2981 * power in an 802.11n implementation. For details on the mechanism
2982 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2983 * "11.2.3 SM power save".
2984 *
2985 * The mac80211 implementation is capable of sending action frames
2986 * to update the AP about the station's SMPS mode, and will instruct
2987 * the driver to enter the specific mode. It will also announce the
2988 * requested SMPS mode during the association handshake. Hardware
2989 * support for this feature is required, and can be indicated by
2990 * hardware flags.
2991 *
2992 * The default mode will be "automatic", which nl80211/cfg80211
2993 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2994 * turned off otherwise.
2995 *
2996 * To support this feature, the driver must set the appropriate
2997 * hardware support flags, and handle the SMPS flag to the config()
2998 * operation. It will then with this mechanism be instructed to
2999 * enter the requested SMPS mode while associated to an HT AP.
3000 */
3001
3002/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003003 * DOC: Frame filtering
3004 *
3005 * mac80211 requires to see many management frames for proper
3006 * operation, and users may want to see many more frames when
3007 * in monitor mode. However, for best CPU usage and power consumption,
3008 * having as few frames as possible percolate through the stack is
3009 * desirable. Hence, the hardware should filter as much as possible.
3010 *
3011 * To achieve this, mac80211 uses filter flags (see below) to tell
3012 * the driver's configure_filter() function which frames should be
3013 * passed to mac80211 and which should be filtered out.
3014 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02003015 * Before configure_filter() is invoked, the prepare_multicast()
3016 * callback is invoked with the parameters @mc_count and @mc_list
3017 * for the combined multicast address list of all virtual interfaces.
3018 * It's use is optional, and it returns a u64 that is passed to
3019 * configure_filter(). Additionally, configure_filter() has the
3020 * arguments @changed_flags telling which flags were changed and
3021 * @total_flags with the new flag states.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003022 *
3023 * If your device has no multicast address filters your driver will
3024 * need to check both the %FIF_ALLMULTI flag and the @mc_count
3025 * parameter to see whether multicast frames should be accepted
3026 * or dropped.
3027 *
Michael Bueschd0f5afb2008-02-12 20:12:45 +01003028 * All unsupported flags in @total_flags must be cleared.
3029 * Hardware does not support a flag if it is incapable of _passing_
3030 * the frame to the stack. Otherwise the driver must ignore
3031 * the flag, but not clear it.
3032 * You must _only_ clear the flag (announce no support for the
3033 * flag to mac80211) if you are not able to pass the packet type
3034 * to the stack (so the hardware always filters it).
3035 * So for example, you should clear @FIF_CONTROL, if your hardware
3036 * always filters control frames. If your hardware always passes
3037 * control frames to the kernel and is incapable of filtering them,
3038 * you do _not_ clear the @FIF_CONTROL flag.
3039 * This rule applies to all other FIF flags as well.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003040 */
3041
3042/**
Johannes Berg4b801bc2011-09-29 16:04:40 +02003043 * DOC: AP support for powersaving clients
3044 *
3045 * In order to implement AP and P2P GO modes, mac80211 has support for
3046 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
3047 * There currently is no support for sAPSD.
3048 *
3049 * There is one assumption that mac80211 makes, namely that a client
3050 * will not poll with PS-Poll and trigger with uAPSD at the same time.
3051 * Both are supported, and both can be used by the same client, but
3052 * they can't be used concurrently by the same client. This simplifies
3053 * the driver code.
3054 *
3055 * The first thing to keep in mind is that there is a flag for complete
3056 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
3057 * mac80211 expects the driver to handle most of the state machine for
3058 * powersaving clients and will ignore the PM bit in incoming frames.
3059 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
3060 * stations' powersave transitions. In this mode, mac80211 also doesn't
3061 * handle PS-Poll/uAPSD.
3062 *
3063 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
3064 * PM bit in incoming frames for client powersave transitions. When a
3065 * station goes to sleep, we will stop transmitting to it. There is,
3066 * however, a race condition: a station might go to sleep while there is
3067 * data buffered on hardware queues. If the device has support for this
3068 * it will reject frames, and the driver should give the frames back to
3069 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
3070 * cause mac80211 to retry the frame when the station wakes up. The
3071 * driver is also notified of powersave transitions by calling its
3072 * @sta_notify callback.
3073 *
3074 * When the station is asleep, it has three choices: it can wake up,
3075 * it can PS-Poll, or it can possibly start a uAPSD service period.
3076 * Waking up is implemented by simply transmitting all buffered (and
3077 * filtered) frames to the station. This is the easiest case. When
3078 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
3079 * will inform the driver of this with the @allow_buffered_frames
3080 * callback; this callback is optional. mac80211 will then transmit
Johannes Berg02f2f1a2012-02-27 12:18:30 +01003081 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
Johannes Berg4b801bc2011-09-29 16:04:40 +02003082 * on each frame. The last frame in the service period (or the only
3083 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
3084 * indicate that it ends the service period; as this frame must have
3085 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
3086 * When TX status is reported for this frame, the service period is
3087 * marked has having ended and a new one can be started by the peer.
3088 *
Johannes Berg02f2f1a2012-02-27 12:18:30 +01003089 * Additionally, non-bufferable MMPDUs can also be transmitted by
3090 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
3091 *
Johannes Berg4b801bc2011-09-29 16:04:40 +02003092 * Another race condition can happen on some devices like iwlwifi
3093 * when there are frames queued for the station and it wakes up
3094 * or polls; the frames that are already queued could end up being
3095 * transmitted first instead, causing reordering and/or wrong
3096 * processing of the EOSP. The cause is that allowing frames to be
3097 * transmitted to a certain station is out-of-band communication to
3098 * the device. To allow this problem to be solved, the driver can
3099 * call ieee80211_sta_block_awake() if frames are buffered when it
3100 * is notified that the station went to sleep. When all these frames
3101 * have been filtered (see above), it must call the function again
3102 * to indicate that the station is no longer blocked.
3103 *
3104 * If the driver buffers frames in the driver for aggregation in any
3105 * way, it must use the ieee80211_sta_set_buffered() call when it is
3106 * notified of the station going to sleep to inform mac80211 of any
3107 * TIDs that have frames buffered. Note that when a station wakes up
3108 * this information is reset (hence the requirement to call it when
3109 * informed of the station going to sleep). Then, when a service
3110 * period starts for any reason, @release_buffered_frames is called
3111 * with the number of frames to be released and which TIDs they are
3112 * to come from. In this case, the driver is responsible for setting
3113 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
Masanari Iidae2278672014-02-18 22:54:36 +09003114 * to help the @more_data parameter is passed to tell the driver if
Johannes Berg4b801bc2011-09-29 16:04:40 +02003115 * there is more data on other TIDs -- the TIDs to release frames
3116 * from are ignored since mac80211 doesn't know how many frames the
3117 * buffers for those TIDs contain.
3118 *
3119 * If the driver also implement GO mode, where absence periods may
3120 * shorten service periods (or abort PS-Poll responses), it must
3121 * filter those response frames except in the case of frames that
3122 * are buffered in the driver -- those must remain buffered to avoid
3123 * reordering. Because it is possible that no frames are released
Johannes Berge9437892013-02-15 21:38:08 +01003124 * in this case, the driver must call ieee80211_sta_eosp()
Johannes Berg4b801bc2011-09-29 16:04:40 +02003125 * to indicate to mac80211 that the service period ended anyway.
3126 *
3127 * Finally, if frames from multiple TIDs are released from mac80211
3128 * but the driver might reorder them, it must clear & set the flags
3129 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
3130 * and also take care of the EOSP and MORE_DATA bits in the frame.
Johannes Berge9437892013-02-15 21:38:08 +01003131 * The driver may also use ieee80211_sta_eosp() in this case.
Johannes Bergb77cf4f2014-01-09 00:00:38 +01003132 *
3133 * Note that if the driver ever buffers frames other than QoS-data
3134 * frames, it must take care to never send a non-QoS-data frame as
3135 * the last frame in a service period, adding a QoS-nulldata frame
3136 * after a non-QoS-data frame if needed.
Johannes Berg4b801bc2011-09-29 16:04:40 +02003137 */
3138
3139/**
Johannes Berg3a25a8c2012-04-03 16:28:50 +02003140 * DOC: HW queue control
3141 *
3142 * Before HW queue control was introduced, mac80211 only had a single static
3143 * assignment of per-interface AC software queues to hardware queues. This
3144 * was problematic for a few reasons:
3145 * 1) off-channel transmissions might get stuck behind other frames
3146 * 2) multiple virtual interfaces couldn't be handled correctly
3147 * 3) after-DTIM frames could get stuck behind other frames
3148 *
3149 * To solve this, hardware typically uses multiple different queues for all
3150 * the different usages, and this needs to be propagated into mac80211 so it
3151 * won't have the same problem with the software queues.
3152 *
3153 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
3154 * flag that tells it that the driver implements its own queue control. To do
3155 * so, the driver will set up the various queues in each &struct ieee80211_vif
3156 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
3157 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
3158 * if necessary will queue the frame on the right software queue that mirrors
3159 * the hardware queue.
3160 * Additionally, the driver has to then use these HW queue IDs for the queue
3161 * management functions (ieee80211_stop_queue() et al.)
3162 *
3163 * The driver is free to set up the queue mappings as needed, multiple virtual
3164 * interfaces may map to the same hardware queues if needed. The setup has to
3165 * happen during add_interface or change_interface callbacks. For example, a
3166 * driver supporting station+station and station+AP modes might decide to have
3167 * 10 hardware queues to handle different scenarios:
3168 *
3169 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
3170 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
3171 * after-DTIM queue for AP: 8
3172 * off-channel queue: 9
3173 *
3174 * It would then set up the hardware like this:
3175 * hw.offchannel_tx_hw_queue = 9
3176 *
3177 * and the first virtual interface that is added as follows:
3178 * vif.hw_queue[IEEE80211_AC_VO] = 0
3179 * vif.hw_queue[IEEE80211_AC_VI] = 1
3180 * vif.hw_queue[IEEE80211_AC_BE] = 2
3181 * vif.hw_queue[IEEE80211_AC_BK] = 3
3182 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
3183 * and the second virtual interface with 4-7.
3184 *
3185 * If queue 6 gets full, for example, mac80211 would only stop the second
3186 * virtual interface's BE queue since virtual interface queues are per AC.
3187 *
3188 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
3189 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
3190 * queue could potentially be shared since mac80211 will look at cab_queue when
3191 * a queue is stopped/woken even if the interface is not in AP mode.
3192 */
3193
3194/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003195 * enum ieee80211_filter_flags - hardware filter flags
3196 *
3197 * These flags determine what the filter in hardware should be
3198 * programmed to let through and what should not be passed to the
3199 * stack. It is always safe to pass more frames than requested,
3200 * but this has negative impact on power consumption.
3201 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003202 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
3203 * by the user or if the hardware is not capable of filtering by
3204 * multicast address.
3205 *
3206 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
3207 * %RX_FLAG_FAILED_FCS_CRC for them)
3208 *
3209 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
3210 * the %RX_FLAG_FAILED_PLCP_CRC for them
3211 *
3212 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
3213 * to the hardware that it should not filter beacons or probe responses
3214 * by BSSID. Filtering them can greatly reduce the amount of processing
3215 * mac80211 needs to do and the amount of CPU wakeups, so you should
3216 * honour this flag if possible.
3217 *
Johannes Bergdf140462015-04-22 14:40:58 +02003218 * @FIF_CONTROL: pass control frames (except for PS Poll) addressed to this
3219 * station
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003220 *
3221 * @FIF_OTHER_BSS: pass frames destined to other BSSes
Igor Perminove3b90ca2009-08-04 16:48:51 +04003222 *
Jakub Kicinskic2d39552015-06-02 21:10:13 +02003223 * @FIF_PSPOLL: pass PS Poll frames
Johannes Berg7be50862010-10-13 12:06:24 +02003224 *
3225 * @FIF_PROBE_REQ: pass probe request frames
Jouni Malinen873b1cf2020-04-21 17:48:15 +03003226 *
3227 * @FIF_MCAST_ACTION: pass multicast Action frames
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003228 */
3229enum ieee80211_filter_flags {
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003230 FIF_ALLMULTI = 1<<1,
3231 FIF_FCSFAIL = 1<<2,
3232 FIF_PLCPFAIL = 1<<3,
3233 FIF_BCN_PRBRESP_PROMISC = 1<<4,
3234 FIF_CONTROL = 1<<5,
3235 FIF_OTHER_BSS = 1<<6,
Igor Perminove3b90ca2009-08-04 16:48:51 +04003236 FIF_PSPOLL = 1<<7,
Johannes Berg7be50862010-10-13 12:06:24 +02003237 FIF_PROBE_REQ = 1<<8,
Jouni Malinen873b1cf2020-04-21 17:48:15 +03003238 FIF_MCAST_ACTION = 1<<9,
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003239};
3240
3241/**
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02003242 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
3243 *
3244 * These flags are used with the ampdu_action() callback in
3245 * &struct ieee80211_ops to indicate which action is needed.
Johannes Berg827d42c92009-11-22 12:28:41 +01003246 *
3247 * Note that drivers MUST be able to deal with a TX aggregation
3248 * session being stopped even before they OK'ed starting it by
Johannes Berg5d22c892010-06-10 10:21:40 +02003249 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
Johannes Berg827d42c92009-11-22 12:28:41 +01003250 * might receive the addBA frame and send a delBA right away!
3251 *
Johannes Berg18b559d2012-07-18 13:51:25 +02003252 * @IEEE80211_AMPDU_RX_START: start RX aggregation
3253 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
Johannes Berg2ce113d2019-10-02 11:12:25 +02003254 * @IEEE80211_AMPDU_TX_START: start TX aggregation, the driver must either
Mordechay Goodstein0c197f12020-03-26 15:09:38 +02003255 * call ieee80211_start_tx_ba_cb_irqsafe() or
3256 * call ieee80211_start_tx_ba_cb_irqsafe() with status
3257 * %IEEE80211_AMPDU_TX_START_DELAY_ADDBA to delay addba after
3258 * ieee80211_start_tx_ba_cb_irqsafe is called, or just return the special
Johannes Berg2ce113d2019-10-02 11:12:25 +02003259 * status %IEEE80211_AMPDU_TX_START_IMMEDIATE.
Johannes Bergb1720232009-03-23 17:28:39 +01003260 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
Johannes Berg18b559d2012-07-18 13:51:25 +02003261 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
3262 * queued packets, now unaggregated. After all packets are transmitted the
3263 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
3264 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
3265 * called when the station is removed. There's no need or reason to call
3266 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
3267 * session is gone and removes the station.
3268 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
3269 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
3270 * now the connection is dropped and the station will be removed. Drivers
3271 * should clean up and drop remaining packets when this is called.
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02003272 */
3273enum ieee80211_ampdu_mlme_action {
3274 IEEE80211_AMPDU_RX_START,
3275 IEEE80211_AMPDU_RX_STOP,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003276 IEEE80211_AMPDU_TX_START,
Johannes Berg18b559d2012-07-18 13:51:25 +02003277 IEEE80211_AMPDU_TX_STOP_CONT,
3278 IEEE80211_AMPDU_TX_STOP_FLUSH,
3279 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
Johannes Bergb1720232009-03-23 17:28:39 +01003280 IEEE80211_AMPDU_TX_OPERATIONAL,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02003281};
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003282
Johannes Berg2ce113d2019-10-02 11:12:25 +02003283#define IEEE80211_AMPDU_TX_START_IMMEDIATE 1
Mordechay Goodstein0c197f12020-03-26 15:09:38 +02003284#define IEEE80211_AMPDU_TX_START_DELAY_ADDBA 2
Johannes Berg2ce113d2019-10-02 11:12:25 +02003285
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003286/**
Sara Sharon50ea05efa2015-12-30 16:06:04 +02003287 * struct ieee80211_ampdu_params - AMPDU action parameters
3288 *
3289 * @action: the ampdu action, value from %ieee80211_ampdu_mlme_action.
3290 * @sta: peer of this AMPDU session
3291 * @tid: tid of the BA session
3292 * @ssn: start sequence number of the session. TX/RX_STOP can pass 0. When
3293 * action is set to %IEEE80211_AMPDU_RX_START the driver passes back the
3294 * actual ssn value used to start the session and writes the value here.
3295 * @buf_size: reorder buffer size (number of subframes). Valid only when the
3296 * action is set to %IEEE80211_AMPDU_RX_START or
3297 * %IEEE80211_AMPDU_TX_OPERATIONAL
3298 * @amsdu: indicates the peer's ability to receive A-MSDU within A-MPDU.
3299 * valid when the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL
3300 * @timeout: BA session timeout. Valid only when the action is set to
3301 * %IEEE80211_AMPDU_RX_START
3302 */
3303struct ieee80211_ampdu_params {
3304 enum ieee80211_ampdu_mlme_action action;
3305 struct ieee80211_sta *sta;
3306 u16 tid;
3307 u16 ssn;
Luca Coelho41cbb0f2018-06-09 09:14:44 +03003308 u16 buf_size;
Sara Sharon50ea05efa2015-12-30 16:06:04 +02003309 bool amsdu;
3310 u16 timeout;
3311};
3312
3313/**
Johannes Berg4049e092011-09-29 16:04:32 +02003314 * enum ieee80211_frame_release_type - frame release reason
3315 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
Johannes Berg47086fc2011-09-29 16:04:33 +02003316 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
3317 * frame received on trigger-enabled AC
Johannes Berg4049e092011-09-29 16:04:32 +02003318 */
3319enum ieee80211_frame_release_type {
3320 IEEE80211_FRAME_RELEASE_PSPOLL,
Johannes Berg47086fc2011-09-29 16:04:33 +02003321 IEEE80211_FRAME_RELEASE_UAPSD,
Johannes Berg4049e092011-09-29 16:04:32 +02003322};
3323
3324/**
Johannes Berg8f727ef2012-03-30 08:43:32 +02003325 * enum ieee80211_rate_control_changed - flags to indicate what changed
3326 *
3327 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
Johannes Berge1a0c6b2013-02-07 11:47:44 +01003328 * to this station changed. The actual bandwidth is in the station
3329 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
3330 * flag changes, for HT and VHT the bandwidth field changes.
Johannes Berg8f727ef2012-03-30 08:43:32 +02003331 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
Antonio Quartullie687f612012-08-12 18:24:55 +02003332 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
3333 * changed (in IBSS mode) due to discovering more information about
3334 * the peer.
Johannes Berg0af83d32012-12-27 18:55:36 +01003335 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
3336 * by the peer
Johannes Berg8f727ef2012-03-30 08:43:32 +02003337 */
3338enum ieee80211_rate_control_changed {
3339 IEEE80211_RC_BW_CHANGED = BIT(0),
3340 IEEE80211_RC_SMPS_CHANGED = BIT(1),
Antonio Quartullie687f612012-08-12 18:24:55 +02003341 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
Johannes Berg0af83d32012-12-27 18:55:36 +01003342 IEEE80211_RC_NSS_CHANGED = BIT(3),
Johannes Berg8f727ef2012-03-30 08:43:32 +02003343};
3344
3345/**
Ilan Peerd339d5c2013-02-12 09:34:13 +02003346 * enum ieee80211_roc_type - remain on channel type
3347 *
3348 * With the support for multi channel contexts and multi channel operations,
3349 * remain on channel operations might be limited/deferred/aborted by other
Chris Packhamae4a50e2019-10-25 10:36:47 +13003350 * flows/operations which have higher priority (and vice versa).
Ilan Peerd339d5c2013-02-12 09:34:13 +02003351 * Specifying the ROC type can be used by devices to prioritize the ROC
3352 * operations compared to other operations/flows.
3353 *
3354 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
3355 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
Chris Packhamae4a50e2019-10-25 10:36:47 +13003356 * for sending management frames offchannel.
Ilan Peerd339d5c2013-02-12 09:34:13 +02003357 */
3358enum ieee80211_roc_type {
3359 IEEE80211_ROC_TYPE_NORMAL = 0,
3360 IEEE80211_ROC_TYPE_MGMT_TX,
3361};
3362
3363/**
Mauro Carvalho Chehabb1e8eb12020-10-23 18:33:08 +02003364 * enum ieee80211_reconfig_type - reconfig type
Eliad Pellercf2c92d2014-11-04 11:43:54 +02003365 *
3366 * This enum is used by the reconfig_complete() callback to indicate what
3367 * reconfiguration type was completed.
3368 *
3369 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
3370 * (also due to resume() callback returning 1)
3371 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
3372 * of wowlan configuration)
3373 */
3374enum ieee80211_reconfig_type {
3375 IEEE80211_RECONFIG_TYPE_RESTART,
3376 IEEE80211_RECONFIG_TYPE_SUSPEND,
3377};
3378
3379/**
Johannes Berg15fae342021-06-18 13:41:55 +03003380 * struct ieee80211_prep_tx_info - prepare TX information
3381 * @duration: if non-zero, hint about the required duration,
3382 * only used with the mgd_prepare_tx() method.
3383 * @subtype: frame subtype (auth, (re)assoc, deauth, disassoc)
3384 * @success: whether the frame exchange was successful, only
3385 * used with the mgd_complete_tx() method, and then only
3386 * valid for auth and (re)assoc.
3387 */
3388struct ieee80211_prep_tx_info {
3389 u16 duration;
3390 u16 subtype;
3391 u8 success:1;
3392};
3393
3394/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003395 * struct ieee80211_ops - callbacks from mac80211 to the driver
3396 *
3397 * This structure contains various callbacks that the driver may
3398 * handle or, in some cases, must handle, for example to configure
3399 * the hardware to a new channel or to transmit a frame.
3400 *
3401 * @tx: Handler that 802.11 module calls for each transmitted frame.
3402 * skb contains the buffer starting from the IEEE 802.11 header.
3403 * The low-level driver should send the frame out based on
Johannes Bergeefce912008-05-17 00:57:13 +02003404 * configuration in the TX control data. This handler should,
Johannes Berg11127e92011-11-16 16:02:47 +01003405 * preferably, never fail and stop queues appropriately.
Johannes Berg11127e92011-11-16 16:02:47 +01003406 * Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003407 *
3408 * @start: Called before the first netdevice attached to the hardware
3409 * is enabled. This should turn on the hardware and must turn on
3410 * frame reception (for possibly enabled monitor interfaces.)
3411 * Returns negative error codes, these may be seen in userspace,
3412 * or zero.
3413 * When the device is started it should not have a MAC address
3414 * to avoid acknowledging frames before a non-monitor device
3415 * is added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01003416 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003417 *
3418 * @stop: Called after last netdevice attached to the hardware
3419 * is disabled. This should turn off the hardware (at least
3420 * it must turn off frame reception.)
3421 * May be called right after add_interface if that rejects
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04003422 * an interface. If you added any work onto the mac80211 workqueue
3423 * you should ensure to cancel it on this callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01003424 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003425 *
Johannes Bergeecc4802011-05-04 15:37:29 +02003426 * @suspend: Suspend the device; mac80211 itself will quiesce before and
3427 * stop transmitting and doing any other configuration, and then
3428 * ask the device to suspend. This is only invoked when WoWLAN is
3429 * configured, otherwise the device is deconfigured completely and
3430 * reconfigured at resume time.
Johannes Berg2b4562d2011-07-02 00:02:01 +02003431 * The driver may also impose special conditions under which it
3432 * wants to use the "normal" suspend (deconfigure), say if it only
3433 * supports WoWLAN when the device is associated. In this case, it
3434 * must return 1 from this function.
Johannes Bergeecc4802011-05-04 15:37:29 +02003435 *
3436 * @resume: If WoWLAN was configured, this indicates that mac80211 is
3437 * now resuming its operation, after this the device must be fully
3438 * functional again. If this returns an error, the only way out is
3439 * to also unregister the device. If it returns 1, then mac80211
3440 * will also go through the regular complete restart on resume.
3441 *
Johannes Bergd13e1412012-06-09 10:31:09 +02003442 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
3443 * modified. The reason is that device_set_wakeup_enable() is
3444 * supposed to be called when the configuration changes, not only
3445 * in suspend().
3446 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003447 * @add_interface: Called when a netdevice attached to the hardware is
Bob Copelande37d4df2008-10-20 21:20:27 -04003448 * enabled. Because it is not called for monitor mode devices, @start
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003449 * and @stop must be implemented.
3450 * The driver should perform any initialization it needs before
3451 * the device can be enabled. The initial configuration for the
3452 * interface is given in the conf parameter.
3453 * The callback may refuse to add an interface by returning a
3454 * negative error code (which will be seen in userspace.)
Kalle Valoe1781ed2009-12-23 13:15:47 +01003455 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003456 *
Johannes Berg34d4bc42010-08-27 12:35:58 +02003457 * @change_interface: Called when a netdevice changes type. This callback
3458 * is optional, but only if it is supported can interface types be
3459 * switched while the interface is UP. The callback may sleep.
3460 * Note that while an interface is being switched, it will not be
3461 * found by the interface iteration callbacks.
3462 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003463 * @remove_interface: Notifies a driver that an interface is going down.
3464 * The @stop callback is called after this if it is the last interface
3465 * and no monitor interfaces are present.
3466 * When all interfaces are removed, the MAC address in the hardware
3467 * must be cleared so the device no longer acknowledges packets,
3468 * the mac_addr member of the conf structure is, however, set to the
3469 * MAC address of the device going away.
Kalle Valoe1781ed2009-12-23 13:15:47 +01003470 * Hence, this callback must be implemented. It can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003471 *
3472 * @config: Handler for configuration requests. IEEE 802.11 code calls this
3473 * function to change hardware configuration, e.g., channel.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05003474 * This function should never fail but returns a negative error code
Kalle Valoe1781ed2009-12-23 13:15:47 +01003475 * if it does. The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003476 *
Johannes Berg471b3ef2007-12-28 14:32:58 +01003477 * @bss_info_changed: Handler for configuration requests related to BSS
3478 * parameters that may vary during BSS's lifespan, and may affect low
3479 * level driver (e.g. assoc/disassoc status, erp parameters).
3480 * This function should not be used if no BSS has been set, unless
3481 * for association indication. The @changed parameter indicates which
Kalle Valoe1781ed2009-12-23 13:15:47 +01003482 * of the bss parameters has changed when a call is made. The callback
3483 * can sleep.
Johannes Berg471b3ef2007-12-28 14:32:58 +01003484 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02003485 * @prepare_multicast: Prepare for multicast filter configuration.
3486 * This callback is optional, and its return value is passed
3487 * to configure_filter(). This callback must be atomic.
3488 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003489 * @configure_filter: Configure the device's RX filter.
3490 * See the section "Frame filtering" for more information.
Kalle Valoe1781ed2009-12-23 13:15:47 +01003491 * This callback must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003492 *
Andrei Otcheretianski1b09b552015-08-15 22:39:50 +03003493 * @config_iface_filter: Configure the interface's RX filter.
3494 * This callback is optional and is used to configure which frames
3495 * should be passed to mac80211. The filter_flags is the combination
3496 * of FIF_* flags. The changed_flags is a bit mask that indicates
3497 * which flags are changed.
3498 * This callback can sleep.
3499 *
Luis R. Rodriguez546c80c92008-08-14 11:43:20 -07003500 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
Johannes Berg17741cd2008-09-11 00:02:02 +02003501 * must be set or cleared for a given STA. Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003502 *
3503 * @set_key: See the section "Hardware crypto acceleration"
Kalle Valoe1781ed2009-12-23 13:15:47 +01003504 * This callback is only called between add_interface and
3505 * remove_interface calls, i.e. while the given virtual interface
Johannes Bergdc822b52008-12-29 12:55:09 +01003506 * is enabled.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05003507 * Returns a negative error code if the key can't be added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01003508 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003509 *
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02003510 * @update_tkip_key: See the section "Hardware crypto acceleration"
3511 * This callback will be called in the context of Rx. Called for drivers
3512 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
Kalle Valoeb807fb2010-01-24 14:55:12 +02003513 * The callback must be atomic.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02003514 *
Johannes Bergc68f4b82011-07-05 16:35:41 +02003515 * @set_rekey_data: If the device supports GTK rekeying, for example while the
3516 * host is suspended, it can assign this callback to retrieve the data
3517 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
3518 * After rekeying was done it should (for example during resume) notify
3519 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
3520 *
Yoni Divinskyde5fad82012-05-30 11:36:39 +03003521 * @set_default_unicast_key: Set the default (unicast) key index, useful for
3522 * WEP when the device sends data packets autonomously, e.g. for ARP
3523 * offloading. The index can be 0-3, or -1 for unsetting it.
3524 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003525 * @hw_scan: Ask the hardware to service the scan request, no need to start
Johannes Berg8318d782008-01-24 19:38:38 +01003526 * the scan state machine in stack. The scan must honour the channel
Kalle Valo9050bdd2009-03-22 21:57:21 +02003527 * configuration done by the regulatory agent in the wiphy's
3528 * registered bands. The hardware (or the driver) needs to make sure
Johannes Bergde95a54b2009-04-01 11:58:36 +02003529 * that power save is disabled.
3530 * The @req ie/ie_len members are rewritten by mac80211 to contain the
3531 * entire IEs after the SSID, so that drivers need not look at these
3532 * at all but just send them after the SSID -- mac80211 includes the
3533 * (extended) supported rates and HT information (where applicable).
3534 * When the scan finishes, ieee80211_scan_completed() must be called;
3535 * note that it also must be called when the scan cannot finish due to
3536 * any error unless this callback returned a negative error code.
Johannes Berge9da68d2018-10-18 10:35:47 +02003537 * This callback is also allowed to return the special return value 1,
3538 * this indicates that hardware scan isn't desirable right now and a
3539 * software scan should be done instead. A driver wishing to use this
3540 * capability must ensure its (hardware) scan capabilities aren't
3541 * advertised as more capable than mac80211's software scan is.
Kalle Valoe1781ed2009-12-23 13:15:47 +01003542 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003543 *
Eliad Pellerb8564392011-06-13 12:47:30 +03003544 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
3545 * The driver should ask the hardware to cancel the scan (if possible),
3546 * but the scan will be completed only after the driver will call
3547 * ieee80211_scan_completed().
3548 * This callback is needed for wowlan, to prevent enqueueing a new
3549 * scan_work after the low-level driver was already suspended.
3550 * The callback can sleep.
3551 *
Luciano Coelho79f460c2011-05-11 17:09:36 +03003552 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
3553 * specific intervals. The driver must call the
3554 * ieee80211_sched_scan_results() function whenever it finds results.
3555 * This process will continue until sched_scan_stop is called.
3556 *
3557 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
Johannes Berg37e33082014-02-17 10:48:17 +01003558 * In this case, ieee80211_sched_scan_stopped() must not be called.
Luciano Coelho79f460c2011-05-11 17:09:36 +03003559 *
Michael Buesch80e775b2009-02-20 15:37:03 +01003560 * @sw_scan_start: Notifier function that is called just before a software scan
3561 * is started. Can be NULL, if the driver doesn't need this notification.
Johannes Berga344d672014-06-12 22:24:31 +02003562 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
3563 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
3564 * can use this parameter. The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01003565 *
Kalle Valoe1781ed2009-12-23 13:15:47 +01003566 * @sw_scan_complete: Notifier function that is called just after a
3567 * software scan finished. Can be NULL, if the driver doesn't need
3568 * this notification.
3569 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01003570 *
Bob Copeland6dd1bf32009-01-08 21:00:34 -05003571 * @get_stats: Return low-level statistics.
3572 * Returns zero if statistics are available.
Kalle Valoe1781ed2009-12-23 13:15:47 +01003573 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003574 *
Johannes Berg9352c192015-04-20 18:12:41 +02003575 * @get_key_seq: If your device implements encryption in hardware and does
3576 * IV/PN assignment then this callback should be provided to read the
3577 * IV/PN for the given key from hardware.
Kalle Valoe1781ed2009-12-23 13:15:47 +01003578 * The callback must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003579 *
Arik Nemtsovf23a4782010-11-08 11:51:06 +02003580 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
Sara Sharonf3fe4e92016-10-18 23:12:11 +03003581 * if the device does fragmentation by itself. Note that to prevent the
3582 * stack from doing fragmentation IEEE80211_HW_SUPPORTS_TX_FRAG
3583 * should be set as well.
Arik Nemtsovf23a4782010-11-08 11:51:06 +02003584 * The callback can sleep.
3585 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003586 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
Kalle Valoe1781ed2009-12-23 13:15:47 +01003587 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003588 *
Johannes Berg34e89502010-02-03 13:59:58 +01003589 * @sta_add: Notifies low level driver about addition of an associated station,
3590 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
3591 *
3592 * @sta_remove: Notifies low level driver about removal of an associated
Johannes Berg6a9d1b92013-12-04 22:39:17 +01003593 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
3594 * returns it isn't safe to use the pointer, not even RCU protected;
3595 * no RCU grace period is guaranteed between returning here and freeing
3596 * the station. See @sta_pre_rcu_remove if needed.
3597 * This callback can sleep.
Johannes Berg34e89502010-02-03 13:59:58 +01003598 *
Sujith Manoharan77d2ece62012-11-20 08:46:02 +05303599 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
3600 * when a station is added to mac80211's station list. This callback
Johannes Bergc7e9dbc2016-09-14 10:03:00 +02003601 * should be within a CONFIG_MAC80211_DEBUGFS conditional. This
3602 * callback can sleep.
Sujith Manoharan77d2ece62012-11-20 08:46:02 +05303603 *
Johannes Berg34e89502010-02-03 13:59:58 +01003604 * @sta_notify: Notifies low level driver about power state transition of an
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02003605 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
3606 * in AP mode, this callback will not be called when the flag
3607 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
Christian Lamparter4571d3b2008-11-30 00:48:41 +01003608 *
Qiujun Huang07e97332020-03-12 22:44:24 +08003609 * @sta_set_txpwr: Configure the station tx power. This callback set the tx
3610 * power for the station.
3611 * This callback can sleep.
3612 *
Johannes Bergf09603a2012-01-20 13:55:21 +01003613 * @sta_state: Notifies low level driver about state transition of a
3614 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
3615 * This callback is mutually exclusive with @sta_add/@sta_remove.
3616 * It must not fail for down transitions but may fail for transitions
Johannes Berg6a9d1b92013-12-04 22:39:17 +01003617 * up the list of states. Also note that after the callback returns it
3618 * isn't safe to use the pointer, not even RCU protected - no RCU grace
3619 * period is guaranteed between returning here and freeing the station.
3620 * See @sta_pre_rcu_remove if needed.
3621 * The callback can sleep.
3622 *
3623 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
3624 * synchronisation. This is useful if a driver needs to have station
3625 * pointers protected using RCU, it can then use this call to clear
3626 * the pointers instead of waiting for an RCU grace period to elapse
3627 * in @sta_state.
Johannes Bergf09603a2012-01-20 13:55:21 +01003628 * The callback can sleep.
3629 *
Johannes Berg8f727ef2012-03-30 08:43:32 +02003630 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
3631 * used to transmit to the station. The changes are advertised with bits
3632 * from &enum ieee80211_rate_control_changed and the values are reflected
3633 * in the station data. This callback should only be used when the driver
3634 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
3635 * otherwise the rate control algorithm is notified directly.
3636 * Must be atomic.
Johannes Bergf815e2b2014-11-19 00:10:42 +01003637 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
3638 * is only used if the configured rate control algorithm actually uses
3639 * the new rate table API, and is therefore optional. Must be atomic.
Johannes Berg8f727ef2012-03-30 08:43:32 +02003640 *
Johannes Berg2b9a7e12014-11-17 11:35:23 +01003641 * @sta_statistics: Get statistics for this station. For example with beacon
3642 * filtering, the statistics kept by mac80211 might not be accurate, so
3643 * let the driver pre-fill the statistics. The driver can fill most of
3644 * the values (indicating which by setting the filled bitmap), but not
3645 * all of them make sense - see the source for which ones are possible.
3646 * Statistics that the driver doesn't fill will be filled by mac80211.
3647 * The callback can sleep.
3648 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003649 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
Johannes Bergfe3fa822008-09-08 11:05:09 +02003650 * bursting) for a hardware TX queue.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05003651 * Returns a negative error code on failure.
Kalle Valoe1781ed2009-12-23 13:15:47 +01003652 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003653 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003654 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01003655 * this is only used for IBSS mode BSSID merging and debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01003656 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01003657 * The callback can sleep.
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01003658 *
3659 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
Johannes Bergad24b0d2013-07-05 11:53:28 +02003660 * Currently, this is only used for IBSS mode debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01003661 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01003662 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003663 *
Pedersen, Thomas354d3812016-09-28 16:56:28 -07003664 * @offset_tsf: Offset the TSF timer by the specified value in the
3665 * firmware/hardware. Preferred to set_tsf as it avoids delay between
3666 * calling set_tsf() and hardware getting programmed, which will show up
3667 * as TSF delay. Is not a required function.
3668 * The callback can sleep.
3669 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003670 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
3671 * with other STAs in the IBSS. This is only used in IBSS mode. This
3672 * function is optional if the firmware/hardware takes full care of
3673 * TSF synchronization.
Kalle Valoe1781ed2009-12-23 13:15:47 +01003674 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003675 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003676 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
3677 * This is needed only for IBSS mode and the result of this function is
3678 * used to determine whether to reply to Probe Requests.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05003679 * Returns non-zero if this device sent the last beacon.
Kalle Valoe1781ed2009-12-23 13:15:47 +01003680 * The callback can sleep.
Ron Rindjunskyd3c990f2007-11-26 16:14:34 +02003681 *
Randy Dunlap4e8998f2010-05-21 11:28:33 -07003682 * @get_survey: Return per-channel survey information
3683 *
Johannes Berg1f87f7d2009-06-02 13:01:41 +02003684 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
3685 * need to set wiphy->rfkill_poll to %true before registration,
3686 * and need to call wiphy_rfkill_set_hw_state() in the callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01003687 * The callback can sleep.
Johannes Bergaff89a92009-07-01 21:26:51 +02003688 *
Lukáš Turek310bc672009-12-21 22:50:48 +01003689 * @set_coverage_class: Set slot time for given coverage class as specified
3690 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
Lorenzo Bianconia4bcaf52014-09-04 23:57:41 +02003691 * accordingly; coverage class equals to -1 to enable ACK timeout
3692 * estimation algorithm (dynack). To disable dynack set valid value for
3693 * coverage class. This callback is not required and may sleep.
Lukáš Turek310bc672009-12-21 22:50:48 +01003694 *
David Spinadel52981cd2013-07-31 18:06:22 +03003695 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
3696 * be %NULL. The callback can sleep.
Wey-Yi Guy71063f02011-05-20 09:05:54 -07003697 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
Johannes Berga80f7c02009-12-23 13:15:32 +01003698 *
3699 * @flush: Flush all pending frames from the hardware queue, making sure
Johannes Berg39ecc012013-02-13 12:11:00 +01003700 * that the hardware queues are empty. The @queues parameter is a bitmap
3701 * of queues to flush, which is useful if different virtual interfaces
3702 * use different hardware queues; it may also indicate all queues.
3703 * If the parameter @drop is set to %true, pending frames may be dropped.
Emmanuel Grumbach77be2c52014-03-27 11:30:29 +02003704 * Note that vif can be NULL.
Johannes Berg39ecc012013-02-13 12:11:00 +01003705 * The callback can sleep.
Johannes Berg5ce6e432010-05-11 16:20:57 +02003706 *
3707 * @channel_switch: Drivers that need (or want) to offload the channel
3708 * switch operation for CSAs received from the AP may implement this
3709 * callback. They must then call ieee80211_chswitch_done() to indicate
3710 * completion of the channel switch.
John W. Linville4e6cbfd2010-07-29 16:14:13 -04003711 *
Bruno Randolf79b1c462010-11-24 14:34:41 +09003712 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3713 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3714 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3715 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3716 *
3717 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
Johannes Berg4976b4e2011-01-04 13:02:32 +01003718 *
3719 * @remain_on_channel: Starts an off-channel period on the given channel, must
3720 * call back to ieee80211_ready_on_channel() when on that channel. Note
3721 * that normal channel traffic is not stopped as this is intended for hw
3722 * offload. Frames to transmit on the off-channel channel are transmitted
3723 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
3724 * duration (which will always be non-zero) expires, the driver must call
Johannes Berg196ac1c2012-06-05 14:28:40 +02003725 * ieee80211_remain_on_channel_expired().
Johannes Berg196ac1c2012-06-05 14:28:40 +02003726 * Note that this callback may be called while the device is in IDLE and
3727 * must be accepted in this case.
3728 * This callback may sleep.
Johannes Berg4976b4e2011-01-04 13:02:32 +01003729 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
3730 * aborted before it expires. This callback may sleep.
John W. Linville38c09152011-03-07 16:19:18 -05003731 *
3732 * @set_ringparam: Set tx and rx ring sizes.
3733 *
3734 * @get_ringparam: Get tx and rx ring current and maximum sizes.
Vivek Natarajane8306f92011-04-06 11:41:10 +05303735 *
3736 * @tx_frames_pending: Check if there is any pending frame in the hardware
3737 * queues before entering power save.
Sujith Manoharanbdbfd6b2011-04-27 16:56:51 +05303738 *
3739 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
3740 * when transmitting a frame. Currently only legacy rates are handled.
3741 * The callback can sleep.
Emmanuel Grumbacha8182922015-03-16 23:23:34 +02003742 * @event_callback: Notify driver about any event in mac80211. See
3743 * &enum ieee80211_event_type for the different types.
Emmanuel Grumbach63822462015-04-20 22:53:37 +03003744 * The callback must be atomic.
Johannes Berg4049e092011-09-29 16:04:32 +02003745 *
3746 * @release_buffered_frames: Release buffered frames according to the given
3747 * parameters. In the case where the driver buffers some frames for
3748 * sleeping stations mac80211 will use this callback to tell the driver
3749 * to release some frames, either for PS-poll or uAPSD.
Masanari Iidae2278672014-02-18 22:54:36 +09003750 * Note that if the @more_data parameter is %false the driver must check
Johannes Berg4049e092011-09-29 16:04:32 +02003751 * if there are more frames on the given TIDs, and if there are more than
3752 * the frames being released then it must still set the more-data bit in
3753 * the frame. If the @more_data parameter is %true, then of course the
3754 * more-data bit must always be set.
3755 * The @tids parameter tells the driver which TIDs to release frames
3756 * from, for PS-poll it will always have only a single bit set.
Johannes Bergdeeaee192011-09-29 16:04:35 +02003757 * In the case this is used for a PS-poll initiated release, the
3758 * @num_frames parameter will always be 1 so code can be shared. In
3759 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
3760 * on the TX status (and must report TX status) so that the PS-poll
3761 * period is properly ended. This is used to avoid sending multiple
3762 * responses for a retried PS-poll frame.
Johannes Berg4049e092011-09-29 16:04:32 +02003763 * In the case this is used for uAPSD, the @num_frames parameter may be
3764 * bigger than one, but the driver may send fewer frames (it must send
3765 * at least one, however). In this case it is also responsible for
Johannes Berg47086fc2011-09-29 16:04:33 +02003766 * setting the EOSP flag in the QoS header of the frames. Also, when the
3767 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
Johannes Berg37fbd902011-09-29 16:04:39 +02003768 * on the last frame in the SP. Alternatively, it may call the function
Johannes Berge9437892013-02-15 21:38:08 +01003769 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
Johannes Berg4049e092011-09-29 16:04:32 +02003770 * This callback must be atomic.
Johannes Berg40b96402011-09-29 16:04:38 +02003771 * @allow_buffered_frames: Prepare device to allow the given number of frames
3772 * to go out to the given station. The frames will be sent by mac80211
3773 * via the usual TX path after this call. The TX information for frames
Johannes Berg02f2f1a2012-02-27 12:18:30 +01003774 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
Johannes Berg40b96402011-09-29 16:04:38 +02003775 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
3776 * frames from multiple TIDs are released and the driver might reorder
3777 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
3778 * on the last frame and clear it on all others and also handle the EOSP
Johannes Berg37fbd902011-09-29 16:04:39 +02003779 * bit in the QoS header correctly. Alternatively, it can also call the
Johannes Berge9437892013-02-15 21:38:08 +01003780 * ieee80211_sta_eosp() function.
Johannes Berg40b96402011-09-29 16:04:38 +02003781 * The @tids parameter is a bitmap and tells the driver which TIDs the
3782 * frames will be on; it will at most have two bits set.
3783 * This callback must be atomic.
Ben Greeare3521142012-04-23 12:50:31 -07003784 *
3785 * @get_et_sset_count: Ethtool API to get string-set count.
3786 *
3787 * @get_et_stats: Ethtool API to get a set of u64 stats.
3788 *
3789 * @get_et_strings: Ethtool API to get a set of strings to describe stats
3790 * and perhaps other supported types of ethtool data-sets.
3791 *
Johannes Berga1845fc2012-06-27 13:18:36 +02003792 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
3793 * before associated. In multi-channel scenarios, a virtual interface is
3794 * bound to a channel before it is associated, but as it isn't associated
3795 * yet it need not necessarily be given airtime, in particular since any
3796 * transmission to a P2P GO needs to be synchronized against the GO's
3797 * powersave state. mac80211 will call this function before transmitting a
3798 * management frame prior to having successfully associated to allow the
3799 * driver to give it channel time for the transmission, to get a response
3800 * and to be able to synchronize with the GO.
Ilan Peer94ba9272018-02-19 14:48:41 +02003801 * For drivers that set %IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP, mac80211
3802 * would also call this function before transmitting a deauthentication
3803 * frame in case that no beacon was heard from the AP/P2P GO.
Johannes Berga1845fc2012-06-27 13:18:36 +02003804 * The callback will be called before each transmission and upon return
3805 * mac80211 will transmit the frame right away.
Johannes Berg15fae342021-06-18 13:41:55 +03003806 * Additional information is passed in the &struct ieee80211_prep_tx_info
3807 * data. If duration there is greater than zero, mac80211 hints to the
3808 * driver the duration for which the operation is requested.
Johannes Berga1845fc2012-06-27 13:18:36 +02003809 * The callback is optional and can (should!) sleep.
Johannes Berg15fae342021-06-18 13:41:55 +03003810 * @mgd_complete_tx: Notify the driver that the response frame for a previously
3811 * transmitted frame announced with @mgd_prepare_tx was received, the data
3812 * is filled similarly to @mgd_prepare_tx though the duration is not used.
Michal Kaziorc3645ea2012-06-26 14:37:17 +02003813 *
Arik Nemtsovee10f2c2014-06-11 17:18:27 +03003814 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
3815 * a TDLS discovery-request, we expect a reply to arrive on the AP's
3816 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
3817 * setup-response is a direct packet not buffered by the AP.
3818 * mac80211 will call this function just before the transmission of a TDLS
3819 * discovery-request. The recommended period of protection is at least
3820 * 2 * (DTIM period).
3821 * The callback is optional and can sleep.
3822 *
Michal Kaziorc3645ea2012-06-26 14:37:17 +02003823 * @add_chanctx: Notifies device driver about new channel context creation.
Chaitanya T Kdcae9e02015-10-30 23:16:15 +05303824 * This callback may sleep.
Michal Kaziorc3645ea2012-06-26 14:37:17 +02003825 * @remove_chanctx: Notifies device driver about channel context destruction.
Chaitanya T Kdcae9e02015-10-30 23:16:15 +05303826 * This callback may sleep.
Michal Kaziorc3645ea2012-06-26 14:37:17 +02003827 * @change_chanctx: Notifies device driver about channel context changes that
3828 * may happen when combining different virtual interfaces on the same
3829 * channel context with different settings
Chaitanya T Kdcae9e02015-10-30 23:16:15 +05303830 * This callback may sleep.
Michal Kaziorc3645ea2012-06-26 14:37:17 +02003831 * @assign_vif_chanctx: Notifies device driver about channel context being bound
3832 * to vif. Possible use is for hw queue remapping.
Chaitanya T Kdcae9e02015-10-30 23:16:15 +05303833 * This callback may sleep.
Michal Kaziorc3645ea2012-06-26 14:37:17 +02003834 * @unassign_vif_chanctx: Notifies device driver about channel context being
3835 * unbound from vif.
Chaitanya T Kdcae9e02015-10-30 23:16:15 +05303836 * This callback may sleep.
Luciano Coelho1a5f0c12014-05-23 14:33:12 +03003837 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
3838 * another, as specified in the list of
3839 * @ieee80211_vif_chanctx_switch passed to the driver, according
3840 * to the mode defined in &ieee80211_chanctx_switch_mode.
Chaitanya T Kdcae9e02015-10-30 23:16:15 +05303841 * This callback may sleep.
Luciano Coelho1a5f0c12014-05-23 14:33:12 +03003842 *
Johannes Berg10416382012-10-19 15:44:42 +02003843 * @start_ap: Start operation on the AP interface, this is called after all the
3844 * information in bss_conf is set and beacon can be retrieved. A channel
3845 * context is bound before this is called. Note that if the driver uses
3846 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
3847 * just "paused" for scanning/ROC, which is indicated by the beacon being
3848 * disabled/enabled via @bss_info_changed.
3849 * @stop_ap: Stop operation on the AP interface.
Johannes Berg9214ad72012-11-06 19:18:13 +01003850 *
Eliad Pellercf2c92d2014-11-04 11:43:54 +02003851 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
3852 * during resume, when the reconfiguration has completed.
3853 * This can help the driver implement the reconfiguration step (and
3854 * indicate mac80211 is ready to receive frames).
3855 * This callback may sleep.
Johannes Berg8f21b0a2013-01-11 00:28:01 +01003856 *
Johannes Berga65240c2013-01-14 15:14:34 +01003857 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
3858 * Currently, this is only called for managed or P2P client interfaces.
3859 * This callback is optional; it must not sleep.
Simon Wunderlich73da7d52013-07-11 16:09:06 +02003860 *
3861 * @channel_switch_beacon: Starts a channel switch to a new channel.
3862 * Beacons are modified to include CSA or ECSA IEs before calling this
3863 * function. The corresponding count fields in these IEs must be
Luciano Coelho66e01cf2014-01-13 19:43:00 +02003864 * decremented, and when they reach 1 the driver must call
Simon Wunderlich73da7d52013-07-11 16:09:06 +02003865 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
3866 * get the csa counter decremented by mac80211, but must check if it is
John Crispin8552a432020-08-11 10:01:04 +02003867 * 1 using ieee80211_beacon_counter_is_complete() after the beacon has been
Simon Wunderlich73da7d52013-07-11 16:09:06 +02003868 * transmitted and then call ieee80211_csa_finish().
Luciano Coelho66e01cf2014-01-13 19:43:00 +02003869 * If the CSA count starts as zero or 1, this function will not be called,
3870 * since there won't be any time to beacon before the switch anyway.
Luciano Coelho6d027bc2014-10-08 09:48:37 +03003871 * @pre_channel_switch: This is an optional callback that is called
3872 * before a channel switch procedure is started (ie. when a STA
Masahiro Yamada9332ef92017-02-27 14:28:47 -08003873 * gets a CSA or a userspace initiated channel-switch), allowing
Luciano Coelho6d027bc2014-10-08 09:48:37 +03003874 * the driver to prepare for the channel switch.
Luciano Coelhof1d65582014-10-08 09:48:38 +03003875 * @post_channel_switch: This is an optional callback that is called
3876 * after a channel switch procedure is completed, allowing the
3877 * driver to go back to a normal configuration.
Sara Sharonb9cc81d2019-02-06 13:17:10 +02003878 * @abort_channel_switch: This is an optional callback that is called
3879 * when channel switch procedure was completed, allowing the
3880 * driver to go back to a normal configuration.
Sara Sharonfafd2bc2019-02-06 13:17:15 +02003881 * @channel_switch_rx_beacon: This is an optional callback that is called
3882 * when channel switch procedure is in progress and additional beacon with
3883 * CSA IE was received, allowing driver to track changes in count.
Johannes Berg55fff502013-08-19 18:48:41 +02003884 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
3885 * information in bss_conf is set up and the beacon can be retrieved. A
3886 * channel context is bound before this is called.
3887 * @leave_ibss: Leave the IBSS again.
Antonio Quartullicca674d2014-05-19 21:53:20 +02003888 *
3889 * @get_expected_throughput: extract the expected throughput towards the
3890 * specified station. The returned value is expressed in Kbps. It returns 0
3891 * if the RC algorithm does not have proper data to provide.
Felix Fietkau5b3dc422014-10-26 00:32:53 +02003892 *
3893 * @get_txpower: get current maximum tx power (in dBm) based on configuration
3894 * and hardware limits.
Arik Nemtsova7a6bdd2014-11-09 18:50:19 +02003895 *
3896 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3897 * is responsible for continually initiating channel-switching operations
3898 * and returning to the base channel for communication with the AP. The
3899 * driver receives a channel-switch request template and the location of
3900 * the switch-timing IE within the template as part of the invocation.
3901 * The template is valid only within the call, and the driver can
3902 * optionally copy the skb for further re-use.
3903 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3904 * peers must be on the base channel when the call completes.
Arik Nemtsov8a4d32f2014-11-09 18:50:20 +02003905 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
3906 * response) has been received from a remote peer. The driver gets
3907 * parameters parsed from the incoming frame and may use them to continue
3908 * an ongoing channel-switch operation. In addition, a channel-switch
3909 * response template is provided, together with the location of the
3910 * switch-timing IE within the template. The skb can only be used within
3911 * the function call.
Felix Fietkauba8c3d62015-03-27 21:30:37 +01003912 *
3913 * @wake_tx_queue: Called when new packets have been added to the queue.
Sara Sharonf59374e2016-03-02 23:46:14 +02003914 * @sync_rx_queues: Process all pending frames in RSS queues. This is a
3915 * synchronization which is needed in case driver has in its RSS queues
3916 * pending frames that were received prior to the control path action
3917 * currently taken (e.g. disassociation) but are not processed yet.
Ayala Beker708d50e2016-09-20 17:31:14 +03003918 *
3919 * @start_nan: join an existing NAN cluster, or create a new one.
3920 * @stop_nan: leave the NAN cluster.
Ayala Beker5953ff62016-09-20 17:31:19 +03003921 * @nan_change_conf: change NAN configuration. The data in cfg80211_nan_conf
3922 * contains full new configuration and changes specify which parameters
3923 * are changed with respect to the last NAN config.
3924 * The driver gets both full configuration and the changed parameters since
3925 * some devices may need the full configuration while others need only the
3926 * changed parameters.
Ayala Beker167e33f2016-09-20 17:31:20 +03003927 * @add_nan_func: Add a NAN function. Returns 0 on success. The data in
3928 * cfg80211_nan_func must not be referenced outside the scope of
3929 * this call.
3930 * @del_nan_func: Remove a NAN function. The driver must call
3931 * ieee80211_nan_func_terminated() with
3932 * NL80211_NAN_FUNC_TERM_REASON_USER_REQUEST reason code upon removal.
Sara Sharon9739fe22018-09-05 08:06:11 +03003933 * @can_aggregate_in_amsdu: Called in order to determine if HW supports
3934 * aggregating two specific frames in the same A-MSDU. The relation
3935 * between the skbs should be symmetric and transitive. Note that while
3936 * skb is always a real frame, head may or may not be an A-MSDU.
Pradeep Kumar Chitrapubc847972018-10-03 20:19:20 -07003937 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
3938 * Statistics should be cumulative, currently no way to reset is provided.
Johannes Bergcee70132018-10-16 11:24:47 +02003939 *
3940 * @start_pmsr: start peer measurement (e.g. FTM) (this call can sleep)
3941 * @abort_pmsr: abort peer measurement (this call can sleep)
Tamizh chelvam370f51d2020-01-20 13:21:27 +05303942 * @set_tid_config: Apply TID specific configurations. This callback may sleep.
3943 * @reset_tid_config: Reset TID specific configuration for the peer.
3944 * This callback may sleep.
Johannes Berg7fba53e2020-09-18 13:21:16 +02003945 * @update_vif_offload: Update virtual interface offload flags
Felix Fietkau6aea26c2020-09-08 14:36:53 +02003946 * This callback may sleep.
Felix Fietkau1ff4e8f2020-09-08 14:37:01 +02003947 * @sta_set_4addr: Called to notify the driver when a station starts/stops using
3948 * 4-address mode
Johannes Berg70b6ff32021-01-06 23:47:41 +01003949 * @set_sar_specs: Update the SAR (TX power) settings.
Felix Fietkau80a915e2020-12-18 19:47:18 +01003950 * @sta_set_decap_offload: Called to notify the driver when a station is allowed
3951 * to use rx decapsulation offload
Lorenzo Bianconif5a4c242021-08-23 20:02:39 +02003952 * @add_twt_setup: Update hw with TWT agreement parameters received from the peer.
3953 * This callback allows the hw to check if requested parameters
3954 * are supported and if there is enough room for a new agreement.
3955 * The hw is expected to set agreement result in the req_type field of
3956 * twt structure.
3957 * @twt_teardown_request: Update the hw with TWT teardown request received
3958 * from the peer.
Lorenzo Bianconia95bfb82021-11-29 14:11:24 +01003959 * @set_radar_background: Configure dedicated offchannel chain available for
Lorenzo Bianconi237337c22021-10-23 11:10:51 +02003960 * radar/CAC detection on some hw. This chain can't be used to transmit
3961 * or receive frames and it is bounded to a running wdev.
Lorenzo Bianconia95bfb82021-11-29 14:11:24 +01003962 * Background radar/CAC detection allows to avoid the CAC downtime
Lorenzo Bianconi237337c22021-10-23 11:10:51 +02003963 * switching to a different channel during CAC detection on the selected
3964 * radar channel.
3965 * The caller is expected to set chandef pointer to NULL in order to
Lorenzo Bianconia95bfb82021-11-29 14:11:24 +01003966 * disable background CAC/radar detection.
Felix Fietkaud787a3e2021-11-12 12:22:23 +01003967 * @net_fill_forward_path: Called from .ndo_fill_forward_path in order to
3968 * resolve a path for hardware flow offloading
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003969 */
Jiri Bencf0706e82007-05-05 11:45:53 -07003970struct ieee80211_ops {
Thomas Huehn36323f82012-07-23 21:33:42 +02003971 void (*tx)(struct ieee80211_hw *hw,
3972 struct ieee80211_tx_control *control,
3973 struct sk_buff *skb);
Johannes Berg4150c572007-09-17 01:29:23 -04003974 int (*start)(struct ieee80211_hw *hw);
Johannes Berg4150c572007-09-17 01:29:23 -04003975 void (*stop)(struct ieee80211_hw *hw);
Johannes Bergeecc4802011-05-04 15:37:29 +02003976#ifdef CONFIG_PM
3977 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
3978 int (*resume)(struct ieee80211_hw *hw);
Johannes Berg6d525632012-04-04 15:05:25 +02003979 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
Johannes Bergeecc4802011-05-04 15:37:29 +02003980#endif
Jiri Bencf0706e82007-05-05 11:45:53 -07003981 int (*add_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01003982 struct ieee80211_vif *vif);
Johannes Berg34d4bc42010-08-27 12:35:58 +02003983 int (*change_interface)(struct ieee80211_hw *hw,
3984 struct ieee80211_vif *vif,
Johannes Berg2ca27bc2010-09-16 14:58:23 +02003985 enum nl80211_iftype new_type, bool p2p);
Jiri Bencf0706e82007-05-05 11:45:53 -07003986 void (*remove_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01003987 struct ieee80211_vif *vif);
Johannes Berge8975582008-10-09 12:18:51 +02003988 int (*config)(struct ieee80211_hw *hw, u32 changed);
Johannes Berg471b3ef2007-12-28 14:32:58 +01003989 void (*bss_info_changed)(struct ieee80211_hw *hw,
3990 struct ieee80211_vif *vif,
3991 struct ieee80211_bss_conf *info,
3992 u32 changed);
Johannes Bergb2abb6e2011-07-19 10:39:53 +02003993
Johannes Berg10416382012-10-19 15:44:42 +02003994 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3995 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3996
Johannes Berg3ac64be2009-08-17 16:16:53 +02003997 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
Jiri Pirko22bedad32010-04-01 21:22:57 +00003998 struct netdev_hw_addr_list *mc_list);
Johannes Berg4150c572007-09-17 01:29:23 -04003999 void (*configure_filter)(struct ieee80211_hw *hw,
4000 unsigned int changed_flags,
4001 unsigned int *total_flags,
Johannes Berg3ac64be2009-08-17 16:16:53 +02004002 u64 multicast);
Andrei Otcheretianski1b09b552015-08-15 22:39:50 +03004003 void (*config_iface_filter)(struct ieee80211_hw *hw,
4004 struct ieee80211_vif *vif,
4005 unsigned int filter_flags,
4006 unsigned int changed_flags);
Johannes Berg17741cd2008-09-11 00:02:02 +02004007 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
4008 bool set);
Johannes Bergea49c352007-09-18 17:29:21 -04004009 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
Johannes Bergdc822b52008-12-29 12:55:09 +01004010 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
Johannes Berg11a843b2007-08-28 17:01:55 -04004011 struct ieee80211_key_conf *key);
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02004012 void (*update_tkip_key)(struct ieee80211_hw *hw,
Johannes Bergb3fbdcf2010-01-21 11:40:47 +01004013 struct ieee80211_vif *vif,
4014 struct ieee80211_key_conf *conf,
4015 struct ieee80211_sta *sta,
4016 u32 iv32, u16 *phase1key);
Johannes Bergc68f4b82011-07-05 16:35:41 +02004017 void (*set_rekey_data)(struct ieee80211_hw *hw,
4018 struct ieee80211_vif *vif,
4019 struct cfg80211_gtk_rekey_data *data);
Yoni Divinskyde5fad82012-05-30 11:36:39 +03004020 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
4021 struct ieee80211_vif *vif, int idx);
Johannes Berga060bbf2010-04-27 11:59:34 +02004022 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
David Spinadelc56ef672014-02-05 15:21:13 +02004023 struct ieee80211_scan_request *req);
Eliad Pellerb8564392011-06-13 12:47:30 +03004024 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
4025 struct ieee80211_vif *vif);
Luciano Coelho79f460c2011-05-11 17:09:36 +03004026 int (*sched_scan_start)(struct ieee80211_hw *hw,
4027 struct ieee80211_vif *vif,
4028 struct cfg80211_sched_scan_request *req,
David Spinadel633e2712014-02-06 16:15:23 +02004029 struct ieee80211_scan_ies *ies);
Johannes Berg37e33082014-02-17 10:48:17 +01004030 int (*sched_scan_stop)(struct ieee80211_hw *hw,
Luciano Coelho79f460c2011-05-11 17:09:36 +03004031 struct ieee80211_vif *vif);
Johannes Berga344d672014-06-12 22:24:31 +02004032 void (*sw_scan_start)(struct ieee80211_hw *hw,
4033 struct ieee80211_vif *vif,
4034 const u8 *mac_addr);
4035 void (*sw_scan_complete)(struct ieee80211_hw *hw,
4036 struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07004037 int (*get_stats)(struct ieee80211_hw *hw,
4038 struct ieee80211_low_level_stats *stats);
Johannes Berg9352c192015-04-20 18:12:41 +02004039 void (*get_key_seq)(struct ieee80211_hw *hw,
4040 struct ieee80211_key_conf *key,
4041 struct ieee80211_key_seq *seq);
Arik Nemtsovf23a4782010-11-08 11:51:06 +02004042 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
Jiri Bencf0706e82007-05-05 11:45:53 -07004043 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
Johannes Berg34e89502010-02-03 13:59:58 +01004044 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4045 struct ieee80211_sta *sta);
4046 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4047 struct ieee80211_sta *sta);
Sujith Manoharan77d2ece62012-11-20 08:46:02 +05304048#ifdef CONFIG_MAC80211_DEBUGFS
4049 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
4050 struct ieee80211_vif *vif,
4051 struct ieee80211_sta *sta,
4052 struct dentry *dir);
Sujith Manoharan77d2ece62012-11-20 08:46:02 +05304053#endif
Johannes Berg32bfd352007-12-19 01:31:26 +01004054 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02004055 enum sta_notify_cmd, struct ieee80211_sta *sta);
Ashok Raj Nagarajanba905bf2019-03-29 16:19:09 +05304056 int (*sta_set_txpwr)(struct ieee80211_hw *hw,
4057 struct ieee80211_vif *vif,
4058 struct ieee80211_sta *sta);
Johannes Bergf09603a2012-01-20 13:55:21 +01004059 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4060 struct ieee80211_sta *sta,
4061 enum ieee80211_sta_state old_state,
4062 enum ieee80211_sta_state new_state);
Johannes Berg6a9d1b92013-12-04 22:39:17 +01004063 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
4064 struct ieee80211_vif *vif,
4065 struct ieee80211_sta *sta);
Johannes Berg8f727ef2012-03-30 08:43:32 +02004066 void (*sta_rc_update)(struct ieee80211_hw *hw,
4067 struct ieee80211_vif *vif,
4068 struct ieee80211_sta *sta,
4069 u32 changed);
Johannes Bergf815e2b2014-11-19 00:10:42 +01004070 void (*sta_rate_tbl_update)(struct ieee80211_hw *hw,
4071 struct ieee80211_vif *vif,
4072 struct ieee80211_sta *sta);
Johannes Berg2b9a7e12014-11-17 11:35:23 +01004073 void (*sta_statistics)(struct ieee80211_hw *hw,
4074 struct ieee80211_vif *vif,
4075 struct ieee80211_sta *sta,
4076 struct station_info *sinfo);
Eliad Peller8a3a3c82011-10-02 10:15:52 +02004077 int (*conf_tx)(struct ieee80211_hw *hw,
Johannes Berga3304b02012-03-28 11:04:24 +02004078 struct ieee80211_vif *vif, u16 ac,
Jiri Bencf0706e82007-05-05 11:45:53 -07004079 const struct ieee80211_tx_queue_params *params);
Eliad Peller37a41b42011-09-21 14:06:11 +03004080 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4081 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4082 u64 tsf);
Pedersen, Thomas354d3812016-09-28 16:56:28 -07004083 void (*offset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4084 s64 offset);
Eliad Peller37a41b42011-09-21 14:06:11 +03004085 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07004086 int (*tx_last_beacon)(struct ieee80211_hw *hw);
Johannes Berg57eeb202017-01-13 11:12:01 +01004087
4088 /**
4089 * @ampdu_action:
4090 * Perform a certain A-MPDU action.
4091 * The RA/TID combination determines the destination and TID we want
4092 * the ampdu action to be performed for. The action is defined through
4093 * ieee80211_ampdu_mlme_action.
4094 * When the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL the driver
4095 * may neither send aggregates containing more subframes than @buf_size
4096 * nor send aggregates in a way that lost frames would exceed the
4097 * buffer size. If just limiting the aggregate size, this would be
4098 * possible with a buf_size of 8:
4099 *
4100 * - ``TX: 1.....7``
4101 * - ``RX: 2....7`` (lost frame #1)
4102 * - ``TX: 8..1...``
4103 *
4104 * which is invalid since #1 was now re-transmitted well past the
4105 * buffer size of 8. Correct ways to retransmit #1 would be:
4106 *
4107 * - ``TX: 1 or``
4108 * - ``TX: 18 or``
4109 * - ``TX: 81``
4110 *
4111 * Even ``189`` would be wrong since 1 could be lost again.
4112 *
Johannes Berg2ce113d2019-10-02 11:12:25 +02004113 * Returns a negative error code on failure. The driver may return
4114 * %IEEE80211_AMPDU_TX_START_IMMEDIATE for %IEEE80211_AMPDU_TX_START
4115 * if the session can start immediately.
4116 *
Johannes Berg57eeb202017-01-13 11:12:01 +01004117 * The callback can sleep.
4118 */
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02004119 int (*ampdu_action)(struct ieee80211_hw *hw,
Johannes Bergc951ad32009-11-16 12:00:38 +01004120 struct ieee80211_vif *vif,
Sara Sharon50ea05efa2015-12-30 16:06:04 +02004121 struct ieee80211_ampdu_params *params);
Holger Schurig12897232010-04-19 10:23:57 +02004122 int (*get_survey)(struct ieee80211_hw *hw, int idx,
4123 struct survey_info *survey);
Johannes Berg1f87f7d2009-06-02 13:01:41 +02004124 void (*rfkill_poll)(struct ieee80211_hw *hw);
Lorenzo Bianconia4bcaf52014-09-04 23:57:41 +02004125 void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class);
Johannes Bergaff89a92009-07-01 21:26:51 +02004126#ifdef CONFIG_NL80211_TESTMODE
David Spinadel52981cd2013-07-31 18:06:22 +03004127 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4128 void *data, int len);
Wey-Yi Guy71063f02011-05-20 09:05:54 -07004129 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
4130 struct netlink_callback *cb,
4131 void *data, int len);
Johannes Bergaff89a92009-07-01 21:26:51 +02004132#endif
Emmanuel Grumbach77be2c52014-03-27 11:30:29 +02004133 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4134 u32 queues, bool drop);
Johannes Berg5ce6e432010-05-11 16:20:57 +02004135 void (*channel_switch)(struct ieee80211_hw *hw,
Luciano Coelho0f791eb42014-10-08 09:48:40 +03004136 struct ieee80211_vif *vif,
Johannes Berg5ce6e432010-05-11 16:20:57 +02004137 struct ieee80211_channel_switch *ch_switch);
Bruno Randolf15d96752010-11-10 12:50:56 +09004138 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
4139 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
Johannes Berg21f83582010-12-18 17:20:47 +01004140
4141 int (*remain_on_channel)(struct ieee80211_hw *hw,
Eliad Peller49884562012-11-19 17:05:09 +02004142 struct ieee80211_vif *vif,
Johannes Berg21f83582010-12-18 17:20:47 +01004143 struct ieee80211_channel *chan,
Ilan Peerd339d5c2013-02-12 09:34:13 +02004144 int duration,
4145 enum ieee80211_roc_type type);
Emmanuel Grumbach5db4c4b2019-07-23 21:00:01 +03004146 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw,
4147 struct ieee80211_vif *vif);
John W. Linville38c09152011-03-07 16:19:18 -05004148 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
4149 void (*get_ringparam)(struct ieee80211_hw *hw,
4150 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
Vivek Natarajane8306f92011-04-06 11:41:10 +05304151 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
Sujith Manoharanbdbfd6b2011-04-27 16:56:51 +05304152 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4153 const struct cfg80211_bitrate_mask *mask);
Emmanuel Grumbacha8182922015-03-16 23:23:34 +02004154 void (*event_callback)(struct ieee80211_hw *hw,
4155 struct ieee80211_vif *vif,
4156 const struct ieee80211_event *event);
Johannes Berg4049e092011-09-29 16:04:32 +02004157
Johannes Berg40b96402011-09-29 16:04:38 +02004158 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
4159 struct ieee80211_sta *sta,
4160 u16 tids, int num_frames,
4161 enum ieee80211_frame_release_type reason,
4162 bool more_data);
Johannes Berg4049e092011-09-29 16:04:32 +02004163 void (*release_buffered_frames)(struct ieee80211_hw *hw,
4164 struct ieee80211_sta *sta,
4165 u16 tids, int num_frames,
4166 enum ieee80211_frame_release_type reason,
4167 bool more_data);
Ben Greeare3521142012-04-23 12:50:31 -07004168
4169 int (*get_et_sset_count)(struct ieee80211_hw *hw,
4170 struct ieee80211_vif *vif, int sset);
4171 void (*get_et_stats)(struct ieee80211_hw *hw,
4172 struct ieee80211_vif *vif,
4173 struct ethtool_stats *stats, u64 *data);
4174 void (*get_et_strings)(struct ieee80211_hw *hw,
4175 struct ieee80211_vif *vif,
4176 u32 sset, u8 *data);
Johannes Berga1845fc2012-06-27 13:18:36 +02004177
4178 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
Ilan Peerd4e36e52018-04-20 13:49:25 +03004179 struct ieee80211_vif *vif,
Johannes Berg15fae342021-06-18 13:41:55 +03004180 struct ieee80211_prep_tx_info *info);
4181 void (*mgd_complete_tx)(struct ieee80211_hw *hw,
4182 struct ieee80211_vif *vif,
4183 struct ieee80211_prep_tx_info *info);
Michal Kaziorc3645ea2012-06-26 14:37:17 +02004184
Arik Nemtsovee10f2c2014-06-11 17:18:27 +03004185 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
4186 struct ieee80211_vif *vif);
4187
Michal Kaziorc3645ea2012-06-26 14:37:17 +02004188 int (*add_chanctx)(struct ieee80211_hw *hw,
4189 struct ieee80211_chanctx_conf *ctx);
4190 void (*remove_chanctx)(struct ieee80211_hw *hw,
4191 struct ieee80211_chanctx_conf *ctx);
4192 void (*change_chanctx)(struct ieee80211_hw *hw,
4193 struct ieee80211_chanctx_conf *ctx,
4194 u32 changed);
4195 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
4196 struct ieee80211_vif *vif,
4197 struct ieee80211_chanctx_conf *ctx);
4198 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
4199 struct ieee80211_vif *vif,
4200 struct ieee80211_chanctx_conf *ctx);
Luciano Coelho1a5f0c12014-05-23 14:33:12 +03004201 int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
4202 struct ieee80211_vif_chanctx_switch *vifs,
4203 int n_vifs,
4204 enum ieee80211_chanctx_switch_mode mode);
Johannes Berg9214ad72012-11-06 19:18:13 +01004205
Eliad Pellercf2c92d2014-11-04 11:43:54 +02004206 void (*reconfig_complete)(struct ieee80211_hw *hw,
4207 enum ieee80211_reconfig_type reconfig_type);
Johannes Berga65240c2013-01-14 15:14:34 +01004208
4209#if IS_ENABLED(CONFIG_IPV6)
4210 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
4211 struct ieee80211_vif *vif,
4212 struct inet6_dev *idev);
4213#endif
Simon Wunderlich73da7d52013-07-11 16:09:06 +02004214 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
4215 struct ieee80211_vif *vif,
4216 struct cfg80211_chan_def *chandef);
Luciano Coelho6d027bc2014-10-08 09:48:37 +03004217 int (*pre_channel_switch)(struct ieee80211_hw *hw,
4218 struct ieee80211_vif *vif,
4219 struct ieee80211_channel_switch *ch_switch);
Johannes Berg55fff502013-08-19 18:48:41 +02004220
Luciano Coelhof1d65582014-10-08 09:48:38 +03004221 int (*post_channel_switch)(struct ieee80211_hw *hw,
4222 struct ieee80211_vif *vif);
Sara Sharonb9cc81d2019-02-06 13:17:10 +02004223 void (*abort_channel_switch)(struct ieee80211_hw *hw,
4224 struct ieee80211_vif *vif);
Sara Sharonfafd2bc2019-02-06 13:17:15 +02004225 void (*channel_switch_rx_beacon)(struct ieee80211_hw *hw,
4226 struct ieee80211_vif *vif,
4227 struct ieee80211_channel_switch *ch_switch);
Luciano Coelhof1d65582014-10-08 09:48:38 +03004228
Johannes Berg55fff502013-08-19 18:48:41 +02004229 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4230 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Maxim Altshul2439ca02016-08-04 15:43:04 +03004231 u32 (*get_expected_throughput)(struct ieee80211_hw *hw,
4232 struct ieee80211_sta *sta);
Felix Fietkau5b3dc422014-10-26 00:32:53 +02004233 int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4234 int *dbm);
Arik Nemtsova7a6bdd2014-11-09 18:50:19 +02004235
4236 int (*tdls_channel_switch)(struct ieee80211_hw *hw,
4237 struct ieee80211_vif *vif,
4238 struct ieee80211_sta *sta, u8 oper_class,
4239 struct cfg80211_chan_def *chandef,
Arik Nemtsov8a4d32f2014-11-09 18:50:20 +02004240 struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie);
Arik Nemtsova7a6bdd2014-11-09 18:50:19 +02004241 void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw,
4242 struct ieee80211_vif *vif,
4243 struct ieee80211_sta *sta);
Arik Nemtsov8a4d32f2014-11-09 18:50:20 +02004244 void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw,
4245 struct ieee80211_vif *vif,
4246 struct ieee80211_tdls_ch_sw_params *params);
Felix Fietkauba8c3d62015-03-27 21:30:37 +01004247
Johannes Berge7881bd52017-12-19 10:11:54 +01004248 void (*wake_tx_queue)(struct ieee80211_hw *hw,
4249 struct ieee80211_txq *txq);
Sara Sharonf59374e2016-03-02 23:46:14 +02004250 void (*sync_rx_queues)(struct ieee80211_hw *hw);
Ayala Beker708d50e2016-09-20 17:31:14 +03004251
4252 int (*start_nan)(struct ieee80211_hw *hw,
4253 struct ieee80211_vif *vif,
4254 struct cfg80211_nan_conf *conf);
4255 int (*stop_nan)(struct ieee80211_hw *hw,
4256 struct ieee80211_vif *vif);
Ayala Beker5953ff62016-09-20 17:31:19 +03004257 int (*nan_change_conf)(struct ieee80211_hw *hw,
4258 struct ieee80211_vif *vif,
4259 struct cfg80211_nan_conf *conf, u32 changes);
Ayala Beker167e33f2016-09-20 17:31:20 +03004260 int (*add_nan_func)(struct ieee80211_hw *hw,
4261 struct ieee80211_vif *vif,
4262 const struct cfg80211_nan_func *nan_func);
4263 void (*del_nan_func)(struct ieee80211_hw *hw,
4264 struct ieee80211_vif *vif,
4265 u8 instance_id);
Sara Sharon9739fe22018-09-05 08:06:11 +03004266 bool (*can_aggregate_in_amsdu)(struct ieee80211_hw *hw,
4267 struct sk_buff *head,
4268 struct sk_buff *skb);
Pradeep Kumar Chitrapubc847972018-10-03 20:19:20 -07004269 int (*get_ftm_responder_stats)(struct ieee80211_hw *hw,
4270 struct ieee80211_vif *vif,
4271 struct cfg80211_ftm_responder_stats *ftm_stats);
Johannes Bergcee70132018-10-16 11:24:47 +02004272 int (*start_pmsr)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4273 struct cfg80211_pmsr_request *request);
4274 void (*abort_pmsr)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4275 struct cfg80211_pmsr_request *request);
Tamizh chelvam370f51d2020-01-20 13:21:27 +05304276 int (*set_tid_config)(struct ieee80211_hw *hw,
4277 struct ieee80211_vif *vif,
4278 struct ieee80211_sta *sta,
4279 struct cfg80211_tid_config *tid_conf);
4280 int (*reset_tid_config)(struct ieee80211_hw *hw,
4281 struct ieee80211_vif *vif,
4282 struct ieee80211_sta *sta, u8 tids);
Felix Fietkau6aea26c2020-09-08 14:36:53 +02004283 void (*update_vif_offload)(struct ieee80211_hw *hw,
4284 struct ieee80211_vif *vif);
Felix Fietkau1ff4e8f2020-09-08 14:37:01 +02004285 void (*sta_set_4addr)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4286 struct ieee80211_sta *sta, bool enabled);
Carl Huangc534e092020-12-03 05:37:27 -05004287 int (*set_sar_specs)(struct ieee80211_hw *hw,
4288 const struct cfg80211_sar_specs *sar);
Felix Fietkau80a915e2020-12-18 19:47:18 +01004289 void (*sta_set_decap_offload)(struct ieee80211_hw *hw,
4290 struct ieee80211_vif *vif,
4291 struct ieee80211_sta *sta, bool enabled);
Lorenzo Bianconif5a4c242021-08-23 20:02:39 +02004292 void (*add_twt_setup)(struct ieee80211_hw *hw,
4293 struct ieee80211_sta *sta,
4294 struct ieee80211_twt_setup *twt);
4295 void (*twt_teardown_request)(struct ieee80211_hw *hw,
4296 struct ieee80211_sta *sta, u8 flowid);
Lorenzo Bianconia95bfb82021-11-29 14:11:24 +01004297 int (*set_radar_background)(struct ieee80211_hw *hw,
4298 struct cfg80211_chan_def *chandef);
Felix Fietkaud787a3e2021-11-12 12:22:23 +01004299 int (*net_fill_forward_path)(struct ieee80211_hw *hw,
4300 struct ieee80211_vif *vif,
4301 struct ieee80211_sta *sta,
4302 struct net_device_path_ctx *ctx,
4303 struct net_device_path *path);
Jiri Bencf0706e82007-05-05 11:45:53 -07004304};
4305
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004306/**
Ben Greearad287572014-10-22 12:23:01 -07004307 * ieee80211_alloc_hw_nm - Allocate a new hardware device
4308 *
4309 * This must be called once for each hardware device. The returned pointer
4310 * must be used to refer to this device when calling other functions.
4311 * mac80211 allocates a private data area for the driver pointed to by
4312 * @priv in &struct ieee80211_hw, the size of this area is given as
4313 * @priv_data_len.
4314 *
4315 * @priv_data_len: length of private data
4316 * @ops: callbacks for this device
4317 * @requested_name: Requested name for this device.
4318 * NULL is valid value, and means use the default naming (phy%d)
4319 *
4320 * Return: A pointer to the new hardware device, or %NULL on error.
4321 */
4322struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len,
4323 const struct ieee80211_ops *ops,
4324 const char *requested_name);
4325
4326/**
4327 * ieee80211_alloc_hw - Allocate a new hardware device
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004328 *
4329 * This must be called once for each hardware device. The returned pointer
4330 * must be used to refer to this device when calling other functions.
4331 * mac80211 allocates a private data area for the driver pointed to by
4332 * @priv in &struct ieee80211_hw, the size of this area is given as
4333 * @priv_data_len.
4334 *
4335 * @priv_data_len: length of private data
4336 * @ops: callbacks for this device
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004337 *
4338 * Return: A pointer to the new hardware device, or %NULL on error.
Jiri Bencf0706e82007-05-05 11:45:53 -07004339 */
Ben Greearad287572014-10-22 12:23:01 -07004340static inline
Jiri Bencf0706e82007-05-05 11:45:53 -07004341struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
Ben Greearad287572014-10-22 12:23:01 -07004342 const struct ieee80211_ops *ops)
4343{
4344 return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL);
4345}
Jiri Bencf0706e82007-05-05 11:45:53 -07004346
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004347/**
4348 * ieee80211_register_hw - Register hardware device
4349 *
Johannes Bergdbbea672008-02-26 14:34:06 +01004350 * You must call this function before any other functions in
4351 * mac80211. Note that before a hardware can be registered, you
4352 * need to fill the contained wiphy's information.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004353 *
4354 * @hw: the device to register as returned by ieee80211_alloc_hw()
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004355 *
4356 * Return: 0 on success. An error code otherwise.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004357 */
Jiri Bencf0706e82007-05-05 11:45:53 -07004358int ieee80211_register_hw(struct ieee80211_hw *hw);
4359
Johannes Berge1e54062010-11-30 08:58:45 +01004360/**
4361 * struct ieee80211_tpt_blink - throughput blink description
4362 * @throughput: throughput in Kbit/sec
4363 * @blink_time: blink time in milliseconds
4364 * (full cycle, ie. one off + one on period)
4365 */
4366struct ieee80211_tpt_blink {
4367 int throughput;
4368 int blink_time;
4369};
4370
Johannes Berg67408c82010-11-30 08:59:23 +01004371/**
4372 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
4373 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
4374 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
4375 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
4376 * interface is connected in some way, including being an AP
4377 */
4378enum ieee80211_tpt_led_trigger_flags {
4379 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
4380 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
4381 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
4382};
4383
Jiri Bencf0706e82007-05-05 11:45:53 -07004384#ifdef CONFIG_MAC80211_LEDS
Johannes Bergf5c4ae02015-04-23 12:09:01 +02004385const char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
4386const char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
4387const char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
4388const char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
4389const char *
4390__ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
4391 unsigned int flags,
4392 const struct ieee80211_tpt_blink *blink_table,
4393 unsigned int blink_table_len);
Jiri Bencf0706e82007-05-05 11:45:53 -07004394#endif
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004395/**
4396 * ieee80211_get_tx_led_name - get name of TX LED
4397 *
4398 * mac80211 creates a transmit LED trigger for each wireless hardware
4399 * that can be used to drive LEDs if your driver registers a LED device.
4400 * This function returns the name (or %NULL if not configured for LEDs)
4401 * of the trigger so you can automatically link the LED device.
4402 *
4403 * @hw: the hardware to get the LED trigger name for
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004404 *
4405 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004406 */
Johannes Bergf5c4ae02015-04-23 12:09:01 +02004407static inline const char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
Jiri Bencf0706e82007-05-05 11:45:53 -07004408{
4409#ifdef CONFIG_MAC80211_LEDS
4410 return __ieee80211_get_tx_led_name(hw);
4411#else
4412 return NULL;
4413#endif
4414}
4415
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004416/**
4417 * ieee80211_get_rx_led_name - get name of RX LED
4418 *
4419 * mac80211 creates a receive LED trigger for each wireless hardware
4420 * that can be used to drive LEDs if your driver registers a LED device.
4421 * This function returns the name (or %NULL if not configured for LEDs)
4422 * of the trigger so you can automatically link the LED device.
4423 *
4424 * @hw: the hardware to get the LED trigger name for
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004425 *
4426 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004427 */
Johannes Bergf5c4ae02015-04-23 12:09:01 +02004428static inline const char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
Jiri Bencf0706e82007-05-05 11:45:53 -07004429{
4430#ifdef CONFIG_MAC80211_LEDS
4431 return __ieee80211_get_rx_led_name(hw);
4432#else
4433 return NULL;
4434#endif
4435}
4436
Ivo van Doorncdcb006f2008-01-07 19:45:24 +01004437/**
4438 * ieee80211_get_assoc_led_name - get name of association LED
4439 *
4440 * mac80211 creates a association LED trigger for each wireless hardware
4441 * that can be used to drive LEDs if your driver registers a LED device.
4442 * This function returns the name (or %NULL if not configured for LEDs)
4443 * of the trigger so you can automatically link the LED device.
4444 *
4445 * @hw: the hardware to get the LED trigger name for
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004446 *
4447 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
Ivo van Doorncdcb006f2008-01-07 19:45:24 +01004448 */
Johannes Bergf5c4ae02015-04-23 12:09:01 +02004449static inline const char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
Michael Buesch47f0c502007-09-27 15:10:44 +02004450{
4451#ifdef CONFIG_MAC80211_LEDS
4452 return __ieee80211_get_assoc_led_name(hw);
4453#else
4454 return NULL;
4455#endif
4456}
4457
Ivo van Doorncdcb006f2008-01-07 19:45:24 +01004458/**
4459 * ieee80211_get_radio_led_name - get name of radio LED
4460 *
4461 * mac80211 creates a radio change LED trigger for each wireless hardware
4462 * that can be used to drive LEDs if your driver registers a LED device.
4463 * This function returns the name (or %NULL if not configured for LEDs)
4464 * of the trigger so you can automatically link the LED device.
4465 *
4466 * @hw: the hardware to get the LED trigger name for
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004467 *
4468 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
Ivo van Doorncdcb006f2008-01-07 19:45:24 +01004469 */
Johannes Bergf5c4ae02015-04-23 12:09:01 +02004470static inline const char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
Ivo van Doorncdcb006f2008-01-07 19:45:24 +01004471{
4472#ifdef CONFIG_MAC80211_LEDS
4473 return __ieee80211_get_radio_led_name(hw);
4474#else
4475 return NULL;
4476#endif
4477}
Michael Buesch47f0c502007-09-27 15:10:44 +02004478
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004479/**
Johannes Berge1e54062010-11-30 08:58:45 +01004480 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
4481 * @hw: the hardware to create the trigger for
Johannes Berg67408c82010-11-30 08:59:23 +01004482 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
Johannes Berge1e54062010-11-30 08:58:45 +01004483 * @blink_table: the blink table -- needs to be ordered by throughput
4484 * @blink_table_len: size of the blink table
4485 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004486 * Return: %NULL (in case of error, or if no LED triggers are
4487 * configured) or the name of the new trigger.
4488 *
4489 * Note: This function must be called before ieee80211_register_hw().
Johannes Berge1e54062010-11-30 08:58:45 +01004490 */
Johannes Bergf5c4ae02015-04-23 12:09:01 +02004491static inline const char *
Johannes Berg67408c82010-11-30 08:59:23 +01004492ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
Johannes Berge1e54062010-11-30 08:58:45 +01004493 const struct ieee80211_tpt_blink *blink_table,
4494 unsigned int blink_table_len)
4495{
4496#ifdef CONFIG_MAC80211_LEDS
Johannes Berg67408c82010-11-30 08:59:23 +01004497 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
Johannes Berge1e54062010-11-30 08:58:45 +01004498 blink_table_len);
4499#else
4500 return NULL;
4501#endif
4502}
4503
4504/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004505 * ieee80211_unregister_hw - Unregister a hardware device
4506 *
4507 * This function instructs mac80211 to free allocated resources
4508 * and unregister netdevices from the networking subsystem.
4509 *
4510 * @hw: the hardware to unregister
4511 */
Jiri Bencf0706e82007-05-05 11:45:53 -07004512void ieee80211_unregister_hw(struct ieee80211_hw *hw);
4513
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004514/**
4515 * ieee80211_free_hw - free hardware descriptor
4516 *
4517 * This function frees everything that was allocated, including the
4518 * private data for the driver. You must call ieee80211_unregister_hw()
Randy Dunlap6ef307b2008-07-03 13:52:18 -07004519 * before calling this function.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004520 *
4521 * @hw: the hardware to free
4522 */
Jiri Bencf0706e82007-05-05 11:45:53 -07004523void ieee80211_free_hw(struct ieee80211_hw *hw);
4524
Johannes Bergf2753dd2009-04-14 10:09:24 +02004525/**
4526 * ieee80211_restart_hw - restart hardware completely
4527 *
4528 * Call this function when the hardware was restarted for some reason
4529 * (hardware error, ...) and the driver is unable to restore its state
4530 * by itself. mac80211 assumes that at this point the driver/hardware
4531 * is completely uninitialised and stopped, it starts the process by
4532 * calling the ->start() operation. The driver will need to reset all
4533 * internal state that it has prior to calling this function.
4534 *
4535 * @hw: the hardware to restart
4536 */
4537void ieee80211_restart_hw(struct ieee80211_hw *hw);
4538
Johannes Berg06d181a2014-02-04 20:51:09 +01004539/**
Felix Fietkauc5d16862020-07-26 13:06:11 +02004540 * ieee80211_rx_list - receive frame and store processed skbs in a list
4541 *
4542 * Use this function to hand received frames to mac80211. The receive
4543 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4544 * paged @skb is used, the driver is recommended to put the ieee80211
4545 * header of the frame on the linear part of the @skb to avoid memory
4546 * allocation and/or memcpy by the stack.
4547 *
4548 * This function may not be called in IRQ context. Calls to this function
4549 * for a single hardware must be synchronized against each other. Calls to
4550 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4551 * mixed for a single hardware. Must not run concurrently with
4552 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4553 *
4554 * This function must be called with BHs disabled and RCU read lock
4555 *
4556 * @hw: the hardware this frame came in on
4557 * @sta: the station the frame was received from, or %NULL
4558 * @skb: the buffer to receive, owned by mac80211 after this call
4559 * @list: the destination list
4560 */
4561void ieee80211_rx_list(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
4562 struct sk_buff *skb, struct list_head *list);
4563
4564/**
Johannes Bergaf9f9b22015-06-11 16:02:32 +02004565 * ieee80211_rx_napi - receive frame from NAPI context
John W. Linville4e6cbfd2010-07-29 16:14:13 -04004566 *
Johannes Bergaf9f9b22015-06-11 16:02:32 +02004567 * Use this function to hand received frames to mac80211. The receive
4568 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4569 * paged @skb is used, the driver is recommended to put the ieee80211
4570 * header of the frame on the linear part of the @skb to avoid memory
4571 * allocation and/or memcpy by the stack.
4572 *
4573 * This function may not be called in IRQ context. Calls to this function
4574 * for a single hardware must be synchronized against each other. Calls to
4575 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4576 * mixed for a single hardware. Must not run concurrently with
4577 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4578 *
4579 * This function must be called with BHs disabled.
4580 *
4581 * @hw: the hardware this frame came in on
Johannes Bergd63b5482016-03-31 20:02:02 +03004582 * @sta: the station the frame was received from, or %NULL
Johannes Bergaf9f9b22015-06-11 16:02:32 +02004583 * @skb: the buffer to receive, owned by mac80211 after this call
4584 * @napi: the NAPI context
John W. Linville4e6cbfd2010-07-29 16:14:13 -04004585 */
Johannes Bergd63b5482016-03-31 20:02:02 +03004586void ieee80211_rx_napi(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
4587 struct sk_buff *skb, struct napi_struct *napi);
John W. Linville4e6cbfd2010-07-29 16:14:13 -04004588
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004589/**
4590 * ieee80211_rx - receive frame
4591 *
4592 * Use this function to hand received frames to mac80211. The receive
Zhu Yie3cf8b3f2010-03-29 17:35:07 +08004593 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4594 * paged @skb is used, the driver is recommended to put the ieee80211
4595 * header of the frame on the linear part of the @skb to avoid memory
4596 * allocation and/or memcpy by the stack.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004597 *
Johannes Berg2485f712008-02-25 16:27:41 +01004598 * This function may not be called in IRQ context. Calls to this function
Kalle Valoe36e49f2009-10-13 20:33:13 +03004599 * for a single hardware must be synchronized against each other. Calls to
4600 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
Felix Fietkauf6b3d852013-05-03 10:01:03 +02004601 * mixed for a single hardware. Must not run concurrently with
4602 * ieee80211_tx_status() or ieee80211_tx_status_ni().
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004603 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03004604 * In process context use instead ieee80211_rx_ni().
Johannes Bergd20ef632009-10-11 15:10:40 +02004605 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004606 * @hw: the hardware this frame came in on
4607 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004608 */
Johannes Bergaf9f9b22015-06-11 16:02:32 +02004609static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb)
4610{
Johannes Bergd63b5482016-03-31 20:02:02 +03004611 ieee80211_rx_napi(hw, NULL, skb, NULL);
Johannes Bergaf9f9b22015-06-11 16:02:32 +02004612}
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004613
4614/**
4615 * ieee80211_rx_irqsafe - receive frame
4616 *
4617 * Like ieee80211_rx() but can be called in IRQ context
Johannes Berg2485f712008-02-25 16:27:41 +01004618 * (internally defers to a tasklet.)
4619 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03004620 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
Felix Fietkauf6b3d852013-05-03 10:01:03 +02004621 * be mixed for a single hardware.Must not run concurrently with
4622 * ieee80211_tx_status() or ieee80211_tx_status_ni().
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004623 *
4624 * @hw: the hardware this frame came in on
4625 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004626 */
Johannes Bergf1d58c22009-06-17 13:13:00 +02004627void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07004628
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004629/**
Kalle Valoe36e49f2009-10-13 20:33:13 +03004630 * ieee80211_rx_ni - receive frame (in process context)
4631 *
4632 * Like ieee80211_rx() but can be called in process context
4633 * (internally disables bottom halves).
4634 *
4635 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
Felix Fietkauf6b3d852013-05-03 10:01:03 +02004636 * not be mixed for a single hardware. Must not run concurrently with
4637 * ieee80211_tx_status() or ieee80211_tx_status_ni().
Kalle Valoe36e49f2009-10-13 20:33:13 +03004638 *
4639 * @hw: the hardware this frame came in on
4640 * @skb: the buffer to receive, owned by mac80211 after this call
4641 */
4642static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
4643 struct sk_buff *skb)
4644{
4645 local_bh_disable();
4646 ieee80211_rx(hw, skb);
4647 local_bh_enable();
4648}
4649
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02004650/**
4651 * ieee80211_sta_ps_transition - PS transition for connected sta
4652 *
4653 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
4654 * flag set, use this function to inform mac80211 about a connected station
4655 * entering/leaving PS mode.
4656 *
4657 * This function may not be called in IRQ context or with softirqs enabled.
4658 *
4659 * Calls to this function for a single hardware must be synchronized against
4660 * each other.
4661 *
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02004662 * @sta: currently connected sta
4663 * @start: start or stop PS
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004664 *
4665 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02004666 */
4667int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
4668
4669/**
4670 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
4671 * (in process context)
4672 *
4673 * Like ieee80211_sta_ps_transition() but can be called in process context
4674 * (internally disables bottom halves). Concurrent call restriction still
4675 * applies.
4676 *
4677 * @sta: currently connected sta
4678 * @start: start or stop PS
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004679 *
4680 * Return: Like ieee80211_sta_ps_transition().
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02004681 */
4682static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
4683 bool start)
4684{
4685 int ret;
4686
4687 local_bh_disable();
4688 ret = ieee80211_sta_ps_transition(sta, start);
4689 local_bh_enable();
4690
4691 return ret;
4692}
4693
Johannes Berg46fa38e2016-05-03 16:58:00 +03004694/**
4695 * ieee80211_sta_pspoll - PS-Poll frame received
4696 * @sta: currently connected station
4697 *
4698 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4699 * use this function to inform mac80211 that a PS-Poll frame from a
4700 * connected station was received.
4701 * This must be used in conjunction with ieee80211_sta_ps_transition()
4702 * and possibly ieee80211_sta_uapsd_trigger(); calls to all three must
4703 * be serialized.
4704 */
4705void ieee80211_sta_pspoll(struct ieee80211_sta *sta);
4706
4707/**
4708 * ieee80211_sta_uapsd_trigger - (potential) U-APSD trigger frame received
4709 * @sta: currently connected station
4710 * @tid: TID of the received (potential) trigger frame
4711 *
4712 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4713 * use this function to inform mac80211 that a (potential) trigger frame
4714 * from a connected station was received.
4715 * This must be used in conjunction with ieee80211_sta_ps_transition()
4716 * and possibly ieee80211_sta_pspoll(); calls to all three must be
4717 * serialized.
Emmanuel Grumbach0aa419e2016-10-18 23:12:10 +03004718 * %IEEE80211_NUM_TIDS can be passed as the tid if the tid is unknown.
4719 * In this case, mac80211 will not check that this tid maps to an AC
4720 * that is trigger enabled and assume that the caller did the proper
4721 * checks.
Johannes Berg46fa38e2016-05-03 16:58:00 +03004722 */
4723void ieee80211_sta_uapsd_trigger(struct ieee80211_sta *sta, u8 tid);
4724
Gertjan van Wingerded24deb22009-12-04 23:46:54 +01004725/*
4726 * The TX headroom reserved by mac80211 for its own tx_status functions.
4727 * This is enough for the radiotap header.
4728 */
Felix Fietkau651b9922018-02-10 13:20:34 +01004729#define IEEE80211_TX_STATUS_HEADROOM ALIGN(14, 4)
Gertjan van Wingerded24deb22009-12-04 23:46:54 +01004730
Kalle Valoe36e49f2009-10-13 20:33:13 +03004731/**
Johannes Berg042ec452011-09-29 16:04:26 +02004732 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
Randy Dunlapbdfbe802011-05-22 17:22:45 -07004733 * @sta: &struct ieee80211_sta pointer for the sleeping station
Johannes Berg042ec452011-09-29 16:04:26 +02004734 * @tid: the TID that has buffered frames
4735 * @buffered: indicates whether or not frames are buffered for this TID
Felix Fietkaudcf55fb2011-04-17 17:45:00 +02004736 *
4737 * If a driver buffers frames for a powersave station instead of passing
Johannes Berg042ec452011-09-29 16:04:26 +02004738 * them back to mac80211 for retransmission, the station may still need
4739 * to be told that there are buffered frames via the TIM bit.
Felix Fietkaudcf55fb2011-04-17 17:45:00 +02004740 *
Johannes Berg042ec452011-09-29 16:04:26 +02004741 * This function informs mac80211 whether or not there are frames that are
4742 * buffered in the driver for a given TID; mac80211 can then use this data
4743 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
4744 * call! Beware of the locking!)
4745 *
4746 * If all frames are released to the station (due to PS-poll or uAPSD)
4747 * then the driver needs to inform mac80211 that there no longer are
4748 * frames buffered. However, when the station wakes up mac80211 assumes
4749 * that all buffered frames will be transmitted and clears this data,
4750 * drivers need to make sure they inform mac80211 about all buffered
4751 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
4752 *
4753 * Note that technically mac80211 only needs to know this per AC, not per
4754 * TID, but since driver buffering will inevitably happen per TID (since
4755 * it is related to aggregation) it is easier to make mac80211 map the
4756 * TID to the AC as required instead of keeping track in all drivers that
4757 * use this API.
Felix Fietkaudcf55fb2011-04-17 17:45:00 +02004758 */
Johannes Berg042ec452011-09-29 16:04:26 +02004759void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
4760 u8 tid, bool buffered);
Felix Fietkaudcf55fb2011-04-17 17:45:00 +02004761
4762/**
Felix Fietkau0d528d82013-04-22 16:14:41 +02004763 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
4764 *
4765 * Call this function in a driver with per-packet rate selection support
4766 * to combine the rate info in the packet tx info with the most recent
4767 * rate selection table for the station entry.
4768 *
4769 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4770 * @sta: the receiver station to which this packet is sent.
4771 * @skb: the frame to be transmitted.
4772 * @dest: buffer for extracted rate/retry information
4773 * @max_rates: maximum number of rates to fetch
4774 */
4775void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
4776 struct ieee80211_sta *sta,
4777 struct sk_buff *skb,
4778 struct ieee80211_tx_rate *dest,
4779 int max_rates);
4780
4781/**
Toke Høiland-Jørgensen484a54c2017-04-06 11:38:26 +02004782 * ieee80211_sta_set_expected_throughput - set the expected tpt for a station
4783 *
4784 * Call this function to notify mac80211 about a change in expected throughput
4785 * to a station. A driver for a device that does rate control in firmware can
4786 * call this function when the expected throughput estimate towards a station
4787 * changes. The information is used to tune the CoDel AQM applied to traffic
4788 * going towards that station (which can otherwise be too aggressive and cause
4789 * slow stations to starve).
4790 *
4791 * @pubsta: the station to set throughput for.
4792 * @thr: the current expected throughput in kbps.
4793 */
4794void ieee80211_sta_set_expected_throughput(struct ieee80211_sta *pubsta,
4795 u32 thr);
4796
4797/**
Anilkumar Kollif8252e72018-10-11 18:15:03 +05304798 * ieee80211_tx_rate_update - transmit rate update callback
4799 *
4800 * Drivers should call this functions with a non-NULL pub sta
4801 * This function can be used in drivers that does not have provision
4802 * in updating the tx rate in data path.
4803 *
4804 * @hw: the hardware the frame was transmitted by
4805 * @pubsta: the station to update the tx rate for.
4806 * @info: tx status information
4807 */
4808void ieee80211_tx_rate_update(struct ieee80211_hw *hw,
4809 struct ieee80211_sta *pubsta,
4810 struct ieee80211_tx_info *info);
4811
4812/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004813 * ieee80211_tx_status - transmit status callback
4814 *
4815 * Call this function for all transmitted frames after they have been
4816 * transmitted. It is permissible to not call this function for
4817 * multicast frames but this can affect statistics.
4818 *
Johannes Berg2485f712008-02-25 16:27:41 +01004819 * This function may not be called in IRQ context. Calls to this function
4820 * for a single hardware must be synchronized against each other. Calls
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01004821 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
Felix Fietkauf6b3d852013-05-03 10:01:03 +02004822 * may not be mixed for a single hardware. Must not run concurrently with
4823 * ieee80211_rx() or ieee80211_rx_ni().
Johannes Berg2485f712008-02-25 16:27:41 +01004824 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004825 * @hw: the hardware the frame was transmitted by
4826 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004827 */
Jiri Bencf0706e82007-05-05 11:45:53 -07004828void ieee80211_tx_status(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02004829 struct sk_buff *skb);
Johannes Berg2485f712008-02-25 16:27:41 +01004830
4831/**
Felix Fietkau5fe49a92017-04-26 17:11:37 +02004832 * ieee80211_tx_status_ext - extended transmit status callback
4833 *
4834 * This function can be used as a replacement for ieee80211_tx_status
4835 * in drivers that may want to provide extra information that does not
4836 * fit into &struct ieee80211_tx_info.
4837 *
4838 * Calls to this function for a single hardware must be synchronized
4839 * against each other. Calls to this function, ieee80211_tx_status_ni()
4840 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4841 *
4842 * @hw: the hardware the frame was transmitted by
4843 * @status: tx status information
4844 */
4845void ieee80211_tx_status_ext(struct ieee80211_hw *hw,
4846 struct ieee80211_tx_status *status);
4847
4848/**
Felix Fietkauf027c2a2014-11-19 20:08:13 +01004849 * ieee80211_tx_status_noskb - transmit status callback without skb
4850 *
4851 * This function can be used as a replacement for ieee80211_tx_status
4852 * in drivers that cannot reliably map tx status information back to
4853 * specific skbs.
4854 *
4855 * Calls to this function for a single hardware must be synchronized
4856 * against each other. Calls to this function, ieee80211_tx_status_ni()
4857 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4858 *
4859 * @hw: the hardware the frame was transmitted by
4860 * @sta: the receiver station to which this packet is sent
4861 * (NULL for multicast packets)
4862 * @info: tx status information
4863 */
Felix Fietkau5fe49a92017-04-26 17:11:37 +02004864static inline void ieee80211_tx_status_noskb(struct ieee80211_hw *hw,
4865 struct ieee80211_sta *sta,
4866 struct ieee80211_tx_info *info)
4867{
4868 struct ieee80211_tx_status status = {
4869 .sta = sta,
4870 .info = info,
4871 };
4872
4873 ieee80211_tx_status_ext(hw, &status);
4874}
Felix Fietkauf027c2a2014-11-19 20:08:13 +01004875
4876/**
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01004877 * ieee80211_tx_status_ni - transmit status callback (in process context)
4878 *
4879 * Like ieee80211_tx_status() but can be called in process context.
4880 *
4881 * Calls to this function, ieee80211_tx_status() and
4882 * ieee80211_tx_status_irqsafe() may not be mixed
4883 * for a single hardware.
4884 *
4885 * @hw: the hardware the frame was transmitted by
4886 * @skb: the frame that was transmitted, owned by mac80211 after this call
4887 */
4888static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
4889 struct sk_buff *skb)
4890{
4891 local_bh_disable();
4892 ieee80211_tx_status(hw, skb);
4893 local_bh_enable();
4894}
4895
4896/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07004897 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
Johannes Berg2485f712008-02-25 16:27:41 +01004898 *
4899 * Like ieee80211_tx_status() but can be called in IRQ context
4900 * (internally defers to a tasklet.)
4901 *
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01004902 * Calls to this function, ieee80211_tx_status() and
4903 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
Johannes Berg2485f712008-02-25 16:27:41 +01004904 *
4905 * @hw: the hardware the frame was transmitted by
4906 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg2485f712008-02-25 16:27:41 +01004907 */
Jiri Bencf0706e82007-05-05 11:45:53 -07004908void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02004909 struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07004910
4911/**
John Crispin50ff4772019-11-25 11:04:37 +01004912 * ieee80211_tx_status_8023 - transmit status callback for 802.3 frame format
4913 *
4914 * Call this function for all transmitted data frames after their transmit
4915 * completion. This callback should only be called for data frames which
Randy Dunlap66b239d2020-07-15 09:43:24 -07004916 * are using driver's (or hardware's) offload capability of encap/decap
John Crispin50ff4772019-11-25 11:04:37 +01004917 * 802.11 frames.
4918 *
4919 * This function may not be called in IRQ context. Calls to this function
4920 * for a single hardware must be synchronized against each other and all
4921 * calls in the same tx status family.
4922 *
4923 * @hw: the hardware the frame was transmitted by
4924 * @vif: the interface for which the frame was transmitted
4925 * @skb: the frame that was transmitted, owned by mac80211 after this call
4926 */
4927void ieee80211_tx_status_8023(struct ieee80211_hw *hw,
4928 struct ieee80211_vif *vif,
4929 struct sk_buff *skb);
4930
4931/**
Arik Nemtsov8178d382011-04-18 14:22:28 +03004932 * ieee80211_report_low_ack - report non-responding station
4933 *
4934 * When operating in AP-mode, call this function to report a non-responding
4935 * connected STA.
4936 *
4937 * @sta: the non-responding connected sta
4938 * @num_packets: number of packets sent to @sta without a response
4939 */
4940void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
4941
John Crispin8552a432020-08-11 10:01:04 +02004942#define IEEE80211_MAX_CNTDWN_COUNTERS_NUM 2
Andrei Otcheretianski1af586c2014-05-09 14:11:50 +03004943
Arik Nemtsov8178d382011-04-18 14:22:28 +03004944/**
Andrei Otcheretianski6ec8c332014-05-09 14:11:49 +03004945 * struct ieee80211_mutable_offsets - mutable beacon offsets
4946 * @tim_offset: position of TIM element
4947 * @tim_length: size of TIM element
John Crispin8552a432020-08-11 10:01:04 +02004948 * @cntdwn_counter_offs: array of IEEE80211_MAX_CNTDWN_COUNTERS_NUM offsets
4949 * to countdown counters. This array can contain zero values which
Luciano Coelho8d77ec82014-05-15 20:32:08 +03004950 * should be ignored.
Lorenzo Bianconi2b3171c2022-02-24 12:54:58 +01004951 * @mbssid_off: position of the multiple bssid element
Andrei Otcheretianski6ec8c332014-05-09 14:11:49 +03004952 */
4953struct ieee80211_mutable_offsets {
4954 u16 tim_offset;
4955 u16 tim_length;
Andrei Otcheretianski1af586c2014-05-09 14:11:50 +03004956
John Crispin8552a432020-08-11 10:01:04 +02004957 u16 cntdwn_counter_offs[IEEE80211_MAX_CNTDWN_COUNTERS_NUM];
Lorenzo Bianconi2b3171c2022-02-24 12:54:58 +01004958 u16 mbssid_off;
Andrei Otcheretianski6ec8c332014-05-09 14:11:49 +03004959};
4960
4961/**
4962 * ieee80211_beacon_get_template - beacon template generation function
4963 * @hw: pointer obtained from ieee80211_alloc_hw().
4964 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4965 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
4966 * receive the offsets that may be updated by the driver.
4967 *
4968 * If the driver implements beaconing modes, it must use this function to
4969 * obtain the beacon template.
4970 *
4971 * This function should be used if the beacon frames are generated by the
4972 * device, and then the driver must use the returned beacon as the template
Andrei Otcheretianski1af586c2014-05-09 14:11:50 +03004973 * The driver or the device are responsible to update the DTIM and, when
4974 * applicable, the CSA count.
Andrei Otcheretianski6ec8c332014-05-09 14:11:49 +03004975 *
4976 * The driver is responsible for freeing the returned skb.
4977 *
4978 * Return: The beacon template. %NULL on error.
4979 */
4980struct sk_buff *
4981ieee80211_beacon_get_template(struct ieee80211_hw *hw,
4982 struct ieee80211_vif *vif,
4983 struct ieee80211_mutable_offsets *offs);
4984
4985/**
Johannes Bergeddcbb942009-10-29 08:30:35 +01004986 * ieee80211_beacon_get_tim - beacon generation function
4987 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01004988 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Bergeddcbb942009-10-29 08:30:35 +01004989 * @tim_offset: pointer to variable that will receive the TIM IE offset.
4990 * Set to 0 if invalid (in non-AP modes).
4991 * @tim_length: pointer to variable that will receive the TIM IE length,
4992 * (including the ID and length bytes!).
4993 * Set to 0 if invalid (in non-AP modes).
4994 *
4995 * If the driver implements beaconing modes, it must use this function to
Andrei Otcheretianski6ec8c332014-05-09 14:11:49 +03004996 * obtain the beacon frame.
Johannes Bergeddcbb942009-10-29 08:30:35 +01004997 *
4998 * If the beacon frames are generated by the host system (i.e., not in
4999 * hardware/firmware), the driver uses this function to get each beacon
Andrei Otcheretianski6ec8c332014-05-09 14:11:49 +03005000 * frame from mac80211 -- it is responsible for calling this function exactly
5001 * once before the beacon is needed (e.g. based on hardware interrupt).
Johannes Bergeddcbb942009-10-29 08:30:35 +01005002 *
5003 * The driver is responsible for freeing the returned skb.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01005004 *
5005 * Return: The beacon template. %NULL on error.
Johannes Bergeddcbb942009-10-29 08:30:35 +01005006 */
5007struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
5008 struct ieee80211_vif *vif,
5009 u16 *tim_offset, u16 *tim_length);
5010
5011/**
Jiri Bencf0706e82007-05-05 11:45:53 -07005012 * ieee80211_beacon_get - beacon generation function
5013 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01005014 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07005015 *
Johannes Bergeddcbb942009-10-29 08:30:35 +01005016 * See ieee80211_beacon_get_tim().
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01005017 *
5018 * Return: See ieee80211_beacon_get_tim().
Jiri Bencf0706e82007-05-05 11:45:53 -07005019 */
Johannes Bergeddcbb942009-10-29 08:30:35 +01005020static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
5021 struct ieee80211_vif *vif)
5022{
5023 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
5024}
Jiri Bencf0706e82007-05-05 11:45:53 -07005025
5026/**
John Crispin8552a432020-08-11 10:01:04 +02005027 * ieee80211_beacon_update_cntdwn - request mac80211 to decrement the beacon countdown
Andrei Otcheretianski1af586c2014-05-09 14:11:50 +03005028 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5029 *
John Crispin8552a432020-08-11 10:01:04 +02005030 * The beacon counter should be updated after each beacon transmission.
Andrei Otcheretianski1af586c2014-05-09 14:11:50 +03005031 * This function is called implicitly when
5032 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
5033 * beacon frames are generated by the device, the driver should call this
John Crispin8552a432020-08-11 10:01:04 +02005034 * function after each beacon transmission to sync mac80211's beacon countdown.
Andrei Otcheretianski1af586c2014-05-09 14:11:50 +03005035 *
John Crispin8552a432020-08-11 10:01:04 +02005036 * Return: new countdown value
Andrei Otcheretianski1af586c2014-05-09 14:11:50 +03005037 */
John Crispin8552a432020-08-11 10:01:04 +02005038u8 ieee80211_beacon_update_cntdwn(struct ieee80211_vif *vif);
Andrei Otcheretianski1af586c2014-05-09 14:11:50 +03005039
5040/**
John Crispin8552a432020-08-11 10:01:04 +02005041 * ieee80211_beacon_set_cntdwn - request mac80211 to set beacon countdown
Gregory Greenman03737002018-04-20 13:49:24 +03005042 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5043 * @counter: the new value for the counter
5044 *
John Crispin8552a432020-08-11 10:01:04 +02005045 * The beacon countdown can be changed by the device, this API should be
Gregory Greenman03737002018-04-20 13:49:24 +03005046 * used by the device driver to update csa counter in mac80211.
5047 *
John Crispin8552a432020-08-11 10:01:04 +02005048 * It should never be used together with ieee80211_beacon_update_cntdwn(),
Gregory Greenman03737002018-04-20 13:49:24 +03005049 * as it will cause a race condition around the counter value.
5050 */
John Crispin8552a432020-08-11 10:01:04 +02005051void ieee80211_beacon_set_cntdwn(struct ieee80211_vif *vif, u8 counter);
Gregory Greenman03737002018-04-20 13:49:24 +03005052
5053/**
Simon Wunderlich73da7d52013-07-11 16:09:06 +02005054 * ieee80211_csa_finish - notify mac80211 about channel switch
5055 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5056 *
5057 * After a channel switch announcement was scheduled and the counter in this
Luciano Coelho66e01cf2014-01-13 19:43:00 +02005058 * announcement hits 1, this function must be called by the driver to
Simon Wunderlich73da7d52013-07-11 16:09:06 +02005059 * notify mac80211 that the channel can be changed.
5060 */
5061void ieee80211_csa_finish(struct ieee80211_vif *vif);
5062
5063/**
John Crispin8552a432020-08-11 10:01:04 +02005064 * ieee80211_beacon_cntdwn_is_complete - find out if countdown reached 1
Simon Wunderlich73da7d52013-07-11 16:09:06 +02005065 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5066 *
John Crispin8552a432020-08-11 10:01:04 +02005067 * This function returns whether the countdown reached zero.
Simon Wunderlich73da7d52013-07-11 16:09:06 +02005068 */
John Crispin8552a432020-08-11 10:01:04 +02005069bool ieee80211_beacon_cntdwn_is_complete(struct ieee80211_vif *vif);
Simon Wunderlich73da7d52013-07-11 16:09:06 +02005070
5071/**
John Crispin5f9404a2021-07-02 19:44:08 +02005072 * ieee80211_color_change_finish - notify mac80211 about color change
5073 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5074 *
5075 * After a color change announcement was scheduled and the counter in this
5076 * announcement hits 1, this function must be called by the driver to
5077 * notify mac80211 that the color can be changed
5078 */
5079void ieee80211_color_change_finish(struct ieee80211_vif *vif);
5080
5081/**
Arik Nemtsov02945822011-11-10 11:28:57 +02005082 * ieee80211_proberesp_get - retrieve a Probe Response template
5083 * @hw: pointer obtained from ieee80211_alloc_hw().
5084 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5085 *
5086 * Creates a Probe Response template which can, for example, be uploaded to
5087 * hardware. The destination address should be set by the caller.
5088 *
5089 * Can only be called in AP mode.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01005090 *
5091 * Return: The Probe Response template. %NULL on error.
Arik Nemtsov02945822011-11-10 11:28:57 +02005092 */
5093struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
5094 struct ieee80211_vif *vif);
5095
5096/**
Kalle Valo7044cc52010-01-05 20:16:19 +02005097 * ieee80211_pspoll_get - retrieve a PS Poll template
5098 * @hw: pointer obtained from ieee80211_alloc_hw().
5099 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5100 *
5101 * Creates a PS Poll a template which can, for example, uploaded to
5102 * hardware. The template must be updated after association so that correct
5103 * AID, BSSID and MAC address is used.
5104 *
5105 * Note: Caller (or hardware) is responsible for setting the
5106 * &IEEE80211_FCTL_PM bit.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01005107 *
5108 * Return: The PS Poll template. %NULL on error.
Kalle Valo7044cc52010-01-05 20:16:19 +02005109 */
5110struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
5111 struct ieee80211_vif *vif);
5112
5113/**
5114 * ieee80211_nullfunc_get - retrieve a nullfunc template
5115 * @hw: pointer obtained from ieee80211_alloc_hw().
5116 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Berg7b6ddea2017-11-21 14:46:08 +01005117 * @qos_ok: QoS NDP is acceptable to the caller, this should be set
5118 * if at all possible
Kalle Valo7044cc52010-01-05 20:16:19 +02005119 *
5120 * Creates a Nullfunc template which can, for example, uploaded to
5121 * hardware. The template must be updated after association so that correct
5122 * BSSID and address is used.
5123 *
Johannes Berg7b6ddea2017-11-21 14:46:08 +01005124 * If @qos_ndp is set and the association is to an AP with QoS/WMM, the
5125 * returned packet will be QoS NDP.
5126 *
Kalle Valo7044cc52010-01-05 20:16:19 +02005127 * Note: Caller (or hardware) is responsible for setting the
5128 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01005129 *
5130 * Return: The nullfunc template. %NULL on error.
Kalle Valo7044cc52010-01-05 20:16:19 +02005131 */
5132struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
Johannes Berg7b6ddea2017-11-21 14:46:08 +01005133 struct ieee80211_vif *vif,
5134 bool qos_ok);
Kalle Valo7044cc52010-01-05 20:16:19 +02005135
5136/**
Kalle Valo05e54ea2010-01-05 20:16:38 +02005137 * ieee80211_probereq_get - retrieve a Probe Request template
5138 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berga344d672014-06-12 22:24:31 +02005139 * @src_addr: source MAC address
Kalle Valo05e54ea2010-01-05 20:16:38 +02005140 * @ssid: SSID buffer
5141 * @ssid_len: length of SSID
Johannes Bergb9a9ada2012-11-29 13:00:10 +01005142 * @tailroom: tailroom to reserve at end of SKB for IEs
Kalle Valo05e54ea2010-01-05 20:16:38 +02005143 *
5144 * Creates a Probe Request template which can, for example, be uploaded to
5145 * hardware.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01005146 *
5147 * Return: The Probe Request template. %NULL on error.
Kalle Valo05e54ea2010-01-05 20:16:38 +02005148 */
5149struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
Johannes Berga344d672014-06-12 22:24:31 +02005150 const u8 *src_addr,
Kalle Valo05e54ea2010-01-05 20:16:38 +02005151 const u8 *ssid, size_t ssid_len,
Johannes Bergb9a9ada2012-11-29 13:00:10 +01005152 size_t tailroom);
Kalle Valo05e54ea2010-01-05 20:16:38 +02005153
5154/**
Jiri Bencf0706e82007-05-05 11:45:53 -07005155 * ieee80211_rts_get - RTS frame generation function
5156 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01005157 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07005158 * @frame: pointer to the frame that is going to be protected by the RTS.
5159 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02005160 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07005161 * @rts: The buffer where to store the RTS frame.
5162 *
5163 * If the RTS frames are generated by the host system (i.e., not in
5164 * hardware/firmware), the low-level driver uses this function to receive
5165 * the next RTS frame from the 802.11 code. The low-level is responsible
5166 * for calling this function before and RTS frame is needed.
5167 */
Johannes Berg32bfd352007-12-19 01:31:26 +01005168void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07005169 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02005170 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07005171 struct ieee80211_rts *rts);
5172
5173/**
5174 * ieee80211_rts_duration - Get the duration field for an RTS frame
5175 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01005176 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07005177 * @frame_len: the length of the frame that is going to be protected by the RTS.
Johannes Berge039fa42008-05-15 12:55:29 +02005178 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07005179 *
5180 * If the RTS is generated in firmware, but the host system must provide
5181 * the duration field, the low-level driver uses this function to receive
5182 * the duration field value in little-endian byteorder.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01005183 *
5184 * Return: The duration.
Jiri Bencf0706e82007-05-05 11:45:53 -07005185 */
Johannes Berg32bfd352007-12-19 01:31:26 +01005186__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
5187 struct ieee80211_vif *vif, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02005188 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07005189
5190/**
5191 * ieee80211_ctstoself_get - CTS-to-self frame generation function
5192 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01005193 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07005194 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
5195 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02005196 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07005197 * @cts: The buffer where to store the CTS-to-self frame.
5198 *
5199 * If the CTS-to-self frames are generated by the host system (i.e., not in
5200 * hardware/firmware), the low-level driver uses this function to receive
5201 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
5202 * for calling this function before and CTS-to-self frame is needed.
5203 */
Johannes Berg32bfd352007-12-19 01:31:26 +01005204void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
5205 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07005206 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02005207 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07005208 struct ieee80211_cts *cts);
5209
5210/**
5211 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
5212 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01005213 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07005214 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
Johannes Berge039fa42008-05-15 12:55:29 +02005215 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07005216 *
5217 * If the CTS-to-self is generated in firmware, but the host system must provide
5218 * the duration field, the low-level driver uses this function to receive
5219 * the duration field value in little-endian byteorder.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01005220 *
5221 * Return: The duration.
Jiri Bencf0706e82007-05-05 11:45:53 -07005222 */
Johannes Berg32bfd352007-12-19 01:31:26 +01005223__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
5224 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07005225 size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02005226 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07005227
5228/**
5229 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
5230 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01005231 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Bergd13e1412012-06-09 10:31:09 +02005232 * @band: the band to calculate the frame duration on
Jiri Bencf0706e82007-05-05 11:45:53 -07005233 * @frame_len: the length of the frame.
Johannes Berg8318d782008-01-24 19:38:38 +01005234 * @rate: the rate at which the frame is going to be transmitted.
Jiri Bencf0706e82007-05-05 11:45:53 -07005235 *
5236 * Calculate the duration field of some generic frame, given its
5237 * length and transmission rate (in 100kbps).
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01005238 *
5239 * Return: The duration.
Jiri Bencf0706e82007-05-05 11:45:53 -07005240 */
Johannes Berg32bfd352007-12-19 01:31:26 +01005241__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
5242 struct ieee80211_vif *vif,
Johannes Berg57fbcce2016-04-12 15:56:15 +02005243 enum nl80211_band band,
Jiri Bencf0706e82007-05-05 11:45:53 -07005244 size_t frame_len,
Johannes Berg8318d782008-01-24 19:38:38 +01005245 struct ieee80211_rate *rate);
Jiri Bencf0706e82007-05-05 11:45:53 -07005246
5247/**
5248 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
5249 * @hw: pointer as obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01005250 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07005251 *
5252 * Function for accessing buffered broadcast and multicast frames. If
5253 * hardware/firmware does not implement buffering of broadcast/multicast
5254 * frames when power saving is used, 802.11 code buffers them in the host
5255 * memory. The low-level driver uses this function to fetch next buffered
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01005256 * frame. In most cases, this is used when generating beacon frame.
5257 *
5258 * Return: A pointer to the next buffered skb or NULL if no more buffered
5259 * frames are available.
Jiri Bencf0706e82007-05-05 11:45:53 -07005260 *
5261 * Note: buffered frames are returned only after DTIM beacon frame was
5262 * generated with ieee80211_beacon_get() and the low-level driver must thus
5263 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
5264 * NULL if the previous generated beacon was not DTIM, so the low-level driver
5265 * does not need to check for DTIM beacons separately and should be able to
5266 * use common code for all beacons.
5267 */
5268struct sk_buff *
Johannes Berge039fa42008-05-15 12:55:29 +02005269ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07005270
Johannes Berg75a5f0c2007-09-18 17:29:20 -04005271/**
Johannes Berg42d987952011-07-07 18:58:01 +02005272 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
5273 *
5274 * This function returns the TKIP phase 1 key for the given IV32.
5275 *
5276 * @keyconf: the parameter passed with the set key
5277 * @iv32: IV32 to get the P1K for
5278 * @p1k: a buffer to which the key will be written, as 5 u16 values
5279 */
5280void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
5281 u32 iv32, u16 *p1k);
5282
5283/**
Johannes Berg523b02e2011-07-07 22:28:01 +02005284 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
Emmanuel Grumbach5d2cdcd42008-03-20 15:06:41 +02005285 *
Johannes Berg523b02e2011-07-07 22:28:01 +02005286 * This function returns the TKIP phase 1 key for the IV32 taken
5287 * from the given packet.
Emmanuel Grumbach5d2cdcd42008-03-20 15:06:41 +02005288 *
5289 * @keyconf: the parameter passed with the set key
Johannes Berg523b02e2011-07-07 22:28:01 +02005290 * @skb: the packet to take the IV32 value from that will be encrypted
5291 * with this P1K
5292 * @p1k: a buffer to which the key will be written, as 5 u16 values
Emmanuel Grumbach5d2cdcd42008-03-20 15:06:41 +02005293 */
Johannes Berg42d987952011-07-07 18:58:01 +02005294static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
5295 struct sk_buff *skb, u16 *p1k)
5296{
5297 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
5298 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
5299 u32 iv32 = get_unaligned_le32(&data[4]);
5300
5301 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
5302}
Johannes Berg523b02e2011-07-07 22:28:01 +02005303
5304/**
Johannes Berg8bca5d82011-07-13 19:50:34 +02005305 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
5306 *
5307 * This function returns the TKIP phase 1 key for the given IV32
5308 * and transmitter address.
5309 *
5310 * @keyconf: the parameter passed with the set key
5311 * @ta: TA that will be used with the key
5312 * @iv32: IV32 to get the P1K for
5313 * @p1k: a buffer to which the key will be written, as 5 u16 values
5314 */
5315void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
5316 const u8 *ta, u32 iv32, u16 *p1k);
5317
5318/**
Johannes Berg523b02e2011-07-07 22:28:01 +02005319 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
5320 *
5321 * This function computes the TKIP RC4 key for the IV values
5322 * in the packet.
5323 *
5324 * @keyconf: the parameter passed with the set key
5325 * @skb: the packet to take the IV32/IV16 values from that will be
5326 * encrypted with this key
5327 * @p2k: a buffer to which the key will be written, 16 bytes
5328 */
5329void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
5330 struct sk_buff *skb, u8 *p2k);
Johannes Bergc68f4b82011-07-05 16:35:41 +02005331
5332/**
Eliad Pellerf8079d42016-02-14 13:56:35 +02005333 * ieee80211_tkip_add_iv - write TKIP IV and Ext. IV to pos
5334 *
5335 * @pos: start of crypto header
5336 * @keyconf: the parameter passed with the set key
5337 * @pn: PN to add
5338 *
5339 * Returns: pointer to the octet following IVs (i.e. beginning of
5340 * the packet payload)
5341 *
5342 * This function writes the tkip IV value to pos (which should
5343 * point to the crypto header)
5344 */
5345u8 *ieee80211_tkip_add_iv(u8 *pos, struct ieee80211_key_conf *keyconf, u64 pn);
5346
5347/**
Johannes Berg3ea542d2011-07-07 18:58:00 +02005348 * ieee80211_get_key_rx_seq - get key RX sequence counter
5349 *
5350 * @keyconf: the parameter passed with the set key
Jouni Malinen00b9cfa2015-01-24 19:52:06 +02005351 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
Johannes Berg3ea542d2011-07-07 18:58:00 +02005352 * the value on TID 0 is also used for non-QoS frames. For
5353 * CMAC, only TID 0 is valid.
5354 * @seq: buffer to receive the sequence data
5355 *
5356 * This function allows a driver to retrieve the current RX IV/PNs
5357 * for the given key. It must not be called if IV checking is done
5358 * by the device and not by mac80211.
5359 *
5360 * Note that this function may only be called when no RX processing
5361 * can be done concurrently.
5362 */
5363void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
5364 int tid, struct ieee80211_key_seq *seq);
5365
5366/**
Johannes Berg27b3eb92013-08-07 20:11:55 +02005367 * ieee80211_set_key_rx_seq - set key RX sequence counter
5368 *
5369 * @keyconf: the parameter passed with the set key
Jouni Malinen00b9cfa2015-01-24 19:52:06 +02005370 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
Johannes Berg27b3eb92013-08-07 20:11:55 +02005371 * the value on TID 0 is also used for non-QoS frames. For
5372 * CMAC, only TID 0 is valid.
5373 * @seq: new sequence data
5374 *
5375 * This function allows a driver to set the current RX IV/PNs for the
5376 * given key. This is useful when resuming from WoWLAN sleep and GTK
5377 * rekey may have been done while suspended. It should not be called
5378 * if IV checking is done by the device and not by mac80211.
5379 *
5380 * Note that this function may only be called when no RX processing
5381 * can be done concurrently.
5382 */
5383void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
5384 int tid, struct ieee80211_key_seq *seq);
5385
5386/**
5387 * ieee80211_remove_key - remove the given key
5388 * @keyconf: the parameter passed with the set key
5389 *
5390 * Remove the given key. If the key was uploaded to the hardware at the
5391 * time this function is called, it is not deleted in the hardware but
5392 * instead assumed to have been removed already.
5393 *
5394 * Note that due to locking considerations this function can (currently)
5395 * only be called during key iteration (ieee80211_iter_keys().)
5396 */
5397void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
5398
5399/**
5400 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
5401 * @vif: the virtual interface to add the key on
5402 * @keyconf: new key data
5403 *
5404 * When GTK rekeying was done while the system was suspended, (a) new
5405 * key(s) will be available. These will be needed by mac80211 for proper
5406 * RX processing, so this function allows setting them.
5407 *
5408 * The function returns the newly allocated key structure, which will
5409 * have similar contents to the passed key configuration but point to
5410 * mac80211-owned memory. In case of errors, the function returns an
5411 * ERR_PTR(), use IS_ERR() etc.
5412 *
5413 * Note that this function assumes the key isn't added to hardware
5414 * acceleration, so no TX will be done with the key. Since it's a GTK
5415 * on managed (station) networks, this is true anyway. If the driver
5416 * calls this function from the resume callback and subsequently uses
5417 * the return code 1 to reconfigure the device, this key will be part
5418 * of the reconfiguration.
5419 *
5420 * Note that the driver should also call ieee80211_set_key_rx_seq()
5421 * for the new key for each TID to set up sequence counters properly.
5422 *
5423 * IMPORTANT: If this replaces a key that is present in the hardware,
5424 * then it will attempt to remove it during this call. In many cases
5425 * this isn't what you want, so call ieee80211_remove_key() first for
5426 * the key that's being replaced.
5427 */
5428struct ieee80211_key_conf *
5429ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
5430 struct ieee80211_key_conf *keyconf);
5431
5432/**
Johannes Bergc68f4b82011-07-05 16:35:41 +02005433 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
5434 * @vif: virtual interface the rekeying was done on
5435 * @bssid: The BSSID of the AP, for checking association
5436 * @replay_ctr: the new replay counter after GTK rekeying
5437 * @gfp: allocation flags
5438 */
5439void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
5440 const u8 *replay_ctr, gfp_t gfp);
5441
Emmanuel Grumbach5d2cdcd42008-03-20 15:06:41 +02005442/**
Johannes Berg4271d4b2020-11-29 17:30:45 +02005443 * ieee80211_key_mic_failure - increment MIC failure counter for the key
5444 *
5445 * Note: this is really only safe if no other RX function is called
5446 * at the same time.
5447 *
5448 * @keyconf: the key in question
5449 */
5450void ieee80211_key_mic_failure(struct ieee80211_key_conf *keyconf);
5451
5452/**
5453 * ieee80211_key_replay - increment replay counter for the key
5454 *
5455 * Note: this is really only safe if no other RX function is called
5456 * at the same time.
5457 *
5458 * @keyconf: the key in question
5459 */
5460void ieee80211_key_replay(struct ieee80211_key_conf *keyconf);
5461
5462/**
Jiri Bencf0706e82007-05-05 11:45:53 -07005463 * ieee80211_wake_queue - wake specific queue
5464 * @hw: pointer as obtained from ieee80211_alloc_hw().
5465 * @queue: queue number (counted from zero).
5466 *
5467 * Drivers should use this function instead of netif_wake_queue.
5468 */
5469void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
5470
5471/**
5472 * ieee80211_stop_queue - stop specific queue
5473 * @hw: pointer as obtained from ieee80211_alloc_hw().
5474 * @queue: queue number (counted from zero).
5475 *
5476 * Drivers should use this function instead of netif_stop_queue.
5477 */
5478void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
5479
5480/**
Tomas Winkler92ab8532008-07-24 21:02:04 +03005481 * ieee80211_queue_stopped - test status of the queue
5482 * @hw: pointer as obtained from ieee80211_alloc_hw().
5483 * @queue: queue number (counted from zero).
5484 *
5485 * Drivers should use this function instead of netif_stop_queue.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01005486 *
5487 * Return: %true if the queue is stopped. %false otherwise.
Tomas Winkler92ab8532008-07-24 21:02:04 +03005488 */
5489
5490int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
5491
5492/**
Jiri Bencf0706e82007-05-05 11:45:53 -07005493 * ieee80211_stop_queues - stop all queues
5494 * @hw: pointer as obtained from ieee80211_alloc_hw().
5495 *
5496 * Drivers should use this function instead of netif_stop_queue.
5497 */
5498void ieee80211_stop_queues(struct ieee80211_hw *hw);
5499
5500/**
5501 * ieee80211_wake_queues - wake all queues
5502 * @hw: pointer as obtained from ieee80211_alloc_hw().
5503 *
5504 * Drivers should use this function instead of netif_wake_queue.
5505 */
5506void ieee80211_wake_queues(struct ieee80211_hw *hw);
5507
Johannes Berg75a5f0c2007-09-18 17:29:20 -04005508/**
5509 * ieee80211_scan_completed - completed hardware scan
5510 *
5511 * When hardware scan offload is used (i.e. the hw_scan() callback is
5512 * assigned) this function needs to be called by the driver to notify
Johannes Berg8789d452010-08-26 13:30:26 +02005513 * mac80211 that the scan finished. This function can be called from
5514 * any context, including hardirq context.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04005515 *
5516 * @hw: the hardware that finished the scan
Avraham Stern7947d3e2016-07-05 15:23:12 +03005517 * @info: information about the completed scan
Johannes Berg75a5f0c2007-09-18 17:29:20 -04005518 */
Avraham Stern7947d3e2016-07-05 15:23:12 +03005519void ieee80211_scan_completed(struct ieee80211_hw *hw,
5520 struct cfg80211_scan_info *info);
Jiri Bencf0706e82007-05-05 11:45:53 -07005521
Johannes Bergdabeb342007-11-09 01:57:29 +01005522/**
Luciano Coelho79f460c2011-05-11 17:09:36 +03005523 * ieee80211_sched_scan_results - got results from scheduled scan
5524 *
5525 * When a scheduled scan is running, this function needs to be called by the
5526 * driver whenever there are new scan results available.
5527 *
5528 * @hw: the hardware that is performing scheduled scans
5529 */
5530void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
5531
5532/**
5533 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
5534 *
5535 * When a scheduled scan is running, this function can be called by
5536 * the driver if it needs to stop the scan to perform another task.
5537 * Usual scenarios are drivers that cannot continue the scheduled scan
5538 * while associating, for instance.
5539 *
5540 * @hw: the hardware that is performing scheduled scans
5541 */
5542void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
5543
5544/**
Johannes Berg8b2c9822012-11-06 20:23:30 +01005545 * enum ieee80211_interface_iteration_flags - interface iteration flags
5546 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
5547 * been added to the driver; However, note that during hardware
5548 * reconfiguration (after restart_hw) it will iterate over a new
5549 * interface and over all the existing interfaces even if they
5550 * haven't been re-added to the driver yet.
5551 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
5552 * interfaces, even if they haven't been re-added to the driver yet.
Arik Nemtsov3384d752015-03-01 09:10:15 +02005553 * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up).
Ben Greear265a0702020-09-22 12:19:56 -07005554 * @IEEE80211_IFACE_SKIP_SDATA_NOT_IN_DRIVER: Skip any interfaces where SDATA
5555 * is not in the driver. This may fix crashes during firmware recovery
5556 * for instance.
Johannes Berg8b2c9822012-11-06 20:23:30 +01005557 */
5558enum ieee80211_interface_iteration_flags {
5559 IEEE80211_IFACE_ITER_NORMAL = 0,
5560 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
Arik Nemtsov3384d752015-03-01 09:10:15 +02005561 IEEE80211_IFACE_ITER_ACTIVE = BIT(1),
Ben Greear265a0702020-09-22 12:19:56 -07005562 IEEE80211_IFACE_SKIP_SDATA_NOT_IN_DRIVER = BIT(2),
Johannes Berg8b2c9822012-11-06 20:23:30 +01005563};
5564
5565/**
Arik Nemtsov3384d752015-03-01 09:10:15 +02005566 * ieee80211_iterate_interfaces - iterate interfaces
5567 *
5568 * This function iterates over the interfaces associated with a given
5569 * hardware and calls the callback for them. This includes active as well as
5570 * inactive interfaces. This function allows the iterator function to sleep.
5571 * Will iterate over a new interface during add_interface().
5572 *
5573 * @hw: the hardware struct of which the interfaces should be iterated over
5574 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5575 * @iterator: the iterator function to call
5576 * @data: first argument of the iterator function
5577 */
5578void ieee80211_iterate_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
5579 void (*iterator)(void *data, u8 *mac,
5580 struct ieee80211_vif *vif),
5581 void *data);
5582
5583/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07005584 * ieee80211_iterate_active_interfaces - iterate active interfaces
Johannes Bergdabeb342007-11-09 01:57:29 +01005585 *
5586 * This function iterates over the interfaces associated with a given
5587 * hardware that are currently active and calls the callback for them.
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02005588 * This function allows the iterator function to sleep, when the iterator
5589 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
5590 * be used.
Johannes Berg8b2c9822012-11-06 20:23:30 +01005591 * Does not iterate over a new interface during add_interface().
Johannes Bergdabeb342007-11-09 01:57:29 +01005592 *
5593 * @hw: the hardware struct of which the interfaces should be iterated over
Johannes Berg8b2c9822012-11-06 20:23:30 +01005594 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02005595 * @iterator: the iterator function to call
Johannes Bergdabeb342007-11-09 01:57:29 +01005596 * @data: first argument of the iterator function
5597 */
Arik Nemtsov3384d752015-03-01 09:10:15 +02005598static inline void
5599ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
5600 void (*iterator)(void *data, u8 *mac,
5601 struct ieee80211_vif *vif),
5602 void *data)
5603{
5604 ieee80211_iterate_interfaces(hw,
5605 iter_flags | IEEE80211_IFACE_ITER_ACTIVE,
5606 iterator, data);
5607}
Johannes Bergdabeb342007-11-09 01:57:29 +01005608
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02005609/**
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02005610 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
5611 *
5612 * This function iterates over the interfaces associated with a given
5613 * hardware that are currently active and calls the callback for them.
5614 * This function requires the iterator callback function to be atomic,
5615 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
Johannes Berg8b2c9822012-11-06 20:23:30 +01005616 * Does not iterate over a new interface during add_interface().
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02005617 *
5618 * @hw: the hardware struct of which the interfaces should be iterated over
Johannes Berg8b2c9822012-11-06 20:23:30 +01005619 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02005620 * @iterator: the iterator function to call, cannot sleep
5621 * @data: first argument of the iterator function
5622 */
5623void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
Johannes Berg8b2c9822012-11-06 20:23:30 +01005624 u32 iter_flags,
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02005625 void (*iterator)(void *data,
5626 u8 *mac,
5627 struct ieee80211_vif *vif),
5628 void *data);
5629
5630/**
Johannes Berga05829a2021-01-22 16:19:43 +01005631 * ieee80211_iterate_active_interfaces_mtx - iterate active interfaces
Johannes Bergc7c71062013-08-21 22:07:20 +02005632 *
5633 * This function iterates over the interfaces associated with a given
5634 * hardware that are currently active and calls the callback for them.
Brian Norris34fb4db2021-05-05 13:28:29 -07005635 * This version can only be used while holding the wiphy mutex.
Martin Blumenstinglacb99b92021-12-28 22:14:53 +01005636 * The driver must not call this with a lock held that it can also take in
5637 * response to callbacks from mac80211, and it must not call this within
5638 * callbacks made by mac80211 - both would result in deadlocks.
Johannes Bergc7c71062013-08-21 22:07:20 +02005639 *
5640 * @hw: the hardware struct of which the interfaces should be iterated over
5641 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5642 * @iterator: the iterator function to call, cannot sleep
5643 * @data: first argument of the iterator function
5644 */
Johannes Berga05829a2021-01-22 16:19:43 +01005645void ieee80211_iterate_active_interfaces_mtx(struct ieee80211_hw *hw,
5646 u32 iter_flags,
5647 void (*iterator)(void *data,
Johannes Bergc7c71062013-08-21 22:07:20 +02005648 u8 *mac,
5649 struct ieee80211_vif *vif),
Johannes Berga05829a2021-01-22 16:19:43 +01005650 void *data);
Johannes Bergc7c71062013-08-21 22:07:20 +02005651
5652/**
Martin Blumenstinglacb99b92021-12-28 22:14:53 +01005653 * ieee80211_iterate_stations - iterate stations
5654 *
5655 * This function iterates over all stations associated with a given
5656 * hardware that are currently uploaded to the driver and calls the callback
5657 * function for them.
5658 * This function allows the iterator function to sleep, when the iterator
5659 * function is atomic @ieee80211_iterate_stations_atomic can be used.
5660 *
5661 * @hw: the hardware struct of which the interfaces should be iterated over
5662 * @iterator: the iterator function to call, cannot sleep
5663 * @data: first argument of the iterator function
5664 */
5665void ieee80211_iterate_stations(struct ieee80211_hw *hw,
5666 void (*iterator)(void *data,
5667 struct ieee80211_sta *sta),
5668 void *data);
5669
5670/**
Arik Nemtsov0fc1e042014-10-22 12:30:59 +03005671 * ieee80211_iterate_stations_atomic - iterate stations
5672 *
5673 * This function iterates over all stations associated with a given
5674 * hardware that are currently uploaded to the driver and calls the callback
5675 * function for them.
5676 * This function requires the iterator callback function to be atomic,
5677 *
5678 * @hw: the hardware struct of which the interfaces should be iterated over
5679 * @iterator: the iterator function to call, cannot sleep
5680 * @data: first argument of the iterator function
5681 */
5682void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw,
5683 void (*iterator)(void *data,
5684 struct ieee80211_sta *sta),
5685 void *data);
5686/**
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04005687 * ieee80211_queue_work - add work onto the mac80211 workqueue
5688 *
5689 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
5690 * This helper ensures drivers are not queueing work when they should not be.
5691 *
5692 * @hw: the hardware struct for the interface we are adding work for
5693 * @work: the work we want to add onto the mac80211 workqueue
5694 */
5695void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
5696
5697/**
5698 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
5699 *
5700 * Drivers and mac80211 use this to queue delayed work onto the mac80211
5701 * workqueue.
5702 *
5703 * @hw: the hardware struct for the interface we are adding work for
5704 * @dwork: delayable work to queue onto the mac80211 workqueue
5705 * @delay: number of jiffies to wait before queueing
5706 */
5707void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
5708 struct delayed_work *dwork,
5709 unsigned long delay);
5710
5711/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02005712 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01005713 * @sta: the station for which to start a BA session
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02005714 * @tid: the TID to BA on.
Sujith Manoharanbd2ce6e2010-12-15 07:47:10 +05305715 * @timeout: session timeout value (in TUs)
Randy Dunlapea2d8b52008-10-27 09:47:03 -07005716 *
5717 * Return: success if addBA request was sent, failure otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02005718 *
5719 * Although mac80211/low level driver/user space application can estimate
5720 * the need to start aggregation on a certain RA/TID, the session level
5721 * will be managed by the mac80211.
5722 */
Sujith Manoharanbd2ce6e2010-12-15 07:47:10 +05305723int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
5724 u16 timeout);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02005725
5726/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02005727 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01005728 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02005729 * @ra: receiver address of the BA session recipient.
5730 * @tid: the TID to BA on.
5731 *
5732 * This function must be called by low level driver once it has
Johannes Berg5d22c892010-06-10 10:21:40 +02005733 * finished with preparations for the BA session. It can be called
5734 * from any context.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02005735 */
Johannes Bergc951ad32009-11-16 12:00:38 +01005736void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02005737 u16 tid);
5738
5739/**
5740 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01005741 * @sta: the station whose BA session to stop
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02005742 * @tid: the TID to stop BA.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07005743 *
Johannes Berg6a8579d2010-05-27 14:41:07 +02005744 * Return: negative error if the TID is invalid, or no aggregation active
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02005745 *
5746 * Although mac80211/low level driver/user space application can estimate
5747 * the need to stop aggregation on a certain RA/TID, the session level
5748 * will be managed by the mac80211.
5749 */
Johannes Berg6a8579d2010-05-27 14:41:07 +02005750int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02005751
5752/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02005753 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01005754 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02005755 * @ra: receiver address of the BA session recipient.
5756 * @tid: the desired TID to BA on.
5757 *
5758 * This function must be called by low level driver once it has
Johannes Berg5d22c892010-06-10 10:21:40 +02005759 * finished with preparations for the BA session tear down. It
5760 * can be called from any context.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02005761 */
Johannes Bergc951ad32009-11-16 12:00:38 +01005762void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02005763 u16 tid);
5764
Mohamed Abbas84363e62008-04-04 16:59:58 -07005765/**
Johannes Berg17741cd2008-09-11 00:02:02 +02005766 * ieee80211_find_sta - find a station
5767 *
Johannes Berg5ed176e2009-11-04 14:42:28 +01005768 * @vif: virtual interface to look for station on
Johannes Berg17741cd2008-09-11 00:02:02 +02005769 * @addr: station's address
5770 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01005771 * Return: The station, if found. %NULL otherwise.
5772 *
5773 * Note: This function must be called under RCU lock and the
Johannes Berg17741cd2008-09-11 00:02:02 +02005774 * resulting pointer is only valid under RCU lock as well.
5775 */
Johannes Berg5ed176e2009-11-04 14:42:28 +01005776struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02005777 const u8 *addr);
5778
Kalle Valo04de8382009-03-22 21:57:35 +02005779/**
Ben Greear686b9cb2010-09-23 09:44:36 -07005780 * ieee80211_find_sta_by_ifaddr - find a station on hardware
Johannes Berg5ed176e2009-11-04 14:42:28 +01005781 *
5782 * @hw: pointer as obtained from ieee80211_alloc_hw()
Ben Greear686b9cb2010-09-23 09:44:36 -07005783 * @addr: remote station's address
5784 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
Johannes Berg5ed176e2009-11-04 14:42:28 +01005785 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01005786 * Return: The station, if found. %NULL otherwise.
5787 *
5788 * Note: This function must be called under RCU lock and the
Johannes Berg5ed176e2009-11-04 14:42:28 +01005789 * resulting pointer is only valid under RCU lock as well.
5790 *
Ben Greear686b9cb2010-09-23 09:44:36 -07005791 * NOTE: You may pass NULL for localaddr, but then you will just get
5792 * the first STA that matches the remote address 'addr'.
5793 * We can have multiple STA associated with multiple
5794 * logical stations (e.g. consider a station connecting to another
5795 * BSSID on the same AP hardware without disconnecting first).
5796 * In this case, the result of this method with localaddr NULL
5797 * is not reliable.
Johannes Berg5ed176e2009-11-04 14:42:28 +01005798 *
Ben Greear686b9cb2010-09-23 09:44:36 -07005799 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
Johannes Berg5ed176e2009-11-04 14:42:28 +01005800 */
Ben Greear686b9cb2010-09-23 09:44:36 -07005801struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
5802 const u8 *addr,
5803 const u8 *localaddr);
Johannes Berg5ed176e2009-11-04 14:42:28 +01005804
5805/**
Johannes Bergaf818582009-11-06 11:35:50 +01005806 * ieee80211_sta_block_awake - block station from waking up
5807 * @hw: the hardware
5808 * @pubsta: the station
5809 * @block: whether to block or unblock
5810 *
5811 * Some devices require that all frames that are on the queues
5812 * for a specific station that went to sleep are flushed before
5813 * a poll response or frames after the station woke up can be
5814 * delivered to that it. Note that such frames must be rejected
5815 * by the driver as filtered, with the appropriate status flag.
5816 *
5817 * This function allows implementing this mode in a race-free
5818 * manner.
5819 *
5820 * To do this, a driver must keep track of the number of frames
5821 * still enqueued for a specific station. If this number is not
5822 * zero when the station goes to sleep, the driver must call
5823 * this function to force mac80211 to consider the station to
5824 * be asleep regardless of the station's actual state. Once the
5825 * number of outstanding frames reaches zero, the driver must
5826 * call this function again to unblock the station. That will
5827 * cause mac80211 to be able to send ps-poll responses, and if
5828 * the station queried in the meantime then frames will also
5829 * be sent out as a result of this. Additionally, the driver
5830 * will be notified that the station woke up some time after
5831 * it is unblocked, regardless of whether the station actually
5832 * woke up while blocked or not.
5833 */
5834void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
5835 struct ieee80211_sta *pubsta, bool block);
5836
5837/**
Johannes Berg37fbd902011-09-29 16:04:39 +02005838 * ieee80211_sta_eosp - notify mac80211 about end of SP
5839 * @pubsta: the station
5840 *
5841 * When a device transmits frames in a way that it can't tell
5842 * mac80211 in the TX status about the EOSP, it must clear the
5843 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
5844 * This applies for PS-Poll as well as uAPSD.
5845 *
Johannes Berge9437892013-02-15 21:38:08 +01005846 * Note that just like with _tx_status() and _rx() drivers must
5847 * not mix calls to irqsafe/non-irqsafe versions, this function
5848 * must not be mixed with those either. Use the all irqsafe, or
5849 * all non-irqsafe, don't mix!
5850 *
5851 * NB: the _irqsafe version of this function doesn't exist, no
5852 * driver needs it right now. Don't call this function if
5853 * you'd need the _irqsafe version, look at the git history
5854 * and restore the _irqsafe version!
Johannes Berg37fbd902011-09-29 16:04:39 +02005855 */
Johannes Berge9437892013-02-15 21:38:08 +01005856void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
Johannes Berg37fbd902011-09-29 16:04:39 +02005857
5858/**
Emmanuel Grumbach0ead2512015-11-17 10:24:36 +02005859 * ieee80211_send_eosp_nullfunc - ask mac80211 to send NDP with EOSP
5860 * @pubsta: the station
5861 * @tid: the tid of the NDP
5862 *
5863 * Sometimes the device understands that it needs to close
5864 * the Service Period unexpectedly. This can happen when
5865 * sending frames that are filling holes in the BA window.
5866 * In this case, the device can ask mac80211 to send a
5867 * Nullfunc frame with EOSP set. When that happens, the
5868 * driver must have called ieee80211_sta_set_buffered() to
5869 * let mac80211 know that there are no buffered frames any
5870 * more, otherwise mac80211 will get the more_data bit wrong.
5871 * The low level driver must have made sure that the frame
5872 * will be sent despite the station being in power-save.
5873 * Mac80211 won't call allow_buffered_frames().
5874 * Note that calling this function, doesn't exempt the driver
5875 * from closing the EOSP properly, it will still have to call
5876 * ieee80211_sta_eosp when the NDP is sent.
5877 */
5878void ieee80211_send_eosp_nullfunc(struct ieee80211_sta *pubsta, int tid);
5879
5880/**
Toke Høiland-Jørgensenb4809e92018-12-18 17:02:08 -08005881 * ieee80211_sta_register_airtime - register airtime usage for a sta/tid
5882 *
Felix Fietkauc74114d2020-09-08 14:36:55 +02005883 * Register airtime usage for a given sta on a given tid. The driver must call
Toke Høiland-Jørgensenb4809e92018-12-18 17:02:08 -08005884 * this function to notify mac80211 that a station used a certain amount of
5885 * airtime. This information will be used by the TXQ scheduler to schedule
5886 * stations in a way that ensures airtime fairness.
5887 *
5888 * The reported airtime should as a minimum include all time that is spent
5889 * transmitting to the remote station, including overhead and padding, but not
5890 * including time spent waiting for a TXOP. If the time is not reported by the
5891 * hardware it can in some cases be calculated from the rate and known frame
5892 * composition. When possible, the time should include any failed transmission
5893 * attempts.
5894 *
5895 * The driver can either call this function synchronously for every packet or
5896 * aggregate, or asynchronously as airtime usage information becomes available.
5897 * TX and RX airtime can be reported together, or separately by setting one of
5898 * them to 0.
5899 *
5900 * @pubsta: the station
5901 * @tid: the TID to register airtime for
5902 * @tx_airtime: airtime used during TX (in usec)
5903 * @rx_airtime: airtime used during RX (in usec)
5904 */
5905void ieee80211_sta_register_airtime(struct ieee80211_sta *pubsta, u8 tid,
5906 u32 tx_airtime, u32 rx_airtime);
5907
5908/**
Kan Yan3ace10f2019-11-18 22:06:09 -08005909 * ieee80211_txq_airtime_check - check if a txq can send frame to device
5910 *
5911 * @hw: pointer obtained from ieee80211_alloc_hw()
5912 * @txq: pointer obtained from station or virtual interface
5913 *
5914 * Return true if the AQL's airtime limit has not been reached and the txq can
5915 * continue to send more packets to the device. Otherwise return false.
5916 */
5917bool
5918ieee80211_txq_airtime_check(struct ieee80211_hw *hw, struct ieee80211_txq *txq);
5919
5920/**
Johannes Berg830af022011-07-05 16:35:39 +02005921 * ieee80211_iter_keys - iterate keys programmed into the device
5922 * @hw: pointer obtained from ieee80211_alloc_hw()
5923 * @vif: virtual interface to iterate, may be %NULL for all
5924 * @iter: iterator function that will be called for each key
5925 * @iter_data: custom data to pass to the iterator function
5926 *
5927 * This function can be used to iterate all the keys known to
5928 * mac80211, even those that weren't previously programmed into
5929 * the device. This is intended for use in WoWLAN if the device
5930 * needs reprogramming of the keys during suspend. Note that due
5931 * to locking reasons, it is also only safe to call this at few
5932 * spots since it must hold the RTNL and be able to sleep.
Johannes Bergf850e002011-07-13 19:50:53 +02005933 *
5934 * The order in which the keys are iterated matches the order
5935 * in which they were originally installed and handed to the
5936 * set_key callback.
Johannes Berg830af022011-07-05 16:35:39 +02005937 */
5938void ieee80211_iter_keys(struct ieee80211_hw *hw,
5939 struct ieee80211_vif *vif,
5940 void (*iter)(struct ieee80211_hw *hw,
5941 struct ieee80211_vif *vif,
5942 struct ieee80211_sta *sta,
5943 struct ieee80211_key_conf *key,
5944 void *data),
5945 void *iter_data);
5946
5947/**
Eliad Pelleref044762015-11-17 10:24:37 +02005948 * ieee80211_iter_keys_rcu - iterate keys programmed into the device
5949 * @hw: pointer obtained from ieee80211_alloc_hw()
5950 * @vif: virtual interface to iterate, may be %NULL for all
5951 * @iter: iterator function that will be called for each key
5952 * @iter_data: custom data to pass to the iterator function
5953 *
5954 * This function can be used to iterate all the keys known to
5955 * mac80211, even those that weren't previously programmed into
5956 * the device. Note that due to locking reasons, keys of station
5957 * in removal process will be skipped.
5958 *
5959 * This function requires being called in an RCU critical section,
5960 * and thus iter must be atomic.
5961 */
5962void ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
5963 struct ieee80211_vif *vif,
5964 void (*iter)(struct ieee80211_hw *hw,
5965 struct ieee80211_vif *vif,
5966 struct ieee80211_sta *sta,
5967 struct ieee80211_key_conf *key,
5968 void *data),
5969 void *iter_data);
5970
5971/**
Johannes Berg3448c002012-09-11 17:57:42 +02005972 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
Chris Packhamae4a50e2019-10-25 10:36:47 +13005973 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg3448c002012-09-11 17:57:42 +02005974 * @iter: iterator function
5975 * @iter_data: data passed to iterator function
5976 *
5977 * Iterate all active channel contexts. This function is atomic and
5978 * doesn't acquire any locks internally that might be held in other
5979 * places while calling into the driver.
5980 *
5981 * The iterator will not find a context that's being added (during
5982 * the driver callback to add it) but will find it while it's being
5983 * removed.
Johannes Berg8a61af62012-12-13 17:42:30 +01005984 *
5985 * Note that during hardware restart, all contexts that existed
5986 * before the restart are considered already present so will be
5987 * found while iterating, whether they've been re-added already
5988 * or not.
Johannes Berg3448c002012-09-11 17:57:42 +02005989 */
5990void ieee80211_iter_chan_contexts_atomic(
5991 struct ieee80211_hw *hw,
5992 void (*iter)(struct ieee80211_hw *hw,
5993 struct ieee80211_chanctx_conf *chanctx_conf,
5994 void *data),
5995 void *iter_data);
5996
5997/**
Juuso Oikarinena619a4c2010-11-11 08:50:18 +02005998 * ieee80211_ap_probereq_get - retrieve a Probe Request template
5999 * @hw: pointer obtained from ieee80211_alloc_hw().
6000 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6001 *
6002 * Creates a Probe Request template which can, for example, be uploaded to
6003 * hardware. The template is filled with bssid, ssid and supported rate
6004 * information. This function must only be called from within the
6005 * .bss_info_changed callback function and only in managed mode. The function
6006 * is only useful when the interface is associated, otherwise it will return
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01006007 * %NULL.
6008 *
6009 * Return: The Probe Request template. %NULL on error.
Juuso Oikarinena619a4c2010-11-11 08:50:18 +02006010 */
6011struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
6012 struct ieee80211_vif *vif);
6013
6014/**
Kalle Valo04de8382009-03-22 21:57:35 +02006015 * ieee80211_beacon_loss - inform hardware does not receive beacons
6016 *
Johannes Berg1ed32e42009-12-23 13:15:45 +01006017 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Kalle Valo04de8382009-03-22 21:57:35 +02006018 *
Johannes Bergc1288b12012-01-19 09:29:57 +01006019 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02006020 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
Kalle Valo04de8382009-03-22 21:57:35 +02006021 * hardware is not receiving beacons with this function.
6022 */
6023void ieee80211_beacon_loss(struct ieee80211_vif *vif);
Johannes Berg4b7679a2008-09-18 18:14:18 +02006024
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02006025/**
6026 * ieee80211_connection_loss - inform hardware has lost connection to the AP
6027 *
6028 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6029 *
Johannes Bergc1288b12012-01-19 09:29:57 +01006030 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02006031 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
6032 * needs to inform if the connection to the AP has been lost.
Johannes Berg682bd382013-01-29 13:13:50 +01006033 * The function may also be called if the connection needs to be terminated
6034 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02006035 *
6036 * This function will cause immediate change to disassociated state,
6037 * without connection recovery attempts.
6038 */
6039void ieee80211_connection_loss(struct ieee80211_vif *vif);
6040
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02006041/**
Johannes Berg3f8a39f2020-12-06 14:54:43 +02006042 * ieee80211_disconnect - request disconnection
6043 *
6044 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6045 * @reconnect: immediate reconnect is desired
6046 *
6047 * Request disconnection from the current network and, if enabled, send a
6048 * hint to the higher layers that immediate reconnect is desired.
6049 */
6050void ieee80211_disconnect(struct ieee80211_vif *vif, bool reconnect);
6051
6052/**
Johannes Berg95acac62011-07-12 12:30:59 +02006053 * ieee80211_resume_disconnect - disconnect from AP after resume
6054 *
6055 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6056 *
6057 * Instructs mac80211 to disconnect from the AP after resume.
6058 * Drivers can use this after WoWLAN if they know that the
6059 * connection cannot be kept up, for example because keys were
6060 * used while the device was asleep but the replay counters or
6061 * similar cannot be retrieved from the device during resume.
6062 *
6063 * Note that due to implementation issues, if the driver uses
6064 * the reconfiguration functionality during resume the interface
6065 * will still be added as associated first during resume and then
6066 * disconnect normally later.
6067 *
6068 * This function can only be called from the resume callback and
6069 * the driver must not be holding any of its own locks while it
6070 * calls this function, or at least not any locks it needs in the
6071 * key configuration paths (if it supports HW crypto).
6072 */
6073void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
6074
6075/**
Youghandhar Chintala7d352ccf2022-03-08 17:23:24 +05306076 * ieee80211_hw_restart_disconnect - disconnect from AP after
6077 * hardware restart
6078 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6079 *
6080 * Instructs mac80211 to disconnect from the AP after
6081 * hardware restart.
6082 */
6083void ieee80211_hw_restart_disconnect(struct ieee80211_vif *vif);
6084
6085/**
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02006086 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
6087 * rssi threshold triggered
6088 *
6089 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6090 * @rssi_event: the RSSI trigger event type
Andrzej Zaborowski769f07d2017-01-25 12:43:40 +01006091 * @rssi_level: new RSSI level value or 0 if not available
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02006092 * @gfp: context flags
6093 *
Johannes Bergea086352012-01-19 09:29:58 +01006094 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02006095 * monitoring is configured with an rssi threshold, the driver will inform
6096 * whenever the rssi level reaches the threshold.
6097 */
6098void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
6099 enum nl80211_cqm_rssi_threshold_event rssi_event,
Andrzej Zaborowski769f07d2017-01-25 12:43:40 +01006100 s32 rssi_level,
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02006101 gfp_t gfp);
6102
Johannes Berg5ce6e432010-05-11 16:20:57 +02006103/**
Johannes Berg98f03342014-11-26 12:42:02 +01006104 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
6105 *
6106 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6107 * @gfp: context flags
6108 */
6109void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp);
6110
6111/**
Simon Wunderlich164eb022013-02-08 18:16:20 +01006112 * ieee80211_radar_detected - inform that a radar was detected
6113 *
6114 * @hw: pointer as obtained from ieee80211_alloc_hw()
6115 */
6116void ieee80211_radar_detected(struct ieee80211_hw *hw);
6117
6118/**
Johannes Berg5ce6e432010-05-11 16:20:57 +02006119 * ieee80211_chswitch_done - Complete channel switch process
6120 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6121 * @success: make the channel switch successful or not
6122 *
6123 * Complete the channel switch post-process: set the new operational channel
6124 * and wake up the suspended queues.
6125 */
6126void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
6127
Johannes Bergd1f5b7a2010-08-05 17:05:55 +02006128/**
Nathan Errera6d501762021-11-29 15:32:38 +02006129 * ieee80211_channel_switch_disconnect - disconnect due to channel switch error
6130 * @vif &struct ieee80211_vif pointer from the add_interface callback.
6131 * @block_tx: if %true, do not send deauth frame.
6132 *
6133 * Instruct mac80211 to disconnect due to a channel switch error. The channel
6134 * switch can request to block the tx and so, we need to make sure we do not send
6135 * a deauth frame in this case.
6136 */
6137void ieee80211_channel_switch_disconnect(struct ieee80211_vif *vif,
6138 bool block_tx);
6139
6140/**
Johannes Bergd1f5b7a2010-08-05 17:05:55 +02006141 * ieee80211_request_smps - request SM PS transition
6142 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Berg633dd1e2010-08-18 15:01:23 +02006143 * @smps_mode: new SM PS mode
Johannes Bergd1f5b7a2010-08-05 17:05:55 +02006144 *
6145 * This allows the driver to request an SM PS transition in managed
6146 * mode. This is useful when the driver has more information than
6147 * the stack about possible interference, for example by bluetooth.
6148 */
6149void ieee80211_request_smps(struct ieee80211_vif *vif,
6150 enum ieee80211_smps_mode smps_mode);
6151
Johannes Berge31b8212010-10-05 19:39:30 +02006152/**
Johannes Berg21f83582010-12-18 17:20:47 +01006153 * ieee80211_ready_on_channel - notification of remain-on-channel start
6154 * @hw: pointer as obtained from ieee80211_alloc_hw()
6155 */
6156void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
6157
6158/**
6159 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
6160 * @hw: pointer as obtained from ieee80211_alloc_hw()
6161 */
6162void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
6163
Shahar Levif41ccd72011-05-22 16:10:21 +03006164/**
6165 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
6166 *
6167 * in order not to harm the system performance and user experience, the device
6168 * may request not to allow any rx ba session and tear down existing rx ba
6169 * sessions based on system constraints such as periodic BT activity that needs
6170 * to limit wlan activity (eg.sco or a2dp)."
6171 * in such cases, the intention is to limit the duration of the rx ppdu and
6172 * therefore prevent the peer device to use a-mpdu aggregation.
6173 *
6174 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6175 * @ba_rx_bitmap: Bit map of open rx ba per tid
6176 * @addr: & to bssid mac address
6177 */
6178void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
6179 const u8 *addr);
6180
Felix Fietkau8c771242011-08-20 15:53:55 +02006181/**
Sara Sharon06470f72016-01-28 16:19:25 +02006182 * ieee80211_mark_rx_ba_filtered_frames - move RX BA window and mark filtered
6183 * @pubsta: station struct
6184 * @tid: the session's TID
6185 * @ssn: starting sequence number of the bitmap, all frames before this are
6186 * assumed to be out of the window after the call
6187 * @filtered: bitmap of filtered frames, BIT(0) is the @ssn entry etc.
6188 * @received_mpdus: number of received mpdus in firmware
6189 *
6190 * This function moves the BA window and releases all frames before @ssn, and
6191 * marks frames marked in the bitmap as having been filtered. Afterwards, it
6192 * checks if any frames in the window starting from @ssn can now be released
6193 * (in case they were only waiting for frames that were filtered.)
6194 */
6195void ieee80211_mark_rx_ba_filtered_frames(struct ieee80211_sta *pubsta, u8 tid,
6196 u16 ssn, u64 filtered,
6197 u16 received_mpdus);
6198
6199/**
Felix Fietkau8c771242011-08-20 15:53:55 +02006200 * ieee80211_send_bar - send a BlockAckReq frame
6201 *
6202 * can be used to flush pending frames from the peer's aggregation reorder
6203 * buffer.
6204 *
6205 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6206 * @ra: the peer's destination address
6207 * @tid: the TID of the aggregation session
6208 * @ssn: the new starting sequence number for the receiver
6209 */
6210void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
6211
Luca Coelho1272c5d2017-08-18 15:33:56 +03006212/**
6213 * ieee80211_manage_rx_ba_offl - helper to queue an RX BA work
6214 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6215 * @addr: station mac address
6216 * @tid: the rx tid
6217 */
Johannes Berg699cb582017-05-30 16:34:46 +02006218void ieee80211_manage_rx_ba_offl(struct ieee80211_vif *vif, const u8 *addr,
Luca Coelho1272c5d2017-08-18 15:33:56 +03006219 unsigned int tid);
Johannes Berg699cb582017-05-30 16:34:46 +02006220
Michal Kazior08cf42e2014-07-16 12:12:15 +02006221/**
6222 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
6223 *
6224 * Some device drivers may offload part of the Rx aggregation flow including
6225 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
6226 * reordering.
6227 *
6228 * Create structures responsible for reordering so device drivers may call here
6229 * when they complete AddBa negotiation.
6230 *
6231 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6232 * @addr: station mac address
6233 * @tid: the rx tid
6234 */
Johannes Berg699cb582017-05-30 16:34:46 +02006235static inline void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
6236 const u8 *addr, u16 tid)
6237{
6238 if (WARN_ON(tid >= IEEE80211_NUM_TIDS))
6239 return;
6240 ieee80211_manage_rx_ba_offl(vif, addr, tid);
6241}
Michal Kazior08cf42e2014-07-16 12:12:15 +02006242
6243/**
6244 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
6245 *
6246 * Some device drivers may offload part of the Rx aggregation flow including
6247 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
6248 * reordering.
6249 *
6250 * Destroy structures responsible for reordering so device drivers may call here
6251 * when they complete DelBa negotiation.
6252 *
6253 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6254 * @addr: station mac address
6255 * @tid: the rx tid
6256 */
Johannes Berg699cb582017-05-30 16:34:46 +02006257static inline void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
6258 const u8 *addr, u16 tid)
6259{
6260 if (WARN_ON(tid >= IEEE80211_NUM_TIDS))
6261 return;
6262 ieee80211_manage_rx_ba_offl(vif, addr, tid + IEEE80211_NUM_TIDS);
6263}
Michal Kazior08cf42e2014-07-16 12:12:15 +02006264
Naftali Goldstein04c2cf32017-07-11 10:07:25 +03006265/**
6266 * ieee80211_rx_ba_timer_expired - stop a Rx BA session due to timeout
6267 *
6268 * Some device drivers do not offload AddBa/DelBa negotiation, but handle rx
6269 * buffer reording internally, and therefore also handle the session timer.
6270 *
6271 * Trigger the timeout flow, which sends a DelBa.
6272 *
6273 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6274 * @addr: station mac address
6275 * @tid: the rx tid
6276 */
6277void ieee80211_rx_ba_timer_expired(struct ieee80211_vif *vif,
6278 const u8 *addr, unsigned int tid);
6279
Johannes Berg4b7679a2008-09-18 18:14:18 +02006280/* Rate control API */
Johannes Berge6a98542008-10-21 12:40:02 +02006281
Johannes Berg4b7679a2008-09-18 18:14:18 +02006282/**
Johannes Berge6a98542008-10-21 12:40:02 +02006283 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
Johannes Berg4b7679a2008-09-18 18:14:18 +02006284 *
Johannes Berge6a98542008-10-21 12:40:02 +02006285 * @hw: The hardware the algorithm is invoked for.
6286 * @sband: The band this frame is being transmitted on.
6287 * @bss_conf: the current BSS configuration
Simon Wunderlichf44d4eb2012-03-07 21:31:13 +01006288 * @skb: the skb that will be transmitted, the control information in it needs
6289 * to be filled in
Johannes Berge6a98542008-10-21 12:40:02 +02006290 * @reported_rate: The rate control algorithm can fill this in to indicate
6291 * which rate should be reported to userspace as the current rate and
6292 * used for rate calculations in the mesh network.
6293 * @rts: whether RTS will be used for this frame because it is longer than the
6294 * RTS threshold
6295 * @short_preamble: whether mac80211 will request short-preamble transmission
6296 * if the selected rate supports it
Simon Wunderlichf44d4eb2012-03-07 21:31:13 +01006297 * @rate_idx_mask: user-requested (legacy) rate mask
Felix Fietkau2ffbe6d2013-04-16 13:38:42 +02006298 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
Felix Fietkau8f0729b2010-11-11 15:07:23 +01006299 * @bss: whether this frame is sent out in AP or IBSS mode
Johannes Berg4b7679a2008-09-18 18:14:18 +02006300 */
Johannes Berge6a98542008-10-21 12:40:02 +02006301struct ieee80211_tx_rate_control {
6302 struct ieee80211_hw *hw;
6303 struct ieee80211_supported_band *sband;
6304 struct ieee80211_bss_conf *bss_conf;
6305 struct sk_buff *skb;
6306 struct ieee80211_tx_rate reported_rate;
6307 bool rts, short_preamble;
Jouni Malinen37eb0b12010-01-06 13:09:08 +02006308 u32 rate_idx_mask;
Felix Fietkau2ffbe6d2013-04-16 13:38:42 +02006309 u8 *rate_idx_mcs_mask;
Felix Fietkau8f0729b2010-11-11 15:07:23 +01006310 bool bss;
Johannes Berg4b7679a2008-09-18 18:14:18 +02006311};
6312
Johannes Berg09b4a4f2018-08-31 11:31:17 +03006313/**
6314 * enum rate_control_capabilities - rate control capabilities
6315 */
6316enum rate_control_capabilities {
6317 /**
6318 * @RATE_CTRL_CAPA_VHT_EXT_NSS_BW:
6319 * Support for extended NSS BW support (dot11VHTExtendedNSSCapable)
6320 * Note that this is only looked at if the minimum number of chains
6321 * that the AP uses is < the number of TX chains the hardware has,
6322 * otherwise the NSS difference doesn't bother us.
6323 */
6324 RATE_CTRL_CAPA_VHT_EXT_NSS_BW = BIT(0),
Felix Fietkau08a46c642021-06-17 18:31:11 +02006325 /**
6326 * @RATE_CTRL_CAPA_AMPDU_TRIGGER:
6327 * mac80211 should start A-MPDU sessions on tx
6328 */
6329 RATE_CTRL_CAPA_AMPDU_TRIGGER = BIT(1),
Johannes Berg09b4a4f2018-08-31 11:31:17 +03006330};
6331
Johannes Berg4b7679a2008-09-18 18:14:18 +02006332struct rate_control_ops {
Johannes Berg09b4a4f2018-08-31 11:31:17 +03006333 unsigned long capa;
Johannes Berg4b7679a2008-09-18 18:14:18 +02006334 const char *name;
Johannes Berg6cb5f3e2020-04-23 11:13:49 +02006335 void *(*alloc)(struct ieee80211_hw *hw);
6336 void (*add_debugfs)(struct ieee80211_hw *hw, void *priv,
6337 struct dentry *debugfsdir);
Johannes Berg4b7679a2008-09-18 18:14:18 +02006338 void (*free)(void *priv);
6339
6340 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
6341 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
Simon Wunderlich3de805c2013-07-08 16:55:50 +02006342 struct cfg80211_chan_def *chandef,
Johannes Berg4b7679a2008-09-18 18:14:18 +02006343 struct ieee80211_sta *sta, void *priv_sta);
Sujith81cb7622009-02-12 11:38:37 +05306344 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
Simon Wunderlich3de805c2013-07-08 16:55:50 +02006345 struct cfg80211_chan_def *chandef,
Johannes Berg64f68e52012-03-28 10:58:37 +02006346 struct ieee80211_sta *sta, void *priv_sta,
6347 u32 changed);
Johannes Berg4b7679a2008-09-18 18:14:18 +02006348 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
6349 void *priv_sta);
6350
Felix Fietkau18fb84d2017-04-26 17:11:35 +02006351 void (*tx_status_ext)(void *priv,
6352 struct ieee80211_supported_band *sband,
6353 void *priv_sta, struct ieee80211_tx_status *st);
Johannes Berg4b7679a2008-09-18 18:14:18 +02006354 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
6355 struct ieee80211_sta *sta, void *priv_sta,
6356 struct sk_buff *skb);
Johannes Berge6a98542008-10-21 12:40:02 +02006357 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
6358 struct ieee80211_tx_rate_control *txrc);
Johannes Berg4b7679a2008-09-18 18:14:18 +02006359
6360 void (*add_sta_debugfs)(void *priv, void *priv_sta,
6361 struct dentry *dir);
Antonio Quartullicca674d2014-05-19 21:53:20 +02006362
6363 u32 (*get_expected_throughput)(void *priv_sta);
Johannes Berg4b7679a2008-09-18 18:14:18 +02006364};
6365
6366static inline int rate_supported(struct ieee80211_sta *sta,
Johannes Berg57fbcce2016-04-12 15:56:15 +02006367 enum nl80211_band band,
Johannes Berg4b7679a2008-09-18 18:14:18 +02006368 int index)
6369{
6370 return (sta == NULL || sta->supp_rates[band] & BIT(index));
6371}
6372
6373static inline s8
6374rate_lowest_index(struct ieee80211_supported_band *sband,
6375 struct ieee80211_sta *sta)
6376{
6377 int i;
6378
6379 for (i = 0; i < sband->n_bitrates; i++)
6380 if (rate_supported(sta, sband->band, i))
6381 return i;
6382
6383 /* warn when we cannot find a rate. */
Johannes Berg54d50262011-11-04 18:07:43 +01006384 WARN_ON_ONCE(1);
Johannes Berg4b7679a2008-09-18 18:14:18 +02006385
Johannes Berg54d50262011-11-04 18:07:43 +01006386 /* and return 0 (the lowest index) */
Johannes Berg4b7679a2008-09-18 18:14:18 +02006387 return 0;
6388}
6389
Luis R. Rodriguezb770b432009-07-16 10:15:09 -07006390static inline
6391bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
6392 struct ieee80211_sta *sta)
6393{
6394 unsigned int i;
6395
6396 for (i = 0; i < sband->n_bitrates; i++)
6397 if (rate_supported(sta, sband->band, i))
6398 return true;
6399 return false;
6400}
Johannes Berg4b7679a2008-09-18 18:14:18 +02006401
Felix Fietkau0d528d82013-04-22 16:14:41 +02006402/**
6403 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
6404 *
6405 * When not doing a rate control probe to test rates, rate control should pass
6406 * its rate selection to mac80211. If the driver supports receiving a station
6407 * rate table, it will use it to ensure that frames are always sent based on
6408 * the most recent rate control module decision.
6409 *
6410 * @hw: pointer as obtained from ieee80211_alloc_hw()
6411 * @pubsta: &struct ieee80211_sta pointer to the target destination.
6412 * @rates: new tx rate set to be used for this station.
6413 */
6414int rate_control_set_rates(struct ieee80211_hw *hw,
6415 struct ieee80211_sta *pubsta,
6416 struct ieee80211_sta_rates *rates);
6417
Johannes Berg631ad702014-01-20 23:29:34 +01006418int ieee80211_rate_control_register(const struct rate_control_ops *ops);
6419void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
Johannes Berg4b7679a2008-09-18 18:14:18 +02006420
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08006421static inline bool
6422conf_is_ht20(struct ieee80211_conf *conf)
6423{
Karl Beldan675a0b02013-03-25 16:26:57 +01006424 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08006425}
6426
6427static inline bool
6428conf_is_ht40_minus(struct ieee80211_conf *conf)
6429{
Karl Beldan675a0b02013-03-25 16:26:57 +01006430 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
6431 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08006432}
6433
6434static inline bool
6435conf_is_ht40_plus(struct ieee80211_conf *conf)
6436{
Karl Beldan675a0b02013-03-25 16:26:57 +01006437 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
6438 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08006439}
6440
6441static inline bool
6442conf_is_ht40(struct ieee80211_conf *conf)
6443{
Karl Beldan675a0b02013-03-25 16:26:57 +01006444 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08006445}
6446
6447static inline bool
6448conf_is_ht(struct ieee80211_conf *conf)
6449{
Rostislav Lisovy041f6072014-04-02 15:31:55 +02006450 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
6451 (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
6452 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08006453}
6454
Johannes Berg2ca27bc2010-09-16 14:58:23 +02006455static inline enum nl80211_iftype
6456ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
6457{
6458 if (p2p) {
6459 switch (type) {
6460 case NL80211_IFTYPE_STATION:
6461 return NL80211_IFTYPE_P2P_CLIENT;
6462 case NL80211_IFTYPE_AP:
6463 return NL80211_IFTYPE_P2P_GO;
6464 default:
6465 break;
6466 }
6467 }
6468 return type;
6469}
6470
6471static inline enum nl80211_iftype
6472ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
6473{
6474 return ieee80211_iftype_p2p(vif->type, vif->p2p);
6475}
6476
Sara Sharon65554d02016-02-16 12:48:17 +02006477/**
6478 * ieee80211_update_mu_groups - set the VHT MU-MIMO groud data
6479 *
6480 * @vif: the specified virtual interface
6481 * @membership: 64 bits array - a bit is set if station is member of the group
6482 * @position: 2 bits per group id indicating the position in the group
6483 *
6484 * Note: This function assumes that the given vif is valid and the position and
6485 * membership data is of the correct size and are in the same byte order as the
6486 * matching GroupId management frame.
6487 * Calls to this function need to be serialized with RX path.
6488 */
6489void ieee80211_update_mu_groups(struct ieee80211_vif *vif,
6490 const u8 *membership, const u8 *position);
6491
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -07006492void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
6493 int rssi_min_thold,
6494 int rssi_max_thold);
6495
6496void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
Arik Nemtsov768db3432011-09-28 14:12:51 +03006497
Wey-Yi Guy0d8a0a12012-04-20 11:57:00 -07006498/**
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01006499 * ieee80211_ave_rssi - report the average RSSI for the specified interface
Wey-Yi Guy0d8a0a12012-04-20 11:57:00 -07006500 *
6501 * @vif: the specified virtual interface
6502 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01006503 * Note: This function assumes that the given vif is valid.
6504 *
6505 * Return: The average RSSI value for the requested interface, or 0 if not
6506 * applicable.
Wey-Yi Guy0d8a0a12012-04-20 11:57:00 -07006507 */
Wey-Yi Guy1dae27f2012-04-13 12:02:57 -07006508int ieee80211_ave_rssi(struct ieee80211_vif *vif);
6509
Johannes Bergcd8f7cb2013-01-22 12:34:29 +01006510/**
6511 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
6512 * @vif: virtual interface
6513 * @wakeup: wakeup reason(s)
6514 * @gfp: allocation flags
6515 *
6516 * See cfg80211_report_wowlan_wakeup().
6517 */
6518void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
6519 struct cfg80211_wowlan_wakeup *wakeup,
6520 gfp_t gfp);
6521
Felix Fietkau06be6b12013-10-14 18:01:00 +02006522/**
6523 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
6524 * @hw: pointer as obtained from ieee80211_alloc_hw()
6525 * @vif: virtual interface
6526 * @skb: frame to be sent from within the driver
6527 * @band: the band to transmit on
6528 * @sta: optional pointer to get the station to send the frame to
6529 *
6530 * Note: must be called under RCU lock
6531 */
6532bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
6533 struct ieee80211_vif *vif, struct sk_buff *skb,
6534 int band, struct ieee80211_sta **sta);
6535
Felix Fietkaua7022e62013-12-16 21:49:14 +01006536/**
Mauro Carvalho Chehabb1e8eb12020-10-23 18:33:08 +02006537 * ieee80211_parse_tx_radiotap - Sanity-check and parse the radiotap header
Mathy Vanhoefbddc0c42021-05-30 15:32:26 +02006538 * of injected frames.
6539 *
6540 * To accurately parse and take into account rate and retransmission fields,
6541 * you must initialize the chandef field in the ieee80211_tx_info structure
6542 * of the skb before calling this function.
6543 *
Mathy Vanhoefcb17ed22020-07-23 14:01:53 +04006544 * @skb: packet injected by userspace
6545 * @dev: the &struct device of this 802.11 device
6546 */
6547bool ieee80211_parse_tx_radiotap(struct sk_buff *skb,
6548 struct net_device *dev);
6549
6550/**
Felix Fietkaua7022e62013-12-16 21:49:14 +01006551 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
6552 *
6553 * @next_tsf: TSF timestamp of the next absent state change
6554 * @has_next_tsf: next absent state change event pending
6555 *
6556 * @absent: descriptor bitmask, set if GO is currently absent
6557 *
6558 * private:
6559 *
6560 * @count: count fields from the NoA descriptors
6561 * @desc: adjusted data from the NoA
6562 */
6563struct ieee80211_noa_data {
6564 u32 next_tsf;
6565 bool has_next_tsf;
6566
6567 u8 absent;
6568
6569 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
6570 struct {
6571 u32 start;
6572 u32 duration;
6573 u32 interval;
6574 } desc[IEEE80211_P2P_NOA_DESC_MAX];
6575};
6576
6577/**
6578 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
6579 *
6580 * @attr: P2P NoA IE
6581 * @data: NoA tracking data
6582 * @tsf: current TSF timestamp
6583 *
6584 * Return: number of successfully parsed descriptors
6585 */
6586int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
6587 struct ieee80211_noa_data *data, u32 tsf);
6588
6589/**
6590 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
6591 *
6592 * @data: NoA tracking data
6593 * @tsf: current TSF timestamp
6594 */
6595void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
6596
Arik Nemtsovc887f0d32014-06-11 17:18:25 +03006597/**
Mauro Carvalho Chehabb1e8eb12020-10-23 18:33:08 +02006598 * ieee80211_tdls_oper_request - request userspace to perform a TDLS operation
Arik Nemtsovc887f0d32014-06-11 17:18:25 +03006599 * @vif: virtual interface
6600 * @peer: the peer's destination address
6601 * @oper: the requested TDLS operation
6602 * @reason_code: reason code for the operation, valid for TDLS teardown
6603 * @gfp: allocation flags
6604 *
6605 * See cfg80211_tdls_oper_request().
6606 */
6607void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
6608 enum nl80211_tdls_operation oper,
6609 u16 reason_code, gfp_t gfp);
Andrei Otcheretianskia7f3a762014-10-22 15:22:49 +03006610
6611/**
Liad Kaufmanb6da9112014-11-19 13:47:38 +02006612 * ieee80211_reserve_tid - request to reserve a specific TID
6613 *
6614 * There is sometimes a need (such as in TDLS) for blocking the driver from
6615 * using a specific TID so that the FW can use it for certain operations such
6616 * as sending PTI requests. To make sure that the driver doesn't use that TID,
6617 * this function must be called as it flushes out packets on this TID and marks
6618 * it as blocked, so that any transmit for the station on this TID will be
6619 * redirected to the alternative TID in the same AC.
6620 *
6621 * Note that this function blocks and may call back into the driver, so it
6622 * should be called without driver locks held. Also note this function should
6623 * only be called from the driver's @sta_state callback.
6624 *
6625 * @sta: the station to reserve the TID for
6626 * @tid: the TID to reserve
6627 *
6628 * Returns: 0 on success, else on failure
6629 */
6630int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid);
6631
6632/**
6633 * ieee80211_unreserve_tid - request to unreserve a specific TID
6634 *
6635 * Once there is no longer any need for reserving a certain TID, this function
6636 * should be called, and no longer will packets have their TID modified for
6637 * preventing use of this TID in the driver.
6638 *
6639 * Note that this function blocks and acquires a lock, so it should be called
6640 * without driver locks held. Also note this function should only be called
6641 * from the driver's @sta_state callback.
6642 *
6643 * @sta: the station
6644 * @tid: the TID to unreserve
6645 */
6646void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid);
6647
6648/**
Felix Fietkauba8c3d62015-03-27 21:30:37 +01006649 * ieee80211_tx_dequeue - dequeue a packet from a software tx queue
6650 *
6651 * @hw: pointer as obtained from ieee80211_alloc_hw()
Toke Høiland-Jørgensen18667602018-12-18 17:02:06 -08006652 * @txq: pointer obtained from station or virtual interface, or from
6653 * ieee80211_next_txq()
Felix Fietkauba8c3d62015-03-27 21:30:37 +01006654 *
6655 * Returns the skb if successful, %NULL if no frame was available.
Johannes Bergfca12792018-12-15 11:03:08 +02006656 *
6657 * Note that this must be called in an rcu_read_lock() critical section,
6658 * which can only be released after the SKB was handled. Some pointers in
Randy Dunlap66b239d2020-07-15 09:43:24 -07006659 * skb->cb, e.g. the key pointer, are protected by RCU and thus the
Johannes Bergfca12792018-12-15 11:03:08 +02006660 * critical section must persist not just for the duration of this call
6661 * but for the duration of the frame handling.
6662 * However, also note that while in the wake_tx_queue() method,
6663 * rcu_read_lock() is already held.
Erik Stromdahlfb0e76a2019-06-17 22:01:39 +02006664 *
6665 * softirqs must also be disabled when this function is called.
6666 * In process context, use ieee80211_tx_dequeue_ni() instead.
Felix Fietkauba8c3d62015-03-27 21:30:37 +01006667 */
6668struct sk_buff *ieee80211_tx_dequeue(struct ieee80211_hw *hw,
6669 struct ieee80211_txq *txq);
Michal Kaziorf2ac7e302016-01-27 15:26:12 +01006670
6671/**
Erik Stromdahlfb0e76a2019-06-17 22:01:39 +02006672 * ieee80211_tx_dequeue_ni - dequeue a packet from a software tx queue
6673 * (in process context)
6674 *
6675 * Like ieee80211_tx_dequeue() but can be called in process context
6676 * (internally disables bottom halves).
6677 *
6678 * @hw: pointer as obtained from ieee80211_alloc_hw()
6679 * @txq: pointer obtained from station or virtual interface, or from
6680 * ieee80211_next_txq()
6681 */
6682static inline struct sk_buff *ieee80211_tx_dequeue_ni(struct ieee80211_hw *hw,
6683 struct ieee80211_txq *txq)
6684{
6685 struct sk_buff *skb;
6686
6687 local_bh_disable();
6688 skb = ieee80211_tx_dequeue(hw, txq);
6689 local_bh_enable();
6690
6691 return skb;
6692}
6693
6694/**
Toke Høiland-Jørgensen18667602018-12-18 17:02:06 -08006695 * ieee80211_next_txq - get next tx queue to pull packets from
6696 *
6697 * @hw: pointer as obtained from ieee80211_alloc_hw()
6698 * @ac: AC number to return packets from.
6699 *
Toke Høiland-Jørgensen18667602018-12-18 17:02:06 -08006700 * Returns the next txq if successful, %NULL if no queue is eligible. If a txq
6701 * is returned, it should be returned with ieee80211_return_txq() after the
6702 * driver has finished scheduling it.
6703 */
6704struct ieee80211_txq *ieee80211_next_txq(struct ieee80211_hw *hw, u8 ac);
6705
6706/**
Felix Fietkau5b989c12019-03-15 11:03:35 +01006707 * ieee80211_txq_schedule_start - start new scheduling round for TXQs
Toke Høiland-Jørgensen18667602018-12-18 17:02:06 -08006708 *
6709 * @hw: pointer as obtained from ieee80211_alloc_hw()
6710 * @ac: AC number to acquire locks for
6711 *
Felix Fietkau5b989c12019-03-15 11:03:35 +01006712 * Should be called before ieee80211_next_txq() or ieee80211_return_txq().
6713 * The driver must not call multiple TXQ scheduling rounds concurrently.
Toke Høiland-Jørgensen18667602018-12-18 17:02:06 -08006714 */
Felix Fietkau5b989c12019-03-15 11:03:35 +01006715void ieee80211_txq_schedule_start(struct ieee80211_hw *hw, u8 ac);
Toke Høiland-Jørgensen18667602018-12-18 17:02:06 -08006716
Felix Fietkau5b989c12019-03-15 11:03:35 +01006717/* (deprecated) */
6718static inline void ieee80211_txq_schedule_end(struct ieee80211_hw *hw, u8 ac)
6719{
6720}
Toke Høiland-Jørgensen18667602018-12-18 17:02:06 -08006721
6722/**
Toke Høiland-Jørgensen390298e2019-01-22 15:20:16 +01006723 * ieee80211_schedule_txq - schedule a TXQ for transmission
6724 *
6725 * @hw: pointer as obtained from ieee80211_alloc_hw()
6726 * @txq: pointer obtained from station or virtual interface
6727 *
Felix Fietkau2b4a6692019-03-18 12:00:58 +01006728 * Schedules a TXQ for transmission if it is not already scheduled,
6729 * even if mac80211 does not have any packets buffered.
6730 *
6731 * The driver may call this function if it has buffered packets for
6732 * this TXQ internally.
Toke Høiland-Jørgensen390298e2019-01-22 15:20:16 +01006733 */
Toke Høiland-Jørgensen24336472021-06-23 15:47:55 +02006734void ieee80211_schedule_txq(struct ieee80211_hw *hw, struct ieee80211_txq *txq);
Felix Fietkau5b989c12019-03-15 11:03:35 +01006735
6736/**
6737 * ieee80211_return_txq - return a TXQ previously acquired by ieee80211_next_txq()
6738 *
6739 * @hw: pointer as obtained from ieee80211_alloc_hw()
6740 * @txq: pointer obtained from station or virtual interface
Felix Fietkau2b4a6692019-03-18 12:00:58 +01006741 * @force: schedule txq even if mac80211 does not have any buffered packets.
6742 *
6743 * The driver may set force=true if it has buffered packets for this TXQ
6744 * internally.
Felix Fietkau5b989c12019-03-15 11:03:35 +01006745 */
Toke Høiland-Jørgensen24336472021-06-23 15:47:55 +02006746void ieee80211_return_txq(struct ieee80211_hw *hw, struct ieee80211_txq *txq,
6747 bool force);
Toke Høiland-Jørgensen390298e2019-01-22 15:20:16 +01006748
6749/**
Toke Høiland-Jørgensenb4809e92018-12-18 17:02:08 -08006750 * ieee80211_txq_may_transmit - check whether TXQ is allowed to transmit
6751 *
6752 * This function is used to check whether given txq is allowed to transmit by
6753 * the airtime scheduler, and can be used by drivers to access the airtime
6754 * fairness accounting without going using the scheduling order enfored by
6755 * next_txq().
6756 *
6757 * Returns %true if the airtime scheduler thinks the TXQ should be allowed to
6758 * transmit, and %false if it should be throttled. This function can also have
6759 * the side effect of rotating the TXQ in the scheduler rotation, which will
6760 * eventually bring the deficit to positive and allow the station to transmit
6761 * again.
6762 *
6763 * The API ieee80211_txq_may_transmit() also ensures that TXQ list will be
Chris Packhamae4a50e2019-10-25 10:36:47 +13006764 * aligned against driver's own round-robin scheduler list. i.e it rotates
Toke Høiland-Jørgensenb4809e92018-12-18 17:02:08 -08006765 * the TXQ list till it makes the requested node becomes the first entry
6766 * in TXQ list. Thus both the TXQ list and driver's list are in sync. If this
6767 * function returns %true, the driver is expected to schedule packets
6768 * for transmission, and then return the TXQ through ieee80211_return_txq().
6769 *
6770 * @hw: pointer as obtained from ieee80211_alloc_hw()
6771 * @txq: pointer obtained from station or virtual interface
6772 */
6773bool ieee80211_txq_may_transmit(struct ieee80211_hw *hw,
6774 struct ieee80211_txq *txq);
6775
6776/**
Michal Kaziorf2ac7e302016-01-27 15:26:12 +01006777 * ieee80211_txq_get_depth - get pending frame/byte count of given txq
6778 *
6779 * The values are not guaranteed to be coherent with regard to each other, i.e.
6780 * txq state can change half-way of this function and the caller may end up
6781 * with "new" frame_cnt and "old" byte_cnt or vice-versa.
6782 *
6783 * @txq: pointer obtained from station or virtual interface
6784 * @frame_cnt: pointer to store frame count
6785 * @byte_cnt: pointer to store byte count
6786 */
6787void ieee80211_txq_get_depth(struct ieee80211_txq *txq,
6788 unsigned long *frame_cnt,
6789 unsigned long *byte_cnt);
Ayala Beker167e33f2016-09-20 17:31:20 +03006790
6791/**
6792 * ieee80211_nan_func_terminated - notify about NAN function termination.
6793 *
6794 * This function is used to notify mac80211 about NAN function termination.
6795 * Note that this function can't be called from hard irq.
6796 *
6797 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6798 * @inst_id: the local instance id
6799 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
6800 * @gfp: allocation flags
6801 */
6802void ieee80211_nan_func_terminated(struct ieee80211_vif *vif,
6803 u8 inst_id,
6804 enum nl80211_nan_func_term_reason reason,
6805 gfp_t gfp);
Ayala Beker92bc43b2016-09-20 17:31:21 +03006806
6807/**
6808 * ieee80211_nan_func_match - notify about NAN function match event.
6809 *
6810 * This function is used to notify mac80211 about NAN function match. The
6811 * cookie inside the match struct will be assigned by mac80211.
6812 * Note that this function can't be called from hard irq.
6813 *
6814 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6815 * @match: match event information
6816 * @gfp: allocation flags
6817 */
6818void ieee80211_nan_func_match(struct ieee80211_vif *vif,
6819 struct cfg80211_nan_match_params *match,
6820 gfp_t gfp);
6821
Toke Høiland-Jørgensendb3e1c42019-11-18 22:06:08 -08006822/**
6823 * ieee80211_calc_rx_airtime - calculate estimated transmission airtime for RX.
6824 *
6825 * This function calculates the estimated airtime usage of a frame based on the
6826 * rate information in the RX status struct and the frame length.
6827 *
6828 * @hw: pointer as obtained from ieee80211_alloc_hw()
6829 * @status: &struct ieee80211_rx_status containing the transmission rate
6830 * information.
6831 * @len: frame length in bytes
6832 */
6833u32 ieee80211_calc_rx_airtime(struct ieee80211_hw *hw,
6834 struct ieee80211_rx_status *status,
6835 int len);
6836
6837/**
6838 * ieee80211_calc_tx_airtime - calculate estimated transmission airtime for TX.
6839 *
6840 * This function calculates the estimated airtime usage of a frame based on the
6841 * rate information in the TX info struct and the frame length.
6842 *
6843 * @hw: pointer as obtained from ieee80211_alloc_hw()
6844 * @info: &struct ieee80211_tx_info of the frame.
6845 * @len: frame length in bytes
6846 */
6847u32 ieee80211_calc_tx_airtime(struct ieee80211_hw *hw,
6848 struct ieee80211_tx_info *info,
6849 int len);
John Crispin50ff4772019-11-25 11:04:37 +01006850/**
6851 * ieee80211_set_hw_80211_encap - enable hardware encapsulation offloading.
6852 *
6853 * This function is used to notify mac80211 that a vif can be passed raw 802.3
6854 * frames. The driver needs to then handle the 802.11 encapsulation inside the
6855 * hardware or firmware.
6856 *
6857 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6858 * @enable: indicate if the feature should be turned on or off
6859 */
6860bool ieee80211_set_hw_80211_encap(struct ieee80211_vif *vif, bool enable);
Toke Høiland-Jørgensendb3e1c42019-11-18 22:06:08 -08006861
Aloka Dixit295b02c2020-09-11 00:05:31 +00006862/**
6863 * ieee80211_get_fils_discovery_tmpl - Get FILS discovery template.
6864 * @hw: pointer obtained from ieee80211_alloc_hw().
6865 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6866 *
6867 * The driver is responsible for freeing the returned skb.
6868 *
6869 * Return: FILS discovery template. %NULL on error.
6870 */
6871struct sk_buff *ieee80211_get_fils_discovery_tmpl(struct ieee80211_hw *hw,
6872 struct ieee80211_vif *vif);
Aloka Dixit632189a2020-09-11 00:33:01 +00006873
6874/**
6875 * ieee80211_get_unsol_bcast_probe_resp_tmpl - Get unsolicited broadcast
6876 * probe response template.
6877 * @hw: pointer obtained from ieee80211_alloc_hw().
6878 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6879 *
6880 * The driver is responsible for freeing the returned skb.
6881 *
6882 * Return: Unsolicited broadcast probe response template. %NULL on error.
6883 */
6884struct sk_buff *
6885ieee80211_get_unsol_bcast_probe_resp_tmpl(struct ieee80211_hw *hw,
6886 struct ieee80211_vif *vif);
Philipp Borgerscff7b5c2021-05-19 14:20:17 +02006887
6888/**
John Crispin5f9404a2021-07-02 19:44:08 +02006889 * ieeee80211_obss_color_collision_notify - notify userland about a BSS color
6890 * collision.
6891 *
6892 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6893 * @color_bitmap: a 64 bit bitmap representing the colors that the local BSS is
6894 * aware of.
6895 */
6896void
6897ieeee80211_obss_color_collision_notify(struct ieee80211_vif *vif,
6898 u64 color_bitmap);
6899
6900/**
Philipp Borgerscff7b5c2021-05-19 14:20:17 +02006901 * ieee80211_is_tx_data - check if frame is a data frame
6902 *
6903 * The function is used to check if a frame is a data frame. Frames with
6904 * hardware encapsulation enabled are data frames.
6905 *
6906 * @skb: the frame to be transmitted.
6907 */
6908static inline bool ieee80211_is_tx_data(struct sk_buff *skb)
6909{
6910 struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
6911 struct ieee80211_hdr *hdr = (void *) skb->data;
6912
6913 return info->flags & IEEE80211_TX_CTL_HW_80211_ENCAP ||
6914 ieee80211_is_data(hdr->frame_control);
6915}
6916
Jiri Bencf0706e82007-05-05 11:45:53 -07006917#endif /* MAC80211_H */