blob: 9ce5cb17ed826a83979d787b9a43e0f19d14f383 [file] [log] [blame]
Jiri Bencf0706e82007-05-05 11:45:53 -07001/*
Johannes Berg3017b802007-08-28 17:01:53 -04002 * mac80211 <-> driver interface
3 *
Jiri Bencf0706e82007-05-05 11:45:53 -07004 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
Jouni Malinen026331c2010-02-15 12:53:10 +02006 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
Jiri Bencf0706e82007-05-05 11:45:53 -07007 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
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>
Johannes Berg42d98792011-07-07 18:58:01 +020022#include <asm/unaligned.h>
Jiri Bencf0706e82007-05-05 11:45:53 -070023
Johannes Berg75a5f0c2007-09-18 17:29:20 -040024/**
25 * DOC: Introduction
26 *
27 * mac80211 is the Linux stack for 802.11 hardware that implements
28 * only partial functionality in hard- or firmware. This document
29 * defines the interface between mac80211 and low-level hardware
30 * drivers.
31 */
32
33/**
34 * DOC: Calling mac80211 from interrupts
35 *
36 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
Jiri Bencf0706e82007-05-05 11:45:53 -070037 * called in hardware interrupt context. The low-level driver must not call any
38 * other functions in hardware interrupt context. If there is a need for such
39 * call, the low-level driver should first ACK the interrupt and perform the
Johannes Berg2485f712008-02-25 16:27:41 +010040 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
41 * tasklet function.
42 *
43 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
Randy Dunlap6ef307b2008-07-03 13:52:18 -070044 * use the non-IRQ-safe functions!
Jiri Bencf0706e82007-05-05 11:45:53 -070045 */
46
Johannes Berg75a5f0c2007-09-18 17:29:20 -040047/**
48 * DOC: Warning
Jiri Bencf0706e82007-05-05 11:45:53 -070049 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -040050 * If you're reading this document and not the header file itself, it will
51 * be incomplete because not all documentation has been converted yet.
52 */
53
54/**
55 * DOC: Frame format
Jiri Bencf0706e82007-05-05 11:45:53 -070056 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -040057 * As a general rule, when frames are passed between mac80211 and the driver,
58 * they start with the IEEE 802.11 header and include the same octets that are
59 * sent over the air except for the FCS which should be calculated by the
60 * hardware.
61 *
62 * There are, however, various exceptions to this rule for advanced features:
63 *
64 * The first exception is for hardware encryption and decryption offload
65 * where the IV/ICV may or may not be generated in hardware.
66 *
67 * Secondly, when the hardware handles fragmentation, the frame handed to
68 * the driver from mac80211 is the MSDU, not the MPDU.
Jiri Bencf0706e82007-05-05 11:45:53 -070069 */
70
Ron Rindjunsky10816d42007-11-26 16:14:30 +020071/**
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -040072 * DOC: mac80211 workqueue
73 *
74 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
75 * The workqueue is a single threaded workqueue and can only be accessed by
76 * helpers for sanity checking. Drivers must ensure all work added onto the
77 * mac80211 workqueue should be cancelled on the driver stop() callback.
78 *
79 * mac80211 will flushed the workqueue upon interface removal and during
80 * suspend.
81 *
82 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
83 *
84 */
85
Paul Gortmaker313162d2012-01-30 11:46:54 -050086struct device;
87
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -040088/**
Johannes Berge100bb62008-04-30 18:51:21 +020089 * enum ieee80211_max_queues - maximum number of queues
90 *
91 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
Johannes Berg445ea4e2013-02-13 12:25:28 +010092 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
Johannes Berge100bb62008-04-30 18:51:21 +020093 */
94enum ieee80211_max_queues {
Johannes Berg3a25a8c2012-04-03 16:28:50 +020095 IEEE80211_MAX_QUEUES = 16,
Johannes Berg445ea4e2013-02-13 12:25:28 +010096 IEEE80211_MAX_QUEUE_MAP = BIT(IEEE80211_MAX_QUEUES) - 1,
Johannes Berge100bb62008-04-30 18:51:21 +020097};
98
Johannes Berg3a25a8c2012-04-03 16:28:50 +020099#define IEEE80211_INVAL_HW_QUEUE 0xff
100
Johannes Berge100bb62008-04-30 18:51:21 +0200101/**
Johannes Berg4bce22b2010-11-16 11:49:58 -0800102 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
103 * @IEEE80211_AC_VO: voice
104 * @IEEE80211_AC_VI: video
105 * @IEEE80211_AC_BE: best effort
106 * @IEEE80211_AC_BK: background
107 */
108enum ieee80211_ac_numbers {
109 IEEE80211_AC_VO = 0,
110 IEEE80211_AC_VI = 1,
111 IEEE80211_AC_BE = 2,
112 IEEE80211_AC_BK = 3,
113};
Johannes Berg948d8872011-09-29 16:04:29 +0200114#define IEEE80211_NUM_ACS 4
Johannes Berg4bce22b2010-11-16 11:49:58 -0800115
116/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400117 * struct ieee80211_tx_queue_params - transmit queue configuration
118 *
119 * The information provided in this structure is required for QoS
Johannes Berg3330d7b2008-02-10 16:49:38 +0100120 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400121 *
Bob Copelande37d4df2008-10-20 21:20:27 -0400122 * @aifs: arbitration interframe space [0..255]
Johannes Bergf434b2d2008-07-10 11:22:31 +0200123 * @cw_min: minimum contention window [a value of the form
124 * 2^n-1 in the range 1..32767]
Johannes Berg6b301cd2007-09-18 17:29:20 -0400125 * @cw_max: maximum contention window [like @cw_min]
Johannes Berg3330d7b2008-02-10 16:49:38 +0100126 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
Alexander Bondar908f8d02013-04-07 09:53:30 +0300127 * @acm: is mandatory admission control required for the access category
Kalle Valo9d173fc2010-01-14 13:09:14 +0200128 * @uapsd: is U-APSD mode enabled for the queue
Johannes Berg6b301cd2007-09-18 17:29:20 -0400129 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700130struct ieee80211_tx_queue_params {
Johannes Bergf434b2d2008-07-10 11:22:31 +0200131 u16 txop;
Johannes Berg3330d7b2008-02-10 16:49:38 +0100132 u16 cw_min;
133 u16 cw_max;
Johannes Bergf434b2d2008-07-10 11:22:31 +0200134 u8 aifs;
Alexander Bondar908f8d02013-04-07 09:53:30 +0300135 bool acm;
Kalle Valoab133152010-01-12 10:42:31 +0200136 bool uapsd;
Jiri Bencf0706e82007-05-05 11:45:53 -0700137};
138
Jiri Bencf0706e82007-05-05 11:45:53 -0700139struct ieee80211_low_level_stats {
140 unsigned int dot11ACKFailureCount;
141 unsigned int dot11RTSFailureCount;
142 unsigned int dot11FCSErrorCount;
143 unsigned int dot11RTSSuccessCount;
144};
145
Johannes Berg471b3ef2007-12-28 14:32:58 +0100146/**
Michal Kaziord01a1e62012-06-26 14:37:16 +0200147 * enum ieee80211_chanctx_change - change flag for channel context
Johannes Berg4bf88532012-11-09 11:39:59 +0100148 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
Johannes Berg04ecd252012-09-11 14:34:12 +0200149 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
Simon Wunderlich164eb022013-02-08 18:16:20 +0100150 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
Simon Wunderlich73da7d52013-07-11 16:09:06 +0200151 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
152 * this is used only with channel switching with CSA
Eliad Peller21f659b2013-11-11 20:14:01 +0200153 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
Michal Kaziord01a1e62012-06-26 14:37:16 +0200154 */
155enum ieee80211_chanctx_change {
Johannes Berg4bf88532012-11-09 11:39:59 +0100156 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0),
Johannes Berg04ecd252012-09-11 14:34:12 +0200157 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1),
Simon Wunderlich164eb022013-02-08 18:16:20 +0100158 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2),
Simon Wunderlich73da7d52013-07-11 16:09:06 +0200159 IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(3),
Eliad Peller21f659b2013-11-11 20:14:01 +0200160 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH = BIT(4),
Michal Kaziord01a1e62012-06-26 14:37:16 +0200161};
162
163/**
164 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
165 *
166 * This is the driver-visible part. The ieee80211_chanctx
167 * that contains it is visible in mac80211 only.
168 *
Johannes Berg4bf88532012-11-09 11:39:59 +0100169 * @def: the channel definition
Eliad Peller21f659b2013-11-11 20:14:01 +0200170 * @min_def: the minimum channel definition currently required.
Johannes Berg04ecd252012-09-11 14:34:12 +0200171 * @rx_chains_static: The number of RX chains that must always be
172 * active on the channel to receive MIMO transmissions
173 * @rx_chains_dynamic: The number of RX chains that must be enabled
174 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
Simon Wunderlich5d7fad42012-11-30 19:17:28 +0100175 * this will always be >= @rx_chains_static.
Simon Wunderlich164eb022013-02-08 18:16:20 +0100176 * @radar_enabled: whether radar detection is enabled on this channel.
Michal Kaziord01a1e62012-06-26 14:37:16 +0200177 * @drv_priv: data area for driver use, will always be aligned to
178 * sizeof(void *), size is determined in hw information.
179 */
180struct ieee80211_chanctx_conf {
Johannes Berg4bf88532012-11-09 11:39:59 +0100181 struct cfg80211_chan_def def;
Eliad Peller21f659b2013-11-11 20:14:01 +0200182 struct cfg80211_chan_def min_def;
Michal Kaziord01a1e62012-06-26 14:37:16 +0200183
Johannes Berg04ecd252012-09-11 14:34:12 +0200184 u8 rx_chains_static, rx_chains_dynamic;
185
Simon Wunderlich164eb022013-02-08 18:16:20 +0100186 bool radar_enabled;
187
Johannes Berg1c06ef92012-12-28 12:22:02 +0100188 u8 drv_priv[0] __aligned(sizeof(void *));
Michal Kaziord01a1e62012-06-26 14:37:16 +0200189};
190
191/**
Luciano Coelho1a5f0c12014-05-23 14:33:12 +0300192 * enum ieee80211_chanctx_switch_mode - channel context switch mode
193 * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already
194 * exist (and will continue to exist), but the virtual interface
195 * needs to be switched from one to the other.
196 * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop
197 * to exist with this call, the new context doesn't exist but
198 * will be active after this call, the virtual interface switches
199 * from the old to the new (note that the driver may of course
200 * implement this as an on-the-fly chandef switch of the existing
201 * hardware context, but the mac80211 pointer for the old context
202 * will cease to exist and only the new one will later be used
203 * for changes/removal.)
204 */
205enum ieee80211_chanctx_switch_mode {
206 CHANCTX_SWMODE_REASSIGN_VIF,
207 CHANCTX_SWMODE_SWAP_CONTEXTS,
208};
209
210/**
211 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information
212 *
213 * This is structure is used to pass information about a vif that
214 * needs to switch from one chanctx to another. The
215 * &ieee80211_chanctx_switch_mode defines how the switch should be
216 * done.
217 *
218 * @vif: the vif that should be switched from old_ctx to new_ctx
219 * @old_ctx: the old context to which the vif was assigned
220 * @new_ctx: the new context to which the vif must be assigned
221 */
222struct ieee80211_vif_chanctx_switch {
223 struct ieee80211_vif *vif;
224 struct ieee80211_chanctx_conf *old_ctx;
225 struct ieee80211_chanctx_conf *new_ctx;
226};
227
228/**
Johannes Berg471b3ef2007-12-28 14:32:58 +0100229 * enum ieee80211_bss_change - BSS change notification flags
230 *
231 * These flags are used with the bss_info_changed() callback
232 * to indicate which BSS parameter changed.
233 *
234 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
235 * also implies a change in the AID.
236 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
237 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300238 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler38668c02008-03-28 16:33:32 -0700239 * @BSS_CHANGED_HT: 802.11n parameters changed
Johannes Berg96dd22a2008-09-11 00:01:57 +0200240 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200241 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200242 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
243 * reason (IBSS and managed mode)
244 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
245 * new beacon (beaconing modes)
246 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
247 * enabled/disabled (beaconing modes)
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200248 * @BSS_CHANGED_CQM: Connection quality monitor config changed
Johannes Berg8fc214b2010-04-28 17:40:43 +0200249 * @BSS_CHANGED_IBSS: IBSS join status changed
Juuso Oikarinen68542962010-06-09 13:43:26 +0300250 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
Johannes Berg4ced3f72010-07-19 16:39:04 +0200251 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
252 * that it is only ever disabled for station mode.
Johannes Berg7da7cc12010-08-05 17:02:38 +0200253 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
Marek Puzyniak0ca54f62013-04-10 13:19:13 +0200254 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
Arik Nemtsov02945822011-11-10 11:28:57 +0200255 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
Eliad Pellerab095872012-07-27 12:33:22 +0300256 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
Johannes Berg1ea6f9c2012-10-24 10:59:25 +0200257 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
Johannes Berg488dd7b2012-10-29 20:08:01 +0100258 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
259 * changed (currently only in P2P client mode, GO mode will be later)
Alexander Bondar989c6502013-05-16 17:34:17 +0300260 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
261 * currently dtim_period only is under consideration.
Johannes Berg2c9b7352013-02-07 21:37:29 +0100262 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
263 * note that this is only called when it changes after the channel
264 * context had been assigned.
Johannes Berg471b3ef2007-12-28 14:32:58 +0100265 */
266enum ieee80211_bss_change {
267 BSS_CHANGED_ASSOC = 1<<0,
268 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
269 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300270 BSS_CHANGED_ERP_SLOT = 1<<3,
Alexander Simona7ce1c92011-09-18 00:16:45 +0200271 BSS_CHANGED_HT = 1<<4,
Johannes Berg96dd22a2008-09-11 00:01:57 +0200272 BSS_CHANGED_BASIC_RATES = 1<<5,
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200273 BSS_CHANGED_BEACON_INT = 1<<6,
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200274 BSS_CHANGED_BSSID = 1<<7,
275 BSS_CHANGED_BEACON = 1<<8,
276 BSS_CHANGED_BEACON_ENABLED = 1<<9,
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200277 BSS_CHANGED_CQM = 1<<10,
Johannes Berg8fc214b2010-04-28 17:40:43 +0200278 BSS_CHANGED_IBSS = 1<<11,
Juuso Oikarinen68542962010-06-09 13:43:26 +0300279 BSS_CHANGED_ARP_FILTER = 1<<12,
Johannes Berg4ced3f72010-07-19 16:39:04 +0200280 BSS_CHANGED_QOS = 1<<13,
Johannes Berg7da7cc12010-08-05 17:02:38 +0200281 BSS_CHANGED_IDLE = 1<<14,
Arik Nemtsov78274932011-09-04 11:11:32 +0300282 BSS_CHANGED_SSID = 1<<15,
Arik Nemtsov02945822011-11-10 11:28:57 +0200283 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
Eliad Pellerab095872012-07-27 12:33:22 +0300284 BSS_CHANGED_PS = 1<<17,
Johannes Berg1ea6f9c2012-10-24 10:59:25 +0200285 BSS_CHANGED_TXPOWER = 1<<18,
Johannes Berg488dd7b2012-10-29 20:08:01 +0100286 BSS_CHANGED_P2P_PS = 1<<19,
Alexander Bondar989c6502013-05-16 17:34:17 +0300287 BSS_CHANGED_BEACON_INFO = 1<<20,
Johannes Berg2c9b7352013-02-07 21:37:29 +0100288 BSS_CHANGED_BANDWIDTH = 1<<21,
Johannes Bergac8dd502010-05-05 09:44:02 +0200289
290 /* when adding here, make sure to change ieee80211_reconfig */
Johannes Berg471b3ef2007-12-28 14:32:58 +0100291};
292
Juuso Oikarinen68542962010-06-09 13:43:26 +0300293/*
294 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
295 * of addresses for an interface increase beyond this value, hardware ARP
296 * filtering will be disabled.
297 */
298#define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
299
Johannes Berg471b3ef2007-12-28 14:32:58 +0100300/**
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -0700301 * enum ieee80211_rssi_event - RSSI threshold event
302 * An indicator for when RSSI goes below/above a certain threshold.
303 * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
304 * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
305 */
306enum ieee80211_rssi_event {
307 RSSI_EVENT_HIGH,
308 RSSI_EVENT_LOW,
309};
310
311/**
Johannes Berg471b3ef2007-12-28 14:32:58 +0100312 * struct ieee80211_bss_conf - holds the BSS's changing parameters
313 *
314 * This structure keeps information about a BSS (and an association
315 * to that BSS) that can change during the lifetime of the BSS.
316 *
317 * @assoc: association status
Johannes Berg8fc214b2010-04-28 17:40:43 +0200318 * @ibss_joined: indicates whether this station is part of an IBSS
319 * or not
Sujith Manoharanc13a7652012-10-12 17:35:45 +0530320 * @ibss_creator: indicates if a new IBSS network is being created
Johannes Berg471b3ef2007-12-28 14:32:58 +0100321 * @aid: association ID number, valid only when @assoc is true
322 * @use_cts_prot: use CTS protection
Johannes Berg7a5158e2008-10-08 10:59:33 +0200323 * @use_short_preamble: use 802.11b short preamble;
324 * if the hardware cannot handle this it must set the
325 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
326 * @use_short_slot: use short slot time (only relevant for ERP);
327 * if the hardware cannot handle this it must set the
328 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
Johannes Berg56007a02010-01-26 14:19:52 +0100329 * @dtim_period: num of beacons before the next DTIM, for beaconing,
Emmanuel Grumbachc65dd142012-12-12 10:12:24 +0200330 * valid in station mode only if after the driver was notified
Alexander Bondar989c6502013-05-16 17:34:17 +0300331 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
Johannes Berg8c358bc2012-05-22 22:13:05 +0200332 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
Johannes Bergef429da2013-02-05 17:48:40 +0100333 * as it may have been received during scanning long ago). If the
334 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
335 * only come from a beacon, but might not become valid until after
336 * association when a beacon is received (which is notified with the
337 * %BSS_CHANGED_DTIM flag.)
Johannes Berg8c358bc2012-05-22 22:13:05 +0200338 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
339 * the driver/device can use this to calculate synchronisation
Johannes Bergef429da2013-02-05 17:48:40 +0100340 * (see @sync_tsf)
341 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
342 * is requested, see @sync_tsf/@sync_device_ts.
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700343 * @beacon_int: beacon interval
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800344 * @assoc_capability: capabilities taken from assoc resp
Johannes Berg96dd22a2008-09-11 00:01:57 +0200345 * @basic_rates: bitmap of basic rates, each bit stands for an
346 * index into the rate table configured by the driver in
347 * the current band.
Alexander Bondar817cee72013-05-19 14:23:57 +0300348 * @beacon_rate: associated AP's beacon TX rate
Felix Fietkaudd5b4cc2010-11-22 20:58:24 +0100349 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200350 * @bssid: The BSSID for this BSS
351 * @enable_beacon: whether beaconing should be enabled or not
Johannes Berg4bf88532012-11-09 11:39:59 +0100352 * @chandef: Channel definition for this BSS -- the hardware might be
353 * configured a higher bandwidth than this BSS uses, for example.
Johannes Berg074d46d2012-03-15 19:45:16 +0100354 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200355 * This field is only valid when the channel type is one of the HT types.
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200356 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
357 * implies disabled
358 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
Juuso Oikarinen68542962010-06-09 13:43:26 +0300359 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
360 * may filter ARP queries targeted for other addresses than listed here.
361 * The driver must allow ARP queries targeted for all address listed here
362 * to pass through. An empty list implies no ARP queries need to pass.
Johannes Berg0f19b412013-01-14 16:39:07 +0100363 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
364 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
365 * array size), it's up to the driver what to do in that case.
Johannes Berg4ced3f72010-07-19 16:39:04 +0200366 * @qos: This is a QoS-enabled BSS.
Johannes Berg7da7cc12010-08-05 17:02:38 +0200367 * @idle: This interface is idle. There's also a global idle flag in the
368 * hardware config which may be more appropriate depending on what
369 * your driver/device needs to do.
Eliad Pellerab095872012-07-27 12:33:22 +0300370 * @ps: power-save mode (STA only). This flag is NOT affected by
371 * offchannel/dynamic_ps operations.
Marek Puzyniak0ca54f62013-04-10 13:19:13 +0200372 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
Arik Nemtsov78274932011-09-04 11:11:32 +0300373 * @ssid_len: Length of SSID given in @ssid.
374 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
Johannes Berg1ea6f9c2012-10-24 10:59:25 +0200375 * @txpower: TX power in dBm
Janusz Dziedzic67baf662013-03-21 15:47:56 +0100376 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
Johannes Berg471b3ef2007-12-28 14:32:58 +0100377 */
378struct ieee80211_bss_conf {
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200379 const u8 *bssid;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100380 /* association related data */
Johannes Berg8fc214b2010-04-28 17:40:43 +0200381 bool assoc, ibss_joined;
Sujith Manoharanc13a7652012-10-12 17:35:45 +0530382 bool ibss_creator;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100383 u16 aid;
384 /* erp related data */
385 bool use_cts_prot;
386 bool use_short_preamble;
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300387 bool use_short_slot;
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200388 bool enable_beacon;
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800389 u8 dtim_period;
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700390 u16 beacon_int;
391 u16 assoc_capability;
Johannes Berg8c358bc2012-05-22 22:13:05 +0200392 u64 sync_tsf;
393 u32 sync_device_ts;
Johannes Bergef429da2013-02-05 17:48:40 +0100394 u8 sync_dtim_count;
Johannes Berg881d9482009-01-21 15:13:48 +0100395 u32 basic_rates;
Alexander Bondar817cee72013-05-19 14:23:57 +0300396 struct ieee80211_rate *beacon_rate;
Felix Fietkaudd5b4cc2010-11-22 20:58:24 +0100397 int mcast_rate[IEEE80211_NUM_BANDS];
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200398 u16 ht_operation_mode;
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200399 s32 cqm_rssi_thold;
400 u32 cqm_rssi_hyst;
Johannes Berg4bf88532012-11-09 11:39:59 +0100401 struct cfg80211_chan_def chandef;
Juuso Oikarinen68542962010-06-09 13:43:26 +0300402 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
Johannes Berg0f19b412013-01-14 16:39:07 +0100403 int arp_addr_cnt;
Johannes Berg4ced3f72010-07-19 16:39:04 +0200404 bool qos;
Johannes Berg7da7cc12010-08-05 17:02:38 +0200405 bool idle;
Eliad Pellerab095872012-07-27 12:33:22 +0300406 bool ps;
Arik Nemtsov78274932011-09-04 11:11:32 +0300407 u8 ssid[IEEE80211_MAX_SSID_LEN];
408 size_t ssid_len;
409 bool hidden_ssid;
Johannes Berg1ea6f9c2012-10-24 10:59:25 +0200410 int txpower;
Janusz Dziedzic67baf662013-03-21 15:47:56 +0100411 struct ieee80211_p2p_noa_attr p2p_noa_attr;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100412};
413
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800414/**
Johannes Bergaf61a162013-07-02 18:09:12 +0200415 * enum mac80211_tx_info_flags - flags to describe transmission information/status
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800416 *
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700417 * These flags are used with the @flags member of &ieee80211_tx_info.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800418 *
Johannes Berg7351c6b2009-11-19 01:08:30 +0100419 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
Johannes Berge6a98542008-10-21 12:40:02 +0200420 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
421 * number to this frame, taking care of not overwriting the fragment
422 * number and increasing the sequence number only when the
423 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
424 * assign sequence numbers to QoS-data frames but cannot do so correctly
425 * for non-QoS-data and management frames because beacons need them from
426 * that counter as well and mac80211 cannot guarantee proper sequencing.
427 * If this flag is set, the driver should instruct the hardware to
428 * assign a sequence number to the frame or assign one itself. Cf. IEEE
429 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
430 * beacons and always be clear for frames without a sequence number field.
Johannes Berge039fa42008-05-15 12:55:29 +0200431 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
Johannes Berge039fa42008-05-15 12:55:29 +0200432 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
433 * station
Johannes Berge039fa42008-05-15 12:55:29 +0200434 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
Johannes Berge039fa42008-05-15 12:55:29 +0200435 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
436 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
Johannes Berge6a98542008-10-21 12:40:02 +0200437 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
Johannes Berge039fa42008-05-15 12:55:29 +0200438 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
Johannes Bergab5b5342009-08-07 16:28:09 +0200439 * because the destination STA was in powersave mode. Note that to
440 * avoid race conditions, the filter must be set by the hardware or
441 * firmware upon receiving a frame that indicates that the station
442 * went to sleep (must be done on device to filter frames already on
443 * the queue) and may only be unset after mac80211 gives the OK for
444 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
445 * since only then is it guaranteed that no more frames are in the
446 * hardware queue.
Johannes Berge039fa42008-05-15 12:55:29 +0200447 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
448 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
449 * is for the whole aggregation.
Ron Rindjunsky429a3802008-07-01 14:16:03 +0300450 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
451 * so consider using block ack request (BAR).
Johannes Berge6a98542008-10-21 12:40:02 +0200452 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
453 * set by rate control algorithms to indicate probe rate, will
454 * be cleared for fragmented frames (except on the last fragment)
Seth Forshee6c17b772013-02-11 11:21:07 -0600455 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
456 * that a frame can be transmitted while the queues are stopped for
457 * off-channel operation.
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100458 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
459 * used to indicate that a pending frame requires TX processing before
460 * it can be sent out.
Johannes Berg8f77f382009-06-07 21:58:37 +0200461 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
462 * used to indicate that a frame was already retried due to PS
Johannes Berg3b8d81e02009-06-17 17:43:56 +0200463 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
464 * used to indicate frame should not be encrypted
Johannes Berg02f2f1a2012-02-27 12:18:30 +0100465 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
466 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
467 * be sent although the station is in powersave mode.
Johannes Bergad5351d2009-08-07 16:42:15 +0200468 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
469 * transmit function after the current frame, this can be used
470 * by drivers to kick the DMA queue only if unset or when the
471 * queue gets full.
Johannes Bergc6fcf6b2010-01-17 01:47:59 +0100472 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
473 * after TX status because the destination was asleep, it must not
474 * be modified again (no seqno assignment, crypto, etc.)
Johannes Berg1672c0e32013-01-29 15:02:27 +0100475 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
476 * code for connection establishment, this indicates that its status
477 * should kick the MLME state machine.
Jouni Malinen026331c2010-02-15 12:53:10 +0200478 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
479 * MLME command (internal to mac80211 to figure out whether to send TX
480 * status to user space)
Luis R. Rodriguez0a56bd02010-04-15 17:39:37 -0400481 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
Felix Fietkauf79d9ba2010-04-19 19:57:35 +0200482 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
483 * frame and selects the maximum number of streams that it can use.
Johannes Berg610dbc92011-01-06 22:36:44 +0100484 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
485 * the off-channel channel when a remain-on-channel offload is done
486 * in hardware -- normal packets still flow and are expected to be
487 * handled properly by the device.
Jouni Malinen681d1192011-02-03 18:35:19 +0200488 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
489 * testing. It will be sent out with incorrect Michael MIC key to allow
490 * TKIP countermeasures to be tested.
Rajkumar Manoharanaad14ce2011-09-25 14:53:31 +0530491 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
492 * This flag is actually used for management frame especially for P2P
493 * frames not being sent at CCK rate in 2GHz band.
Johannes Berg47086fc2011-09-29 16:04:33 +0200494 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
495 * when its status is reported the service period ends. For frames in
496 * an SP that mac80211 transmits, it is already set; for driver frames
Johannes Bergdeeaee12011-09-29 16:04:35 +0200497 * the driver may set this flag. It is also used to do the same for
498 * PS-Poll responses.
Rajkumar Manoharanb6f35302011-09-29 20:34:04 +0530499 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
500 * This flag is used to send nullfunc frame at minimum rate when
501 * the nullfunc is used for connection monitoring purpose.
Johannes Berga26eb272011-10-07 14:01:25 +0200502 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
503 * would be fragmented by size (this is optional, only used for
504 * monitor injection).
Felix Fietkaud6d23de22013-06-04 12:15:42 +0200505 * @IEEE80211_TX_CTL_PS_RESPONSE: This frame is a response to a poll
506 * frame (PS-Poll or uAPSD).
Christian Lampartereb7d3062010-09-21 21:36:18 +0200507 *
508 * Note: If you have to add new flags to the enumeration, then don't
509 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800510 */
Johannes Bergaf61a162013-07-02 18:09:12 +0200511enum mac80211_tx_info_flags {
Johannes Berge039fa42008-05-15 12:55:29 +0200512 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
Johannes Berge6a98542008-10-21 12:40:02 +0200513 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
514 IEEE80211_TX_CTL_NO_ACK = BIT(2),
515 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
516 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
517 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
518 IEEE80211_TX_CTL_AMPDU = BIT(6),
519 IEEE80211_TX_CTL_INJECTED = BIT(7),
520 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
521 IEEE80211_TX_STAT_ACK = BIT(9),
522 IEEE80211_TX_STAT_AMPDU = BIT(10),
523 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
524 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
Seth Forshee6c17b772013-02-11 11:21:07 -0600525 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100526 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
Johannes Berg8f77f382009-06-07 21:58:37 +0200527 IEEE80211_TX_INTFL_RETRIED = BIT(15),
Johannes Berg3b8d81e02009-06-17 17:43:56 +0200528 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
Johannes Berg02f2f1a2012-02-27 12:18:30 +0100529 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
Johannes Bergad5351d2009-08-07 16:42:15 +0200530 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
Johannes Bergc6fcf6b2010-01-17 01:47:59 +0100531 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
Johannes Berg1672c0e32013-01-29 15:02:27 +0100532 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
Jouni Malinen026331c2010-02-15 12:53:10 +0200533 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
Luis R. Rodriguez0a56bd02010-04-15 17:39:37 -0400534 IEEE80211_TX_CTL_LDPC = BIT(22),
Felix Fietkauf79d9ba2010-04-19 19:57:35 +0200535 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
Johannes Berg21f83582010-12-18 17:20:47 +0100536 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
Jouni Malinen681d1192011-02-03 18:35:19 +0200537 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
Rajkumar Manoharanaad14ce2011-09-25 14:53:31 +0530538 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
Johannes Berg47086fc2011-09-29 16:04:33 +0200539 IEEE80211_TX_STATUS_EOSP = BIT(28),
Rajkumar Manoharanb6f35302011-09-29 20:34:04 +0530540 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
Johannes Berga26eb272011-10-07 14:01:25 +0200541 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
Felix Fietkaud6d23de22013-06-04 12:15:42 +0200542 IEEE80211_TX_CTL_PS_RESPONSE = BIT(31),
Johannes Berge6a98542008-10-21 12:40:02 +0200543};
544
Johannes Bergabe37c42010-06-07 11:12:27 +0200545#define IEEE80211_TX_CTL_STBC_SHIFT 23
546
Johannes Bergaf61a162013-07-02 18:09:12 +0200547/**
548 * enum mac80211_tx_control_flags - flags to describe transmit control
549 *
550 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
551 * protocol frame (e.g. EAP)
552 *
553 * These flags are used in tx_info->control.flags.
554 */
555enum mac80211_tx_control_flags {
556 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
557};
558
Christian Lampartereb7d3062010-09-21 21:36:18 +0200559/*
560 * This definition is used as a mask to clear all temporary flags, which are
561 * set by the tx handlers for each transmission attempt by the mac80211 stack.
562 */
563#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
564 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
565 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
566 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
567 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
Johannes Berg02f2f1a2012-02-27 12:18:30 +0100568 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
Christian Lampartereb7d3062010-09-21 21:36:18 +0200569 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
Johannes Berg47086fc2011-09-29 16:04:33 +0200570 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
Christian Lampartereb7d3062010-09-21 21:36:18 +0200571
Sujith2134e7e2009-01-22 09:00:52 +0530572/**
573 * enum mac80211_rate_control_flags - per-rate flags set by the
574 * Rate Control algorithm.
575 *
576 * These flags are set by the Rate control algorithm for each rate during tx,
577 * in the @flags member of struct ieee80211_tx_rate.
578 *
579 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
580 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
581 * This is set if the current BSS requires ERP protection.
582 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
583 * @IEEE80211_TX_RC_MCS: HT rate.
Johannes Berg8bc83c22012-11-09 18:38:32 +0100584 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
585 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
Sujith2134e7e2009-01-22 09:00:52 +0530586 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
587 * Greenfield mode.
588 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
Johannes Berg8bc83c22012-11-09 18:38:32 +0100589 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
590 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
591 * (80+80 isn't supported yet)
Sujith2134e7e2009-01-22 09:00:52 +0530592 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
593 * adjacent 20 MHz channels, if the current channel type is
594 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
595 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
596 */
Johannes Berge6a98542008-10-21 12:40:02 +0200597enum mac80211_rate_control_flags {
598 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
599 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
600 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
601
Johannes Berg8bc83c22012-11-09 18:38:32 +0100602 /* rate index is an HT/VHT MCS instead of an index */
Johannes Berge6a98542008-10-21 12:40:02 +0200603 IEEE80211_TX_RC_MCS = BIT(3),
604 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
605 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
606 IEEE80211_TX_RC_DUP_DATA = BIT(6),
607 IEEE80211_TX_RC_SHORT_GI = BIT(7),
Johannes Berg8bc83c22012-11-09 18:38:32 +0100608 IEEE80211_TX_RC_VHT_MCS = BIT(8),
609 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
610 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800611};
612
Johannes Berge039fa42008-05-15 12:55:29 +0200613
Johannes Berge6a98542008-10-21 12:40:02 +0200614/* there are 40 bytes if you don't need the rateset to be kept */
615#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
Johannes Berge039fa42008-05-15 12:55:29 +0200616
Johannes Berge6a98542008-10-21 12:40:02 +0200617/* if you do need the rateset, then you have less space */
618#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
619
620/* maximum number of rate stages */
Thomas Huehne3e1a0b2012-07-02 19:46:16 +0200621#define IEEE80211_TX_MAX_RATES 4
Felix Fietkau870abdf2008-10-05 18:04:24 +0200622
Felix Fietkau0d528d82013-04-22 16:14:41 +0200623/* maximum number of rate table entries */
624#define IEEE80211_TX_RATE_TABLE_SIZE 4
625
Felix Fietkau870abdf2008-10-05 18:04:24 +0200626/**
Johannes Berge6a98542008-10-21 12:40:02 +0200627 * struct ieee80211_tx_rate - rate selection/status
Felix Fietkau870abdf2008-10-05 18:04:24 +0200628 *
Johannes Berge6a98542008-10-21 12:40:02 +0200629 * @idx: rate index to attempt to send with
630 * @flags: rate control flags (&enum mac80211_rate_control_flags)
Johannes Berge25cf4a2008-10-23 08:51:20 +0200631 * @count: number of tries in this rate before going to the next rate
Johannes Berge6a98542008-10-21 12:40:02 +0200632 *
633 * A value of -1 for @idx indicates an invalid rate and, if used
634 * in an array of retry rates, that no more rates should be tried.
635 *
636 * When used for transmit status reporting, the driver should
637 * always report the rate along with the flags it used.
Johannes Bergc555b9b2009-08-07 16:23:43 +0200638 *
639 * &struct ieee80211_tx_info contains an array of these structs
640 * in the control information, and it will be filled by the rate
641 * control algorithm according to what should be sent. For example,
642 * if this array contains, in the format { <idx>, <count> } the
643 * information
644 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
645 * then this means that the frame should be transmitted
646 * up to twice at rate 3, up to twice at rate 2, and up to four
647 * times at rate 1 if it doesn't get acknowledged. Say it gets
648 * acknowledged by the peer after the fifth attempt, the status
649 * information should then contain
650 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
651 * since it was transmitted twice at rate 3, twice at rate 2
652 * and once at rate 1 after which we received an acknowledgement.
Felix Fietkau870abdf2008-10-05 18:04:24 +0200653 */
Johannes Berge6a98542008-10-21 12:40:02 +0200654struct ieee80211_tx_rate {
655 s8 idx;
Johannes Berg8bc83c22012-11-09 18:38:32 +0100656 u16 count:5,
657 flags:11;
Gustavo F. Padovan3f30fc12010-07-21 10:59:58 +0000658} __packed;
Felix Fietkau870abdf2008-10-05 18:04:24 +0200659
Johannes Berg8bc83c22012-11-09 18:38:32 +0100660#define IEEE80211_MAX_TX_RETRY 31
661
662static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
663 u8 mcs, u8 nss)
664{
665 WARN_ON(mcs & ~0xF);
Karl Beldan6bc83122013-04-15 17:09:29 +0200666 WARN_ON((nss - 1) & ~0x7);
667 rate->idx = ((nss - 1) << 4) | mcs;
Johannes Berg8bc83c22012-11-09 18:38:32 +0100668}
669
670static inline u8
671ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
672{
673 return rate->idx & 0xF;
674}
675
676static inline u8
677ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
678{
Karl Beldan6bc83122013-04-15 17:09:29 +0200679 return (rate->idx >> 4) + 1;
Johannes Berg8bc83c22012-11-09 18:38:32 +0100680}
681
Johannes Berge039fa42008-05-15 12:55:29 +0200682/**
683 * struct ieee80211_tx_info - skb transmit information
Ivo van Doorn1c014422008-04-17 19:41:02 +0200684 *
Johannes Berge039fa42008-05-15 12:55:29 +0200685 * This structure is placed in skb->cb for three uses:
686 * (1) mac80211 TX control - mac80211 tells the driver what to do
687 * (2) driver internal use (if applicable)
688 * (3) TX status information - driver tells mac80211 what happened
689 *
690 * @flags: transmit info flags, defined above
Johannes Berge6a98542008-10-21 12:40:02 +0200691 * @band: the band to transmit on (use for checking for races)
Johannes Berg3a25a8c2012-04-03 16:28:50 +0200692 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
Johannes Berga729cff2011-11-06 14:13:34 +0100693 * @ack_frame_id: internal frame ID for TX status, used internally
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700694 * @control: union for control data
695 * @status: union for status data
696 * @driver_data: array of driver_data pointers
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100697 * @ampdu_ack_len: number of acked aggregated frames.
Daniel Halperin93d95b12010-04-18 09:28:18 -0700698 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100699 * @ampdu_len: number of aggregated frames.
Daniel Halperin93d95b12010-04-18 09:28:18 -0700700 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
Johannes Berge039fa42008-05-15 12:55:29 +0200701 * @ack_signal: signal strength of the ACK frame
Ivo van Doorn1c014422008-04-17 19:41:02 +0200702 */
Johannes Berge039fa42008-05-15 12:55:29 +0200703struct ieee80211_tx_info {
704 /* common information */
705 u32 flags;
706 u8 band;
Johannes Berge6a98542008-10-21 12:40:02 +0200707
Johannes Berg3a25a8c2012-04-03 16:28:50 +0200708 u8 hw_queue;
Johannes Berg8318d782008-01-24 19:38:38 +0100709
Johannes Berga729cff2011-11-06 14:13:34 +0100710 u16 ack_frame_id;
Johannes Berg8318d782008-01-24 19:38:38 +0100711
Johannes Berge039fa42008-05-15 12:55:29 +0200712 union {
713 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200714 union {
715 /* rate control */
716 struct {
717 struct ieee80211_tx_rate rates[
718 IEEE80211_TX_MAX_RATES];
719 s8 rts_cts_rate_idx;
Felix Fietkau991fec02013-04-16 13:38:43 +0200720 u8 use_rts:1;
721 u8 use_cts_prot:1;
Felix Fietkau0d528d82013-04-22 16:14:41 +0200722 u8 short_preamble:1;
723 u8 skip_table:1;
Felix Fietkau991fec02013-04-16 13:38:43 +0200724 /* 2 bytes free */
Johannes Berge6a98542008-10-21 12:40:02 +0200725 };
726 /* only needed before rate control */
727 unsigned long jiffies;
728 };
Johannes Berg25d834e2008-09-12 22:52:47 +0200729 /* NB: vif can be NULL for injected frames */
Johannes Berge039fa42008-05-15 12:55:29 +0200730 struct ieee80211_vif *vif;
731 struct ieee80211_key_conf *hw_key;
Johannes Bergaf61a162013-07-02 18:09:12 +0200732 u32 flags;
733 /* 4 bytes free */
Johannes Berge039fa42008-05-15 12:55:29 +0200734 } control;
735 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200736 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
Eliad Pellera0f995a2014-03-13 14:30:47 +0200737 s32 ack_signal;
Thomas Huehne3e1a0b2012-07-02 19:46:16 +0200738 u8 ampdu_ack_len;
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100739 u8 ampdu_len;
Johannes Bergd748b462012-03-28 11:04:23 +0200740 u8 antenna;
Eliad Pellera0f995a2014-03-13 14:30:47 +0200741 void *status_driver_data[21 / sizeof(void *)];
Johannes Berge039fa42008-05-15 12:55:29 +0200742 } status;
Johannes Berge6a98542008-10-21 12:40:02 +0200743 struct {
744 struct ieee80211_tx_rate driver_rates[
745 IEEE80211_TX_MAX_RATES];
Felix Fietkau0d528d82013-04-22 16:14:41 +0200746 u8 pad[4];
747
Johannes Berge6a98542008-10-21 12:40:02 +0200748 void *rate_driver_data[
749 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
750 };
751 void *driver_data[
752 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
Johannes Berge039fa42008-05-15 12:55:29 +0200753 };
Jiri Bencf0706e82007-05-05 11:45:53 -0700754};
755
Luciano Coelho79f460c2011-05-11 17:09:36 +0300756/**
David Spinadelc56ef672014-02-05 15:21:13 +0200757 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
758 *
David Spinadel633e2712014-02-06 16:15:23 +0200759 * This structure is used to point to different blocks of IEs in HW scan
760 * and scheduled scan. These blocks contain the IEs passed by userspace
761 * and the ones generated by mac80211.
David Spinadelc56ef672014-02-05 15:21:13 +0200762 *
763 * @ies: pointers to band specific IEs.
764 * @len: lengths of band_specific IEs.
765 * @common_ies: IEs for all bands (especially vendor specific ones)
766 * @common_ie_len: length of the common_ies
767 */
768struct ieee80211_scan_ies {
769 const u8 *ies[IEEE80211_NUM_BANDS];
770 size_t len[IEEE80211_NUM_BANDS];
771 const u8 *common_ies;
772 size_t common_ie_len;
773};
774
775
Johannes Berge039fa42008-05-15 12:55:29 +0200776static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
777{
778 return (struct ieee80211_tx_info *)skb->cb;
779}
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400780
Johannes Bergf1d58c22009-06-17 13:13:00 +0200781static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
782{
783 return (struct ieee80211_rx_status *)skb->cb;
784}
785
Johannes Berge6a98542008-10-21 12:40:02 +0200786/**
787 * ieee80211_tx_info_clear_status - clear TX status
788 *
789 * @info: The &struct ieee80211_tx_info to be cleared.
790 *
791 * When the driver passes an skb back to mac80211, it must report
792 * a number of things in TX status. This function clears everything
793 * in the TX status but the rate control information (it does clear
794 * the count since you need to fill that in anyway).
795 *
796 * NOTE: You can only use this function if you do NOT use
797 * info->driver_data! Use info->rate_driver_data
798 * instead if you need only the less space that allows.
799 */
800static inline void
801ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
802{
803 int i;
804
805 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
806 offsetof(struct ieee80211_tx_info, control.rates));
807 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
808 offsetof(struct ieee80211_tx_info, driver_rates));
809 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
810 /* clear the rate counts */
811 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
812 info->status.rates[i].count = 0;
813
814 BUILD_BUG_ON(
Thomas Huehne3e1a0b2012-07-02 19:46:16 +0200815 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
Johannes Berge6a98542008-10-21 12:40:02 +0200816 memset(&info->status.ampdu_ack_len, 0,
817 sizeof(struct ieee80211_tx_info) -
818 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
819}
820
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400821
822/**
823 * enum mac80211_rx_flags - receive flags
824 *
825 * These flags are used with the @flag member of &struct ieee80211_rx_status.
826 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
827 * Use together with %RX_FLAG_MMIC_STRIPPED.
828 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400829 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
830 * verification has been done by the hardware.
831 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
832 * If this flag is set, the stack cannot do any replay detection
833 * hence the driver or hardware will have to do that.
Johannes Berg72abd812007-09-17 01:29:22 -0400834 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
835 * the frame.
836 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
837 * the frame.
Thomas Pedersenf4bda332012-11-13 10:46:27 -0800838 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
Johannes Berg6ebacbb2011-02-23 15:06:08 +0100839 * field) is valid and contains the time the first symbol of the MPDU
840 * was received. This is useful in monitor mode and for proper IBSS
841 * merging.
Thomas Pedersenf4bda332012-11-13 10:46:27 -0800842 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
843 * field) is valid and contains the time the last symbol of the MPDU
844 * (including FCS) was received.
Bruno Randolfb4f28bb2008-07-30 17:19:55 +0200845 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200846 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
Johannes Berg56146182012-11-09 15:07:02 +0100847 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200848 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
849 * @RX_FLAG_SHORT_GI: Short guard interval was used
Felix Fietkaufe8431f2012-03-01 18:00:07 +0100850 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
851 * Valid only for data frames (mainly A-MPDU)
Johannes Bergac55d2f2012-05-10 09:09:10 +0200852 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
853 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
854 * to hw.radiotap_mcs_details to advertise that fact
Johannes Berg4c298672012-07-05 11:34:31 +0200855 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
856 * number (@ampdu_reference) must be populated and be a distinct number for
857 * each A-MPDU
858 * @RX_FLAG_AMPDU_REPORT_ZEROLEN: driver reports 0-length subframes
859 * @RX_FLAG_AMPDU_IS_ZEROLEN: This is a zero-length subframe, for
860 * monitoring purposes only
861 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
862 * subframes of a single A-MPDU
863 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
864 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
865 * on this subframe
866 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
867 * is stored in the @ampdu_delimiter_crc field)
Emmanuel Grumbach63c361f2014-02-05 12:48:53 +0200868 * @RX_FLAG_LDPC: LDPC was used
Oleksij Rempel786677d2013-05-24 12:05:45 +0200869 * @RX_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
Simon Wunderlicha5e70692013-07-08 16:55:52 +0200870 * @RX_FLAG_10MHZ: 10 MHz (half channel) was used
871 * @RX_FLAG_5MHZ: 5 MHz (quarter channel) was used
Michal Kazior0cfcefe2013-09-23 15:34:38 +0200872 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
873 * subframes instead of a one huge frame for performance reasons.
874 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
875 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
876 * the 3rd (last) one must not have this flag set. The flag is used to
877 * deal with retransmission/duplication recovery properly since A-MSDU
878 * subframes share the same sequence number. Reported subframes can be
879 * either regular MSDU or singly A-MSDUs. Subframes must not be
880 * interleaved with other frames.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400881 */
882enum mac80211_rx_flags {
Johannes Berg4c298672012-07-05 11:34:31 +0200883 RX_FLAG_MMIC_ERROR = BIT(0),
884 RX_FLAG_DECRYPTED = BIT(1),
885 RX_FLAG_MMIC_STRIPPED = BIT(3),
886 RX_FLAG_IV_STRIPPED = BIT(4),
887 RX_FLAG_FAILED_FCS_CRC = BIT(5),
888 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
Thomas Pedersenf4bda332012-11-13 10:46:27 -0800889 RX_FLAG_MACTIME_START = BIT(7),
Johannes Berg4c298672012-07-05 11:34:31 +0200890 RX_FLAG_SHORTPRE = BIT(8),
891 RX_FLAG_HT = BIT(9),
892 RX_FLAG_40MHZ = BIT(10),
893 RX_FLAG_SHORT_GI = BIT(11),
894 RX_FLAG_NO_SIGNAL_VAL = BIT(12),
895 RX_FLAG_HT_GF = BIT(13),
896 RX_FLAG_AMPDU_DETAILS = BIT(14),
897 RX_FLAG_AMPDU_REPORT_ZEROLEN = BIT(15),
898 RX_FLAG_AMPDU_IS_ZEROLEN = BIT(16),
899 RX_FLAG_AMPDU_LAST_KNOWN = BIT(17),
900 RX_FLAG_AMPDU_IS_LAST = BIT(18),
901 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(19),
902 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(20),
Thomas Pedersenf4bda332012-11-13 10:46:27 -0800903 RX_FLAG_MACTIME_END = BIT(21),
Johannes Berg56146182012-11-09 15:07:02 +0100904 RX_FLAG_VHT = BIT(22),
Emmanuel Grumbach63c361f2014-02-05 12:48:53 +0200905 RX_FLAG_LDPC = BIT(23),
Oleksij Rempel786677d2013-05-24 12:05:45 +0200906 RX_FLAG_STBC_MASK = BIT(26) | BIT(27),
Simon Wunderlicha5e70692013-07-08 16:55:52 +0200907 RX_FLAG_10MHZ = BIT(28),
908 RX_FLAG_5MHZ = BIT(29),
Michal Kazior0cfcefe2013-09-23 15:34:38 +0200909 RX_FLAG_AMSDU_MORE = BIT(30),
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400910};
911
Oleksij Rempel786677d2013-05-24 12:05:45 +0200912#define RX_FLAG_STBC_SHIFT 26
913
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400914/**
Emmanuel Grumbach1b8d2422014-02-05 16:37:11 +0200915 * enum mac80211_rx_vht_flags - receive VHT flags
916 *
917 * These flags are used with the @vht_flag member of
918 * &struct ieee80211_rx_status.
919 * @RX_VHT_FLAG_80MHZ: 80 MHz was used
920 * @RX_VHT_FLAG_80P80MHZ: 80+80 MHz was used
921 * @RX_VHT_FLAG_160MHZ: 160 MHz was used
Emmanuel Grumbachfb378c22014-03-04 10:35:25 +0200922 * @RX_VHT_FLAG_BF: packet was beamformed
Emmanuel Grumbach1b8d2422014-02-05 16:37:11 +0200923 */
924enum mac80211_rx_vht_flags {
925 RX_VHT_FLAG_80MHZ = BIT(0),
926 RX_VHT_FLAG_80P80MHZ = BIT(1),
927 RX_VHT_FLAG_160MHZ = BIT(2),
Emmanuel Grumbachfb378c22014-03-04 10:35:25 +0200928 RX_VHT_FLAG_BF = BIT(3),
Emmanuel Grumbach1b8d2422014-02-05 16:37:11 +0200929};
930
931/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400932 * struct ieee80211_rx_status - receive status
933 *
934 * The low-level driver should provide this information (the subset
935 * supported by hardware) to the 802.11 code with each received
Johannes Bergf1d58c22009-06-17 13:13:00 +0200936 * frame, in the skb's control buffer (cb).
Bruno Randolf566bfe52008-05-08 19:15:40 +0200937 *
Bruno Randolfc132bec2008-02-18 11:20:51 +0900938 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
939 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
Johannes Berg8c358bc2012-05-22 22:13:05 +0200940 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
941 * it but can store it and pass it back to the driver for synchronisation
Johannes Berg8318d782008-01-24 19:38:38 +0100942 * @band: the active band when this frame was received
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400943 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
Bruno Randolf566bfe52008-05-08 19:15:40 +0200944 * @signal: signal strength when receiving this frame, either in dBm, in dB or
945 * unspecified depending on the hardware capabilities flags
946 * @IEEE80211_HW_SIGNAL_*
Felix Fietkauef0621e2013-04-22 16:29:31 +0200947 * @chains: bitmask of receive chains for which separate signal strength
948 * values were filled.
949 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
950 * support dB or unspecified units)
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400951 * @antenna: antenna used
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200952 * @rate_idx: index of data rate into band's supported rates or MCS index if
Johannes Berg56146182012-11-09 15:07:02 +0100953 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
954 * @vht_nss: number of streams (VHT only)
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400955 * @flag: %RX_FLAG_*
Emmanuel Grumbach1b8d2422014-02-05 16:37:11 +0200956 * @vht_flag: %RX_VHT_FLAG_*
Johannes Berg554891e2010-09-24 12:38:25 +0200957 * @rx_flags: internal RX flags for mac80211
Johannes Berg4c298672012-07-05 11:34:31 +0200958 * @ampdu_reference: A-MPDU reference number, must be a different value for
959 * each A-MPDU but the same for each subframe within one A-MPDU
960 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400961 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700962struct ieee80211_rx_status {
963 u64 mactime;
Johannes Berg8c358bc2012-05-22 22:13:05 +0200964 u32 device_timestamp;
Johannes Berg4c298672012-07-05 11:34:31 +0200965 u32 ampdu_reference;
966 u32 flag;
Johannes Berg30f42292012-07-05 13:14:18 +0200967 u16 freq;
Emmanuel Grumbach1b8d2422014-02-05 16:37:11 +0200968 u8 vht_flag;
Johannes Berg30f42292012-07-05 13:14:18 +0200969 u8 rate_idx;
Johannes Berg56146182012-11-09 15:07:02 +0100970 u8 vht_nss;
Johannes Berg30f42292012-07-05 13:14:18 +0200971 u8 rx_flags;
972 u8 band;
973 u8 antenna;
974 s8 signal;
Felix Fietkauef0621e2013-04-22 16:29:31 +0200975 u8 chains;
976 s8 chain_signal[IEEE80211_MAX_CHAINS];
Johannes Berg4c298672012-07-05 11:34:31 +0200977 u8 ampdu_delimiter_crc;
Jiri Bencf0706e82007-05-05 11:45:53 -0700978};
979
Johannes Berg6b301cd2007-09-18 17:29:20 -0400980/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400981 * enum ieee80211_conf_flags - configuration flags
982 *
983 * Flags to define PHY configuration options
984 *
Johannes Berg0869aea2009-10-28 10:03:35 +0100985 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
986 * to determine for example whether to calculate timestamps for packets
987 * or not, do not use instead of filter flags!
Kalle Valoc99445b2010-01-14 13:09:21 +0200988 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
989 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
990 * meaning that the hardware still wakes up for beacons, is able to
991 * transmit frames and receive the possible acknowledgment frames.
992 * Not to be confused with hardware specific wakeup/sleep states,
993 * driver is responsible for that. See the section "Powersave support"
994 * for more.
Johannes Berg5cff20e2009-04-29 12:26:17 +0200995 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
996 * the driver should be prepared to handle configuration requests but
997 * may turn the device off as much as possible. Typically, this flag will
998 * be set when an interface is set UP but not associated or scanning, but
999 * it can also be unset in that case when monitor interfaces are active.
Felix Fietkau45521242010-07-28 02:40:49 +02001000 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1001 * operating channel.
Johannes Berg6b301cd2007-09-18 17:29:20 -04001002 */
1003enum ieee80211_conf_flags {
Johannes Berg0869aea2009-10-28 10:03:35 +01001004 IEEE80211_CONF_MONITOR = (1<<0),
Johannes Bergae5eb022008-10-14 16:58:37 +02001005 IEEE80211_CONF_PS = (1<<1),
Johannes Berg5cff20e2009-04-29 12:26:17 +02001006 IEEE80211_CONF_IDLE = (1<<2),
Felix Fietkau45521242010-07-28 02:40:49 +02001007 IEEE80211_CONF_OFFCHANNEL = (1<<3),
Johannes Berg6b301cd2007-09-18 17:29:20 -04001008};
Jiri Bencf0706e82007-05-05 11:45:53 -07001009
Johannes Berg7a5158e2008-10-08 10:59:33 +02001010
Jiri Bencf0706e82007-05-05 11:45:53 -07001011/**
Johannes Berge8975582008-10-09 12:18:51 +02001012 * enum ieee80211_conf_changed - denotes which configuration changed
1013 *
Johannes Berge8975582008-10-09 12:18:51 +02001014 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
Johannes Berg0869aea2009-10-28 10:03:35 +01001015 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
Johannes Berge255d5e2009-04-22 12:40:07 +02001016 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
Johannes Berge8975582008-10-09 12:18:51 +02001017 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
Johannes Berg47979382009-01-07 10:13:27 +01001018 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
Johannes Berg9124b072008-10-14 19:17:54 +02001019 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
Johannes Berg5cff20e2009-04-29 12:26:17 +02001020 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
Johannes Berg0f782312009-12-01 13:37:02 +01001021 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
Johannes Berg04ecd252012-09-11 14:34:12 +02001022 * Note that this is only valid if channel contexts are not used,
1023 * otherwise each channel context has the number of chains listed.
Johannes Berge8975582008-10-09 12:18:51 +02001024 */
1025enum ieee80211_conf_changed {
Johannes Berg0f782312009-12-01 13:37:02 +01001026 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
Johannes Berge8975582008-10-09 12:18:51 +02001027 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
Johannes Berg0869aea2009-10-28 10:03:35 +01001028 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
Johannes Berge8975582008-10-09 12:18:51 +02001029 IEEE80211_CONF_CHANGE_PS = BIT(4),
Johannes Berge255d5e2009-04-22 12:40:07 +02001030 IEEE80211_CONF_CHANGE_POWER = BIT(5),
1031 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
1032 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
Johannes Berg5cff20e2009-04-29 12:26:17 +02001033 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
Johannes Berge8975582008-10-09 12:18:51 +02001034};
1035
1036/**
Johannes Berg0f782312009-12-01 13:37:02 +01001037 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1038 *
Kalle Valo9d173fc2010-01-14 13:09:14 +02001039 * @IEEE80211_SMPS_AUTOMATIC: automatic
1040 * @IEEE80211_SMPS_OFF: off
1041 * @IEEE80211_SMPS_STATIC: static
1042 * @IEEE80211_SMPS_DYNAMIC: dynamic
1043 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
Johannes Berg0f782312009-12-01 13:37:02 +01001044 */
1045enum ieee80211_smps_mode {
1046 IEEE80211_SMPS_AUTOMATIC,
1047 IEEE80211_SMPS_OFF,
1048 IEEE80211_SMPS_STATIC,
1049 IEEE80211_SMPS_DYNAMIC,
1050
1051 /* keep last */
1052 IEEE80211_SMPS_NUM_MODES,
1053};
1054
1055/**
Jiri Bencf0706e82007-05-05 11:45:53 -07001056 * struct ieee80211_conf - configuration of the device
1057 *
1058 * This struct indicates how the driver shall configure the hardware.
1059 *
Johannes Berg04fe2032009-04-22 18:44:37 +02001060 * @flags: configuration flags defined above
1061 *
Tomas Winklerea95bba2008-07-18 13:53:00 +08001062 * @listen_interval: listen interval in units of beacon interval
Johannes Berg9ccebe62009-04-23 10:32:36 +02001063 * @max_sleep_period: the maximum number of beacon intervals to sleep for
Johannes Berg04fe2032009-04-22 18:44:37 +02001064 * before checking the beacon for a TIM bit (managed mode only); this
1065 * value will be only achievable between DTIM frames, the hardware
1066 * needs to check for the multicast traffic bit in DTIM beacons.
1067 * This variable is valid only when the CONF_PS flag is set.
Johannes Berg56007a02010-01-26 14:19:52 +01001068 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1069 * in power saving. Power saving will not be enabled until a beacon
1070 * has been received and the DTIM period is known.
Johannes Berg04fe2032009-04-22 18:44:37 +02001071 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1072 * powersave documentation below. This variable is valid only when
1073 * the CONF_PS flag is set.
1074 *
Johannes Berg1ea6f9c2012-10-24 10:59:25 +02001075 * @power_level: requested transmit power (in dBm), backward compatibility
1076 * value only that is set to the minimum of all interfaces
Johannes Berg04fe2032009-04-22 18:44:37 +02001077 *
Karl Beldan675a0b02013-03-25 16:26:57 +01001078 * @chandef: the channel definition to tune to
Simon Wunderlich164eb022013-02-08 18:16:20 +01001079 * @radar_enabled: whether radar detection is enabled
Johannes Berg04fe2032009-04-22 18:44:37 +02001080 *
Johannes Berg9124b072008-10-14 19:17:54 +02001081 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
Johannes Bergad24b0d2013-07-05 11:53:28 +02001082 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1083 * but actually means the number of transmissions not the number of retries
Johannes Berg9124b072008-10-14 19:17:54 +02001084 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
Johannes Bergad24b0d2013-07-05 11:53:28 +02001085 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1086 * number of transmissions not the number of retries
Johannes Berg0f782312009-12-01 13:37:02 +01001087 *
1088 * @smps_mode: spatial multiplexing powersave mode; note that
1089 * %IEEE80211_SMPS_STATIC is used when the device is not
Johannes Berg04ecd252012-09-11 14:34:12 +02001090 * configured for an HT channel.
1091 * Note that this is only valid if channel contexts are not used,
1092 * otherwise each channel context has the number of chains listed.
Jiri Bencf0706e82007-05-05 11:45:53 -07001093 */
1094struct ieee80211_conf {
Johannes Berg6b301cd2007-09-18 17:29:20 -04001095 u32 flags;
Juuso Oikarinenff616382010-06-09 09:51:52 +03001096 int power_level, dynamic_ps_timeout;
Johannes Berg9ccebe62009-04-23 10:32:36 +02001097 int max_sleep_period;
Ron Rindjunsky10816d42007-11-26 16:14:30 +02001098
Johannes Berge8975582008-10-09 12:18:51 +02001099 u16 listen_interval;
Johannes Berg56007a02010-01-26 14:19:52 +01001100 u8 ps_dtim_period;
Johannes Berge8975582008-10-09 12:18:51 +02001101
Johannes Berg9124b072008-10-14 19:17:54 +02001102 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1103
Karl Beldan675a0b02013-03-25 16:26:57 +01001104 struct cfg80211_chan_def chandef;
Simon Wunderlich164eb022013-02-08 18:16:20 +01001105 bool radar_enabled;
Johannes Berg0f782312009-12-01 13:37:02 +01001106 enum ieee80211_smps_mode smps_mode;
Jiri Bencf0706e82007-05-05 11:45:53 -07001107};
1108
1109/**
Johannes Berg5ce6e432010-05-11 16:20:57 +02001110 * struct ieee80211_channel_switch - holds the channel switch data
1111 *
1112 * The information provided in this structure is required for channel switch
1113 * operation.
1114 *
1115 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1116 * Function (TSF) timer when the frame containing the channel switch
1117 * announcement was received. This is simply the rx.mactime parameter
1118 * the driver passed into mac80211.
1119 * @block_tx: Indicates whether transmission must be blocked before the
1120 * scheduled channel switch, as indicated by the AP.
Johannes Berg85220d72013-03-25 18:29:27 +01001121 * @chandef: the new channel to switch to
Johannes Berg5ce6e432010-05-11 16:20:57 +02001122 * @count: the number of TBTT's until the channel switch event
1123 */
1124struct ieee80211_channel_switch {
1125 u64 timestamp;
1126 bool block_tx;
Johannes Berg85220d72013-03-25 18:29:27 +01001127 struct cfg80211_chan_def chandef;
Johannes Berg5ce6e432010-05-11 16:20:57 +02001128 u8 count;
1129};
1130
1131/**
Johannes Bergc1288b12012-01-19 09:29:57 +01001132 * enum ieee80211_vif_flags - virtual interface flags
1133 *
1134 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1135 * on this virtual interface to avoid unnecessary CPU wakeups
Johannes Bergea086352012-01-19 09:29:58 +01001136 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1137 * monitoring on this virtual interface -- i.e. it can monitor
1138 * connection quality related parameters, such as the RSSI level and
1139 * provide notifications if configured trigger levels are reached.
Johannes Bergc1288b12012-01-19 09:29:57 +01001140 */
1141enum ieee80211_vif_flags {
1142 IEEE80211_VIF_BEACON_FILTER = BIT(0),
Johannes Bergea086352012-01-19 09:29:58 +01001143 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
Johannes Bergc1288b12012-01-19 09:29:57 +01001144};
1145
1146/**
Johannes Berg32bfd352007-12-19 01:31:26 +01001147 * struct ieee80211_vif - per-interface data
1148 *
1149 * Data in this structure is continually present for driver
1150 * use during the life of a virtual interface.
1151 *
Johannes Berg51fb61e2007-12-19 01:31:27 +01001152 * @type: type of this virtual interface
Johannes Bergbda39332008-10-11 01:51:51 +02001153 * @bss_conf: BSS configuration for this interface, either our own
1154 * or the BSS we're associated to
Johannes Berg47846c92009-11-25 17:46:19 +01001155 * @addr: address of this interface
Johannes Berg2ca27bc2010-09-16 14:58:23 +02001156 * @p2p: indicates whether this AP or STA interface is a p2p
1157 * interface, i.e. a GO or p2p-sta respectively
Michal Kazior59af6922014-04-09 15:10:59 +02001158 * @csa_active: marks whether a channel switch is going on. Internally it is
1159 * write-protected by sdata_lock and local->mtx so holding either is fine
1160 * for read access.
Johannes Bergc1288b12012-01-19 09:29:57 +01001161 * @driver_flags: flags/capabilities the driver has for this interface,
1162 * these need to be set (or cleared) when the interface is added
1163 * or, if supported by the driver, the interface type is changed
1164 * at runtime, mac80211 will never touch this field
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001165 * @hw_queue: hardware queue for each AC
1166 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
Michal Kaziord01a1e62012-06-26 14:37:16 +02001167 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1168 * when it is not assigned. This pointer is RCU-protected due to the TX
1169 * path needing to access it; even though the netdev carrier will always
1170 * be off when it is %NULL there can still be races and packets could be
1171 * processed after it switches back to %NULL.
Stanislaw Gruszkaddbfe862013-03-08 14:46:14 +01001172 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
Johannes Bergad24b0d2013-07-05 11:53:28 +02001173 * interface debug files. Note that it will be NULL for the virtual
Stanislaw Gruszkaddbfe862013-03-08 14:46:14 +01001174 * monitor interface (if that is requested.)
Johannes Berg32bfd352007-12-19 01:31:26 +01001175 * @drv_priv: data area for driver use, will always be aligned to
1176 * sizeof(void *).
1177 */
1178struct ieee80211_vif {
Johannes Berg05c914f2008-09-11 00:01:58 +02001179 enum nl80211_iftype type;
Johannes Bergbda39332008-10-11 01:51:51 +02001180 struct ieee80211_bss_conf bss_conf;
Johannes Berg47846c92009-11-25 17:46:19 +01001181 u8 addr[ETH_ALEN];
Johannes Berg2ca27bc2010-09-16 14:58:23 +02001182 bool p2p;
Simon Wunderlich73da7d52013-07-11 16:09:06 +02001183 bool csa_active;
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001184
1185 u8 cab_queue;
1186 u8 hw_queue[IEEE80211_NUM_ACS];
1187
Michal Kaziord01a1e62012-06-26 14:37:16 +02001188 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1189
Johannes Bergc1288b12012-01-19 09:29:57 +01001190 u32 driver_flags;
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001191
Stanislaw Gruszkaddbfe862013-03-08 14:46:14 +01001192#ifdef CONFIG_MAC80211_DEBUGFS
1193 struct dentry *debugfs_dir;
1194#endif
1195
Johannes Berg32bfd352007-12-19 01:31:26 +01001196 /* must be last */
Johannes Berg1c06ef92012-12-28 12:22:02 +01001197 u8 drv_priv[0] __aligned(sizeof(void *));
Johannes Berg32bfd352007-12-19 01:31:26 +01001198};
1199
Johannes Berg902acc72008-02-23 15:17:19 +01001200static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1201{
1202#ifdef CONFIG_MAC80211_MESH
Johannes Berg05c914f2008-09-11 00:01:58 +02001203 return vif->type == NL80211_IFTYPE_MESH_POINT;
Johannes Berg902acc72008-02-23 15:17:19 +01001204#endif
1205 return false;
1206}
1207
Johannes Berg32bfd352007-12-19 01:31:26 +01001208/**
Johannes Bergad7e7182013-11-13 13:37:47 +01001209 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1210 * @wdev: the wdev to get the vif for
1211 *
1212 * This can be used by mac80211 drivers with direct cfg80211 APIs
1213 * (like the vendor commands) that get a wdev.
1214 *
1215 * Note that this function may return %NULL if the given wdev isn't
1216 * associated with a vif that the driver knows about (e.g. monitor
1217 * or AP_VLAN interfaces.)
1218 */
1219struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1220
1221/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001222 * enum ieee80211_key_flags - key flags
1223 *
1224 * These flags are used for communication about keys between the driver
1225 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1226 *
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001227 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1228 * driver to indicate that it requires IV generation for this
1229 * particular key.
1230 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1231 * the driver for a TKIP key if it requires Michael MIC
1232 * generation in software.
Ivo van Doornc6adbd22008-04-17 21:11:18 +02001233 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1234 * that the key is pairwise rather then a shared key.
Johannes Berge548c492012-09-04 17:08:23 +02001235 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
Jouni Malinen1f7d77a2009-01-08 13:32:10 +02001236 * CCMP key if it requires CCMP encryption of management frames (MFP) to
1237 * be done in software.
Arik Nemtsov077a9152011-10-23 08:21:41 +02001238 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
Janusz.Dziedzic@tieto.comee701082012-05-09 08:11:20 +03001239 * if space should be prepared for the IV, but the IV
Arik Nemtsov077a9152011-10-23 08:21:41 +02001240 * itself should not be generated. Do not set together with
1241 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key.
Johannes Berge548c492012-09-04 17:08:23 +02001242 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1243 * management frames. The flag can help drivers that have a hardware
1244 * crypto implementation that doesn't deal with management frames
1245 * properly by allowing them to not upload the keys to hardware and
1246 * fall back to software crypto. Note that this flag deals only with
1247 * RX, if your crypto engine can't deal with TX you can also set the
1248 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
Marek Kwaczynski17d38fa2014-04-14 11:27:21 +02001249 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1250 * driver for a CCMP key to indicate that is requires IV generation
1251 * only for managment frames (MFP).
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001252 */
1253enum ieee80211_key_flags {
Marek Kwaczynski17d38fa2014-04-14 11:27:21 +02001254 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0),
1255 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1),
1256 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2),
1257 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3),
1258 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4),
1259 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5),
1260 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6),
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001261};
1262
1263/**
1264 * struct ieee80211_key_conf - key information
1265 *
1266 * This key information is given by mac80211 to the driver by
1267 * the set_key() callback in &struct ieee80211_ops.
1268 *
1269 * @hw_key_idx: To be set by the driver, this is the key index the driver
1270 * wants to be given when a frame is transmitted and needs to be
Johannes Berg6a7664d2007-09-14 11:10:25 -04001271 * encrypted in hardware.
Johannes Berg97359d12010-08-10 09:46:38 +02001272 * @cipher: The key's cipher suite selector.
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001273 * @flags: key flags, see &enum ieee80211_key_flags.
1274 * @keyidx: the key index (0-3)
1275 * @keylen: key material length
Luis R. Rodriguezffd78912008-06-21 10:02:46 -04001276 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1277 * data block:
1278 * - Temporal Encryption Key (128 bits)
1279 * - Temporal Authenticator Tx MIC Key (64 bits)
1280 * - Temporal Authenticator Rx MIC Key (64 bits)
Johannes Bergdc822b52008-12-29 12:55:09 +01001281 * @icv_len: The ICV length for this key type
1282 * @iv_len: The IV length for this key type
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001283 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001284struct ieee80211_key_conf {
Johannes Berg97359d12010-08-10 09:46:38 +02001285 u32 cipher;
Felix Fietkau76708de2008-10-05 18:02:48 +02001286 u8 icv_len;
1287 u8 iv_len;
Johannes Berg6a7664d2007-09-14 11:10:25 -04001288 u8 hw_key_idx;
Johannes Berg11a843b2007-08-28 17:01:55 -04001289 u8 flags;
Johannes Berg11a843b2007-08-28 17:01:55 -04001290 s8 keyidx;
Johannes Berg11a843b2007-08-28 17:01:55 -04001291 u8 keylen;
Jiri Bencf0706e82007-05-05 11:45:53 -07001292 u8 key[0];
1293};
1294
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001295/**
Max Stepanov2475b1cc2013-03-24 14:23:27 +02001296 * struct ieee80211_cipher_scheme - cipher scheme
1297 *
1298 * This structure contains a cipher scheme information defining
1299 * the secure packet crypto handling.
1300 *
1301 * @cipher: a cipher suite selector
1302 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1303 * @hdr_len: a length of a security header used the cipher
1304 * @pn_len: a length of a packet number in the security header
1305 * @pn_off: an offset of pn from the beginning of the security header
1306 * @key_idx_off: an offset of key index byte in the security header
1307 * @key_idx_mask: a bit mask of key_idx bits
1308 * @key_idx_shift: a bit shift needed to get key_idx
1309 * key_idx value calculation:
1310 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1311 * @mic_len: a mic length in bytes
1312 */
1313struct ieee80211_cipher_scheme {
1314 u32 cipher;
1315 u16 iftype;
1316 u8 hdr_len;
1317 u8 pn_len;
1318 u8 pn_off;
1319 u8 key_idx_off;
1320 u8 key_idx_mask;
1321 u8 key_idx_shift;
1322 u8 mic_len;
1323};
1324
1325/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001326 * enum set_key_cmd - key command
1327 *
1328 * Used with the set_key() callback in &struct ieee80211_ops, this
1329 * indicates whether a key is being removed or added.
1330 *
1331 * @SET_KEY: a key is set
1332 * @DISABLE_KEY: a key must be disabled
1333 */
Johannes Bergea49c352007-09-18 17:29:21 -04001334enum set_key_cmd {
Johannes Berg11a843b2007-08-28 17:01:55 -04001335 SET_KEY, DISABLE_KEY,
Johannes Bergea49c352007-09-18 17:29:21 -04001336};
Jiri Bencf0706e82007-05-05 11:45:53 -07001337
Tomas Winkler478f8d22007-09-30 13:52:37 +02001338/**
Johannes Bergf09603a2012-01-20 13:55:21 +01001339 * enum ieee80211_sta_state - station state
1340 *
1341 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1342 * this is a special state for add/remove transitions
1343 * @IEEE80211_STA_NONE: station exists without special state
1344 * @IEEE80211_STA_AUTH: station is authenticated
1345 * @IEEE80211_STA_ASSOC: station is associated
1346 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1347 */
1348enum ieee80211_sta_state {
1349 /* NOTE: These need to be ordered correctly! */
1350 IEEE80211_STA_NOTEXIST,
1351 IEEE80211_STA_NONE,
1352 IEEE80211_STA_AUTH,
1353 IEEE80211_STA_ASSOC,
1354 IEEE80211_STA_AUTHORIZED,
1355};
1356
1357/**
Johannes Berge1a0c6b2013-02-07 11:47:44 +01001358 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1359 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1360 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1361 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1362 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1363 * (including 80+80 MHz)
1364 *
1365 * Implementation note: 20 must be zero to be initialized
1366 * correctly, the values must be sorted.
1367 */
1368enum ieee80211_sta_rx_bandwidth {
1369 IEEE80211_STA_RX_BW_20 = 0,
1370 IEEE80211_STA_RX_BW_40,
1371 IEEE80211_STA_RX_BW_80,
1372 IEEE80211_STA_RX_BW_160,
1373};
1374
1375/**
Felix Fietkau0d528d82013-04-22 16:14:41 +02001376 * struct ieee80211_sta_rates - station rate selection table
1377 *
1378 * @rcu_head: RCU head used for freeing the table on update
Robert P. J. Day03f831a2013-05-02 07:15:09 -04001379 * @rate: transmit rates/flags to be used by default.
Felix Fietkau0d528d82013-04-22 16:14:41 +02001380 * Overriding entries per-packet is possible by using cb tx control.
1381 */
1382struct ieee80211_sta_rates {
1383 struct rcu_head rcu_head;
1384 struct {
1385 s8 idx;
1386 u8 count;
1387 u8 count_cts;
1388 u8 count_rts;
1389 u16 flags;
1390 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1391};
1392
1393/**
Johannes Berg17741cd2008-09-11 00:02:02 +02001394 * struct ieee80211_sta - station table entry
1395 *
1396 * A station table entry represents a station we are possibly
1397 * communicating with. Since stations are RCU-managed in
1398 * mac80211, any ieee80211_sta pointer you get access to must
1399 * either be protected by rcu_read_lock() explicitly or implicitly,
1400 * or you must take good care to not use such a pointer after a
Johannes Berg34e89502010-02-03 13:59:58 +01001401 * call to your sta_remove callback that removed it.
Johannes Berg17741cd2008-09-11 00:02:02 +02001402 *
1403 * @addr: MAC address
1404 * @aid: AID we assigned to the station if we're an AP
Johannes Berg323ce792008-09-11 02:45:11 +02001405 * @supp_rates: Bitmap of supported rates (per band)
Johannes Berg55d942f2013-03-01 13:07:48 +01001406 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1407 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
Arik Nemtsov39df6002011-06-27 23:58:45 +03001408 * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
Johannes Berg17741cd2008-09-11 00:02:02 +02001409 * @drv_priv: data area for driver use, will always be aligned to
1410 * sizeof(void *), size is determined in hw information.
Eliad Peller910868d2011-09-11 09:46:55 +03001411 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1412 * if wme is supported.
1413 * @max_sp: max Service Period. Only valid if wme is supported.
Johannes Berge1a0c6b2013-02-07 11:47:44 +01001414 * @bandwidth: current bandwidth the station can receive with
Johannes Berg8921d042012-12-27 18:26:42 +01001415 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1416 * station can receive at the moment, changed by operating mode
1417 * notifications and capabilities. The value is only valid after
1418 * the station moves to associated state.
Johannes Bergaf0ed692013-02-12 14:21:00 +01001419 * @smps_mode: current SMPS mode (off, static or dynamic)
Robert P. J. Day03f831a2013-05-02 07:15:09 -04001420 * @rates: rate control selection table
Arik Nemtsov0c4972c2014-05-01 10:17:27 +03001421 * @tdls: indicates whether the STA is a TDLS peer
Johannes Berg17741cd2008-09-11 00:02:02 +02001422 */
1423struct ieee80211_sta {
Johannes Berg881d9482009-01-21 15:13:48 +01001424 u32 supp_rates[IEEE80211_NUM_BANDS];
Johannes Berg17741cd2008-09-11 00:02:02 +02001425 u8 addr[ETH_ALEN];
1426 u16 aid;
Johannes Bergd9fe60d2008-10-09 12:13:49 +02001427 struct ieee80211_sta_ht_cap ht_cap;
Mahesh Palivela818255e2012-10-10 11:33:04 +00001428 struct ieee80211_sta_vht_cap vht_cap;
Arik Nemtsov39df6002011-06-27 23:58:45 +03001429 bool wme;
Eliad Peller9533b4a2011-08-23 14:37:47 +03001430 u8 uapsd_queues;
1431 u8 max_sp;
Johannes Berg8921d042012-12-27 18:26:42 +01001432 u8 rx_nss;
Johannes Berge1a0c6b2013-02-07 11:47:44 +01001433 enum ieee80211_sta_rx_bandwidth bandwidth;
Johannes Bergaf0ed692013-02-12 14:21:00 +01001434 enum ieee80211_smps_mode smps_mode;
Felix Fietkau0d528d82013-04-22 16:14:41 +02001435 struct ieee80211_sta_rates __rcu *rates;
Arik Nemtsov0c4972c2014-05-01 10:17:27 +03001436 bool tdls;
Johannes Berg17741cd2008-09-11 00:02:02 +02001437
1438 /* must be last */
Johannes Berg1c06ef92012-12-28 12:22:02 +01001439 u8 drv_priv[0] __aligned(sizeof(void *));
Johannes Berg17741cd2008-09-11 00:02:02 +02001440};
1441
1442/**
Tomas Winkler478f8d22007-09-30 13:52:37 +02001443 * enum sta_notify_cmd - sta notify command
1444 *
1445 * Used with the sta_notify() callback in &struct ieee80211_ops, this
Sujith38a6cc72010-05-19 11:32:30 +05301446 * indicates if an associated station made a power state transition.
Tomas Winkler478f8d22007-09-30 13:52:37 +02001447 *
Christian Lamparter4571d3b2008-11-30 00:48:41 +01001448 * @STA_NOTIFY_SLEEP: a station is now sleeping
1449 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1450 */
Christian Lamparter89fad572008-12-09 16:28:06 +01001451enum sta_notify_cmd {
Christian Lamparter4571d3b2008-11-30 00:48:41 +01001452 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1453};
1454
1455/**
Thomas Huehn36323f82012-07-23 21:33:42 +02001456 * struct ieee80211_tx_control - TX control data
1457 *
1458 * @sta: station table entry, this sta pointer may be NULL and
1459 * it is not allowed to copy the pointer, due to RCU.
1460 */
1461struct ieee80211_tx_control {
1462 struct ieee80211_sta *sta;
1463};
1464
1465/**
Johannes Berg1bc08262007-09-18 17:29:15 -04001466 * enum ieee80211_hw_flags - hardware flags
1467 *
1468 * These flags are used to indicate hardware capabilities to
1469 * the stack. Generally, flags here should have their meaning
1470 * done in a way that the simplest hardware doesn't need setting
1471 * any particular flags. There are some exceptions to this rule,
1472 * however, so you are advised to review these flags carefully.
1473 *
Johannes Bergaf65cd962009-11-17 18:18:36 +01001474 * @IEEE80211_HW_HAS_RATE_CONTROL:
1475 * The hardware or firmware includes rate control, and cannot be
1476 * controlled by the stack. As such, no rate control algorithm
1477 * should be instantiated, and the TX rate reported to userspace
1478 * will be taken from the TX status instead of the rate control
1479 * algorithm.
1480 * Note that this requires that the driver implement a number of
1481 * callbacks so it has the correct information, it needs to have
1482 * the @set_rts_threshold callback and must look at the BSS config
1483 * @use_cts_prot for G/N protection, @use_short_slot for slot
1484 * timing in 2.4 GHz and @use_short_preamble for preambles for
1485 * CCK frames.
1486 *
Johannes Berg1bc08262007-09-18 17:29:15 -04001487 * @IEEE80211_HW_RX_INCLUDES_FCS:
1488 * Indicates that received frames passed to the stack include
1489 * the FCS at the end.
1490 *
1491 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1492 * Some wireless LAN chipsets buffer broadcast/multicast frames
1493 * for power saving stations in the hardware/firmware and others
1494 * rely on the host system for such buffering. This option is used
1495 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1496 * multicast frames when there are power saving stations so that
Luis R. Rodriguez546c80c92008-08-14 11:43:20 -07001497 * the driver can fetch them with ieee80211_get_buffered_bc().
Johannes Berg1bc08262007-09-18 17:29:15 -04001498 *
Johannes Berg8318d782008-01-24 19:38:38 +01001499 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1500 * Hardware is not capable of short slot operation on the 2.4 GHz band.
1501 *
1502 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1503 * Hardware is not capable of receiving frames with short preamble on
1504 * the 2.4 GHz band.
Bruno Randolf566bfe52008-05-08 19:15:40 +02001505 *
1506 * @IEEE80211_HW_SIGNAL_UNSPEC:
1507 * Hardware can provide signal values but we don't know its units. We
1508 * expect values between 0 and @max_signal.
1509 * If possible please provide dB or dBm instead.
1510 *
Bruno Randolf566bfe52008-05-08 19:15:40 +02001511 * @IEEE80211_HW_SIGNAL_DBM:
1512 * Hardware gives signal values in dBm, decibel difference from
1513 * one milliwatt. This is the preferred method since it is standardized
1514 * between different devices. @max_signal does not need to be set.
1515 *
Tomas Winkler06ff47b2008-06-18 17:53:44 +03001516 * @IEEE80211_HW_SPECTRUM_MGMT:
1517 * Hardware supports spectrum management defined in 802.11h
1518 * Measurement, Channel Switch, Quieting, TPC
Sujith8b30b1f2008-10-24 09:55:27 +05301519 *
1520 * @IEEE80211_HW_AMPDU_AGGREGATION:
1521 * Hardware supports 11n A-MPDU aggregation.
Kalle Valo520eb822008-12-18 23:35:27 +02001522 *
Johannes Berg4be8c382009-01-07 18:28:20 +01001523 * @IEEE80211_HW_SUPPORTS_PS:
1524 * Hardware has power save support (i.e. can go to sleep).
1525 *
1526 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1527 * Hardware requires nullfunc frame handling in stack, implies
1528 * stack support for dynamic PS.
1529 *
1530 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1531 * Hardware has support for dynamic PS.
Jouni Malinen4375d082009-01-08 13:32:11 +02001532 *
1533 * @IEEE80211_HW_MFP_CAPABLE:
1534 * Hardware supports management frame protection (MFP, IEEE 802.11w).
Kalle Valo04de8382009-03-22 21:57:35 +02001535 *
Johannes Berg0f782312009-12-01 13:37:02 +01001536 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1537 * Hardware supports static spatial multiplexing powersave,
1538 * ie. can turn off all but one chain even on HT connections
1539 * that should be using more chains.
1540 *
1541 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1542 * Hardware supports dynamic spatial multiplexing powersave,
1543 * ie. can turn off all but one chain and then wake the rest
1544 * up as required after, for example, rts/cts handshake.
Kalle Valoab133152010-01-12 10:42:31 +02001545 *
1546 * @IEEE80211_HW_SUPPORTS_UAPSD:
1547 * Hardware supports Unscheduled Automatic Power Save Delivery
1548 * (U-APSD) in managed mode. The mode is configured with
1549 * conf_tx() operation.
Vivek Natarajan375177b2010-02-09 14:50:28 +05301550 *
1551 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1552 * Hardware can provide ack status reports of Tx frames to
1553 * the stack.
1554 *
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02001555 * @IEEE80211_HW_CONNECTION_MONITOR:
Johannes Bergad24b0d2013-07-05 11:53:28 +02001556 * The hardware performs its own connection monitoring, including
1557 * periodic keep-alives to the AP and probing the AP on beacon loss.
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02001558 *
Emmanuel Grumbachc65dd142012-12-12 10:12:24 +02001559 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1560 * This device needs to get data from beacon before association (i.e.
1561 * dtim_period).
Johannes Berge31b8212010-10-05 19:39:30 +02001562 *
1563 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1564 * per-station GTKs as used by IBSS RSN or during fast transition. If
1565 * the device doesn't support per-station GTKs, but can be asked not
1566 * to decrypt group addressed frames, then IBSS RSN support is still
1567 * possible but software crypto will be used. Advertise the wiphy flag
1568 * only in that case.
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02001569 *
1570 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1571 * autonomously manages the PS status of connected stations. When
1572 * this flag is set mac80211 will not trigger PS mode for connected
1573 * stations based on the PM bit of incoming frames.
1574 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1575 * the PS mode of connected stations.
Arik Nemtsovedf6b782011-08-30 09:32:38 +03001576 *
1577 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1578 * setup strictly in HW. mac80211 should not attempt to do this in
1579 * software.
Eliad Peller885bd8e2012-02-02 17:44:55 +02001580 *
Johannes Berg4b6f1dd2012-04-03 14:35:57 +02001581 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1582 * a virtual monitor interface when monitor interfaces are the only
1583 * active interfaces.
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001584 *
1585 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1586 * queue mapping in order to use different queues (not just one per AC)
1587 * for different virtual interfaces. See the doc section on HW queue
1588 * control for more details.
Johannes Berg6d711172012-06-19 17:19:44 +02001589 *
Felix Fietkau0d528d82013-04-22 16:14:41 +02001590 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
1591 * selection table provided by the rate control algorithm.
1592 *
Johannes Berg6d711172012-06-19 17:19:44 +02001593 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1594 * P2P Interface. This will be honoured even if more than one interface
1595 * is supported.
Johannes Bergef429da2013-02-05 17:48:40 +01001596 *
1597 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
1598 * only, to allow getting TBTT of a DTIM beacon.
Arik Nemtsov7578d572013-09-01 17:15:51 +03001599 *
Johannes Berg919be622013-10-14 10:05:16 +02001600 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
1601 * and can cope with CCK rates in an aggregation session (e.g. by not
1602 * using aggregation for such frames.)
1603 *
Arik Nemtsov7578d572013-09-01 17:15:51 +03001604 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
1605 * for a single active channel while using channel contexts. When support
1606 * is not enabled the default action is to disconnect when getting the
1607 * CSA frame.
Luciano Coelho5d52ee82014-02-27 14:33:47 +02001608 *
David Spinadelc56ef672014-02-05 15:21:13 +02001609 * @IEEE80211_SINGLE_HW_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
1610 * in one command, mac80211 doesn't have to run separate scans per band.
Johannes Berg1bc08262007-09-18 17:29:15 -04001611 */
1612enum ieee80211_hw_flags {
Johannes Bergaf65cd962009-11-17 18:18:36 +01001613 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
Johannes Berg1bc08262007-09-18 17:29:15 -04001614 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1615 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
Johannes Berg8318d782008-01-24 19:38:38 +01001616 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1617 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
Bruno Randolf566bfe52008-05-08 19:15:40 +02001618 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
Johannes Berg7fee5372009-01-30 11:13:06 +01001619 IEEE80211_HW_SIGNAL_DBM = 1<<6,
Emmanuel Grumbachc65dd142012-12-12 10:12:24 +02001620 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC = 1<<7,
Johannes Berg7fee5372009-01-30 11:13:06 +01001621 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1622 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1623 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1624 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1625 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1626 IEEE80211_HW_MFP_CAPABLE = 1<<13,
Johannes Berg4b6f1dd2012-04-03 14:35:57 +02001627 IEEE80211_HW_WANT_MONITOR_VIF = 1<<14,
Johannes Berg0f782312009-12-01 13:37:02 +01001628 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
1629 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
Kalle Valoab133152010-01-12 10:42:31 +02001630 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
Vivek Natarajan375177b2010-02-09 14:50:28 +05301631 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02001632 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001633 IEEE80211_HW_QUEUE_CONTROL = 1<<20,
Johannes Berge31b8212010-10-05 19:39:30 +02001634 IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02001635 IEEE80211_HW_AP_LINK_PS = 1<<22,
Arik Nemtsovedf6b782011-08-30 09:32:38 +03001636 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW = 1<<23,
Felix Fietkau0d528d82013-04-22 16:14:41 +02001637 IEEE80211_HW_SUPPORTS_RC_TABLE = 1<<24,
Johannes Berg6d711172012-06-19 17:19:44 +02001638 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF = 1<<25,
Johannes Bergef429da2013-02-05 17:48:40 +01001639 IEEE80211_HW_TIMING_BEACON_ONLY = 1<<26,
Felix Fietkau2dfca312013-08-20 19:43:54 +02001640 IEEE80211_HW_SUPPORTS_HT_CCK_RATES = 1<<27,
Arik Nemtsov7578d572013-09-01 17:15:51 +03001641 IEEE80211_HW_CHANCTX_STA_CSA = 1<<28,
Michal Kazior5bcae312014-06-25 12:35:06 +02001642 /* bit 29 unused */
David Spinadelc56ef672014-02-05 15:21:13 +02001643 IEEE80211_SINGLE_HW_SCAN_ON_ALL_BANDS = 1<<30,
Johannes Berg1bc08262007-09-18 17:29:15 -04001644};
1645
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001646/**
1647 * struct ieee80211_hw - hardware information and state
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001648 *
1649 * This structure contains the configuration and hardware
1650 * information for an 802.11 PHY.
1651 *
1652 * @wiphy: This points to the &struct wiphy allocated for this
1653 * 802.11 PHY. You must fill in the @perm_addr and @dev
1654 * members of this structure using SET_IEEE80211_DEV()
Johannes Berg8318d782008-01-24 19:38:38 +01001655 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1656 * bands (with channels, bitrates) are registered here.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001657 *
1658 * @conf: &struct ieee80211_conf, device configuration, don't use.
1659 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001660 * @priv: pointer to private area that was allocated for driver use
1661 * along with this structure.
1662 *
1663 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1664 *
1665 * @extra_tx_headroom: headroom to reserve in each transmit skb
1666 * for use by the driver (e.g. for transmit headers.)
1667 *
Felix Fietkau70dabeb2013-12-14 13:54:53 +01001668 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
1669 * Can be used by drivers to add extra IEs.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001670 *
Bruno Randolf566bfe52008-05-08 19:15:40 +02001671 * @max_signal: Maximum value for signal (rssi) in RX information, used
Johannes Bergad24b0d2013-07-05 11:53:28 +02001672 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001673 *
Tomas Winklerea95bba2008-07-18 13:53:00 +08001674 * @max_listen_interval: max listen interval in units of beacon interval
Johannes Bergad24b0d2013-07-05 11:53:28 +02001675 * that HW supports
Tomas Winklerea95bba2008-07-18 13:53:00 +08001676 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001677 * @queues: number of available hardware transmit queues for
Johannes Berge100bb62008-04-30 18:51:21 +02001678 * data packets. WMM/QoS requires at least four, these
1679 * queues need to have configurable access parameters.
1680 *
Johannes Berg830f9032007-10-28 14:51:05 +01001681 * @rate_control_algorithm: rate control algorithm for this hardware.
1682 * If unset (NULL), the default algorithm will be used. Must be
1683 * set before calling ieee80211_register_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001684 *
1685 * @vif_data_size: size (in bytes) of the drv_priv data area
1686 * within &struct ieee80211_vif.
Johannes Berg17741cd2008-09-11 00:02:02 +02001687 * @sta_data_size: size (in bytes) of the drv_priv data area
1688 * within &struct ieee80211_sta.
Michal Kaziord01a1e62012-06-26 14:37:16 +02001689 * @chanctx_data_size: size (in bytes) of the drv_priv data area
1690 * within &struct ieee80211_chanctx_conf.
Felix Fietkau870abdf2008-10-05 18:04:24 +02001691 *
Helmut Schaa78be49e2010-10-02 11:31:55 +02001692 * @max_rates: maximum number of alternate rate retry stages the hw
1693 * can handle.
1694 * @max_report_rates: maximum number of alternate rate retry stages
1695 * the hw can report back.
Johannes Berge6a98542008-10-21 12:40:02 +02001696 * @max_rate_tries: maximum number of tries for each stage
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001697 *
Luciano Coelhodf6ba5d2011-01-12 15:26:30 +02001698 * @max_rx_aggregation_subframes: maximum buffer size (number of
1699 * sub-frames) to be used for A-MPDU block ack receiver
1700 * aggregation.
1701 * This is only relevant if the device has restrictions on the
1702 * number of subframes, if it relies on mac80211 to do reordering
1703 * it shouldn't be set.
Johannes Berg5dd36bc2011-01-18 13:52:23 +01001704 *
1705 * @max_tx_aggregation_subframes: maximum number of subframes in an
1706 * aggregate an HT driver will transmit, used by the peer as a
1707 * hint to size its reorder buffer.
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001708 *
1709 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
1710 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
Johannes Bergac55d2f2012-05-10 09:09:10 +02001711 *
1712 * @radiotap_mcs_details: lists which MCS information can the HW
1713 * reports, by default it is set to _MCS, _GI and _BW but doesn't
1714 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
1715 * adding _BW is supported today.
Arik Nemtsov72d78722012-05-10 16:18:26 +03001716 *
Johannes Berg51648922012-11-22 23:00:18 +01001717 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
1718 * the default is _GI | _BANDWIDTH.
1719 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_* values.
1720 *
Arik Nemtsov72d78722012-05-10 16:18:26 +03001721 * @netdev_features: netdev features to be set in each netdev created
1722 * from this HW. Note only HW checksum features are currently
1723 * compatible with mac80211. Other feature bits will be rejected.
Alexander Bondar219c3862013-01-22 16:52:23 +02001724 *
1725 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
1726 * for each access category if it is uAPSD trigger-enabled and delivery-
1727 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
1728 * Each bit corresponds to different AC. Value '1' in specific bit means
1729 * that corresponding AC is both trigger- and delivery-enabled. '0' means
1730 * neither enabled.
1731 *
1732 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
1733 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
1734 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
Max Stepanov2475b1cc2013-03-24 14:23:27 +02001735 *
1736 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
1737 * @cipher_schemes: a pointer to an array of cipher scheme definitions
1738 * supported by HW.
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001739 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001740struct ieee80211_hw {
Jiri Bencf0706e82007-05-05 11:45:53 -07001741 struct ieee80211_conf conf;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001742 struct wiphy *wiphy;
Johannes Berg830f9032007-10-28 14:51:05 +01001743 const char *rate_control_algorithm;
Jiri Bencf0706e82007-05-05 11:45:53 -07001744 void *priv;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001745 u32 flags;
Jiri Bencf0706e82007-05-05 11:45:53 -07001746 unsigned int extra_tx_headroom;
Felix Fietkau70dabeb2013-12-14 13:54:53 +01001747 unsigned int extra_beacon_tailroom;
Johannes Berg32bfd352007-12-19 01:31:26 +01001748 int vif_data_size;
Johannes Berg17741cd2008-09-11 00:02:02 +02001749 int sta_data_size;
Michal Kaziord01a1e62012-06-26 14:37:16 +02001750 int chanctx_data_size;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001751 u16 queues;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001752 u16 max_listen_interval;
Jiri Bencf0706e82007-05-05 11:45:53 -07001753 s8 max_signal;
Johannes Berge6a98542008-10-21 12:40:02 +02001754 u8 max_rates;
Helmut Schaa78be49e2010-10-02 11:31:55 +02001755 u8 max_report_rates;
Johannes Berge6a98542008-10-21 12:40:02 +02001756 u8 max_rate_tries;
Luciano Coelhodf6ba5d2011-01-12 15:26:30 +02001757 u8 max_rx_aggregation_subframes;
Johannes Berg5dd36bc2011-01-18 13:52:23 +01001758 u8 max_tx_aggregation_subframes;
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001759 u8 offchannel_tx_hw_queue;
Johannes Bergac55d2f2012-05-10 09:09:10 +02001760 u8 radiotap_mcs_details;
Johannes Berg51648922012-11-22 23:00:18 +01001761 u16 radiotap_vht_details;
Arik Nemtsov72d78722012-05-10 16:18:26 +03001762 netdev_features_t netdev_features;
Alexander Bondar219c3862013-01-22 16:52:23 +02001763 u8 uapsd_queues;
1764 u8 uapsd_max_sp_len;
Max Stepanov2475b1cc2013-03-24 14:23:27 +02001765 u8 n_cipher_schemes;
1766 const struct ieee80211_cipher_scheme *cipher_schemes;
Jiri Bencf0706e82007-05-05 11:45:53 -07001767};
1768
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001769/**
David Spinadelc56ef672014-02-05 15:21:13 +02001770 * struct ieee80211_scan_request - hw scan request
1771 *
1772 * @ies: pointers different parts of IEs (in req.ie)
1773 * @req: cfg80211 request.
1774 */
1775struct ieee80211_scan_request {
1776 struct ieee80211_scan_ies ies;
1777
1778 /* Keep last */
1779 struct cfg80211_scan_request req;
1780};
1781
1782/**
Luis R. Rodriguez9a953712009-01-22 15:05:53 -08001783 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1784 *
1785 * @wiphy: the &struct wiphy which we want to query
1786 *
1787 * mac80211 drivers can use this to get to their respective
1788 * &struct ieee80211_hw. Drivers wishing to get to their own private
1789 * structure can then access it via hw->priv. Note that mac802111 drivers should
1790 * not use wiphy_priv() to try to get their private driver structure as this
1791 * is already used internally by mac80211.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01001792 *
1793 * Return: The mac80211 driver hw struct of @wiphy.
Luis R. Rodriguez9a953712009-01-22 15:05:53 -08001794 */
1795struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1796
1797/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001798 * SET_IEEE80211_DEV - set device for 802.11 hardware
1799 *
1800 * @hw: the &struct ieee80211_hw to set the device for
1801 * @dev: the &struct device of this 802.11 device
1802 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001803static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1804{
1805 set_wiphy_dev(hw->wiphy, dev);
1806}
1807
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001808/**
Bob Copelande37d4df2008-10-20 21:20:27 -04001809 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001810 *
1811 * @hw: the &struct ieee80211_hw to set the MAC address for
1812 * @addr: the address to set
1813 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001814static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1815{
1816 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1817}
1818
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001819static inline struct ieee80211_rate *
1820ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001821 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001822{
Larry Fingeraa331df2012-04-06 16:35:53 -05001823 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001824 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001825 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001826}
1827
1828static inline struct ieee80211_rate *
1829ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001830 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001831{
Johannes Berge039fa42008-05-15 12:55:29 +02001832 if (c->control.rts_cts_rate_idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001833 return NULL;
Johannes Berge039fa42008-05-15 12:55:29 +02001834 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001835}
1836
1837static inline struct ieee80211_rate *
1838ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
Felix Fietkau870abdf2008-10-05 18:04:24 +02001839 const struct ieee80211_tx_info *c, int idx)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001840{
Johannes Berge6a98542008-10-21 12:40:02 +02001841 if (c->control.rates[idx + 1].idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001842 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001843 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001844}
1845
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001846/**
Johannes Berg6096de72011-11-04 11:18:10 +01001847 * ieee80211_free_txskb - free TX skb
1848 * @hw: the hardware
1849 * @skb: the skb
1850 *
1851 * Free a transmit skb. Use this funtion when some failure
1852 * to transmit happened and thus status cannot be reported.
1853 */
1854void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
1855
1856/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001857 * DOC: Hardware crypto acceleration
Johannes Berg4150c572007-09-17 01:29:23 -04001858 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001859 * mac80211 is capable of taking advantage of many hardware
1860 * acceleration designs for encryption and decryption operations.
1861 *
1862 * The set_key() callback in the &struct ieee80211_ops for a given
1863 * device is called to enable hardware acceleration of encryption and
Johannes Bergdc822b52008-12-29 12:55:09 +01001864 * decryption. The callback takes a @sta parameter that will be NULL
1865 * for default keys or keys used for transmission only, or point to
1866 * the station information for the peer for individual keys.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001867 * Multiple transmission keys with the same key index may be used when
1868 * VLANs are configured for an access point.
1869 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001870 * When transmitting, the TX control data will use the @hw_key_idx
1871 * selected by the driver by modifying the &struct ieee80211_key_conf
1872 * pointed to by the @key parameter to the set_key() function.
1873 *
1874 * The set_key() call for the %SET_KEY command should return 0 if
1875 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1876 * added; if you return 0 then hw_key_idx must be assigned to the
1877 * hardware key index, you are free to use the full u8 range.
1878 *
1879 * When the cmd is %DISABLE_KEY then it must succeed.
1880 *
1881 * Note that it is permissible to not decrypt a frame even if a key
1882 * for it has been uploaded to hardware, the stack will not make any
1883 * decision based on whether a key has been uploaded or not but rather
1884 * based on the receive flags.
1885 *
1886 * The &struct ieee80211_key_conf structure pointed to by the @key
1887 * parameter is guaranteed to be valid until another call to set_key()
1888 * removes it, but it can only be used as a cookie to differentiate
1889 * keys.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001890 *
1891 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1892 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1893 * handler.
1894 * The update_tkip_key() call updates the driver with the new phase 1 key.
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001895 * This happens every time the iv16 wraps around (every 65536 packets). The
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001896 * set_key() call will happen only once for each key (unless the AP did
1897 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
Bob Copelande37d4df2008-10-20 21:20:27 -04001898 * provided by update_tkip_key only. The trigger that makes mac80211 call this
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001899 * handler is software decryption with wrap around of iv16.
Yoni Divinskyde5fad82012-05-30 11:36:39 +03001900 *
1901 * The set_default_unicast_key() call updates the default WEP key index
1902 * configured to the hardware for WEP encryption type. This is required
1903 * for devices that support offload of data packets (e.g. ARP responses).
Johannes Berg4150c572007-09-17 01:29:23 -04001904 */
Johannes Berg4150c572007-09-17 01:29:23 -04001905
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001906/**
Johannes Berg4be8c382009-01-07 18:28:20 +01001907 * DOC: Powersave support
1908 *
1909 * mac80211 has support for various powersave implementations.
1910 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001911 * First, it can support hardware that handles all powersaving by itself,
1912 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1913 * flag. In that case, it will be told about the desired powersave mode
1914 * with the %IEEE80211_CONF_PS flag depending on the association status.
1915 * The hardware must take care of sending nullfunc frames when necessary,
1916 * i.e. when entering and leaving powersave mode. The hardware is required
1917 * to look at the AID in beacons and signal to the AP that it woke up when
1918 * it finds traffic directed to it.
Johannes Berg4be8c382009-01-07 18:28:20 +01001919 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001920 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1921 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1922 * with hardware wakeup and sleep states. Driver is responsible for waking
Bob Copeland2738bd62010-08-21 16:39:01 -04001923 * up the hardware before issuing commands to the hardware and putting it
1924 * back to sleep at appropriate times.
Kalle Valoc99445b2010-01-14 13:09:21 +02001925 *
1926 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1927 * buffered multicast/broadcast frames after the beacon. Also it must be
1928 * possible to send frames and receive the acknowledment frame.
Johannes Berg4be8c382009-01-07 18:28:20 +01001929 *
1930 * Other hardware designs cannot send nullfunc frames by themselves and also
1931 * need software support for parsing the TIM bitmap. This is also supported
1932 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1933 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
Johannes Berg955394c2009-04-16 17:04:25 +02001934 * required to pass up beacons. The hardware is still required to handle
1935 * waking up for multicast traffic; if it cannot the driver must handle that
Kalle Valoc99445b2010-01-14 13:09:21 +02001936 * as best as it can, mac80211 is too slow to do that.
Johannes Berg4be8c382009-01-07 18:28:20 +01001937 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001938 * Dynamic powersave is an extension to normal powersave in which the
1939 * hardware stays awake for a user-specified period of time after sending a
1940 * frame so that reply frames need not be buffered and therefore delayed to
1941 * the next wakeup. It's compromise of getting good enough latency when
1942 * there's data traffic and still saving significantly power in idle
1943 * periods.
1944 *
Bob Copeland2738bd62010-08-21 16:39:01 -04001945 * Dynamic powersave is simply supported by mac80211 enabling and disabling
Kalle Valoc99445b2010-01-14 13:09:21 +02001946 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1947 * flag and mac80211 will handle everything automatically. Additionally,
1948 * hardware having support for the dynamic PS feature may set the
1949 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1950 * dynamic PS mode itself. The driver needs to look at the
1951 * @dynamic_ps_timeout hardware configuration value and use it that value
1952 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1953 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1954 * enabled whenever user has enabled powersave.
1955 *
1956 * Driver informs U-APSD client support by enabling
1957 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
Masanari Iidae2278672014-02-18 22:54:36 +09001958 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
Kalle Valoc99445b2010-01-14 13:09:21 +02001959 * Nullfunc frames and stay awake until the service period has ended. To
1960 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1961 * from that AC are transmitted with powersave enabled.
1962 *
1963 * Note: U-APSD client mode is not yet supported with
1964 * %IEEE80211_HW_PS_NULLFUNC_STACK.
Johannes Berg4be8c382009-01-07 18:28:20 +01001965 */
1966
1967/**
Kalle Valo04de8382009-03-22 21:57:35 +02001968 * DOC: Beacon filter support
1969 *
1970 * Some hardware have beacon filter support to reduce host cpu wakeups
Justin P. Mattock42b2aa82011-11-28 20:31:00 -08001971 * which will reduce system power consumption. It usually works so that
Kalle Valo04de8382009-03-22 21:57:35 +02001972 * the firmware creates a checksum of the beacon but omits all constantly
1973 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1974 * beacon is forwarded to the host, otherwise it will be just dropped. That
1975 * way the host will only receive beacons where some relevant information
1976 * (for example ERP protection or WMM settings) have changed.
1977 *
Johannes Bergc1288b12012-01-19 09:29:57 +01001978 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
1979 * interface capability. The driver needs to enable beacon filter support
Johannes Berg955394c2009-04-16 17:04:25 +02001980 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1981 * power save is enabled, the stack will not check for beacon loss and the
1982 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1983 *
1984 * The time (or number of beacons missed) until the firmware notifies the
1985 * driver of a beacon loss event (which in turn causes the driver to call
1986 * ieee80211_beacon_loss()) should be configurable and will be controlled
1987 * by mac80211 and the roaming algorithm in the future.
1988 *
1989 * Since there may be constantly changing information elements that nothing
1990 * in the software stack cares about, we will, in the future, have mac80211
1991 * tell the driver which information elements are interesting in the sense
1992 * that we want to see changes in them. This will include
1993 * - a list of information element IDs
1994 * - a list of OUIs for the vendor information element
1995 *
1996 * Ideally, the hardware would filter out any beacons without changes in the
1997 * requested elements, but if it cannot support that it may, at the expense
1998 * of some efficiency, filter out only a subset. For example, if the device
1999 * doesn't support checking for OUIs it should pass up all changes in all
2000 * vendor information elements.
2001 *
2002 * Note that change, for the sake of simplification, also includes information
2003 * elements appearing or disappearing from the beacon.
2004 *
2005 * Some hardware supports an "ignore list" instead, just make sure nothing
2006 * that was requested is on the ignore list, and include commonly changing
2007 * information element IDs in the ignore list, for example 11 (BSS load) and
2008 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2009 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2010 * it could also include some currently unused IDs.
2011 *
2012 *
2013 * In addition to these capabilities, hardware should support notifying the
2014 * host of changes in the beacon RSSI. This is relevant to implement roaming
2015 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2016 * the received data packets). This can consist in notifying the host when
2017 * the RSSI changes significantly or when it drops below or rises above
2018 * configurable thresholds. In the future these thresholds will also be
2019 * configured by mac80211 (which gets them from userspace) to implement
2020 * them as the roaming algorithm requires.
2021 *
2022 * If the hardware cannot implement this, the driver should ask it to
2023 * periodically pass beacon frames to the host so that software can do the
2024 * signal strength threshold checking.
Kalle Valo04de8382009-03-22 21:57:35 +02002025 */
2026
2027/**
Johannes Berg0f782312009-12-01 13:37:02 +01002028 * DOC: Spatial multiplexing power save
2029 *
2030 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2031 * power in an 802.11n implementation. For details on the mechanism
2032 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2033 * "11.2.3 SM power save".
2034 *
2035 * The mac80211 implementation is capable of sending action frames
2036 * to update the AP about the station's SMPS mode, and will instruct
2037 * the driver to enter the specific mode. It will also announce the
2038 * requested SMPS mode during the association handshake. Hardware
2039 * support for this feature is required, and can be indicated by
2040 * hardware flags.
2041 *
2042 * The default mode will be "automatic", which nl80211/cfg80211
2043 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2044 * turned off otherwise.
2045 *
2046 * To support this feature, the driver must set the appropriate
2047 * hardware support flags, and handle the SMPS flag to the config()
2048 * operation. It will then with this mechanism be instructed to
2049 * enter the requested SMPS mode while associated to an HT AP.
2050 */
2051
2052/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002053 * DOC: Frame filtering
2054 *
2055 * mac80211 requires to see many management frames for proper
2056 * operation, and users may want to see many more frames when
2057 * in monitor mode. However, for best CPU usage and power consumption,
2058 * having as few frames as possible percolate through the stack is
2059 * desirable. Hence, the hardware should filter as much as possible.
2060 *
2061 * To achieve this, mac80211 uses filter flags (see below) to tell
2062 * the driver's configure_filter() function which frames should be
2063 * passed to mac80211 and which should be filtered out.
2064 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02002065 * Before configure_filter() is invoked, the prepare_multicast()
2066 * callback is invoked with the parameters @mc_count and @mc_list
2067 * for the combined multicast address list of all virtual interfaces.
2068 * It's use is optional, and it returns a u64 that is passed to
2069 * configure_filter(). Additionally, configure_filter() has the
2070 * arguments @changed_flags telling which flags were changed and
2071 * @total_flags with the new flag states.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002072 *
2073 * If your device has no multicast address filters your driver will
2074 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2075 * parameter to see whether multicast frames should be accepted
2076 * or dropped.
2077 *
Michael Bueschd0f5afb2008-02-12 20:12:45 +01002078 * All unsupported flags in @total_flags must be cleared.
2079 * Hardware does not support a flag if it is incapable of _passing_
2080 * the frame to the stack. Otherwise the driver must ignore
2081 * the flag, but not clear it.
2082 * You must _only_ clear the flag (announce no support for the
2083 * flag to mac80211) if you are not able to pass the packet type
2084 * to the stack (so the hardware always filters it).
2085 * So for example, you should clear @FIF_CONTROL, if your hardware
2086 * always filters control frames. If your hardware always passes
2087 * control frames to the kernel and is incapable of filtering them,
2088 * you do _not_ clear the @FIF_CONTROL flag.
2089 * This rule applies to all other FIF flags as well.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002090 */
2091
2092/**
Johannes Berg4b801bc2011-09-29 16:04:40 +02002093 * DOC: AP support for powersaving clients
2094 *
2095 * In order to implement AP and P2P GO modes, mac80211 has support for
2096 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2097 * There currently is no support for sAPSD.
2098 *
2099 * There is one assumption that mac80211 makes, namely that a client
2100 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2101 * Both are supported, and both can be used by the same client, but
2102 * they can't be used concurrently by the same client. This simplifies
2103 * the driver code.
2104 *
2105 * The first thing to keep in mind is that there is a flag for complete
2106 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2107 * mac80211 expects the driver to handle most of the state machine for
2108 * powersaving clients and will ignore the PM bit in incoming frames.
2109 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2110 * stations' powersave transitions. In this mode, mac80211 also doesn't
2111 * handle PS-Poll/uAPSD.
2112 *
2113 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2114 * PM bit in incoming frames for client powersave transitions. When a
2115 * station goes to sleep, we will stop transmitting to it. There is,
2116 * however, a race condition: a station might go to sleep while there is
2117 * data buffered on hardware queues. If the device has support for this
2118 * it will reject frames, and the driver should give the frames back to
2119 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2120 * cause mac80211 to retry the frame when the station wakes up. The
2121 * driver is also notified of powersave transitions by calling its
2122 * @sta_notify callback.
2123 *
2124 * When the station is asleep, it has three choices: it can wake up,
2125 * it can PS-Poll, or it can possibly start a uAPSD service period.
2126 * Waking up is implemented by simply transmitting all buffered (and
2127 * filtered) frames to the station. This is the easiest case. When
2128 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2129 * will inform the driver of this with the @allow_buffered_frames
2130 * callback; this callback is optional. mac80211 will then transmit
Johannes Berg02f2f1a2012-02-27 12:18:30 +01002131 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
Johannes Berg4b801bc2011-09-29 16:04:40 +02002132 * on each frame. The last frame in the service period (or the only
2133 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2134 * indicate that it ends the service period; as this frame must have
2135 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2136 * When TX status is reported for this frame, the service period is
2137 * marked has having ended and a new one can be started by the peer.
2138 *
Johannes Berg02f2f1a2012-02-27 12:18:30 +01002139 * Additionally, non-bufferable MMPDUs can also be transmitted by
2140 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2141 *
Johannes Berg4b801bc2011-09-29 16:04:40 +02002142 * Another race condition can happen on some devices like iwlwifi
2143 * when there are frames queued for the station and it wakes up
2144 * or polls; the frames that are already queued could end up being
2145 * transmitted first instead, causing reordering and/or wrong
2146 * processing of the EOSP. The cause is that allowing frames to be
2147 * transmitted to a certain station is out-of-band communication to
2148 * the device. To allow this problem to be solved, the driver can
2149 * call ieee80211_sta_block_awake() if frames are buffered when it
2150 * is notified that the station went to sleep. When all these frames
2151 * have been filtered (see above), it must call the function again
2152 * to indicate that the station is no longer blocked.
2153 *
2154 * If the driver buffers frames in the driver for aggregation in any
2155 * way, it must use the ieee80211_sta_set_buffered() call when it is
2156 * notified of the station going to sleep to inform mac80211 of any
2157 * TIDs that have frames buffered. Note that when a station wakes up
2158 * this information is reset (hence the requirement to call it when
2159 * informed of the station going to sleep). Then, when a service
2160 * period starts for any reason, @release_buffered_frames is called
2161 * with the number of frames to be released and which TIDs they are
2162 * to come from. In this case, the driver is responsible for setting
2163 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
Masanari Iidae2278672014-02-18 22:54:36 +09002164 * to help the @more_data parameter is passed to tell the driver if
Johannes Berg4b801bc2011-09-29 16:04:40 +02002165 * there is more data on other TIDs -- the TIDs to release frames
2166 * from are ignored since mac80211 doesn't know how many frames the
2167 * buffers for those TIDs contain.
2168 *
2169 * If the driver also implement GO mode, where absence periods may
2170 * shorten service periods (or abort PS-Poll responses), it must
2171 * filter those response frames except in the case of frames that
2172 * are buffered in the driver -- those must remain buffered to avoid
2173 * reordering. Because it is possible that no frames are released
Johannes Berge9437892013-02-15 21:38:08 +01002174 * in this case, the driver must call ieee80211_sta_eosp()
Johannes Berg4b801bc2011-09-29 16:04:40 +02002175 * to indicate to mac80211 that the service period ended anyway.
2176 *
2177 * Finally, if frames from multiple TIDs are released from mac80211
2178 * but the driver might reorder them, it must clear & set the flags
2179 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2180 * and also take care of the EOSP and MORE_DATA bits in the frame.
Johannes Berge9437892013-02-15 21:38:08 +01002181 * The driver may also use ieee80211_sta_eosp() in this case.
Johannes Bergb77cf4f2014-01-09 00:00:38 +01002182 *
2183 * Note that if the driver ever buffers frames other than QoS-data
2184 * frames, it must take care to never send a non-QoS-data frame as
2185 * the last frame in a service period, adding a QoS-nulldata frame
2186 * after a non-QoS-data frame if needed.
Johannes Berg4b801bc2011-09-29 16:04:40 +02002187 */
2188
2189/**
Johannes Berg3a25a8c2012-04-03 16:28:50 +02002190 * DOC: HW queue control
2191 *
2192 * Before HW queue control was introduced, mac80211 only had a single static
2193 * assignment of per-interface AC software queues to hardware queues. This
2194 * was problematic for a few reasons:
2195 * 1) off-channel transmissions might get stuck behind other frames
2196 * 2) multiple virtual interfaces couldn't be handled correctly
2197 * 3) after-DTIM frames could get stuck behind other frames
2198 *
2199 * To solve this, hardware typically uses multiple different queues for all
2200 * the different usages, and this needs to be propagated into mac80211 so it
2201 * won't have the same problem with the software queues.
2202 *
2203 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2204 * flag that tells it that the driver implements its own queue control. To do
2205 * so, the driver will set up the various queues in each &struct ieee80211_vif
2206 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2207 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2208 * if necessary will queue the frame on the right software queue that mirrors
2209 * the hardware queue.
2210 * Additionally, the driver has to then use these HW queue IDs for the queue
2211 * management functions (ieee80211_stop_queue() et al.)
2212 *
2213 * The driver is free to set up the queue mappings as needed, multiple virtual
2214 * interfaces may map to the same hardware queues if needed. The setup has to
2215 * happen during add_interface or change_interface callbacks. For example, a
2216 * driver supporting station+station and station+AP modes might decide to have
2217 * 10 hardware queues to handle different scenarios:
2218 *
2219 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2220 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2221 * after-DTIM queue for AP: 8
2222 * off-channel queue: 9
2223 *
2224 * It would then set up the hardware like this:
2225 * hw.offchannel_tx_hw_queue = 9
2226 *
2227 * and the first virtual interface that is added as follows:
2228 * vif.hw_queue[IEEE80211_AC_VO] = 0
2229 * vif.hw_queue[IEEE80211_AC_VI] = 1
2230 * vif.hw_queue[IEEE80211_AC_BE] = 2
2231 * vif.hw_queue[IEEE80211_AC_BK] = 3
2232 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2233 * and the second virtual interface with 4-7.
2234 *
2235 * If queue 6 gets full, for example, mac80211 would only stop the second
2236 * virtual interface's BE queue since virtual interface queues are per AC.
2237 *
2238 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2239 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2240 * queue could potentially be shared since mac80211 will look at cab_queue when
2241 * a queue is stopped/woken even if the interface is not in AP mode.
2242 */
2243
2244/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002245 * enum ieee80211_filter_flags - hardware filter flags
2246 *
2247 * These flags determine what the filter in hardware should be
2248 * programmed to let through and what should not be passed to the
2249 * stack. It is always safe to pass more frames than requested,
2250 * but this has negative impact on power consumption.
2251 *
2252 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
2253 * think of the BSS as your network segment and then this corresponds
2254 * to the regular ethernet device promiscuous mode.
2255 *
2256 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2257 * by the user or if the hardware is not capable of filtering by
2258 * multicast address.
2259 *
2260 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2261 * %RX_FLAG_FAILED_FCS_CRC for them)
2262 *
2263 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2264 * the %RX_FLAG_FAILED_PLCP_CRC for them
2265 *
2266 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2267 * to the hardware that it should not filter beacons or probe responses
2268 * by BSSID. Filtering them can greatly reduce the amount of processing
2269 * mac80211 needs to do and the amount of CPU wakeups, so you should
2270 * honour this flag if possible.
2271 *
Igor Perminove3b90ca2009-08-04 16:48:51 +04002272 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
Johannes Berg7be50862010-10-13 12:06:24 +02002273 * is not set then only those addressed to this station.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002274 *
2275 * @FIF_OTHER_BSS: pass frames destined to other BSSes
Igor Perminove3b90ca2009-08-04 16:48:51 +04002276 *
Johannes Berg7be50862010-10-13 12:06:24 +02002277 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
2278 * those addressed to this station.
2279 *
2280 * @FIF_PROBE_REQ: pass probe request frames
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002281 */
2282enum ieee80211_filter_flags {
2283 FIF_PROMISC_IN_BSS = 1<<0,
2284 FIF_ALLMULTI = 1<<1,
2285 FIF_FCSFAIL = 1<<2,
2286 FIF_PLCPFAIL = 1<<3,
2287 FIF_BCN_PRBRESP_PROMISC = 1<<4,
2288 FIF_CONTROL = 1<<5,
2289 FIF_OTHER_BSS = 1<<6,
Igor Perminove3b90ca2009-08-04 16:48:51 +04002290 FIF_PSPOLL = 1<<7,
Johannes Berg7be50862010-10-13 12:06:24 +02002291 FIF_PROBE_REQ = 1<<8,
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002292};
2293
2294/**
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02002295 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2296 *
2297 * These flags are used with the ampdu_action() callback in
2298 * &struct ieee80211_ops to indicate which action is needed.
Johannes Berg827d42c2009-11-22 12:28:41 +01002299 *
2300 * Note that drivers MUST be able to deal with a TX aggregation
2301 * session being stopped even before they OK'ed starting it by
Johannes Berg5d22c892010-06-10 10:21:40 +02002302 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
Johannes Berg827d42c2009-11-22 12:28:41 +01002303 * might receive the addBA frame and send a delBA right away!
2304 *
Johannes Berg18b559d2012-07-18 13:51:25 +02002305 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2306 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2307 * @IEEE80211_AMPDU_TX_START: start TX aggregation
Johannes Bergb1720232009-03-23 17:28:39 +01002308 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
Johannes Berg18b559d2012-07-18 13:51:25 +02002309 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2310 * queued packets, now unaggregated. After all packets are transmitted the
2311 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2312 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2313 * called when the station is removed. There's no need or reason to call
2314 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2315 * session is gone and removes the station.
2316 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2317 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2318 * now the connection is dropped and the station will be removed. Drivers
2319 * should clean up and drop remaining packets when this is called.
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02002320 */
2321enum ieee80211_ampdu_mlme_action {
2322 IEEE80211_AMPDU_RX_START,
2323 IEEE80211_AMPDU_RX_STOP,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002324 IEEE80211_AMPDU_TX_START,
Johannes Berg18b559d2012-07-18 13:51:25 +02002325 IEEE80211_AMPDU_TX_STOP_CONT,
2326 IEEE80211_AMPDU_TX_STOP_FLUSH,
2327 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
Johannes Bergb1720232009-03-23 17:28:39 +01002328 IEEE80211_AMPDU_TX_OPERATIONAL,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02002329};
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002330
2331/**
Johannes Berg4049e092011-09-29 16:04:32 +02002332 * enum ieee80211_frame_release_type - frame release reason
2333 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
Johannes Berg47086fc2011-09-29 16:04:33 +02002334 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2335 * frame received on trigger-enabled AC
Johannes Berg4049e092011-09-29 16:04:32 +02002336 */
2337enum ieee80211_frame_release_type {
2338 IEEE80211_FRAME_RELEASE_PSPOLL,
Johannes Berg47086fc2011-09-29 16:04:33 +02002339 IEEE80211_FRAME_RELEASE_UAPSD,
Johannes Berg4049e092011-09-29 16:04:32 +02002340};
2341
2342/**
Johannes Berg8f727ef2012-03-30 08:43:32 +02002343 * enum ieee80211_rate_control_changed - flags to indicate what changed
2344 *
2345 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
Johannes Berge1a0c6b2013-02-07 11:47:44 +01002346 * to this station changed. The actual bandwidth is in the station
2347 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2348 * flag changes, for HT and VHT the bandwidth field changes.
Johannes Berg8f727ef2012-03-30 08:43:32 +02002349 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
Antonio Quartullie687f612012-08-12 18:24:55 +02002350 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2351 * changed (in IBSS mode) due to discovering more information about
2352 * the peer.
Johannes Berg0af83d32012-12-27 18:55:36 +01002353 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2354 * by the peer
Johannes Berg8f727ef2012-03-30 08:43:32 +02002355 */
2356enum ieee80211_rate_control_changed {
2357 IEEE80211_RC_BW_CHANGED = BIT(0),
2358 IEEE80211_RC_SMPS_CHANGED = BIT(1),
Antonio Quartullie687f612012-08-12 18:24:55 +02002359 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
Johannes Berg0af83d32012-12-27 18:55:36 +01002360 IEEE80211_RC_NSS_CHANGED = BIT(3),
Johannes Berg8f727ef2012-03-30 08:43:32 +02002361};
2362
2363/**
Ilan Peerd339d5c2013-02-12 09:34:13 +02002364 * enum ieee80211_roc_type - remain on channel type
2365 *
2366 * With the support for multi channel contexts and multi channel operations,
2367 * remain on channel operations might be limited/deferred/aborted by other
2368 * flows/operations which have higher priority (and vise versa).
2369 * Specifying the ROC type can be used by devices to prioritize the ROC
2370 * operations compared to other operations/flows.
2371 *
2372 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2373 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2374 * for sending managment frames offchannel.
2375 */
2376enum ieee80211_roc_type {
2377 IEEE80211_ROC_TYPE_NORMAL = 0,
2378 IEEE80211_ROC_TYPE_MGMT_TX,
2379};
2380
2381/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002382 * struct ieee80211_ops - callbacks from mac80211 to the driver
2383 *
2384 * This structure contains various callbacks that the driver may
2385 * handle or, in some cases, must handle, for example to configure
2386 * the hardware to a new channel or to transmit a frame.
2387 *
2388 * @tx: Handler that 802.11 module calls for each transmitted frame.
2389 * skb contains the buffer starting from the IEEE 802.11 header.
2390 * The low-level driver should send the frame out based on
Johannes Bergeefce912008-05-17 00:57:13 +02002391 * configuration in the TX control data. This handler should,
Johannes Berg11127e92011-11-16 16:02:47 +01002392 * preferably, never fail and stop queues appropriately.
Johannes Berg11127e92011-11-16 16:02:47 +01002393 * Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002394 *
2395 * @start: Called before the first netdevice attached to the hardware
2396 * is enabled. This should turn on the hardware and must turn on
2397 * frame reception (for possibly enabled monitor interfaces.)
2398 * Returns negative error codes, these may be seen in userspace,
2399 * or zero.
2400 * When the device is started it should not have a MAC address
2401 * to avoid acknowledging frames before a non-monitor device
2402 * is added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002403 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002404 *
2405 * @stop: Called after last netdevice attached to the hardware
2406 * is disabled. This should turn off the hardware (at least
2407 * it must turn off frame reception.)
2408 * May be called right after add_interface if that rejects
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04002409 * an interface. If you added any work onto the mac80211 workqueue
2410 * you should ensure to cancel it on this callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002411 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002412 *
Johannes Bergeecc4802011-05-04 15:37:29 +02002413 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2414 * stop transmitting and doing any other configuration, and then
2415 * ask the device to suspend. This is only invoked when WoWLAN is
2416 * configured, otherwise the device is deconfigured completely and
2417 * reconfigured at resume time.
Johannes Berg2b4562d2011-07-02 00:02:01 +02002418 * The driver may also impose special conditions under which it
2419 * wants to use the "normal" suspend (deconfigure), say if it only
2420 * supports WoWLAN when the device is associated. In this case, it
2421 * must return 1 from this function.
Johannes Bergeecc4802011-05-04 15:37:29 +02002422 *
2423 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2424 * now resuming its operation, after this the device must be fully
2425 * functional again. If this returns an error, the only way out is
2426 * to also unregister the device. If it returns 1, then mac80211
2427 * will also go through the regular complete restart on resume.
2428 *
Johannes Bergd13e1412012-06-09 10:31:09 +02002429 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2430 * modified. The reason is that device_set_wakeup_enable() is
2431 * supposed to be called when the configuration changes, not only
2432 * in suspend().
2433 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002434 * @add_interface: Called when a netdevice attached to the hardware is
Bob Copelande37d4df2008-10-20 21:20:27 -04002435 * enabled. Because it is not called for monitor mode devices, @start
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002436 * and @stop must be implemented.
2437 * The driver should perform any initialization it needs before
2438 * the device can be enabled. The initial configuration for the
2439 * interface is given in the conf parameter.
2440 * The callback may refuse to add an interface by returning a
2441 * negative error code (which will be seen in userspace.)
Kalle Valoe1781ed2009-12-23 13:15:47 +01002442 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002443 *
Johannes Berg34d4bc42010-08-27 12:35:58 +02002444 * @change_interface: Called when a netdevice changes type. This callback
2445 * is optional, but only if it is supported can interface types be
2446 * switched while the interface is UP. The callback may sleep.
2447 * Note that while an interface is being switched, it will not be
2448 * found by the interface iteration callbacks.
2449 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002450 * @remove_interface: Notifies a driver that an interface is going down.
2451 * The @stop callback is called after this if it is the last interface
2452 * and no monitor interfaces are present.
2453 * When all interfaces are removed, the MAC address in the hardware
2454 * must be cleared so the device no longer acknowledges packets,
2455 * the mac_addr member of the conf structure is, however, set to the
2456 * MAC address of the device going away.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002457 * Hence, this callback must be implemented. It can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002458 *
2459 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2460 * function to change hardware configuration, e.g., channel.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05002461 * This function should never fail but returns a negative error code
Kalle Valoe1781ed2009-12-23 13:15:47 +01002462 * if it does. The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002463 *
Johannes Berg471b3ef2007-12-28 14:32:58 +01002464 * @bss_info_changed: Handler for configuration requests related to BSS
2465 * parameters that may vary during BSS's lifespan, and may affect low
2466 * level driver (e.g. assoc/disassoc status, erp parameters).
2467 * This function should not be used if no BSS has been set, unless
2468 * for association indication. The @changed parameter indicates which
Kalle Valoe1781ed2009-12-23 13:15:47 +01002469 * of the bss parameters has changed when a call is made. The callback
2470 * can sleep.
Johannes Berg471b3ef2007-12-28 14:32:58 +01002471 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02002472 * @prepare_multicast: Prepare for multicast filter configuration.
2473 * This callback is optional, and its return value is passed
2474 * to configure_filter(). This callback must be atomic.
2475 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002476 * @configure_filter: Configure the device's RX filter.
2477 * See the section "Frame filtering" for more information.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002478 * This callback must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002479 *
Luis R. Rodriguez546c80c92008-08-14 11:43:20 -07002480 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
Johannes Berg17741cd2008-09-11 00:02:02 +02002481 * must be set or cleared for a given STA. Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002482 *
2483 * @set_key: See the section "Hardware crypto acceleration"
Kalle Valoe1781ed2009-12-23 13:15:47 +01002484 * This callback is only called between add_interface and
2485 * remove_interface calls, i.e. while the given virtual interface
Johannes Bergdc822b52008-12-29 12:55:09 +01002486 * is enabled.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05002487 * Returns a negative error code if the key can't be added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002488 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002489 *
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02002490 * @update_tkip_key: See the section "Hardware crypto acceleration"
2491 * This callback will be called in the context of Rx. Called for drivers
2492 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
Kalle Valoeb807fb2010-01-24 14:55:12 +02002493 * The callback must be atomic.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02002494 *
Johannes Bergc68f4b82011-07-05 16:35:41 +02002495 * @set_rekey_data: If the device supports GTK rekeying, for example while the
2496 * host is suspended, it can assign this callback to retrieve the data
2497 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2498 * After rekeying was done it should (for example during resume) notify
2499 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2500 *
Yoni Divinskyde5fad82012-05-30 11:36:39 +03002501 * @set_default_unicast_key: Set the default (unicast) key index, useful for
2502 * WEP when the device sends data packets autonomously, e.g. for ARP
2503 * offloading. The index can be 0-3, or -1 for unsetting it.
2504 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002505 * @hw_scan: Ask the hardware to service the scan request, no need to start
Johannes Berg8318d782008-01-24 19:38:38 +01002506 * the scan state machine in stack. The scan must honour the channel
Kalle Valo9050bdd2009-03-22 21:57:21 +02002507 * configuration done by the regulatory agent in the wiphy's
2508 * registered bands. The hardware (or the driver) needs to make sure
Johannes Bergde95a542009-04-01 11:58:36 +02002509 * that power save is disabled.
2510 * The @req ie/ie_len members are rewritten by mac80211 to contain the
2511 * entire IEs after the SSID, so that drivers need not look at these
2512 * at all but just send them after the SSID -- mac80211 includes the
2513 * (extended) supported rates and HT information (where applicable).
2514 * When the scan finishes, ieee80211_scan_completed() must be called;
2515 * note that it also must be called when the scan cannot finish due to
2516 * any error unless this callback returned a negative error code.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002517 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002518 *
Eliad Pellerb8564392011-06-13 12:47:30 +03002519 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2520 * The driver should ask the hardware to cancel the scan (if possible),
2521 * but the scan will be completed only after the driver will call
2522 * ieee80211_scan_completed().
2523 * This callback is needed for wowlan, to prevent enqueueing a new
2524 * scan_work after the low-level driver was already suspended.
2525 * The callback can sleep.
2526 *
Luciano Coelho79f460c2011-05-11 17:09:36 +03002527 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2528 * specific intervals. The driver must call the
2529 * ieee80211_sched_scan_results() function whenever it finds results.
2530 * This process will continue until sched_scan_stop is called.
2531 *
2532 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
Johannes Berg37e33082014-02-17 10:48:17 +01002533 * In this case, ieee80211_sched_scan_stopped() must not be called.
Luciano Coelho79f460c2011-05-11 17:09:36 +03002534 *
Michael Buesch80e775b2009-02-20 15:37:03 +01002535 * @sw_scan_start: Notifier function that is called just before a software scan
2536 * is started. Can be NULL, if the driver doesn't need this notification.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002537 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01002538 *
Kalle Valoe1781ed2009-12-23 13:15:47 +01002539 * @sw_scan_complete: Notifier function that is called just after a
2540 * software scan finished. Can be NULL, if the driver doesn't need
2541 * this notification.
2542 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01002543 *
Bob Copeland6dd1bf32009-01-08 21:00:34 -05002544 * @get_stats: Return low-level statistics.
2545 * Returns zero if statistics are available.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002546 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002547 *
Johannes Berg62da92f2007-12-19 02:03:31 +01002548 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
2549 * callback should be provided to read the TKIP transmit IVs (both IV32
2550 * and IV16) for the given key from hardware.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002551 * The callback must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002552 *
Arik Nemtsovf23a4782010-11-08 11:51:06 +02002553 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
2554 * if the device does fragmentation by itself; if this callback is
2555 * implemented then the stack will not do fragmentation.
2556 * The callback can sleep.
2557 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002558 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
Kalle Valoe1781ed2009-12-23 13:15:47 +01002559 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002560 *
Johannes Berg34e89502010-02-03 13:59:58 +01002561 * @sta_add: Notifies low level driver about addition of an associated station,
2562 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2563 *
2564 * @sta_remove: Notifies low level driver about removal of an associated
Johannes Berg6a9d1b92013-12-04 22:39:17 +01002565 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
2566 * returns it isn't safe to use the pointer, not even RCU protected;
2567 * no RCU grace period is guaranteed between returning here and freeing
2568 * the station. See @sta_pre_rcu_remove if needed.
2569 * This callback can sleep.
Johannes Berg34e89502010-02-03 13:59:58 +01002570 *
Sujith Manoharan77d2ece2012-11-20 08:46:02 +05302571 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
2572 * when a station is added to mac80211's station list. This callback
2573 * and @sta_remove_debugfs should be within a CONFIG_MAC80211_DEBUGFS
2574 * conditional. This callback can sleep.
2575 *
2576 * @sta_remove_debugfs: Remove the debugfs files which were added using
2577 * @sta_add_debugfs. This callback can sleep.
2578 *
Johannes Berg34e89502010-02-03 13:59:58 +01002579 * @sta_notify: Notifies low level driver about power state transition of an
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02002580 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
2581 * in AP mode, this callback will not be called when the flag
2582 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
Christian Lamparter4571d3b2008-11-30 00:48:41 +01002583 *
Johannes Bergf09603a2012-01-20 13:55:21 +01002584 * @sta_state: Notifies low level driver about state transition of a
2585 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
2586 * This callback is mutually exclusive with @sta_add/@sta_remove.
2587 * It must not fail for down transitions but may fail for transitions
Johannes Berg6a9d1b92013-12-04 22:39:17 +01002588 * up the list of states. Also note that after the callback returns it
2589 * isn't safe to use the pointer, not even RCU protected - no RCU grace
2590 * period is guaranteed between returning here and freeing the station.
2591 * See @sta_pre_rcu_remove if needed.
2592 * The callback can sleep.
2593 *
2594 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
2595 * synchronisation. This is useful if a driver needs to have station
2596 * pointers protected using RCU, it can then use this call to clear
2597 * the pointers instead of waiting for an RCU grace period to elapse
2598 * in @sta_state.
Johannes Bergf09603a2012-01-20 13:55:21 +01002599 * The callback can sleep.
2600 *
Johannes Berg8f727ef2012-03-30 08:43:32 +02002601 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
2602 * used to transmit to the station. The changes are advertised with bits
2603 * from &enum ieee80211_rate_control_changed and the values are reflected
2604 * in the station data. This callback should only be used when the driver
2605 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
2606 * otherwise the rate control algorithm is notified directly.
2607 * Must be atomic.
2608 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002609 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
Johannes Bergfe3fa822008-09-08 11:05:09 +02002610 * bursting) for a hardware TX queue.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05002611 * Returns a negative error code on failure.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002612 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002613 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002614 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01002615 * this is only used for IBSS mode BSSID merging and debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01002616 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002617 * The callback can sleep.
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01002618 *
2619 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
Johannes Bergad24b0d2013-07-05 11:53:28 +02002620 * Currently, this is only used for IBSS mode debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01002621 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002622 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002623 *
2624 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
2625 * with other STAs in the IBSS. This is only used in IBSS mode. This
2626 * function is optional if the firmware/hardware takes full care of
2627 * TSF synchronization.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002628 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002629 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002630 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
2631 * This is needed only for IBSS mode and the result of this function is
2632 * used to determine whether to reply to Probe Requests.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05002633 * Returns non-zero if this device sent the last beacon.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002634 * The callback can sleep.
Ron Rindjunskyd3c990f2007-11-26 16:14:34 +02002635 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02002636 * @ampdu_action: Perform a certain A-MPDU action
2637 * The RA/TID combination determines the destination and TID we want
2638 * the ampdu action to be performed for. The action is defined through
2639 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
Bob Copeland6dd1bf32009-01-08 21:00:34 -05002640 * is the first frame we expect to perform the action on. Notice
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002641 * that TX/RX_STOP can pass NULL for this parameter.
Johannes Berg0b01f032011-01-18 13:51:05 +01002642 * The @buf_size parameter is only valid when the action is set to
2643 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
Johannes Berg5312c3f2011-04-01 13:52:34 +02002644 * buffer size (number of subframes) for this session -- the driver
2645 * may neither send aggregates containing more subframes than this
2646 * nor send aggregates in a way that lost frames would exceed the
2647 * buffer size. If just limiting the aggregate size, this would be
2648 * possible with a buf_size of 8:
2649 * - TX: 1.....7
2650 * - RX: 2....7 (lost frame #1)
2651 * - TX: 8..1...
2652 * which is invalid since #1 was now re-transmitted well past the
2653 * buffer size of 8. Correct ways to retransmit #1 would be:
2654 * - TX: 1 or 18 or 81
2655 * Even "189" would be wrong since 1 could be lost again.
2656 *
Bob Copeland6dd1bf32009-01-08 21:00:34 -05002657 * Returns a negative error code on failure.
Johannes Berg85ad1812010-06-10 10:21:49 +02002658 * The callback can sleep.
Johannes Berg1f87f7d2009-06-02 13:01:41 +02002659 *
Randy Dunlap4e8998f2010-05-21 11:28:33 -07002660 * @get_survey: Return per-channel survey information
2661 *
Johannes Berg1f87f7d2009-06-02 13:01:41 +02002662 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
2663 * need to set wiphy->rfkill_poll to %true before registration,
2664 * and need to call wiphy_rfkill_set_hw_state() in the callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002665 * The callback can sleep.
Johannes Bergaff89a92009-07-01 21:26:51 +02002666 *
Lukáš Turek310bc672009-12-21 22:50:48 +01002667 * @set_coverage_class: Set slot time for given coverage class as specified
2668 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
2669 * accordingly. This callback is not required and may sleep.
2670 *
David Spinadel52981cd2013-07-31 18:06:22 +03002671 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
2672 * be %NULL. The callback can sleep.
Wey-Yi Guy71063f02011-05-20 09:05:54 -07002673 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
Johannes Berga80f7c02009-12-23 13:15:32 +01002674 *
2675 * @flush: Flush all pending frames from the hardware queue, making sure
Johannes Berg39ecc012013-02-13 12:11:00 +01002676 * that the hardware queues are empty. The @queues parameter is a bitmap
2677 * of queues to flush, which is useful if different virtual interfaces
2678 * use different hardware queues; it may also indicate all queues.
2679 * If the parameter @drop is set to %true, pending frames may be dropped.
Emmanuel Grumbach77be2c52014-03-27 11:30:29 +02002680 * Note that vif can be NULL.
Johannes Berg39ecc012013-02-13 12:11:00 +01002681 * The callback can sleep.
Johannes Berg5ce6e432010-05-11 16:20:57 +02002682 *
2683 * @channel_switch: Drivers that need (or want) to offload the channel
2684 * switch operation for CSAs received from the AP may implement this
2685 * callback. They must then call ieee80211_chswitch_done() to indicate
2686 * completion of the channel switch.
John W. Linville4e6cbfd2010-07-29 16:14:13 -04002687 *
Bruno Randolf79b1c462010-11-24 14:34:41 +09002688 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2689 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2690 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2691 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2692 *
2693 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
Johannes Berg4976b4e2011-01-04 13:02:32 +01002694 *
2695 * @remain_on_channel: Starts an off-channel period on the given channel, must
2696 * call back to ieee80211_ready_on_channel() when on that channel. Note
2697 * that normal channel traffic is not stopped as this is intended for hw
2698 * offload. Frames to transmit on the off-channel channel are transmitted
2699 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
2700 * duration (which will always be non-zero) expires, the driver must call
Johannes Berg196ac1c2012-06-05 14:28:40 +02002701 * ieee80211_remain_on_channel_expired().
Johannes Berg196ac1c2012-06-05 14:28:40 +02002702 * Note that this callback may be called while the device is in IDLE and
2703 * must be accepted in this case.
2704 * This callback may sleep.
Johannes Berg4976b4e2011-01-04 13:02:32 +01002705 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
2706 * aborted before it expires. This callback may sleep.
John W. Linville38c09152011-03-07 16:19:18 -05002707 *
2708 * @set_ringparam: Set tx and rx ring sizes.
2709 *
2710 * @get_ringparam: Get tx and rx ring current and maximum sizes.
Vivek Natarajane8306f92011-04-06 11:41:10 +05302711 *
2712 * @tx_frames_pending: Check if there is any pending frame in the hardware
2713 * queues before entering power save.
Sujith Manoharanbdbfd6b2011-04-27 16:56:51 +05302714 *
2715 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
2716 * when transmitting a frame. Currently only legacy rates are handled.
2717 * The callback can sleep.
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -07002718 * @rssi_callback: Notify driver when the average RSSI goes above/below
2719 * thresholds that were registered previously. The callback can sleep.
Johannes Berg4049e092011-09-29 16:04:32 +02002720 *
2721 * @release_buffered_frames: Release buffered frames according to the given
2722 * parameters. In the case where the driver buffers some frames for
2723 * sleeping stations mac80211 will use this callback to tell the driver
2724 * to release some frames, either for PS-poll or uAPSD.
Masanari Iidae2278672014-02-18 22:54:36 +09002725 * Note that if the @more_data parameter is %false the driver must check
Johannes Berg4049e092011-09-29 16:04:32 +02002726 * if there are more frames on the given TIDs, and if there are more than
2727 * the frames being released then it must still set the more-data bit in
2728 * the frame. If the @more_data parameter is %true, then of course the
2729 * more-data bit must always be set.
2730 * The @tids parameter tells the driver which TIDs to release frames
2731 * from, for PS-poll it will always have only a single bit set.
Johannes Bergdeeaee12011-09-29 16:04:35 +02002732 * In the case this is used for a PS-poll initiated release, the
2733 * @num_frames parameter will always be 1 so code can be shared. In
2734 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
2735 * on the TX status (and must report TX status) so that the PS-poll
2736 * period is properly ended. This is used to avoid sending multiple
2737 * responses for a retried PS-poll frame.
Johannes Berg4049e092011-09-29 16:04:32 +02002738 * In the case this is used for uAPSD, the @num_frames parameter may be
2739 * bigger than one, but the driver may send fewer frames (it must send
2740 * at least one, however). In this case it is also responsible for
Johannes Berg47086fc2011-09-29 16:04:33 +02002741 * setting the EOSP flag in the QoS header of the frames. Also, when the
2742 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
Johannes Berg37fbd902011-09-29 16:04:39 +02002743 * on the last frame in the SP. Alternatively, it may call the function
Johannes Berge9437892013-02-15 21:38:08 +01002744 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
Johannes Berg4049e092011-09-29 16:04:32 +02002745 * This callback must be atomic.
Johannes Berg40b96402011-09-29 16:04:38 +02002746 * @allow_buffered_frames: Prepare device to allow the given number of frames
2747 * to go out to the given station. The frames will be sent by mac80211
2748 * via the usual TX path after this call. The TX information for frames
Johannes Berg02f2f1a2012-02-27 12:18:30 +01002749 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
Johannes Berg40b96402011-09-29 16:04:38 +02002750 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
2751 * frames from multiple TIDs are released and the driver might reorder
2752 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
2753 * on the last frame and clear it on all others and also handle the EOSP
Johannes Berg37fbd902011-09-29 16:04:39 +02002754 * bit in the QoS header correctly. Alternatively, it can also call the
Johannes Berge9437892013-02-15 21:38:08 +01002755 * ieee80211_sta_eosp() function.
Johannes Berg40b96402011-09-29 16:04:38 +02002756 * The @tids parameter is a bitmap and tells the driver which TIDs the
2757 * frames will be on; it will at most have two bits set.
2758 * This callback must be atomic.
Ben Greeare3521142012-04-23 12:50:31 -07002759 *
2760 * @get_et_sset_count: Ethtool API to get string-set count.
2761 *
2762 * @get_et_stats: Ethtool API to get a set of u64 stats.
2763 *
2764 * @get_et_strings: Ethtool API to get a set of strings to describe stats
2765 * and perhaps other supported types of ethtool data-sets.
2766 *
Victor Goldenshtein66572cf2012-06-21 10:56:46 +03002767 * @get_rssi: Get current signal strength in dBm, the function is optional
2768 * and can sleep.
2769 *
Johannes Berga1845fc2012-06-27 13:18:36 +02002770 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
2771 * before associated. In multi-channel scenarios, a virtual interface is
2772 * bound to a channel before it is associated, but as it isn't associated
2773 * yet it need not necessarily be given airtime, in particular since any
2774 * transmission to a P2P GO needs to be synchronized against the GO's
2775 * powersave state. mac80211 will call this function before transmitting a
2776 * management frame prior to having successfully associated to allow the
2777 * driver to give it channel time for the transmission, to get a response
2778 * and to be able to synchronize with the GO.
2779 * The callback will be called before each transmission and upon return
2780 * mac80211 will transmit the frame right away.
2781 * The callback is optional and can (should!) sleep.
Michal Kaziorc3645ea2012-06-26 14:37:17 +02002782 *
Arik Nemtsovee10f2c2014-06-11 17:18:27 +03002783 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
2784 * a TDLS discovery-request, we expect a reply to arrive on the AP's
2785 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
2786 * setup-response is a direct packet not buffered by the AP.
2787 * mac80211 will call this function just before the transmission of a TDLS
2788 * discovery-request. The recommended period of protection is at least
2789 * 2 * (DTIM period).
2790 * The callback is optional and can sleep.
2791 *
Michal Kaziorc3645ea2012-06-26 14:37:17 +02002792 * @add_chanctx: Notifies device driver about new channel context creation.
2793 * @remove_chanctx: Notifies device driver about channel context destruction.
2794 * @change_chanctx: Notifies device driver about channel context changes that
2795 * may happen when combining different virtual interfaces on the same
2796 * channel context with different settings
2797 * @assign_vif_chanctx: Notifies device driver about channel context being bound
2798 * to vif. Possible use is for hw queue remapping.
2799 * @unassign_vif_chanctx: Notifies device driver about channel context being
2800 * unbound from vif.
Luciano Coelho1a5f0c12014-05-23 14:33:12 +03002801 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
2802 * another, as specified in the list of
2803 * @ieee80211_vif_chanctx_switch passed to the driver, according
2804 * to the mode defined in &ieee80211_chanctx_switch_mode.
2805 *
Johannes Berg10416382012-10-19 15:44:42 +02002806 * @start_ap: Start operation on the AP interface, this is called after all the
2807 * information in bss_conf is set and beacon can be retrieved. A channel
2808 * context is bound before this is called. Note that if the driver uses
2809 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
2810 * just "paused" for scanning/ROC, which is indicated by the beacon being
2811 * disabled/enabled via @bss_info_changed.
2812 * @stop_ap: Stop operation on the AP interface.
Johannes Berg9214ad72012-11-06 19:18:13 +01002813 *
2814 * @restart_complete: Called after a call to ieee80211_restart_hw(), when the
2815 * reconfiguration has completed. This can help the driver implement the
Johannes Berg8f21b0a2013-01-11 00:28:01 +01002816 * reconfiguration step. Also called when reconfiguring because the
2817 * driver's resume function returned 1, as this is just like an "inline"
2818 * hardware restart. This callback may sleep.
2819 *
Johannes Berga65240c2013-01-14 15:14:34 +01002820 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
2821 * Currently, this is only called for managed or P2P client interfaces.
2822 * This callback is optional; it must not sleep.
Simon Wunderlich73da7d52013-07-11 16:09:06 +02002823 *
2824 * @channel_switch_beacon: Starts a channel switch to a new channel.
2825 * Beacons are modified to include CSA or ECSA IEs before calling this
2826 * function. The corresponding count fields in these IEs must be
Luciano Coelho66e01cf2014-01-13 19:43:00 +02002827 * decremented, and when they reach 1 the driver must call
Simon Wunderlich73da7d52013-07-11 16:09:06 +02002828 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
2829 * get the csa counter decremented by mac80211, but must check if it is
Luciano Coelho66e01cf2014-01-13 19:43:00 +02002830 * 1 using ieee80211_csa_is_complete() after the beacon has been
Simon Wunderlich73da7d52013-07-11 16:09:06 +02002831 * transmitted and then call ieee80211_csa_finish().
Luciano Coelho66e01cf2014-01-13 19:43:00 +02002832 * If the CSA count starts as zero or 1, this function will not be called,
2833 * since there won't be any time to beacon before the switch anyway.
Simon Wunderlich73da7d52013-07-11 16:09:06 +02002834 *
Johannes Berg55fff502013-08-19 18:48:41 +02002835 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
2836 * information in bss_conf is set up and the beacon can be retrieved. A
2837 * channel context is bound before this is called.
2838 * @leave_ibss: Leave the IBSS again.
Antonio Quartullicca674d2014-05-19 21:53:20 +02002839 *
2840 * @get_expected_throughput: extract the expected throughput towards the
2841 * specified station. The returned value is expressed in Kbps. It returns 0
2842 * if the RC algorithm does not have proper data to provide.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002843 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002844struct ieee80211_ops {
Thomas Huehn36323f82012-07-23 21:33:42 +02002845 void (*tx)(struct ieee80211_hw *hw,
2846 struct ieee80211_tx_control *control,
2847 struct sk_buff *skb);
Johannes Berg4150c572007-09-17 01:29:23 -04002848 int (*start)(struct ieee80211_hw *hw);
Johannes Berg4150c572007-09-17 01:29:23 -04002849 void (*stop)(struct ieee80211_hw *hw);
Johannes Bergeecc4802011-05-04 15:37:29 +02002850#ifdef CONFIG_PM
2851 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
2852 int (*resume)(struct ieee80211_hw *hw);
Johannes Berg6d525632012-04-04 15:05:25 +02002853 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
Johannes Bergeecc4802011-05-04 15:37:29 +02002854#endif
Jiri Bencf0706e82007-05-05 11:45:53 -07002855 int (*add_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01002856 struct ieee80211_vif *vif);
Johannes Berg34d4bc42010-08-27 12:35:58 +02002857 int (*change_interface)(struct ieee80211_hw *hw,
2858 struct ieee80211_vif *vif,
Johannes Berg2ca27bc2010-09-16 14:58:23 +02002859 enum nl80211_iftype new_type, bool p2p);
Jiri Bencf0706e82007-05-05 11:45:53 -07002860 void (*remove_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01002861 struct ieee80211_vif *vif);
Johannes Berge8975582008-10-09 12:18:51 +02002862 int (*config)(struct ieee80211_hw *hw, u32 changed);
Johannes Berg471b3ef2007-12-28 14:32:58 +01002863 void (*bss_info_changed)(struct ieee80211_hw *hw,
2864 struct ieee80211_vif *vif,
2865 struct ieee80211_bss_conf *info,
2866 u32 changed);
Johannes Bergb2abb6e2011-07-19 10:39:53 +02002867
Johannes Berg10416382012-10-19 15:44:42 +02002868 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2869 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2870
Johannes Berg3ac64be2009-08-17 16:16:53 +02002871 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
Jiri Pirko22bedad32010-04-01 21:22:57 +00002872 struct netdev_hw_addr_list *mc_list);
Johannes Berg4150c572007-09-17 01:29:23 -04002873 void (*configure_filter)(struct ieee80211_hw *hw,
2874 unsigned int changed_flags,
2875 unsigned int *total_flags,
Johannes Berg3ac64be2009-08-17 16:16:53 +02002876 u64 multicast);
Johannes Berg17741cd2008-09-11 00:02:02 +02002877 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
2878 bool set);
Johannes Bergea49c352007-09-18 17:29:21 -04002879 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
Johannes Bergdc822b52008-12-29 12:55:09 +01002880 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
Johannes Berg11a843b2007-08-28 17:01:55 -04002881 struct ieee80211_key_conf *key);
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02002882 void (*update_tkip_key)(struct ieee80211_hw *hw,
Johannes Bergb3fbdcf2010-01-21 11:40:47 +01002883 struct ieee80211_vif *vif,
2884 struct ieee80211_key_conf *conf,
2885 struct ieee80211_sta *sta,
2886 u32 iv32, u16 *phase1key);
Johannes Bergc68f4b82011-07-05 16:35:41 +02002887 void (*set_rekey_data)(struct ieee80211_hw *hw,
2888 struct ieee80211_vif *vif,
2889 struct cfg80211_gtk_rekey_data *data);
Yoni Divinskyde5fad82012-05-30 11:36:39 +03002890 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
2891 struct ieee80211_vif *vif, int idx);
Johannes Berga060bbf2010-04-27 11:59:34 +02002892 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
David Spinadelc56ef672014-02-05 15:21:13 +02002893 struct ieee80211_scan_request *req);
Eliad Pellerb8564392011-06-13 12:47:30 +03002894 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
2895 struct ieee80211_vif *vif);
Luciano Coelho79f460c2011-05-11 17:09:36 +03002896 int (*sched_scan_start)(struct ieee80211_hw *hw,
2897 struct ieee80211_vif *vif,
2898 struct cfg80211_sched_scan_request *req,
David Spinadel633e2712014-02-06 16:15:23 +02002899 struct ieee80211_scan_ies *ies);
Johannes Berg37e33082014-02-17 10:48:17 +01002900 int (*sched_scan_stop)(struct ieee80211_hw *hw,
Luciano Coelho79f460c2011-05-11 17:09:36 +03002901 struct ieee80211_vif *vif);
Michael Buesch80e775b2009-02-20 15:37:03 +01002902 void (*sw_scan_start)(struct ieee80211_hw *hw);
2903 void (*sw_scan_complete)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07002904 int (*get_stats)(struct ieee80211_hw *hw,
2905 struct ieee80211_low_level_stats *stats);
Johannes Berg62da92f2007-12-19 02:03:31 +01002906 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
2907 u32 *iv32, u16 *iv16);
Arik Nemtsovf23a4782010-11-08 11:51:06 +02002908 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
Jiri Bencf0706e82007-05-05 11:45:53 -07002909 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
Johannes Berg34e89502010-02-03 13:59:58 +01002910 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2911 struct ieee80211_sta *sta);
2912 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2913 struct ieee80211_sta *sta);
Sujith Manoharan77d2ece2012-11-20 08:46:02 +05302914#ifdef CONFIG_MAC80211_DEBUGFS
2915 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
2916 struct ieee80211_vif *vif,
2917 struct ieee80211_sta *sta,
2918 struct dentry *dir);
2919 void (*sta_remove_debugfs)(struct ieee80211_hw *hw,
2920 struct ieee80211_vif *vif,
2921 struct ieee80211_sta *sta,
2922 struct dentry *dir);
2923#endif
Johannes Berg32bfd352007-12-19 01:31:26 +01002924 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02002925 enum sta_notify_cmd, struct ieee80211_sta *sta);
Johannes Bergf09603a2012-01-20 13:55:21 +01002926 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2927 struct ieee80211_sta *sta,
2928 enum ieee80211_sta_state old_state,
2929 enum ieee80211_sta_state new_state);
Johannes Berg6a9d1b92013-12-04 22:39:17 +01002930 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
2931 struct ieee80211_vif *vif,
2932 struct ieee80211_sta *sta);
Johannes Berg8f727ef2012-03-30 08:43:32 +02002933 void (*sta_rc_update)(struct ieee80211_hw *hw,
2934 struct ieee80211_vif *vif,
2935 struct ieee80211_sta *sta,
2936 u32 changed);
Eliad Peller8a3a3c82011-10-02 10:15:52 +02002937 int (*conf_tx)(struct ieee80211_hw *hw,
Johannes Berga3304b02012-03-28 11:04:24 +02002938 struct ieee80211_vif *vif, u16 ac,
Jiri Bencf0706e82007-05-05 11:45:53 -07002939 const struct ieee80211_tx_queue_params *params);
Eliad Peller37a41b42011-09-21 14:06:11 +03002940 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2941 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2942 u64 tsf);
2943 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07002944 int (*tx_last_beacon)(struct ieee80211_hw *hw);
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02002945 int (*ampdu_action)(struct ieee80211_hw *hw,
Johannes Bergc951ad32009-11-16 12:00:38 +01002946 struct ieee80211_vif *vif,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02002947 enum ieee80211_ampdu_mlme_action action,
Johannes Berg0b01f032011-01-18 13:51:05 +01002948 struct ieee80211_sta *sta, u16 tid, u16 *ssn,
2949 u8 buf_size);
Holger Schurig12897232010-04-19 10:23:57 +02002950 int (*get_survey)(struct ieee80211_hw *hw, int idx,
2951 struct survey_info *survey);
Johannes Berg1f87f7d2009-06-02 13:01:41 +02002952 void (*rfkill_poll)(struct ieee80211_hw *hw);
Lukáš Turek310bc672009-12-21 22:50:48 +01002953 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
Johannes Bergaff89a92009-07-01 21:26:51 +02002954#ifdef CONFIG_NL80211_TESTMODE
David Spinadel52981cd2013-07-31 18:06:22 +03002955 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2956 void *data, int len);
Wey-Yi Guy71063f02011-05-20 09:05:54 -07002957 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
2958 struct netlink_callback *cb,
2959 void *data, int len);
Johannes Bergaff89a92009-07-01 21:26:51 +02002960#endif
Emmanuel Grumbach77be2c52014-03-27 11:30:29 +02002961 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2962 u32 queues, bool drop);
Johannes Berg5ce6e432010-05-11 16:20:57 +02002963 void (*channel_switch)(struct ieee80211_hw *hw,
2964 struct ieee80211_channel_switch *ch_switch);
Bruno Randolf15d96752010-11-10 12:50:56 +09002965 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
2966 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
Johannes Berg21f83582010-12-18 17:20:47 +01002967
2968 int (*remain_on_channel)(struct ieee80211_hw *hw,
Eliad Peller49884562012-11-19 17:05:09 +02002969 struct ieee80211_vif *vif,
Johannes Berg21f83582010-12-18 17:20:47 +01002970 struct ieee80211_channel *chan,
Ilan Peerd339d5c2013-02-12 09:34:13 +02002971 int duration,
2972 enum ieee80211_roc_type type);
Johannes Berg21f83582010-12-18 17:20:47 +01002973 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
John W. Linville38c09152011-03-07 16:19:18 -05002974 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
2975 void (*get_ringparam)(struct ieee80211_hw *hw,
2976 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
Vivek Natarajane8306f92011-04-06 11:41:10 +05302977 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
Sujith Manoharanbdbfd6b2011-04-27 16:56:51 +05302978 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2979 const struct cfg80211_bitrate_mask *mask);
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -07002980 void (*rssi_callback)(struct ieee80211_hw *hw,
Emmanuel Grumbach887da912013-01-20 17:32:41 +02002981 struct ieee80211_vif *vif,
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -07002982 enum ieee80211_rssi_event rssi_event);
Johannes Berg4049e092011-09-29 16:04:32 +02002983
Johannes Berg40b96402011-09-29 16:04:38 +02002984 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
2985 struct ieee80211_sta *sta,
2986 u16 tids, int num_frames,
2987 enum ieee80211_frame_release_type reason,
2988 bool more_data);
Johannes Berg4049e092011-09-29 16:04:32 +02002989 void (*release_buffered_frames)(struct ieee80211_hw *hw,
2990 struct ieee80211_sta *sta,
2991 u16 tids, int num_frames,
2992 enum ieee80211_frame_release_type reason,
2993 bool more_data);
Ben Greeare3521142012-04-23 12:50:31 -07002994
2995 int (*get_et_sset_count)(struct ieee80211_hw *hw,
2996 struct ieee80211_vif *vif, int sset);
2997 void (*get_et_stats)(struct ieee80211_hw *hw,
2998 struct ieee80211_vif *vif,
2999 struct ethtool_stats *stats, u64 *data);
3000 void (*get_et_strings)(struct ieee80211_hw *hw,
3001 struct ieee80211_vif *vif,
3002 u32 sset, u8 *data);
Victor Goldenshtein66572cf2012-06-21 10:56:46 +03003003 int (*get_rssi)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3004 struct ieee80211_sta *sta, s8 *rssi_dbm);
Johannes Berga1845fc2012-06-27 13:18:36 +02003005
3006 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
3007 struct ieee80211_vif *vif);
Michal Kaziorc3645ea2012-06-26 14:37:17 +02003008
Arik Nemtsovee10f2c2014-06-11 17:18:27 +03003009 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
3010 struct ieee80211_vif *vif);
3011
Michal Kaziorc3645ea2012-06-26 14:37:17 +02003012 int (*add_chanctx)(struct ieee80211_hw *hw,
3013 struct ieee80211_chanctx_conf *ctx);
3014 void (*remove_chanctx)(struct ieee80211_hw *hw,
3015 struct ieee80211_chanctx_conf *ctx);
3016 void (*change_chanctx)(struct ieee80211_hw *hw,
3017 struct ieee80211_chanctx_conf *ctx,
3018 u32 changed);
3019 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
3020 struct ieee80211_vif *vif,
3021 struct ieee80211_chanctx_conf *ctx);
3022 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
3023 struct ieee80211_vif *vif,
3024 struct ieee80211_chanctx_conf *ctx);
Luciano Coelho1a5f0c12014-05-23 14:33:12 +03003025 int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
3026 struct ieee80211_vif_chanctx_switch *vifs,
3027 int n_vifs,
3028 enum ieee80211_chanctx_switch_mode mode);
Johannes Berg9214ad72012-11-06 19:18:13 +01003029
3030 void (*restart_complete)(struct ieee80211_hw *hw);
Johannes Berga65240c2013-01-14 15:14:34 +01003031
3032#if IS_ENABLED(CONFIG_IPV6)
3033 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
3034 struct ieee80211_vif *vif,
3035 struct inet6_dev *idev);
3036#endif
Simon Wunderlich73da7d52013-07-11 16:09:06 +02003037 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
3038 struct ieee80211_vif *vif,
3039 struct cfg80211_chan_def *chandef);
Johannes Berg55fff502013-08-19 18:48:41 +02003040
3041 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3042 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Antonio Quartullicca674d2014-05-19 21:53:20 +02003043 u32 (*get_expected_throughput)(struct ieee80211_sta *sta);
Jiri Bencf0706e82007-05-05 11:45:53 -07003044};
3045
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003046/**
3047 * ieee80211_alloc_hw - Allocate a new hardware device
3048 *
3049 * This must be called once for each hardware device. The returned pointer
3050 * must be used to refer to this device when calling other functions.
3051 * mac80211 allocates a private data area for the driver pointed to by
3052 * @priv in &struct ieee80211_hw, the size of this area is given as
3053 * @priv_data_len.
3054 *
3055 * @priv_data_len: length of private data
3056 * @ops: callbacks for this device
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003057 *
3058 * Return: A pointer to the new hardware device, or %NULL on error.
Jiri Bencf0706e82007-05-05 11:45:53 -07003059 */
3060struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
3061 const struct ieee80211_ops *ops);
3062
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003063/**
3064 * ieee80211_register_hw - Register hardware device
3065 *
Johannes Bergdbbea672008-02-26 14:34:06 +01003066 * You must call this function before any other functions in
3067 * mac80211. Note that before a hardware can be registered, you
3068 * need to fill the contained wiphy's information.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003069 *
3070 * @hw: the device to register as returned by ieee80211_alloc_hw()
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003071 *
3072 * Return: 0 on success. An error code otherwise.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003073 */
Jiri Bencf0706e82007-05-05 11:45:53 -07003074int ieee80211_register_hw(struct ieee80211_hw *hw);
3075
Johannes Berge1e54062010-11-30 08:58:45 +01003076/**
3077 * struct ieee80211_tpt_blink - throughput blink description
3078 * @throughput: throughput in Kbit/sec
3079 * @blink_time: blink time in milliseconds
3080 * (full cycle, ie. one off + one on period)
3081 */
3082struct ieee80211_tpt_blink {
3083 int throughput;
3084 int blink_time;
3085};
3086
Johannes Berg67408c82010-11-30 08:59:23 +01003087/**
3088 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
3089 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
3090 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
3091 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
3092 * interface is connected in some way, including being an AP
3093 */
3094enum ieee80211_tpt_led_trigger_flags {
3095 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
3096 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
3097 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
3098};
3099
Jiri Bencf0706e82007-05-05 11:45:53 -07003100#ifdef CONFIG_MAC80211_LEDS
Joe Perches10dd9b72013-07-31 17:31:37 -07003101char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
3102char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
3103char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
3104char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
3105char *__ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
3106 unsigned int flags,
3107 const struct ieee80211_tpt_blink *blink_table,
3108 unsigned int blink_table_len);
Jiri Bencf0706e82007-05-05 11:45:53 -07003109#endif
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003110/**
3111 * ieee80211_get_tx_led_name - get name of TX LED
3112 *
3113 * mac80211 creates a transmit LED trigger for each wireless hardware
3114 * that can be used to drive LEDs if your driver registers a LED device.
3115 * This function returns the name (or %NULL if not configured for LEDs)
3116 * of the trigger so you can automatically link the LED device.
3117 *
3118 * @hw: the hardware to get the LED trigger name for
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003119 *
3120 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003121 */
Jiri Bencf0706e82007-05-05 11:45:53 -07003122static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
3123{
3124#ifdef CONFIG_MAC80211_LEDS
3125 return __ieee80211_get_tx_led_name(hw);
3126#else
3127 return NULL;
3128#endif
3129}
3130
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003131/**
3132 * ieee80211_get_rx_led_name - get name of RX LED
3133 *
3134 * mac80211 creates a receive LED trigger for each wireless hardware
3135 * that can be used to drive LEDs if your driver registers a LED device.
3136 * This function returns the name (or %NULL if not configured for LEDs)
3137 * of the trigger so you can automatically link the LED device.
3138 *
3139 * @hw: the hardware to get the LED trigger name for
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003140 *
3141 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003142 */
Jiri Bencf0706e82007-05-05 11:45:53 -07003143static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
3144{
3145#ifdef CONFIG_MAC80211_LEDS
3146 return __ieee80211_get_rx_led_name(hw);
3147#else
3148 return NULL;
3149#endif
3150}
3151
Ivo van Doorncdcb0062008-01-07 19:45:24 +01003152/**
3153 * ieee80211_get_assoc_led_name - get name of association LED
3154 *
3155 * mac80211 creates a association LED trigger for each wireless hardware
3156 * that can be used to drive LEDs if your driver registers a LED device.
3157 * This function returns the name (or %NULL if not configured for LEDs)
3158 * of the trigger so you can automatically link the LED device.
3159 *
3160 * @hw: the hardware to get the LED trigger name for
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003161 *
3162 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
Ivo van Doorncdcb0062008-01-07 19:45:24 +01003163 */
Michael Buesch47f0c502007-09-27 15:10:44 +02003164static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
3165{
3166#ifdef CONFIG_MAC80211_LEDS
3167 return __ieee80211_get_assoc_led_name(hw);
3168#else
3169 return NULL;
3170#endif
3171}
3172
Ivo van Doorncdcb0062008-01-07 19:45:24 +01003173/**
3174 * ieee80211_get_radio_led_name - get name of radio LED
3175 *
3176 * mac80211 creates a radio change LED trigger for each wireless hardware
3177 * that can be used to drive LEDs if your driver registers a LED device.
3178 * This function returns the name (or %NULL if not configured for LEDs)
3179 * of the trigger so you can automatically link the LED device.
3180 *
3181 * @hw: the hardware to get the LED trigger name for
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003182 *
3183 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
Ivo van Doorncdcb0062008-01-07 19:45:24 +01003184 */
3185static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
3186{
3187#ifdef CONFIG_MAC80211_LEDS
3188 return __ieee80211_get_radio_led_name(hw);
3189#else
3190 return NULL;
3191#endif
3192}
Michael Buesch47f0c502007-09-27 15:10:44 +02003193
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003194/**
Johannes Berge1e54062010-11-30 08:58:45 +01003195 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
3196 * @hw: the hardware to create the trigger for
Johannes Berg67408c82010-11-30 08:59:23 +01003197 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
Johannes Berge1e54062010-11-30 08:58:45 +01003198 * @blink_table: the blink table -- needs to be ordered by throughput
3199 * @blink_table_len: size of the blink table
3200 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003201 * Return: %NULL (in case of error, or if no LED triggers are
3202 * configured) or the name of the new trigger.
3203 *
3204 * Note: This function must be called before ieee80211_register_hw().
Johannes Berge1e54062010-11-30 08:58:45 +01003205 */
3206static inline char *
Johannes Berg67408c82010-11-30 08:59:23 +01003207ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
Johannes Berge1e54062010-11-30 08:58:45 +01003208 const struct ieee80211_tpt_blink *blink_table,
3209 unsigned int blink_table_len)
3210{
3211#ifdef CONFIG_MAC80211_LEDS
Johannes Berg67408c82010-11-30 08:59:23 +01003212 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
Johannes Berge1e54062010-11-30 08:58:45 +01003213 blink_table_len);
3214#else
3215 return NULL;
3216#endif
3217}
3218
3219/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003220 * ieee80211_unregister_hw - Unregister a hardware device
3221 *
3222 * This function instructs mac80211 to free allocated resources
3223 * and unregister netdevices from the networking subsystem.
3224 *
3225 * @hw: the hardware to unregister
3226 */
Jiri Bencf0706e82007-05-05 11:45:53 -07003227void ieee80211_unregister_hw(struct ieee80211_hw *hw);
3228
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003229/**
3230 * ieee80211_free_hw - free hardware descriptor
3231 *
3232 * This function frees everything that was allocated, including the
3233 * private data for the driver. You must call ieee80211_unregister_hw()
Randy Dunlap6ef307b2008-07-03 13:52:18 -07003234 * before calling this function.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003235 *
3236 * @hw: the hardware to free
3237 */
Jiri Bencf0706e82007-05-05 11:45:53 -07003238void ieee80211_free_hw(struct ieee80211_hw *hw);
3239
Johannes Bergf2753dd2009-04-14 10:09:24 +02003240/**
3241 * ieee80211_restart_hw - restart hardware completely
3242 *
3243 * Call this function when the hardware was restarted for some reason
3244 * (hardware error, ...) and the driver is unable to restore its state
3245 * by itself. mac80211 assumes that at this point the driver/hardware
3246 * is completely uninitialised and stopped, it starts the process by
3247 * calling the ->start() operation. The driver will need to reset all
3248 * internal state that it has prior to calling this function.
3249 *
3250 * @hw: the hardware to restart
3251 */
3252void ieee80211_restart_hw(struct ieee80211_hw *hw);
3253
Johannes Berg06d181a2014-02-04 20:51:09 +01003254/**
3255 * ieee80211_napi_add - initialize mac80211 NAPI context
3256 * @hw: the hardware to initialize the NAPI context on
3257 * @napi: the NAPI context to initialize
3258 * @napi_dev: dummy NAPI netdevice, here to not waste the space if the
3259 * driver doesn't use NAPI
3260 * @poll: poll function
3261 * @weight: default weight
John W. Linville4e6cbfd2010-07-29 16:14:13 -04003262 *
Johannes Berg06d181a2014-02-04 20:51:09 +01003263 * See also netif_napi_add().
John W. Linville4e6cbfd2010-07-29 16:14:13 -04003264 */
Johannes Berg06d181a2014-02-04 20:51:09 +01003265void ieee80211_napi_add(struct ieee80211_hw *hw, struct napi_struct *napi,
3266 struct net_device *napi_dev,
3267 int (*poll)(struct napi_struct *, int),
3268 int weight);
John W. Linville4e6cbfd2010-07-29 16:14:13 -04003269
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003270/**
3271 * ieee80211_rx - receive frame
3272 *
3273 * Use this function to hand received frames to mac80211. The receive
Zhu Yie3cf8b32010-03-29 17:35:07 +08003274 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3275 * paged @skb is used, the driver is recommended to put the ieee80211
3276 * header of the frame on the linear part of the @skb to avoid memory
3277 * allocation and/or memcpy by the stack.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003278 *
Johannes Berg2485f712008-02-25 16:27:41 +01003279 * This function may not be called in IRQ context. Calls to this function
Kalle Valoe36e49f2009-10-13 20:33:13 +03003280 * for a single hardware must be synchronized against each other. Calls to
3281 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
Felix Fietkauf6b3d852013-05-03 10:01:03 +02003282 * mixed for a single hardware. Must not run concurrently with
3283 * ieee80211_tx_status() or ieee80211_tx_status_ni().
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003284 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03003285 * In process context use instead ieee80211_rx_ni().
Johannes Bergd20ef632009-10-11 15:10:40 +02003286 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003287 * @hw: the hardware this frame came in on
3288 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003289 */
John W. Linville103bf9f2009-08-20 16:34:15 -04003290void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003291
3292/**
3293 * ieee80211_rx_irqsafe - receive frame
3294 *
3295 * Like ieee80211_rx() but can be called in IRQ context
Johannes Berg2485f712008-02-25 16:27:41 +01003296 * (internally defers to a tasklet.)
3297 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03003298 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
Felix Fietkauf6b3d852013-05-03 10:01:03 +02003299 * be mixed for a single hardware.Must not run concurrently with
3300 * ieee80211_tx_status() or ieee80211_tx_status_ni().
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003301 *
3302 * @hw: the hardware this frame came in on
3303 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003304 */
Johannes Bergf1d58c22009-06-17 13:13:00 +02003305void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07003306
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003307/**
Kalle Valoe36e49f2009-10-13 20:33:13 +03003308 * ieee80211_rx_ni - receive frame (in process context)
3309 *
3310 * Like ieee80211_rx() but can be called in process context
3311 * (internally disables bottom halves).
3312 *
3313 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
Felix Fietkauf6b3d852013-05-03 10:01:03 +02003314 * not be mixed for a single hardware. Must not run concurrently with
3315 * ieee80211_tx_status() or ieee80211_tx_status_ni().
Kalle Valoe36e49f2009-10-13 20:33:13 +03003316 *
3317 * @hw: the hardware this frame came in on
3318 * @skb: the buffer to receive, owned by mac80211 after this call
3319 */
3320static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
3321 struct sk_buff *skb)
3322{
3323 local_bh_disable();
3324 ieee80211_rx(hw, skb);
3325 local_bh_enable();
3326}
3327
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02003328/**
3329 * ieee80211_sta_ps_transition - PS transition for connected sta
3330 *
3331 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
3332 * flag set, use this function to inform mac80211 about a connected station
3333 * entering/leaving PS mode.
3334 *
3335 * This function may not be called in IRQ context or with softirqs enabled.
3336 *
3337 * Calls to this function for a single hardware must be synchronized against
3338 * each other.
3339 *
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02003340 * @sta: currently connected sta
3341 * @start: start or stop PS
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003342 *
3343 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02003344 */
3345int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
3346
3347/**
3348 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
3349 * (in process context)
3350 *
3351 * Like ieee80211_sta_ps_transition() but can be called in process context
3352 * (internally disables bottom halves). Concurrent call restriction still
3353 * applies.
3354 *
3355 * @sta: currently connected sta
3356 * @start: start or stop PS
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003357 *
3358 * Return: Like ieee80211_sta_ps_transition().
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02003359 */
3360static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
3361 bool start)
3362{
3363 int ret;
3364
3365 local_bh_disable();
3366 ret = ieee80211_sta_ps_transition(sta, start);
3367 local_bh_enable();
3368
3369 return ret;
3370}
3371
Gertjan van Wingerded24deb22009-12-04 23:46:54 +01003372/*
3373 * The TX headroom reserved by mac80211 for its own tx_status functions.
3374 * This is enough for the radiotap header.
3375 */
Helmut Schaa7f2a5e22011-10-11 18:08:55 +02003376#define IEEE80211_TX_STATUS_HEADROOM 14
Gertjan van Wingerded24deb22009-12-04 23:46:54 +01003377
Kalle Valoe36e49f2009-10-13 20:33:13 +03003378/**
Johannes Berg042ec452011-09-29 16:04:26 +02003379 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
Randy Dunlapbdfbe802011-05-22 17:22:45 -07003380 * @sta: &struct ieee80211_sta pointer for the sleeping station
Johannes Berg042ec452011-09-29 16:04:26 +02003381 * @tid: the TID that has buffered frames
3382 * @buffered: indicates whether or not frames are buffered for this TID
Felix Fietkaudcf55fb2011-04-17 17:45:00 +02003383 *
3384 * If a driver buffers frames for a powersave station instead of passing
Johannes Berg042ec452011-09-29 16:04:26 +02003385 * them back to mac80211 for retransmission, the station may still need
3386 * to be told that there are buffered frames via the TIM bit.
Felix Fietkaudcf55fb2011-04-17 17:45:00 +02003387 *
Johannes Berg042ec452011-09-29 16:04:26 +02003388 * This function informs mac80211 whether or not there are frames that are
3389 * buffered in the driver for a given TID; mac80211 can then use this data
3390 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
3391 * call! Beware of the locking!)
3392 *
3393 * If all frames are released to the station (due to PS-poll or uAPSD)
3394 * then the driver needs to inform mac80211 that there no longer are
3395 * frames buffered. However, when the station wakes up mac80211 assumes
3396 * that all buffered frames will be transmitted and clears this data,
3397 * drivers need to make sure they inform mac80211 about all buffered
3398 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
3399 *
3400 * Note that technically mac80211 only needs to know this per AC, not per
3401 * TID, but since driver buffering will inevitably happen per TID (since
3402 * it is related to aggregation) it is easier to make mac80211 map the
3403 * TID to the AC as required instead of keeping track in all drivers that
3404 * use this API.
Felix Fietkaudcf55fb2011-04-17 17:45:00 +02003405 */
Johannes Berg042ec452011-09-29 16:04:26 +02003406void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
3407 u8 tid, bool buffered);
Felix Fietkaudcf55fb2011-04-17 17:45:00 +02003408
3409/**
Felix Fietkau0d528d82013-04-22 16:14:41 +02003410 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
3411 *
3412 * Call this function in a driver with per-packet rate selection support
3413 * to combine the rate info in the packet tx info with the most recent
3414 * rate selection table for the station entry.
3415 *
3416 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3417 * @sta: the receiver station to which this packet is sent.
3418 * @skb: the frame to be transmitted.
3419 * @dest: buffer for extracted rate/retry information
3420 * @max_rates: maximum number of rates to fetch
3421 */
3422void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
3423 struct ieee80211_sta *sta,
3424 struct sk_buff *skb,
3425 struct ieee80211_tx_rate *dest,
3426 int max_rates);
3427
3428/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003429 * ieee80211_tx_status - transmit status callback
3430 *
3431 * Call this function for all transmitted frames after they have been
3432 * transmitted. It is permissible to not call this function for
3433 * multicast frames but this can affect statistics.
3434 *
Johannes Berg2485f712008-02-25 16:27:41 +01003435 * This function may not be called in IRQ context. Calls to this function
3436 * for a single hardware must be synchronized against each other. Calls
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01003437 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
Felix Fietkauf6b3d852013-05-03 10:01:03 +02003438 * may not be mixed for a single hardware. Must not run concurrently with
3439 * ieee80211_rx() or ieee80211_rx_ni().
Johannes Berg2485f712008-02-25 16:27:41 +01003440 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003441 * @hw: the hardware the frame was transmitted by
3442 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003443 */
Jiri Bencf0706e82007-05-05 11:45:53 -07003444void ieee80211_tx_status(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02003445 struct sk_buff *skb);
Johannes Berg2485f712008-02-25 16:27:41 +01003446
3447/**
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01003448 * ieee80211_tx_status_ni - transmit status callback (in process context)
3449 *
3450 * Like ieee80211_tx_status() but can be called in process context.
3451 *
3452 * Calls to this function, ieee80211_tx_status() and
3453 * ieee80211_tx_status_irqsafe() may not be mixed
3454 * for a single hardware.
3455 *
3456 * @hw: the hardware the frame was transmitted by
3457 * @skb: the frame that was transmitted, owned by mac80211 after this call
3458 */
3459static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
3460 struct sk_buff *skb)
3461{
3462 local_bh_disable();
3463 ieee80211_tx_status(hw, skb);
3464 local_bh_enable();
3465}
3466
3467/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07003468 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
Johannes Berg2485f712008-02-25 16:27:41 +01003469 *
3470 * Like ieee80211_tx_status() but can be called in IRQ context
3471 * (internally defers to a tasklet.)
3472 *
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01003473 * Calls to this function, ieee80211_tx_status() and
3474 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
Johannes Berg2485f712008-02-25 16:27:41 +01003475 *
3476 * @hw: the hardware the frame was transmitted by
3477 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg2485f712008-02-25 16:27:41 +01003478 */
Jiri Bencf0706e82007-05-05 11:45:53 -07003479void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02003480 struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07003481
3482/**
Arik Nemtsov8178d382011-04-18 14:22:28 +03003483 * ieee80211_report_low_ack - report non-responding station
3484 *
3485 * When operating in AP-mode, call this function to report a non-responding
3486 * connected STA.
3487 *
3488 * @sta: the non-responding connected sta
3489 * @num_packets: number of packets sent to @sta without a response
3490 */
3491void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
3492
Andrei Otcheretianski1af586c2014-05-09 14:11:50 +03003493#define IEEE80211_MAX_CSA_COUNTERS_NUM 2
3494
Arik Nemtsov8178d382011-04-18 14:22:28 +03003495/**
Andrei Otcheretianski6ec8c332014-05-09 14:11:49 +03003496 * struct ieee80211_mutable_offsets - mutable beacon offsets
3497 * @tim_offset: position of TIM element
3498 * @tim_length: size of TIM element
Luciano Coelho8d77ec82014-05-15 20:32:08 +03003499 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets
3500 * to CSA counters. This array can contain zero values which
3501 * should be ignored.
Andrei Otcheretianski6ec8c332014-05-09 14:11:49 +03003502 */
3503struct ieee80211_mutable_offsets {
3504 u16 tim_offset;
3505 u16 tim_length;
Andrei Otcheretianski1af586c2014-05-09 14:11:50 +03003506
3507 u16 csa_counter_offs[IEEE80211_MAX_CSA_COUNTERS_NUM];
Andrei Otcheretianski6ec8c332014-05-09 14:11:49 +03003508};
3509
3510/**
3511 * ieee80211_beacon_get_template - beacon template generation function
3512 * @hw: pointer obtained from ieee80211_alloc_hw().
3513 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3514 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
3515 * receive the offsets that may be updated by the driver.
3516 *
3517 * If the driver implements beaconing modes, it must use this function to
3518 * obtain the beacon template.
3519 *
3520 * This function should be used if the beacon frames are generated by the
3521 * device, and then the driver must use the returned beacon as the template
Andrei Otcheretianski1af586c2014-05-09 14:11:50 +03003522 * The driver or the device are responsible to update the DTIM and, when
3523 * applicable, the CSA count.
Andrei Otcheretianski6ec8c332014-05-09 14:11:49 +03003524 *
3525 * The driver is responsible for freeing the returned skb.
3526 *
3527 * Return: The beacon template. %NULL on error.
3528 */
3529struct sk_buff *
3530ieee80211_beacon_get_template(struct ieee80211_hw *hw,
3531 struct ieee80211_vif *vif,
3532 struct ieee80211_mutable_offsets *offs);
3533
3534/**
Johannes Bergeddcbb92009-10-29 08:30:35 +01003535 * ieee80211_beacon_get_tim - beacon generation function
3536 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01003537 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Bergeddcbb92009-10-29 08:30:35 +01003538 * @tim_offset: pointer to variable that will receive the TIM IE offset.
3539 * Set to 0 if invalid (in non-AP modes).
3540 * @tim_length: pointer to variable that will receive the TIM IE length,
3541 * (including the ID and length bytes!).
3542 * Set to 0 if invalid (in non-AP modes).
3543 *
3544 * If the driver implements beaconing modes, it must use this function to
Andrei Otcheretianski6ec8c332014-05-09 14:11:49 +03003545 * obtain the beacon frame.
Johannes Bergeddcbb92009-10-29 08:30:35 +01003546 *
3547 * If the beacon frames are generated by the host system (i.e., not in
3548 * hardware/firmware), the driver uses this function to get each beacon
Andrei Otcheretianski6ec8c332014-05-09 14:11:49 +03003549 * frame from mac80211 -- it is responsible for calling this function exactly
3550 * once before the beacon is needed (e.g. based on hardware interrupt).
Johannes Bergeddcbb92009-10-29 08:30:35 +01003551 *
3552 * The driver is responsible for freeing the returned skb.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003553 *
3554 * Return: The beacon template. %NULL on error.
Johannes Bergeddcbb92009-10-29 08:30:35 +01003555 */
3556struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
3557 struct ieee80211_vif *vif,
3558 u16 *tim_offset, u16 *tim_length);
3559
3560/**
Jiri Bencf0706e82007-05-05 11:45:53 -07003561 * ieee80211_beacon_get - beacon generation function
3562 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01003563 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07003564 *
Johannes Bergeddcbb92009-10-29 08:30:35 +01003565 * See ieee80211_beacon_get_tim().
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003566 *
3567 * Return: See ieee80211_beacon_get_tim().
Jiri Bencf0706e82007-05-05 11:45:53 -07003568 */
Johannes Bergeddcbb92009-10-29 08:30:35 +01003569static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
3570 struct ieee80211_vif *vif)
3571{
3572 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
3573}
Jiri Bencf0706e82007-05-05 11:45:53 -07003574
3575/**
Andrei Otcheretianski1af586c2014-05-09 14:11:50 +03003576 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter
3577 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3578 *
3579 * The csa counter should be updated after each beacon transmission.
3580 * This function is called implicitly when
3581 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
3582 * beacon frames are generated by the device, the driver should call this
3583 * function after each beacon transmission to sync mac80211's csa counters.
3584 *
3585 * Return: new csa counter value
3586 */
3587u8 ieee80211_csa_update_counter(struct ieee80211_vif *vif);
3588
3589/**
Simon Wunderlich73da7d52013-07-11 16:09:06 +02003590 * ieee80211_csa_finish - notify mac80211 about channel switch
3591 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3592 *
3593 * After a channel switch announcement was scheduled and the counter in this
Luciano Coelho66e01cf2014-01-13 19:43:00 +02003594 * announcement hits 1, this function must be called by the driver to
Simon Wunderlich73da7d52013-07-11 16:09:06 +02003595 * notify mac80211 that the channel can be changed.
3596 */
3597void ieee80211_csa_finish(struct ieee80211_vif *vif);
3598
3599/**
Luciano Coelho66e01cf2014-01-13 19:43:00 +02003600 * ieee80211_csa_is_complete - find out if counters reached 1
Simon Wunderlich73da7d52013-07-11 16:09:06 +02003601 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3602 *
3603 * This function returns whether the channel switch counters reached zero.
3604 */
3605bool ieee80211_csa_is_complete(struct ieee80211_vif *vif);
3606
3607
3608/**
Arik Nemtsov02945822011-11-10 11:28:57 +02003609 * ieee80211_proberesp_get - retrieve a Probe Response template
3610 * @hw: pointer obtained from ieee80211_alloc_hw().
3611 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3612 *
3613 * Creates a Probe Response template which can, for example, be uploaded to
3614 * hardware. The destination address should be set by the caller.
3615 *
3616 * Can only be called in AP mode.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003617 *
3618 * Return: The Probe Response template. %NULL on error.
Arik Nemtsov02945822011-11-10 11:28:57 +02003619 */
3620struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
3621 struct ieee80211_vif *vif);
3622
3623/**
Kalle Valo7044cc52010-01-05 20:16:19 +02003624 * ieee80211_pspoll_get - retrieve a PS Poll template
3625 * @hw: pointer obtained from ieee80211_alloc_hw().
3626 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3627 *
3628 * Creates a PS Poll a template which can, for example, uploaded to
3629 * hardware. The template must be updated after association so that correct
3630 * AID, BSSID and MAC address is used.
3631 *
3632 * Note: Caller (or hardware) is responsible for setting the
3633 * &IEEE80211_FCTL_PM bit.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003634 *
3635 * Return: The PS Poll template. %NULL on error.
Kalle Valo7044cc52010-01-05 20:16:19 +02003636 */
3637struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
3638 struct ieee80211_vif *vif);
3639
3640/**
3641 * ieee80211_nullfunc_get - retrieve a nullfunc template
3642 * @hw: pointer obtained from ieee80211_alloc_hw().
3643 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3644 *
3645 * Creates a Nullfunc template which can, for example, uploaded to
3646 * hardware. The template must be updated after association so that correct
3647 * BSSID and address is used.
3648 *
3649 * Note: Caller (or hardware) is responsible for setting the
3650 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003651 *
3652 * Return: The nullfunc template. %NULL on error.
Kalle Valo7044cc52010-01-05 20:16:19 +02003653 */
3654struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
3655 struct ieee80211_vif *vif);
3656
3657/**
Kalle Valo05e54ea2010-01-05 20:16:38 +02003658 * ieee80211_probereq_get - retrieve a Probe Request template
3659 * @hw: pointer obtained from ieee80211_alloc_hw().
3660 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3661 * @ssid: SSID buffer
3662 * @ssid_len: length of SSID
Johannes Bergb9a9ada2012-11-29 13:00:10 +01003663 * @tailroom: tailroom to reserve at end of SKB for IEs
Kalle Valo05e54ea2010-01-05 20:16:38 +02003664 *
3665 * Creates a Probe Request template which can, for example, be uploaded to
3666 * hardware.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003667 *
3668 * Return: The Probe Request template. %NULL on error.
Kalle Valo05e54ea2010-01-05 20:16:38 +02003669 */
3670struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
3671 struct ieee80211_vif *vif,
3672 const u8 *ssid, size_t ssid_len,
Johannes Bergb9a9ada2012-11-29 13:00:10 +01003673 size_t tailroom);
Kalle Valo05e54ea2010-01-05 20:16:38 +02003674
3675/**
Jiri Bencf0706e82007-05-05 11:45:53 -07003676 * ieee80211_rts_get - RTS frame generation function
3677 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01003678 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07003679 * @frame: pointer to the frame that is going to be protected by the RTS.
3680 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02003681 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07003682 * @rts: The buffer where to store the RTS frame.
3683 *
3684 * If the RTS frames are generated by the host system (i.e., not in
3685 * hardware/firmware), the low-level driver uses this function to receive
3686 * the next RTS frame from the 802.11 code. The low-level is responsible
3687 * for calling this function before and RTS frame is needed.
3688 */
Johannes Berg32bfd352007-12-19 01:31:26 +01003689void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07003690 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02003691 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07003692 struct ieee80211_rts *rts);
3693
3694/**
3695 * ieee80211_rts_duration - Get the duration field for an RTS frame
3696 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01003697 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07003698 * @frame_len: the length of the frame that is going to be protected by the RTS.
Johannes Berge039fa42008-05-15 12:55:29 +02003699 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07003700 *
3701 * If the RTS is generated in firmware, but the host system must provide
3702 * the duration field, the low-level driver uses this function to receive
3703 * the duration field value in little-endian byteorder.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003704 *
3705 * Return: The duration.
Jiri Bencf0706e82007-05-05 11:45:53 -07003706 */
Johannes Berg32bfd352007-12-19 01:31:26 +01003707__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
3708 struct ieee80211_vif *vif, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02003709 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07003710
3711/**
3712 * ieee80211_ctstoself_get - CTS-to-self frame generation function
3713 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01003714 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07003715 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
3716 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02003717 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07003718 * @cts: The buffer where to store the CTS-to-self frame.
3719 *
3720 * If the CTS-to-self frames are generated by the host system (i.e., not in
3721 * hardware/firmware), the low-level driver uses this function to receive
3722 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
3723 * for calling this function before and CTS-to-self frame is needed.
3724 */
Johannes Berg32bfd352007-12-19 01:31:26 +01003725void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
3726 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07003727 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02003728 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07003729 struct ieee80211_cts *cts);
3730
3731/**
3732 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
3733 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01003734 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07003735 * @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 +02003736 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07003737 *
3738 * If the CTS-to-self is generated in firmware, but the host system must provide
3739 * the duration field, the low-level driver uses this function to receive
3740 * the duration field value in little-endian byteorder.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003741 *
3742 * Return: The duration.
Jiri Bencf0706e82007-05-05 11:45:53 -07003743 */
Johannes Berg32bfd352007-12-19 01:31:26 +01003744__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
3745 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07003746 size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02003747 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07003748
3749/**
3750 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
3751 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01003752 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Bergd13e1412012-06-09 10:31:09 +02003753 * @band: the band to calculate the frame duration on
Jiri Bencf0706e82007-05-05 11:45:53 -07003754 * @frame_len: the length of the frame.
Johannes Berg8318d782008-01-24 19:38:38 +01003755 * @rate: the rate at which the frame is going to be transmitted.
Jiri Bencf0706e82007-05-05 11:45:53 -07003756 *
3757 * Calculate the duration field of some generic frame, given its
3758 * length and transmission rate (in 100kbps).
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003759 *
3760 * Return: The duration.
Jiri Bencf0706e82007-05-05 11:45:53 -07003761 */
Johannes Berg32bfd352007-12-19 01:31:26 +01003762__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
3763 struct ieee80211_vif *vif,
Michal Kazior4ee73f32012-04-11 08:47:56 +02003764 enum ieee80211_band band,
Jiri Bencf0706e82007-05-05 11:45:53 -07003765 size_t frame_len,
Johannes Berg8318d782008-01-24 19:38:38 +01003766 struct ieee80211_rate *rate);
Jiri Bencf0706e82007-05-05 11:45:53 -07003767
3768/**
3769 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
3770 * @hw: pointer as obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01003771 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07003772 *
3773 * Function for accessing buffered broadcast and multicast frames. If
3774 * hardware/firmware does not implement buffering of broadcast/multicast
3775 * frames when power saving is used, 802.11 code buffers them in the host
3776 * memory. The low-level driver uses this function to fetch next buffered
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003777 * frame. In most cases, this is used when generating beacon frame.
3778 *
3779 * Return: A pointer to the next buffered skb or NULL if no more buffered
3780 * frames are available.
Jiri Bencf0706e82007-05-05 11:45:53 -07003781 *
3782 * Note: buffered frames are returned only after DTIM beacon frame was
3783 * generated with ieee80211_beacon_get() and the low-level driver must thus
3784 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
3785 * NULL if the previous generated beacon was not DTIM, so the low-level driver
3786 * does not need to check for DTIM beacons separately and should be able to
3787 * use common code for all beacons.
3788 */
3789struct sk_buff *
Johannes Berge039fa42008-05-15 12:55:29 +02003790ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07003791
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003792/**
Johannes Berg42d98792011-07-07 18:58:01 +02003793 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
3794 *
3795 * This function returns the TKIP phase 1 key for the given IV32.
3796 *
3797 * @keyconf: the parameter passed with the set key
3798 * @iv32: IV32 to get the P1K for
3799 * @p1k: a buffer to which the key will be written, as 5 u16 values
3800 */
3801void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
3802 u32 iv32, u16 *p1k);
3803
3804/**
Johannes Berg523b02e2011-07-07 22:28:01 +02003805 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02003806 *
Johannes Berg523b02e2011-07-07 22:28:01 +02003807 * This function returns the TKIP phase 1 key for the IV32 taken
3808 * from the given packet.
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02003809 *
3810 * @keyconf: the parameter passed with the set key
Johannes Berg523b02e2011-07-07 22:28:01 +02003811 * @skb: the packet to take the IV32 value from that will be encrypted
3812 * with this P1K
3813 * @p1k: a buffer to which the key will be written, as 5 u16 values
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02003814 */
Johannes Berg42d98792011-07-07 18:58:01 +02003815static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
3816 struct sk_buff *skb, u16 *p1k)
3817{
3818 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
3819 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
3820 u32 iv32 = get_unaligned_le32(&data[4]);
3821
3822 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
3823}
Johannes Berg523b02e2011-07-07 22:28:01 +02003824
3825/**
Johannes Berg8bca5d82011-07-13 19:50:34 +02003826 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
3827 *
3828 * This function returns the TKIP phase 1 key for the given IV32
3829 * and transmitter address.
3830 *
3831 * @keyconf: the parameter passed with the set key
3832 * @ta: TA that will be used with the key
3833 * @iv32: IV32 to get the P1K for
3834 * @p1k: a buffer to which the key will be written, as 5 u16 values
3835 */
3836void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
3837 const u8 *ta, u32 iv32, u16 *p1k);
3838
3839/**
Johannes Berg523b02e2011-07-07 22:28:01 +02003840 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
3841 *
3842 * This function computes the TKIP RC4 key for the IV values
3843 * in the packet.
3844 *
3845 * @keyconf: the parameter passed with the set key
3846 * @skb: the packet to take the IV32/IV16 values from that will be
3847 * encrypted with this key
3848 * @p2k: a buffer to which the key will be written, 16 bytes
3849 */
3850void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
3851 struct sk_buff *skb, u8 *p2k);
Johannes Bergc68f4b82011-07-05 16:35:41 +02003852
3853/**
Assaf Krauss5d0d04e2012-08-01 15:12:48 +03003854 * ieee80211_aes_cmac_calculate_k1_k2 - calculate the AES-CMAC sub keys
3855 *
3856 * This function computes the two AES-CMAC sub-keys, based on the
3857 * previously installed master key.
3858 *
3859 * @keyconf: the parameter passed with the set key
3860 * @k1: a buffer to be filled with the 1st sub-key
3861 * @k2: a buffer to be filled with the 2nd sub-key
3862 */
3863void ieee80211_aes_cmac_calculate_k1_k2(struct ieee80211_key_conf *keyconf,
3864 u8 *k1, u8 *k2);
3865
3866/**
Johannes Berg3ea542d2011-07-07 18:58:00 +02003867 * struct ieee80211_key_seq - key sequence counter
3868 *
3869 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
3870 * @ccmp: PN data, most significant byte first (big endian,
3871 * reverse order than in packet)
3872 * @aes_cmac: PN data, most significant byte first (big endian,
3873 * reverse order than in packet)
3874 */
3875struct ieee80211_key_seq {
3876 union {
3877 struct {
3878 u32 iv32;
3879 u16 iv16;
3880 } tkip;
3881 struct {
3882 u8 pn[6];
3883 } ccmp;
3884 struct {
3885 u8 pn[6];
3886 } aes_cmac;
3887 };
3888};
3889
3890/**
3891 * ieee80211_get_key_tx_seq - get key TX sequence counter
3892 *
3893 * @keyconf: the parameter passed with the set key
3894 * @seq: buffer to receive the sequence data
3895 *
3896 * This function allows a driver to retrieve the current TX IV/PN
3897 * for the given key. It must not be called if IV generation is
3898 * offloaded to the device.
3899 *
3900 * Note that this function may only be called when no TX processing
3901 * can be done concurrently, for example when queues are stopped
3902 * and the stop has been synchronized.
3903 */
3904void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
3905 struct ieee80211_key_seq *seq);
3906
3907/**
3908 * ieee80211_get_key_rx_seq - get key RX sequence counter
3909 *
3910 * @keyconf: the parameter passed with the set key
3911 * @tid: The TID, or -1 for the management frame value (CCMP only);
3912 * the value on TID 0 is also used for non-QoS frames. For
3913 * CMAC, only TID 0 is valid.
3914 * @seq: buffer to receive the sequence data
3915 *
3916 * This function allows a driver to retrieve the current RX IV/PNs
3917 * for the given key. It must not be called if IV checking is done
3918 * by the device and not by mac80211.
3919 *
3920 * Note that this function may only be called when no RX processing
3921 * can be done concurrently.
3922 */
3923void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
3924 int tid, struct ieee80211_key_seq *seq);
3925
3926/**
Johannes Berg27b3eb92013-08-07 20:11:55 +02003927 * ieee80211_set_key_tx_seq - set key TX sequence counter
3928 *
3929 * @keyconf: the parameter passed with the set key
3930 * @seq: new sequence data
3931 *
3932 * This function allows a driver to set the current TX IV/PNs for the
3933 * given key. This is useful when resuming from WoWLAN sleep and the
3934 * device may have transmitted frames using the PTK, e.g. replies to
3935 * ARP requests.
3936 *
3937 * Note that this function may only be called when no TX processing
3938 * can be done concurrently.
3939 */
3940void ieee80211_set_key_tx_seq(struct ieee80211_key_conf *keyconf,
3941 struct ieee80211_key_seq *seq);
3942
3943/**
3944 * ieee80211_set_key_rx_seq - set key RX sequence counter
3945 *
3946 * @keyconf: the parameter passed with the set key
3947 * @tid: The TID, or -1 for the management frame value (CCMP only);
3948 * the value on TID 0 is also used for non-QoS frames. For
3949 * CMAC, only TID 0 is valid.
3950 * @seq: new sequence data
3951 *
3952 * This function allows a driver to set the current RX IV/PNs for the
3953 * given key. This is useful when resuming from WoWLAN sleep and GTK
3954 * rekey may have been done while suspended. It should not be called
3955 * if IV checking is done by the device and not by mac80211.
3956 *
3957 * Note that this function may only be called when no RX processing
3958 * can be done concurrently.
3959 */
3960void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
3961 int tid, struct ieee80211_key_seq *seq);
3962
3963/**
3964 * ieee80211_remove_key - remove the given key
3965 * @keyconf: the parameter passed with the set key
3966 *
3967 * Remove the given key. If the key was uploaded to the hardware at the
3968 * time this function is called, it is not deleted in the hardware but
3969 * instead assumed to have been removed already.
3970 *
3971 * Note that due to locking considerations this function can (currently)
3972 * only be called during key iteration (ieee80211_iter_keys().)
3973 */
3974void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
3975
3976/**
3977 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
3978 * @vif: the virtual interface to add the key on
3979 * @keyconf: new key data
3980 *
3981 * When GTK rekeying was done while the system was suspended, (a) new
3982 * key(s) will be available. These will be needed by mac80211 for proper
3983 * RX processing, so this function allows setting them.
3984 *
3985 * The function returns the newly allocated key structure, which will
3986 * have similar contents to the passed key configuration but point to
3987 * mac80211-owned memory. In case of errors, the function returns an
3988 * ERR_PTR(), use IS_ERR() etc.
3989 *
3990 * Note that this function assumes the key isn't added to hardware
3991 * acceleration, so no TX will be done with the key. Since it's a GTK
3992 * on managed (station) networks, this is true anyway. If the driver
3993 * calls this function from the resume callback and subsequently uses
3994 * the return code 1 to reconfigure the device, this key will be part
3995 * of the reconfiguration.
3996 *
3997 * Note that the driver should also call ieee80211_set_key_rx_seq()
3998 * for the new key for each TID to set up sequence counters properly.
3999 *
4000 * IMPORTANT: If this replaces a key that is present in the hardware,
4001 * then it will attempt to remove it during this call. In many cases
4002 * this isn't what you want, so call ieee80211_remove_key() first for
4003 * the key that's being replaced.
4004 */
4005struct ieee80211_key_conf *
4006ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
4007 struct ieee80211_key_conf *keyconf);
4008
4009/**
Johannes Bergc68f4b82011-07-05 16:35:41 +02004010 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
4011 * @vif: virtual interface the rekeying was done on
4012 * @bssid: The BSSID of the AP, for checking association
4013 * @replay_ctr: the new replay counter after GTK rekeying
4014 * @gfp: allocation flags
4015 */
4016void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
4017 const u8 *replay_ctr, gfp_t gfp);
4018
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02004019/**
Jiri Bencf0706e82007-05-05 11:45:53 -07004020 * ieee80211_wake_queue - wake specific queue
4021 * @hw: pointer as obtained from ieee80211_alloc_hw().
4022 * @queue: queue number (counted from zero).
4023 *
4024 * Drivers should use this function instead of netif_wake_queue.
4025 */
4026void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
4027
4028/**
4029 * ieee80211_stop_queue - stop specific queue
4030 * @hw: pointer as obtained from ieee80211_alloc_hw().
4031 * @queue: queue number (counted from zero).
4032 *
4033 * Drivers should use this function instead of netif_stop_queue.
4034 */
4035void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
4036
4037/**
Tomas Winkler92ab8532008-07-24 21:02:04 +03004038 * ieee80211_queue_stopped - test status of the queue
4039 * @hw: pointer as obtained from ieee80211_alloc_hw().
4040 * @queue: queue number (counted from zero).
4041 *
4042 * Drivers should use this function instead of netif_stop_queue.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004043 *
4044 * Return: %true if the queue is stopped. %false otherwise.
Tomas Winkler92ab8532008-07-24 21:02:04 +03004045 */
4046
4047int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
4048
4049/**
Jiri Bencf0706e82007-05-05 11:45:53 -07004050 * ieee80211_stop_queues - stop all queues
4051 * @hw: pointer as obtained from ieee80211_alloc_hw().
4052 *
4053 * Drivers should use this function instead of netif_stop_queue.
4054 */
4055void ieee80211_stop_queues(struct ieee80211_hw *hw);
4056
4057/**
4058 * ieee80211_wake_queues - wake all queues
4059 * @hw: pointer as obtained from ieee80211_alloc_hw().
4060 *
4061 * Drivers should use this function instead of netif_wake_queue.
4062 */
4063void ieee80211_wake_queues(struct ieee80211_hw *hw);
4064
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004065/**
4066 * ieee80211_scan_completed - completed hardware scan
4067 *
4068 * When hardware scan offload is used (i.e. the hw_scan() callback is
4069 * assigned) this function needs to be called by the driver to notify
Johannes Berg8789d452010-08-26 13:30:26 +02004070 * mac80211 that the scan finished. This function can be called from
4071 * any context, including hardirq context.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004072 *
4073 * @hw: the hardware that finished the scan
Johannes Berg2a519312009-02-10 21:25:55 +01004074 * @aborted: set to true if scan was aborted
Johannes Berg75a5f0c2007-09-18 17:29:20 -04004075 */
Johannes Berg2a519312009-02-10 21:25:55 +01004076void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
Jiri Bencf0706e82007-05-05 11:45:53 -07004077
Johannes Bergdabeb342007-11-09 01:57:29 +01004078/**
Luciano Coelho79f460c2011-05-11 17:09:36 +03004079 * ieee80211_sched_scan_results - got results from scheduled scan
4080 *
4081 * When a scheduled scan is running, this function needs to be called by the
4082 * driver whenever there are new scan results available.
4083 *
4084 * @hw: the hardware that is performing scheduled scans
4085 */
4086void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
4087
4088/**
4089 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
4090 *
4091 * When a scheduled scan is running, this function can be called by
4092 * the driver if it needs to stop the scan to perform another task.
4093 * Usual scenarios are drivers that cannot continue the scheduled scan
4094 * while associating, for instance.
4095 *
4096 * @hw: the hardware that is performing scheduled scans
4097 */
4098void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
4099
4100/**
Johannes Berg8b2c9822012-11-06 20:23:30 +01004101 * enum ieee80211_interface_iteration_flags - interface iteration flags
4102 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
4103 * been added to the driver; However, note that during hardware
4104 * reconfiguration (after restart_hw) it will iterate over a new
4105 * interface and over all the existing interfaces even if they
4106 * haven't been re-added to the driver yet.
4107 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
4108 * interfaces, even if they haven't been re-added to the driver yet.
4109 */
4110enum ieee80211_interface_iteration_flags {
4111 IEEE80211_IFACE_ITER_NORMAL = 0,
4112 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
4113};
4114
4115/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07004116 * ieee80211_iterate_active_interfaces - iterate active interfaces
Johannes Bergdabeb342007-11-09 01:57:29 +01004117 *
4118 * This function iterates over the interfaces associated with a given
4119 * hardware that are currently active and calls the callback for them.
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02004120 * This function allows the iterator function to sleep, when the iterator
4121 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
4122 * be used.
Johannes Berg8b2c9822012-11-06 20:23:30 +01004123 * Does not iterate over a new interface during add_interface().
Johannes Bergdabeb342007-11-09 01:57:29 +01004124 *
4125 * @hw: the hardware struct of which the interfaces should be iterated over
Johannes Berg8b2c9822012-11-06 20:23:30 +01004126 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02004127 * @iterator: the iterator function to call
Johannes Bergdabeb342007-11-09 01:57:29 +01004128 * @data: first argument of the iterator function
4129 */
4130void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
Johannes Berg8b2c9822012-11-06 20:23:30 +01004131 u32 iter_flags,
Johannes Bergdabeb342007-11-09 01:57:29 +01004132 void (*iterator)(void *data, u8 *mac,
Johannes Berg32bfd352007-12-19 01:31:26 +01004133 struct ieee80211_vif *vif),
Johannes Bergdabeb342007-11-09 01:57:29 +01004134 void *data);
4135
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004136/**
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02004137 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
4138 *
4139 * This function iterates over the interfaces associated with a given
4140 * hardware that are currently active and calls the callback for them.
4141 * This function requires the iterator callback function to be atomic,
4142 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
Johannes Berg8b2c9822012-11-06 20:23:30 +01004143 * Does not iterate over a new interface during add_interface().
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02004144 *
4145 * @hw: the hardware struct of which the interfaces should be iterated over
Johannes Berg8b2c9822012-11-06 20:23:30 +01004146 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02004147 * @iterator: the iterator function to call, cannot sleep
4148 * @data: first argument of the iterator function
4149 */
4150void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
Johannes Berg8b2c9822012-11-06 20:23:30 +01004151 u32 iter_flags,
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02004152 void (*iterator)(void *data,
4153 u8 *mac,
4154 struct ieee80211_vif *vif),
4155 void *data);
4156
4157/**
Johannes Bergc7c71062013-08-21 22:07:20 +02004158 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
4159 *
4160 * This function iterates over the interfaces associated with a given
4161 * hardware that are currently active and calls the callback for them.
4162 * This version can only be used while holding the RTNL.
4163 *
4164 * @hw: the hardware struct of which the interfaces should be iterated over
4165 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4166 * @iterator: the iterator function to call, cannot sleep
4167 * @data: first argument of the iterator function
4168 */
4169void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw,
4170 u32 iter_flags,
4171 void (*iterator)(void *data,
4172 u8 *mac,
4173 struct ieee80211_vif *vif),
4174 void *data);
4175
4176/**
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04004177 * ieee80211_queue_work - add work onto the mac80211 workqueue
4178 *
4179 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
4180 * This helper ensures drivers are not queueing work when they should not be.
4181 *
4182 * @hw: the hardware struct for the interface we are adding work for
4183 * @work: the work we want to add onto the mac80211 workqueue
4184 */
4185void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
4186
4187/**
4188 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
4189 *
4190 * Drivers and mac80211 use this to queue delayed work onto the mac80211
4191 * workqueue.
4192 *
4193 * @hw: the hardware struct for the interface we are adding work for
4194 * @dwork: delayable work to queue onto the mac80211 workqueue
4195 * @delay: number of jiffies to wait before queueing
4196 */
4197void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
4198 struct delayed_work *dwork,
4199 unsigned long delay);
4200
4201/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004202 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01004203 * @sta: the station for which to start a BA session
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004204 * @tid: the TID to BA on.
Sujith Manoharanbd2ce6e2010-12-15 07:47:10 +05304205 * @timeout: session timeout value (in TUs)
Randy Dunlapea2d8b52008-10-27 09:47:03 -07004206 *
4207 * Return: success if addBA request was sent, failure otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004208 *
4209 * Although mac80211/low level driver/user space application can estimate
4210 * the need to start aggregation on a certain RA/TID, the session level
4211 * will be managed by the mac80211.
4212 */
Sujith Manoharanbd2ce6e2010-12-15 07:47:10 +05304213int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
4214 u16 timeout);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004215
4216/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004217 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01004218 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004219 * @ra: receiver address of the BA session recipient.
4220 * @tid: the TID to BA on.
4221 *
4222 * This function must be called by low level driver once it has
Johannes Berg5d22c892010-06-10 10:21:40 +02004223 * finished with preparations for the BA session. It can be called
4224 * from any context.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004225 */
Johannes Bergc951ad32009-11-16 12:00:38 +01004226void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004227 u16 tid);
4228
4229/**
4230 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01004231 * @sta: the station whose BA session to stop
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004232 * @tid: the TID to stop BA.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07004233 *
Johannes Berg6a8579d2010-05-27 14:41:07 +02004234 * Return: negative error if the TID is invalid, or no aggregation active
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004235 *
4236 * Although mac80211/low level driver/user space application can estimate
4237 * the need to stop aggregation on a certain RA/TID, the session level
4238 * will be managed by the mac80211.
4239 */
Johannes Berg6a8579d2010-05-27 14:41:07 +02004240int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004241
4242/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004243 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01004244 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004245 * @ra: receiver address of the BA session recipient.
4246 * @tid: the desired TID to BA on.
4247 *
4248 * This function must be called by low level driver once it has
Johannes Berg5d22c892010-06-10 10:21:40 +02004249 * finished with preparations for the BA session tear down. It
4250 * can be called from any context.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004251 */
Johannes Bergc951ad32009-11-16 12:00:38 +01004252void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004253 u16 tid);
4254
Mohamed Abbas84363e62008-04-04 16:59:58 -07004255/**
Johannes Berg17741cd2008-09-11 00:02:02 +02004256 * ieee80211_find_sta - find a station
4257 *
Johannes Berg5ed176e2009-11-04 14:42:28 +01004258 * @vif: virtual interface to look for station on
Johannes Berg17741cd2008-09-11 00:02:02 +02004259 * @addr: station's address
4260 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004261 * Return: The station, if found. %NULL otherwise.
4262 *
4263 * Note: This function must be called under RCU lock and the
Johannes Berg17741cd2008-09-11 00:02:02 +02004264 * resulting pointer is only valid under RCU lock as well.
4265 */
Johannes Berg5ed176e2009-11-04 14:42:28 +01004266struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02004267 const u8 *addr);
4268
Kalle Valo04de8382009-03-22 21:57:35 +02004269/**
Ben Greear686b9cb2010-09-23 09:44:36 -07004270 * ieee80211_find_sta_by_ifaddr - find a station on hardware
Johannes Berg5ed176e2009-11-04 14:42:28 +01004271 *
4272 * @hw: pointer as obtained from ieee80211_alloc_hw()
Ben Greear686b9cb2010-09-23 09:44:36 -07004273 * @addr: remote station's address
4274 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
Johannes Berg5ed176e2009-11-04 14:42:28 +01004275 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004276 * Return: The station, if found. %NULL otherwise.
4277 *
4278 * Note: This function must be called under RCU lock and the
Johannes Berg5ed176e2009-11-04 14:42:28 +01004279 * resulting pointer is only valid under RCU lock as well.
4280 *
Ben Greear686b9cb2010-09-23 09:44:36 -07004281 * NOTE: You may pass NULL for localaddr, but then you will just get
4282 * the first STA that matches the remote address 'addr'.
4283 * We can have multiple STA associated with multiple
4284 * logical stations (e.g. consider a station connecting to another
4285 * BSSID on the same AP hardware without disconnecting first).
4286 * In this case, the result of this method with localaddr NULL
4287 * is not reliable.
Johannes Berg5ed176e2009-11-04 14:42:28 +01004288 *
Ben Greear686b9cb2010-09-23 09:44:36 -07004289 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
Johannes Berg5ed176e2009-11-04 14:42:28 +01004290 */
Ben Greear686b9cb2010-09-23 09:44:36 -07004291struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
4292 const u8 *addr,
4293 const u8 *localaddr);
Johannes Berg5ed176e2009-11-04 14:42:28 +01004294
4295/**
Johannes Bergaf818582009-11-06 11:35:50 +01004296 * ieee80211_sta_block_awake - block station from waking up
4297 * @hw: the hardware
4298 * @pubsta: the station
4299 * @block: whether to block or unblock
4300 *
4301 * Some devices require that all frames that are on the queues
4302 * for a specific station that went to sleep are flushed before
4303 * a poll response or frames after the station woke up can be
4304 * delivered to that it. Note that such frames must be rejected
4305 * by the driver as filtered, with the appropriate status flag.
4306 *
4307 * This function allows implementing this mode in a race-free
4308 * manner.
4309 *
4310 * To do this, a driver must keep track of the number of frames
4311 * still enqueued for a specific station. If this number is not
4312 * zero when the station goes to sleep, the driver must call
4313 * this function to force mac80211 to consider the station to
4314 * be asleep regardless of the station's actual state. Once the
4315 * number of outstanding frames reaches zero, the driver must
4316 * call this function again to unblock the station. That will
4317 * cause mac80211 to be able to send ps-poll responses, and if
4318 * the station queried in the meantime then frames will also
4319 * be sent out as a result of this. Additionally, the driver
4320 * will be notified that the station woke up some time after
4321 * it is unblocked, regardless of whether the station actually
4322 * woke up while blocked or not.
4323 */
4324void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
4325 struct ieee80211_sta *pubsta, bool block);
4326
4327/**
Johannes Berg37fbd902011-09-29 16:04:39 +02004328 * ieee80211_sta_eosp - notify mac80211 about end of SP
4329 * @pubsta: the station
4330 *
4331 * When a device transmits frames in a way that it can't tell
4332 * mac80211 in the TX status about the EOSP, it must clear the
4333 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
4334 * This applies for PS-Poll as well as uAPSD.
4335 *
Johannes Berge9437892013-02-15 21:38:08 +01004336 * Note that just like with _tx_status() and _rx() drivers must
4337 * not mix calls to irqsafe/non-irqsafe versions, this function
4338 * must not be mixed with those either. Use the all irqsafe, or
4339 * all non-irqsafe, don't mix!
4340 *
4341 * NB: the _irqsafe version of this function doesn't exist, no
4342 * driver needs it right now. Don't call this function if
4343 * you'd need the _irqsafe version, look at the git history
4344 * and restore the _irqsafe version!
Johannes Berg37fbd902011-09-29 16:04:39 +02004345 */
Johannes Berge9437892013-02-15 21:38:08 +01004346void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
Johannes Berg37fbd902011-09-29 16:04:39 +02004347
4348/**
Johannes Berg830af022011-07-05 16:35:39 +02004349 * ieee80211_iter_keys - iterate keys programmed into the device
4350 * @hw: pointer obtained from ieee80211_alloc_hw()
4351 * @vif: virtual interface to iterate, may be %NULL for all
4352 * @iter: iterator function that will be called for each key
4353 * @iter_data: custom data to pass to the iterator function
4354 *
4355 * This function can be used to iterate all the keys known to
4356 * mac80211, even those that weren't previously programmed into
4357 * the device. This is intended for use in WoWLAN if the device
4358 * needs reprogramming of the keys during suspend. Note that due
4359 * to locking reasons, it is also only safe to call this at few
4360 * spots since it must hold the RTNL and be able to sleep.
Johannes Bergf850e002011-07-13 19:50:53 +02004361 *
4362 * The order in which the keys are iterated matches the order
4363 * in which they were originally installed and handed to the
4364 * set_key callback.
Johannes Berg830af022011-07-05 16:35:39 +02004365 */
4366void ieee80211_iter_keys(struct ieee80211_hw *hw,
4367 struct ieee80211_vif *vif,
4368 void (*iter)(struct ieee80211_hw *hw,
4369 struct ieee80211_vif *vif,
4370 struct ieee80211_sta *sta,
4371 struct ieee80211_key_conf *key,
4372 void *data),
4373 void *iter_data);
4374
4375/**
Johannes Berg3448c002012-09-11 17:57:42 +02004376 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
4377 * @hw: pointre obtained from ieee80211_alloc_hw().
4378 * @iter: iterator function
4379 * @iter_data: data passed to iterator function
4380 *
4381 * Iterate all active channel contexts. This function is atomic and
4382 * doesn't acquire any locks internally that might be held in other
4383 * places while calling into the driver.
4384 *
4385 * The iterator will not find a context that's being added (during
4386 * the driver callback to add it) but will find it while it's being
4387 * removed.
Johannes Berg8a61af62012-12-13 17:42:30 +01004388 *
4389 * Note that during hardware restart, all contexts that existed
4390 * before the restart are considered already present so will be
4391 * found while iterating, whether they've been re-added already
4392 * or not.
Johannes Berg3448c002012-09-11 17:57:42 +02004393 */
4394void ieee80211_iter_chan_contexts_atomic(
4395 struct ieee80211_hw *hw,
4396 void (*iter)(struct ieee80211_hw *hw,
4397 struct ieee80211_chanctx_conf *chanctx_conf,
4398 void *data),
4399 void *iter_data);
4400
4401/**
Juuso Oikarinena619a4c2010-11-11 08:50:18 +02004402 * ieee80211_ap_probereq_get - retrieve a Probe Request template
4403 * @hw: pointer obtained from ieee80211_alloc_hw().
4404 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4405 *
4406 * Creates a Probe Request template which can, for example, be uploaded to
4407 * hardware. The template is filled with bssid, ssid and supported rate
4408 * information. This function must only be called from within the
4409 * .bss_info_changed callback function and only in managed mode. The function
4410 * is only useful when the interface is associated, otherwise it will return
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004411 * %NULL.
4412 *
4413 * Return: The Probe Request template. %NULL on error.
Juuso Oikarinena619a4c2010-11-11 08:50:18 +02004414 */
4415struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
4416 struct ieee80211_vif *vif);
4417
4418/**
Kalle Valo04de8382009-03-22 21:57:35 +02004419 * ieee80211_beacon_loss - inform hardware does not receive beacons
4420 *
Johannes Berg1ed32e42009-12-23 13:15:45 +01004421 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Kalle Valo04de8382009-03-22 21:57:35 +02004422 *
Johannes Bergc1288b12012-01-19 09:29:57 +01004423 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02004424 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
Kalle Valo04de8382009-03-22 21:57:35 +02004425 * hardware is not receiving beacons with this function.
4426 */
4427void ieee80211_beacon_loss(struct ieee80211_vif *vif);
Johannes Berg4b7679a2008-09-18 18:14:18 +02004428
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02004429/**
4430 * ieee80211_connection_loss - inform hardware has lost connection to the AP
4431 *
4432 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4433 *
Johannes Bergc1288b12012-01-19 09:29:57 +01004434 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02004435 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
4436 * needs to inform if the connection to the AP has been lost.
Johannes Berg682bd382013-01-29 13:13:50 +01004437 * The function may also be called if the connection needs to be terminated
4438 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02004439 *
4440 * This function will cause immediate change to disassociated state,
4441 * without connection recovery attempts.
4442 */
4443void ieee80211_connection_loss(struct ieee80211_vif *vif);
4444
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02004445/**
Johannes Berg95acac62011-07-12 12:30:59 +02004446 * ieee80211_resume_disconnect - disconnect from AP after resume
4447 *
4448 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4449 *
4450 * Instructs mac80211 to disconnect from the AP after resume.
4451 * Drivers can use this after WoWLAN if they know that the
4452 * connection cannot be kept up, for example because keys were
4453 * used while the device was asleep but the replay counters or
4454 * similar cannot be retrieved from the device during resume.
4455 *
4456 * Note that due to implementation issues, if the driver uses
4457 * the reconfiguration functionality during resume the interface
4458 * will still be added as associated first during resume and then
4459 * disconnect normally later.
4460 *
4461 * This function can only be called from the resume callback and
4462 * the driver must not be holding any of its own locks while it
4463 * calls this function, or at least not any locks it needs in the
4464 * key configuration paths (if it supports HW crypto).
4465 */
4466void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
4467
4468/**
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02004469 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
4470 * rssi threshold triggered
4471 *
4472 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4473 * @rssi_event: the RSSI trigger event type
4474 * @gfp: context flags
4475 *
Johannes Bergea086352012-01-19 09:29:58 +01004476 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02004477 * monitoring is configured with an rssi threshold, the driver will inform
4478 * whenever the rssi level reaches the threshold.
4479 */
4480void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
4481 enum nl80211_cqm_rssi_threshold_event rssi_event,
4482 gfp_t gfp);
4483
Johannes Berg5ce6e432010-05-11 16:20:57 +02004484/**
Simon Wunderlich164eb022013-02-08 18:16:20 +01004485 * ieee80211_radar_detected - inform that a radar was detected
4486 *
4487 * @hw: pointer as obtained from ieee80211_alloc_hw()
4488 */
4489void ieee80211_radar_detected(struct ieee80211_hw *hw);
4490
4491/**
Johannes Berg5ce6e432010-05-11 16:20:57 +02004492 * ieee80211_chswitch_done - Complete channel switch process
4493 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4494 * @success: make the channel switch successful or not
4495 *
4496 * Complete the channel switch post-process: set the new operational channel
4497 * and wake up the suspended queues.
4498 */
4499void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
4500
Johannes Bergd1f5b7a2010-08-05 17:05:55 +02004501/**
4502 * ieee80211_request_smps - request SM PS transition
4503 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Berg633dd1e2010-08-18 15:01:23 +02004504 * @smps_mode: new SM PS mode
Johannes Bergd1f5b7a2010-08-05 17:05:55 +02004505 *
4506 * This allows the driver to request an SM PS transition in managed
4507 * mode. This is useful when the driver has more information than
4508 * the stack about possible interference, for example by bluetooth.
4509 */
4510void ieee80211_request_smps(struct ieee80211_vif *vif,
4511 enum ieee80211_smps_mode smps_mode);
4512
Johannes Berge31b8212010-10-05 19:39:30 +02004513/**
Johannes Berg21f83582010-12-18 17:20:47 +01004514 * ieee80211_ready_on_channel - notification of remain-on-channel start
4515 * @hw: pointer as obtained from ieee80211_alloc_hw()
4516 */
4517void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
4518
4519/**
4520 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
4521 * @hw: pointer as obtained from ieee80211_alloc_hw()
4522 */
4523void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
4524
Shahar Levif41ccd72011-05-22 16:10:21 +03004525/**
4526 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
4527 *
4528 * in order not to harm the system performance and user experience, the device
4529 * may request not to allow any rx ba session and tear down existing rx ba
4530 * sessions based on system constraints such as periodic BT activity that needs
4531 * to limit wlan activity (eg.sco or a2dp)."
4532 * in such cases, the intention is to limit the duration of the rx ppdu and
4533 * therefore prevent the peer device to use a-mpdu aggregation.
4534 *
4535 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4536 * @ba_rx_bitmap: Bit map of open rx ba per tid
4537 * @addr: & to bssid mac address
4538 */
4539void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
4540 const u8 *addr);
4541
Felix Fietkau8c771242011-08-20 15:53:55 +02004542/**
4543 * ieee80211_send_bar - send a BlockAckReq frame
4544 *
4545 * can be used to flush pending frames from the peer's aggregation reorder
4546 * buffer.
4547 *
4548 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4549 * @ra: the peer's destination address
4550 * @tid: the TID of the aggregation session
4551 * @ssn: the new starting sequence number for the receiver
4552 */
4553void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
4554
Johannes Berg4b7679a2008-09-18 18:14:18 +02004555/* Rate control API */
Johannes Berge6a98542008-10-21 12:40:02 +02004556
Johannes Berg4b7679a2008-09-18 18:14:18 +02004557/**
Johannes Berge6a98542008-10-21 12:40:02 +02004558 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
Johannes Berg4b7679a2008-09-18 18:14:18 +02004559 *
Johannes Berge6a98542008-10-21 12:40:02 +02004560 * @hw: The hardware the algorithm is invoked for.
4561 * @sband: The band this frame is being transmitted on.
4562 * @bss_conf: the current BSS configuration
Simon Wunderlichf44d4eb2012-03-07 21:31:13 +01004563 * @skb: the skb that will be transmitted, the control information in it needs
4564 * to be filled in
Johannes Berge6a98542008-10-21 12:40:02 +02004565 * @reported_rate: The rate control algorithm can fill this in to indicate
4566 * which rate should be reported to userspace as the current rate and
4567 * used for rate calculations in the mesh network.
4568 * @rts: whether RTS will be used for this frame because it is longer than the
4569 * RTS threshold
4570 * @short_preamble: whether mac80211 will request short-preamble transmission
4571 * if the selected rate supports it
Simon Wunderlichf44d4eb2012-03-07 21:31:13 +01004572 * @max_rate_idx: user-requested maximum (legacy) rate
Jouni Malinen37eb0b12010-01-06 13:09:08 +02004573 * (deprecated; this will be removed once drivers get updated to use
4574 * rate_idx_mask)
Simon Wunderlichf44d4eb2012-03-07 21:31:13 +01004575 * @rate_idx_mask: user-requested (legacy) rate mask
Felix Fietkau2ffbe6d2013-04-16 13:38:42 +02004576 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
Felix Fietkau8f0729b2010-11-11 15:07:23 +01004577 * @bss: whether this frame is sent out in AP or IBSS mode
Johannes Berg4b7679a2008-09-18 18:14:18 +02004578 */
Johannes Berge6a98542008-10-21 12:40:02 +02004579struct ieee80211_tx_rate_control {
4580 struct ieee80211_hw *hw;
4581 struct ieee80211_supported_band *sband;
4582 struct ieee80211_bss_conf *bss_conf;
4583 struct sk_buff *skb;
4584 struct ieee80211_tx_rate reported_rate;
4585 bool rts, short_preamble;
4586 u8 max_rate_idx;
Jouni Malinen37eb0b12010-01-06 13:09:08 +02004587 u32 rate_idx_mask;
Felix Fietkau2ffbe6d2013-04-16 13:38:42 +02004588 u8 *rate_idx_mcs_mask;
Felix Fietkau8f0729b2010-11-11 15:07:23 +01004589 bool bss;
Johannes Berg4b7679a2008-09-18 18:14:18 +02004590};
4591
4592struct rate_control_ops {
Johannes Berg4b7679a2008-09-18 18:14:18 +02004593 const char *name;
4594 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
Johannes Berg4b7679a2008-09-18 18:14:18 +02004595 void (*free)(void *priv);
4596
4597 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
4598 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
Simon Wunderlich3de805c2013-07-08 16:55:50 +02004599 struct cfg80211_chan_def *chandef,
Johannes Berg4b7679a2008-09-18 18:14:18 +02004600 struct ieee80211_sta *sta, void *priv_sta);
Sujith81cb7622009-02-12 11:38:37 +05304601 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
Simon Wunderlich3de805c2013-07-08 16:55:50 +02004602 struct cfg80211_chan_def *chandef,
Johannes Berg64f68e52012-03-28 10:58:37 +02004603 struct ieee80211_sta *sta, void *priv_sta,
4604 u32 changed);
Johannes Berg4b7679a2008-09-18 18:14:18 +02004605 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
4606 void *priv_sta);
4607
4608 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
4609 struct ieee80211_sta *sta, void *priv_sta,
4610 struct sk_buff *skb);
Johannes Berge6a98542008-10-21 12:40:02 +02004611 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
4612 struct ieee80211_tx_rate_control *txrc);
Johannes Berg4b7679a2008-09-18 18:14:18 +02004613
4614 void (*add_sta_debugfs)(void *priv, void *priv_sta,
4615 struct dentry *dir);
4616 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
Antonio Quartullicca674d2014-05-19 21:53:20 +02004617
4618 u32 (*get_expected_throughput)(void *priv_sta);
Johannes Berg4b7679a2008-09-18 18:14:18 +02004619};
4620
4621static inline int rate_supported(struct ieee80211_sta *sta,
4622 enum ieee80211_band band,
4623 int index)
4624{
4625 return (sta == NULL || sta->supp_rates[band] & BIT(index));
4626}
4627
Luis R. Rodriguez4c6d4f52009-07-16 10:05:41 -07004628/**
4629 * rate_control_send_low - helper for drivers for management/no-ack frames
4630 *
4631 * Rate control algorithms that agree to use the lowest rate to
4632 * send management frames and NO_ACK data with the respective hw
4633 * retries should use this in the beginning of their mac80211 get_rate
4634 * callback. If true is returned the rate control can simply return.
4635 * If false is returned we guarantee that sta and sta and priv_sta is
4636 * not null.
4637 *
4638 * Rate control algorithms wishing to do more intelligent selection of
4639 * rate for multicast/broadcast frames may choose to not use this.
4640 *
4641 * @sta: &struct ieee80211_sta pointer to the target destination. Note
4642 * that this may be null.
4643 * @priv_sta: private rate control structure. This may be null.
4644 * @txrc: rate control information we sholud populate for mac80211.
4645 */
4646bool rate_control_send_low(struct ieee80211_sta *sta,
4647 void *priv_sta,
4648 struct ieee80211_tx_rate_control *txrc);
4649
4650
Johannes Berg4b7679a2008-09-18 18:14:18 +02004651static inline s8
4652rate_lowest_index(struct ieee80211_supported_band *sband,
4653 struct ieee80211_sta *sta)
4654{
4655 int i;
4656
4657 for (i = 0; i < sband->n_bitrates; i++)
4658 if (rate_supported(sta, sband->band, i))
4659 return i;
4660
4661 /* warn when we cannot find a rate. */
Johannes Berg54d50262011-11-04 18:07:43 +01004662 WARN_ON_ONCE(1);
Johannes Berg4b7679a2008-09-18 18:14:18 +02004663
Johannes Berg54d50262011-11-04 18:07:43 +01004664 /* and return 0 (the lowest index) */
Johannes Berg4b7679a2008-09-18 18:14:18 +02004665 return 0;
4666}
4667
Luis R. Rodriguezb770b432009-07-16 10:15:09 -07004668static inline
4669bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
4670 struct ieee80211_sta *sta)
4671{
4672 unsigned int i;
4673
4674 for (i = 0; i < sband->n_bitrates; i++)
4675 if (rate_supported(sta, sband->band, i))
4676 return true;
4677 return false;
4678}
Johannes Berg4b7679a2008-09-18 18:14:18 +02004679
Felix Fietkau0d528d82013-04-22 16:14:41 +02004680/**
4681 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
4682 *
4683 * When not doing a rate control probe to test rates, rate control should pass
4684 * its rate selection to mac80211. If the driver supports receiving a station
4685 * rate table, it will use it to ensure that frames are always sent based on
4686 * the most recent rate control module decision.
4687 *
4688 * @hw: pointer as obtained from ieee80211_alloc_hw()
4689 * @pubsta: &struct ieee80211_sta pointer to the target destination.
4690 * @rates: new tx rate set to be used for this station.
4691 */
4692int rate_control_set_rates(struct ieee80211_hw *hw,
4693 struct ieee80211_sta *pubsta,
4694 struct ieee80211_sta_rates *rates);
4695
Johannes Berg631ad702014-01-20 23:29:34 +01004696int ieee80211_rate_control_register(const struct rate_control_ops *ops);
4697void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
Johannes Berg4b7679a2008-09-18 18:14:18 +02004698
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08004699static inline bool
4700conf_is_ht20(struct ieee80211_conf *conf)
4701{
Karl Beldan675a0b02013-03-25 16:26:57 +01004702 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08004703}
4704
4705static inline bool
4706conf_is_ht40_minus(struct ieee80211_conf *conf)
4707{
Karl Beldan675a0b02013-03-25 16:26:57 +01004708 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
4709 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08004710}
4711
4712static inline bool
4713conf_is_ht40_plus(struct ieee80211_conf *conf)
4714{
Karl Beldan675a0b02013-03-25 16:26:57 +01004715 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
4716 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08004717}
4718
4719static inline bool
4720conf_is_ht40(struct ieee80211_conf *conf)
4721{
Karl Beldan675a0b02013-03-25 16:26:57 +01004722 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08004723}
4724
4725static inline bool
4726conf_is_ht(struct ieee80211_conf *conf)
4727{
Rostislav Lisovy041f6072014-04-02 15:31:55 +02004728 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
4729 (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
4730 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08004731}
4732
Johannes Berg2ca27bc2010-09-16 14:58:23 +02004733static inline enum nl80211_iftype
4734ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
4735{
4736 if (p2p) {
4737 switch (type) {
4738 case NL80211_IFTYPE_STATION:
4739 return NL80211_IFTYPE_P2P_CLIENT;
4740 case NL80211_IFTYPE_AP:
4741 return NL80211_IFTYPE_P2P_GO;
4742 default:
4743 break;
4744 }
4745 }
4746 return type;
4747}
4748
4749static inline enum nl80211_iftype
4750ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
4751{
4752 return ieee80211_iftype_p2p(vif->type, vif->p2p);
4753}
4754
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -07004755void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
4756 int rssi_min_thold,
4757 int rssi_max_thold);
4758
4759void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
Arik Nemtsov768db342011-09-28 14:12:51 +03004760
Wey-Yi Guy0d8a0a12012-04-20 11:57:00 -07004761/**
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004762 * ieee80211_ave_rssi - report the average RSSI for the specified interface
Wey-Yi Guy0d8a0a12012-04-20 11:57:00 -07004763 *
4764 * @vif: the specified virtual interface
4765 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004766 * Note: This function assumes that the given vif is valid.
4767 *
4768 * Return: The average RSSI value for the requested interface, or 0 if not
4769 * applicable.
Wey-Yi Guy0d8a0a12012-04-20 11:57:00 -07004770 */
Wey-Yi Guy1dae27f2012-04-13 12:02:57 -07004771int ieee80211_ave_rssi(struct ieee80211_vif *vif);
4772
Johannes Bergcd8f7cb2013-01-22 12:34:29 +01004773/**
4774 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
4775 * @vif: virtual interface
4776 * @wakeup: wakeup reason(s)
4777 * @gfp: allocation flags
4778 *
4779 * See cfg80211_report_wowlan_wakeup().
4780 */
4781void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
4782 struct cfg80211_wowlan_wakeup *wakeup,
4783 gfp_t gfp);
4784
Felix Fietkau06be6b12013-10-14 18:01:00 +02004785/**
4786 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
4787 * @hw: pointer as obtained from ieee80211_alloc_hw()
4788 * @vif: virtual interface
4789 * @skb: frame to be sent from within the driver
4790 * @band: the band to transmit on
4791 * @sta: optional pointer to get the station to send the frame to
4792 *
4793 * Note: must be called under RCU lock
4794 */
4795bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
4796 struct ieee80211_vif *vif, struct sk_buff *skb,
4797 int band, struct ieee80211_sta **sta);
4798
Felix Fietkaua7022e62013-12-16 21:49:14 +01004799/**
4800 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
4801 *
4802 * @next_tsf: TSF timestamp of the next absent state change
4803 * @has_next_tsf: next absent state change event pending
4804 *
4805 * @absent: descriptor bitmask, set if GO is currently absent
4806 *
4807 * private:
4808 *
4809 * @count: count fields from the NoA descriptors
4810 * @desc: adjusted data from the NoA
4811 */
4812struct ieee80211_noa_data {
4813 u32 next_tsf;
4814 bool has_next_tsf;
4815
4816 u8 absent;
4817
4818 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
4819 struct {
4820 u32 start;
4821 u32 duration;
4822 u32 interval;
4823 } desc[IEEE80211_P2P_NOA_DESC_MAX];
4824};
4825
4826/**
4827 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
4828 *
4829 * @attr: P2P NoA IE
4830 * @data: NoA tracking data
4831 * @tsf: current TSF timestamp
4832 *
4833 * Return: number of successfully parsed descriptors
4834 */
4835int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
4836 struct ieee80211_noa_data *data, u32 tsf);
4837
4838/**
4839 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
4840 *
4841 * @data: NoA tracking data
4842 * @tsf: current TSF timestamp
4843 */
4844void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
4845
Arik Nemtsovc887f0d32014-06-11 17:18:25 +03004846/**
4847 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
4848 * @vif: virtual interface
4849 * @peer: the peer's destination address
4850 * @oper: the requested TDLS operation
4851 * @reason_code: reason code for the operation, valid for TDLS teardown
4852 * @gfp: allocation flags
4853 *
4854 * See cfg80211_tdls_oper_request().
4855 */
4856void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
4857 enum nl80211_tdls_operation oper,
4858 u16 reason_code, gfp_t gfp);
Jiri Bencf0706e82007-05-05 11:45:53 -07004859#endif /* MAC80211_H */