blob: 3cd408b326de7400b00e6284be2524955beefe27 [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.
69 *
70 * Finally, for received frames, the driver is able to indicate that it has
71 * filled a radiotap header and put that in front of the frame; if it does
72 * not do so then mac80211 may add this under certain circumstances.
Jiri Bencf0706e82007-05-05 11:45:53 -070073 */
74
Ron Rindjunsky10816d42007-11-26 16:14:30 +020075/**
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -040076 * DOC: mac80211 workqueue
77 *
78 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
79 * The workqueue is a single threaded workqueue and can only be accessed by
80 * helpers for sanity checking. Drivers must ensure all work added onto the
81 * mac80211 workqueue should be cancelled on the driver stop() callback.
82 *
83 * mac80211 will flushed the workqueue upon interface removal and during
84 * suspend.
85 *
86 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
87 *
88 */
89
Paul Gortmaker313162d2012-01-30 11:46:54 -050090struct device;
91
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -040092/**
Johannes Berge100bb62008-04-30 18:51:21 +020093 * enum ieee80211_max_queues - maximum number of queues
94 *
95 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
Johannes Berg445ea4e2013-02-13 12:25:28 +010096 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
Johannes Berge100bb62008-04-30 18:51:21 +020097 */
98enum ieee80211_max_queues {
Johannes Berg3a25a8c2012-04-03 16:28:50 +020099 IEEE80211_MAX_QUEUES = 16,
Johannes Berg445ea4e2013-02-13 12:25:28 +0100100 IEEE80211_MAX_QUEUE_MAP = BIT(IEEE80211_MAX_QUEUES) - 1,
Johannes Berge100bb62008-04-30 18:51:21 +0200101};
102
Johannes Berg3a25a8c2012-04-03 16:28:50 +0200103#define IEEE80211_INVAL_HW_QUEUE 0xff
104
Johannes Berge100bb62008-04-30 18:51:21 +0200105/**
Johannes Berg4bce22b2010-11-16 11:49:58 -0800106 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
107 * @IEEE80211_AC_VO: voice
108 * @IEEE80211_AC_VI: video
109 * @IEEE80211_AC_BE: best effort
110 * @IEEE80211_AC_BK: background
111 */
112enum ieee80211_ac_numbers {
113 IEEE80211_AC_VO = 0,
114 IEEE80211_AC_VI = 1,
115 IEEE80211_AC_BE = 2,
116 IEEE80211_AC_BK = 3,
117};
Johannes Berg948d8872011-09-29 16:04:29 +0200118#define IEEE80211_NUM_ACS 4
Johannes Berg4bce22b2010-11-16 11:49:58 -0800119
120/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400121 * struct ieee80211_tx_queue_params - transmit queue configuration
122 *
123 * The information provided in this structure is required for QoS
Johannes Berg3330d7b2008-02-10 16:49:38 +0100124 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400125 *
Bob Copelande37d4df2008-10-20 21:20:27 -0400126 * @aifs: arbitration interframe space [0..255]
Johannes Bergf434b2d2008-07-10 11:22:31 +0200127 * @cw_min: minimum contention window [a value of the form
128 * 2^n-1 in the range 1..32767]
Johannes Berg6b301cd2007-09-18 17:29:20 -0400129 * @cw_max: maximum contention window [like @cw_min]
Johannes Berg3330d7b2008-02-10 16:49:38 +0100130 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
Alexander Bondar908f8d02013-04-07 09:53:30 +0300131 * @acm: is mandatory admission control required for the access category
Kalle Valo9d173fc2010-01-14 13:09:14 +0200132 * @uapsd: is U-APSD mode enabled for the queue
Johannes Berg6b301cd2007-09-18 17:29:20 -0400133 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700134struct ieee80211_tx_queue_params {
Johannes Bergf434b2d2008-07-10 11:22:31 +0200135 u16 txop;
Johannes Berg3330d7b2008-02-10 16:49:38 +0100136 u16 cw_min;
137 u16 cw_max;
Johannes Bergf434b2d2008-07-10 11:22:31 +0200138 u8 aifs;
Alexander Bondar908f8d02013-04-07 09:53:30 +0300139 bool acm;
Kalle Valoab133152010-01-12 10:42:31 +0200140 bool uapsd;
Jiri Bencf0706e82007-05-05 11:45:53 -0700141};
142
Jiri Bencf0706e82007-05-05 11:45:53 -0700143struct ieee80211_low_level_stats {
144 unsigned int dot11ACKFailureCount;
145 unsigned int dot11RTSFailureCount;
146 unsigned int dot11FCSErrorCount;
147 unsigned int dot11RTSSuccessCount;
148};
149
Johannes Berg471b3ef2007-12-28 14:32:58 +0100150/**
Michal Kaziord01a1e62012-06-26 14:37:16 +0200151 * enum ieee80211_chanctx_change - change flag for channel context
Johannes Berg4bf88532012-11-09 11:39:59 +0100152 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
Johannes Berg04ecd252012-09-11 14:34:12 +0200153 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
Simon Wunderlich164eb022013-02-08 18:16:20 +0100154 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
Simon Wunderlich73da7d52013-07-11 16:09:06 +0200155 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
156 * this is used only with channel switching with CSA
Eliad Peller21f659b2013-11-11 20:14:01 +0200157 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
Michal Kaziord01a1e62012-06-26 14:37:16 +0200158 */
159enum ieee80211_chanctx_change {
Johannes Berg4bf88532012-11-09 11:39:59 +0100160 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0),
Johannes Berg04ecd252012-09-11 14:34:12 +0200161 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1),
Simon Wunderlich164eb022013-02-08 18:16:20 +0100162 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2),
Simon Wunderlich73da7d52013-07-11 16:09:06 +0200163 IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(3),
Eliad Peller21f659b2013-11-11 20:14:01 +0200164 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH = BIT(4),
Michal Kaziord01a1e62012-06-26 14:37:16 +0200165};
166
167/**
168 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
169 *
170 * This is the driver-visible part. The ieee80211_chanctx
171 * that contains it is visible in mac80211 only.
172 *
Johannes Berg4bf88532012-11-09 11:39:59 +0100173 * @def: the channel definition
Eliad Peller21f659b2013-11-11 20:14:01 +0200174 * @min_def: the minimum channel definition currently required.
Johannes Berg04ecd252012-09-11 14:34:12 +0200175 * @rx_chains_static: The number of RX chains that must always be
176 * active on the channel to receive MIMO transmissions
177 * @rx_chains_dynamic: The number of RX chains that must be enabled
178 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
Simon Wunderlich5d7fad42012-11-30 19:17:28 +0100179 * this will always be >= @rx_chains_static.
Simon Wunderlich164eb022013-02-08 18:16:20 +0100180 * @radar_enabled: whether radar detection is enabled on this channel.
Michal Kaziord01a1e62012-06-26 14:37:16 +0200181 * @drv_priv: data area for driver use, will always be aligned to
182 * sizeof(void *), size is determined in hw information.
183 */
184struct ieee80211_chanctx_conf {
Johannes Berg4bf88532012-11-09 11:39:59 +0100185 struct cfg80211_chan_def def;
Eliad Peller21f659b2013-11-11 20:14:01 +0200186 struct cfg80211_chan_def min_def;
Michal Kaziord01a1e62012-06-26 14:37:16 +0200187
Johannes Berg04ecd252012-09-11 14:34:12 +0200188 u8 rx_chains_static, rx_chains_dynamic;
189
Simon Wunderlich164eb022013-02-08 18:16:20 +0100190 bool radar_enabled;
191
Johannes Berg1c06ef92012-12-28 12:22:02 +0100192 u8 drv_priv[0] __aligned(sizeof(void *));
Michal Kaziord01a1e62012-06-26 14:37:16 +0200193};
194
195/**
Johannes Berg471b3ef2007-12-28 14:32:58 +0100196 * enum ieee80211_bss_change - BSS change notification flags
197 *
198 * These flags are used with the bss_info_changed() callback
199 * to indicate which BSS parameter changed.
200 *
201 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
202 * also implies a change in the AID.
203 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
204 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300205 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler38668c02008-03-28 16:33:32 -0700206 * @BSS_CHANGED_HT: 802.11n parameters changed
Johannes Berg96dd22a2008-09-11 00:01:57 +0200207 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200208 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200209 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
210 * reason (IBSS and managed mode)
211 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
212 * new beacon (beaconing modes)
213 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
214 * enabled/disabled (beaconing modes)
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200215 * @BSS_CHANGED_CQM: Connection quality monitor config changed
Johannes Berg8fc214b2010-04-28 17:40:43 +0200216 * @BSS_CHANGED_IBSS: IBSS join status changed
Juuso Oikarinen68542962010-06-09 13:43:26 +0300217 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
Johannes Berg4ced3f72010-07-19 16:39:04 +0200218 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
219 * that it is only ever disabled for station mode.
Johannes Berg7da7cc12010-08-05 17:02:38 +0200220 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
Marek Puzyniak0ca54f62013-04-10 13:19:13 +0200221 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
Arik Nemtsov02945822011-11-10 11:28:57 +0200222 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
Eliad Pellerab095872012-07-27 12:33:22 +0300223 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
Johannes Berg1ea6f9c2012-10-24 10:59:25 +0200224 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
Johannes Berg488dd7b2012-10-29 20:08:01 +0100225 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
226 * changed (currently only in P2P client mode, GO mode will be later)
Alexander Bondar989c6502013-05-16 17:34:17 +0300227 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
228 * currently dtim_period only is under consideration.
Johannes Berg2c9b7352013-02-07 21:37:29 +0100229 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
230 * note that this is only called when it changes after the channel
231 * context had been assigned.
Johannes Berg471b3ef2007-12-28 14:32:58 +0100232 */
233enum ieee80211_bss_change {
234 BSS_CHANGED_ASSOC = 1<<0,
235 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
236 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300237 BSS_CHANGED_ERP_SLOT = 1<<3,
Alexander Simona7ce1c92011-09-18 00:16:45 +0200238 BSS_CHANGED_HT = 1<<4,
Johannes Berg96dd22a2008-09-11 00:01:57 +0200239 BSS_CHANGED_BASIC_RATES = 1<<5,
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200240 BSS_CHANGED_BEACON_INT = 1<<6,
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200241 BSS_CHANGED_BSSID = 1<<7,
242 BSS_CHANGED_BEACON = 1<<8,
243 BSS_CHANGED_BEACON_ENABLED = 1<<9,
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200244 BSS_CHANGED_CQM = 1<<10,
Johannes Berg8fc214b2010-04-28 17:40:43 +0200245 BSS_CHANGED_IBSS = 1<<11,
Juuso Oikarinen68542962010-06-09 13:43:26 +0300246 BSS_CHANGED_ARP_FILTER = 1<<12,
Johannes Berg4ced3f72010-07-19 16:39:04 +0200247 BSS_CHANGED_QOS = 1<<13,
Johannes Berg7da7cc12010-08-05 17:02:38 +0200248 BSS_CHANGED_IDLE = 1<<14,
Arik Nemtsov78274932011-09-04 11:11:32 +0300249 BSS_CHANGED_SSID = 1<<15,
Arik Nemtsov02945822011-11-10 11:28:57 +0200250 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
Eliad Pellerab095872012-07-27 12:33:22 +0300251 BSS_CHANGED_PS = 1<<17,
Johannes Berg1ea6f9c2012-10-24 10:59:25 +0200252 BSS_CHANGED_TXPOWER = 1<<18,
Johannes Berg488dd7b2012-10-29 20:08:01 +0100253 BSS_CHANGED_P2P_PS = 1<<19,
Alexander Bondar989c6502013-05-16 17:34:17 +0300254 BSS_CHANGED_BEACON_INFO = 1<<20,
Johannes Berg2c9b7352013-02-07 21:37:29 +0100255 BSS_CHANGED_BANDWIDTH = 1<<21,
Johannes Bergac8dd502010-05-05 09:44:02 +0200256
257 /* when adding here, make sure to change ieee80211_reconfig */
Johannes Berg471b3ef2007-12-28 14:32:58 +0100258};
259
Juuso Oikarinen68542962010-06-09 13:43:26 +0300260/*
261 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
262 * of addresses for an interface increase beyond this value, hardware ARP
263 * filtering will be disabled.
264 */
265#define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
266
Johannes Berg471b3ef2007-12-28 14:32:58 +0100267/**
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -0700268 * enum ieee80211_rssi_event - RSSI threshold event
269 * An indicator for when RSSI goes below/above a certain threshold.
270 * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
271 * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
272 */
273enum ieee80211_rssi_event {
274 RSSI_EVENT_HIGH,
275 RSSI_EVENT_LOW,
276};
277
278/**
Johannes Berg471b3ef2007-12-28 14:32:58 +0100279 * struct ieee80211_bss_conf - holds the BSS's changing parameters
280 *
281 * This structure keeps information about a BSS (and an association
282 * to that BSS) that can change during the lifetime of the BSS.
283 *
284 * @assoc: association status
Johannes Berg8fc214b2010-04-28 17:40:43 +0200285 * @ibss_joined: indicates whether this station is part of an IBSS
286 * or not
Sujith Manoharanc13a7652012-10-12 17:35:45 +0530287 * @ibss_creator: indicates if a new IBSS network is being created
Johannes Berg471b3ef2007-12-28 14:32:58 +0100288 * @aid: association ID number, valid only when @assoc is true
289 * @use_cts_prot: use CTS protection
Johannes Berg7a5158e2008-10-08 10:59:33 +0200290 * @use_short_preamble: use 802.11b short preamble;
291 * if the hardware cannot handle this it must set the
292 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
293 * @use_short_slot: use short slot time (only relevant for ERP);
294 * if the hardware cannot handle this it must set the
295 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
Johannes Berg56007a02010-01-26 14:19:52 +0100296 * @dtim_period: num of beacons before the next DTIM, for beaconing,
Emmanuel Grumbachc65dd142012-12-12 10:12:24 +0200297 * valid in station mode only if after the driver was notified
Alexander Bondar989c6502013-05-16 17:34:17 +0300298 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
Johannes Berg8c358bc2012-05-22 22:13:05 +0200299 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
Johannes Bergef429da2013-02-05 17:48:40 +0100300 * as it may have been received during scanning long ago). If the
301 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
302 * only come from a beacon, but might not become valid until after
303 * association when a beacon is received (which is notified with the
304 * %BSS_CHANGED_DTIM flag.)
Johannes Berg8c358bc2012-05-22 22:13:05 +0200305 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
306 * the driver/device can use this to calculate synchronisation
Johannes Bergef429da2013-02-05 17:48:40 +0100307 * (see @sync_tsf)
308 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
309 * is requested, see @sync_tsf/@sync_device_ts.
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700310 * @beacon_int: beacon interval
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800311 * @assoc_capability: capabilities taken from assoc resp
Johannes Berg96dd22a2008-09-11 00:01:57 +0200312 * @basic_rates: bitmap of basic rates, each bit stands for an
313 * index into the rate table configured by the driver in
314 * the current band.
Alexander Bondar817cee72013-05-19 14:23:57 +0300315 * @beacon_rate: associated AP's beacon TX rate
Felix Fietkaudd5b4cc2010-11-22 20:58:24 +0100316 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200317 * @bssid: The BSSID for this BSS
318 * @enable_beacon: whether beaconing should be enabled or not
Johannes Berg4bf88532012-11-09 11:39:59 +0100319 * @chandef: Channel definition for this BSS -- the hardware might be
320 * configured a higher bandwidth than this BSS uses, for example.
Johannes Berg074d46d2012-03-15 19:45:16 +0100321 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200322 * This field is only valid when the channel type is one of the HT types.
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200323 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
324 * implies disabled
325 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
Juuso Oikarinen68542962010-06-09 13:43:26 +0300326 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
327 * may filter ARP queries targeted for other addresses than listed here.
328 * The driver must allow ARP queries targeted for all address listed here
329 * to pass through. An empty list implies no ARP queries need to pass.
Johannes Berg0f19b412013-01-14 16:39:07 +0100330 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
331 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
332 * array size), it's up to the driver what to do in that case.
Johannes Berg4ced3f72010-07-19 16:39:04 +0200333 * @qos: This is a QoS-enabled BSS.
Johannes Berg7da7cc12010-08-05 17:02:38 +0200334 * @idle: This interface is idle. There's also a global idle flag in the
335 * hardware config which may be more appropriate depending on what
336 * your driver/device needs to do.
Eliad Pellerab095872012-07-27 12:33:22 +0300337 * @ps: power-save mode (STA only). This flag is NOT affected by
338 * offchannel/dynamic_ps operations.
Marek Puzyniak0ca54f62013-04-10 13:19:13 +0200339 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
Arik Nemtsov78274932011-09-04 11:11:32 +0300340 * @ssid_len: Length of SSID given in @ssid.
341 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
Johannes Berg1ea6f9c2012-10-24 10:59:25 +0200342 * @txpower: TX power in dBm
Janusz Dziedzic67baf662013-03-21 15:47:56 +0100343 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
Johannes Berg471b3ef2007-12-28 14:32:58 +0100344 */
345struct ieee80211_bss_conf {
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200346 const u8 *bssid;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100347 /* association related data */
Johannes Berg8fc214b2010-04-28 17:40:43 +0200348 bool assoc, ibss_joined;
Sujith Manoharanc13a7652012-10-12 17:35:45 +0530349 bool ibss_creator;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100350 u16 aid;
351 /* erp related data */
352 bool use_cts_prot;
353 bool use_short_preamble;
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300354 bool use_short_slot;
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200355 bool enable_beacon;
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800356 u8 dtim_period;
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700357 u16 beacon_int;
358 u16 assoc_capability;
Johannes Berg8c358bc2012-05-22 22:13:05 +0200359 u64 sync_tsf;
360 u32 sync_device_ts;
Johannes Bergef429da2013-02-05 17:48:40 +0100361 u8 sync_dtim_count;
Johannes Berg881d9482009-01-21 15:13:48 +0100362 u32 basic_rates;
Alexander Bondar817cee72013-05-19 14:23:57 +0300363 struct ieee80211_rate *beacon_rate;
Felix Fietkaudd5b4cc2010-11-22 20:58:24 +0100364 int mcast_rate[IEEE80211_NUM_BANDS];
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200365 u16 ht_operation_mode;
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200366 s32 cqm_rssi_thold;
367 u32 cqm_rssi_hyst;
Johannes Berg4bf88532012-11-09 11:39:59 +0100368 struct cfg80211_chan_def chandef;
Juuso Oikarinen68542962010-06-09 13:43:26 +0300369 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
Johannes Berg0f19b412013-01-14 16:39:07 +0100370 int arp_addr_cnt;
Johannes Berg4ced3f72010-07-19 16:39:04 +0200371 bool qos;
Johannes Berg7da7cc12010-08-05 17:02:38 +0200372 bool idle;
Eliad Pellerab095872012-07-27 12:33:22 +0300373 bool ps;
Arik Nemtsov78274932011-09-04 11:11:32 +0300374 u8 ssid[IEEE80211_MAX_SSID_LEN];
375 size_t ssid_len;
376 bool hidden_ssid;
Johannes Berg1ea6f9c2012-10-24 10:59:25 +0200377 int txpower;
Janusz Dziedzic67baf662013-03-21 15:47:56 +0100378 struct ieee80211_p2p_noa_attr p2p_noa_attr;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100379};
380
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800381/**
Johannes Bergaf61a162013-07-02 18:09:12 +0200382 * enum mac80211_tx_info_flags - flags to describe transmission information/status
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800383 *
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700384 * These flags are used with the @flags member of &ieee80211_tx_info.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800385 *
Johannes Berg7351c6b2009-11-19 01:08:30 +0100386 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
Johannes Berge6a98542008-10-21 12:40:02 +0200387 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
388 * number to this frame, taking care of not overwriting the fragment
389 * number and increasing the sequence number only when the
390 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
391 * assign sequence numbers to QoS-data frames but cannot do so correctly
392 * for non-QoS-data and management frames because beacons need them from
393 * that counter as well and mac80211 cannot guarantee proper sequencing.
394 * If this flag is set, the driver should instruct the hardware to
395 * assign a sequence number to the frame or assign one itself. Cf. IEEE
396 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
397 * beacons and always be clear for frames without a sequence number field.
Johannes Berge039fa42008-05-15 12:55:29 +0200398 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
Johannes Berge039fa42008-05-15 12:55:29 +0200399 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
400 * station
Johannes Berge039fa42008-05-15 12:55:29 +0200401 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
Johannes Berge039fa42008-05-15 12:55:29 +0200402 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
403 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
Johannes Berge6a98542008-10-21 12:40:02 +0200404 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
Johannes Berge039fa42008-05-15 12:55:29 +0200405 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
Johannes Bergab5b5342009-08-07 16:28:09 +0200406 * because the destination STA was in powersave mode. Note that to
407 * avoid race conditions, the filter must be set by the hardware or
408 * firmware upon receiving a frame that indicates that the station
409 * went to sleep (must be done on device to filter frames already on
410 * the queue) and may only be unset after mac80211 gives the OK for
411 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
412 * since only then is it guaranteed that no more frames are in the
413 * hardware queue.
Johannes Berge039fa42008-05-15 12:55:29 +0200414 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
415 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
416 * is for the whole aggregation.
Ron Rindjunsky429a3802008-07-01 14:16:03 +0300417 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
418 * so consider using block ack request (BAR).
Johannes Berge6a98542008-10-21 12:40:02 +0200419 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
420 * set by rate control algorithms to indicate probe rate, will
421 * be cleared for fragmented frames (except on the last fragment)
Seth Forshee6c17b772013-02-11 11:21:07 -0600422 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
423 * that a frame can be transmitted while the queues are stopped for
424 * off-channel operation.
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100425 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
426 * used to indicate that a pending frame requires TX processing before
427 * it can be sent out.
Johannes Berg8f77f382009-06-07 21:58:37 +0200428 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
429 * used to indicate that a frame was already retried due to PS
Johannes Berg3b8d81e02009-06-17 17:43:56 +0200430 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
431 * used to indicate frame should not be encrypted
Johannes Berg02f2f1a2012-02-27 12:18:30 +0100432 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
433 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
434 * be sent although the station is in powersave mode.
Johannes Bergad5351d2009-08-07 16:42:15 +0200435 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
436 * transmit function after the current frame, this can be used
437 * by drivers to kick the DMA queue only if unset or when the
438 * queue gets full.
Johannes Bergc6fcf6b2010-01-17 01:47:59 +0100439 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
440 * after TX status because the destination was asleep, it must not
441 * be modified again (no seqno assignment, crypto, etc.)
Johannes Berg1672c0e32013-01-29 15:02:27 +0100442 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
443 * code for connection establishment, this indicates that its status
444 * should kick the MLME state machine.
Jouni Malinen026331c2010-02-15 12:53:10 +0200445 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
446 * MLME command (internal to mac80211 to figure out whether to send TX
447 * status to user space)
Luis R. Rodriguez0a56bd02010-04-15 17:39:37 -0400448 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
Felix Fietkauf79d9ba2010-04-19 19:57:35 +0200449 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
450 * frame and selects the maximum number of streams that it can use.
Johannes Berg610dbc92011-01-06 22:36:44 +0100451 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
452 * the off-channel channel when a remain-on-channel offload is done
453 * in hardware -- normal packets still flow and are expected to be
454 * handled properly by the device.
Jouni Malinen681d1192011-02-03 18:35:19 +0200455 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
456 * testing. It will be sent out with incorrect Michael MIC key to allow
457 * TKIP countermeasures to be tested.
Rajkumar Manoharanaad14ce2011-09-25 14:53:31 +0530458 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
459 * This flag is actually used for management frame especially for P2P
460 * frames not being sent at CCK rate in 2GHz band.
Johannes Berg47086fc2011-09-29 16:04:33 +0200461 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
462 * when its status is reported the service period ends. For frames in
463 * an SP that mac80211 transmits, it is already set; for driver frames
Johannes Bergdeeaee12011-09-29 16:04:35 +0200464 * the driver may set this flag. It is also used to do the same for
465 * PS-Poll responses.
Rajkumar Manoharanb6f35302011-09-29 20:34:04 +0530466 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
467 * This flag is used to send nullfunc frame at minimum rate when
468 * the nullfunc is used for connection monitoring purpose.
Johannes Berga26eb272011-10-07 14:01:25 +0200469 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
470 * would be fragmented by size (this is optional, only used for
471 * monitor injection).
Felix Fietkaud6d23de22013-06-04 12:15:42 +0200472 * @IEEE80211_TX_CTL_PS_RESPONSE: This frame is a response to a poll
473 * frame (PS-Poll or uAPSD).
Christian Lampartereb7d3062010-09-21 21:36:18 +0200474 *
475 * Note: If you have to add new flags to the enumeration, then don't
476 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800477 */
Johannes Bergaf61a162013-07-02 18:09:12 +0200478enum mac80211_tx_info_flags {
Johannes Berge039fa42008-05-15 12:55:29 +0200479 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
Johannes Berge6a98542008-10-21 12:40:02 +0200480 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
481 IEEE80211_TX_CTL_NO_ACK = BIT(2),
482 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
483 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
484 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
485 IEEE80211_TX_CTL_AMPDU = BIT(6),
486 IEEE80211_TX_CTL_INJECTED = BIT(7),
487 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
488 IEEE80211_TX_STAT_ACK = BIT(9),
489 IEEE80211_TX_STAT_AMPDU = BIT(10),
490 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
491 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
Seth Forshee6c17b772013-02-11 11:21:07 -0600492 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100493 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
Johannes Berg8f77f382009-06-07 21:58:37 +0200494 IEEE80211_TX_INTFL_RETRIED = BIT(15),
Johannes Berg3b8d81e02009-06-17 17:43:56 +0200495 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
Johannes Berg02f2f1a2012-02-27 12:18:30 +0100496 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
Johannes Bergad5351d2009-08-07 16:42:15 +0200497 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
Johannes Bergc6fcf6b2010-01-17 01:47:59 +0100498 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
Johannes Berg1672c0e32013-01-29 15:02:27 +0100499 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
Jouni Malinen026331c2010-02-15 12:53:10 +0200500 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
Luis R. Rodriguez0a56bd02010-04-15 17:39:37 -0400501 IEEE80211_TX_CTL_LDPC = BIT(22),
Felix Fietkauf79d9ba2010-04-19 19:57:35 +0200502 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
Johannes Berg21f83582010-12-18 17:20:47 +0100503 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
Jouni Malinen681d1192011-02-03 18:35:19 +0200504 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
Rajkumar Manoharanaad14ce2011-09-25 14:53:31 +0530505 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
Johannes Berg47086fc2011-09-29 16:04:33 +0200506 IEEE80211_TX_STATUS_EOSP = BIT(28),
Rajkumar Manoharanb6f35302011-09-29 20:34:04 +0530507 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
Johannes Berga26eb272011-10-07 14:01:25 +0200508 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
Felix Fietkaud6d23de22013-06-04 12:15:42 +0200509 IEEE80211_TX_CTL_PS_RESPONSE = BIT(31),
Johannes Berge6a98542008-10-21 12:40:02 +0200510};
511
Johannes Bergabe37c42010-06-07 11:12:27 +0200512#define IEEE80211_TX_CTL_STBC_SHIFT 23
513
Johannes Bergaf61a162013-07-02 18:09:12 +0200514/**
515 * enum mac80211_tx_control_flags - flags to describe transmit control
516 *
517 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
518 * protocol frame (e.g. EAP)
519 *
520 * These flags are used in tx_info->control.flags.
521 */
522enum mac80211_tx_control_flags {
523 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
524};
525
Christian Lampartereb7d3062010-09-21 21:36:18 +0200526/*
527 * This definition is used as a mask to clear all temporary flags, which are
528 * set by the tx handlers for each transmission attempt by the mac80211 stack.
529 */
530#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
531 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
532 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
533 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
534 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
Johannes Berg02f2f1a2012-02-27 12:18:30 +0100535 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
Christian Lampartereb7d3062010-09-21 21:36:18 +0200536 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
Johannes Berg47086fc2011-09-29 16:04:33 +0200537 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
Christian Lampartereb7d3062010-09-21 21:36:18 +0200538
Sujith2134e7e2009-01-22 09:00:52 +0530539/**
540 * enum mac80211_rate_control_flags - per-rate flags set by the
541 * Rate Control algorithm.
542 *
543 * These flags are set by the Rate control algorithm for each rate during tx,
544 * in the @flags member of struct ieee80211_tx_rate.
545 *
546 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
547 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
548 * This is set if the current BSS requires ERP protection.
549 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
550 * @IEEE80211_TX_RC_MCS: HT rate.
Johannes Berg8bc83c22012-11-09 18:38:32 +0100551 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
552 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
Sujith2134e7e2009-01-22 09:00:52 +0530553 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
554 * Greenfield mode.
555 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
Johannes Berg8bc83c22012-11-09 18:38:32 +0100556 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
557 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
558 * (80+80 isn't supported yet)
Sujith2134e7e2009-01-22 09:00:52 +0530559 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
560 * adjacent 20 MHz channels, if the current channel type is
561 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
562 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
563 */
Johannes Berge6a98542008-10-21 12:40:02 +0200564enum mac80211_rate_control_flags {
565 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
566 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
567 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
568
Johannes Berg8bc83c22012-11-09 18:38:32 +0100569 /* rate index is an HT/VHT MCS instead of an index */
Johannes Berge6a98542008-10-21 12:40:02 +0200570 IEEE80211_TX_RC_MCS = BIT(3),
571 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
572 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
573 IEEE80211_TX_RC_DUP_DATA = BIT(6),
574 IEEE80211_TX_RC_SHORT_GI = BIT(7),
Johannes Berg8bc83c22012-11-09 18:38:32 +0100575 IEEE80211_TX_RC_VHT_MCS = BIT(8),
576 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
577 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800578};
579
Johannes Berge039fa42008-05-15 12:55:29 +0200580
Johannes Berge6a98542008-10-21 12:40:02 +0200581/* there are 40 bytes if you don't need the rateset to be kept */
582#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
Johannes Berge039fa42008-05-15 12:55:29 +0200583
Johannes Berge6a98542008-10-21 12:40:02 +0200584/* if you do need the rateset, then you have less space */
585#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
586
587/* maximum number of rate stages */
Thomas Huehne3e1a0b2012-07-02 19:46:16 +0200588#define IEEE80211_TX_MAX_RATES 4
Felix Fietkau870abdf2008-10-05 18:04:24 +0200589
Felix Fietkau0d528d82013-04-22 16:14:41 +0200590/* maximum number of rate table entries */
591#define IEEE80211_TX_RATE_TABLE_SIZE 4
592
Felix Fietkau870abdf2008-10-05 18:04:24 +0200593/**
Johannes Berge6a98542008-10-21 12:40:02 +0200594 * struct ieee80211_tx_rate - rate selection/status
Felix Fietkau870abdf2008-10-05 18:04:24 +0200595 *
Johannes Berge6a98542008-10-21 12:40:02 +0200596 * @idx: rate index to attempt to send with
597 * @flags: rate control flags (&enum mac80211_rate_control_flags)
Johannes Berge25cf4a2008-10-23 08:51:20 +0200598 * @count: number of tries in this rate before going to the next rate
Johannes Berge6a98542008-10-21 12:40:02 +0200599 *
600 * A value of -1 for @idx indicates an invalid rate and, if used
601 * in an array of retry rates, that no more rates should be tried.
602 *
603 * When used for transmit status reporting, the driver should
604 * always report the rate along with the flags it used.
Johannes Bergc555b9b2009-08-07 16:23:43 +0200605 *
606 * &struct ieee80211_tx_info contains an array of these structs
607 * in the control information, and it will be filled by the rate
608 * control algorithm according to what should be sent. For example,
609 * if this array contains, in the format { <idx>, <count> } the
610 * information
611 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
612 * then this means that the frame should be transmitted
613 * up to twice at rate 3, up to twice at rate 2, and up to four
614 * times at rate 1 if it doesn't get acknowledged. Say it gets
615 * acknowledged by the peer after the fifth attempt, the status
616 * information should then contain
617 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
618 * since it was transmitted twice at rate 3, twice at rate 2
619 * and once at rate 1 after which we received an acknowledgement.
Felix Fietkau870abdf2008-10-05 18:04:24 +0200620 */
Johannes Berge6a98542008-10-21 12:40:02 +0200621struct ieee80211_tx_rate {
622 s8 idx;
Johannes Berg8bc83c22012-11-09 18:38:32 +0100623 u16 count:5,
624 flags:11;
Gustavo F. Padovan3f30fc12010-07-21 10:59:58 +0000625} __packed;
Felix Fietkau870abdf2008-10-05 18:04:24 +0200626
Johannes Berg8bc83c22012-11-09 18:38:32 +0100627#define IEEE80211_MAX_TX_RETRY 31
628
629static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
630 u8 mcs, u8 nss)
631{
632 WARN_ON(mcs & ~0xF);
Karl Beldan6bc83122013-04-15 17:09:29 +0200633 WARN_ON((nss - 1) & ~0x7);
634 rate->idx = ((nss - 1) << 4) | mcs;
Johannes Berg8bc83c22012-11-09 18:38:32 +0100635}
636
637static inline u8
638ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
639{
640 return rate->idx & 0xF;
641}
642
643static inline u8
644ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
645{
Karl Beldan6bc83122013-04-15 17:09:29 +0200646 return (rate->idx >> 4) + 1;
Johannes Berg8bc83c22012-11-09 18:38:32 +0100647}
648
Johannes Berge039fa42008-05-15 12:55:29 +0200649/**
650 * struct ieee80211_tx_info - skb transmit information
Ivo van Doorn1c014422008-04-17 19:41:02 +0200651 *
Johannes Berge039fa42008-05-15 12:55:29 +0200652 * This structure is placed in skb->cb for three uses:
653 * (1) mac80211 TX control - mac80211 tells the driver what to do
654 * (2) driver internal use (if applicable)
655 * (3) TX status information - driver tells mac80211 what happened
656 *
657 * @flags: transmit info flags, defined above
Johannes Berge6a98542008-10-21 12:40:02 +0200658 * @band: the band to transmit on (use for checking for races)
Johannes Berg3a25a8c2012-04-03 16:28:50 +0200659 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
Johannes Berga729cff2011-11-06 14:13:34 +0100660 * @ack_frame_id: internal frame ID for TX status, used internally
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700661 * @control: union for control data
662 * @status: union for status data
663 * @driver_data: array of driver_data pointers
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100664 * @ampdu_ack_len: number of acked aggregated frames.
Daniel Halperin93d95b12010-04-18 09:28:18 -0700665 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100666 * @ampdu_len: number of aggregated frames.
Daniel Halperin93d95b12010-04-18 09:28:18 -0700667 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
Johannes Berge039fa42008-05-15 12:55:29 +0200668 * @ack_signal: signal strength of the ACK frame
Ivo van Doorn1c014422008-04-17 19:41:02 +0200669 */
Johannes Berge039fa42008-05-15 12:55:29 +0200670struct ieee80211_tx_info {
671 /* common information */
672 u32 flags;
673 u8 band;
Johannes Berge6a98542008-10-21 12:40:02 +0200674
Johannes Berg3a25a8c2012-04-03 16:28:50 +0200675 u8 hw_queue;
Johannes Berg8318d782008-01-24 19:38:38 +0100676
Johannes Berga729cff2011-11-06 14:13:34 +0100677 u16 ack_frame_id;
Johannes Berg8318d782008-01-24 19:38:38 +0100678
Johannes Berge039fa42008-05-15 12:55:29 +0200679 union {
680 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200681 union {
682 /* rate control */
683 struct {
684 struct ieee80211_tx_rate rates[
685 IEEE80211_TX_MAX_RATES];
686 s8 rts_cts_rate_idx;
Felix Fietkau991fec02013-04-16 13:38:43 +0200687 u8 use_rts:1;
688 u8 use_cts_prot:1;
Felix Fietkau0d528d82013-04-22 16:14:41 +0200689 u8 short_preamble:1;
690 u8 skip_table:1;
Felix Fietkau991fec02013-04-16 13:38:43 +0200691 /* 2 bytes free */
Johannes Berge6a98542008-10-21 12:40:02 +0200692 };
693 /* only needed before rate control */
694 unsigned long jiffies;
695 };
Johannes Berg25d834e2008-09-12 22:52:47 +0200696 /* NB: vif can be NULL for injected frames */
Johannes Berge039fa42008-05-15 12:55:29 +0200697 struct ieee80211_vif *vif;
698 struct ieee80211_key_conf *hw_key;
Johannes Bergaf61a162013-07-02 18:09:12 +0200699 u32 flags;
700 /* 4 bytes free */
Johannes Berge039fa42008-05-15 12:55:29 +0200701 } control;
702 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200703 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
Johannes Berge039fa42008-05-15 12:55:29 +0200704 int ack_signal;
Thomas Huehne3e1a0b2012-07-02 19:46:16 +0200705 u8 ampdu_ack_len;
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100706 u8 ampdu_len;
Johannes Bergd748b462012-03-28 11:04:23 +0200707 u8 antenna;
Thomas Huehne3e1a0b2012-07-02 19:46:16 +0200708 /* 21 bytes free */
Johannes Berge039fa42008-05-15 12:55:29 +0200709 } status;
Johannes Berge6a98542008-10-21 12:40:02 +0200710 struct {
711 struct ieee80211_tx_rate driver_rates[
712 IEEE80211_TX_MAX_RATES];
Felix Fietkau0d528d82013-04-22 16:14:41 +0200713 u8 pad[4];
714
Johannes Berge6a98542008-10-21 12:40:02 +0200715 void *rate_driver_data[
716 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
717 };
718 void *driver_data[
719 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
Johannes Berge039fa42008-05-15 12:55:29 +0200720 };
Jiri Bencf0706e82007-05-05 11:45:53 -0700721};
722
Luciano Coelho79f460c2011-05-11 17:09:36 +0300723/**
Randy Dunlapbdfbe802011-05-22 17:22:45 -0700724 * struct ieee80211_sched_scan_ies - scheduled scan IEs
Luciano Coelho79f460c2011-05-11 17:09:36 +0300725 *
726 * This structure is used to pass the appropriate IEs to be used in scheduled
727 * scans for all bands. It contains both the IEs passed from the userspace
728 * and the ones generated by mac80211.
729 *
730 * @ie: array with the IEs for each supported band
731 * @len: array with the total length of the IEs for each band
732 */
733struct ieee80211_sched_scan_ies {
734 u8 *ie[IEEE80211_NUM_BANDS];
735 size_t len[IEEE80211_NUM_BANDS];
736};
737
Johannes Berge039fa42008-05-15 12:55:29 +0200738static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
739{
740 return (struct ieee80211_tx_info *)skb->cb;
741}
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400742
Johannes Bergf1d58c22009-06-17 13:13:00 +0200743static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
744{
745 return (struct ieee80211_rx_status *)skb->cb;
746}
747
Johannes Berge6a98542008-10-21 12:40:02 +0200748/**
749 * ieee80211_tx_info_clear_status - clear TX status
750 *
751 * @info: The &struct ieee80211_tx_info to be cleared.
752 *
753 * When the driver passes an skb back to mac80211, it must report
754 * a number of things in TX status. This function clears everything
755 * in the TX status but the rate control information (it does clear
756 * the count since you need to fill that in anyway).
757 *
758 * NOTE: You can only use this function if you do NOT use
759 * info->driver_data! Use info->rate_driver_data
760 * instead if you need only the less space that allows.
761 */
762static inline void
763ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
764{
765 int i;
766
767 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
768 offsetof(struct ieee80211_tx_info, control.rates));
769 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
770 offsetof(struct ieee80211_tx_info, driver_rates));
771 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
772 /* clear the rate counts */
773 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
774 info->status.rates[i].count = 0;
775
776 BUILD_BUG_ON(
Thomas Huehne3e1a0b2012-07-02 19:46:16 +0200777 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
Johannes Berge6a98542008-10-21 12:40:02 +0200778 memset(&info->status.ampdu_ack_len, 0,
779 sizeof(struct ieee80211_tx_info) -
780 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
781}
782
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400783
784/**
785 * enum mac80211_rx_flags - receive flags
786 *
787 * These flags are used with the @flag member of &struct ieee80211_rx_status.
788 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
789 * Use together with %RX_FLAG_MMIC_STRIPPED.
790 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400791 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
792 * verification has been done by the hardware.
793 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
794 * If this flag is set, the stack cannot do any replay detection
795 * hence the driver or hardware will have to do that.
Johannes Berg72abd812007-09-17 01:29:22 -0400796 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
797 * the frame.
798 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
799 * the frame.
Thomas Pedersenf4bda332012-11-13 10:46:27 -0800800 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
Johannes Berg6ebacbb2011-02-23 15:06:08 +0100801 * field) is valid and contains the time the first symbol of the MPDU
802 * was received. This is useful in monitor mode and for proper IBSS
803 * merging.
Thomas Pedersenf4bda332012-11-13 10:46:27 -0800804 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
805 * field) is valid and contains the time the last symbol of the MPDU
806 * (including FCS) was received.
Bruno Randolfb4f28bb2008-07-30 17:19:55 +0200807 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200808 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
Johannes Berg56146182012-11-09 15:07:02 +0100809 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200810 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
Johannes Berg56146182012-11-09 15:07:02 +0100811 * @RX_FLAG_80MHZ: 80 MHz was used
812 * @RX_FLAG_80P80MHZ: 80+80 MHz was used
813 * @RX_FLAG_160MHZ: 160 MHz was used
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200814 * @RX_FLAG_SHORT_GI: Short guard interval was used
Felix Fietkaufe8431f2012-03-01 18:00:07 +0100815 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
816 * Valid only for data frames (mainly A-MPDU)
Johannes Bergac55d2f2012-05-10 09:09:10 +0200817 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
818 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
819 * to hw.radiotap_mcs_details to advertise that fact
Johannes Berg4c298672012-07-05 11:34:31 +0200820 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
821 * number (@ampdu_reference) must be populated and be a distinct number for
822 * each A-MPDU
823 * @RX_FLAG_AMPDU_REPORT_ZEROLEN: driver reports 0-length subframes
824 * @RX_FLAG_AMPDU_IS_ZEROLEN: This is a zero-length subframe, for
825 * monitoring purposes only
826 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
827 * subframes of a single A-MPDU
828 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
829 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
830 * on this subframe
831 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
832 * is stored in the @ampdu_delimiter_crc field)
Oleksij Rempel786677d2013-05-24 12:05:45 +0200833 * @RX_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
Simon Wunderlicha5e70692013-07-08 16:55:52 +0200834 * @RX_FLAG_10MHZ: 10 MHz (half channel) was used
835 * @RX_FLAG_5MHZ: 5 MHz (quarter channel) was used
Michal Kazior0cfcefe2013-09-23 15:34:38 +0200836 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
837 * subframes instead of a one huge frame for performance reasons.
838 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
839 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
840 * the 3rd (last) one must not have this flag set. The flag is used to
841 * deal with retransmission/duplication recovery properly since A-MSDU
842 * subframes share the same sequence number. Reported subframes can be
843 * either regular MSDU or singly A-MSDUs. Subframes must not be
844 * interleaved with other frames.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400845 */
846enum mac80211_rx_flags {
Johannes Berg4c298672012-07-05 11:34:31 +0200847 RX_FLAG_MMIC_ERROR = BIT(0),
848 RX_FLAG_DECRYPTED = BIT(1),
849 RX_FLAG_MMIC_STRIPPED = BIT(3),
850 RX_FLAG_IV_STRIPPED = BIT(4),
851 RX_FLAG_FAILED_FCS_CRC = BIT(5),
852 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
Thomas Pedersenf4bda332012-11-13 10:46:27 -0800853 RX_FLAG_MACTIME_START = BIT(7),
Johannes Berg4c298672012-07-05 11:34:31 +0200854 RX_FLAG_SHORTPRE = BIT(8),
855 RX_FLAG_HT = BIT(9),
856 RX_FLAG_40MHZ = BIT(10),
857 RX_FLAG_SHORT_GI = BIT(11),
858 RX_FLAG_NO_SIGNAL_VAL = BIT(12),
859 RX_FLAG_HT_GF = BIT(13),
860 RX_FLAG_AMPDU_DETAILS = BIT(14),
861 RX_FLAG_AMPDU_REPORT_ZEROLEN = BIT(15),
862 RX_FLAG_AMPDU_IS_ZEROLEN = BIT(16),
863 RX_FLAG_AMPDU_LAST_KNOWN = BIT(17),
864 RX_FLAG_AMPDU_IS_LAST = BIT(18),
865 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(19),
866 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(20),
Thomas Pedersenf4bda332012-11-13 10:46:27 -0800867 RX_FLAG_MACTIME_END = BIT(21),
Johannes Berg56146182012-11-09 15:07:02 +0100868 RX_FLAG_VHT = BIT(22),
869 RX_FLAG_80MHZ = BIT(23),
870 RX_FLAG_80P80MHZ = BIT(24),
871 RX_FLAG_160MHZ = BIT(25),
Oleksij Rempel786677d2013-05-24 12:05:45 +0200872 RX_FLAG_STBC_MASK = BIT(26) | BIT(27),
Simon Wunderlicha5e70692013-07-08 16:55:52 +0200873 RX_FLAG_10MHZ = BIT(28),
874 RX_FLAG_5MHZ = BIT(29),
Michal Kazior0cfcefe2013-09-23 15:34:38 +0200875 RX_FLAG_AMSDU_MORE = BIT(30),
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400876};
877
Oleksij Rempel786677d2013-05-24 12:05:45 +0200878#define RX_FLAG_STBC_SHIFT 26
879
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400880/**
881 * struct ieee80211_rx_status - receive status
882 *
883 * The low-level driver should provide this information (the subset
884 * supported by hardware) to the 802.11 code with each received
Johannes Bergf1d58c22009-06-17 13:13:00 +0200885 * frame, in the skb's control buffer (cb).
Bruno Randolf566bfe52008-05-08 19:15:40 +0200886 *
Bruno Randolfc132bec2008-02-18 11:20:51 +0900887 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
888 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
Johannes Berg8c358bc2012-05-22 22:13:05 +0200889 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
890 * it but can store it and pass it back to the driver for synchronisation
Johannes Berg8318d782008-01-24 19:38:38 +0100891 * @band: the active band when this frame was received
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400892 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
Bruno Randolf566bfe52008-05-08 19:15:40 +0200893 * @signal: signal strength when receiving this frame, either in dBm, in dB or
894 * unspecified depending on the hardware capabilities flags
895 * @IEEE80211_HW_SIGNAL_*
Felix Fietkauef0621e2013-04-22 16:29:31 +0200896 * @chains: bitmask of receive chains for which separate signal strength
897 * values were filled.
898 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
899 * support dB or unspecified units)
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400900 * @antenna: antenna used
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200901 * @rate_idx: index of data rate into band's supported rates or MCS index if
Johannes Berg56146182012-11-09 15:07:02 +0100902 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
903 * @vht_nss: number of streams (VHT only)
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400904 * @flag: %RX_FLAG_*
Johannes Berg554891e2010-09-24 12:38:25 +0200905 * @rx_flags: internal RX flags for mac80211
Johannes Berg4c298672012-07-05 11:34:31 +0200906 * @ampdu_reference: A-MPDU reference number, must be a different value for
907 * each A-MPDU but the same for each subframe within one A-MPDU
908 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
Johannes Berg90b9e4462012-11-16 10:09:08 +0100909 * @vendor_radiotap_bitmap: radiotap vendor namespace presence bitmap
910 * @vendor_radiotap_len: radiotap vendor namespace length
911 * @vendor_radiotap_align: radiotap vendor namespace alignment. Note
912 * that the actual data must be at the start of the SKB data
913 * already.
914 * @vendor_radiotap_oui: radiotap vendor namespace OUI
915 * @vendor_radiotap_subns: radiotap vendor sub namespace
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400916 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700917struct ieee80211_rx_status {
918 u64 mactime;
Johannes Berg8c358bc2012-05-22 22:13:05 +0200919 u32 device_timestamp;
Johannes Berg4c298672012-07-05 11:34:31 +0200920 u32 ampdu_reference;
921 u32 flag;
Johannes Berg90b9e4462012-11-16 10:09:08 +0100922 u32 vendor_radiotap_bitmap;
923 u16 vendor_radiotap_len;
Johannes Berg30f42292012-07-05 13:14:18 +0200924 u16 freq;
925 u8 rate_idx;
Johannes Berg56146182012-11-09 15:07:02 +0100926 u8 vht_nss;
Johannes Berg30f42292012-07-05 13:14:18 +0200927 u8 rx_flags;
928 u8 band;
929 u8 antenna;
930 s8 signal;
Felix Fietkauef0621e2013-04-22 16:29:31 +0200931 u8 chains;
932 s8 chain_signal[IEEE80211_MAX_CHAINS];
Johannes Berg4c298672012-07-05 11:34:31 +0200933 u8 ampdu_delimiter_crc;
Johannes Berg90b9e4462012-11-16 10:09:08 +0100934 u8 vendor_radiotap_align;
935 u8 vendor_radiotap_oui[3];
936 u8 vendor_radiotap_subns;
Jiri Bencf0706e82007-05-05 11:45:53 -0700937};
938
Johannes Berg6b301cd2007-09-18 17:29:20 -0400939/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400940 * enum ieee80211_conf_flags - configuration flags
941 *
942 * Flags to define PHY configuration options
943 *
Johannes Berg0869aea2009-10-28 10:03:35 +0100944 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
945 * to determine for example whether to calculate timestamps for packets
946 * or not, do not use instead of filter flags!
Kalle Valoc99445b2010-01-14 13:09:21 +0200947 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
948 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
949 * meaning that the hardware still wakes up for beacons, is able to
950 * transmit frames and receive the possible acknowledgment frames.
951 * Not to be confused with hardware specific wakeup/sleep states,
952 * driver is responsible for that. See the section "Powersave support"
953 * for more.
Johannes Berg5cff20e2009-04-29 12:26:17 +0200954 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
955 * the driver should be prepared to handle configuration requests but
956 * may turn the device off as much as possible. Typically, this flag will
957 * be set when an interface is set UP but not associated or scanning, but
958 * it can also be unset in that case when monitor interfaces are active.
Felix Fietkau45521242010-07-28 02:40:49 +0200959 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
960 * operating channel.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400961 */
962enum ieee80211_conf_flags {
Johannes Berg0869aea2009-10-28 10:03:35 +0100963 IEEE80211_CONF_MONITOR = (1<<0),
Johannes Bergae5eb022008-10-14 16:58:37 +0200964 IEEE80211_CONF_PS = (1<<1),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200965 IEEE80211_CONF_IDLE = (1<<2),
Felix Fietkau45521242010-07-28 02:40:49 +0200966 IEEE80211_CONF_OFFCHANNEL = (1<<3),
Johannes Berg6b301cd2007-09-18 17:29:20 -0400967};
Jiri Bencf0706e82007-05-05 11:45:53 -0700968
Johannes Berg7a5158e2008-10-08 10:59:33 +0200969
Jiri Bencf0706e82007-05-05 11:45:53 -0700970/**
Johannes Berge8975582008-10-09 12:18:51 +0200971 * enum ieee80211_conf_changed - denotes which configuration changed
972 *
Johannes Berge8975582008-10-09 12:18:51 +0200973 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
Johannes Berg0869aea2009-10-28 10:03:35 +0100974 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
Johannes Berge255d5e2009-04-22 12:40:07 +0200975 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
Johannes Berge8975582008-10-09 12:18:51 +0200976 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
Johannes Berg47979382009-01-07 10:13:27 +0100977 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
Johannes Berg9124b072008-10-14 19:17:54 +0200978 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
Johannes Berg5cff20e2009-04-29 12:26:17 +0200979 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
Johannes Berg0f782312009-12-01 13:37:02 +0100980 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
Johannes Berg04ecd252012-09-11 14:34:12 +0200981 * Note that this is only valid if channel contexts are not used,
982 * otherwise each channel context has the number of chains listed.
Johannes Berge8975582008-10-09 12:18:51 +0200983 */
984enum ieee80211_conf_changed {
Johannes Berg0f782312009-12-01 13:37:02 +0100985 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
Johannes Berge8975582008-10-09 12:18:51 +0200986 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
Johannes Berg0869aea2009-10-28 10:03:35 +0100987 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
Johannes Berge8975582008-10-09 12:18:51 +0200988 IEEE80211_CONF_CHANGE_PS = BIT(4),
Johannes Berge255d5e2009-04-22 12:40:07 +0200989 IEEE80211_CONF_CHANGE_POWER = BIT(5),
990 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
991 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200992 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
Johannes Berge8975582008-10-09 12:18:51 +0200993};
994
995/**
Johannes Berg0f782312009-12-01 13:37:02 +0100996 * enum ieee80211_smps_mode - spatial multiplexing power save mode
997 *
Kalle Valo9d173fc2010-01-14 13:09:14 +0200998 * @IEEE80211_SMPS_AUTOMATIC: automatic
999 * @IEEE80211_SMPS_OFF: off
1000 * @IEEE80211_SMPS_STATIC: static
1001 * @IEEE80211_SMPS_DYNAMIC: dynamic
1002 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
Johannes Berg0f782312009-12-01 13:37:02 +01001003 */
1004enum ieee80211_smps_mode {
1005 IEEE80211_SMPS_AUTOMATIC,
1006 IEEE80211_SMPS_OFF,
1007 IEEE80211_SMPS_STATIC,
1008 IEEE80211_SMPS_DYNAMIC,
1009
1010 /* keep last */
1011 IEEE80211_SMPS_NUM_MODES,
1012};
1013
1014/**
Jiri Bencf0706e82007-05-05 11:45:53 -07001015 * struct ieee80211_conf - configuration of the device
1016 *
1017 * This struct indicates how the driver shall configure the hardware.
1018 *
Johannes Berg04fe2032009-04-22 18:44:37 +02001019 * @flags: configuration flags defined above
1020 *
Tomas Winklerea95bba2008-07-18 13:53:00 +08001021 * @listen_interval: listen interval in units of beacon interval
Johannes Berg9ccebe62009-04-23 10:32:36 +02001022 * @max_sleep_period: the maximum number of beacon intervals to sleep for
Johannes Berg04fe2032009-04-22 18:44:37 +02001023 * before checking the beacon for a TIM bit (managed mode only); this
1024 * value will be only achievable between DTIM frames, the hardware
1025 * needs to check for the multicast traffic bit in DTIM beacons.
1026 * This variable is valid only when the CONF_PS flag is set.
Johannes Berg56007a02010-01-26 14:19:52 +01001027 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1028 * in power saving. Power saving will not be enabled until a beacon
1029 * has been received and the DTIM period is known.
Johannes Berg04fe2032009-04-22 18:44:37 +02001030 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1031 * powersave documentation below. This variable is valid only when
1032 * the CONF_PS flag is set.
1033 *
Johannes Berg1ea6f9c2012-10-24 10:59:25 +02001034 * @power_level: requested transmit power (in dBm), backward compatibility
1035 * value only that is set to the minimum of all interfaces
Johannes Berg04fe2032009-04-22 18:44:37 +02001036 *
Karl Beldan675a0b02013-03-25 16:26:57 +01001037 * @chandef: the channel definition to tune to
Simon Wunderlich164eb022013-02-08 18:16:20 +01001038 * @radar_enabled: whether radar detection is enabled
Johannes Berg04fe2032009-04-22 18:44:37 +02001039 *
Johannes Berg9124b072008-10-14 19:17:54 +02001040 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
Johannes Bergad24b0d2013-07-05 11:53:28 +02001041 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1042 * but actually means the number of transmissions not the number of retries
Johannes Berg9124b072008-10-14 19:17:54 +02001043 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
Johannes Bergad24b0d2013-07-05 11:53:28 +02001044 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1045 * number of transmissions not the number of retries
Johannes Berg0f782312009-12-01 13:37:02 +01001046 *
1047 * @smps_mode: spatial multiplexing powersave mode; note that
1048 * %IEEE80211_SMPS_STATIC is used when the device is not
Johannes Berg04ecd252012-09-11 14:34:12 +02001049 * configured for an HT channel.
1050 * Note that this is only valid if channel contexts are not used,
1051 * otherwise each channel context has the number of chains listed.
Jiri Bencf0706e82007-05-05 11:45:53 -07001052 */
1053struct ieee80211_conf {
Johannes Berg6b301cd2007-09-18 17:29:20 -04001054 u32 flags;
Juuso Oikarinenff616382010-06-09 09:51:52 +03001055 int power_level, dynamic_ps_timeout;
Johannes Berg9ccebe62009-04-23 10:32:36 +02001056 int max_sleep_period;
Ron Rindjunsky10816d42007-11-26 16:14:30 +02001057
Johannes Berge8975582008-10-09 12:18:51 +02001058 u16 listen_interval;
Johannes Berg56007a02010-01-26 14:19:52 +01001059 u8 ps_dtim_period;
Johannes Berge8975582008-10-09 12:18:51 +02001060
Johannes Berg9124b072008-10-14 19:17:54 +02001061 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1062
Karl Beldan675a0b02013-03-25 16:26:57 +01001063 struct cfg80211_chan_def chandef;
Simon Wunderlich164eb022013-02-08 18:16:20 +01001064 bool radar_enabled;
Johannes Berg0f782312009-12-01 13:37:02 +01001065 enum ieee80211_smps_mode smps_mode;
Jiri Bencf0706e82007-05-05 11:45:53 -07001066};
1067
1068/**
Johannes Berg5ce6e432010-05-11 16:20:57 +02001069 * struct ieee80211_channel_switch - holds the channel switch data
1070 *
1071 * The information provided in this structure is required for channel switch
1072 * operation.
1073 *
1074 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1075 * Function (TSF) timer when the frame containing the channel switch
1076 * announcement was received. This is simply the rx.mactime parameter
1077 * the driver passed into mac80211.
1078 * @block_tx: Indicates whether transmission must be blocked before the
1079 * scheduled channel switch, as indicated by the AP.
Johannes Berg85220d72013-03-25 18:29:27 +01001080 * @chandef: the new channel to switch to
Johannes Berg5ce6e432010-05-11 16:20:57 +02001081 * @count: the number of TBTT's until the channel switch event
1082 */
1083struct ieee80211_channel_switch {
1084 u64 timestamp;
1085 bool block_tx;
Johannes Berg85220d72013-03-25 18:29:27 +01001086 struct cfg80211_chan_def chandef;
Johannes Berg5ce6e432010-05-11 16:20:57 +02001087 u8 count;
1088};
1089
1090/**
Johannes Bergc1288b12012-01-19 09:29:57 +01001091 * enum ieee80211_vif_flags - virtual interface flags
1092 *
1093 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1094 * on this virtual interface to avoid unnecessary CPU wakeups
Johannes Bergea086352012-01-19 09:29:58 +01001095 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1096 * monitoring on this virtual interface -- i.e. it can monitor
1097 * connection quality related parameters, such as the RSSI level and
1098 * provide notifications if configured trigger levels are reached.
Johannes Bergc1288b12012-01-19 09:29:57 +01001099 */
1100enum ieee80211_vif_flags {
1101 IEEE80211_VIF_BEACON_FILTER = BIT(0),
Johannes Bergea086352012-01-19 09:29:58 +01001102 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
Johannes Bergc1288b12012-01-19 09:29:57 +01001103};
1104
1105/**
Johannes Berg32bfd352007-12-19 01:31:26 +01001106 * struct ieee80211_vif - per-interface data
1107 *
1108 * Data in this structure is continually present for driver
1109 * use during the life of a virtual interface.
1110 *
Johannes Berg51fb61e2007-12-19 01:31:27 +01001111 * @type: type of this virtual interface
Johannes Bergbda39332008-10-11 01:51:51 +02001112 * @bss_conf: BSS configuration for this interface, either our own
1113 * or the BSS we're associated to
Johannes Berg47846c92009-11-25 17:46:19 +01001114 * @addr: address of this interface
Johannes Berg2ca27bc2010-09-16 14:58:23 +02001115 * @p2p: indicates whether this AP or STA interface is a p2p
1116 * interface, i.e. a GO or p2p-sta respectively
Simon Wunderlich73da7d52013-07-11 16:09:06 +02001117 * @csa_active: marks whether a channel switch is going on
Johannes Bergc1288b12012-01-19 09:29:57 +01001118 * @driver_flags: flags/capabilities the driver has for this interface,
1119 * these need to be set (or cleared) when the interface is added
1120 * or, if supported by the driver, the interface type is changed
1121 * at runtime, mac80211 will never touch this field
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001122 * @hw_queue: hardware queue for each AC
1123 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
Michal Kaziord01a1e62012-06-26 14:37:16 +02001124 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1125 * when it is not assigned. This pointer is RCU-protected due to the TX
1126 * path needing to access it; even though the netdev carrier will always
1127 * be off when it is %NULL there can still be races and packets could be
1128 * processed after it switches back to %NULL.
Stanislaw Gruszkaddbfe862013-03-08 14:46:14 +01001129 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
Johannes Bergad24b0d2013-07-05 11:53:28 +02001130 * interface debug files. Note that it will be NULL for the virtual
Stanislaw Gruszkaddbfe862013-03-08 14:46:14 +01001131 * monitor interface (if that is requested.)
Johannes Berg32bfd352007-12-19 01:31:26 +01001132 * @drv_priv: data area for driver use, will always be aligned to
1133 * sizeof(void *).
1134 */
1135struct ieee80211_vif {
Johannes Berg05c914f2008-09-11 00:01:58 +02001136 enum nl80211_iftype type;
Johannes Bergbda39332008-10-11 01:51:51 +02001137 struct ieee80211_bss_conf bss_conf;
Johannes Berg47846c92009-11-25 17:46:19 +01001138 u8 addr[ETH_ALEN];
Johannes Berg2ca27bc2010-09-16 14:58:23 +02001139 bool p2p;
Simon Wunderlich73da7d52013-07-11 16:09:06 +02001140 bool csa_active;
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001141
1142 u8 cab_queue;
1143 u8 hw_queue[IEEE80211_NUM_ACS];
1144
Michal Kaziord01a1e62012-06-26 14:37:16 +02001145 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1146
Johannes Bergc1288b12012-01-19 09:29:57 +01001147 u32 driver_flags;
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001148
Stanislaw Gruszkaddbfe862013-03-08 14:46:14 +01001149#ifdef CONFIG_MAC80211_DEBUGFS
1150 struct dentry *debugfs_dir;
1151#endif
1152
Johannes Berg32bfd352007-12-19 01:31:26 +01001153 /* must be last */
Johannes Berg1c06ef92012-12-28 12:22:02 +01001154 u8 drv_priv[0] __aligned(sizeof(void *));
Johannes Berg32bfd352007-12-19 01:31:26 +01001155};
1156
Johannes Berg902acc72008-02-23 15:17:19 +01001157static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1158{
1159#ifdef CONFIG_MAC80211_MESH
Johannes Berg05c914f2008-09-11 00:01:58 +02001160 return vif->type == NL80211_IFTYPE_MESH_POINT;
Johannes Berg902acc72008-02-23 15:17:19 +01001161#endif
1162 return false;
1163}
1164
Johannes Berg32bfd352007-12-19 01:31:26 +01001165/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001166 * enum ieee80211_key_flags - key flags
1167 *
1168 * These flags are used for communication about keys between the driver
1169 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1170 *
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001171 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1172 * driver to indicate that it requires IV generation for this
1173 * particular key.
1174 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1175 * the driver for a TKIP key if it requires Michael MIC
1176 * generation in software.
Ivo van Doornc6adbd22008-04-17 21:11:18 +02001177 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1178 * that the key is pairwise rather then a shared key.
Johannes Berge548c492012-09-04 17:08:23 +02001179 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
Jouni Malinen1f7d77a2009-01-08 13:32:10 +02001180 * CCMP key if it requires CCMP encryption of management frames (MFP) to
1181 * be done in software.
Arik Nemtsov077a9152011-10-23 08:21:41 +02001182 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
Janusz.Dziedzic@tieto.comee701082012-05-09 08:11:20 +03001183 * if space should be prepared for the IV, but the IV
Arik Nemtsov077a9152011-10-23 08:21:41 +02001184 * itself should not be generated. Do not set together with
1185 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key.
Johannes Berge548c492012-09-04 17:08:23 +02001186 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1187 * management frames. The flag can help drivers that have a hardware
1188 * crypto implementation that doesn't deal with management frames
1189 * properly by allowing them to not upload the keys to hardware and
1190 * fall back to software crypto. Note that this flag deals only with
1191 * RX, if your crypto engine can't deal with TX you can also set the
1192 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001193 */
1194enum ieee80211_key_flags {
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001195 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
1196 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
Ivo van Doornc6adbd22008-04-17 21:11:18 +02001197 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
Johannes Berge548c492012-09-04 17:08:23 +02001198 IEEE80211_KEY_FLAG_SW_MGMT_TX = 1<<4,
Arik Nemtsov077a9152011-10-23 08:21:41 +02001199 IEEE80211_KEY_FLAG_PUT_IV_SPACE = 1<<5,
Johannes Berge548c492012-09-04 17:08:23 +02001200 IEEE80211_KEY_FLAG_RX_MGMT = 1<<6,
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001201};
1202
1203/**
1204 * struct ieee80211_key_conf - key information
1205 *
1206 * This key information is given by mac80211 to the driver by
1207 * the set_key() callback in &struct ieee80211_ops.
1208 *
1209 * @hw_key_idx: To be set by the driver, this is the key index the driver
1210 * wants to be given when a frame is transmitted and needs to be
Johannes Berg6a7664d2007-09-14 11:10:25 -04001211 * encrypted in hardware.
Johannes Berg97359d12010-08-10 09:46:38 +02001212 * @cipher: The key's cipher suite selector.
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001213 * @flags: key flags, see &enum ieee80211_key_flags.
1214 * @keyidx: the key index (0-3)
1215 * @keylen: key material length
Luis R. Rodriguezffd78912008-06-21 10:02:46 -04001216 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1217 * data block:
1218 * - Temporal Encryption Key (128 bits)
1219 * - Temporal Authenticator Tx MIC Key (64 bits)
1220 * - Temporal Authenticator Rx MIC Key (64 bits)
Johannes Bergdc822b52008-12-29 12:55:09 +01001221 * @icv_len: The ICV length for this key type
1222 * @iv_len: The IV length for this key type
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001223 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001224struct ieee80211_key_conf {
Johannes Berg97359d12010-08-10 09:46:38 +02001225 u32 cipher;
Felix Fietkau76708de2008-10-05 18:02:48 +02001226 u8 icv_len;
1227 u8 iv_len;
Johannes Berg6a7664d2007-09-14 11:10:25 -04001228 u8 hw_key_idx;
Johannes Berg11a843b2007-08-28 17:01:55 -04001229 u8 flags;
Johannes Berg11a843b2007-08-28 17:01:55 -04001230 s8 keyidx;
Johannes Berg11a843b2007-08-28 17:01:55 -04001231 u8 keylen;
Jiri Bencf0706e82007-05-05 11:45:53 -07001232 u8 key[0];
1233};
1234
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001235/**
Max Stepanov2475b1cc2013-03-24 14:23:27 +02001236 * struct ieee80211_cipher_scheme - cipher scheme
1237 *
1238 * This structure contains a cipher scheme information defining
1239 * the secure packet crypto handling.
1240 *
1241 * @cipher: a cipher suite selector
1242 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1243 * @hdr_len: a length of a security header used the cipher
1244 * @pn_len: a length of a packet number in the security header
1245 * @pn_off: an offset of pn from the beginning of the security header
1246 * @key_idx_off: an offset of key index byte in the security header
1247 * @key_idx_mask: a bit mask of key_idx bits
1248 * @key_idx_shift: a bit shift needed to get key_idx
1249 * key_idx value calculation:
1250 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1251 * @mic_len: a mic length in bytes
1252 */
1253struct ieee80211_cipher_scheme {
1254 u32 cipher;
1255 u16 iftype;
1256 u8 hdr_len;
1257 u8 pn_len;
1258 u8 pn_off;
1259 u8 key_idx_off;
1260 u8 key_idx_mask;
1261 u8 key_idx_shift;
1262 u8 mic_len;
1263};
1264
1265/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001266 * enum set_key_cmd - key command
1267 *
1268 * Used with the set_key() callback in &struct ieee80211_ops, this
1269 * indicates whether a key is being removed or added.
1270 *
1271 * @SET_KEY: a key is set
1272 * @DISABLE_KEY: a key must be disabled
1273 */
Johannes Bergea49c352007-09-18 17:29:21 -04001274enum set_key_cmd {
Johannes Berg11a843b2007-08-28 17:01:55 -04001275 SET_KEY, DISABLE_KEY,
Johannes Bergea49c352007-09-18 17:29:21 -04001276};
Jiri Bencf0706e82007-05-05 11:45:53 -07001277
Tomas Winkler478f8d22007-09-30 13:52:37 +02001278/**
Johannes Bergf09603a2012-01-20 13:55:21 +01001279 * enum ieee80211_sta_state - station state
1280 *
1281 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1282 * this is a special state for add/remove transitions
1283 * @IEEE80211_STA_NONE: station exists without special state
1284 * @IEEE80211_STA_AUTH: station is authenticated
1285 * @IEEE80211_STA_ASSOC: station is associated
1286 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1287 */
1288enum ieee80211_sta_state {
1289 /* NOTE: These need to be ordered correctly! */
1290 IEEE80211_STA_NOTEXIST,
1291 IEEE80211_STA_NONE,
1292 IEEE80211_STA_AUTH,
1293 IEEE80211_STA_ASSOC,
1294 IEEE80211_STA_AUTHORIZED,
1295};
1296
1297/**
Johannes Berge1a0c6b2013-02-07 11:47:44 +01001298 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1299 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1300 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1301 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1302 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1303 * (including 80+80 MHz)
1304 *
1305 * Implementation note: 20 must be zero to be initialized
1306 * correctly, the values must be sorted.
1307 */
1308enum ieee80211_sta_rx_bandwidth {
1309 IEEE80211_STA_RX_BW_20 = 0,
1310 IEEE80211_STA_RX_BW_40,
1311 IEEE80211_STA_RX_BW_80,
1312 IEEE80211_STA_RX_BW_160,
1313};
1314
1315/**
Felix Fietkau0d528d82013-04-22 16:14:41 +02001316 * struct ieee80211_sta_rates - station rate selection table
1317 *
1318 * @rcu_head: RCU head used for freeing the table on update
Robert P. J. Day03f831a2013-05-02 07:15:09 -04001319 * @rate: transmit rates/flags to be used by default.
Felix Fietkau0d528d82013-04-22 16:14:41 +02001320 * Overriding entries per-packet is possible by using cb tx control.
1321 */
1322struct ieee80211_sta_rates {
1323 struct rcu_head rcu_head;
1324 struct {
1325 s8 idx;
1326 u8 count;
1327 u8 count_cts;
1328 u8 count_rts;
1329 u16 flags;
1330 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1331};
1332
1333/**
Johannes Berg17741cd2008-09-11 00:02:02 +02001334 * struct ieee80211_sta - station table entry
1335 *
1336 * A station table entry represents a station we are possibly
1337 * communicating with. Since stations are RCU-managed in
1338 * mac80211, any ieee80211_sta pointer you get access to must
1339 * either be protected by rcu_read_lock() explicitly or implicitly,
1340 * or you must take good care to not use such a pointer after a
Johannes Berg34e89502010-02-03 13:59:58 +01001341 * call to your sta_remove callback that removed it.
Johannes Berg17741cd2008-09-11 00:02:02 +02001342 *
1343 * @addr: MAC address
1344 * @aid: AID we assigned to the station if we're an AP
Johannes Berg323ce792008-09-11 02:45:11 +02001345 * @supp_rates: Bitmap of supported rates (per band)
Johannes Berg55d942f2013-03-01 13:07:48 +01001346 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1347 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
Arik Nemtsov39df6002011-06-27 23:58:45 +03001348 * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
Johannes Berg17741cd2008-09-11 00:02:02 +02001349 * @drv_priv: data area for driver use, will always be aligned to
1350 * sizeof(void *), size is determined in hw information.
Eliad Peller910868d2011-09-11 09:46:55 +03001351 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1352 * if wme is supported.
1353 * @max_sp: max Service Period. Only valid if wme is supported.
Johannes Berge1a0c6b2013-02-07 11:47:44 +01001354 * @bandwidth: current bandwidth the station can receive with
Johannes Berg8921d042012-12-27 18:26:42 +01001355 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1356 * station can receive at the moment, changed by operating mode
1357 * notifications and capabilities. The value is only valid after
1358 * the station moves to associated state.
Johannes Bergaf0ed692013-02-12 14:21:00 +01001359 * @smps_mode: current SMPS mode (off, static or dynamic)
Robert P. J. Day03f831a2013-05-02 07:15:09 -04001360 * @rates: rate control selection table
Johannes Berg17741cd2008-09-11 00:02:02 +02001361 */
1362struct ieee80211_sta {
Johannes Berg881d9482009-01-21 15:13:48 +01001363 u32 supp_rates[IEEE80211_NUM_BANDS];
Johannes Berg17741cd2008-09-11 00:02:02 +02001364 u8 addr[ETH_ALEN];
1365 u16 aid;
Johannes Bergd9fe60d2008-10-09 12:13:49 +02001366 struct ieee80211_sta_ht_cap ht_cap;
Mahesh Palivela818255e2012-10-10 11:33:04 +00001367 struct ieee80211_sta_vht_cap vht_cap;
Arik Nemtsov39df6002011-06-27 23:58:45 +03001368 bool wme;
Eliad Peller9533b4a2011-08-23 14:37:47 +03001369 u8 uapsd_queues;
1370 u8 max_sp;
Johannes Berg8921d042012-12-27 18:26:42 +01001371 u8 rx_nss;
Johannes Berge1a0c6b2013-02-07 11:47:44 +01001372 enum ieee80211_sta_rx_bandwidth bandwidth;
Johannes Bergaf0ed692013-02-12 14:21:00 +01001373 enum ieee80211_smps_mode smps_mode;
Felix Fietkau0d528d82013-04-22 16:14:41 +02001374 struct ieee80211_sta_rates __rcu *rates;
Johannes Berg17741cd2008-09-11 00:02:02 +02001375
1376 /* must be last */
Johannes Berg1c06ef92012-12-28 12:22:02 +01001377 u8 drv_priv[0] __aligned(sizeof(void *));
Johannes Berg17741cd2008-09-11 00:02:02 +02001378};
1379
1380/**
Tomas Winkler478f8d22007-09-30 13:52:37 +02001381 * enum sta_notify_cmd - sta notify command
1382 *
1383 * Used with the sta_notify() callback in &struct ieee80211_ops, this
Sujith38a6cc72010-05-19 11:32:30 +05301384 * indicates if an associated station made a power state transition.
Tomas Winkler478f8d22007-09-30 13:52:37 +02001385 *
Christian Lamparter4571d3b2008-11-30 00:48:41 +01001386 * @STA_NOTIFY_SLEEP: a station is now sleeping
1387 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1388 */
Christian Lamparter89fad572008-12-09 16:28:06 +01001389enum sta_notify_cmd {
Christian Lamparter4571d3b2008-11-30 00:48:41 +01001390 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1391};
1392
1393/**
Thomas Huehn36323f82012-07-23 21:33:42 +02001394 * struct ieee80211_tx_control - TX control data
1395 *
1396 * @sta: station table entry, this sta pointer may be NULL and
1397 * it is not allowed to copy the pointer, due to RCU.
1398 */
1399struct ieee80211_tx_control {
1400 struct ieee80211_sta *sta;
1401};
1402
1403/**
Johannes Berg1bc08262007-09-18 17:29:15 -04001404 * enum ieee80211_hw_flags - hardware flags
1405 *
1406 * These flags are used to indicate hardware capabilities to
1407 * the stack. Generally, flags here should have their meaning
1408 * done in a way that the simplest hardware doesn't need setting
1409 * any particular flags. There are some exceptions to this rule,
1410 * however, so you are advised to review these flags carefully.
1411 *
Johannes Bergaf65cd962009-11-17 18:18:36 +01001412 * @IEEE80211_HW_HAS_RATE_CONTROL:
1413 * The hardware or firmware includes rate control, and cannot be
1414 * controlled by the stack. As such, no rate control algorithm
1415 * should be instantiated, and the TX rate reported to userspace
1416 * will be taken from the TX status instead of the rate control
1417 * algorithm.
1418 * Note that this requires that the driver implement a number of
1419 * callbacks so it has the correct information, it needs to have
1420 * the @set_rts_threshold callback and must look at the BSS config
1421 * @use_cts_prot for G/N protection, @use_short_slot for slot
1422 * timing in 2.4 GHz and @use_short_preamble for preambles for
1423 * CCK frames.
1424 *
Johannes Berg1bc08262007-09-18 17:29:15 -04001425 * @IEEE80211_HW_RX_INCLUDES_FCS:
1426 * Indicates that received frames passed to the stack include
1427 * the FCS at the end.
1428 *
1429 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1430 * Some wireless LAN chipsets buffer broadcast/multicast frames
1431 * for power saving stations in the hardware/firmware and others
1432 * rely on the host system for such buffering. This option is used
1433 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1434 * multicast frames when there are power saving stations so that
Luis R. Rodriguez546c80c92008-08-14 11:43:20 -07001435 * the driver can fetch them with ieee80211_get_buffered_bc().
Johannes Berg1bc08262007-09-18 17:29:15 -04001436 *
Johannes Berg8318d782008-01-24 19:38:38 +01001437 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1438 * Hardware is not capable of short slot operation on the 2.4 GHz band.
1439 *
1440 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1441 * Hardware is not capable of receiving frames with short preamble on
1442 * the 2.4 GHz band.
Bruno Randolf566bfe52008-05-08 19:15:40 +02001443 *
1444 * @IEEE80211_HW_SIGNAL_UNSPEC:
1445 * Hardware can provide signal values but we don't know its units. We
1446 * expect values between 0 and @max_signal.
1447 * If possible please provide dB or dBm instead.
1448 *
Bruno Randolf566bfe52008-05-08 19:15:40 +02001449 * @IEEE80211_HW_SIGNAL_DBM:
1450 * Hardware gives signal values in dBm, decibel difference from
1451 * one milliwatt. This is the preferred method since it is standardized
1452 * between different devices. @max_signal does not need to be set.
1453 *
Tomas Winkler06ff47b2008-06-18 17:53:44 +03001454 * @IEEE80211_HW_SPECTRUM_MGMT:
1455 * Hardware supports spectrum management defined in 802.11h
1456 * Measurement, Channel Switch, Quieting, TPC
Sujith8b30b1f2008-10-24 09:55:27 +05301457 *
1458 * @IEEE80211_HW_AMPDU_AGGREGATION:
1459 * Hardware supports 11n A-MPDU aggregation.
Kalle Valo520eb822008-12-18 23:35:27 +02001460 *
Johannes Berg4be8c382009-01-07 18:28:20 +01001461 * @IEEE80211_HW_SUPPORTS_PS:
1462 * Hardware has power save support (i.e. can go to sleep).
1463 *
1464 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1465 * Hardware requires nullfunc frame handling in stack, implies
1466 * stack support for dynamic PS.
1467 *
1468 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1469 * Hardware has support for dynamic PS.
Jouni Malinen4375d082009-01-08 13:32:11 +02001470 *
1471 * @IEEE80211_HW_MFP_CAPABLE:
1472 * Hardware supports management frame protection (MFP, IEEE 802.11w).
Kalle Valo04de8382009-03-22 21:57:35 +02001473 *
Johannes Berg0f782312009-12-01 13:37:02 +01001474 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1475 * Hardware supports static spatial multiplexing powersave,
1476 * ie. can turn off all but one chain even on HT connections
1477 * that should be using more chains.
1478 *
1479 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1480 * Hardware supports dynamic spatial multiplexing powersave,
1481 * ie. can turn off all but one chain and then wake the rest
1482 * up as required after, for example, rts/cts handshake.
Kalle Valoab133152010-01-12 10:42:31 +02001483 *
1484 * @IEEE80211_HW_SUPPORTS_UAPSD:
1485 * Hardware supports Unscheduled Automatic Power Save Delivery
1486 * (U-APSD) in managed mode. The mode is configured with
1487 * conf_tx() operation.
Vivek Natarajan375177b2010-02-09 14:50:28 +05301488 *
1489 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1490 * Hardware can provide ack status reports of Tx frames to
1491 * the stack.
1492 *
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02001493 * @IEEE80211_HW_CONNECTION_MONITOR:
Johannes Bergad24b0d2013-07-05 11:53:28 +02001494 * The hardware performs its own connection monitoring, including
1495 * periodic keep-alives to the AP and probing the AP on beacon loss.
1496 * When this flag is set, signaling beacon-loss will cause an immediate
1497 * change to disassociated state.
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02001498 *
Emmanuel Grumbachc65dd142012-12-12 10:12:24 +02001499 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1500 * This device needs to get data from beacon before association (i.e.
1501 * dtim_period).
Johannes Berge31b8212010-10-05 19:39:30 +02001502 *
1503 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1504 * per-station GTKs as used by IBSS RSN or during fast transition. If
1505 * the device doesn't support per-station GTKs, but can be asked not
1506 * to decrypt group addressed frames, then IBSS RSN support is still
1507 * possible but software crypto will be used. Advertise the wiphy flag
1508 * only in that case.
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02001509 *
1510 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1511 * autonomously manages the PS status of connected stations. When
1512 * this flag is set mac80211 will not trigger PS mode for connected
1513 * stations based on the PM bit of incoming frames.
1514 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1515 * the PS mode of connected stations.
Arik Nemtsovedf6b782011-08-30 09:32:38 +03001516 *
1517 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1518 * setup strictly in HW. mac80211 should not attempt to do this in
1519 * software.
Eliad Peller885bd8e2012-02-02 17:44:55 +02001520 *
Johannes Berg4b6f1dd2012-04-03 14:35:57 +02001521 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1522 * a virtual monitor interface when monitor interfaces are the only
1523 * active interfaces.
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001524 *
1525 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1526 * queue mapping in order to use different queues (not just one per AC)
1527 * for different virtual interfaces. See the doc section on HW queue
1528 * control for more details.
Johannes Berg6d711172012-06-19 17:19:44 +02001529 *
Felix Fietkau0d528d82013-04-22 16:14:41 +02001530 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
1531 * selection table provided by the rate control algorithm.
1532 *
Johannes Berg6d711172012-06-19 17:19:44 +02001533 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1534 * P2P Interface. This will be honoured even if more than one interface
1535 * is supported.
Johannes Bergef429da2013-02-05 17:48:40 +01001536 *
1537 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
1538 * only, to allow getting TBTT of a DTIM beacon.
Arik Nemtsov7578d572013-09-01 17:15:51 +03001539 *
Johannes Berg919be622013-10-14 10:05:16 +02001540 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
1541 * and can cope with CCK rates in an aggregation session (e.g. by not
1542 * using aggregation for such frames.)
1543 *
Arik Nemtsov7578d572013-09-01 17:15:51 +03001544 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
1545 * for a single active channel while using channel contexts. When support
1546 * is not enabled the default action is to disconnect when getting the
1547 * CSA frame.
Johannes Berg1bc08262007-09-18 17:29:15 -04001548 */
1549enum ieee80211_hw_flags {
Johannes Bergaf65cd962009-11-17 18:18:36 +01001550 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
Johannes Berg1bc08262007-09-18 17:29:15 -04001551 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1552 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
Johannes Berg8318d782008-01-24 19:38:38 +01001553 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1554 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
Bruno Randolf566bfe52008-05-08 19:15:40 +02001555 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
Johannes Berg7fee5372009-01-30 11:13:06 +01001556 IEEE80211_HW_SIGNAL_DBM = 1<<6,
Emmanuel Grumbachc65dd142012-12-12 10:12:24 +02001557 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC = 1<<7,
Johannes Berg7fee5372009-01-30 11:13:06 +01001558 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1559 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1560 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1561 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1562 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1563 IEEE80211_HW_MFP_CAPABLE = 1<<13,
Johannes Berg4b6f1dd2012-04-03 14:35:57 +02001564 IEEE80211_HW_WANT_MONITOR_VIF = 1<<14,
Johannes Berg0f782312009-12-01 13:37:02 +01001565 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
1566 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
Kalle Valoab133152010-01-12 10:42:31 +02001567 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
Vivek Natarajan375177b2010-02-09 14:50:28 +05301568 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02001569 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001570 IEEE80211_HW_QUEUE_CONTROL = 1<<20,
Johannes Berge31b8212010-10-05 19:39:30 +02001571 IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02001572 IEEE80211_HW_AP_LINK_PS = 1<<22,
Arik Nemtsovedf6b782011-08-30 09:32:38 +03001573 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW = 1<<23,
Felix Fietkau0d528d82013-04-22 16:14:41 +02001574 IEEE80211_HW_SUPPORTS_RC_TABLE = 1<<24,
Johannes Berg6d711172012-06-19 17:19:44 +02001575 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF = 1<<25,
Johannes Bergef429da2013-02-05 17:48:40 +01001576 IEEE80211_HW_TIMING_BEACON_ONLY = 1<<26,
Felix Fietkau2dfca312013-08-20 19:43:54 +02001577 IEEE80211_HW_SUPPORTS_HT_CCK_RATES = 1<<27,
Arik Nemtsov7578d572013-09-01 17:15:51 +03001578 IEEE80211_HW_CHANCTX_STA_CSA = 1<<28,
Johannes Berg1bc08262007-09-18 17:29:15 -04001579};
1580
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001581/**
1582 * struct ieee80211_hw - hardware information and state
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001583 *
1584 * This structure contains the configuration and hardware
1585 * information for an 802.11 PHY.
1586 *
1587 * @wiphy: This points to the &struct wiphy allocated for this
1588 * 802.11 PHY. You must fill in the @perm_addr and @dev
1589 * members of this structure using SET_IEEE80211_DEV()
Johannes Berg8318d782008-01-24 19:38:38 +01001590 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1591 * bands (with channels, bitrates) are registered here.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001592 *
1593 * @conf: &struct ieee80211_conf, device configuration, don't use.
1594 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001595 * @priv: pointer to private area that was allocated for driver use
1596 * along with this structure.
1597 *
1598 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1599 *
1600 * @extra_tx_headroom: headroom to reserve in each transmit skb
1601 * for use by the driver (e.g. for transmit headers.)
1602 *
1603 * @channel_change_time: time (in microseconds) it takes to change channels.
1604 *
Bruno Randolf566bfe52008-05-08 19:15:40 +02001605 * @max_signal: Maximum value for signal (rssi) in RX information, used
Johannes Bergad24b0d2013-07-05 11:53:28 +02001606 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001607 *
Tomas Winklerea95bba2008-07-18 13:53:00 +08001608 * @max_listen_interval: max listen interval in units of beacon interval
Johannes Bergad24b0d2013-07-05 11:53:28 +02001609 * that HW supports
Tomas Winklerea95bba2008-07-18 13:53:00 +08001610 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001611 * @queues: number of available hardware transmit queues for
Johannes Berge100bb62008-04-30 18:51:21 +02001612 * data packets. WMM/QoS requires at least four, these
1613 * queues need to have configurable access parameters.
1614 *
Johannes Berg830f9032007-10-28 14:51:05 +01001615 * @rate_control_algorithm: rate control algorithm for this hardware.
1616 * If unset (NULL), the default algorithm will be used. Must be
1617 * set before calling ieee80211_register_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001618 *
1619 * @vif_data_size: size (in bytes) of the drv_priv data area
1620 * within &struct ieee80211_vif.
Johannes Berg17741cd2008-09-11 00:02:02 +02001621 * @sta_data_size: size (in bytes) of the drv_priv data area
1622 * within &struct ieee80211_sta.
Michal Kaziord01a1e62012-06-26 14:37:16 +02001623 * @chanctx_data_size: size (in bytes) of the drv_priv data area
1624 * within &struct ieee80211_chanctx_conf.
Felix Fietkau870abdf2008-10-05 18:04:24 +02001625 *
Helmut Schaa78be49e2010-10-02 11:31:55 +02001626 * @max_rates: maximum number of alternate rate retry stages the hw
1627 * can handle.
1628 * @max_report_rates: maximum number of alternate rate retry stages
1629 * the hw can report back.
Johannes Berge6a98542008-10-21 12:40:02 +02001630 * @max_rate_tries: maximum number of tries for each stage
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001631 *
1632 * @napi_weight: weight used for NAPI polling. You must specify an
1633 * appropriate value here if a napi_poll operation is provided
1634 * by your driver.
Randy Dunlap858022a2011-03-18 09:33:02 -07001635 *
Luciano Coelhodf6ba5d2011-01-12 15:26:30 +02001636 * @max_rx_aggregation_subframes: maximum buffer size (number of
1637 * sub-frames) to be used for A-MPDU block ack receiver
1638 * aggregation.
1639 * This is only relevant if the device has restrictions on the
1640 * number of subframes, if it relies on mac80211 to do reordering
1641 * it shouldn't be set.
Johannes Berg5dd36bc2011-01-18 13:52:23 +01001642 *
1643 * @max_tx_aggregation_subframes: maximum number of subframes in an
1644 * aggregate an HT driver will transmit, used by the peer as a
1645 * hint to size its reorder buffer.
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001646 *
1647 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
1648 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
Johannes Bergac55d2f2012-05-10 09:09:10 +02001649 *
1650 * @radiotap_mcs_details: lists which MCS information can the HW
1651 * reports, by default it is set to _MCS, _GI and _BW but doesn't
1652 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
1653 * adding _BW is supported today.
Arik Nemtsov72d78722012-05-10 16:18:26 +03001654 *
Johannes Berg51648922012-11-22 23:00:18 +01001655 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
1656 * the default is _GI | _BANDWIDTH.
1657 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_* values.
1658 *
Arik Nemtsov72d78722012-05-10 16:18:26 +03001659 * @netdev_features: netdev features to be set in each netdev created
1660 * from this HW. Note only HW checksum features are currently
1661 * compatible with mac80211. Other feature bits will be rejected.
Alexander Bondar219c3862013-01-22 16:52:23 +02001662 *
1663 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
1664 * for each access category if it is uAPSD trigger-enabled and delivery-
1665 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
1666 * Each bit corresponds to different AC. Value '1' in specific bit means
1667 * that corresponding AC is both trigger- and delivery-enabled. '0' means
1668 * neither enabled.
1669 *
1670 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
1671 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
1672 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
Max Stepanov2475b1cc2013-03-24 14:23:27 +02001673 *
1674 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
1675 * @cipher_schemes: a pointer to an array of cipher scheme definitions
1676 * supported by HW.
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001677 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001678struct ieee80211_hw {
Jiri Bencf0706e82007-05-05 11:45:53 -07001679 struct ieee80211_conf conf;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001680 struct wiphy *wiphy;
Johannes Berg830f9032007-10-28 14:51:05 +01001681 const char *rate_control_algorithm;
Jiri Bencf0706e82007-05-05 11:45:53 -07001682 void *priv;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001683 u32 flags;
Jiri Bencf0706e82007-05-05 11:45:53 -07001684 unsigned int extra_tx_headroom;
Jiri Bencf0706e82007-05-05 11:45:53 -07001685 int channel_change_time;
Johannes Berg32bfd352007-12-19 01:31:26 +01001686 int vif_data_size;
Johannes Berg17741cd2008-09-11 00:02:02 +02001687 int sta_data_size;
Michal Kaziord01a1e62012-06-26 14:37:16 +02001688 int chanctx_data_size;
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001689 int napi_weight;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001690 u16 queues;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001691 u16 max_listen_interval;
Jiri Bencf0706e82007-05-05 11:45:53 -07001692 s8 max_signal;
Johannes Berge6a98542008-10-21 12:40:02 +02001693 u8 max_rates;
Helmut Schaa78be49e2010-10-02 11:31:55 +02001694 u8 max_report_rates;
Johannes Berge6a98542008-10-21 12:40:02 +02001695 u8 max_rate_tries;
Luciano Coelhodf6ba5d2011-01-12 15:26:30 +02001696 u8 max_rx_aggregation_subframes;
Johannes Berg5dd36bc2011-01-18 13:52:23 +01001697 u8 max_tx_aggregation_subframes;
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001698 u8 offchannel_tx_hw_queue;
Johannes Bergac55d2f2012-05-10 09:09:10 +02001699 u8 radiotap_mcs_details;
Johannes Berg51648922012-11-22 23:00:18 +01001700 u16 radiotap_vht_details;
Arik Nemtsov72d78722012-05-10 16:18:26 +03001701 netdev_features_t netdev_features;
Alexander Bondar219c3862013-01-22 16:52:23 +02001702 u8 uapsd_queues;
1703 u8 uapsd_max_sp_len;
Max Stepanov2475b1cc2013-03-24 14:23:27 +02001704 u8 n_cipher_schemes;
1705 const struct ieee80211_cipher_scheme *cipher_schemes;
Jiri Bencf0706e82007-05-05 11:45:53 -07001706};
1707
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001708/**
Luis R. Rodriguez9a953712009-01-22 15:05:53 -08001709 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1710 *
1711 * @wiphy: the &struct wiphy which we want to query
1712 *
1713 * mac80211 drivers can use this to get to their respective
1714 * &struct ieee80211_hw. Drivers wishing to get to their own private
1715 * structure can then access it via hw->priv. Note that mac802111 drivers should
1716 * not use wiphy_priv() to try to get their private driver structure as this
1717 * is already used internally by mac80211.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01001718 *
1719 * Return: The mac80211 driver hw struct of @wiphy.
Luis R. Rodriguez9a953712009-01-22 15:05:53 -08001720 */
1721struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1722
1723/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001724 * SET_IEEE80211_DEV - set device for 802.11 hardware
1725 *
1726 * @hw: the &struct ieee80211_hw to set the device for
1727 * @dev: the &struct device of this 802.11 device
1728 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001729static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1730{
1731 set_wiphy_dev(hw->wiphy, dev);
1732}
1733
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001734/**
Bob Copelande37d4df2008-10-20 21:20:27 -04001735 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001736 *
1737 * @hw: the &struct ieee80211_hw to set the MAC address for
1738 * @addr: the address to set
1739 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001740static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1741{
1742 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1743}
1744
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001745static inline struct ieee80211_rate *
1746ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001747 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001748{
Larry Fingeraa331df2012-04-06 16:35:53 -05001749 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001750 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001751 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001752}
1753
1754static inline struct ieee80211_rate *
1755ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001756 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001757{
Johannes Berge039fa42008-05-15 12:55:29 +02001758 if (c->control.rts_cts_rate_idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001759 return NULL;
Johannes Berge039fa42008-05-15 12:55:29 +02001760 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001761}
1762
1763static inline struct ieee80211_rate *
1764ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
Felix Fietkau870abdf2008-10-05 18:04:24 +02001765 const struct ieee80211_tx_info *c, int idx)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001766{
Johannes Berge6a98542008-10-21 12:40:02 +02001767 if (c->control.rates[idx + 1].idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001768 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001769 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001770}
1771
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001772/**
Johannes Berg6096de72011-11-04 11:18:10 +01001773 * ieee80211_free_txskb - free TX skb
1774 * @hw: the hardware
1775 * @skb: the skb
1776 *
1777 * Free a transmit skb. Use this funtion when some failure
1778 * to transmit happened and thus status cannot be reported.
1779 */
1780void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
1781
1782/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001783 * DOC: Hardware crypto acceleration
Johannes Berg4150c572007-09-17 01:29:23 -04001784 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001785 * mac80211 is capable of taking advantage of many hardware
1786 * acceleration designs for encryption and decryption operations.
1787 *
1788 * The set_key() callback in the &struct ieee80211_ops for a given
1789 * device is called to enable hardware acceleration of encryption and
Johannes Bergdc822b52008-12-29 12:55:09 +01001790 * decryption. The callback takes a @sta parameter that will be NULL
1791 * for default keys or keys used for transmission only, or point to
1792 * the station information for the peer for individual keys.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001793 * Multiple transmission keys with the same key index may be used when
1794 * VLANs are configured for an access point.
1795 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001796 * When transmitting, the TX control data will use the @hw_key_idx
1797 * selected by the driver by modifying the &struct ieee80211_key_conf
1798 * pointed to by the @key parameter to the set_key() function.
1799 *
1800 * The set_key() call for the %SET_KEY command should return 0 if
1801 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1802 * added; if you return 0 then hw_key_idx must be assigned to the
1803 * hardware key index, you are free to use the full u8 range.
1804 *
1805 * When the cmd is %DISABLE_KEY then it must succeed.
1806 *
1807 * Note that it is permissible to not decrypt a frame even if a key
1808 * for it has been uploaded to hardware, the stack will not make any
1809 * decision based on whether a key has been uploaded or not but rather
1810 * based on the receive flags.
1811 *
1812 * The &struct ieee80211_key_conf structure pointed to by the @key
1813 * parameter is guaranteed to be valid until another call to set_key()
1814 * removes it, but it can only be used as a cookie to differentiate
1815 * keys.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001816 *
1817 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1818 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1819 * handler.
1820 * The update_tkip_key() call updates the driver with the new phase 1 key.
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001821 * This happens every time the iv16 wraps around (every 65536 packets). The
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001822 * set_key() call will happen only once for each key (unless the AP did
1823 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
Bob Copelande37d4df2008-10-20 21:20:27 -04001824 * provided by update_tkip_key only. The trigger that makes mac80211 call this
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001825 * handler is software decryption with wrap around of iv16.
Yoni Divinskyde5fad82012-05-30 11:36:39 +03001826 *
1827 * The set_default_unicast_key() call updates the default WEP key index
1828 * configured to the hardware for WEP encryption type. This is required
1829 * for devices that support offload of data packets (e.g. ARP responses).
Johannes Berg4150c572007-09-17 01:29:23 -04001830 */
Johannes Berg4150c572007-09-17 01:29:23 -04001831
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001832/**
Johannes Berg4be8c382009-01-07 18:28:20 +01001833 * DOC: Powersave support
1834 *
1835 * mac80211 has support for various powersave implementations.
1836 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001837 * First, it can support hardware that handles all powersaving by itself,
1838 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1839 * flag. In that case, it will be told about the desired powersave mode
1840 * with the %IEEE80211_CONF_PS flag depending on the association status.
1841 * The hardware must take care of sending nullfunc frames when necessary,
1842 * i.e. when entering and leaving powersave mode. The hardware is required
1843 * to look at the AID in beacons and signal to the AP that it woke up when
1844 * it finds traffic directed to it.
Johannes Berg4be8c382009-01-07 18:28:20 +01001845 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001846 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1847 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1848 * with hardware wakeup and sleep states. Driver is responsible for waking
Bob Copeland2738bd62010-08-21 16:39:01 -04001849 * up the hardware before issuing commands to the hardware and putting it
1850 * back to sleep at appropriate times.
Kalle Valoc99445b2010-01-14 13:09:21 +02001851 *
1852 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1853 * buffered multicast/broadcast frames after the beacon. Also it must be
1854 * possible to send frames and receive the acknowledment frame.
Johannes Berg4be8c382009-01-07 18:28:20 +01001855 *
1856 * Other hardware designs cannot send nullfunc frames by themselves and also
1857 * need software support for parsing the TIM bitmap. This is also supported
1858 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1859 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
Johannes Berg955394c2009-04-16 17:04:25 +02001860 * required to pass up beacons. The hardware is still required to handle
1861 * waking up for multicast traffic; if it cannot the driver must handle that
Kalle Valoc99445b2010-01-14 13:09:21 +02001862 * as best as it can, mac80211 is too slow to do that.
Johannes Berg4be8c382009-01-07 18:28:20 +01001863 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001864 * Dynamic powersave is an extension to normal powersave in which the
1865 * hardware stays awake for a user-specified period of time after sending a
1866 * frame so that reply frames need not be buffered and therefore delayed to
1867 * the next wakeup. It's compromise of getting good enough latency when
1868 * there's data traffic and still saving significantly power in idle
1869 * periods.
1870 *
Bob Copeland2738bd62010-08-21 16:39:01 -04001871 * Dynamic powersave is simply supported by mac80211 enabling and disabling
Kalle Valoc99445b2010-01-14 13:09:21 +02001872 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1873 * flag and mac80211 will handle everything automatically. Additionally,
1874 * hardware having support for the dynamic PS feature may set the
1875 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1876 * dynamic PS mode itself. The driver needs to look at the
1877 * @dynamic_ps_timeout hardware configuration value and use it that value
1878 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1879 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1880 * enabled whenever user has enabled powersave.
1881 *
1882 * Driver informs U-APSD client support by enabling
1883 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1884 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1885 * Nullfunc frames and stay awake until the service period has ended. To
1886 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1887 * from that AC are transmitted with powersave enabled.
1888 *
1889 * Note: U-APSD client mode is not yet supported with
1890 * %IEEE80211_HW_PS_NULLFUNC_STACK.
Johannes Berg4be8c382009-01-07 18:28:20 +01001891 */
1892
1893/**
Kalle Valo04de8382009-03-22 21:57:35 +02001894 * DOC: Beacon filter support
1895 *
1896 * Some hardware have beacon filter support to reduce host cpu wakeups
Justin P. Mattock42b2aa82011-11-28 20:31:00 -08001897 * which will reduce system power consumption. It usually works so that
Kalle Valo04de8382009-03-22 21:57:35 +02001898 * the firmware creates a checksum of the beacon but omits all constantly
1899 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1900 * beacon is forwarded to the host, otherwise it will be just dropped. That
1901 * way the host will only receive beacons where some relevant information
1902 * (for example ERP protection or WMM settings) have changed.
1903 *
Johannes Bergc1288b12012-01-19 09:29:57 +01001904 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
1905 * interface capability. The driver needs to enable beacon filter support
Johannes Berg955394c2009-04-16 17:04:25 +02001906 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1907 * power save is enabled, the stack will not check for beacon loss and the
1908 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1909 *
1910 * The time (or number of beacons missed) until the firmware notifies the
1911 * driver of a beacon loss event (which in turn causes the driver to call
1912 * ieee80211_beacon_loss()) should be configurable and will be controlled
1913 * by mac80211 and the roaming algorithm in the future.
1914 *
1915 * Since there may be constantly changing information elements that nothing
1916 * in the software stack cares about, we will, in the future, have mac80211
1917 * tell the driver which information elements are interesting in the sense
1918 * that we want to see changes in them. This will include
1919 * - a list of information element IDs
1920 * - a list of OUIs for the vendor information element
1921 *
1922 * Ideally, the hardware would filter out any beacons without changes in the
1923 * requested elements, but if it cannot support that it may, at the expense
1924 * of some efficiency, filter out only a subset. For example, if the device
1925 * doesn't support checking for OUIs it should pass up all changes in all
1926 * vendor information elements.
1927 *
1928 * Note that change, for the sake of simplification, also includes information
1929 * elements appearing or disappearing from the beacon.
1930 *
1931 * Some hardware supports an "ignore list" instead, just make sure nothing
1932 * that was requested is on the ignore list, and include commonly changing
1933 * information element IDs in the ignore list, for example 11 (BSS load) and
1934 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1935 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1936 * it could also include some currently unused IDs.
1937 *
1938 *
1939 * In addition to these capabilities, hardware should support notifying the
1940 * host of changes in the beacon RSSI. This is relevant to implement roaming
1941 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1942 * the received data packets). This can consist in notifying the host when
1943 * the RSSI changes significantly or when it drops below or rises above
1944 * configurable thresholds. In the future these thresholds will also be
1945 * configured by mac80211 (which gets them from userspace) to implement
1946 * them as the roaming algorithm requires.
1947 *
1948 * If the hardware cannot implement this, the driver should ask it to
1949 * periodically pass beacon frames to the host so that software can do the
1950 * signal strength threshold checking.
Kalle Valo04de8382009-03-22 21:57:35 +02001951 */
1952
1953/**
Johannes Berg0f782312009-12-01 13:37:02 +01001954 * DOC: Spatial multiplexing power save
1955 *
1956 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1957 * power in an 802.11n implementation. For details on the mechanism
1958 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1959 * "11.2.3 SM power save".
1960 *
1961 * The mac80211 implementation is capable of sending action frames
1962 * to update the AP about the station's SMPS mode, and will instruct
1963 * the driver to enter the specific mode. It will also announce the
1964 * requested SMPS mode during the association handshake. Hardware
1965 * support for this feature is required, and can be indicated by
1966 * hardware flags.
1967 *
1968 * The default mode will be "automatic", which nl80211/cfg80211
1969 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1970 * turned off otherwise.
1971 *
1972 * To support this feature, the driver must set the appropriate
1973 * hardware support flags, and handle the SMPS flag to the config()
1974 * operation. It will then with this mechanism be instructed to
1975 * enter the requested SMPS mode while associated to an HT AP.
1976 */
1977
1978/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001979 * DOC: Frame filtering
1980 *
1981 * mac80211 requires to see many management frames for proper
1982 * operation, and users may want to see many more frames when
1983 * in monitor mode. However, for best CPU usage and power consumption,
1984 * having as few frames as possible percolate through the stack is
1985 * desirable. Hence, the hardware should filter as much as possible.
1986 *
1987 * To achieve this, mac80211 uses filter flags (see below) to tell
1988 * the driver's configure_filter() function which frames should be
1989 * passed to mac80211 and which should be filtered out.
1990 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02001991 * Before configure_filter() is invoked, the prepare_multicast()
1992 * callback is invoked with the parameters @mc_count and @mc_list
1993 * for the combined multicast address list of all virtual interfaces.
1994 * It's use is optional, and it returns a u64 that is passed to
1995 * configure_filter(). Additionally, configure_filter() has the
1996 * arguments @changed_flags telling which flags were changed and
1997 * @total_flags with the new flag states.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001998 *
1999 * If your device has no multicast address filters your driver will
2000 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2001 * parameter to see whether multicast frames should be accepted
2002 * or dropped.
2003 *
Michael Bueschd0f5afb2008-02-12 20:12:45 +01002004 * All unsupported flags in @total_flags must be cleared.
2005 * Hardware does not support a flag if it is incapable of _passing_
2006 * the frame to the stack. Otherwise the driver must ignore
2007 * the flag, but not clear it.
2008 * You must _only_ clear the flag (announce no support for the
2009 * flag to mac80211) if you are not able to pass the packet type
2010 * to the stack (so the hardware always filters it).
2011 * So for example, you should clear @FIF_CONTROL, if your hardware
2012 * always filters control frames. If your hardware always passes
2013 * control frames to the kernel and is incapable of filtering them,
2014 * you do _not_ clear the @FIF_CONTROL flag.
2015 * This rule applies to all other FIF flags as well.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002016 */
2017
2018/**
Johannes Berg4b801bc2011-09-29 16:04:40 +02002019 * DOC: AP support for powersaving clients
2020 *
2021 * In order to implement AP and P2P GO modes, mac80211 has support for
2022 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2023 * There currently is no support for sAPSD.
2024 *
2025 * There is one assumption that mac80211 makes, namely that a client
2026 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2027 * Both are supported, and both can be used by the same client, but
2028 * they can't be used concurrently by the same client. This simplifies
2029 * the driver code.
2030 *
2031 * The first thing to keep in mind is that there is a flag for complete
2032 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2033 * mac80211 expects the driver to handle most of the state machine for
2034 * powersaving clients and will ignore the PM bit in incoming frames.
2035 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2036 * stations' powersave transitions. In this mode, mac80211 also doesn't
2037 * handle PS-Poll/uAPSD.
2038 *
2039 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2040 * PM bit in incoming frames for client powersave transitions. When a
2041 * station goes to sleep, we will stop transmitting to it. There is,
2042 * however, a race condition: a station might go to sleep while there is
2043 * data buffered on hardware queues. If the device has support for this
2044 * it will reject frames, and the driver should give the frames back to
2045 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2046 * cause mac80211 to retry the frame when the station wakes up. The
2047 * driver is also notified of powersave transitions by calling its
2048 * @sta_notify callback.
2049 *
2050 * When the station is asleep, it has three choices: it can wake up,
2051 * it can PS-Poll, or it can possibly start a uAPSD service period.
2052 * Waking up is implemented by simply transmitting all buffered (and
2053 * filtered) frames to the station. This is the easiest case. When
2054 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2055 * will inform the driver of this with the @allow_buffered_frames
2056 * callback; this callback is optional. mac80211 will then transmit
Johannes Berg02f2f1a2012-02-27 12:18:30 +01002057 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
Johannes Berg4b801bc2011-09-29 16:04:40 +02002058 * on each frame. The last frame in the service period (or the only
2059 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2060 * indicate that it ends the service period; as this frame must have
2061 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2062 * When TX status is reported for this frame, the service period is
2063 * marked has having ended and a new one can be started by the peer.
2064 *
Johannes Berg02f2f1a2012-02-27 12:18:30 +01002065 * Additionally, non-bufferable MMPDUs can also be transmitted by
2066 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2067 *
Johannes Berg4b801bc2011-09-29 16:04:40 +02002068 * Another race condition can happen on some devices like iwlwifi
2069 * when there are frames queued for the station and it wakes up
2070 * or polls; the frames that are already queued could end up being
2071 * transmitted first instead, causing reordering and/or wrong
2072 * processing of the EOSP. The cause is that allowing frames to be
2073 * transmitted to a certain station is out-of-band communication to
2074 * the device. To allow this problem to be solved, the driver can
2075 * call ieee80211_sta_block_awake() if frames are buffered when it
2076 * is notified that the station went to sleep. When all these frames
2077 * have been filtered (see above), it must call the function again
2078 * to indicate that the station is no longer blocked.
2079 *
2080 * If the driver buffers frames in the driver for aggregation in any
2081 * way, it must use the ieee80211_sta_set_buffered() call when it is
2082 * notified of the station going to sleep to inform mac80211 of any
2083 * TIDs that have frames buffered. Note that when a station wakes up
2084 * this information is reset (hence the requirement to call it when
2085 * informed of the station going to sleep). Then, when a service
2086 * period starts for any reason, @release_buffered_frames is called
2087 * with the number of frames to be released and which TIDs they are
2088 * to come from. In this case, the driver is responsible for setting
2089 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2090 * to help the @more_data paramter is passed to tell the driver if
2091 * there is more data on other TIDs -- the TIDs to release frames
2092 * from are ignored since mac80211 doesn't know how many frames the
2093 * buffers for those TIDs contain.
2094 *
2095 * If the driver also implement GO mode, where absence periods may
2096 * shorten service periods (or abort PS-Poll responses), it must
2097 * filter those response frames except in the case of frames that
2098 * are buffered in the driver -- those must remain buffered to avoid
2099 * reordering. Because it is possible that no frames are released
Johannes Berge9437892013-02-15 21:38:08 +01002100 * in this case, the driver must call ieee80211_sta_eosp()
Johannes Berg4b801bc2011-09-29 16:04:40 +02002101 * to indicate to mac80211 that the service period ended anyway.
2102 *
2103 * Finally, if frames from multiple TIDs are released from mac80211
2104 * but the driver might reorder them, it must clear & set the flags
2105 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2106 * and also take care of the EOSP and MORE_DATA bits in the frame.
Johannes Berge9437892013-02-15 21:38:08 +01002107 * The driver may also use ieee80211_sta_eosp() in this case.
Johannes Berg4b801bc2011-09-29 16:04:40 +02002108 */
2109
2110/**
Johannes Berg3a25a8c2012-04-03 16:28:50 +02002111 * DOC: HW queue control
2112 *
2113 * Before HW queue control was introduced, mac80211 only had a single static
2114 * assignment of per-interface AC software queues to hardware queues. This
2115 * was problematic for a few reasons:
2116 * 1) off-channel transmissions might get stuck behind other frames
2117 * 2) multiple virtual interfaces couldn't be handled correctly
2118 * 3) after-DTIM frames could get stuck behind other frames
2119 *
2120 * To solve this, hardware typically uses multiple different queues for all
2121 * the different usages, and this needs to be propagated into mac80211 so it
2122 * won't have the same problem with the software queues.
2123 *
2124 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2125 * flag that tells it that the driver implements its own queue control. To do
2126 * so, the driver will set up the various queues in each &struct ieee80211_vif
2127 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2128 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2129 * if necessary will queue the frame on the right software queue that mirrors
2130 * the hardware queue.
2131 * Additionally, the driver has to then use these HW queue IDs for the queue
2132 * management functions (ieee80211_stop_queue() et al.)
2133 *
2134 * The driver is free to set up the queue mappings as needed, multiple virtual
2135 * interfaces may map to the same hardware queues if needed. The setup has to
2136 * happen during add_interface or change_interface callbacks. For example, a
2137 * driver supporting station+station and station+AP modes might decide to have
2138 * 10 hardware queues to handle different scenarios:
2139 *
2140 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2141 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2142 * after-DTIM queue for AP: 8
2143 * off-channel queue: 9
2144 *
2145 * It would then set up the hardware like this:
2146 * hw.offchannel_tx_hw_queue = 9
2147 *
2148 * and the first virtual interface that is added as follows:
2149 * vif.hw_queue[IEEE80211_AC_VO] = 0
2150 * vif.hw_queue[IEEE80211_AC_VI] = 1
2151 * vif.hw_queue[IEEE80211_AC_BE] = 2
2152 * vif.hw_queue[IEEE80211_AC_BK] = 3
2153 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2154 * and the second virtual interface with 4-7.
2155 *
2156 * If queue 6 gets full, for example, mac80211 would only stop the second
2157 * virtual interface's BE queue since virtual interface queues are per AC.
2158 *
2159 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2160 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2161 * queue could potentially be shared since mac80211 will look at cab_queue when
2162 * a queue is stopped/woken even if the interface is not in AP mode.
2163 */
2164
2165/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002166 * enum ieee80211_filter_flags - hardware filter flags
2167 *
2168 * These flags determine what the filter in hardware should be
2169 * programmed to let through and what should not be passed to the
2170 * stack. It is always safe to pass more frames than requested,
2171 * but this has negative impact on power consumption.
2172 *
2173 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
2174 * think of the BSS as your network segment and then this corresponds
2175 * to the regular ethernet device promiscuous mode.
2176 *
2177 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2178 * by the user or if the hardware is not capable of filtering by
2179 * multicast address.
2180 *
2181 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2182 * %RX_FLAG_FAILED_FCS_CRC for them)
2183 *
2184 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2185 * the %RX_FLAG_FAILED_PLCP_CRC for them
2186 *
2187 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2188 * to the hardware that it should not filter beacons or probe responses
2189 * by BSSID. Filtering them can greatly reduce the amount of processing
2190 * mac80211 needs to do and the amount of CPU wakeups, so you should
2191 * honour this flag if possible.
2192 *
Igor Perminove3b90ca2009-08-04 16:48:51 +04002193 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
Johannes Berg7be50862010-10-13 12:06:24 +02002194 * is not set then only those addressed to this station.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002195 *
2196 * @FIF_OTHER_BSS: pass frames destined to other BSSes
Igor Perminove3b90ca2009-08-04 16:48:51 +04002197 *
Johannes Berg7be50862010-10-13 12:06:24 +02002198 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
2199 * those addressed to this station.
2200 *
2201 * @FIF_PROBE_REQ: pass probe request frames
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002202 */
2203enum ieee80211_filter_flags {
2204 FIF_PROMISC_IN_BSS = 1<<0,
2205 FIF_ALLMULTI = 1<<1,
2206 FIF_FCSFAIL = 1<<2,
2207 FIF_PLCPFAIL = 1<<3,
2208 FIF_BCN_PRBRESP_PROMISC = 1<<4,
2209 FIF_CONTROL = 1<<5,
2210 FIF_OTHER_BSS = 1<<6,
Igor Perminove3b90ca2009-08-04 16:48:51 +04002211 FIF_PSPOLL = 1<<7,
Johannes Berg7be50862010-10-13 12:06:24 +02002212 FIF_PROBE_REQ = 1<<8,
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002213};
2214
2215/**
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02002216 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2217 *
2218 * These flags are used with the ampdu_action() callback in
2219 * &struct ieee80211_ops to indicate which action is needed.
Johannes Berg827d42c2009-11-22 12:28:41 +01002220 *
2221 * Note that drivers MUST be able to deal with a TX aggregation
2222 * session being stopped even before they OK'ed starting it by
Johannes Berg5d22c892010-06-10 10:21:40 +02002223 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
Johannes Berg827d42c2009-11-22 12:28:41 +01002224 * might receive the addBA frame and send a delBA right away!
2225 *
Johannes Berg18b559d2012-07-18 13:51:25 +02002226 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2227 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2228 * @IEEE80211_AMPDU_TX_START: start TX aggregation
Johannes Bergb1720232009-03-23 17:28:39 +01002229 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
Johannes Berg18b559d2012-07-18 13:51:25 +02002230 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2231 * queued packets, now unaggregated. After all packets are transmitted the
2232 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2233 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2234 * called when the station is removed. There's no need or reason to call
2235 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2236 * session is gone and removes the station.
2237 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2238 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2239 * now the connection is dropped and the station will be removed. Drivers
2240 * should clean up and drop remaining packets when this is called.
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02002241 */
2242enum ieee80211_ampdu_mlme_action {
2243 IEEE80211_AMPDU_RX_START,
2244 IEEE80211_AMPDU_RX_STOP,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002245 IEEE80211_AMPDU_TX_START,
Johannes Berg18b559d2012-07-18 13:51:25 +02002246 IEEE80211_AMPDU_TX_STOP_CONT,
2247 IEEE80211_AMPDU_TX_STOP_FLUSH,
2248 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
Johannes Bergb1720232009-03-23 17:28:39 +01002249 IEEE80211_AMPDU_TX_OPERATIONAL,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02002250};
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002251
2252/**
Johannes Berg4049e092011-09-29 16:04:32 +02002253 * enum ieee80211_frame_release_type - frame release reason
2254 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
Johannes Berg47086fc2011-09-29 16:04:33 +02002255 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2256 * frame received on trigger-enabled AC
Johannes Berg4049e092011-09-29 16:04:32 +02002257 */
2258enum ieee80211_frame_release_type {
2259 IEEE80211_FRAME_RELEASE_PSPOLL,
Johannes Berg47086fc2011-09-29 16:04:33 +02002260 IEEE80211_FRAME_RELEASE_UAPSD,
Johannes Berg4049e092011-09-29 16:04:32 +02002261};
2262
2263/**
Johannes Berg8f727ef2012-03-30 08:43:32 +02002264 * enum ieee80211_rate_control_changed - flags to indicate what changed
2265 *
2266 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
Johannes Berge1a0c6b2013-02-07 11:47:44 +01002267 * to this station changed. The actual bandwidth is in the station
2268 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2269 * flag changes, for HT and VHT the bandwidth field changes.
Johannes Berg8f727ef2012-03-30 08:43:32 +02002270 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
Antonio Quartullie687f612012-08-12 18:24:55 +02002271 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2272 * changed (in IBSS mode) due to discovering more information about
2273 * the peer.
Johannes Berg0af83d32012-12-27 18:55:36 +01002274 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2275 * by the peer
Johannes Berg8f727ef2012-03-30 08:43:32 +02002276 */
2277enum ieee80211_rate_control_changed {
2278 IEEE80211_RC_BW_CHANGED = BIT(0),
2279 IEEE80211_RC_SMPS_CHANGED = BIT(1),
Antonio Quartullie687f612012-08-12 18:24:55 +02002280 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
Johannes Berg0af83d32012-12-27 18:55:36 +01002281 IEEE80211_RC_NSS_CHANGED = BIT(3),
Johannes Berg8f727ef2012-03-30 08:43:32 +02002282};
2283
2284/**
Ilan Peerd339d5c2013-02-12 09:34:13 +02002285 * enum ieee80211_roc_type - remain on channel type
2286 *
2287 * With the support for multi channel contexts and multi channel operations,
2288 * remain on channel operations might be limited/deferred/aborted by other
2289 * flows/operations which have higher priority (and vise versa).
2290 * Specifying the ROC type can be used by devices to prioritize the ROC
2291 * operations compared to other operations/flows.
2292 *
2293 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2294 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2295 * for sending managment frames offchannel.
2296 */
2297enum ieee80211_roc_type {
2298 IEEE80211_ROC_TYPE_NORMAL = 0,
2299 IEEE80211_ROC_TYPE_MGMT_TX,
2300};
2301
2302/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002303 * struct ieee80211_ops - callbacks from mac80211 to the driver
2304 *
2305 * This structure contains various callbacks that the driver may
2306 * handle or, in some cases, must handle, for example to configure
2307 * the hardware to a new channel or to transmit a frame.
2308 *
2309 * @tx: Handler that 802.11 module calls for each transmitted frame.
2310 * skb contains the buffer starting from the IEEE 802.11 header.
2311 * The low-level driver should send the frame out based on
Johannes Bergeefce912008-05-17 00:57:13 +02002312 * configuration in the TX control data. This handler should,
Johannes Berg11127e92011-11-16 16:02:47 +01002313 * preferably, never fail and stop queues appropriately.
Johannes Berg11127e92011-11-16 16:02:47 +01002314 * Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002315 *
2316 * @start: Called before the first netdevice attached to the hardware
2317 * is enabled. This should turn on the hardware and must turn on
2318 * frame reception (for possibly enabled monitor interfaces.)
2319 * Returns negative error codes, these may be seen in userspace,
2320 * or zero.
2321 * When the device is started it should not have a MAC address
2322 * to avoid acknowledging frames before a non-monitor device
2323 * is added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002324 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002325 *
2326 * @stop: Called after last netdevice attached to the hardware
2327 * is disabled. This should turn off the hardware (at least
2328 * it must turn off frame reception.)
2329 * May be called right after add_interface if that rejects
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04002330 * an interface. If you added any work onto the mac80211 workqueue
2331 * you should ensure to cancel it on this callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002332 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002333 *
Johannes Bergeecc4802011-05-04 15:37:29 +02002334 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2335 * stop transmitting and doing any other configuration, and then
2336 * ask the device to suspend. This is only invoked when WoWLAN is
2337 * configured, otherwise the device is deconfigured completely and
2338 * reconfigured at resume time.
Johannes Berg2b4562d2011-07-02 00:02:01 +02002339 * The driver may also impose special conditions under which it
2340 * wants to use the "normal" suspend (deconfigure), say if it only
2341 * supports WoWLAN when the device is associated. In this case, it
2342 * must return 1 from this function.
Johannes Bergeecc4802011-05-04 15:37:29 +02002343 *
2344 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2345 * now resuming its operation, after this the device must be fully
2346 * functional again. If this returns an error, the only way out is
2347 * to also unregister the device. If it returns 1, then mac80211
2348 * will also go through the regular complete restart on resume.
2349 *
Johannes Bergd13e1412012-06-09 10:31:09 +02002350 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2351 * modified. The reason is that device_set_wakeup_enable() is
2352 * supposed to be called when the configuration changes, not only
2353 * in suspend().
2354 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002355 * @add_interface: Called when a netdevice attached to the hardware is
Bob Copelande37d4df2008-10-20 21:20:27 -04002356 * enabled. Because it is not called for monitor mode devices, @start
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002357 * and @stop must be implemented.
2358 * The driver should perform any initialization it needs before
2359 * the device can be enabled. The initial configuration for the
2360 * interface is given in the conf parameter.
2361 * The callback may refuse to add an interface by returning a
2362 * negative error code (which will be seen in userspace.)
Kalle Valoe1781ed2009-12-23 13:15:47 +01002363 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002364 *
Johannes Berg34d4bc42010-08-27 12:35:58 +02002365 * @change_interface: Called when a netdevice changes type. This callback
2366 * is optional, but only if it is supported can interface types be
2367 * switched while the interface is UP. The callback may sleep.
2368 * Note that while an interface is being switched, it will not be
2369 * found by the interface iteration callbacks.
2370 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002371 * @remove_interface: Notifies a driver that an interface is going down.
2372 * The @stop callback is called after this if it is the last interface
2373 * and no monitor interfaces are present.
2374 * When all interfaces are removed, the MAC address in the hardware
2375 * must be cleared so the device no longer acknowledges packets,
2376 * the mac_addr member of the conf structure is, however, set to the
2377 * MAC address of the device going away.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002378 * Hence, this callback must be implemented. It can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002379 *
2380 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2381 * function to change hardware configuration, e.g., channel.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05002382 * This function should never fail but returns a negative error code
Kalle Valoe1781ed2009-12-23 13:15:47 +01002383 * if it does. The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002384 *
Johannes Berg471b3ef2007-12-28 14:32:58 +01002385 * @bss_info_changed: Handler for configuration requests related to BSS
2386 * parameters that may vary during BSS's lifespan, and may affect low
2387 * level driver (e.g. assoc/disassoc status, erp parameters).
2388 * This function should not be used if no BSS has been set, unless
2389 * for association indication. The @changed parameter indicates which
Kalle Valoe1781ed2009-12-23 13:15:47 +01002390 * of the bss parameters has changed when a call is made. The callback
2391 * can sleep.
Johannes Berg471b3ef2007-12-28 14:32:58 +01002392 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02002393 * @prepare_multicast: Prepare for multicast filter configuration.
2394 * This callback is optional, and its return value is passed
2395 * to configure_filter(). This callback must be atomic.
2396 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002397 * @configure_filter: Configure the device's RX filter.
2398 * See the section "Frame filtering" for more information.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002399 * This callback must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002400 *
Alexander Bondar488b3662013-02-11 14:56:29 +02002401 * @set_multicast_list: Configure the device's interface specific RX multicast
2402 * filter. This callback is optional. This callback must be atomic.
2403 *
Luis R. Rodriguez546c80c92008-08-14 11:43:20 -07002404 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
Johannes Berg17741cd2008-09-11 00:02:02 +02002405 * must be set or cleared for a given STA. Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002406 *
2407 * @set_key: See the section "Hardware crypto acceleration"
Kalle Valoe1781ed2009-12-23 13:15:47 +01002408 * This callback is only called between add_interface and
2409 * remove_interface calls, i.e. while the given virtual interface
Johannes Bergdc822b52008-12-29 12:55:09 +01002410 * is enabled.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05002411 * Returns a negative error code if the key can't be added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002412 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002413 *
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02002414 * @update_tkip_key: See the section "Hardware crypto acceleration"
2415 * This callback will be called in the context of Rx. Called for drivers
2416 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
Kalle Valoeb807fb2010-01-24 14:55:12 +02002417 * The callback must be atomic.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02002418 *
Johannes Bergc68f4b82011-07-05 16:35:41 +02002419 * @set_rekey_data: If the device supports GTK rekeying, for example while the
2420 * host is suspended, it can assign this callback to retrieve the data
2421 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2422 * After rekeying was done it should (for example during resume) notify
2423 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2424 *
Yoni Divinskyde5fad82012-05-30 11:36:39 +03002425 * @set_default_unicast_key: Set the default (unicast) key index, useful for
2426 * WEP when the device sends data packets autonomously, e.g. for ARP
2427 * offloading. The index can be 0-3, or -1 for unsetting it.
2428 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002429 * @hw_scan: Ask the hardware to service the scan request, no need to start
Johannes Berg8318d782008-01-24 19:38:38 +01002430 * the scan state machine in stack. The scan must honour the channel
Kalle Valo9050bdd2009-03-22 21:57:21 +02002431 * configuration done by the regulatory agent in the wiphy's
2432 * registered bands. The hardware (or the driver) needs to make sure
Johannes Bergde95a542009-04-01 11:58:36 +02002433 * that power save is disabled.
2434 * The @req ie/ie_len members are rewritten by mac80211 to contain the
2435 * entire IEs after the SSID, so that drivers need not look at these
2436 * at all but just send them after the SSID -- mac80211 includes the
2437 * (extended) supported rates and HT information (where applicable).
2438 * When the scan finishes, ieee80211_scan_completed() must be called;
2439 * note that it also must be called when the scan cannot finish due to
2440 * any error unless this callback returned a negative error code.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002441 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002442 *
Eliad Pellerb8564392011-06-13 12:47:30 +03002443 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2444 * The driver should ask the hardware to cancel the scan (if possible),
2445 * but the scan will be completed only after the driver will call
2446 * ieee80211_scan_completed().
2447 * This callback is needed for wowlan, to prevent enqueueing a new
2448 * scan_work after the low-level driver was already suspended.
2449 * The callback can sleep.
2450 *
Luciano Coelho79f460c2011-05-11 17:09:36 +03002451 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2452 * specific intervals. The driver must call the
2453 * ieee80211_sched_scan_results() function whenever it finds results.
2454 * This process will continue until sched_scan_stop is called.
2455 *
2456 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
2457 *
Michael Buesch80e775b2009-02-20 15:37:03 +01002458 * @sw_scan_start: Notifier function that is called just before a software scan
2459 * is started. Can be NULL, if the driver doesn't need this notification.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002460 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01002461 *
Kalle Valoe1781ed2009-12-23 13:15:47 +01002462 * @sw_scan_complete: Notifier function that is called just after a
2463 * software scan finished. Can be NULL, if the driver doesn't need
2464 * this notification.
2465 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01002466 *
Bob Copeland6dd1bf32009-01-08 21:00:34 -05002467 * @get_stats: Return low-level statistics.
2468 * Returns zero if statistics are available.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002469 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002470 *
Johannes Berg62da92f2007-12-19 02:03:31 +01002471 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
2472 * callback should be provided to read the TKIP transmit IVs (both IV32
2473 * and IV16) for the given key from hardware.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002474 * The callback must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002475 *
Arik Nemtsovf23a4782010-11-08 11:51:06 +02002476 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
2477 * if the device does fragmentation by itself; if this callback is
2478 * implemented then the stack will not do fragmentation.
2479 * The callback can sleep.
2480 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002481 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
Kalle Valoe1781ed2009-12-23 13:15:47 +01002482 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002483 *
Johannes Berg34e89502010-02-03 13:59:58 +01002484 * @sta_add: Notifies low level driver about addition of an associated station,
2485 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2486 *
2487 * @sta_remove: Notifies low level driver about removal of an associated
2488 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2489 *
Sujith Manoharan77d2ece2012-11-20 08:46:02 +05302490 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
2491 * when a station is added to mac80211's station list. This callback
2492 * and @sta_remove_debugfs should be within a CONFIG_MAC80211_DEBUGFS
2493 * conditional. This callback can sleep.
2494 *
2495 * @sta_remove_debugfs: Remove the debugfs files which were added using
2496 * @sta_add_debugfs. This callback can sleep.
2497 *
Johannes Berg34e89502010-02-03 13:59:58 +01002498 * @sta_notify: Notifies low level driver about power state transition of an
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02002499 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
2500 * in AP mode, this callback will not be called when the flag
2501 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
Christian Lamparter4571d3b2008-11-30 00:48:41 +01002502 *
Johannes Bergf09603a2012-01-20 13:55:21 +01002503 * @sta_state: Notifies low level driver about state transition of a
2504 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
2505 * This callback is mutually exclusive with @sta_add/@sta_remove.
2506 * It must not fail for down transitions but may fail for transitions
2507 * up the list of states.
2508 * The callback can sleep.
2509 *
Johannes Berg8f727ef2012-03-30 08:43:32 +02002510 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
2511 * used to transmit to the station. The changes are advertised with bits
2512 * from &enum ieee80211_rate_control_changed and the values are reflected
2513 * in the station data. This callback should only be used when the driver
2514 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
2515 * otherwise the rate control algorithm is notified directly.
2516 * Must be atomic.
2517 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002518 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
Johannes Bergfe3fa822008-09-08 11:05:09 +02002519 * bursting) for a hardware TX queue.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05002520 * Returns a negative error code on failure.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002521 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002522 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002523 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01002524 * this is only used for IBSS mode BSSID merging and debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01002525 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002526 * The callback can sleep.
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01002527 *
2528 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
Johannes Bergad24b0d2013-07-05 11:53:28 +02002529 * Currently, this is only used for IBSS mode debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01002530 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002531 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002532 *
2533 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
2534 * with other STAs in the IBSS. This is only used in IBSS mode. This
2535 * function is optional if the firmware/hardware takes full care of
2536 * TSF synchronization.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002537 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002538 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002539 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
2540 * This is needed only for IBSS mode and the result of this function is
2541 * used to determine whether to reply to Probe Requests.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05002542 * Returns non-zero if this device sent the last beacon.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002543 * The callback can sleep.
Ron Rindjunskyd3c990f2007-11-26 16:14:34 +02002544 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02002545 * @ampdu_action: Perform a certain A-MPDU action
2546 * The RA/TID combination determines the destination and TID we want
2547 * the ampdu action to be performed for. The action is defined through
2548 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
Bob Copeland6dd1bf32009-01-08 21:00:34 -05002549 * is the first frame we expect to perform the action on. Notice
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002550 * that TX/RX_STOP can pass NULL for this parameter.
Johannes Berg0b01f032011-01-18 13:51:05 +01002551 * The @buf_size parameter is only valid when the action is set to
2552 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
Johannes Berg5312c3f2011-04-01 13:52:34 +02002553 * buffer size (number of subframes) for this session -- the driver
2554 * may neither send aggregates containing more subframes than this
2555 * nor send aggregates in a way that lost frames would exceed the
2556 * buffer size. If just limiting the aggregate size, this would be
2557 * possible with a buf_size of 8:
2558 * - TX: 1.....7
2559 * - RX: 2....7 (lost frame #1)
2560 * - TX: 8..1...
2561 * which is invalid since #1 was now re-transmitted well past the
2562 * buffer size of 8. Correct ways to retransmit #1 would be:
2563 * - TX: 1 or 18 or 81
2564 * Even "189" would be wrong since 1 could be lost again.
2565 *
Bob Copeland6dd1bf32009-01-08 21:00:34 -05002566 * Returns a negative error code on failure.
Johannes Berg85ad1812010-06-10 10:21:49 +02002567 * The callback can sleep.
Johannes Berg1f87f7d2009-06-02 13:01:41 +02002568 *
Randy Dunlap4e8998f2010-05-21 11:28:33 -07002569 * @get_survey: Return per-channel survey information
2570 *
Johannes Berg1f87f7d2009-06-02 13:01:41 +02002571 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
2572 * need to set wiphy->rfkill_poll to %true before registration,
2573 * and need to call wiphy_rfkill_set_hw_state() in the callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002574 * The callback can sleep.
Johannes Bergaff89a92009-07-01 21:26:51 +02002575 *
Lukáš Turek310bc672009-12-21 22:50:48 +01002576 * @set_coverage_class: Set slot time for given coverage class as specified
2577 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
2578 * accordingly. This callback is not required and may sleep.
2579 *
David Spinadel52981cd2013-07-31 18:06:22 +03002580 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
2581 * be %NULL. The callback can sleep.
Wey-Yi Guy71063f02011-05-20 09:05:54 -07002582 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
Johannes Berga80f7c02009-12-23 13:15:32 +01002583 *
2584 * @flush: Flush all pending frames from the hardware queue, making sure
Johannes Berg39ecc012013-02-13 12:11:00 +01002585 * that the hardware queues are empty. The @queues parameter is a bitmap
2586 * of queues to flush, which is useful if different virtual interfaces
2587 * use different hardware queues; it may also indicate all queues.
2588 * If the parameter @drop is set to %true, pending frames may be dropped.
2589 * The callback can sleep.
Johannes Berg5ce6e432010-05-11 16:20:57 +02002590 *
2591 * @channel_switch: Drivers that need (or want) to offload the channel
2592 * switch operation for CSAs received from the AP may implement this
2593 * callback. They must then call ieee80211_chswitch_done() to indicate
2594 * completion of the channel switch.
John W. Linville4e6cbfd2010-07-29 16:14:13 -04002595 *
2596 * @napi_poll: Poll Rx queue for incoming data frames.
Bruno Randolf79b1c462010-11-24 14:34:41 +09002597 *
2598 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2599 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2600 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2601 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2602 *
2603 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
Johannes Berg4976b4e2011-01-04 13:02:32 +01002604 *
2605 * @remain_on_channel: Starts an off-channel period on the given channel, must
2606 * call back to ieee80211_ready_on_channel() when on that channel. Note
2607 * that normal channel traffic is not stopped as this is intended for hw
2608 * offload. Frames to transmit on the off-channel channel are transmitted
2609 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
2610 * duration (which will always be non-zero) expires, the driver must call
Johannes Berg196ac1c2012-06-05 14:28:40 +02002611 * ieee80211_remain_on_channel_expired().
Johannes Berg196ac1c2012-06-05 14:28:40 +02002612 * Note that this callback may be called while the device is in IDLE and
2613 * must be accepted in this case.
2614 * This callback may sleep.
Johannes Berg4976b4e2011-01-04 13:02:32 +01002615 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
2616 * aborted before it expires. This callback may sleep.
John W. Linville38c09152011-03-07 16:19:18 -05002617 *
2618 * @set_ringparam: Set tx and rx ring sizes.
2619 *
2620 * @get_ringparam: Get tx and rx ring current and maximum sizes.
Vivek Natarajane8306f92011-04-06 11:41:10 +05302621 *
2622 * @tx_frames_pending: Check if there is any pending frame in the hardware
2623 * queues before entering power save.
Sujith Manoharanbdbfd6b2011-04-27 16:56:51 +05302624 *
2625 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
2626 * when transmitting a frame. Currently only legacy rates are handled.
2627 * The callback can sleep.
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -07002628 * @rssi_callback: Notify driver when the average RSSI goes above/below
2629 * thresholds that were registered previously. The callback can sleep.
Johannes Berg4049e092011-09-29 16:04:32 +02002630 *
2631 * @release_buffered_frames: Release buffered frames according to the given
2632 * parameters. In the case where the driver buffers some frames for
2633 * sleeping stations mac80211 will use this callback to tell the driver
2634 * to release some frames, either for PS-poll or uAPSD.
2635 * Note that if the @more_data paramter is %false the driver must check
2636 * if there are more frames on the given TIDs, and if there are more than
2637 * the frames being released then it must still set the more-data bit in
2638 * the frame. If the @more_data parameter is %true, then of course the
2639 * more-data bit must always be set.
2640 * The @tids parameter tells the driver which TIDs to release frames
2641 * from, for PS-poll it will always have only a single bit set.
Johannes Bergdeeaee12011-09-29 16:04:35 +02002642 * In the case this is used for a PS-poll initiated release, the
2643 * @num_frames parameter will always be 1 so code can be shared. In
2644 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
2645 * on the TX status (and must report TX status) so that the PS-poll
2646 * period is properly ended. This is used to avoid sending multiple
2647 * responses for a retried PS-poll frame.
Johannes Berg4049e092011-09-29 16:04:32 +02002648 * In the case this is used for uAPSD, the @num_frames parameter may be
2649 * bigger than one, but the driver may send fewer frames (it must send
2650 * at least one, however). In this case it is also responsible for
Johannes Berg47086fc2011-09-29 16:04:33 +02002651 * setting the EOSP flag in the QoS header of the frames. Also, when the
2652 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
Johannes Berg37fbd902011-09-29 16:04:39 +02002653 * on the last frame in the SP. Alternatively, it may call the function
Johannes Berge9437892013-02-15 21:38:08 +01002654 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
Johannes Berg4049e092011-09-29 16:04:32 +02002655 * This callback must be atomic.
Johannes Berg40b96402011-09-29 16:04:38 +02002656 * @allow_buffered_frames: Prepare device to allow the given number of frames
2657 * to go out to the given station. The frames will be sent by mac80211
2658 * via the usual TX path after this call. The TX information for frames
Johannes Berg02f2f1a2012-02-27 12:18:30 +01002659 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
Johannes Berg40b96402011-09-29 16:04:38 +02002660 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
2661 * frames from multiple TIDs are released and the driver might reorder
2662 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
2663 * on the last frame and clear it on all others and also handle the EOSP
Johannes Berg37fbd902011-09-29 16:04:39 +02002664 * bit in the QoS header correctly. Alternatively, it can also call the
Johannes Berge9437892013-02-15 21:38:08 +01002665 * ieee80211_sta_eosp() function.
Johannes Berg40b96402011-09-29 16:04:38 +02002666 * The @tids parameter is a bitmap and tells the driver which TIDs the
2667 * frames will be on; it will at most have two bits set.
2668 * This callback must be atomic.
Ben Greeare3521142012-04-23 12:50:31 -07002669 *
2670 * @get_et_sset_count: Ethtool API to get string-set count.
2671 *
2672 * @get_et_stats: Ethtool API to get a set of u64 stats.
2673 *
2674 * @get_et_strings: Ethtool API to get a set of strings to describe stats
2675 * and perhaps other supported types of ethtool data-sets.
2676 *
Victor Goldenshtein66572cf2012-06-21 10:56:46 +03002677 * @get_rssi: Get current signal strength in dBm, the function is optional
2678 * and can sleep.
2679 *
Johannes Berga1845fc2012-06-27 13:18:36 +02002680 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
2681 * before associated. In multi-channel scenarios, a virtual interface is
2682 * bound to a channel before it is associated, but as it isn't associated
2683 * yet it need not necessarily be given airtime, in particular since any
2684 * transmission to a P2P GO needs to be synchronized against the GO's
2685 * powersave state. mac80211 will call this function before transmitting a
2686 * management frame prior to having successfully associated to allow the
2687 * driver to give it channel time for the transmission, to get a response
2688 * and to be able to synchronize with the GO.
2689 * The callback will be called before each transmission and upon return
2690 * mac80211 will transmit the frame right away.
2691 * The callback is optional and can (should!) sleep.
Michal Kaziorc3645ea2012-06-26 14:37:17 +02002692 *
2693 * @add_chanctx: Notifies device driver about new channel context creation.
2694 * @remove_chanctx: Notifies device driver about channel context destruction.
2695 * @change_chanctx: Notifies device driver about channel context changes that
2696 * may happen when combining different virtual interfaces on the same
2697 * channel context with different settings
2698 * @assign_vif_chanctx: Notifies device driver about channel context being bound
2699 * to vif. Possible use is for hw queue remapping.
2700 * @unassign_vif_chanctx: Notifies device driver about channel context being
2701 * unbound from vif.
Johannes Berg10416382012-10-19 15:44:42 +02002702 * @start_ap: Start operation on the AP interface, this is called after all the
2703 * information in bss_conf is set and beacon can be retrieved. A channel
2704 * context is bound before this is called. Note that if the driver uses
2705 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
2706 * just "paused" for scanning/ROC, which is indicated by the beacon being
2707 * disabled/enabled via @bss_info_changed.
2708 * @stop_ap: Stop operation on the AP interface.
Johannes Berg9214ad72012-11-06 19:18:13 +01002709 *
2710 * @restart_complete: Called after a call to ieee80211_restart_hw(), when the
2711 * reconfiguration has completed. This can help the driver implement the
Johannes Berg8f21b0a2013-01-11 00:28:01 +01002712 * reconfiguration step. Also called when reconfiguring because the
2713 * driver's resume function returned 1, as this is just like an "inline"
2714 * hardware restart. This callback may sleep.
2715 *
Johannes Berga65240c2013-01-14 15:14:34 +01002716 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
2717 * Currently, this is only called for managed or P2P client interfaces.
2718 * This callback is optional; it must not sleep.
Simon Wunderlich73da7d52013-07-11 16:09:06 +02002719 *
2720 * @channel_switch_beacon: Starts a channel switch to a new channel.
2721 * Beacons are modified to include CSA or ECSA IEs before calling this
2722 * function. The corresponding count fields in these IEs must be
2723 * decremented, and when they reach zero the driver must call
2724 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
2725 * get the csa counter decremented by mac80211, but must check if it is
2726 * zero using ieee80211_csa_is_complete() after the beacon has been
2727 * transmitted and then call ieee80211_csa_finish().
2728 *
Johannes Berg55fff502013-08-19 18:48:41 +02002729 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
2730 * information in bss_conf is set up and the beacon can be retrieved. A
2731 * channel context is bound before this is called.
2732 * @leave_ibss: Leave the IBSS again.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002733 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002734struct ieee80211_ops {
Thomas Huehn36323f82012-07-23 21:33:42 +02002735 void (*tx)(struct ieee80211_hw *hw,
2736 struct ieee80211_tx_control *control,
2737 struct sk_buff *skb);
Johannes Berg4150c572007-09-17 01:29:23 -04002738 int (*start)(struct ieee80211_hw *hw);
Johannes Berg4150c572007-09-17 01:29:23 -04002739 void (*stop)(struct ieee80211_hw *hw);
Johannes Bergeecc4802011-05-04 15:37:29 +02002740#ifdef CONFIG_PM
2741 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
2742 int (*resume)(struct ieee80211_hw *hw);
Johannes Berg6d525632012-04-04 15:05:25 +02002743 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
Johannes Bergeecc4802011-05-04 15:37:29 +02002744#endif
Jiri Bencf0706e82007-05-05 11:45:53 -07002745 int (*add_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01002746 struct ieee80211_vif *vif);
Johannes Berg34d4bc42010-08-27 12:35:58 +02002747 int (*change_interface)(struct ieee80211_hw *hw,
2748 struct ieee80211_vif *vif,
Johannes Berg2ca27bc2010-09-16 14:58:23 +02002749 enum nl80211_iftype new_type, bool p2p);
Jiri Bencf0706e82007-05-05 11:45:53 -07002750 void (*remove_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01002751 struct ieee80211_vif *vif);
Johannes Berge8975582008-10-09 12:18:51 +02002752 int (*config)(struct ieee80211_hw *hw, u32 changed);
Johannes Berg471b3ef2007-12-28 14:32:58 +01002753 void (*bss_info_changed)(struct ieee80211_hw *hw,
2754 struct ieee80211_vif *vif,
2755 struct ieee80211_bss_conf *info,
2756 u32 changed);
Johannes Bergb2abb6e2011-07-19 10:39:53 +02002757
Johannes Berg10416382012-10-19 15:44:42 +02002758 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2759 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2760
Johannes Berg3ac64be2009-08-17 16:16:53 +02002761 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
Jiri Pirko22bedad32010-04-01 21:22:57 +00002762 struct netdev_hw_addr_list *mc_list);
Johannes Berg4150c572007-09-17 01:29:23 -04002763 void (*configure_filter)(struct ieee80211_hw *hw,
2764 unsigned int changed_flags,
2765 unsigned int *total_flags,
Johannes Berg3ac64be2009-08-17 16:16:53 +02002766 u64 multicast);
Alexander Bondar488b3662013-02-11 14:56:29 +02002767 void (*set_multicast_list)(struct ieee80211_hw *hw,
2768 struct ieee80211_vif *vif, bool allmulti,
2769 struct netdev_hw_addr_list *mc_list);
2770
Johannes Berg17741cd2008-09-11 00:02:02 +02002771 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
2772 bool set);
Johannes Bergea49c352007-09-18 17:29:21 -04002773 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
Johannes Bergdc822b52008-12-29 12:55:09 +01002774 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
Johannes Berg11a843b2007-08-28 17:01:55 -04002775 struct ieee80211_key_conf *key);
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02002776 void (*update_tkip_key)(struct ieee80211_hw *hw,
Johannes Bergb3fbdcf2010-01-21 11:40:47 +01002777 struct ieee80211_vif *vif,
2778 struct ieee80211_key_conf *conf,
2779 struct ieee80211_sta *sta,
2780 u32 iv32, u16 *phase1key);
Johannes Bergc68f4b82011-07-05 16:35:41 +02002781 void (*set_rekey_data)(struct ieee80211_hw *hw,
2782 struct ieee80211_vif *vif,
2783 struct cfg80211_gtk_rekey_data *data);
Yoni Divinskyde5fad82012-05-30 11:36:39 +03002784 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
2785 struct ieee80211_vif *vif, int idx);
Johannes Berga060bbf2010-04-27 11:59:34 +02002786 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg2a519312009-02-10 21:25:55 +01002787 struct cfg80211_scan_request *req);
Eliad Pellerb8564392011-06-13 12:47:30 +03002788 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
2789 struct ieee80211_vif *vif);
Luciano Coelho79f460c2011-05-11 17:09:36 +03002790 int (*sched_scan_start)(struct ieee80211_hw *hw,
2791 struct ieee80211_vif *vif,
2792 struct cfg80211_sched_scan_request *req,
2793 struct ieee80211_sched_scan_ies *ies);
2794 void (*sched_scan_stop)(struct ieee80211_hw *hw,
2795 struct ieee80211_vif *vif);
Michael Buesch80e775b2009-02-20 15:37:03 +01002796 void (*sw_scan_start)(struct ieee80211_hw *hw);
2797 void (*sw_scan_complete)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07002798 int (*get_stats)(struct ieee80211_hw *hw,
2799 struct ieee80211_low_level_stats *stats);
Johannes Berg62da92f2007-12-19 02:03:31 +01002800 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
2801 u32 *iv32, u16 *iv16);
Arik Nemtsovf23a4782010-11-08 11:51:06 +02002802 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
Jiri Bencf0706e82007-05-05 11:45:53 -07002803 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
Johannes Berg34e89502010-02-03 13:59:58 +01002804 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2805 struct ieee80211_sta *sta);
2806 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2807 struct ieee80211_sta *sta);
Sujith Manoharan77d2ece2012-11-20 08:46:02 +05302808#ifdef CONFIG_MAC80211_DEBUGFS
2809 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
2810 struct ieee80211_vif *vif,
2811 struct ieee80211_sta *sta,
2812 struct dentry *dir);
2813 void (*sta_remove_debugfs)(struct ieee80211_hw *hw,
2814 struct ieee80211_vif *vif,
2815 struct ieee80211_sta *sta,
2816 struct dentry *dir);
2817#endif
Johannes Berg32bfd352007-12-19 01:31:26 +01002818 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02002819 enum sta_notify_cmd, struct ieee80211_sta *sta);
Johannes Bergf09603a2012-01-20 13:55:21 +01002820 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2821 struct ieee80211_sta *sta,
2822 enum ieee80211_sta_state old_state,
2823 enum ieee80211_sta_state new_state);
Johannes Berg8f727ef2012-03-30 08:43:32 +02002824 void (*sta_rc_update)(struct ieee80211_hw *hw,
2825 struct ieee80211_vif *vif,
2826 struct ieee80211_sta *sta,
2827 u32 changed);
Eliad Peller8a3a3c82011-10-02 10:15:52 +02002828 int (*conf_tx)(struct ieee80211_hw *hw,
Johannes Berga3304b02012-03-28 11:04:24 +02002829 struct ieee80211_vif *vif, u16 ac,
Jiri Bencf0706e82007-05-05 11:45:53 -07002830 const struct ieee80211_tx_queue_params *params);
Eliad Peller37a41b42011-09-21 14:06:11 +03002831 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2832 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2833 u64 tsf);
2834 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07002835 int (*tx_last_beacon)(struct ieee80211_hw *hw);
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02002836 int (*ampdu_action)(struct ieee80211_hw *hw,
Johannes Bergc951ad32009-11-16 12:00:38 +01002837 struct ieee80211_vif *vif,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02002838 enum ieee80211_ampdu_mlme_action action,
Johannes Berg0b01f032011-01-18 13:51:05 +01002839 struct ieee80211_sta *sta, u16 tid, u16 *ssn,
2840 u8 buf_size);
Holger Schurig12897232010-04-19 10:23:57 +02002841 int (*get_survey)(struct ieee80211_hw *hw, int idx,
2842 struct survey_info *survey);
Johannes Berg1f87f7d2009-06-02 13:01:41 +02002843 void (*rfkill_poll)(struct ieee80211_hw *hw);
Lukáš Turek310bc672009-12-21 22:50:48 +01002844 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
Johannes Bergaff89a92009-07-01 21:26:51 +02002845#ifdef CONFIG_NL80211_TESTMODE
David Spinadel52981cd2013-07-31 18:06:22 +03002846 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2847 void *data, int len);
Wey-Yi Guy71063f02011-05-20 09:05:54 -07002848 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
2849 struct netlink_callback *cb,
2850 void *data, int len);
Johannes Bergaff89a92009-07-01 21:26:51 +02002851#endif
Johannes Berg39ecc012013-02-13 12:11:00 +01002852 void (*flush)(struct ieee80211_hw *hw, u32 queues, bool drop);
Johannes Berg5ce6e432010-05-11 16:20:57 +02002853 void (*channel_switch)(struct ieee80211_hw *hw,
2854 struct ieee80211_channel_switch *ch_switch);
John W. Linville4e6cbfd2010-07-29 16:14:13 -04002855 int (*napi_poll)(struct ieee80211_hw *hw, int budget);
Bruno Randolf15d96752010-11-10 12:50:56 +09002856 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
2857 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
Johannes Berg21f83582010-12-18 17:20:47 +01002858
2859 int (*remain_on_channel)(struct ieee80211_hw *hw,
Eliad Peller49884562012-11-19 17:05:09 +02002860 struct ieee80211_vif *vif,
Johannes Berg21f83582010-12-18 17:20:47 +01002861 struct ieee80211_channel *chan,
Ilan Peerd339d5c2013-02-12 09:34:13 +02002862 int duration,
2863 enum ieee80211_roc_type type);
Johannes Berg21f83582010-12-18 17:20:47 +01002864 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
John W. Linville38c09152011-03-07 16:19:18 -05002865 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
2866 void (*get_ringparam)(struct ieee80211_hw *hw,
2867 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
Vivek Natarajane8306f92011-04-06 11:41:10 +05302868 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
Sujith Manoharanbdbfd6b2011-04-27 16:56:51 +05302869 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2870 const struct cfg80211_bitrate_mask *mask);
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -07002871 void (*rssi_callback)(struct ieee80211_hw *hw,
Emmanuel Grumbach887da912013-01-20 17:32:41 +02002872 struct ieee80211_vif *vif,
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -07002873 enum ieee80211_rssi_event rssi_event);
Johannes Berg4049e092011-09-29 16:04:32 +02002874
Johannes Berg40b96402011-09-29 16:04:38 +02002875 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
2876 struct ieee80211_sta *sta,
2877 u16 tids, int num_frames,
2878 enum ieee80211_frame_release_type reason,
2879 bool more_data);
Johannes Berg4049e092011-09-29 16:04:32 +02002880 void (*release_buffered_frames)(struct ieee80211_hw *hw,
2881 struct ieee80211_sta *sta,
2882 u16 tids, int num_frames,
2883 enum ieee80211_frame_release_type reason,
2884 bool more_data);
Ben Greeare3521142012-04-23 12:50:31 -07002885
2886 int (*get_et_sset_count)(struct ieee80211_hw *hw,
2887 struct ieee80211_vif *vif, int sset);
2888 void (*get_et_stats)(struct ieee80211_hw *hw,
2889 struct ieee80211_vif *vif,
2890 struct ethtool_stats *stats, u64 *data);
2891 void (*get_et_strings)(struct ieee80211_hw *hw,
2892 struct ieee80211_vif *vif,
2893 u32 sset, u8 *data);
Victor Goldenshtein66572cf2012-06-21 10:56:46 +03002894 int (*get_rssi)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2895 struct ieee80211_sta *sta, s8 *rssi_dbm);
Johannes Berga1845fc2012-06-27 13:18:36 +02002896
2897 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
2898 struct ieee80211_vif *vif);
Michal Kaziorc3645ea2012-06-26 14:37:17 +02002899
2900 int (*add_chanctx)(struct ieee80211_hw *hw,
2901 struct ieee80211_chanctx_conf *ctx);
2902 void (*remove_chanctx)(struct ieee80211_hw *hw,
2903 struct ieee80211_chanctx_conf *ctx);
2904 void (*change_chanctx)(struct ieee80211_hw *hw,
2905 struct ieee80211_chanctx_conf *ctx,
2906 u32 changed);
2907 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
2908 struct ieee80211_vif *vif,
2909 struct ieee80211_chanctx_conf *ctx);
2910 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
2911 struct ieee80211_vif *vif,
2912 struct ieee80211_chanctx_conf *ctx);
Johannes Berg9214ad72012-11-06 19:18:13 +01002913
2914 void (*restart_complete)(struct ieee80211_hw *hw);
Johannes Berga65240c2013-01-14 15:14:34 +01002915
2916#if IS_ENABLED(CONFIG_IPV6)
2917 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
2918 struct ieee80211_vif *vif,
2919 struct inet6_dev *idev);
2920#endif
Simon Wunderlich73da7d52013-07-11 16:09:06 +02002921 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
2922 struct ieee80211_vif *vif,
2923 struct cfg80211_chan_def *chandef);
Johannes Berg55fff502013-08-19 18:48:41 +02002924
2925 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2926 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07002927};
2928
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002929/**
2930 * ieee80211_alloc_hw - Allocate a new hardware device
2931 *
2932 * This must be called once for each hardware device. The returned pointer
2933 * must be used to refer to this device when calling other functions.
2934 * mac80211 allocates a private data area for the driver pointed to by
2935 * @priv in &struct ieee80211_hw, the size of this area is given as
2936 * @priv_data_len.
2937 *
2938 * @priv_data_len: length of private data
2939 * @ops: callbacks for this device
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01002940 *
2941 * Return: A pointer to the new hardware device, or %NULL on error.
Jiri Bencf0706e82007-05-05 11:45:53 -07002942 */
2943struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
2944 const struct ieee80211_ops *ops);
2945
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002946/**
2947 * ieee80211_register_hw - Register hardware device
2948 *
Johannes Bergdbbea672008-02-26 14:34:06 +01002949 * You must call this function before any other functions in
2950 * mac80211. Note that before a hardware can be registered, you
2951 * need to fill the contained wiphy's information.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002952 *
2953 * @hw: the device to register as returned by ieee80211_alloc_hw()
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01002954 *
2955 * Return: 0 on success. An error code otherwise.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002956 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002957int ieee80211_register_hw(struct ieee80211_hw *hw);
2958
Johannes Berge1e54062010-11-30 08:58:45 +01002959/**
2960 * struct ieee80211_tpt_blink - throughput blink description
2961 * @throughput: throughput in Kbit/sec
2962 * @blink_time: blink time in milliseconds
2963 * (full cycle, ie. one off + one on period)
2964 */
2965struct ieee80211_tpt_blink {
2966 int throughput;
2967 int blink_time;
2968};
2969
Johannes Berg67408c82010-11-30 08:59:23 +01002970/**
2971 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
2972 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
2973 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
2974 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
2975 * interface is connected in some way, including being an AP
2976 */
2977enum ieee80211_tpt_led_trigger_flags {
2978 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
2979 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
2980 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
2981};
2982
Jiri Bencf0706e82007-05-05 11:45:53 -07002983#ifdef CONFIG_MAC80211_LEDS
Joe Perches10dd9b72013-07-31 17:31:37 -07002984char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
2985char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
2986char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
2987char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
2988char *__ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
2989 unsigned int flags,
2990 const struct ieee80211_tpt_blink *blink_table,
2991 unsigned int blink_table_len);
Jiri Bencf0706e82007-05-05 11:45:53 -07002992#endif
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002993/**
2994 * ieee80211_get_tx_led_name - get name of TX LED
2995 *
2996 * mac80211 creates a transmit LED trigger for each wireless hardware
2997 * that can be used to drive LEDs if your driver registers a LED device.
2998 * This function returns the name (or %NULL if not configured for LEDs)
2999 * of the trigger so you can automatically link the LED device.
3000 *
3001 * @hw: the hardware to get the LED trigger name for
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003002 *
3003 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003004 */
Jiri Bencf0706e82007-05-05 11:45:53 -07003005static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
3006{
3007#ifdef CONFIG_MAC80211_LEDS
3008 return __ieee80211_get_tx_led_name(hw);
3009#else
3010 return NULL;
3011#endif
3012}
3013
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003014/**
3015 * ieee80211_get_rx_led_name - get name of RX LED
3016 *
3017 * mac80211 creates a receive LED trigger for each wireless hardware
3018 * that can be used to drive LEDs if your driver registers a LED device.
3019 * This function returns the name (or %NULL if not configured for LEDs)
3020 * of the trigger so you can automatically link the LED device.
3021 *
3022 * @hw: the hardware to get the LED trigger name for
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003023 *
3024 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003025 */
Jiri Bencf0706e82007-05-05 11:45:53 -07003026static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
3027{
3028#ifdef CONFIG_MAC80211_LEDS
3029 return __ieee80211_get_rx_led_name(hw);
3030#else
3031 return NULL;
3032#endif
3033}
3034
Ivo van Doorncdcb0062008-01-07 19:45:24 +01003035/**
3036 * ieee80211_get_assoc_led_name - get name of association LED
3037 *
3038 * mac80211 creates a association LED trigger for each wireless hardware
3039 * that can be used to drive LEDs if your driver registers a LED device.
3040 * This function returns the name (or %NULL if not configured for LEDs)
3041 * of the trigger so you can automatically link the LED device.
3042 *
3043 * @hw: the hardware to get the LED trigger name for
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003044 *
3045 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
Ivo van Doorncdcb0062008-01-07 19:45:24 +01003046 */
Michael Buesch47f0c502007-09-27 15:10:44 +02003047static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
3048{
3049#ifdef CONFIG_MAC80211_LEDS
3050 return __ieee80211_get_assoc_led_name(hw);
3051#else
3052 return NULL;
3053#endif
3054}
3055
Ivo van Doorncdcb0062008-01-07 19:45:24 +01003056/**
3057 * ieee80211_get_radio_led_name - get name of radio LED
3058 *
3059 * mac80211 creates a radio change LED trigger for each wireless hardware
3060 * that can be used to drive LEDs if your driver registers a LED device.
3061 * This function returns the name (or %NULL if not configured for LEDs)
3062 * of the trigger so you can automatically link the LED device.
3063 *
3064 * @hw: the hardware to get the LED trigger name for
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003065 *
3066 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
Ivo van Doorncdcb0062008-01-07 19:45:24 +01003067 */
3068static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
3069{
3070#ifdef CONFIG_MAC80211_LEDS
3071 return __ieee80211_get_radio_led_name(hw);
3072#else
3073 return NULL;
3074#endif
3075}
Michael Buesch47f0c502007-09-27 15:10:44 +02003076
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003077/**
Johannes Berge1e54062010-11-30 08:58:45 +01003078 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
3079 * @hw: the hardware to create the trigger for
Johannes Berg67408c82010-11-30 08:59:23 +01003080 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
Johannes Berge1e54062010-11-30 08:58:45 +01003081 * @blink_table: the blink table -- needs to be ordered by throughput
3082 * @blink_table_len: size of the blink table
3083 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003084 * Return: %NULL (in case of error, or if no LED triggers are
3085 * configured) or the name of the new trigger.
3086 *
3087 * Note: This function must be called before ieee80211_register_hw().
Johannes Berge1e54062010-11-30 08:58:45 +01003088 */
3089static inline char *
Johannes Berg67408c82010-11-30 08:59:23 +01003090ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
Johannes Berge1e54062010-11-30 08:58:45 +01003091 const struct ieee80211_tpt_blink *blink_table,
3092 unsigned int blink_table_len)
3093{
3094#ifdef CONFIG_MAC80211_LEDS
Johannes Berg67408c82010-11-30 08:59:23 +01003095 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
Johannes Berge1e54062010-11-30 08:58:45 +01003096 blink_table_len);
3097#else
3098 return NULL;
3099#endif
3100}
3101
3102/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003103 * ieee80211_unregister_hw - Unregister a hardware device
3104 *
3105 * This function instructs mac80211 to free allocated resources
3106 * and unregister netdevices from the networking subsystem.
3107 *
3108 * @hw: the hardware to unregister
3109 */
Jiri Bencf0706e82007-05-05 11:45:53 -07003110void ieee80211_unregister_hw(struct ieee80211_hw *hw);
3111
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003112/**
3113 * ieee80211_free_hw - free hardware descriptor
3114 *
3115 * This function frees everything that was allocated, including the
3116 * private data for the driver. You must call ieee80211_unregister_hw()
Randy Dunlap6ef307b2008-07-03 13:52:18 -07003117 * before calling this function.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003118 *
3119 * @hw: the hardware to free
3120 */
Jiri Bencf0706e82007-05-05 11:45:53 -07003121void ieee80211_free_hw(struct ieee80211_hw *hw);
3122
Johannes Bergf2753dd2009-04-14 10:09:24 +02003123/**
3124 * ieee80211_restart_hw - restart hardware completely
3125 *
3126 * Call this function when the hardware was restarted for some reason
3127 * (hardware error, ...) and the driver is unable to restore its state
3128 * by itself. mac80211 assumes that at this point the driver/hardware
3129 * is completely uninitialised and stopped, it starts the process by
3130 * calling the ->start() operation. The driver will need to reset all
3131 * internal state that it has prior to calling this function.
3132 *
3133 * @hw: the hardware to restart
3134 */
3135void ieee80211_restart_hw(struct ieee80211_hw *hw);
3136
John W. Linville4e6cbfd2010-07-29 16:14:13 -04003137/** ieee80211_napi_schedule - schedule NAPI poll
3138 *
3139 * Use this function to schedule NAPI polling on a device.
3140 *
3141 * @hw: the hardware to start polling
3142 */
3143void ieee80211_napi_schedule(struct ieee80211_hw *hw);
3144
3145/** ieee80211_napi_complete - complete NAPI polling
3146 *
3147 * Use this function to finish NAPI polling on a device.
3148 *
3149 * @hw: the hardware to stop polling
3150 */
3151void ieee80211_napi_complete(struct ieee80211_hw *hw);
3152
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003153/**
3154 * ieee80211_rx - receive frame
3155 *
3156 * Use this function to hand received frames to mac80211. The receive
Zhu Yie3cf8b32010-03-29 17:35:07 +08003157 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3158 * paged @skb is used, the driver is recommended to put the ieee80211
3159 * header of the frame on the linear part of the @skb to avoid memory
3160 * allocation and/or memcpy by the stack.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003161 *
Johannes Berg2485f712008-02-25 16:27:41 +01003162 * This function may not be called in IRQ context. Calls to this function
Kalle Valoe36e49f2009-10-13 20:33:13 +03003163 * for a single hardware must be synchronized against each other. Calls to
3164 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
Felix Fietkauf6b3d852013-05-03 10:01:03 +02003165 * mixed for a single hardware. Must not run concurrently with
3166 * ieee80211_tx_status() or ieee80211_tx_status_ni().
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003167 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03003168 * In process context use instead ieee80211_rx_ni().
Johannes Bergd20ef632009-10-11 15:10:40 +02003169 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003170 * @hw: the hardware this frame came in on
3171 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003172 */
John W. Linville103bf9f2009-08-20 16:34:15 -04003173void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003174
3175/**
3176 * ieee80211_rx_irqsafe - receive frame
3177 *
3178 * Like ieee80211_rx() but can be called in IRQ context
Johannes Berg2485f712008-02-25 16:27:41 +01003179 * (internally defers to a tasklet.)
3180 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03003181 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
Felix Fietkauf6b3d852013-05-03 10:01:03 +02003182 * be mixed for a single hardware.Must not run concurrently with
3183 * ieee80211_tx_status() or ieee80211_tx_status_ni().
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003184 *
3185 * @hw: the hardware this frame came in on
3186 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003187 */
Johannes Bergf1d58c22009-06-17 13:13:00 +02003188void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07003189
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003190/**
Kalle Valoe36e49f2009-10-13 20:33:13 +03003191 * ieee80211_rx_ni - receive frame (in process context)
3192 *
3193 * Like ieee80211_rx() but can be called in process context
3194 * (internally disables bottom halves).
3195 *
3196 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
Felix Fietkauf6b3d852013-05-03 10:01:03 +02003197 * not be mixed for a single hardware. Must not run concurrently with
3198 * ieee80211_tx_status() or ieee80211_tx_status_ni().
Kalle Valoe36e49f2009-10-13 20:33:13 +03003199 *
3200 * @hw: the hardware this frame came in on
3201 * @skb: the buffer to receive, owned by mac80211 after this call
3202 */
3203static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
3204 struct sk_buff *skb)
3205{
3206 local_bh_disable();
3207 ieee80211_rx(hw, skb);
3208 local_bh_enable();
3209}
3210
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02003211/**
3212 * ieee80211_sta_ps_transition - PS transition for connected sta
3213 *
3214 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
3215 * flag set, use this function to inform mac80211 about a connected station
3216 * entering/leaving PS mode.
3217 *
3218 * This function may not be called in IRQ context or with softirqs enabled.
3219 *
3220 * Calls to this function for a single hardware must be synchronized against
3221 * each other.
3222 *
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02003223 * @sta: currently connected sta
3224 * @start: start or stop PS
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003225 *
3226 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02003227 */
3228int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
3229
3230/**
3231 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
3232 * (in process context)
3233 *
3234 * Like ieee80211_sta_ps_transition() but can be called in process context
3235 * (internally disables bottom halves). Concurrent call restriction still
3236 * applies.
3237 *
3238 * @sta: currently connected sta
3239 * @start: start or stop PS
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003240 *
3241 * Return: Like ieee80211_sta_ps_transition().
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02003242 */
3243static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
3244 bool start)
3245{
3246 int ret;
3247
3248 local_bh_disable();
3249 ret = ieee80211_sta_ps_transition(sta, start);
3250 local_bh_enable();
3251
3252 return ret;
3253}
3254
Gertjan van Wingerded24deb22009-12-04 23:46:54 +01003255/*
3256 * The TX headroom reserved by mac80211 for its own tx_status functions.
3257 * This is enough for the radiotap header.
3258 */
Helmut Schaa7f2a5e22011-10-11 18:08:55 +02003259#define IEEE80211_TX_STATUS_HEADROOM 14
Gertjan van Wingerded24deb22009-12-04 23:46:54 +01003260
Kalle Valoe36e49f2009-10-13 20:33:13 +03003261/**
Johannes Berg042ec452011-09-29 16:04:26 +02003262 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
Randy Dunlapbdfbe802011-05-22 17:22:45 -07003263 * @sta: &struct ieee80211_sta pointer for the sleeping station
Johannes Berg042ec452011-09-29 16:04:26 +02003264 * @tid: the TID that has buffered frames
3265 * @buffered: indicates whether or not frames are buffered for this TID
Felix Fietkaudcf55fb2011-04-17 17:45:00 +02003266 *
3267 * If a driver buffers frames for a powersave station instead of passing
Johannes Berg042ec452011-09-29 16:04:26 +02003268 * them back to mac80211 for retransmission, the station may still need
3269 * to be told that there are buffered frames via the TIM bit.
Felix Fietkaudcf55fb2011-04-17 17:45:00 +02003270 *
Johannes Berg042ec452011-09-29 16:04:26 +02003271 * This function informs mac80211 whether or not there are frames that are
3272 * buffered in the driver for a given TID; mac80211 can then use this data
3273 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
3274 * call! Beware of the locking!)
3275 *
3276 * If all frames are released to the station (due to PS-poll or uAPSD)
3277 * then the driver needs to inform mac80211 that there no longer are
3278 * frames buffered. However, when the station wakes up mac80211 assumes
3279 * that all buffered frames will be transmitted and clears this data,
3280 * drivers need to make sure they inform mac80211 about all buffered
3281 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
3282 *
3283 * Note that technically mac80211 only needs to know this per AC, not per
3284 * TID, but since driver buffering will inevitably happen per TID (since
3285 * it is related to aggregation) it is easier to make mac80211 map the
3286 * TID to the AC as required instead of keeping track in all drivers that
3287 * use this API.
Felix Fietkaudcf55fb2011-04-17 17:45:00 +02003288 */
Johannes Berg042ec452011-09-29 16:04:26 +02003289void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
3290 u8 tid, bool buffered);
Felix Fietkaudcf55fb2011-04-17 17:45:00 +02003291
3292/**
Felix Fietkau0d528d82013-04-22 16:14:41 +02003293 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
3294 *
3295 * Call this function in a driver with per-packet rate selection support
3296 * to combine the rate info in the packet tx info with the most recent
3297 * rate selection table for the station entry.
3298 *
3299 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3300 * @sta: the receiver station to which this packet is sent.
3301 * @skb: the frame to be transmitted.
3302 * @dest: buffer for extracted rate/retry information
3303 * @max_rates: maximum number of rates to fetch
3304 */
3305void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
3306 struct ieee80211_sta *sta,
3307 struct sk_buff *skb,
3308 struct ieee80211_tx_rate *dest,
3309 int max_rates);
3310
3311/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003312 * ieee80211_tx_status - transmit status callback
3313 *
3314 * Call this function for all transmitted frames after they have been
3315 * transmitted. It is permissible to not call this function for
3316 * multicast frames but this can affect statistics.
3317 *
Johannes Berg2485f712008-02-25 16:27:41 +01003318 * This function may not be called in IRQ context. Calls to this function
3319 * for a single hardware must be synchronized against each other. Calls
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01003320 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
Felix Fietkauf6b3d852013-05-03 10:01:03 +02003321 * may not be mixed for a single hardware. Must not run concurrently with
3322 * ieee80211_rx() or ieee80211_rx_ni().
Johannes Berg2485f712008-02-25 16:27:41 +01003323 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003324 * @hw: the hardware the frame was transmitted by
3325 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003326 */
Jiri Bencf0706e82007-05-05 11:45:53 -07003327void ieee80211_tx_status(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02003328 struct sk_buff *skb);
Johannes Berg2485f712008-02-25 16:27:41 +01003329
3330/**
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01003331 * ieee80211_tx_status_ni - transmit status callback (in process context)
3332 *
3333 * Like ieee80211_tx_status() but can be called in process context.
3334 *
3335 * Calls to this function, ieee80211_tx_status() and
3336 * ieee80211_tx_status_irqsafe() may not be mixed
3337 * for a single hardware.
3338 *
3339 * @hw: the hardware the frame was transmitted by
3340 * @skb: the frame that was transmitted, owned by mac80211 after this call
3341 */
3342static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
3343 struct sk_buff *skb)
3344{
3345 local_bh_disable();
3346 ieee80211_tx_status(hw, skb);
3347 local_bh_enable();
3348}
3349
3350/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07003351 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
Johannes Berg2485f712008-02-25 16:27:41 +01003352 *
3353 * Like ieee80211_tx_status() but can be called in IRQ context
3354 * (internally defers to a tasklet.)
3355 *
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01003356 * Calls to this function, ieee80211_tx_status() and
3357 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
Johannes Berg2485f712008-02-25 16:27:41 +01003358 *
3359 * @hw: the hardware the frame was transmitted by
3360 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg2485f712008-02-25 16:27:41 +01003361 */
Jiri Bencf0706e82007-05-05 11:45:53 -07003362void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02003363 struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07003364
3365/**
Arik Nemtsov8178d382011-04-18 14:22:28 +03003366 * ieee80211_report_low_ack - report non-responding station
3367 *
3368 * When operating in AP-mode, call this function to report a non-responding
3369 * connected STA.
3370 *
3371 * @sta: the non-responding connected sta
3372 * @num_packets: number of packets sent to @sta without a response
3373 */
3374void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
3375
3376/**
Johannes Bergeddcbb92009-10-29 08:30:35 +01003377 * ieee80211_beacon_get_tim - beacon generation function
3378 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01003379 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Bergeddcbb92009-10-29 08:30:35 +01003380 * @tim_offset: pointer to variable that will receive the TIM IE offset.
3381 * Set to 0 if invalid (in non-AP modes).
3382 * @tim_length: pointer to variable that will receive the TIM IE length,
3383 * (including the ID and length bytes!).
3384 * Set to 0 if invalid (in non-AP modes).
3385 *
3386 * If the driver implements beaconing modes, it must use this function to
3387 * obtain the beacon frame/template.
3388 *
3389 * If the beacon frames are generated by the host system (i.e., not in
3390 * hardware/firmware), the driver uses this function to get each beacon
3391 * frame from mac80211 -- it is responsible for calling this function
3392 * before the beacon is needed (e.g. based on hardware interrupt).
3393 *
3394 * If the beacon frames are generated by the device, then the driver
3395 * must use the returned beacon as the template and change the TIM IE
3396 * according to the current DTIM parameters/TIM bitmap.
3397 *
3398 * The driver is responsible for freeing the returned skb.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003399 *
3400 * Return: The beacon template. %NULL on error.
Johannes Bergeddcbb92009-10-29 08:30:35 +01003401 */
3402struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
3403 struct ieee80211_vif *vif,
3404 u16 *tim_offset, u16 *tim_length);
3405
3406/**
Jiri Bencf0706e82007-05-05 11:45:53 -07003407 * ieee80211_beacon_get - beacon generation function
3408 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01003409 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07003410 *
Johannes Bergeddcbb92009-10-29 08:30:35 +01003411 * See ieee80211_beacon_get_tim().
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003412 *
3413 * Return: See ieee80211_beacon_get_tim().
Jiri Bencf0706e82007-05-05 11:45:53 -07003414 */
Johannes Bergeddcbb92009-10-29 08:30:35 +01003415static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
3416 struct ieee80211_vif *vif)
3417{
3418 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
3419}
Jiri Bencf0706e82007-05-05 11:45:53 -07003420
3421/**
Simon Wunderlich73da7d52013-07-11 16:09:06 +02003422 * ieee80211_csa_finish - notify mac80211 about channel switch
3423 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3424 *
3425 * After a channel switch announcement was scheduled and the counter in this
3426 * announcement hit zero, this function must be called by the driver to
3427 * notify mac80211 that the channel can be changed.
3428 */
3429void ieee80211_csa_finish(struct ieee80211_vif *vif);
3430
3431/**
3432 * ieee80211_csa_is_complete - find out if counters reached zero
3433 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3434 *
3435 * This function returns whether the channel switch counters reached zero.
3436 */
3437bool ieee80211_csa_is_complete(struct ieee80211_vif *vif);
3438
3439
3440/**
Arik Nemtsov02945822011-11-10 11:28:57 +02003441 * ieee80211_proberesp_get - retrieve a Probe Response template
3442 * @hw: pointer obtained from ieee80211_alloc_hw().
3443 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3444 *
3445 * Creates a Probe Response template which can, for example, be uploaded to
3446 * hardware. The destination address should be set by the caller.
3447 *
3448 * Can only be called in AP mode.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003449 *
3450 * Return: The Probe Response template. %NULL on error.
Arik Nemtsov02945822011-11-10 11:28:57 +02003451 */
3452struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
3453 struct ieee80211_vif *vif);
3454
3455/**
Kalle Valo7044cc52010-01-05 20:16:19 +02003456 * ieee80211_pspoll_get - retrieve a PS Poll template
3457 * @hw: pointer obtained from ieee80211_alloc_hw().
3458 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3459 *
3460 * Creates a PS Poll a template which can, for example, uploaded to
3461 * hardware. The template must be updated after association so that correct
3462 * AID, BSSID and MAC address is used.
3463 *
3464 * Note: Caller (or hardware) is responsible for setting the
3465 * &IEEE80211_FCTL_PM bit.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003466 *
3467 * Return: The PS Poll template. %NULL on error.
Kalle Valo7044cc52010-01-05 20:16:19 +02003468 */
3469struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
3470 struct ieee80211_vif *vif);
3471
3472/**
3473 * ieee80211_nullfunc_get - retrieve a nullfunc template
3474 * @hw: pointer obtained from ieee80211_alloc_hw().
3475 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3476 *
3477 * Creates a Nullfunc template which can, for example, uploaded to
3478 * hardware. The template must be updated after association so that correct
3479 * BSSID and address is used.
3480 *
3481 * Note: Caller (or hardware) is responsible for setting the
3482 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003483 *
3484 * Return: The nullfunc template. %NULL on error.
Kalle Valo7044cc52010-01-05 20:16:19 +02003485 */
3486struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
3487 struct ieee80211_vif *vif);
3488
3489/**
Kalle Valo05e54ea2010-01-05 20:16:38 +02003490 * ieee80211_probereq_get - retrieve a Probe Request template
3491 * @hw: pointer obtained from ieee80211_alloc_hw().
3492 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3493 * @ssid: SSID buffer
3494 * @ssid_len: length of SSID
Johannes Bergb9a9ada2012-11-29 13:00:10 +01003495 * @tailroom: tailroom to reserve at end of SKB for IEs
Kalle Valo05e54ea2010-01-05 20:16:38 +02003496 *
3497 * Creates a Probe Request template which can, for example, be uploaded to
3498 * hardware.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003499 *
3500 * Return: The Probe Request template. %NULL on error.
Kalle Valo05e54ea2010-01-05 20:16:38 +02003501 */
3502struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
3503 struct ieee80211_vif *vif,
3504 const u8 *ssid, size_t ssid_len,
Johannes Bergb9a9ada2012-11-29 13:00:10 +01003505 size_t tailroom);
Kalle Valo05e54ea2010-01-05 20:16:38 +02003506
3507/**
Jiri Bencf0706e82007-05-05 11:45:53 -07003508 * ieee80211_rts_get - RTS frame generation function
3509 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01003510 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07003511 * @frame: pointer to the frame that is going to be protected by the RTS.
3512 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02003513 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07003514 * @rts: The buffer where to store the RTS frame.
3515 *
3516 * If the RTS frames are generated by the host system (i.e., not in
3517 * hardware/firmware), the low-level driver uses this function to receive
3518 * the next RTS frame from the 802.11 code. The low-level is responsible
3519 * for calling this function before and RTS frame is needed.
3520 */
Johannes Berg32bfd352007-12-19 01:31:26 +01003521void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07003522 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02003523 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07003524 struct ieee80211_rts *rts);
3525
3526/**
3527 * ieee80211_rts_duration - Get the duration field for an RTS frame
3528 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01003529 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07003530 * @frame_len: the length of the frame that is going to be protected by the RTS.
Johannes Berge039fa42008-05-15 12:55:29 +02003531 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07003532 *
3533 * If the RTS is generated in firmware, but the host system must provide
3534 * the duration field, the low-level driver uses this function to receive
3535 * the duration field value in little-endian byteorder.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003536 *
3537 * Return: The duration.
Jiri Bencf0706e82007-05-05 11:45:53 -07003538 */
Johannes Berg32bfd352007-12-19 01:31:26 +01003539__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
3540 struct ieee80211_vif *vif, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02003541 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07003542
3543/**
3544 * ieee80211_ctstoself_get - CTS-to-self frame generation function
3545 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01003546 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07003547 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
3548 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02003549 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07003550 * @cts: The buffer where to store the CTS-to-self frame.
3551 *
3552 * If the CTS-to-self frames are generated by the host system (i.e., not in
3553 * hardware/firmware), the low-level driver uses this function to receive
3554 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
3555 * for calling this function before and CTS-to-self frame is needed.
3556 */
Johannes Berg32bfd352007-12-19 01:31:26 +01003557void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
3558 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07003559 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02003560 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07003561 struct ieee80211_cts *cts);
3562
3563/**
3564 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
3565 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01003566 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07003567 * @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 +02003568 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07003569 *
3570 * If the CTS-to-self is generated in firmware, but the host system must provide
3571 * the duration field, the low-level driver uses this function to receive
3572 * the duration field value in little-endian byteorder.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003573 *
3574 * Return: The duration.
Jiri Bencf0706e82007-05-05 11:45:53 -07003575 */
Johannes Berg32bfd352007-12-19 01:31:26 +01003576__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
3577 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07003578 size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02003579 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07003580
3581/**
3582 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
3583 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01003584 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Bergd13e1412012-06-09 10:31:09 +02003585 * @band: the band to calculate the frame duration on
Jiri Bencf0706e82007-05-05 11:45:53 -07003586 * @frame_len: the length of the frame.
Johannes Berg8318d782008-01-24 19:38:38 +01003587 * @rate: the rate at which the frame is going to be transmitted.
Jiri Bencf0706e82007-05-05 11:45:53 -07003588 *
3589 * Calculate the duration field of some generic frame, given its
3590 * length and transmission rate (in 100kbps).
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003591 *
3592 * Return: The duration.
Jiri Bencf0706e82007-05-05 11:45:53 -07003593 */
Johannes Berg32bfd352007-12-19 01:31:26 +01003594__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
3595 struct ieee80211_vif *vif,
Michal Kazior4ee73f32012-04-11 08:47:56 +02003596 enum ieee80211_band band,
Jiri Bencf0706e82007-05-05 11:45:53 -07003597 size_t frame_len,
Johannes Berg8318d782008-01-24 19:38:38 +01003598 struct ieee80211_rate *rate);
Jiri Bencf0706e82007-05-05 11:45:53 -07003599
3600/**
3601 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
3602 * @hw: pointer as obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01003603 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07003604 *
3605 * Function for accessing buffered broadcast and multicast frames. If
3606 * hardware/firmware does not implement buffering of broadcast/multicast
3607 * frames when power saving is used, 802.11 code buffers them in the host
3608 * memory. The low-level driver uses this function to fetch next buffered
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003609 * frame. In most cases, this is used when generating beacon frame.
3610 *
3611 * Return: A pointer to the next buffered skb or NULL if no more buffered
3612 * frames are available.
Jiri Bencf0706e82007-05-05 11:45:53 -07003613 *
3614 * Note: buffered frames are returned only after DTIM beacon frame was
3615 * generated with ieee80211_beacon_get() and the low-level driver must thus
3616 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
3617 * NULL if the previous generated beacon was not DTIM, so the low-level driver
3618 * does not need to check for DTIM beacons separately and should be able to
3619 * use common code for all beacons.
3620 */
3621struct sk_buff *
Johannes Berge039fa42008-05-15 12:55:29 +02003622ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07003623
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003624/**
Johannes Berg42d98792011-07-07 18:58:01 +02003625 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
3626 *
3627 * This function returns the TKIP phase 1 key for the given IV32.
3628 *
3629 * @keyconf: the parameter passed with the set key
3630 * @iv32: IV32 to get the P1K for
3631 * @p1k: a buffer to which the key will be written, as 5 u16 values
3632 */
3633void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
3634 u32 iv32, u16 *p1k);
3635
3636/**
Johannes Berg523b02e2011-07-07 22:28:01 +02003637 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02003638 *
Johannes Berg523b02e2011-07-07 22:28:01 +02003639 * This function returns the TKIP phase 1 key for the IV32 taken
3640 * from the given packet.
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02003641 *
3642 * @keyconf: the parameter passed with the set key
Johannes Berg523b02e2011-07-07 22:28:01 +02003643 * @skb: the packet to take the IV32 value from that will be encrypted
3644 * with this P1K
3645 * @p1k: a buffer to which the key will be written, as 5 u16 values
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02003646 */
Johannes Berg42d98792011-07-07 18:58:01 +02003647static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
3648 struct sk_buff *skb, u16 *p1k)
3649{
3650 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
3651 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
3652 u32 iv32 = get_unaligned_le32(&data[4]);
3653
3654 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
3655}
Johannes Berg523b02e2011-07-07 22:28:01 +02003656
3657/**
Johannes Berg8bca5d82011-07-13 19:50:34 +02003658 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
3659 *
3660 * This function returns the TKIP phase 1 key for the given IV32
3661 * and transmitter address.
3662 *
3663 * @keyconf: the parameter passed with the set key
3664 * @ta: TA that will be used with the key
3665 * @iv32: IV32 to get the P1K for
3666 * @p1k: a buffer to which the key will be written, as 5 u16 values
3667 */
3668void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
3669 const u8 *ta, u32 iv32, u16 *p1k);
3670
3671/**
Johannes Berg523b02e2011-07-07 22:28:01 +02003672 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
3673 *
3674 * This function computes the TKIP RC4 key for the IV values
3675 * in the packet.
3676 *
3677 * @keyconf: the parameter passed with the set key
3678 * @skb: the packet to take the IV32/IV16 values from that will be
3679 * encrypted with this key
3680 * @p2k: a buffer to which the key will be written, 16 bytes
3681 */
3682void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
3683 struct sk_buff *skb, u8 *p2k);
Johannes Bergc68f4b82011-07-05 16:35:41 +02003684
3685/**
Assaf Krauss5d0d04e2012-08-01 15:12:48 +03003686 * ieee80211_aes_cmac_calculate_k1_k2 - calculate the AES-CMAC sub keys
3687 *
3688 * This function computes the two AES-CMAC sub-keys, based on the
3689 * previously installed master key.
3690 *
3691 * @keyconf: the parameter passed with the set key
3692 * @k1: a buffer to be filled with the 1st sub-key
3693 * @k2: a buffer to be filled with the 2nd sub-key
3694 */
3695void ieee80211_aes_cmac_calculate_k1_k2(struct ieee80211_key_conf *keyconf,
3696 u8 *k1, u8 *k2);
3697
3698/**
Johannes Berg3ea542d2011-07-07 18:58:00 +02003699 * struct ieee80211_key_seq - key sequence counter
3700 *
3701 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
3702 * @ccmp: PN data, most significant byte first (big endian,
3703 * reverse order than in packet)
3704 * @aes_cmac: PN data, most significant byte first (big endian,
3705 * reverse order than in packet)
3706 */
3707struct ieee80211_key_seq {
3708 union {
3709 struct {
3710 u32 iv32;
3711 u16 iv16;
3712 } tkip;
3713 struct {
3714 u8 pn[6];
3715 } ccmp;
3716 struct {
3717 u8 pn[6];
3718 } aes_cmac;
3719 };
3720};
3721
3722/**
3723 * ieee80211_get_key_tx_seq - get key TX sequence counter
3724 *
3725 * @keyconf: the parameter passed with the set key
3726 * @seq: buffer to receive the sequence data
3727 *
3728 * This function allows a driver to retrieve the current TX IV/PN
3729 * for the given key. It must not be called if IV generation is
3730 * offloaded to the device.
3731 *
3732 * Note that this function may only be called when no TX processing
3733 * can be done concurrently, for example when queues are stopped
3734 * and the stop has been synchronized.
3735 */
3736void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
3737 struct ieee80211_key_seq *seq);
3738
3739/**
3740 * ieee80211_get_key_rx_seq - get key RX sequence counter
3741 *
3742 * @keyconf: the parameter passed with the set key
3743 * @tid: The TID, or -1 for the management frame value (CCMP only);
3744 * the value on TID 0 is also used for non-QoS frames. For
3745 * CMAC, only TID 0 is valid.
3746 * @seq: buffer to receive the sequence data
3747 *
3748 * This function allows a driver to retrieve the current RX IV/PNs
3749 * for the given key. It must not be called if IV checking is done
3750 * by the device and not by mac80211.
3751 *
3752 * Note that this function may only be called when no RX processing
3753 * can be done concurrently.
3754 */
3755void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
3756 int tid, struct ieee80211_key_seq *seq);
3757
3758/**
Johannes Berg27b3eb92013-08-07 20:11:55 +02003759 * ieee80211_set_key_tx_seq - set key TX sequence counter
3760 *
3761 * @keyconf: the parameter passed with the set key
3762 * @seq: new sequence data
3763 *
3764 * This function allows a driver to set the current TX IV/PNs for the
3765 * given key. This is useful when resuming from WoWLAN sleep and the
3766 * device may have transmitted frames using the PTK, e.g. replies to
3767 * ARP requests.
3768 *
3769 * Note that this function may only be called when no TX processing
3770 * can be done concurrently.
3771 */
3772void ieee80211_set_key_tx_seq(struct ieee80211_key_conf *keyconf,
3773 struct ieee80211_key_seq *seq);
3774
3775/**
3776 * ieee80211_set_key_rx_seq - set key RX sequence counter
3777 *
3778 * @keyconf: the parameter passed with the set key
3779 * @tid: The TID, or -1 for the management frame value (CCMP only);
3780 * the value on TID 0 is also used for non-QoS frames. For
3781 * CMAC, only TID 0 is valid.
3782 * @seq: new sequence data
3783 *
3784 * This function allows a driver to set the current RX IV/PNs for the
3785 * given key. This is useful when resuming from WoWLAN sleep and GTK
3786 * rekey may have been done while suspended. It should not be called
3787 * if IV checking is done by the device and not by mac80211.
3788 *
3789 * Note that this function may only be called when no RX processing
3790 * can be done concurrently.
3791 */
3792void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
3793 int tid, struct ieee80211_key_seq *seq);
3794
3795/**
3796 * ieee80211_remove_key - remove the given key
3797 * @keyconf: the parameter passed with the set key
3798 *
3799 * Remove the given key. If the key was uploaded to the hardware at the
3800 * time this function is called, it is not deleted in the hardware but
3801 * instead assumed to have been removed already.
3802 *
3803 * Note that due to locking considerations this function can (currently)
3804 * only be called during key iteration (ieee80211_iter_keys().)
3805 */
3806void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
3807
3808/**
3809 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
3810 * @vif: the virtual interface to add the key on
3811 * @keyconf: new key data
3812 *
3813 * When GTK rekeying was done while the system was suspended, (a) new
3814 * key(s) will be available. These will be needed by mac80211 for proper
3815 * RX processing, so this function allows setting them.
3816 *
3817 * The function returns the newly allocated key structure, which will
3818 * have similar contents to the passed key configuration but point to
3819 * mac80211-owned memory. In case of errors, the function returns an
3820 * ERR_PTR(), use IS_ERR() etc.
3821 *
3822 * Note that this function assumes the key isn't added to hardware
3823 * acceleration, so no TX will be done with the key. Since it's a GTK
3824 * on managed (station) networks, this is true anyway. If the driver
3825 * calls this function from the resume callback and subsequently uses
3826 * the return code 1 to reconfigure the device, this key will be part
3827 * of the reconfiguration.
3828 *
3829 * Note that the driver should also call ieee80211_set_key_rx_seq()
3830 * for the new key for each TID to set up sequence counters properly.
3831 *
3832 * IMPORTANT: If this replaces a key that is present in the hardware,
3833 * then it will attempt to remove it during this call. In many cases
3834 * this isn't what you want, so call ieee80211_remove_key() first for
3835 * the key that's being replaced.
3836 */
3837struct ieee80211_key_conf *
3838ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
3839 struct ieee80211_key_conf *keyconf);
3840
3841/**
Johannes Bergc68f4b82011-07-05 16:35:41 +02003842 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
3843 * @vif: virtual interface the rekeying was done on
3844 * @bssid: The BSSID of the AP, for checking association
3845 * @replay_ctr: the new replay counter after GTK rekeying
3846 * @gfp: allocation flags
3847 */
3848void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
3849 const u8 *replay_ctr, gfp_t gfp);
3850
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02003851/**
Jiri Bencf0706e82007-05-05 11:45:53 -07003852 * ieee80211_wake_queue - wake specific queue
3853 * @hw: pointer as obtained from ieee80211_alloc_hw().
3854 * @queue: queue number (counted from zero).
3855 *
3856 * Drivers should use this function instead of netif_wake_queue.
3857 */
3858void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
3859
3860/**
3861 * ieee80211_stop_queue - stop specific queue
3862 * @hw: pointer as obtained from ieee80211_alloc_hw().
3863 * @queue: queue number (counted from zero).
3864 *
3865 * Drivers should use this function instead of netif_stop_queue.
3866 */
3867void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
3868
3869/**
Tomas Winkler92ab8532008-07-24 21:02:04 +03003870 * ieee80211_queue_stopped - test status of the queue
3871 * @hw: pointer as obtained from ieee80211_alloc_hw().
3872 * @queue: queue number (counted from zero).
3873 *
3874 * Drivers should use this function instead of netif_stop_queue.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003875 *
3876 * Return: %true if the queue is stopped. %false otherwise.
Tomas Winkler92ab8532008-07-24 21:02:04 +03003877 */
3878
3879int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
3880
3881/**
Jiri Bencf0706e82007-05-05 11:45:53 -07003882 * ieee80211_stop_queues - stop all queues
3883 * @hw: pointer as obtained from ieee80211_alloc_hw().
3884 *
3885 * Drivers should use this function instead of netif_stop_queue.
3886 */
3887void ieee80211_stop_queues(struct ieee80211_hw *hw);
3888
3889/**
3890 * ieee80211_wake_queues - wake all queues
3891 * @hw: pointer as obtained from ieee80211_alloc_hw().
3892 *
3893 * Drivers should use this function instead of netif_wake_queue.
3894 */
3895void ieee80211_wake_queues(struct ieee80211_hw *hw);
3896
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003897/**
3898 * ieee80211_scan_completed - completed hardware scan
3899 *
3900 * When hardware scan offload is used (i.e. the hw_scan() callback is
3901 * assigned) this function needs to be called by the driver to notify
Johannes Berg8789d452010-08-26 13:30:26 +02003902 * mac80211 that the scan finished. This function can be called from
3903 * any context, including hardirq context.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003904 *
3905 * @hw: the hardware that finished the scan
Johannes Berg2a519312009-02-10 21:25:55 +01003906 * @aborted: set to true if scan was aborted
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003907 */
Johannes Berg2a519312009-02-10 21:25:55 +01003908void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
Jiri Bencf0706e82007-05-05 11:45:53 -07003909
Johannes Bergdabeb342007-11-09 01:57:29 +01003910/**
Luciano Coelho79f460c2011-05-11 17:09:36 +03003911 * ieee80211_sched_scan_results - got results from scheduled scan
3912 *
3913 * When a scheduled scan is running, this function needs to be called by the
3914 * driver whenever there are new scan results available.
3915 *
3916 * @hw: the hardware that is performing scheduled scans
3917 */
3918void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
3919
3920/**
3921 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
3922 *
3923 * When a scheduled scan is running, this function can be called by
3924 * the driver if it needs to stop the scan to perform another task.
3925 * Usual scenarios are drivers that cannot continue the scheduled scan
3926 * while associating, for instance.
3927 *
3928 * @hw: the hardware that is performing scheduled scans
3929 */
3930void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
3931
3932/**
Johannes Berg8b2c9822012-11-06 20:23:30 +01003933 * enum ieee80211_interface_iteration_flags - interface iteration flags
3934 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
3935 * been added to the driver; However, note that during hardware
3936 * reconfiguration (after restart_hw) it will iterate over a new
3937 * interface and over all the existing interfaces even if they
3938 * haven't been re-added to the driver yet.
3939 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
3940 * interfaces, even if they haven't been re-added to the driver yet.
3941 */
3942enum ieee80211_interface_iteration_flags {
3943 IEEE80211_IFACE_ITER_NORMAL = 0,
3944 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
3945};
3946
3947/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07003948 * ieee80211_iterate_active_interfaces - iterate active interfaces
Johannes Bergdabeb342007-11-09 01:57:29 +01003949 *
3950 * This function iterates over the interfaces associated with a given
3951 * hardware that are currently active and calls the callback for them.
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02003952 * This function allows the iterator function to sleep, when the iterator
3953 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
3954 * be used.
Johannes Berg8b2c9822012-11-06 20:23:30 +01003955 * Does not iterate over a new interface during add_interface().
Johannes Bergdabeb342007-11-09 01:57:29 +01003956 *
3957 * @hw: the hardware struct of which the interfaces should be iterated over
Johannes Berg8b2c9822012-11-06 20:23:30 +01003958 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02003959 * @iterator: the iterator function to call
Johannes Bergdabeb342007-11-09 01:57:29 +01003960 * @data: first argument of the iterator function
3961 */
3962void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
Johannes Berg8b2c9822012-11-06 20:23:30 +01003963 u32 iter_flags,
Johannes Bergdabeb342007-11-09 01:57:29 +01003964 void (*iterator)(void *data, u8 *mac,
Johannes Berg32bfd352007-12-19 01:31:26 +01003965 struct ieee80211_vif *vif),
Johannes Bergdabeb342007-11-09 01:57:29 +01003966 void *data);
3967
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003968/**
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02003969 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
3970 *
3971 * This function iterates over the interfaces associated with a given
3972 * hardware that are currently active and calls the callback for them.
3973 * This function requires the iterator callback function to be atomic,
3974 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
Johannes Berg8b2c9822012-11-06 20:23:30 +01003975 * Does not iterate over a new interface during add_interface().
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02003976 *
3977 * @hw: the hardware struct of which the interfaces should be iterated over
Johannes Berg8b2c9822012-11-06 20:23:30 +01003978 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02003979 * @iterator: the iterator function to call, cannot sleep
3980 * @data: first argument of the iterator function
3981 */
3982void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
Johannes Berg8b2c9822012-11-06 20:23:30 +01003983 u32 iter_flags,
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02003984 void (*iterator)(void *data,
3985 u8 *mac,
3986 struct ieee80211_vif *vif),
3987 void *data);
3988
3989/**
Johannes Bergc7c71062013-08-21 22:07:20 +02003990 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
3991 *
3992 * This function iterates over the interfaces associated with a given
3993 * hardware that are currently active and calls the callback for them.
3994 * This version can only be used while holding the RTNL.
3995 *
3996 * @hw: the hardware struct of which the interfaces should be iterated over
3997 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
3998 * @iterator: the iterator function to call, cannot sleep
3999 * @data: first argument of the iterator function
4000 */
4001void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw,
4002 u32 iter_flags,
4003 void (*iterator)(void *data,
4004 u8 *mac,
4005 struct ieee80211_vif *vif),
4006 void *data);
4007
4008/**
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04004009 * ieee80211_queue_work - add work onto the mac80211 workqueue
4010 *
4011 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
4012 * This helper ensures drivers are not queueing work when they should not be.
4013 *
4014 * @hw: the hardware struct for the interface we are adding work for
4015 * @work: the work we want to add onto the mac80211 workqueue
4016 */
4017void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
4018
4019/**
4020 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
4021 *
4022 * Drivers and mac80211 use this to queue delayed work onto the mac80211
4023 * workqueue.
4024 *
4025 * @hw: the hardware struct for the interface we are adding work for
4026 * @dwork: delayable work to queue onto the mac80211 workqueue
4027 * @delay: number of jiffies to wait before queueing
4028 */
4029void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
4030 struct delayed_work *dwork,
4031 unsigned long delay);
4032
4033/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004034 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01004035 * @sta: the station for which to start a BA session
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004036 * @tid: the TID to BA on.
Sujith Manoharanbd2ce6e2010-12-15 07:47:10 +05304037 * @timeout: session timeout value (in TUs)
Randy Dunlapea2d8b52008-10-27 09:47:03 -07004038 *
4039 * Return: success if addBA request was sent, failure otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004040 *
4041 * Although mac80211/low level driver/user space application can estimate
4042 * the need to start aggregation on a certain RA/TID, the session level
4043 * will be managed by the mac80211.
4044 */
Sujith Manoharanbd2ce6e2010-12-15 07:47:10 +05304045int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
4046 u16 timeout);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004047
4048/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004049 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01004050 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004051 * @ra: receiver address of the BA session recipient.
4052 * @tid: the TID to BA on.
4053 *
4054 * This function must be called by low level driver once it has
Johannes Berg5d22c892010-06-10 10:21:40 +02004055 * finished with preparations for the BA session. It can be called
4056 * from any context.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004057 */
Johannes Bergc951ad32009-11-16 12:00:38 +01004058void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004059 u16 tid);
4060
4061/**
4062 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01004063 * @sta: the station whose BA session to stop
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004064 * @tid: the TID to stop BA.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07004065 *
Johannes Berg6a8579d2010-05-27 14:41:07 +02004066 * Return: negative error if the TID is invalid, or no aggregation active
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004067 *
4068 * Although mac80211/low level driver/user space application can estimate
4069 * the need to stop aggregation on a certain RA/TID, the session level
4070 * will be managed by the mac80211.
4071 */
Johannes Berg6a8579d2010-05-27 14:41:07 +02004072int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004073
4074/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004075 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01004076 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004077 * @ra: receiver address of the BA session recipient.
4078 * @tid: the desired TID to BA on.
4079 *
4080 * This function must be called by low level driver once it has
Johannes Berg5d22c892010-06-10 10:21:40 +02004081 * finished with preparations for the BA session tear down. It
4082 * can be called from any context.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004083 */
Johannes Bergc951ad32009-11-16 12:00:38 +01004084void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02004085 u16 tid);
4086
Mohamed Abbas84363e62008-04-04 16:59:58 -07004087/**
Johannes Berg17741cd2008-09-11 00:02:02 +02004088 * ieee80211_find_sta - find a station
4089 *
Johannes Berg5ed176e2009-11-04 14:42:28 +01004090 * @vif: virtual interface to look for station on
Johannes Berg17741cd2008-09-11 00:02:02 +02004091 * @addr: station's address
4092 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004093 * Return: The station, if found. %NULL otherwise.
4094 *
4095 * Note: This function must be called under RCU lock and the
Johannes Berg17741cd2008-09-11 00:02:02 +02004096 * resulting pointer is only valid under RCU lock as well.
4097 */
Johannes Berg5ed176e2009-11-04 14:42:28 +01004098struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02004099 const u8 *addr);
4100
Kalle Valo04de8382009-03-22 21:57:35 +02004101/**
Ben Greear686b9cb2010-09-23 09:44:36 -07004102 * ieee80211_find_sta_by_ifaddr - find a station on hardware
Johannes Berg5ed176e2009-11-04 14:42:28 +01004103 *
4104 * @hw: pointer as obtained from ieee80211_alloc_hw()
Ben Greear686b9cb2010-09-23 09:44:36 -07004105 * @addr: remote station's address
4106 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
Johannes Berg5ed176e2009-11-04 14:42:28 +01004107 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004108 * Return: The station, if found. %NULL otherwise.
4109 *
4110 * Note: This function must be called under RCU lock and the
Johannes Berg5ed176e2009-11-04 14:42:28 +01004111 * resulting pointer is only valid under RCU lock as well.
4112 *
Ben Greear686b9cb2010-09-23 09:44:36 -07004113 * NOTE: You may pass NULL for localaddr, but then you will just get
4114 * the first STA that matches the remote address 'addr'.
4115 * We can have multiple STA associated with multiple
4116 * logical stations (e.g. consider a station connecting to another
4117 * BSSID on the same AP hardware without disconnecting first).
4118 * In this case, the result of this method with localaddr NULL
4119 * is not reliable.
Johannes Berg5ed176e2009-11-04 14:42:28 +01004120 *
Ben Greear686b9cb2010-09-23 09:44:36 -07004121 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
Johannes Berg5ed176e2009-11-04 14:42:28 +01004122 */
Ben Greear686b9cb2010-09-23 09:44:36 -07004123struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
4124 const u8 *addr,
4125 const u8 *localaddr);
Johannes Berg5ed176e2009-11-04 14:42:28 +01004126
4127/**
Johannes Bergaf818582009-11-06 11:35:50 +01004128 * ieee80211_sta_block_awake - block station from waking up
4129 * @hw: the hardware
4130 * @pubsta: the station
4131 * @block: whether to block or unblock
4132 *
4133 * Some devices require that all frames that are on the queues
4134 * for a specific station that went to sleep are flushed before
4135 * a poll response or frames after the station woke up can be
4136 * delivered to that it. Note that such frames must be rejected
4137 * by the driver as filtered, with the appropriate status flag.
4138 *
4139 * This function allows implementing this mode in a race-free
4140 * manner.
4141 *
4142 * To do this, a driver must keep track of the number of frames
4143 * still enqueued for a specific station. If this number is not
4144 * zero when the station goes to sleep, the driver must call
4145 * this function to force mac80211 to consider the station to
4146 * be asleep regardless of the station's actual state. Once the
4147 * number of outstanding frames reaches zero, the driver must
4148 * call this function again to unblock the station. That will
4149 * cause mac80211 to be able to send ps-poll responses, and if
4150 * the station queried in the meantime then frames will also
4151 * be sent out as a result of this. Additionally, the driver
4152 * will be notified that the station woke up some time after
4153 * it is unblocked, regardless of whether the station actually
4154 * woke up while blocked or not.
4155 */
4156void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
4157 struct ieee80211_sta *pubsta, bool block);
4158
4159/**
Johannes Berg37fbd902011-09-29 16:04:39 +02004160 * ieee80211_sta_eosp - notify mac80211 about end of SP
4161 * @pubsta: the station
4162 *
4163 * When a device transmits frames in a way that it can't tell
4164 * mac80211 in the TX status about the EOSP, it must clear the
4165 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
4166 * This applies for PS-Poll as well as uAPSD.
4167 *
Johannes Berge9437892013-02-15 21:38:08 +01004168 * Note that just like with _tx_status() and _rx() drivers must
4169 * not mix calls to irqsafe/non-irqsafe versions, this function
4170 * must not be mixed with those either. Use the all irqsafe, or
4171 * all non-irqsafe, don't mix!
4172 *
4173 * NB: the _irqsafe version of this function doesn't exist, no
4174 * driver needs it right now. Don't call this function if
4175 * you'd need the _irqsafe version, look at the git history
4176 * and restore the _irqsafe version!
Johannes Berg37fbd902011-09-29 16:04:39 +02004177 */
Johannes Berge9437892013-02-15 21:38:08 +01004178void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
Johannes Berg37fbd902011-09-29 16:04:39 +02004179
4180/**
Johannes Berg830af022011-07-05 16:35:39 +02004181 * ieee80211_iter_keys - iterate keys programmed into the device
4182 * @hw: pointer obtained from ieee80211_alloc_hw()
4183 * @vif: virtual interface to iterate, may be %NULL for all
4184 * @iter: iterator function that will be called for each key
4185 * @iter_data: custom data to pass to the iterator function
4186 *
4187 * This function can be used to iterate all the keys known to
4188 * mac80211, even those that weren't previously programmed into
4189 * the device. This is intended for use in WoWLAN if the device
4190 * needs reprogramming of the keys during suspend. Note that due
4191 * to locking reasons, it is also only safe to call this at few
4192 * spots since it must hold the RTNL and be able to sleep.
Johannes Bergf850e002011-07-13 19:50:53 +02004193 *
4194 * The order in which the keys are iterated matches the order
4195 * in which they were originally installed and handed to the
4196 * set_key callback.
Johannes Berg830af022011-07-05 16:35:39 +02004197 */
4198void ieee80211_iter_keys(struct ieee80211_hw *hw,
4199 struct ieee80211_vif *vif,
4200 void (*iter)(struct ieee80211_hw *hw,
4201 struct ieee80211_vif *vif,
4202 struct ieee80211_sta *sta,
4203 struct ieee80211_key_conf *key,
4204 void *data),
4205 void *iter_data);
4206
4207/**
Johannes Berg3448c002012-09-11 17:57:42 +02004208 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
4209 * @hw: pointre obtained from ieee80211_alloc_hw().
4210 * @iter: iterator function
4211 * @iter_data: data passed to iterator function
4212 *
4213 * Iterate all active channel contexts. This function is atomic and
4214 * doesn't acquire any locks internally that might be held in other
4215 * places while calling into the driver.
4216 *
4217 * The iterator will not find a context that's being added (during
4218 * the driver callback to add it) but will find it while it's being
4219 * removed.
Johannes Berg8a61af62012-12-13 17:42:30 +01004220 *
4221 * Note that during hardware restart, all contexts that existed
4222 * before the restart are considered already present so will be
4223 * found while iterating, whether they've been re-added already
4224 * or not.
Johannes Berg3448c002012-09-11 17:57:42 +02004225 */
4226void ieee80211_iter_chan_contexts_atomic(
4227 struct ieee80211_hw *hw,
4228 void (*iter)(struct ieee80211_hw *hw,
4229 struct ieee80211_chanctx_conf *chanctx_conf,
4230 void *data),
4231 void *iter_data);
4232
4233/**
Juuso Oikarinena619a4c2010-11-11 08:50:18 +02004234 * ieee80211_ap_probereq_get - retrieve a Probe Request template
4235 * @hw: pointer obtained from ieee80211_alloc_hw().
4236 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4237 *
4238 * Creates a Probe Request template which can, for example, be uploaded to
4239 * hardware. The template is filled with bssid, ssid and supported rate
4240 * information. This function must only be called from within the
4241 * .bss_info_changed callback function and only in managed mode. The function
4242 * is only useful when the interface is associated, otherwise it will return
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004243 * %NULL.
4244 *
4245 * Return: The Probe Request template. %NULL on error.
Juuso Oikarinena619a4c2010-11-11 08:50:18 +02004246 */
4247struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
4248 struct ieee80211_vif *vif);
4249
4250/**
Kalle Valo04de8382009-03-22 21:57:35 +02004251 * ieee80211_beacon_loss - inform hardware does not receive beacons
4252 *
Johannes Berg1ed32e42009-12-23 13:15:45 +01004253 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Kalle Valo04de8382009-03-22 21:57:35 +02004254 *
Johannes Bergc1288b12012-01-19 09:29:57 +01004255 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02004256 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
Kalle Valo04de8382009-03-22 21:57:35 +02004257 * hardware is not receiving beacons with this function.
4258 */
4259void ieee80211_beacon_loss(struct ieee80211_vif *vif);
Johannes Berg4b7679a2008-09-18 18:14:18 +02004260
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02004261/**
4262 * ieee80211_connection_loss - inform hardware has lost connection to the AP
4263 *
4264 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4265 *
Johannes Bergc1288b12012-01-19 09:29:57 +01004266 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02004267 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
4268 * needs to inform if the connection to the AP has been lost.
Johannes Berg682bd382013-01-29 13:13:50 +01004269 * The function may also be called if the connection needs to be terminated
4270 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02004271 *
4272 * This function will cause immediate change to disassociated state,
4273 * without connection recovery attempts.
4274 */
4275void ieee80211_connection_loss(struct ieee80211_vif *vif);
4276
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02004277/**
Johannes Berg95acac62011-07-12 12:30:59 +02004278 * ieee80211_resume_disconnect - disconnect from AP after resume
4279 *
4280 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4281 *
4282 * Instructs mac80211 to disconnect from the AP after resume.
4283 * Drivers can use this after WoWLAN if they know that the
4284 * connection cannot be kept up, for example because keys were
4285 * used while the device was asleep but the replay counters or
4286 * similar cannot be retrieved from the device during resume.
4287 *
4288 * Note that due to implementation issues, if the driver uses
4289 * the reconfiguration functionality during resume the interface
4290 * will still be added as associated first during resume and then
4291 * disconnect normally later.
4292 *
4293 * This function can only be called from the resume callback and
4294 * the driver must not be holding any of its own locks while it
4295 * calls this function, or at least not any locks it needs in the
4296 * key configuration paths (if it supports HW crypto).
4297 */
4298void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
4299
4300/**
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02004301 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
4302 * rssi threshold triggered
4303 *
4304 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4305 * @rssi_event: the RSSI trigger event type
4306 * @gfp: context flags
4307 *
Johannes Bergea086352012-01-19 09:29:58 +01004308 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02004309 * monitoring is configured with an rssi threshold, the driver will inform
4310 * whenever the rssi level reaches the threshold.
4311 */
4312void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
4313 enum nl80211_cqm_rssi_threshold_event rssi_event,
4314 gfp_t gfp);
4315
Johannes Berg5ce6e432010-05-11 16:20:57 +02004316/**
Simon Wunderlich164eb022013-02-08 18:16:20 +01004317 * ieee80211_radar_detected - inform that a radar was detected
4318 *
4319 * @hw: pointer as obtained from ieee80211_alloc_hw()
4320 */
4321void ieee80211_radar_detected(struct ieee80211_hw *hw);
4322
4323/**
Johannes Berg5ce6e432010-05-11 16:20:57 +02004324 * ieee80211_chswitch_done - Complete channel switch process
4325 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4326 * @success: make the channel switch successful or not
4327 *
4328 * Complete the channel switch post-process: set the new operational channel
4329 * and wake up the suspended queues.
4330 */
4331void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
4332
Johannes Bergd1f5b7a2010-08-05 17:05:55 +02004333/**
4334 * ieee80211_request_smps - request SM PS transition
4335 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Berg633dd1e2010-08-18 15:01:23 +02004336 * @smps_mode: new SM PS mode
Johannes Bergd1f5b7a2010-08-05 17:05:55 +02004337 *
4338 * This allows the driver to request an SM PS transition in managed
4339 * mode. This is useful when the driver has more information than
4340 * the stack about possible interference, for example by bluetooth.
4341 */
4342void ieee80211_request_smps(struct ieee80211_vif *vif,
4343 enum ieee80211_smps_mode smps_mode);
4344
Johannes Berge31b8212010-10-05 19:39:30 +02004345/**
Johannes Berg21f83582010-12-18 17:20:47 +01004346 * ieee80211_ready_on_channel - notification of remain-on-channel start
4347 * @hw: pointer as obtained from ieee80211_alloc_hw()
4348 */
4349void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
4350
4351/**
4352 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
4353 * @hw: pointer as obtained from ieee80211_alloc_hw()
4354 */
4355void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
4356
Shahar Levif41ccd72011-05-22 16:10:21 +03004357/**
4358 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
4359 *
4360 * in order not to harm the system performance and user experience, the device
4361 * may request not to allow any rx ba session and tear down existing rx ba
4362 * sessions based on system constraints such as periodic BT activity that needs
4363 * to limit wlan activity (eg.sco or a2dp)."
4364 * in such cases, the intention is to limit the duration of the rx ppdu and
4365 * therefore prevent the peer device to use a-mpdu aggregation.
4366 *
4367 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4368 * @ba_rx_bitmap: Bit map of open rx ba per tid
4369 * @addr: & to bssid mac address
4370 */
4371void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
4372 const u8 *addr);
4373
Felix Fietkau8c771242011-08-20 15:53:55 +02004374/**
4375 * ieee80211_send_bar - send a BlockAckReq frame
4376 *
4377 * can be used to flush pending frames from the peer's aggregation reorder
4378 * buffer.
4379 *
4380 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4381 * @ra: the peer's destination address
4382 * @tid: the TID of the aggregation session
4383 * @ssn: the new starting sequence number for the receiver
4384 */
4385void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
4386
Johannes Berg4b7679a2008-09-18 18:14:18 +02004387/* Rate control API */
Johannes Berge6a98542008-10-21 12:40:02 +02004388
Johannes Berg4b7679a2008-09-18 18:14:18 +02004389/**
Johannes Berge6a98542008-10-21 12:40:02 +02004390 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
Johannes Berg4b7679a2008-09-18 18:14:18 +02004391 *
Johannes Berge6a98542008-10-21 12:40:02 +02004392 * @hw: The hardware the algorithm is invoked for.
4393 * @sband: The band this frame is being transmitted on.
4394 * @bss_conf: the current BSS configuration
Simon Wunderlichf44d4eb2012-03-07 21:31:13 +01004395 * @skb: the skb that will be transmitted, the control information in it needs
4396 * to be filled in
Johannes Berge6a98542008-10-21 12:40:02 +02004397 * @reported_rate: The rate control algorithm can fill this in to indicate
4398 * which rate should be reported to userspace as the current rate and
4399 * used for rate calculations in the mesh network.
4400 * @rts: whether RTS will be used for this frame because it is longer than the
4401 * RTS threshold
4402 * @short_preamble: whether mac80211 will request short-preamble transmission
4403 * if the selected rate supports it
Simon Wunderlichf44d4eb2012-03-07 21:31:13 +01004404 * @max_rate_idx: user-requested maximum (legacy) rate
Jouni Malinen37eb0b12010-01-06 13:09:08 +02004405 * (deprecated; this will be removed once drivers get updated to use
4406 * rate_idx_mask)
Simon Wunderlichf44d4eb2012-03-07 21:31:13 +01004407 * @rate_idx_mask: user-requested (legacy) rate mask
Felix Fietkau2ffbe6d2013-04-16 13:38:42 +02004408 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
Felix Fietkau8f0729b2010-11-11 15:07:23 +01004409 * @bss: whether this frame is sent out in AP or IBSS mode
Johannes Berg4b7679a2008-09-18 18:14:18 +02004410 */
Johannes Berge6a98542008-10-21 12:40:02 +02004411struct ieee80211_tx_rate_control {
4412 struct ieee80211_hw *hw;
4413 struct ieee80211_supported_band *sband;
4414 struct ieee80211_bss_conf *bss_conf;
4415 struct sk_buff *skb;
4416 struct ieee80211_tx_rate reported_rate;
4417 bool rts, short_preamble;
4418 u8 max_rate_idx;
Jouni Malinen37eb0b12010-01-06 13:09:08 +02004419 u32 rate_idx_mask;
Felix Fietkau2ffbe6d2013-04-16 13:38:42 +02004420 u8 *rate_idx_mcs_mask;
Felix Fietkau8f0729b2010-11-11 15:07:23 +01004421 bool bss;
Johannes Berg4b7679a2008-09-18 18:14:18 +02004422};
4423
4424struct rate_control_ops {
4425 struct module *module;
4426 const char *name;
4427 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
Johannes Berg4b7679a2008-09-18 18:14:18 +02004428 void (*free)(void *priv);
4429
4430 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
4431 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
Simon Wunderlich3de805c2013-07-08 16:55:50 +02004432 struct cfg80211_chan_def *chandef,
Johannes Berg4b7679a2008-09-18 18:14:18 +02004433 struct ieee80211_sta *sta, void *priv_sta);
Sujith81cb7622009-02-12 11:38:37 +05304434 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
Simon Wunderlich3de805c2013-07-08 16:55:50 +02004435 struct cfg80211_chan_def *chandef,
Johannes Berg64f68e52012-03-28 10:58:37 +02004436 struct ieee80211_sta *sta, void *priv_sta,
4437 u32 changed);
Johannes Berg4b7679a2008-09-18 18:14:18 +02004438 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
4439 void *priv_sta);
4440
4441 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
4442 struct ieee80211_sta *sta, void *priv_sta,
4443 struct sk_buff *skb);
Johannes Berge6a98542008-10-21 12:40:02 +02004444 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
4445 struct ieee80211_tx_rate_control *txrc);
Johannes Berg4b7679a2008-09-18 18:14:18 +02004446
4447 void (*add_sta_debugfs)(void *priv, void *priv_sta,
4448 struct dentry *dir);
4449 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
4450};
4451
4452static inline int rate_supported(struct ieee80211_sta *sta,
4453 enum ieee80211_band band,
4454 int index)
4455{
4456 return (sta == NULL || sta->supp_rates[band] & BIT(index));
4457}
4458
Luis R. Rodriguez4c6d4f52009-07-16 10:05:41 -07004459/**
4460 * rate_control_send_low - helper for drivers for management/no-ack frames
4461 *
4462 * Rate control algorithms that agree to use the lowest rate to
4463 * send management frames and NO_ACK data with the respective hw
4464 * retries should use this in the beginning of their mac80211 get_rate
4465 * callback. If true is returned the rate control can simply return.
4466 * If false is returned we guarantee that sta and sta and priv_sta is
4467 * not null.
4468 *
4469 * Rate control algorithms wishing to do more intelligent selection of
4470 * rate for multicast/broadcast frames may choose to not use this.
4471 *
4472 * @sta: &struct ieee80211_sta pointer to the target destination. Note
4473 * that this may be null.
4474 * @priv_sta: private rate control structure. This may be null.
4475 * @txrc: rate control information we sholud populate for mac80211.
4476 */
4477bool rate_control_send_low(struct ieee80211_sta *sta,
4478 void *priv_sta,
4479 struct ieee80211_tx_rate_control *txrc);
4480
4481
Johannes Berg4b7679a2008-09-18 18:14:18 +02004482static inline s8
4483rate_lowest_index(struct ieee80211_supported_band *sband,
4484 struct ieee80211_sta *sta)
4485{
4486 int i;
4487
4488 for (i = 0; i < sband->n_bitrates; i++)
4489 if (rate_supported(sta, sband->band, i))
4490 return i;
4491
4492 /* warn when we cannot find a rate. */
Johannes Berg54d50262011-11-04 18:07:43 +01004493 WARN_ON_ONCE(1);
Johannes Berg4b7679a2008-09-18 18:14:18 +02004494
Johannes Berg54d50262011-11-04 18:07:43 +01004495 /* and return 0 (the lowest index) */
Johannes Berg4b7679a2008-09-18 18:14:18 +02004496 return 0;
4497}
4498
Luis R. Rodriguezb770b432009-07-16 10:15:09 -07004499static inline
4500bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
4501 struct ieee80211_sta *sta)
4502{
4503 unsigned int i;
4504
4505 for (i = 0; i < sband->n_bitrates; i++)
4506 if (rate_supported(sta, sband->band, i))
4507 return true;
4508 return false;
4509}
Johannes Berg4b7679a2008-09-18 18:14:18 +02004510
Felix Fietkau0d528d82013-04-22 16:14:41 +02004511/**
4512 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
4513 *
4514 * When not doing a rate control probe to test rates, rate control should pass
4515 * its rate selection to mac80211. If the driver supports receiving a station
4516 * rate table, it will use it to ensure that frames are always sent based on
4517 * the most recent rate control module decision.
4518 *
4519 * @hw: pointer as obtained from ieee80211_alloc_hw()
4520 * @pubsta: &struct ieee80211_sta pointer to the target destination.
4521 * @rates: new tx rate set to be used for this station.
4522 */
4523int rate_control_set_rates(struct ieee80211_hw *hw,
4524 struct ieee80211_sta *pubsta,
4525 struct ieee80211_sta_rates *rates);
4526
Johannes Berg4b7679a2008-09-18 18:14:18 +02004527int ieee80211_rate_control_register(struct rate_control_ops *ops);
4528void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
4529
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08004530static inline bool
4531conf_is_ht20(struct ieee80211_conf *conf)
4532{
Karl Beldan675a0b02013-03-25 16:26:57 +01004533 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08004534}
4535
4536static inline bool
4537conf_is_ht40_minus(struct ieee80211_conf *conf)
4538{
Karl Beldan675a0b02013-03-25 16:26:57 +01004539 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
4540 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08004541}
4542
4543static inline bool
4544conf_is_ht40_plus(struct ieee80211_conf *conf)
4545{
Karl Beldan675a0b02013-03-25 16:26:57 +01004546 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
4547 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08004548}
4549
4550static inline bool
4551conf_is_ht40(struct ieee80211_conf *conf)
4552{
Karl Beldan675a0b02013-03-25 16:26:57 +01004553 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08004554}
4555
4556static inline bool
4557conf_is_ht(struct ieee80211_conf *conf)
4558{
Karl Beldan675a0b02013-03-25 16:26:57 +01004559 return conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08004560}
4561
Johannes Berg2ca27bc2010-09-16 14:58:23 +02004562static inline enum nl80211_iftype
4563ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
4564{
4565 if (p2p) {
4566 switch (type) {
4567 case NL80211_IFTYPE_STATION:
4568 return NL80211_IFTYPE_P2P_CLIENT;
4569 case NL80211_IFTYPE_AP:
4570 return NL80211_IFTYPE_P2P_GO;
4571 default:
4572 break;
4573 }
4574 }
4575 return type;
4576}
4577
4578static inline enum nl80211_iftype
4579ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
4580{
4581 return ieee80211_iftype_p2p(vif->type, vif->p2p);
4582}
4583
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -07004584void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
4585 int rssi_min_thold,
4586 int rssi_max_thold);
4587
4588void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
Arik Nemtsov768db342011-09-28 14:12:51 +03004589
Wey-Yi Guy0d8a0a12012-04-20 11:57:00 -07004590/**
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004591 * ieee80211_ave_rssi - report the average RSSI for the specified interface
Wey-Yi Guy0d8a0a12012-04-20 11:57:00 -07004592 *
4593 * @vif: the specified virtual interface
4594 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004595 * Note: This function assumes that the given vif is valid.
4596 *
4597 * Return: The average RSSI value for the requested interface, or 0 if not
4598 * applicable.
Wey-Yi Guy0d8a0a12012-04-20 11:57:00 -07004599 */
Wey-Yi Guy1dae27f2012-04-13 12:02:57 -07004600int ieee80211_ave_rssi(struct ieee80211_vif *vif);
4601
Johannes Bergcd8f7cb2013-01-22 12:34:29 +01004602/**
4603 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
4604 * @vif: virtual interface
4605 * @wakeup: wakeup reason(s)
4606 * @gfp: allocation flags
4607 *
4608 * See cfg80211_report_wowlan_wakeup().
4609 */
4610void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
4611 struct cfg80211_wowlan_wakeup *wakeup,
4612 gfp_t gfp);
4613
Felix Fietkau06be6b12013-10-14 18:01:00 +02004614/**
4615 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
4616 * @hw: pointer as obtained from ieee80211_alloc_hw()
4617 * @vif: virtual interface
4618 * @skb: frame to be sent from within the driver
4619 * @band: the band to transmit on
4620 * @sta: optional pointer to get the station to send the frame to
4621 *
4622 * Note: must be called under RCU lock
4623 */
4624bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
4625 struct ieee80211_vif *vif, struct sk_buff *skb,
4626 int band, struct ieee80211_sta **sta);
4627
Jiri Bencf0706e82007-05-05 11:45:53 -07004628#endif /* MAC80211_H */