blob: dd73b8c6746bdd1654c08bc5e2c10f77b59a0a1f [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
Kalle Valo9d173fc2010-01-14 13:09:14 +0200131 * @uapsd: is U-APSD mode enabled for the queue
Johannes Berg6b301cd2007-09-18 17:29:20 -0400132 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700133struct ieee80211_tx_queue_params {
Johannes Bergf434b2d2008-07-10 11:22:31 +0200134 u16 txop;
Johannes Berg3330d7b2008-02-10 16:49:38 +0100135 u16 cw_min;
136 u16 cw_max;
Johannes Bergf434b2d2008-07-10 11:22:31 +0200137 u8 aifs;
Kalle Valoab133152010-01-12 10:42:31 +0200138 bool uapsd;
Jiri Bencf0706e82007-05-05 11:45:53 -0700139};
140
Jiri Bencf0706e82007-05-05 11:45:53 -0700141struct ieee80211_low_level_stats {
142 unsigned int dot11ACKFailureCount;
143 unsigned int dot11RTSFailureCount;
144 unsigned int dot11FCSErrorCount;
145 unsigned int dot11RTSSuccessCount;
146};
147
Johannes Berg471b3ef2007-12-28 14:32:58 +0100148/**
Michal Kaziord01a1e62012-06-26 14:37:16 +0200149 * enum ieee80211_chanctx_change - change flag for channel context
Johannes Berg4bf88532012-11-09 11:39:59 +0100150 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
Johannes Berg04ecd252012-09-11 14:34:12 +0200151 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
Simon Wunderlich164eb022013-02-08 18:16:20 +0100152 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
Michal Kaziord01a1e62012-06-26 14:37:16 +0200153 */
154enum ieee80211_chanctx_change {
Johannes Berg4bf88532012-11-09 11:39:59 +0100155 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0),
Johannes Berg04ecd252012-09-11 14:34:12 +0200156 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1),
Simon Wunderlich164eb022013-02-08 18:16:20 +0100157 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2),
Michal Kaziord01a1e62012-06-26 14:37:16 +0200158};
159
160/**
161 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
162 *
163 * This is the driver-visible part. The ieee80211_chanctx
164 * that contains it is visible in mac80211 only.
165 *
Johannes Berg4bf88532012-11-09 11:39:59 +0100166 * @def: the channel definition
Johannes Berg04ecd252012-09-11 14:34:12 +0200167 * @rx_chains_static: The number of RX chains that must always be
168 * active on the channel to receive MIMO transmissions
169 * @rx_chains_dynamic: The number of RX chains that must be enabled
170 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
Simon Wunderlich5d7fad42012-11-30 19:17:28 +0100171 * this will always be >= @rx_chains_static.
Simon Wunderlich164eb022013-02-08 18:16:20 +0100172 * @radar_enabled: whether radar detection is enabled on this channel.
Michal Kaziord01a1e62012-06-26 14:37:16 +0200173 * @drv_priv: data area for driver use, will always be aligned to
174 * sizeof(void *), size is determined in hw information.
175 */
176struct ieee80211_chanctx_conf {
Johannes Berg4bf88532012-11-09 11:39:59 +0100177 struct cfg80211_chan_def def;
Michal Kaziord01a1e62012-06-26 14:37:16 +0200178
Johannes Berg04ecd252012-09-11 14:34:12 +0200179 u8 rx_chains_static, rx_chains_dynamic;
180
Simon Wunderlich164eb022013-02-08 18:16:20 +0100181 bool radar_enabled;
182
Johannes Berg1c06ef92012-12-28 12:22:02 +0100183 u8 drv_priv[0] __aligned(sizeof(void *));
Michal Kaziord01a1e62012-06-26 14:37:16 +0200184};
185
186/**
Johannes Berg471b3ef2007-12-28 14:32:58 +0100187 * enum ieee80211_bss_change - BSS change notification flags
188 *
189 * These flags are used with the bss_info_changed() callback
190 * to indicate which BSS parameter changed.
191 *
192 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
193 * also implies a change in the AID.
194 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
195 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300196 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler38668c02008-03-28 16:33:32 -0700197 * @BSS_CHANGED_HT: 802.11n parameters changed
Johannes Berg96dd22a2008-09-11 00:01:57 +0200198 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200199 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200200 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
201 * reason (IBSS and managed mode)
202 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
203 * new beacon (beaconing modes)
204 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
205 * enabled/disabled (beaconing modes)
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200206 * @BSS_CHANGED_CQM: Connection quality monitor config changed
Johannes Berg8fc214b2010-04-28 17:40:43 +0200207 * @BSS_CHANGED_IBSS: IBSS join status changed
Juuso Oikarinen68542962010-06-09 13:43:26 +0300208 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
Johannes Berg4ced3f72010-07-19 16:39:04 +0200209 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
210 * that it is only ever disabled for station mode.
Johannes Berg7da7cc12010-08-05 17:02:38 +0200211 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
Arik Nemtsov78274932011-09-04 11:11:32 +0300212 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP mode)
Arik Nemtsov02945822011-11-10 11:28:57 +0200213 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
Eliad Pellerab095872012-07-27 12:33:22 +0300214 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
Johannes Berg1ea6f9c2012-10-24 10:59:25 +0200215 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
Johannes Berg488dd7b2012-10-29 20:08:01 +0100216 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
217 * changed (currently only in P2P client mode, GO mode will be later)
Emmanuel Grumbachc65dd142012-12-12 10:12:24 +0200218 * @BSS_CHANGED_DTIM_PERIOD: the DTIM period value was changed (set when
219 * it becomes valid, managed mode only)
Johannes Berg2c9b7352013-02-07 21:37:29 +0100220 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
221 * note that this is only called when it changes after the channel
222 * context had been assigned.
Johannes Berg471b3ef2007-12-28 14:32:58 +0100223 */
224enum ieee80211_bss_change {
225 BSS_CHANGED_ASSOC = 1<<0,
226 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
227 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300228 BSS_CHANGED_ERP_SLOT = 1<<3,
Alexander Simona7ce1c92011-09-18 00:16:45 +0200229 BSS_CHANGED_HT = 1<<4,
Johannes Berg96dd22a2008-09-11 00:01:57 +0200230 BSS_CHANGED_BASIC_RATES = 1<<5,
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200231 BSS_CHANGED_BEACON_INT = 1<<6,
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200232 BSS_CHANGED_BSSID = 1<<7,
233 BSS_CHANGED_BEACON = 1<<8,
234 BSS_CHANGED_BEACON_ENABLED = 1<<9,
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200235 BSS_CHANGED_CQM = 1<<10,
Johannes Berg8fc214b2010-04-28 17:40:43 +0200236 BSS_CHANGED_IBSS = 1<<11,
Juuso Oikarinen68542962010-06-09 13:43:26 +0300237 BSS_CHANGED_ARP_FILTER = 1<<12,
Johannes Berg4ced3f72010-07-19 16:39:04 +0200238 BSS_CHANGED_QOS = 1<<13,
Johannes Berg7da7cc12010-08-05 17:02:38 +0200239 BSS_CHANGED_IDLE = 1<<14,
Arik Nemtsov78274932011-09-04 11:11:32 +0300240 BSS_CHANGED_SSID = 1<<15,
Arik Nemtsov02945822011-11-10 11:28:57 +0200241 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
Eliad Pellerab095872012-07-27 12:33:22 +0300242 BSS_CHANGED_PS = 1<<17,
Johannes Berg1ea6f9c2012-10-24 10:59:25 +0200243 BSS_CHANGED_TXPOWER = 1<<18,
Johannes Berg488dd7b2012-10-29 20:08:01 +0100244 BSS_CHANGED_P2P_PS = 1<<19,
Emmanuel Grumbachc65dd142012-12-12 10:12:24 +0200245 BSS_CHANGED_DTIM_PERIOD = 1<<20,
Johannes Berg2c9b7352013-02-07 21:37:29 +0100246 BSS_CHANGED_BANDWIDTH = 1<<21,
Johannes Bergac8dd502010-05-05 09:44:02 +0200247
248 /* when adding here, make sure to change ieee80211_reconfig */
Johannes Berg471b3ef2007-12-28 14:32:58 +0100249};
250
Juuso Oikarinen68542962010-06-09 13:43:26 +0300251/*
252 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
253 * of addresses for an interface increase beyond this value, hardware ARP
254 * filtering will be disabled.
255 */
256#define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
257
Johannes Berg471b3ef2007-12-28 14:32:58 +0100258/**
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -0700259 * enum ieee80211_rssi_event - RSSI threshold event
260 * An indicator for when RSSI goes below/above a certain threshold.
261 * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
262 * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
263 */
264enum ieee80211_rssi_event {
265 RSSI_EVENT_HIGH,
266 RSSI_EVENT_LOW,
267};
268
269/**
Johannes Berg471b3ef2007-12-28 14:32:58 +0100270 * struct ieee80211_bss_conf - holds the BSS's changing parameters
271 *
272 * This structure keeps information about a BSS (and an association
273 * to that BSS) that can change during the lifetime of the BSS.
274 *
275 * @assoc: association status
Johannes Berg8fc214b2010-04-28 17:40:43 +0200276 * @ibss_joined: indicates whether this station is part of an IBSS
277 * or not
Sujith Manoharanc13a7652012-10-12 17:35:45 +0530278 * @ibss_creator: indicates if a new IBSS network is being created
Johannes Berg471b3ef2007-12-28 14:32:58 +0100279 * @aid: association ID number, valid only when @assoc is true
280 * @use_cts_prot: use CTS protection
Johannes Berg7a5158e2008-10-08 10:59:33 +0200281 * @use_short_preamble: use 802.11b short preamble;
282 * if the hardware cannot handle this it must set the
283 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
284 * @use_short_slot: use short slot time (only relevant for ERP);
285 * if the hardware cannot handle this it must set the
286 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
Johannes Berg56007a02010-01-26 14:19:52 +0100287 * @dtim_period: num of beacons before the next DTIM, for beaconing,
Emmanuel Grumbachc65dd142012-12-12 10:12:24 +0200288 * valid in station mode only if after the driver was notified
289 * with the %BSS_CHANGED_DTIM_PERIOD flag, will be non-zero then.
Johannes Berg8c358bc2012-05-22 22:13:05 +0200290 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
Johannes Bergef429da2013-02-05 17:48:40 +0100291 * as it may have been received during scanning long ago). If the
292 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
293 * only come from a beacon, but might not become valid until after
294 * association when a beacon is received (which is notified with the
295 * %BSS_CHANGED_DTIM flag.)
Johannes Berg8c358bc2012-05-22 22:13:05 +0200296 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
297 * the driver/device can use this to calculate synchronisation
Johannes Bergef429da2013-02-05 17:48:40 +0100298 * (see @sync_tsf)
299 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
300 * is requested, see @sync_tsf/@sync_device_ts.
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700301 * @beacon_int: beacon interval
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800302 * @assoc_capability: capabilities taken from assoc resp
Johannes Berg96dd22a2008-09-11 00:01:57 +0200303 * @basic_rates: bitmap of basic rates, each bit stands for an
304 * index into the rate table configured by the driver in
305 * the current band.
Felix Fietkaudd5b4cc2010-11-22 20:58:24 +0100306 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200307 * @bssid: The BSSID for this BSS
308 * @enable_beacon: whether beaconing should be enabled or not
Johannes Berg4bf88532012-11-09 11:39:59 +0100309 * @chandef: Channel definition for this BSS -- the hardware might be
310 * configured a higher bandwidth than this BSS uses, for example.
Johannes Berg074d46d2012-03-15 19:45:16 +0100311 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200312 * This field is only valid when the channel type is one of the HT types.
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200313 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
314 * implies disabled
315 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
Juuso Oikarinen68542962010-06-09 13:43:26 +0300316 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
317 * may filter ARP queries targeted for other addresses than listed here.
318 * The driver must allow ARP queries targeted for all address listed here
319 * to pass through. An empty list implies no ARP queries need to pass.
Johannes Berg0f19b412013-01-14 16:39:07 +0100320 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
321 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
322 * array size), it's up to the driver what to do in that case.
Johannes Berg4ced3f72010-07-19 16:39:04 +0200323 * @qos: This is a QoS-enabled BSS.
Johannes Berg7da7cc12010-08-05 17:02:38 +0200324 * @idle: This interface is idle. There's also a global idle flag in the
325 * hardware config which may be more appropriate depending on what
326 * your driver/device needs to do.
Eliad Pellerab095872012-07-27 12:33:22 +0300327 * @ps: power-save mode (STA only). This flag is NOT affected by
328 * offchannel/dynamic_ps operations.
Arik Nemtsov78274932011-09-04 11:11:32 +0300329 * @ssid: The SSID of the current vif. Only valid in AP-mode.
330 * @ssid_len: Length of SSID given in @ssid.
331 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
Johannes Berg1ea6f9c2012-10-24 10:59:25 +0200332 * @txpower: TX power in dBm
Johannes Berg488dd7b2012-10-29 20:08:01 +0100333 * @p2p_ctwindow: P2P CTWindow, only for P2P client interfaces
334 * @p2p_oppps: P2P opportunistic PS is enabled
Johannes Berg471b3ef2007-12-28 14:32:58 +0100335 */
336struct ieee80211_bss_conf {
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200337 const u8 *bssid;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100338 /* association related data */
Johannes Berg8fc214b2010-04-28 17:40:43 +0200339 bool assoc, ibss_joined;
Sujith Manoharanc13a7652012-10-12 17:35:45 +0530340 bool ibss_creator;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100341 u16 aid;
342 /* erp related data */
343 bool use_cts_prot;
344 bool use_short_preamble;
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300345 bool use_short_slot;
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200346 bool enable_beacon;
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800347 u8 dtim_period;
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700348 u16 beacon_int;
349 u16 assoc_capability;
Johannes Berg8c358bc2012-05-22 22:13:05 +0200350 u64 sync_tsf;
351 u32 sync_device_ts;
Johannes Bergef429da2013-02-05 17:48:40 +0100352 u8 sync_dtim_count;
Johannes Berg881d9482009-01-21 15:13:48 +0100353 u32 basic_rates;
Felix Fietkaudd5b4cc2010-11-22 20:58:24 +0100354 int mcast_rate[IEEE80211_NUM_BANDS];
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200355 u16 ht_operation_mode;
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200356 s32 cqm_rssi_thold;
357 u32 cqm_rssi_hyst;
Johannes Berg4bf88532012-11-09 11:39:59 +0100358 struct cfg80211_chan_def chandef;
Juuso Oikarinen68542962010-06-09 13:43:26 +0300359 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
Johannes Berg0f19b412013-01-14 16:39:07 +0100360 int arp_addr_cnt;
Johannes Berg4ced3f72010-07-19 16:39:04 +0200361 bool qos;
Johannes Berg7da7cc12010-08-05 17:02:38 +0200362 bool idle;
Eliad Pellerab095872012-07-27 12:33:22 +0300363 bool ps;
Arik Nemtsov78274932011-09-04 11:11:32 +0300364 u8 ssid[IEEE80211_MAX_SSID_LEN];
365 size_t ssid_len;
366 bool hidden_ssid;
Johannes Berg1ea6f9c2012-10-24 10:59:25 +0200367 int txpower;
Johannes Berg488dd7b2012-10-29 20:08:01 +0100368 u8 p2p_ctwindow;
369 bool p2p_oppps;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100370};
371
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800372/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700373 * enum mac80211_tx_control_flags - flags to describe transmission information/status
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800374 *
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700375 * These flags are used with the @flags member of &ieee80211_tx_info.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800376 *
Johannes Berg7351c6b2009-11-19 01:08:30 +0100377 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
Johannes Berge6a98542008-10-21 12:40:02 +0200378 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
379 * number to this frame, taking care of not overwriting the fragment
380 * number and increasing the sequence number only when the
381 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
382 * assign sequence numbers to QoS-data frames but cannot do so correctly
383 * for non-QoS-data and management frames because beacons need them from
384 * that counter as well and mac80211 cannot guarantee proper sequencing.
385 * If this flag is set, the driver should instruct the hardware to
386 * assign a sequence number to the frame or assign one itself. Cf. IEEE
387 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
388 * beacons and always be clear for frames without a sequence number field.
Johannes Berge039fa42008-05-15 12:55:29 +0200389 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
Johannes Berge039fa42008-05-15 12:55:29 +0200390 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
391 * station
Johannes Berge039fa42008-05-15 12:55:29 +0200392 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
Johannes Berge039fa42008-05-15 12:55:29 +0200393 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
394 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
Johannes Berge6a98542008-10-21 12:40:02 +0200395 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
Johannes Berge039fa42008-05-15 12:55:29 +0200396 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
Johannes Bergab5b5342009-08-07 16:28:09 +0200397 * because the destination STA was in powersave mode. Note that to
398 * avoid race conditions, the filter must be set by the hardware or
399 * firmware upon receiving a frame that indicates that the station
400 * went to sleep (must be done on device to filter frames already on
401 * the queue) and may only be unset after mac80211 gives the OK for
402 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
403 * since only then is it guaranteed that no more frames are in the
404 * hardware queue.
Johannes Berge039fa42008-05-15 12:55:29 +0200405 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
406 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
407 * is for the whole aggregation.
Ron Rindjunsky429a3802008-07-01 14:16:03 +0300408 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
409 * so consider using block ack request (BAR).
Johannes Berge6a98542008-10-21 12:40:02 +0200410 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
411 * set by rate control algorithms to indicate probe rate, will
412 * be cleared for fragmented frames (except on the last fragment)
Seth Forshee6c17b772013-02-11 11:21:07 -0600413 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
414 * that a frame can be transmitted while the queues are stopped for
415 * off-channel operation.
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100416 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
417 * used to indicate that a pending frame requires TX processing before
418 * it can be sent out.
Johannes Berg8f77f382009-06-07 21:58:37 +0200419 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
420 * used to indicate that a frame was already retried due to PS
Johannes Berg3b8d81e02009-06-17 17:43:56 +0200421 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
422 * used to indicate frame should not be encrypted
Johannes Berg02f2f1a2012-02-27 12:18:30 +0100423 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
424 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
425 * be sent although the station is in powersave mode.
Johannes Bergad5351d2009-08-07 16:42:15 +0200426 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
427 * transmit function after the current frame, this can be used
428 * by drivers to kick the DMA queue only if unset or when the
429 * queue gets full.
Johannes Bergc6fcf6b2010-01-17 01:47:59 +0100430 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
431 * after TX status because the destination was asleep, it must not
432 * be modified again (no seqno assignment, crypto, etc.)
Johannes Berg1672c0e32013-01-29 15:02:27 +0100433 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
434 * code for connection establishment, this indicates that its status
435 * should kick the MLME state machine.
Jouni Malinen026331c2010-02-15 12:53:10 +0200436 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
437 * MLME command (internal to mac80211 to figure out whether to send TX
438 * status to user space)
Luis R. Rodriguez0a56bd02010-04-15 17:39:37 -0400439 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
Felix Fietkauf79d9ba2010-04-19 19:57:35 +0200440 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
441 * frame and selects the maximum number of streams that it can use.
Johannes Berg610dbc92011-01-06 22:36:44 +0100442 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
443 * the off-channel channel when a remain-on-channel offload is done
444 * in hardware -- normal packets still flow and are expected to be
445 * handled properly by the device.
Jouni Malinen681d1192011-02-03 18:35:19 +0200446 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
447 * testing. It will be sent out with incorrect Michael MIC key to allow
448 * TKIP countermeasures to be tested.
Rajkumar Manoharanaad14ce2011-09-25 14:53:31 +0530449 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
450 * This flag is actually used for management frame especially for P2P
451 * frames not being sent at CCK rate in 2GHz band.
Johannes Berg47086fc2011-09-29 16:04:33 +0200452 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
453 * when its status is reported the service period ends. For frames in
454 * an SP that mac80211 transmits, it is already set; for driver frames
Johannes Bergdeeaee12011-09-29 16:04:35 +0200455 * the driver may set this flag. It is also used to do the same for
456 * PS-Poll responses.
Rajkumar Manoharanb6f35302011-09-29 20:34:04 +0530457 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
458 * This flag is used to send nullfunc frame at minimum rate when
459 * the nullfunc is used for connection monitoring purpose.
Johannes Berga26eb272011-10-07 14:01:25 +0200460 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
461 * would be fragmented by size (this is optional, only used for
462 * monitor injection).
Christian Lampartereb7d3062010-09-21 21:36:18 +0200463 *
464 * Note: If you have to add new flags to the enumeration, then don't
465 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800466 */
467enum mac80211_tx_control_flags {
Johannes Berge039fa42008-05-15 12:55:29 +0200468 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
Johannes Berge6a98542008-10-21 12:40:02 +0200469 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
470 IEEE80211_TX_CTL_NO_ACK = BIT(2),
471 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
472 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
473 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
474 IEEE80211_TX_CTL_AMPDU = BIT(6),
475 IEEE80211_TX_CTL_INJECTED = BIT(7),
476 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
477 IEEE80211_TX_STAT_ACK = BIT(9),
478 IEEE80211_TX_STAT_AMPDU = BIT(10),
479 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
480 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
Seth Forshee6c17b772013-02-11 11:21:07 -0600481 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100482 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
Johannes Berg8f77f382009-06-07 21:58:37 +0200483 IEEE80211_TX_INTFL_RETRIED = BIT(15),
Johannes Berg3b8d81e02009-06-17 17:43:56 +0200484 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
Johannes Berg02f2f1a2012-02-27 12:18:30 +0100485 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
Johannes Bergad5351d2009-08-07 16:42:15 +0200486 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
Johannes Bergc6fcf6b2010-01-17 01:47:59 +0100487 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
Johannes Berg1672c0e32013-01-29 15:02:27 +0100488 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
Jouni Malinen026331c2010-02-15 12:53:10 +0200489 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
Luis R. Rodriguez0a56bd02010-04-15 17:39:37 -0400490 IEEE80211_TX_CTL_LDPC = BIT(22),
Felix Fietkauf79d9ba2010-04-19 19:57:35 +0200491 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
Johannes Berg21f83582010-12-18 17:20:47 +0100492 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
Jouni Malinen681d1192011-02-03 18:35:19 +0200493 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
Rajkumar Manoharanaad14ce2011-09-25 14:53:31 +0530494 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
Johannes Berg47086fc2011-09-29 16:04:33 +0200495 IEEE80211_TX_STATUS_EOSP = BIT(28),
Rajkumar Manoharanb6f35302011-09-29 20:34:04 +0530496 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
Johannes Berga26eb272011-10-07 14:01:25 +0200497 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
Johannes Berge6a98542008-10-21 12:40:02 +0200498};
499
Johannes Bergabe37c42010-06-07 11:12:27 +0200500#define IEEE80211_TX_CTL_STBC_SHIFT 23
501
Christian Lampartereb7d3062010-09-21 21:36:18 +0200502/*
503 * This definition is used as a mask to clear all temporary flags, which are
504 * set by the tx handlers for each transmission attempt by the mac80211 stack.
505 */
506#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
507 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
508 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
509 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
510 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
Johannes Berg02f2f1a2012-02-27 12:18:30 +0100511 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
Christian Lampartereb7d3062010-09-21 21:36:18 +0200512 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
Johannes Berg47086fc2011-09-29 16:04:33 +0200513 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
Christian Lampartereb7d3062010-09-21 21:36:18 +0200514
Sujith2134e7e2009-01-22 09:00:52 +0530515/**
516 * enum mac80211_rate_control_flags - per-rate flags set by the
517 * Rate Control algorithm.
518 *
519 * These flags are set by the Rate control algorithm for each rate during tx,
520 * in the @flags member of struct ieee80211_tx_rate.
521 *
522 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
523 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
524 * This is set if the current BSS requires ERP protection.
525 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
526 * @IEEE80211_TX_RC_MCS: HT rate.
Johannes Berg8bc83c22012-11-09 18:38:32 +0100527 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
528 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
Sujith2134e7e2009-01-22 09:00:52 +0530529 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
530 * Greenfield mode.
531 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
Johannes Berg8bc83c22012-11-09 18:38:32 +0100532 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
533 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
534 * (80+80 isn't supported yet)
Sujith2134e7e2009-01-22 09:00:52 +0530535 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
536 * adjacent 20 MHz channels, if the current channel type is
537 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
538 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
539 */
Johannes Berge6a98542008-10-21 12:40:02 +0200540enum mac80211_rate_control_flags {
541 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
542 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
543 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
544
Johannes Berg8bc83c22012-11-09 18:38:32 +0100545 /* rate index is an HT/VHT MCS instead of an index */
Johannes Berge6a98542008-10-21 12:40:02 +0200546 IEEE80211_TX_RC_MCS = BIT(3),
547 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
548 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
549 IEEE80211_TX_RC_DUP_DATA = BIT(6),
550 IEEE80211_TX_RC_SHORT_GI = BIT(7),
Johannes Berg8bc83c22012-11-09 18:38:32 +0100551 IEEE80211_TX_RC_VHT_MCS = BIT(8),
552 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
553 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800554};
555
Johannes Berge039fa42008-05-15 12:55:29 +0200556
Johannes Berge6a98542008-10-21 12:40:02 +0200557/* there are 40 bytes if you don't need the rateset to be kept */
558#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
Johannes Berge039fa42008-05-15 12:55:29 +0200559
Johannes Berge6a98542008-10-21 12:40:02 +0200560/* if you do need the rateset, then you have less space */
561#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
562
563/* maximum number of rate stages */
Thomas Huehne3e1a0b2012-07-02 19:46:16 +0200564#define IEEE80211_TX_MAX_RATES 4
Felix Fietkau870abdf2008-10-05 18:04:24 +0200565
566/**
Johannes Berge6a98542008-10-21 12:40:02 +0200567 * struct ieee80211_tx_rate - rate selection/status
Felix Fietkau870abdf2008-10-05 18:04:24 +0200568 *
Johannes Berge6a98542008-10-21 12:40:02 +0200569 * @idx: rate index to attempt to send with
570 * @flags: rate control flags (&enum mac80211_rate_control_flags)
Johannes Berge25cf4a2008-10-23 08:51:20 +0200571 * @count: number of tries in this rate before going to the next rate
Johannes Berge6a98542008-10-21 12:40:02 +0200572 *
573 * A value of -1 for @idx indicates an invalid rate and, if used
574 * in an array of retry rates, that no more rates should be tried.
575 *
576 * When used for transmit status reporting, the driver should
577 * always report the rate along with the flags it used.
Johannes Bergc555b9b2009-08-07 16:23:43 +0200578 *
579 * &struct ieee80211_tx_info contains an array of these structs
580 * in the control information, and it will be filled by the rate
581 * control algorithm according to what should be sent. For example,
582 * if this array contains, in the format { <idx>, <count> } the
583 * information
584 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
585 * then this means that the frame should be transmitted
586 * up to twice at rate 3, up to twice at rate 2, and up to four
587 * times at rate 1 if it doesn't get acknowledged. Say it gets
588 * acknowledged by the peer after the fifth attempt, the status
589 * information should then contain
590 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
591 * since it was transmitted twice at rate 3, twice at rate 2
592 * and once at rate 1 after which we received an acknowledgement.
Felix Fietkau870abdf2008-10-05 18:04:24 +0200593 */
Johannes Berge6a98542008-10-21 12:40:02 +0200594struct ieee80211_tx_rate {
595 s8 idx;
Johannes Berg8bc83c22012-11-09 18:38:32 +0100596 u16 count:5,
597 flags:11;
Gustavo F. Padovan3f30fc12010-07-21 10:59:58 +0000598} __packed;
Felix Fietkau870abdf2008-10-05 18:04:24 +0200599
Johannes Berg8bc83c22012-11-09 18:38:32 +0100600#define IEEE80211_MAX_TX_RETRY 31
601
602static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
603 u8 mcs, u8 nss)
604{
605 WARN_ON(mcs & ~0xF);
606 WARN_ON(nss & ~0x7);
607 rate->idx = (nss << 4) | mcs;
608}
609
610static inline u8
611ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
612{
613 return rate->idx & 0xF;
614}
615
616static inline u8
617ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
618{
619 return rate->idx >> 4;
620}
621
Johannes Berge039fa42008-05-15 12:55:29 +0200622/**
623 * struct ieee80211_tx_info - skb transmit information
Ivo van Doorn1c014422008-04-17 19:41:02 +0200624 *
Johannes Berge039fa42008-05-15 12:55:29 +0200625 * This structure is placed in skb->cb for three uses:
626 * (1) mac80211 TX control - mac80211 tells the driver what to do
627 * (2) driver internal use (if applicable)
628 * (3) TX status information - driver tells mac80211 what happened
629 *
630 * @flags: transmit info flags, defined above
Johannes Berge6a98542008-10-21 12:40:02 +0200631 * @band: the band to transmit on (use for checking for races)
Johannes Berg3a25a8c2012-04-03 16:28:50 +0200632 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
Johannes Berga729cff2011-11-06 14:13:34 +0100633 * @ack_frame_id: internal frame ID for TX status, used internally
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700634 * @control: union for control data
635 * @status: union for status data
636 * @driver_data: array of driver_data pointers
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100637 * @ampdu_ack_len: number of acked aggregated frames.
Daniel Halperin93d95b12010-04-18 09:28:18 -0700638 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100639 * @ampdu_len: number of aggregated frames.
Daniel Halperin93d95b12010-04-18 09:28:18 -0700640 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
Johannes Berge039fa42008-05-15 12:55:29 +0200641 * @ack_signal: signal strength of the ACK frame
Ivo van Doorn1c014422008-04-17 19:41:02 +0200642 */
Johannes Berge039fa42008-05-15 12:55:29 +0200643struct ieee80211_tx_info {
644 /* common information */
645 u32 flags;
646 u8 band;
Johannes Berge6a98542008-10-21 12:40:02 +0200647
Johannes Berg3a25a8c2012-04-03 16:28:50 +0200648 u8 hw_queue;
Johannes Berg8318d782008-01-24 19:38:38 +0100649
Johannes Berga729cff2011-11-06 14:13:34 +0100650 u16 ack_frame_id;
Johannes Berg8318d782008-01-24 19:38:38 +0100651
Johannes Berge039fa42008-05-15 12:55:29 +0200652 union {
653 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200654 union {
655 /* rate control */
656 struct {
657 struct ieee80211_tx_rate rates[
658 IEEE80211_TX_MAX_RATES];
659 s8 rts_cts_rate_idx;
Thomas Huehn36323f82012-07-23 21:33:42 +0200660 /* 3 bytes free */
Johannes Berge6a98542008-10-21 12:40:02 +0200661 };
662 /* only needed before rate control */
663 unsigned long jiffies;
664 };
Johannes Berg25d834e2008-09-12 22:52:47 +0200665 /* NB: vif can be NULL for injected frames */
Johannes Berge039fa42008-05-15 12:55:29 +0200666 struct ieee80211_vif *vif;
667 struct ieee80211_key_conf *hw_key;
Thomas Huehn36323f82012-07-23 21:33:42 +0200668 /* 8 bytes free */
Johannes Berge039fa42008-05-15 12:55:29 +0200669 } control;
670 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200671 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
Johannes Berge039fa42008-05-15 12:55:29 +0200672 int ack_signal;
Thomas Huehne3e1a0b2012-07-02 19:46:16 +0200673 u8 ampdu_ack_len;
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100674 u8 ampdu_len;
Johannes Bergd748b462012-03-28 11:04:23 +0200675 u8 antenna;
Thomas Huehne3e1a0b2012-07-02 19:46:16 +0200676 /* 21 bytes free */
Johannes Berge039fa42008-05-15 12:55:29 +0200677 } status;
Johannes Berge6a98542008-10-21 12:40:02 +0200678 struct {
679 struct ieee80211_tx_rate driver_rates[
680 IEEE80211_TX_MAX_RATES];
681 void *rate_driver_data[
682 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
683 };
684 void *driver_data[
685 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
Johannes Berge039fa42008-05-15 12:55:29 +0200686 };
Jiri Bencf0706e82007-05-05 11:45:53 -0700687};
688
Luciano Coelho79f460c2011-05-11 17:09:36 +0300689/**
Randy Dunlapbdfbe802011-05-22 17:22:45 -0700690 * struct ieee80211_sched_scan_ies - scheduled scan IEs
Luciano Coelho79f460c2011-05-11 17:09:36 +0300691 *
692 * This structure is used to pass the appropriate IEs to be used in scheduled
693 * scans for all bands. It contains both the IEs passed from the userspace
694 * and the ones generated by mac80211.
695 *
696 * @ie: array with the IEs for each supported band
697 * @len: array with the total length of the IEs for each band
698 */
699struct ieee80211_sched_scan_ies {
700 u8 *ie[IEEE80211_NUM_BANDS];
701 size_t len[IEEE80211_NUM_BANDS];
702};
703
Johannes Berge039fa42008-05-15 12:55:29 +0200704static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
705{
706 return (struct ieee80211_tx_info *)skb->cb;
707}
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400708
Johannes Bergf1d58c22009-06-17 13:13:00 +0200709static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
710{
711 return (struct ieee80211_rx_status *)skb->cb;
712}
713
Johannes Berge6a98542008-10-21 12:40:02 +0200714/**
715 * ieee80211_tx_info_clear_status - clear TX status
716 *
717 * @info: The &struct ieee80211_tx_info to be cleared.
718 *
719 * When the driver passes an skb back to mac80211, it must report
720 * a number of things in TX status. This function clears everything
721 * in the TX status but the rate control information (it does clear
722 * the count since you need to fill that in anyway).
723 *
724 * NOTE: You can only use this function if you do NOT use
725 * info->driver_data! Use info->rate_driver_data
726 * instead if you need only the less space that allows.
727 */
728static inline void
729ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
730{
731 int i;
732
733 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
734 offsetof(struct ieee80211_tx_info, control.rates));
735 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
736 offsetof(struct ieee80211_tx_info, driver_rates));
737 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
738 /* clear the rate counts */
739 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
740 info->status.rates[i].count = 0;
741
742 BUILD_BUG_ON(
Thomas Huehne3e1a0b2012-07-02 19:46:16 +0200743 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
Johannes Berge6a98542008-10-21 12:40:02 +0200744 memset(&info->status.ampdu_ack_len, 0,
745 sizeof(struct ieee80211_tx_info) -
746 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
747}
748
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400749
750/**
751 * enum mac80211_rx_flags - receive flags
752 *
753 * These flags are used with the @flag member of &struct ieee80211_rx_status.
754 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
755 * Use together with %RX_FLAG_MMIC_STRIPPED.
756 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400757 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
758 * verification has been done by the hardware.
759 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
760 * If this flag is set, the stack cannot do any replay detection
761 * hence the driver or hardware will have to do that.
Johannes Berg72abd812007-09-17 01:29:22 -0400762 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
763 * the frame.
764 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
765 * the frame.
Thomas Pedersenf4bda332012-11-13 10:46:27 -0800766 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
Johannes Berg6ebacbb2011-02-23 15:06:08 +0100767 * field) is valid and contains the time the first symbol of the MPDU
768 * was received. This is useful in monitor mode and for proper IBSS
769 * merging.
Thomas Pedersenf4bda332012-11-13 10:46:27 -0800770 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
771 * field) is valid and contains the time the last symbol of the MPDU
772 * (including FCS) was received.
Bruno Randolfb4f28bb2008-07-30 17:19:55 +0200773 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200774 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
Johannes Berg56146182012-11-09 15:07:02 +0100775 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200776 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
Johannes Berg56146182012-11-09 15:07:02 +0100777 * @RX_FLAG_80MHZ: 80 MHz was used
778 * @RX_FLAG_80P80MHZ: 80+80 MHz was used
779 * @RX_FLAG_160MHZ: 160 MHz was used
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200780 * @RX_FLAG_SHORT_GI: Short guard interval was used
Felix Fietkaufe8431f2012-03-01 18:00:07 +0100781 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
782 * Valid only for data frames (mainly A-MPDU)
Johannes Bergac55d2f2012-05-10 09:09:10 +0200783 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
784 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
785 * to hw.radiotap_mcs_details to advertise that fact
Johannes Berg4c298672012-07-05 11:34:31 +0200786 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
787 * number (@ampdu_reference) must be populated and be a distinct number for
788 * each A-MPDU
789 * @RX_FLAG_AMPDU_REPORT_ZEROLEN: driver reports 0-length subframes
790 * @RX_FLAG_AMPDU_IS_ZEROLEN: This is a zero-length subframe, for
791 * monitoring purposes only
792 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
793 * subframes of a single A-MPDU
794 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
795 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
796 * on this subframe
797 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
798 * is stored in the @ampdu_delimiter_crc field)
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400799 */
800enum mac80211_rx_flags {
Johannes Berg4c298672012-07-05 11:34:31 +0200801 RX_FLAG_MMIC_ERROR = BIT(0),
802 RX_FLAG_DECRYPTED = BIT(1),
803 RX_FLAG_MMIC_STRIPPED = BIT(3),
804 RX_FLAG_IV_STRIPPED = BIT(4),
805 RX_FLAG_FAILED_FCS_CRC = BIT(5),
806 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
Thomas Pedersenf4bda332012-11-13 10:46:27 -0800807 RX_FLAG_MACTIME_START = BIT(7),
Johannes Berg4c298672012-07-05 11:34:31 +0200808 RX_FLAG_SHORTPRE = BIT(8),
809 RX_FLAG_HT = BIT(9),
810 RX_FLAG_40MHZ = BIT(10),
811 RX_FLAG_SHORT_GI = BIT(11),
812 RX_FLAG_NO_SIGNAL_VAL = BIT(12),
813 RX_FLAG_HT_GF = BIT(13),
814 RX_FLAG_AMPDU_DETAILS = BIT(14),
815 RX_FLAG_AMPDU_REPORT_ZEROLEN = BIT(15),
816 RX_FLAG_AMPDU_IS_ZEROLEN = BIT(16),
817 RX_FLAG_AMPDU_LAST_KNOWN = BIT(17),
818 RX_FLAG_AMPDU_IS_LAST = BIT(18),
819 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(19),
820 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(20),
Thomas Pedersenf4bda332012-11-13 10:46:27 -0800821 RX_FLAG_MACTIME_END = BIT(21),
Johannes Berg56146182012-11-09 15:07:02 +0100822 RX_FLAG_VHT = BIT(22),
823 RX_FLAG_80MHZ = BIT(23),
824 RX_FLAG_80P80MHZ = BIT(24),
825 RX_FLAG_160MHZ = BIT(25),
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400826};
827
828/**
829 * struct ieee80211_rx_status - receive status
830 *
831 * The low-level driver should provide this information (the subset
832 * supported by hardware) to the 802.11 code with each received
Johannes Bergf1d58c22009-06-17 13:13:00 +0200833 * frame, in the skb's control buffer (cb).
Bruno Randolf566bfe52008-05-08 19:15:40 +0200834 *
Bruno Randolfc132bec2008-02-18 11:20:51 +0900835 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
836 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
Johannes Berg8c358bc2012-05-22 22:13:05 +0200837 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
838 * it but can store it and pass it back to the driver for synchronisation
Johannes Berg8318d782008-01-24 19:38:38 +0100839 * @band: the active band when this frame was received
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400840 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
Bruno Randolf566bfe52008-05-08 19:15:40 +0200841 * @signal: signal strength when receiving this frame, either in dBm, in dB or
842 * unspecified depending on the hardware capabilities flags
843 * @IEEE80211_HW_SIGNAL_*
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400844 * @antenna: antenna used
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200845 * @rate_idx: index of data rate into band's supported rates or MCS index if
Johannes Berg56146182012-11-09 15:07:02 +0100846 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
847 * @vht_nss: number of streams (VHT only)
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400848 * @flag: %RX_FLAG_*
Johannes Berg554891e2010-09-24 12:38:25 +0200849 * @rx_flags: internal RX flags for mac80211
Johannes Berg4c298672012-07-05 11:34:31 +0200850 * @ampdu_reference: A-MPDU reference number, must be a different value for
851 * each A-MPDU but the same for each subframe within one A-MPDU
852 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
Johannes Berg90b9e4462012-11-16 10:09:08 +0100853 * @vendor_radiotap_bitmap: radiotap vendor namespace presence bitmap
854 * @vendor_radiotap_len: radiotap vendor namespace length
855 * @vendor_radiotap_align: radiotap vendor namespace alignment. Note
856 * that the actual data must be at the start of the SKB data
857 * already.
858 * @vendor_radiotap_oui: radiotap vendor namespace OUI
859 * @vendor_radiotap_subns: radiotap vendor sub namespace
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400860 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700861struct ieee80211_rx_status {
862 u64 mactime;
Johannes Berg8c358bc2012-05-22 22:13:05 +0200863 u32 device_timestamp;
Johannes Berg4c298672012-07-05 11:34:31 +0200864 u32 ampdu_reference;
865 u32 flag;
Johannes Berg90b9e4462012-11-16 10:09:08 +0100866 u32 vendor_radiotap_bitmap;
867 u16 vendor_radiotap_len;
Johannes Berg30f42292012-07-05 13:14:18 +0200868 u16 freq;
869 u8 rate_idx;
Johannes Berg56146182012-11-09 15:07:02 +0100870 u8 vht_nss;
Johannes Berg30f42292012-07-05 13:14:18 +0200871 u8 rx_flags;
872 u8 band;
873 u8 antenna;
874 s8 signal;
Johannes Berg4c298672012-07-05 11:34:31 +0200875 u8 ampdu_delimiter_crc;
Johannes Berg90b9e4462012-11-16 10:09:08 +0100876 u8 vendor_radiotap_align;
877 u8 vendor_radiotap_oui[3];
878 u8 vendor_radiotap_subns;
Jiri Bencf0706e82007-05-05 11:45:53 -0700879};
880
Johannes Berg6b301cd2007-09-18 17:29:20 -0400881/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400882 * enum ieee80211_conf_flags - configuration flags
883 *
884 * Flags to define PHY configuration options
885 *
Johannes Berg0869aea2009-10-28 10:03:35 +0100886 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
887 * to determine for example whether to calculate timestamps for packets
888 * or not, do not use instead of filter flags!
Kalle Valoc99445b2010-01-14 13:09:21 +0200889 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
890 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
891 * meaning that the hardware still wakes up for beacons, is able to
892 * transmit frames and receive the possible acknowledgment frames.
893 * Not to be confused with hardware specific wakeup/sleep states,
894 * driver is responsible for that. See the section "Powersave support"
895 * for more.
Johannes Berg5cff20e2009-04-29 12:26:17 +0200896 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
897 * the driver should be prepared to handle configuration requests but
898 * may turn the device off as much as possible. Typically, this flag will
899 * be set when an interface is set UP but not associated or scanning, but
900 * it can also be unset in that case when monitor interfaces are active.
Felix Fietkau45521242010-07-28 02:40:49 +0200901 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
902 * operating channel.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400903 */
904enum ieee80211_conf_flags {
Johannes Berg0869aea2009-10-28 10:03:35 +0100905 IEEE80211_CONF_MONITOR = (1<<0),
Johannes Bergae5eb022008-10-14 16:58:37 +0200906 IEEE80211_CONF_PS = (1<<1),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200907 IEEE80211_CONF_IDLE = (1<<2),
Felix Fietkau45521242010-07-28 02:40:49 +0200908 IEEE80211_CONF_OFFCHANNEL = (1<<3),
Johannes Berg6b301cd2007-09-18 17:29:20 -0400909};
Jiri Bencf0706e82007-05-05 11:45:53 -0700910
Johannes Berg7a5158e2008-10-08 10:59:33 +0200911
Jiri Bencf0706e82007-05-05 11:45:53 -0700912/**
Johannes Berge8975582008-10-09 12:18:51 +0200913 * enum ieee80211_conf_changed - denotes which configuration changed
914 *
Johannes Berge8975582008-10-09 12:18:51 +0200915 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
Johannes Berg0869aea2009-10-28 10:03:35 +0100916 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
Johannes Berge255d5e2009-04-22 12:40:07 +0200917 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
Johannes Berge8975582008-10-09 12:18:51 +0200918 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
Johannes Berg47979382009-01-07 10:13:27 +0100919 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
Johannes Berg9124b072008-10-14 19:17:54 +0200920 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
Johannes Berg5cff20e2009-04-29 12:26:17 +0200921 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
Johannes Berg0f782312009-12-01 13:37:02 +0100922 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
Johannes Berg04ecd252012-09-11 14:34:12 +0200923 * Note that this is only valid if channel contexts are not used,
924 * otherwise each channel context has the number of chains listed.
Johannes Berge8975582008-10-09 12:18:51 +0200925 */
926enum ieee80211_conf_changed {
Johannes Berg0f782312009-12-01 13:37:02 +0100927 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
Johannes Berge8975582008-10-09 12:18:51 +0200928 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
Johannes Berg0869aea2009-10-28 10:03:35 +0100929 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
Johannes Berge8975582008-10-09 12:18:51 +0200930 IEEE80211_CONF_CHANGE_PS = BIT(4),
Johannes Berge255d5e2009-04-22 12:40:07 +0200931 IEEE80211_CONF_CHANGE_POWER = BIT(5),
932 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
933 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200934 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
Johannes Berge8975582008-10-09 12:18:51 +0200935};
936
937/**
Johannes Berg0f782312009-12-01 13:37:02 +0100938 * enum ieee80211_smps_mode - spatial multiplexing power save mode
939 *
Kalle Valo9d173fc2010-01-14 13:09:14 +0200940 * @IEEE80211_SMPS_AUTOMATIC: automatic
941 * @IEEE80211_SMPS_OFF: off
942 * @IEEE80211_SMPS_STATIC: static
943 * @IEEE80211_SMPS_DYNAMIC: dynamic
944 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
Johannes Berg0f782312009-12-01 13:37:02 +0100945 */
946enum ieee80211_smps_mode {
947 IEEE80211_SMPS_AUTOMATIC,
948 IEEE80211_SMPS_OFF,
949 IEEE80211_SMPS_STATIC,
950 IEEE80211_SMPS_DYNAMIC,
951
952 /* keep last */
953 IEEE80211_SMPS_NUM_MODES,
954};
955
956/**
Jiri Bencf0706e82007-05-05 11:45:53 -0700957 * struct ieee80211_conf - configuration of the device
958 *
959 * This struct indicates how the driver shall configure the hardware.
960 *
Johannes Berg04fe2032009-04-22 18:44:37 +0200961 * @flags: configuration flags defined above
962 *
Tomas Winklerea95bba2008-07-18 13:53:00 +0800963 * @listen_interval: listen interval in units of beacon interval
Johannes Berg9ccebe62009-04-23 10:32:36 +0200964 * @max_sleep_period: the maximum number of beacon intervals to sleep for
Johannes Berg04fe2032009-04-22 18:44:37 +0200965 * before checking the beacon for a TIM bit (managed mode only); this
966 * value will be only achievable between DTIM frames, the hardware
967 * needs to check for the multicast traffic bit in DTIM beacons.
968 * This variable is valid only when the CONF_PS flag is set.
Johannes Berg56007a02010-01-26 14:19:52 +0100969 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
970 * in power saving. Power saving will not be enabled until a beacon
971 * has been received and the DTIM period is known.
Johannes Berg04fe2032009-04-22 18:44:37 +0200972 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
973 * powersave documentation below. This variable is valid only when
974 * the CONF_PS flag is set.
975 *
Johannes Berg1ea6f9c2012-10-24 10:59:25 +0200976 * @power_level: requested transmit power (in dBm), backward compatibility
977 * value only that is set to the minimum of all interfaces
Johannes Berg04fe2032009-04-22 18:44:37 +0200978 *
Johannes Berg8318d782008-01-24 19:38:38 +0100979 * @channel: the channel to tune to
Johannes Berg47979382009-01-07 10:13:27 +0100980 * @channel_type: the channel (HT) type
Simon Wunderlich164eb022013-02-08 18:16:20 +0100981 * @radar_enabled: whether radar detection is enabled
Johannes Berg04fe2032009-04-22 18:44:37 +0200982 *
Johannes Berg9124b072008-10-14 19:17:54 +0200983 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
984 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
985 * but actually means the number of transmissions not the number of retries
986 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
987 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
988 * number of transmissions not the number of retries
Johannes Berg0f782312009-12-01 13:37:02 +0100989 *
990 * @smps_mode: spatial multiplexing powersave mode; note that
991 * %IEEE80211_SMPS_STATIC is used when the device is not
Johannes Berg04ecd252012-09-11 14:34:12 +0200992 * configured for an HT channel.
993 * Note that this is only valid if channel contexts are not used,
994 * otherwise each channel context has the number of chains listed.
Jiri Bencf0706e82007-05-05 11:45:53 -0700995 */
996struct ieee80211_conf {
Johannes Berg6b301cd2007-09-18 17:29:20 -0400997 u32 flags;
Juuso Oikarinenff616382010-06-09 09:51:52 +0300998 int power_level, dynamic_ps_timeout;
Johannes Berg9ccebe62009-04-23 10:32:36 +0200999 int max_sleep_period;
Ron Rindjunsky10816d42007-11-26 16:14:30 +02001000
Johannes Berge8975582008-10-09 12:18:51 +02001001 u16 listen_interval;
Johannes Berg56007a02010-01-26 14:19:52 +01001002 u8 ps_dtim_period;
Johannes Berge8975582008-10-09 12:18:51 +02001003
Johannes Berg9124b072008-10-14 19:17:54 +02001004 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1005
Johannes Berg8318d782008-01-24 19:38:38 +01001006 struct ieee80211_channel *channel;
Johannes Berg47979382009-01-07 10:13:27 +01001007 enum nl80211_channel_type channel_type;
Simon Wunderlich164eb022013-02-08 18:16:20 +01001008 bool radar_enabled;
Johannes Berg0f782312009-12-01 13:37:02 +01001009 enum ieee80211_smps_mode smps_mode;
Jiri Bencf0706e82007-05-05 11:45:53 -07001010};
1011
1012/**
Johannes Berg5ce6e432010-05-11 16:20:57 +02001013 * struct ieee80211_channel_switch - holds the channel switch data
1014 *
1015 * The information provided in this structure is required for channel switch
1016 * operation.
1017 *
1018 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1019 * Function (TSF) timer when the frame containing the channel switch
1020 * announcement was received. This is simply the rx.mactime parameter
1021 * the driver passed into mac80211.
1022 * @block_tx: Indicates whether transmission must be blocked before the
1023 * scheduled channel switch, as indicated by the AP.
1024 * @channel: the new channel to switch to
1025 * @count: the number of TBTT's until the channel switch event
1026 */
1027struct ieee80211_channel_switch {
1028 u64 timestamp;
1029 bool block_tx;
1030 struct ieee80211_channel *channel;
1031 u8 count;
1032};
1033
1034/**
Johannes Bergc1288b12012-01-19 09:29:57 +01001035 * enum ieee80211_vif_flags - virtual interface flags
1036 *
1037 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1038 * on this virtual interface to avoid unnecessary CPU wakeups
Johannes Bergea086352012-01-19 09:29:58 +01001039 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1040 * monitoring on this virtual interface -- i.e. it can monitor
1041 * connection quality related parameters, such as the RSSI level and
1042 * provide notifications if configured trigger levels are reached.
Johannes Bergc1288b12012-01-19 09:29:57 +01001043 */
1044enum ieee80211_vif_flags {
1045 IEEE80211_VIF_BEACON_FILTER = BIT(0),
Johannes Bergea086352012-01-19 09:29:58 +01001046 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
Johannes Bergc1288b12012-01-19 09:29:57 +01001047};
1048
1049/**
Johannes Berg32bfd352007-12-19 01:31:26 +01001050 * struct ieee80211_vif - per-interface data
1051 *
1052 * Data in this structure is continually present for driver
1053 * use during the life of a virtual interface.
1054 *
Johannes Berg51fb61e2007-12-19 01:31:27 +01001055 * @type: type of this virtual interface
Johannes Bergbda39332008-10-11 01:51:51 +02001056 * @bss_conf: BSS configuration for this interface, either our own
1057 * or the BSS we're associated to
Johannes Berg47846c92009-11-25 17:46:19 +01001058 * @addr: address of this interface
Johannes Berg2ca27bc2010-09-16 14:58:23 +02001059 * @p2p: indicates whether this AP or STA interface is a p2p
1060 * interface, i.e. a GO or p2p-sta respectively
Johannes Bergc1288b12012-01-19 09:29:57 +01001061 * @driver_flags: flags/capabilities the driver has for this interface,
1062 * these need to be set (or cleared) when the interface is added
1063 * or, if supported by the driver, the interface type is changed
1064 * at runtime, mac80211 will never touch this field
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001065 * @hw_queue: hardware queue for each AC
1066 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
Michal Kaziord01a1e62012-06-26 14:37:16 +02001067 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1068 * when it is not assigned. This pointer is RCU-protected due to the TX
1069 * path needing to access it; even though the netdev carrier will always
1070 * be off when it is %NULL there can still be races and packets could be
1071 * processed after it switches back to %NULL.
Stanislaw Gruszkaddbfe862013-03-08 14:46:14 +01001072 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1073 * interface debug files. Note that it will be NULL for the virtual
1074 * monitor interface (if that is requested.)
Johannes Berg32bfd352007-12-19 01:31:26 +01001075 * @drv_priv: data area for driver use, will always be aligned to
1076 * sizeof(void *).
1077 */
1078struct ieee80211_vif {
Johannes Berg05c914f2008-09-11 00:01:58 +02001079 enum nl80211_iftype type;
Johannes Bergbda39332008-10-11 01:51:51 +02001080 struct ieee80211_bss_conf bss_conf;
Johannes Berg47846c92009-11-25 17:46:19 +01001081 u8 addr[ETH_ALEN];
Johannes Berg2ca27bc2010-09-16 14:58:23 +02001082 bool p2p;
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001083
1084 u8 cab_queue;
1085 u8 hw_queue[IEEE80211_NUM_ACS];
1086
Michal Kaziord01a1e62012-06-26 14:37:16 +02001087 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1088
Johannes Bergc1288b12012-01-19 09:29:57 +01001089 u32 driver_flags;
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001090
Stanislaw Gruszkaddbfe862013-03-08 14:46:14 +01001091#ifdef CONFIG_MAC80211_DEBUGFS
1092 struct dentry *debugfs_dir;
1093#endif
1094
Johannes Berg32bfd352007-12-19 01:31:26 +01001095 /* must be last */
Johannes Berg1c06ef92012-12-28 12:22:02 +01001096 u8 drv_priv[0] __aligned(sizeof(void *));
Johannes Berg32bfd352007-12-19 01:31:26 +01001097};
1098
Johannes Berg902acc72008-02-23 15:17:19 +01001099static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1100{
1101#ifdef CONFIG_MAC80211_MESH
Johannes Berg05c914f2008-09-11 00:01:58 +02001102 return vif->type == NL80211_IFTYPE_MESH_POINT;
Johannes Berg902acc72008-02-23 15:17:19 +01001103#endif
1104 return false;
1105}
1106
Johannes Berg32bfd352007-12-19 01:31:26 +01001107/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001108 * enum ieee80211_key_flags - key flags
1109 *
1110 * These flags are used for communication about keys between the driver
1111 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1112 *
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001113 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1114 * driver to indicate that it requires IV generation for this
1115 * particular key.
1116 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1117 * the driver for a TKIP key if it requires Michael MIC
1118 * generation in software.
Ivo van Doornc6adbd22008-04-17 21:11:18 +02001119 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1120 * that the key is pairwise rather then a shared key.
Johannes Berge548c492012-09-04 17:08:23 +02001121 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
Jouni Malinen1f7d77a2009-01-08 13:32:10 +02001122 * CCMP key if it requires CCMP encryption of management frames (MFP) to
1123 * be done in software.
Arik Nemtsov077a9152011-10-23 08:21:41 +02001124 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
Janusz.Dziedzic@tieto.comee701082012-05-09 08:11:20 +03001125 * if space should be prepared for the IV, but the IV
Arik Nemtsov077a9152011-10-23 08:21:41 +02001126 * itself should not be generated. Do not set together with
1127 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key.
Johannes Berge548c492012-09-04 17:08:23 +02001128 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1129 * management frames. The flag can help drivers that have a hardware
1130 * crypto implementation that doesn't deal with management frames
1131 * properly by allowing them to not upload the keys to hardware and
1132 * fall back to software crypto. Note that this flag deals only with
1133 * RX, if your crypto engine can't deal with TX you can also set the
1134 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001135 */
1136enum ieee80211_key_flags {
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001137 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
1138 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
Ivo van Doornc6adbd22008-04-17 21:11:18 +02001139 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
Johannes Berge548c492012-09-04 17:08:23 +02001140 IEEE80211_KEY_FLAG_SW_MGMT_TX = 1<<4,
Arik Nemtsov077a9152011-10-23 08:21:41 +02001141 IEEE80211_KEY_FLAG_PUT_IV_SPACE = 1<<5,
Johannes Berge548c492012-09-04 17:08:23 +02001142 IEEE80211_KEY_FLAG_RX_MGMT = 1<<6,
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001143};
1144
1145/**
1146 * struct ieee80211_key_conf - key information
1147 *
1148 * This key information is given by mac80211 to the driver by
1149 * the set_key() callback in &struct ieee80211_ops.
1150 *
1151 * @hw_key_idx: To be set by the driver, this is the key index the driver
1152 * wants to be given when a frame is transmitted and needs to be
Johannes Berg6a7664d2007-09-14 11:10:25 -04001153 * encrypted in hardware.
Johannes Berg97359d12010-08-10 09:46:38 +02001154 * @cipher: The key's cipher suite selector.
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001155 * @flags: key flags, see &enum ieee80211_key_flags.
1156 * @keyidx: the key index (0-3)
1157 * @keylen: key material length
Luis R. Rodriguezffd78912008-06-21 10:02:46 -04001158 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1159 * data block:
1160 * - Temporal Encryption Key (128 bits)
1161 * - Temporal Authenticator Tx MIC Key (64 bits)
1162 * - Temporal Authenticator Rx MIC Key (64 bits)
Johannes Bergdc822b52008-12-29 12:55:09 +01001163 * @icv_len: The ICV length for this key type
1164 * @iv_len: The IV length for this key type
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001165 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001166struct ieee80211_key_conf {
Johannes Berg97359d12010-08-10 09:46:38 +02001167 u32 cipher;
Felix Fietkau76708de2008-10-05 18:02:48 +02001168 u8 icv_len;
1169 u8 iv_len;
Johannes Berg6a7664d2007-09-14 11:10:25 -04001170 u8 hw_key_idx;
Johannes Berg11a843b2007-08-28 17:01:55 -04001171 u8 flags;
Johannes Berg11a843b2007-08-28 17:01:55 -04001172 s8 keyidx;
Johannes Berg11a843b2007-08-28 17:01:55 -04001173 u8 keylen;
Jiri Bencf0706e82007-05-05 11:45:53 -07001174 u8 key[0];
1175};
1176
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001177/**
1178 * enum set_key_cmd - key command
1179 *
1180 * Used with the set_key() callback in &struct ieee80211_ops, this
1181 * indicates whether a key is being removed or added.
1182 *
1183 * @SET_KEY: a key is set
1184 * @DISABLE_KEY: a key must be disabled
1185 */
Johannes Bergea49c352007-09-18 17:29:21 -04001186enum set_key_cmd {
Johannes Berg11a843b2007-08-28 17:01:55 -04001187 SET_KEY, DISABLE_KEY,
Johannes Bergea49c352007-09-18 17:29:21 -04001188};
Jiri Bencf0706e82007-05-05 11:45:53 -07001189
Tomas Winkler478f8d22007-09-30 13:52:37 +02001190/**
Johannes Bergf09603a2012-01-20 13:55:21 +01001191 * enum ieee80211_sta_state - station state
1192 *
1193 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1194 * this is a special state for add/remove transitions
1195 * @IEEE80211_STA_NONE: station exists without special state
1196 * @IEEE80211_STA_AUTH: station is authenticated
1197 * @IEEE80211_STA_ASSOC: station is associated
1198 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1199 */
1200enum ieee80211_sta_state {
1201 /* NOTE: These need to be ordered correctly! */
1202 IEEE80211_STA_NOTEXIST,
1203 IEEE80211_STA_NONE,
1204 IEEE80211_STA_AUTH,
1205 IEEE80211_STA_ASSOC,
1206 IEEE80211_STA_AUTHORIZED,
1207};
1208
1209/**
Johannes Berge1a0c6b2013-02-07 11:47:44 +01001210 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1211 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1212 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1213 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1214 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1215 * (including 80+80 MHz)
1216 *
1217 * Implementation note: 20 must be zero to be initialized
1218 * correctly, the values must be sorted.
1219 */
1220enum ieee80211_sta_rx_bandwidth {
1221 IEEE80211_STA_RX_BW_20 = 0,
1222 IEEE80211_STA_RX_BW_40,
1223 IEEE80211_STA_RX_BW_80,
1224 IEEE80211_STA_RX_BW_160,
1225};
1226
1227/**
Johannes Berg17741cd2008-09-11 00:02:02 +02001228 * struct ieee80211_sta - station table entry
1229 *
1230 * A station table entry represents a station we are possibly
1231 * communicating with. Since stations are RCU-managed in
1232 * mac80211, any ieee80211_sta pointer you get access to must
1233 * either be protected by rcu_read_lock() explicitly or implicitly,
1234 * or you must take good care to not use such a pointer after a
Johannes Berg34e89502010-02-03 13:59:58 +01001235 * call to your sta_remove callback that removed it.
Johannes Berg17741cd2008-09-11 00:02:02 +02001236 *
1237 * @addr: MAC address
1238 * @aid: AID we assigned to the station if we're an AP
Johannes Berg323ce792008-09-11 02:45:11 +02001239 * @supp_rates: Bitmap of supported rates (per band)
Johannes Berg55d942f2013-03-01 13:07:48 +01001240 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1241 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
Arik Nemtsov39df6002011-06-27 23:58:45 +03001242 * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
Johannes Berg17741cd2008-09-11 00:02:02 +02001243 * @drv_priv: data area for driver use, will always be aligned to
1244 * sizeof(void *), size is determined in hw information.
Eliad Peller910868d2011-09-11 09:46:55 +03001245 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1246 * if wme is supported.
1247 * @max_sp: max Service Period. Only valid if wme is supported.
Johannes Berge1a0c6b2013-02-07 11:47:44 +01001248 * @bandwidth: current bandwidth the station can receive with
Johannes Berg8921d042012-12-27 18:26:42 +01001249 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1250 * station can receive at the moment, changed by operating mode
1251 * notifications and capabilities. The value is only valid after
1252 * the station moves to associated state.
Johannes Bergaf0ed692013-02-12 14:21:00 +01001253 * @smps_mode: current SMPS mode (off, static or dynamic)
Johannes Berg17741cd2008-09-11 00:02:02 +02001254 */
1255struct ieee80211_sta {
Johannes Berg881d9482009-01-21 15:13:48 +01001256 u32 supp_rates[IEEE80211_NUM_BANDS];
Johannes Berg17741cd2008-09-11 00:02:02 +02001257 u8 addr[ETH_ALEN];
1258 u16 aid;
Johannes Bergd9fe60d2008-10-09 12:13:49 +02001259 struct ieee80211_sta_ht_cap ht_cap;
Mahesh Palivela818255e2012-10-10 11:33:04 +00001260 struct ieee80211_sta_vht_cap vht_cap;
Arik Nemtsov39df6002011-06-27 23:58:45 +03001261 bool wme;
Eliad Peller9533b4a2011-08-23 14:37:47 +03001262 u8 uapsd_queues;
1263 u8 max_sp;
Johannes Berg8921d042012-12-27 18:26:42 +01001264 u8 rx_nss;
Johannes Berge1a0c6b2013-02-07 11:47:44 +01001265 enum ieee80211_sta_rx_bandwidth bandwidth;
Johannes Bergaf0ed692013-02-12 14:21:00 +01001266 enum ieee80211_smps_mode smps_mode;
Johannes Berg17741cd2008-09-11 00:02:02 +02001267
1268 /* must be last */
Johannes Berg1c06ef92012-12-28 12:22:02 +01001269 u8 drv_priv[0] __aligned(sizeof(void *));
Johannes Berg17741cd2008-09-11 00:02:02 +02001270};
1271
1272/**
Tomas Winkler478f8d22007-09-30 13:52:37 +02001273 * enum sta_notify_cmd - sta notify command
1274 *
1275 * Used with the sta_notify() callback in &struct ieee80211_ops, this
Sujith38a6cc72010-05-19 11:32:30 +05301276 * indicates if an associated station made a power state transition.
Tomas Winkler478f8d22007-09-30 13:52:37 +02001277 *
Christian Lamparter4571d3b2008-11-30 00:48:41 +01001278 * @STA_NOTIFY_SLEEP: a station is now sleeping
1279 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1280 */
Christian Lamparter89fad572008-12-09 16:28:06 +01001281enum sta_notify_cmd {
Christian Lamparter4571d3b2008-11-30 00:48:41 +01001282 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1283};
1284
1285/**
Thomas Huehn36323f82012-07-23 21:33:42 +02001286 * struct ieee80211_tx_control - TX control data
1287 *
1288 * @sta: station table entry, this sta pointer may be NULL and
1289 * it is not allowed to copy the pointer, due to RCU.
1290 */
1291struct ieee80211_tx_control {
1292 struct ieee80211_sta *sta;
1293};
1294
1295/**
Johannes Berg1bc08262007-09-18 17:29:15 -04001296 * enum ieee80211_hw_flags - hardware flags
1297 *
1298 * These flags are used to indicate hardware capabilities to
1299 * the stack. Generally, flags here should have their meaning
1300 * done in a way that the simplest hardware doesn't need setting
1301 * any particular flags. There are some exceptions to this rule,
1302 * however, so you are advised to review these flags carefully.
1303 *
Johannes Bergaf65cd962009-11-17 18:18:36 +01001304 * @IEEE80211_HW_HAS_RATE_CONTROL:
1305 * The hardware or firmware includes rate control, and cannot be
1306 * controlled by the stack. As such, no rate control algorithm
1307 * should be instantiated, and the TX rate reported to userspace
1308 * will be taken from the TX status instead of the rate control
1309 * algorithm.
1310 * Note that this requires that the driver implement a number of
1311 * callbacks so it has the correct information, it needs to have
1312 * the @set_rts_threshold callback and must look at the BSS config
1313 * @use_cts_prot for G/N protection, @use_short_slot for slot
1314 * timing in 2.4 GHz and @use_short_preamble for preambles for
1315 * CCK frames.
1316 *
Johannes Berg1bc08262007-09-18 17:29:15 -04001317 * @IEEE80211_HW_RX_INCLUDES_FCS:
1318 * Indicates that received frames passed to the stack include
1319 * the FCS at the end.
1320 *
1321 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1322 * Some wireless LAN chipsets buffer broadcast/multicast frames
1323 * for power saving stations in the hardware/firmware and others
1324 * rely on the host system for such buffering. This option is used
1325 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1326 * multicast frames when there are power saving stations so that
Luis R. Rodriguez546c80c92008-08-14 11:43:20 -07001327 * the driver can fetch them with ieee80211_get_buffered_bc().
Johannes Berg1bc08262007-09-18 17:29:15 -04001328 *
Johannes Berg8318d782008-01-24 19:38:38 +01001329 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1330 * Hardware is not capable of short slot operation on the 2.4 GHz band.
1331 *
1332 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1333 * Hardware is not capable of receiving frames with short preamble on
1334 * the 2.4 GHz band.
Bruno Randolf566bfe52008-05-08 19:15:40 +02001335 *
1336 * @IEEE80211_HW_SIGNAL_UNSPEC:
1337 * Hardware can provide signal values but we don't know its units. We
1338 * expect values between 0 and @max_signal.
1339 * If possible please provide dB or dBm instead.
1340 *
Bruno Randolf566bfe52008-05-08 19:15:40 +02001341 * @IEEE80211_HW_SIGNAL_DBM:
1342 * Hardware gives signal values in dBm, decibel difference from
1343 * one milliwatt. This is the preferred method since it is standardized
1344 * between different devices. @max_signal does not need to be set.
1345 *
Tomas Winkler06ff47b2008-06-18 17:53:44 +03001346 * @IEEE80211_HW_SPECTRUM_MGMT:
1347 * Hardware supports spectrum management defined in 802.11h
1348 * Measurement, Channel Switch, Quieting, TPC
Sujith8b30b1f2008-10-24 09:55:27 +05301349 *
1350 * @IEEE80211_HW_AMPDU_AGGREGATION:
1351 * Hardware supports 11n A-MPDU aggregation.
Kalle Valo520eb822008-12-18 23:35:27 +02001352 *
Johannes Berg4be8c382009-01-07 18:28:20 +01001353 * @IEEE80211_HW_SUPPORTS_PS:
1354 * Hardware has power save support (i.e. can go to sleep).
1355 *
1356 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1357 * Hardware requires nullfunc frame handling in stack, implies
1358 * stack support for dynamic PS.
1359 *
1360 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1361 * Hardware has support for dynamic PS.
Jouni Malinen4375d082009-01-08 13:32:11 +02001362 *
1363 * @IEEE80211_HW_MFP_CAPABLE:
1364 * Hardware supports management frame protection (MFP, IEEE 802.11w).
Kalle Valo04de8382009-03-22 21:57:35 +02001365 *
Johannes Berg0f782312009-12-01 13:37:02 +01001366 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1367 * Hardware supports static spatial multiplexing powersave,
1368 * ie. can turn off all but one chain even on HT connections
1369 * that should be using more chains.
1370 *
1371 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1372 * Hardware supports dynamic spatial multiplexing powersave,
1373 * ie. can turn off all but one chain and then wake the rest
1374 * up as required after, for example, rts/cts handshake.
Kalle Valoab133152010-01-12 10:42:31 +02001375 *
1376 * @IEEE80211_HW_SUPPORTS_UAPSD:
1377 * Hardware supports Unscheduled Automatic Power Save Delivery
1378 * (U-APSD) in managed mode. The mode is configured with
1379 * conf_tx() operation.
Vivek Natarajan375177b2010-02-09 14:50:28 +05301380 *
1381 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1382 * Hardware can provide ack status reports of Tx frames to
1383 * the stack.
1384 *
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02001385 * @IEEE80211_HW_CONNECTION_MONITOR:
1386 * The hardware performs its own connection monitoring, including
1387 * periodic keep-alives to the AP and probing the AP on beacon loss.
1388 * When this flag is set, signaling beacon-loss will cause an immediate
1389 * change to disassociated state.
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02001390 *
Emmanuel Grumbachc65dd142012-12-12 10:12:24 +02001391 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1392 * This device needs to get data from beacon before association (i.e.
1393 * dtim_period).
Johannes Berge31b8212010-10-05 19:39:30 +02001394 *
1395 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1396 * per-station GTKs as used by IBSS RSN or during fast transition. If
1397 * the device doesn't support per-station GTKs, but can be asked not
1398 * to decrypt group addressed frames, then IBSS RSN support is still
1399 * possible but software crypto will be used. Advertise the wiphy flag
1400 * only in that case.
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02001401 *
1402 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1403 * autonomously manages the PS status of connected stations. When
1404 * this flag is set mac80211 will not trigger PS mode for connected
1405 * stations based on the PM bit of incoming frames.
1406 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1407 * the PS mode of connected stations.
Arik Nemtsovedf6b782011-08-30 09:32:38 +03001408 *
1409 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1410 * setup strictly in HW. mac80211 should not attempt to do this in
1411 * software.
Eliad Peller885bd8e2012-02-02 17:44:55 +02001412 *
Johannes Berg4b6f1dd2012-04-03 14:35:57 +02001413 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1414 * a virtual monitor interface when monitor interfaces are the only
1415 * active interfaces.
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001416 *
1417 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1418 * queue mapping in order to use different queues (not just one per AC)
1419 * for different virtual interfaces. See the doc section on HW queue
1420 * control for more details.
Johannes Berg6d711172012-06-19 17:19:44 +02001421 *
1422 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1423 * P2P Interface. This will be honoured even if more than one interface
1424 * is supported.
Johannes Bergef429da2013-02-05 17:48:40 +01001425 *
1426 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
1427 * only, to allow getting TBTT of a DTIM beacon.
Johannes Berg1bc08262007-09-18 17:29:15 -04001428 */
1429enum ieee80211_hw_flags {
Johannes Bergaf65cd962009-11-17 18:18:36 +01001430 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
Johannes Berg1bc08262007-09-18 17:29:15 -04001431 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1432 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
Johannes Berg8318d782008-01-24 19:38:38 +01001433 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1434 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
Bruno Randolf566bfe52008-05-08 19:15:40 +02001435 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
Johannes Berg7fee5372009-01-30 11:13:06 +01001436 IEEE80211_HW_SIGNAL_DBM = 1<<6,
Emmanuel Grumbachc65dd142012-12-12 10:12:24 +02001437 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC = 1<<7,
Johannes Berg7fee5372009-01-30 11:13:06 +01001438 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1439 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1440 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1441 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1442 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1443 IEEE80211_HW_MFP_CAPABLE = 1<<13,
Johannes Berg4b6f1dd2012-04-03 14:35:57 +02001444 IEEE80211_HW_WANT_MONITOR_VIF = 1<<14,
Johannes Berg0f782312009-12-01 13:37:02 +01001445 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
1446 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
Kalle Valoab133152010-01-12 10:42:31 +02001447 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
Vivek Natarajan375177b2010-02-09 14:50:28 +05301448 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02001449 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001450 IEEE80211_HW_QUEUE_CONTROL = 1<<20,
Johannes Berge31b8212010-10-05 19:39:30 +02001451 IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02001452 IEEE80211_HW_AP_LINK_PS = 1<<22,
Arik Nemtsovedf6b782011-08-30 09:32:38 +03001453 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW = 1<<23,
Johannes Berg6d711172012-06-19 17:19:44 +02001454 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF = 1<<25,
Johannes Bergef429da2013-02-05 17:48:40 +01001455 IEEE80211_HW_TIMING_BEACON_ONLY = 1<<26,
Johannes Berg1bc08262007-09-18 17:29:15 -04001456};
1457
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001458/**
1459 * struct ieee80211_hw - hardware information and state
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001460 *
1461 * This structure contains the configuration and hardware
1462 * information for an 802.11 PHY.
1463 *
1464 * @wiphy: This points to the &struct wiphy allocated for this
1465 * 802.11 PHY. You must fill in the @perm_addr and @dev
1466 * members of this structure using SET_IEEE80211_DEV()
Johannes Berg8318d782008-01-24 19:38:38 +01001467 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1468 * bands (with channels, bitrates) are registered here.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001469 *
1470 * @conf: &struct ieee80211_conf, device configuration, don't use.
1471 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001472 * @priv: pointer to private area that was allocated for driver use
1473 * along with this structure.
1474 *
1475 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1476 *
1477 * @extra_tx_headroom: headroom to reserve in each transmit skb
1478 * for use by the driver (e.g. for transmit headers.)
1479 *
1480 * @channel_change_time: time (in microseconds) it takes to change channels.
1481 *
Bruno Randolf566bfe52008-05-08 19:15:40 +02001482 * @max_signal: Maximum value for signal (rssi) in RX information, used
1483 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001484 *
Tomas Winklerea95bba2008-07-18 13:53:00 +08001485 * @max_listen_interval: max listen interval in units of beacon interval
1486 * that HW supports
1487 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001488 * @queues: number of available hardware transmit queues for
Johannes Berge100bb62008-04-30 18:51:21 +02001489 * data packets. WMM/QoS requires at least four, these
1490 * queues need to have configurable access parameters.
1491 *
Johannes Berg830f9032007-10-28 14:51:05 +01001492 * @rate_control_algorithm: rate control algorithm for this hardware.
1493 * If unset (NULL), the default algorithm will be used. Must be
1494 * set before calling ieee80211_register_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001495 *
1496 * @vif_data_size: size (in bytes) of the drv_priv data area
1497 * within &struct ieee80211_vif.
Johannes Berg17741cd2008-09-11 00:02:02 +02001498 * @sta_data_size: size (in bytes) of the drv_priv data area
1499 * within &struct ieee80211_sta.
Michal Kaziord01a1e62012-06-26 14:37:16 +02001500 * @chanctx_data_size: size (in bytes) of the drv_priv data area
1501 * within &struct ieee80211_chanctx_conf.
Felix Fietkau870abdf2008-10-05 18:04:24 +02001502 *
Helmut Schaa78be49e2010-10-02 11:31:55 +02001503 * @max_rates: maximum number of alternate rate retry stages the hw
1504 * can handle.
1505 * @max_report_rates: maximum number of alternate rate retry stages
1506 * the hw can report back.
Johannes Berge6a98542008-10-21 12:40:02 +02001507 * @max_rate_tries: maximum number of tries for each stage
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001508 *
1509 * @napi_weight: weight used for NAPI polling. You must specify an
1510 * appropriate value here if a napi_poll operation is provided
1511 * by your driver.
Randy Dunlap858022a2011-03-18 09:33:02 -07001512 *
Luciano Coelhodf6ba5d2011-01-12 15:26:30 +02001513 * @max_rx_aggregation_subframes: maximum buffer size (number of
1514 * sub-frames) to be used for A-MPDU block ack receiver
1515 * aggregation.
1516 * This is only relevant if the device has restrictions on the
1517 * number of subframes, if it relies on mac80211 to do reordering
1518 * it shouldn't be set.
Johannes Berg5dd36bc2011-01-18 13:52:23 +01001519 *
1520 * @max_tx_aggregation_subframes: maximum number of subframes in an
1521 * aggregate an HT driver will transmit, used by the peer as a
1522 * hint to size its reorder buffer.
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001523 *
1524 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
1525 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
Johannes Bergac55d2f2012-05-10 09:09:10 +02001526 *
1527 * @radiotap_mcs_details: lists which MCS information can the HW
1528 * reports, by default it is set to _MCS, _GI and _BW but doesn't
1529 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
1530 * adding _BW is supported today.
Arik Nemtsov72d78722012-05-10 16:18:26 +03001531 *
Johannes Berg51648922012-11-22 23:00:18 +01001532 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
1533 * the default is _GI | _BANDWIDTH.
1534 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_* values.
1535 *
Arik Nemtsov72d78722012-05-10 16:18:26 +03001536 * @netdev_features: netdev features to be set in each netdev created
1537 * from this HW. Note only HW checksum features are currently
1538 * compatible with mac80211. Other feature bits will be rejected.
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001539 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001540struct ieee80211_hw {
Jiri Bencf0706e82007-05-05 11:45:53 -07001541 struct ieee80211_conf conf;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001542 struct wiphy *wiphy;
Johannes Berg830f9032007-10-28 14:51:05 +01001543 const char *rate_control_algorithm;
Jiri Bencf0706e82007-05-05 11:45:53 -07001544 void *priv;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001545 u32 flags;
Jiri Bencf0706e82007-05-05 11:45:53 -07001546 unsigned int extra_tx_headroom;
Jiri Bencf0706e82007-05-05 11:45:53 -07001547 int channel_change_time;
Johannes Berg32bfd352007-12-19 01:31:26 +01001548 int vif_data_size;
Johannes Berg17741cd2008-09-11 00:02:02 +02001549 int sta_data_size;
Michal Kaziord01a1e62012-06-26 14:37:16 +02001550 int chanctx_data_size;
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001551 int napi_weight;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001552 u16 queues;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001553 u16 max_listen_interval;
Jiri Bencf0706e82007-05-05 11:45:53 -07001554 s8 max_signal;
Johannes Berge6a98542008-10-21 12:40:02 +02001555 u8 max_rates;
Helmut Schaa78be49e2010-10-02 11:31:55 +02001556 u8 max_report_rates;
Johannes Berge6a98542008-10-21 12:40:02 +02001557 u8 max_rate_tries;
Luciano Coelhodf6ba5d2011-01-12 15:26:30 +02001558 u8 max_rx_aggregation_subframes;
Johannes Berg5dd36bc2011-01-18 13:52:23 +01001559 u8 max_tx_aggregation_subframes;
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001560 u8 offchannel_tx_hw_queue;
Johannes Bergac55d2f2012-05-10 09:09:10 +02001561 u8 radiotap_mcs_details;
Johannes Berg51648922012-11-22 23:00:18 +01001562 u16 radiotap_vht_details;
Arik Nemtsov72d78722012-05-10 16:18:26 +03001563 netdev_features_t netdev_features;
Jiri Bencf0706e82007-05-05 11:45:53 -07001564};
1565
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001566/**
Luis R. Rodriguez9a953712009-01-22 15:05:53 -08001567 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1568 *
1569 * @wiphy: the &struct wiphy which we want to query
1570 *
1571 * mac80211 drivers can use this to get to their respective
1572 * &struct ieee80211_hw. Drivers wishing to get to their own private
1573 * structure can then access it via hw->priv. Note that mac802111 drivers should
1574 * not use wiphy_priv() to try to get their private driver structure as this
1575 * is already used internally by mac80211.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01001576 *
1577 * Return: The mac80211 driver hw struct of @wiphy.
Luis R. Rodriguez9a953712009-01-22 15:05:53 -08001578 */
1579struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1580
1581/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001582 * SET_IEEE80211_DEV - set device for 802.11 hardware
1583 *
1584 * @hw: the &struct ieee80211_hw to set the device for
1585 * @dev: the &struct device of this 802.11 device
1586 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001587static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1588{
1589 set_wiphy_dev(hw->wiphy, dev);
1590}
1591
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001592/**
Bob Copelande37d4df2008-10-20 21:20:27 -04001593 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001594 *
1595 * @hw: the &struct ieee80211_hw to set the MAC address for
1596 * @addr: the address to set
1597 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001598static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1599{
1600 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1601}
1602
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001603static inline struct ieee80211_rate *
1604ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001605 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001606{
Larry Fingeraa331df2012-04-06 16:35:53 -05001607 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001608 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001609 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001610}
1611
1612static inline struct ieee80211_rate *
1613ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001614 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001615{
Johannes Berge039fa42008-05-15 12:55:29 +02001616 if (c->control.rts_cts_rate_idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001617 return NULL;
Johannes Berge039fa42008-05-15 12:55:29 +02001618 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001619}
1620
1621static inline struct ieee80211_rate *
1622ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
Felix Fietkau870abdf2008-10-05 18:04:24 +02001623 const struct ieee80211_tx_info *c, int idx)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001624{
Johannes Berge6a98542008-10-21 12:40:02 +02001625 if (c->control.rates[idx + 1].idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001626 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001627 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001628}
1629
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001630/**
Johannes Berg6096de72011-11-04 11:18:10 +01001631 * ieee80211_free_txskb - free TX skb
1632 * @hw: the hardware
1633 * @skb: the skb
1634 *
1635 * Free a transmit skb. Use this funtion when some failure
1636 * to transmit happened and thus status cannot be reported.
1637 */
1638void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
1639
1640/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001641 * DOC: Hardware crypto acceleration
Johannes Berg4150c572007-09-17 01:29:23 -04001642 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001643 * mac80211 is capable of taking advantage of many hardware
1644 * acceleration designs for encryption and decryption operations.
1645 *
1646 * The set_key() callback in the &struct ieee80211_ops for a given
1647 * device is called to enable hardware acceleration of encryption and
Johannes Bergdc822b52008-12-29 12:55:09 +01001648 * decryption. The callback takes a @sta parameter that will be NULL
1649 * for default keys or keys used for transmission only, or point to
1650 * the station information for the peer for individual keys.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001651 * Multiple transmission keys with the same key index may be used when
1652 * VLANs are configured for an access point.
1653 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001654 * When transmitting, the TX control data will use the @hw_key_idx
1655 * selected by the driver by modifying the &struct ieee80211_key_conf
1656 * pointed to by the @key parameter to the set_key() function.
1657 *
1658 * The set_key() call for the %SET_KEY command should return 0 if
1659 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1660 * added; if you return 0 then hw_key_idx must be assigned to the
1661 * hardware key index, you are free to use the full u8 range.
1662 *
1663 * When the cmd is %DISABLE_KEY then it must succeed.
1664 *
1665 * Note that it is permissible to not decrypt a frame even if a key
1666 * for it has been uploaded to hardware, the stack will not make any
1667 * decision based on whether a key has been uploaded or not but rather
1668 * based on the receive flags.
1669 *
1670 * The &struct ieee80211_key_conf structure pointed to by the @key
1671 * parameter is guaranteed to be valid until another call to set_key()
1672 * removes it, but it can only be used as a cookie to differentiate
1673 * keys.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001674 *
1675 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1676 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1677 * handler.
1678 * The update_tkip_key() call updates the driver with the new phase 1 key.
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001679 * This happens every time the iv16 wraps around (every 65536 packets). The
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001680 * set_key() call will happen only once for each key (unless the AP did
1681 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
Bob Copelande37d4df2008-10-20 21:20:27 -04001682 * provided by update_tkip_key only. The trigger that makes mac80211 call this
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001683 * handler is software decryption with wrap around of iv16.
Yoni Divinskyde5fad82012-05-30 11:36:39 +03001684 *
1685 * The set_default_unicast_key() call updates the default WEP key index
1686 * configured to the hardware for WEP encryption type. This is required
1687 * for devices that support offload of data packets (e.g. ARP responses).
Johannes Berg4150c572007-09-17 01:29:23 -04001688 */
Johannes Berg4150c572007-09-17 01:29:23 -04001689
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001690/**
Johannes Berg4be8c382009-01-07 18:28:20 +01001691 * DOC: Powersave support
1692 *
1693 * mac80211 has support for various powersave implementations.
1694 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001695 * First, it can support hardware that handles all powersaving by itself,
1696 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1697 * flag. In that case, it will be told about the desired powersave mode
1698 * with the %IEEE80211_CONF_PS flag depending on the association status.
1699 * The hardware must take care of sending nullfunc frames when necessary,
1700 * i.e. when entering and leaving powersave mode. The hardware is required
1701 * to look at the AID in beacons and signal to the AP that it woke up when
1702 * it finds traffic directed to it.
Johannes Berg4be8c382009-01-07 18:28:20 +01001703 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001704 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1705 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1706 * with hardware wakeup and sleep states. Driver is responsible for waking
Bob Copeland2738bd62010-08-21 16:39:01 -04001707 * up the hardware before issuing commands to the hardware and putting it
1708 * back to sleep at appropriate times.
Kalle Valoc99445b2010-01-14 13:09:21 +02001709 *
1710 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1711 * buffered multicast/broadcast frames after the beacon. Also it must be
1712 * possible to send frames and receive the acknowledment frame.
Johannes Berg4be8c382009-01-07 18:28:20 +01001713 *
1714 * Other hardware designs cannot send nullfunc frames by themselves and also
1715 * need software support for parsing the TIM bitmap. This is also supported
1716 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1717 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
Johannes Berg955394c2009-04-16 17:04:25 +02001718 * required to pass up beacons. The hardware is still required to handle
1719 * waking up for multicast traffic; if it cannot the driver must handle that
Kalle Valoc99445b2010-01-14 13:09:21 +02001720 * as best as it can, mac80211 is too slow to do that.
Johannes Berg4be8c382009-01-07 18:28:20 +01001721 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001722 * Dynamic powersave is an extension to normal powersave in which the
1723 * hardware stays awake for a user-specified period of time after sending a
1724 * frame so that reply frames need not be buffered and therefore delayed to
1725 * the next wakeup. It's compromise of getting good enough latency when
1726 * there's data traffic and still saving significantly power in idle
1727 * periods.
1728 *
Bob Copeland2738bd62010-08-21 16:39:01 -04001729 * Dynamic powersave is simply supported by mac80211 enabling and disabling
Kalle Valoc99445b2010-01-14 13:09:21 +02001730 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1731 * flag and mac80211 will handle everything automatically. Additionally,
1732 * hardware having support for the dynamic PS feature may set the
1733 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1734 * dynamic PS mode itself. The driver needs to look at the
1735 * @dynamic_ps_timeout hardware configuration value and use it that value
1736 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1737 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1738 * enabled whenever user has enabled powersave.
1739 *
1740 * Driver informs U-APSD client support by enabling
1741 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1742 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1743 * Nullfunc frames and stay awake until the service period has ended. To
1744 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1745 * from that AC are transmitted with powersave enabled.
1746 *
1747 * Note: U-APSD client mode is not yet supported with
1748 * %IEEE80211_HW_PS_NULLFUNC_STACK.
Johannes Berg4be8c382009-01-07 18:28:20 +01001749 */
1750
1751/**
Kalle Valo04de8382009-03-22 21:57:35 +02001752 * DOC: Beacon filter support
1753 *
1754 * Some hardware have beacon filter support to reduce host cpu wakeups
Justin P. Mattock42b2aa82011-11-28 20:31:00 -08001755 * which will reduce system power consumption. It usually works so that
Kalle Valo04de8382009-03-22 21:57:35 +02001756 * the firmware creates a checksum of the beacon but omits all constantly
1757 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1758 * beacon is forwarded to the host, otherwise it will be just dropped. That
1759 * way the host will only receive beacons where some relevant information
1760 * (for example ERP protection or WMM settings) have changed.
1761 *
Johannes Bergc1288b12012-01-19 09:29:57 +01001762 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
1763 * interface capability. The driver needs to enable beacon filter support
Johannes Berg955394c2009-04-16 17:04:25 +02001764 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1765 * power save is enabled, the stack will not check for beacon loss and the
1766 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1767 *
1768 * The time (or number of beacons missed) until the firmware notifies the
1769 * driver of a beacon loss event (which in turn causes the driver to call
1770 * ieee80211_beacon_loss()) should be configurable and will be controlled
1771 * by mac80211 and the roaming algorithm in the future.
1772 *
1773 * Since there may be constantly changing information elements that nothing
1774 * in the software stack cares about, we will, in the future, have mac80211
1775 * tell the driver which information elements are interesting in the sense
1776 * that we want to see changes in them. This will include
1777 * - a list of information element IDs
1778 * - a list of OUIs for the vendor information element
1779 *
1780 * Ideally, the hardware would filter out any beacons without changes in the
1781 * requested elements, but if it cannot support that it may, at the expense
1782 * of some efficiency, filter out only a subset. For example, if the device
1783 * doesn't support checking for OUIs it should pass up all changes in all
1784 * vendor information elements.
1785 *
1786 * Note that change, for the sake of simplification, also includes information
1787 * elements appearing or disappearing from the beacon.
1788 *
1789 * Some hardware supports an "ignore list" instead, just make sure nothing
1790 * that was requested is on the ignore list, and include commonly changing
1791 * information element IDs in the ignore list, for example 11 (BSS load) and
1792 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1793 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1794 * it could also include some currently unused IDs.
1795 *
1796 *
1797 * In addition to these capabilities, hardware should support notifying the
1798 * host of changes in the beacon RSSI. This is relevant to implement roaming
1799 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1800 * the received data packets). This can consist in notifying the host when
1801 * the RSSI changes significantly or when it drops below or rises above
1802 * configurable thresholds. In the future these thresholds will also be
1803 * configured by mac80211 (which gets them from userspace) to implement
1804 * them as the roaming algorithm requires.
1805 *
1806 * If the hardware cannot implement this, the driver should ask it to
1807 * periodically pass beacon frames to the host so that software can do the
1808 * signal strength threshold checking.
Kalle Valo04de8382009-03-22 21:57:35 +02001809 */
1810
1811/**
Johannes Berg0f782312009-12-01 13:37:02 +01001812 * DOC: Spatial multiplexing power save
1813 *
1814 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1815 * power in an 802.11n implementation. For details on the mechanism
1816 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1817 * "11.2.3 SM power save".
1818 *
1819 * The mac80211 implementation is capable of sending action frames
1820 * to update the AP about the station's SMPS mode, and will instruct
1821 * the driver to enter the specific mode. It will also announce the
1822 * requested SMPS mode during the association handshake. Hardware
1823 * support for this feature is required, and can be indicated by
1824 * hardware flags.
1825 *
1826 * The default mode will be "automatic", which nl80211/cfg80211
1827 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1828 * turned off otherwise.
1829 *
1830 * To support this feature, the driver must set the appropriate
1831 * hardware support flags, and handle the SMPS flag to the config()
1832 * operation. It will then with this mechanism be instructed to
1833 * enter the requested SMPS mode while associated to an HT AP.
1834 */
1835
1836/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001837 * DOC: Frame filtering
1838 *
1839 * mac80211 requires to see many management frames for proper
1840 * operation, and users may want to see many more frames when
1841 * in monitor mode. However, for best CPU usage and power consumption,
1842 * having as few frames as possible percolate through the stack is
1843 * desirable. Hence, the hardware should filter as much as possible.
1844 *
1845 * To achieve this, mac80211 uses filter flags (see below) to tell
1846 * the driver's configure_filter() function which frames should be
1847 * passed to mac80211 and which should be filtered out.
1848 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02001849 * Before configure_filter() is invoked, the prepare_multicast()
1850 * callback is invoked with the parameters @mc_count and @mc_list
1851 * for the combined multicast address list of all virtual interfaces.
1852 * It's use is optional, and it returns a u64 that is passed to
1853 * configure_filter(). Additionally, configure_filter() has the
1854 * arguments @changed_flags telling which flags were changed and
1855 * @total_flags with the new flag states.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001856 *
1857 * If your device has no multicast address filters your driver will
1858 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1859 * parameter to see whether multicast frames should be accepted
1860 * or dropped.
1861 *
Michael Bueschd0f5afb2008-02-12 20:12:45 +01001862 * All unsupported flags in @total_flags must be cleared.
1863 * Hardware does not support a flag if it is incapable of _passing_
1864 * the frame to the stack. Otherwise the driver must ignore
1865 * the flag, but not clear it.
1866 * You must _only_ clear the flag (announce no support for the
1867 * flag to mac80211) if you are not able to pass the packet type
1868 * to the stack (so the hardware always filters it).
1869 * So for example, you should clear @FIF_CONTROL, if your hardware
1870 * always filters control frames. If your hardware always passes
1871 * control frames to the kernel and is incapable of filtering them,
1872 * you do _not_ clear the @FIF_CONTROL flag.
1873 * This rule applies to all other FIF flags as well.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001874 */
1875
1876/**
Johannes Berg4b801bc2011-09-29 16:04:40 +02001877 * DOC: AP support for powersaving clients
1878 *
1879 * In order to implement AP and P2P GO modes, mac80211 has support for
1880 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
1881 * There currently is no support for sAPSD.
1882 *
1883 * There is one assumption that mac80211 makes, namely that a client
1884 * will not poll with PS-Poll and trigger with uAPSD at the same time.
1885 * Both are supported, and both can be used by the same client, but
1886 * they can't be used concurrently by the same client. This simplifies
1887 * the driver code.
1888 *
1889 * The first thing to keep in mind is that there is a flag for complete
1890 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
1891 * mac80211 expects the driver to handle most of the state machine for
1892 * powersaving clients and will ignore the PM bit in incoming frames.
1893 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
1894 * stations' powersave transitions. In this mode, mac80211 also doesn't
1895 * handle PS-Poll/uAPSD.
1896 *
1897 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
1898 * PM bit in incoming frames for client powersave transitions. When a
1899 * station goes to sleep, we will stop transmitting to it. There is,
1900 * however, a race condition: a station might go to sleep while there is
1901 * data buffered on hardware queues. If the device has support for this
1902 * it will reject frames, and the driver should give the frames back to
1903 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
1904 * cause mac80211 to retry the frame when the station wakes up. The
1905 * driver is also notified of powersave transitions by calling its
1906 * @sta_notify callback.
1907 *
1908 * When the station is asleep, it has three choices: it can wake up,
1909 * it can PS-Poll, or it can possibly start a uAPSD service period.
1910 * Waking up is implemented by simply transmitting all buffered (and
1911 * filtered) frames to the station. This is the easiest case. When
1912 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
1913 * will inform the driver of this with the @allow_buffered_frames
1914 * callback; this callback is optional. mac80211 will then transmit
Johannes Berg02f2f1a2012-02-27 12:18:30 +01001915 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
Johannes Berg4b801bc2011-09-29 16:04:40 +02001916 * on each frame. The last frame in the service period (or the only
1917 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
1918 * indicate that it ends the service period; as this frame must have
1919 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
1920 * When TX status is reported for this frame, the service period is
1921 * marked has having ended and a new one can be started by the peer.
1922 *
Johannes Berg02f2f1a2012-02-27 12:18:30 +01001923 * Additionally, non-bufferable MMPDUs can also be transmitted by
1924 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
1925 *
Johannes Berg4b801bc2011-09-29 16:04:40 +02001926 * Another race condition can happen on some devices like iwlwifi
1927 * when there are frames queued for the station and it wakes up
1928 * or polls; the frames that are already queued could end up being
1929 * transmitted first instead, causing reordering and/or wrong
1930 * processing of the EOSP. The cause is that allowing frames to be
1931 * transmitted to a certain station is out-of-band communication to
1932 * the device. To allow this problem to be solved, the driver can
1933 * call ieee80211_sta_block_awake() if frames are buffered when it
1934 * is notified that the station went to sleep. When all these frames
1935 * have been filtered (see above), it must call the function again
1936 * to indicate that the station is no longer blocked.
1937 *
1938 * If the driver buffers frames in the driver for aggregation in any
1939 * way, it must use the ieee80211_sta_set_buffered() call when it is
1940 * notified of the station going to sleep to inform mac80211 of any
1941 * TIDs that have frames buffered. Note that when a station wakes up
1942 * this information is reset (hence the requirement to call it when
1943 * informed of the station going to sleep). Then, when a service
1944 * period starts for any reason, @release_buffered_frames is called
1945 * with the number of frames to be released and which TIDs they are
1946 * to come from. In this case, the driver is responsible for setting
1947 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
1948 * to help the @more_data paramter is passed to tell the driver if
1949 * there is more data on other TIDs -- the TIDs to release frames
1950 * from are ignored since mac80211 doesn't know how many frames the
1951 * buffers for those TIDs contain.
1952 *
1953 * If the driver also implement GO mode, where absence periods may
1954 * shorten service periods (or abort PS-Poll responses), it must
1955 * filter those response frames except in the case of frames that
1956 * are buffered in the driver -- those must remain buffered to avoid
1957 * reordering. Because it is possible that no frames are released
Johannes Berge9437892013-02-15 21:38:08 +01001958 * in this case, the driver must call ieee80211_sta_eosp()
Johannes Berg4b801bc2011-09-29 16:04:40 +02001959 * to indicate to mac80211 that the service period ended anyway.
1960 *
1961 * Finally, if frames from multiple TIDs are released from mac80211
1962 * but the driver might reorder them, it must clear & set the flags
1963 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
1964 * and also take care of the EOSP and MORE_DATA bits in the frame.
Johannes Berge9437892013-02-15 21:38:08 +01001965 * The driver may also use ieee80211_sta_eosp() in this case.
Johannes Berg4b801bc2011-09-29 16:04:40 +02001966 */
1967
1968/**
Johannes Berg3a25a8c2012-04-03 16:28:50 +02001969 * DOC: HW queue control
1970 *
1971 * Before HW queue control was introduced, mac80211 only had a single static
1972 * assignment of per-interface AC software queues to hardware queues. This
1973 * was problematic for a few reasons:
1974 * 1) off-channel transmissions might get stuck behind other frames
1975 * 2) multiple virtual interfaces couldn't be handled correctly
1976 * 3) after-DTIM frames could get stuck behind other frames
1977 *
1978 * To solve this, hardware typically uses multiple different queues for all
1979 * the different usages, and this needs to be propagated into mac80211 so it
1980 * won't have the same problem with the software queues.
1981 *
1982 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
1983 * flag that tells it that the driver implements its own queue control. To do
1984 * so, the driver will set up the various queues in each &struct ieee80211_vif
1985 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
1986 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
1987 * if necessary will queue the frame on the right software queue that mirrors
1988 * the hardware queue.
1989 * Additionally, the driver has to then use these HW queue IDs for the queue
1990 * management functions (ieee80211_stop_queue() et al.)
1991 *
1992 * The driver is free to set up the queue mappings as needed, multiple virtual
1993 * interfaces may map to the same hardware queues if needed. The setup has to
1994 * happen during add_interface or change_interface callbacks. For example, a
1995 * driver supporting station+station and station+AP modes might decide to have
1996 * 10 hardware queues to handle different scenarios:
1997 *
1998 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
1999 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2000 * after-DTIM queue for AP: 8
2001 * off-channel queue: 9
2002 *
2003 * It would then set up the hardware like this:
2004 * hw.offchannel_tx_hw_queue = 9
2005 *
2006 * and the first virtual interface that is added as follows:
2007 * vif.hw_queue[IEEE80211_AC_VO] = 0
2008 * vif.hw_queue[IEEE80211_AC_VI] = 1
2009 * vif.hw_queue[IEEE80211_AC_BE] = 2
2010 * vif.hw_queue[IEEE80211_AC_BK] = 3
2011 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2012 * and the second virtual interface with 4-7.
2013 *
2014 * If queue 6 gets full, for example, mac80211 would only stop the second
2015 * virtual interface's BE queue since virtual interface queues are per AC.
2016 *
2017 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2018 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2019 * queue could potentially be shared since mac80211 will look at cab_queue when
2020 * a queue is stopped/woken even if the interface is not in AP mode.
2021 */
2022
2023/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002024 * enum ieee80211_filter_flags - hardware filter flags
2025 *
2026 * These flags determine what the filter in hardware should be
2027 * programmed to let through and what should not be passed to the
2028 * stack. It is always safe to pass more frames than requested,
2029 * but this has negative impact on power consumption.
2030 *
2031 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
2032 * think of the BSS as your network segment and then this corresponds
2033 * to the regular ethernet device promiscuous mode.
2034 *
2035 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2036 * by the user or if the hardware is not capable of filtering by
2037 * multicast address.
2038 *
2039 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2040 * %RX_FLAG_FAILED_FCS_CRC for them)
2041 *
2042 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2043 * the %RX_FLAG_FAILED_PLCP_CRC for them
2044 *
2045 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2046 * to the hardware that it should not filter beacons or probe responses
2047 * by BSSID. Filtering them can greatly reduce the amount of processing
2048 * mac80211 needs to do and the amount of CPU wakeups, so you should
2049 * honour this flag if possible.
2050 *
Igor Perminove3b90ca2009-08-04 16:48:51 +04002051 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
Johannes Berg7be50862010-10-13 12:06:24 +02002052 * is not set then only those addressed to this station.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002053 *
2054 * @FIF_OTHER_BSS: pass frames destined to other BSSes
Igor Perminove3b90ca2009-08-04 16:48:51 +04002055 *
Johannes Berg7be50862010-10-13 12:06:24 +02002056 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
2057 * those addressed to this station.
2058 *
2059 * @FIF_PROBE_REQ: pass probe request frames
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002060 */
2061enum ieee80211_filter_flags {
2062 FIF_PROMISC_IN_BSS = 1<<0,
2063 FIF_ALLMULTI = 1<<1,
2064 FIF_FCSFAIL = 1<<2,
2065 FIF_PLCPFAIL = 1<<3,
2066 FIF_BCN_PRBRESP_PROMISC = 1<<4,
2067 FIF_CONTROL = 1<<5,
2068 FIF_OTHER_BSS = 1<<6,
Igor Perminove3b90ca2009-08-04 16:48:51 +04002069 FIF_PSPOLL = 1<<7,
Johannes Berg7be50862010-10-13 12:06:24 +02002070 FIF_PROBE_REQ = 1<<8,
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002071};
2072
2073/**
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02002074 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2075 *
2076 * These flags are used with the ampdu_action() callback in
2077 * &struct ieee80211_ops to indicate which action is needed.
Johannes Berg827d42c2009-11-22 12:28:41 +01002078 *
2079 * Note that drivers MUST be able to deal with a TX aggregation
2080 * session being stopped even before they OK'ed starting it by
Johannes Berg5d22c892010-06-10 10:21:40 +02002081 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
Johannes Berg827d42c2009-11-22 12:28:41 +01002082 * might receive the addBA frame and send a delBA right away!
2083 *
Johannes Berg18b559d2012-07-18 13:51:25 +02002084 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2085 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2086 * @IEEE80211_AMPDU_TX_START: start TX aggregation
Johannes Bergb1720232009-03-23 17:28:39 +01002087 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
Johannes Berg18b559d2012-07-18 13:51:25 +02002088 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2089 * queued packets, now unaggregated. After all packets are transmitted the
2090 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2091 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2092 * called when the station is removed. There's no need or reason to call
2093 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2094 * session is gone and removes the station.
2095 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2096 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2097 * now the connection is dropped and the station will be removed. Drivers
2098 * should clean up and drop remaining packets when this is called.
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02002099 */
2100enum ieee80211_ampdu_mlme_action {
2101 IEEE80211_AMPDU_RX_START,
2102 IEEE80211_AMPDU_RX_STOP,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002103 IEEE80211_AMPDU_TX_START,
Johannes Berg18b559d2012-07-18 13:51:25 +02002104 IEEE80211_AMPDU_TX_STOP_CONT,
2105 IEEE80211_AMPDU_TX_STOP_FLUSH,
2106 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
Johannes Bergb1720232009-03-23 17:28:39 +01002107 IEEE80211_AMPDU_TX_OPERATIONAL,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02002108};
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002109
2110/**
Johannes Berg4049e092011-09-29 16:04:32 +02002111 * enum ieee80211_frame_release_type - frame release reason
2112 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
Johannes Berg47086fc2011-09-29 16:04:33 +02002113 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2114 * frame received on trigger-enabled AC
Johannes Berg4049e092011-09-29 16:04:32 +02002115 */
2116enum ieee80211_frame_release_type {
2117 IEEE80211_FRAME_RELEASE_PSPOLL,
Johannes Berg47086fc2011-09-29 16:04:33 +02002118 IEEE80211_FRAME_RELEASE_UAPSD,
Johannes Berg4049e092011-09-29 16:04:32 +02002119};
2120
2121/**
Johannes Berg8f727ef2012-03-30 08:43:32 +02002122 * enum ieee80211_rate_control_changed - flags to indicate what changed
2123 *
2124 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
Johannes Berge1a0c6b2013-02-07 11:47:44 +01002125 * to this station changed. The actual bandwidth is in the station
2126 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2127 * flag changes, for HT and VHT the bandwidth field changes.
Johannes Berg8f727ef2012-03-30 08:43:32 +02002128 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
Antonio Quartullie687f612012-08-12 18:24:55 +02002129 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2130 * changed (in IBSS mode) due to discovering more information about
2131 * the peer.
Johannes Berg0af83d32012-12-27 18:55:36 +01002132 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2133 * by the peer
Johannes Berg8f727ef2012-03-30 08:43:32 +02002134 */
2135enum ieee80211_rate_control_changed {
2136 IEEE80211_RC_BW_CHANGED = BIT(0),
2137 IEEE80211_RC_SMPS_CHANGED = BIT(1),
Antonio Quartullie687f612012-08-12 18:24:55 +02002138 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
Johannes Berg0af83d32012-12-27 18:55:36 +01002139 IEEE80211_RC_NSS_CHANGED = BIT(3),
Johannes Berg8f727ef2012-03-30 08:43:32 +02002140};
2141
2142/**
Ilan Peerd339d5c2013-02-12 09:34:13 +02002143 * enum ieee80211_roc_type - remain on channel type
2144 *
2145 * With the support for multi channel contexts and multi channel operations,
2146 * remain on channel operations might be limited/deferred/aborted by other
2147 * flows/operations which have higher priority (and vise versa).
2148 * Specifying the ROC type can be used by devices to prioritize the ROC
2149 * operations compared to other operations/flows.
2150 *
2151 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2152 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2153 * for sending managment frames offchannel.
2154 */
2155enum ieee80211_roc_type {
2156 IEEE80211_ROC_TYPE_NORMAL = 0,
2157 IEEE80211_ROC_TYPE_MGMT_TX,
2158};
2159
2160/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002161 * struct ieee80211_ops - callbacks from mac80211 to the driver
2162 *
2163 * This structure contains various callbacks that the driver may
2164 * handle or, in some cases, must handle, for example to configure
2165 * the hardware to a new channel or to transmit a frame.
2166 *
2167 * @tx: Handler that 802.11 module calls for each transmitted frame.
2168 * skb contains the buffer starting from the IEEE 802.11 header.
2169 * The low-level driver should send the frame out based on
Johannes Bergeefce912008-05-17 00:57:13 +02002170 * configuration in the TX control data. This handler should,
Johannes Berg11127e92011-11-16 16:02:47 +01002171 * preferably, never fail and stop queues appropriately.
Johannes Berg11127e92011-11-16 16:02:47 +01002172 * Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002173 *
2174 * @start: Called before the first netdevice attached to the hardware
2175 * is enabled. This should turn on the hardware and must turn on
2176 * frame reception (for possibly enabled monitor interfaces.)
2177 * Returns negative error codes, these may be seen in userspace,
2178 * or zero.
2179 * When the device is started it should not have a MAC address
2180 * to avoid acknowledging frames before a non-monitor device
2181 * is added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002182 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002183 *
2184 * @stop: Called after last netdevice attached to the hardware
2185 * is disabled. This should turn off the hardware (at least
2186 * it must turn off frame reception.)
2187 * May be called right after add_interface if that rejects
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04002188 * an interface. If you added any work onto the mac80211 workqueue
2189 * you should ensure to cancel it on this callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002190 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002191 *
Johannes Bergeecc4802011-05-04 15:37:29 +02002192 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2193 * stop transmitting and doing any other configuration, and then
2194 * ask the device to suspend. This is only invoked when WoWLAN is
2195 * configured, otherwise the device is deconfigured completely and
2196 * reconfigured at resume time.
Johannes Berg2b4562d2011-07-02 00:02:01 +02002197 * The driver may also impose special conditions under which it
2198 * wants to use the "normal" suspend (deconfigure), say if it only
2199 * supports WoWLAN when the device is associated. In this case, it
2200 * must return 1 from this function.
Johannes Bergeecc4802011-05-04 15:37:29 +02002201 *
2202 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2203 * now resuming its operation, after this the device must be fully
2204 * functional again. If this returns an error, the only way out is
2205 * to also unregister the device. If it returns 1, then mac80211
2206 * will also go through the regular complete restart on resume.
2207 *
Johannes Bergd13e1412012-06-09 10:31:09 +02002208 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2209 * modified. The reason is that device_set_wakeup_enable() is
2210 * supposed to be called when the configuration changes, not only
2211 * in suspend().
2212 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002213 * @add_interface: Called when a netdevice attached to the hardware is
Bob Copelande37d4df2008-10-20 21:20:27 -04002214 * enabled. Because it is not called for monitor mode devices, @start
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002215 * and @stop must be implemented.
2216 * The driver should perform any initialization it needs before
2217 * the device can be enabled. The initial configuration for the
2218 * interface is given in the conf parameter.
2219 * The callback may refuse to add an interface by returning a
2220 * negative error code (which will be seen in userspace.)
Kalle Valoe1781ed2009-12-23 13:15:47 +01002221 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002222 *
Johannes Berg34d4bc42010-08-27 12:35:58 +02002223 * @change_interface: Called when a netdevice changes type. This callback
2224 * is optional, but only if it is supported can interface types be
2225 * switched while the interface is UP. The callback may sleep.
2226 * Note that while an interface is being switched, it will not be
2227 * found by the interface iteration callbacks.
2228 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002229 * @remove_interface: Notifies a driver that an interface is going down.
2230 * The @stop callback is called after this if it is the last interface
2231 * and no monitor interfaces are present.
2232 * When all interfaces are removed, the MAC address in the hardware
2233 * must be cleared so the device no longer acknowledges packets,
2234 * the mac_addr member of the conf structure is, however, set to the
2235 * MAC address of the device going away.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002236 * Hence, this callback must be implemented. It can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002237 *
2238 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2239 * function to change hardware configuration, e.g., channel.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05002240 * This function should never fail but returns a negative error code
Kalle Valoe1781ed2009-12-23 13:15:47 +01002241 * if it does. The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002242 *
Johannes Berg471b3ef2007-12-28 14:32:58 +01002243 * @bss_info_changed: Handler for configuration requests related to BSS
2244 * parameters that may vary during BSS's lifespan, and may affect low
2245 * level driver (e.g. assoc/disassoc status, erp parameters).
2246 * This function should not be used if no BSS has been set, unless
2247 * for association indication. The @changed parameter indicates which
Kalle Valoe1781ed2009-12-23 13:15:47 +01002248 * of the bss parameters has changed when a call is made. The callback
2249 * can sleep.
Johannes Berg471b3ef2007-12-28 14:32:58 +01002250 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02002251 * @prepare_multicast: Prepare for multicast filter configuration.
2252 * This callback is optional, and its return value is passed
2253 * to configure_filter(). This callback must be atomic.
2254 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002255 * @configure_filter: Configure the device's RX filter.
2256 * See the section "Frame filtering" for more information.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002257 * This callback must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002258 *
Alexander Bondar488b3662013-02-11 14:56:29 +02002259 * @set_multicast_list: Configure the device's interface specific RX multicast
2260 * filter. This callback is optional. This callback must be atomic.
2261 *
Luis R. Rodriguez546c80c92008-08-14 11:43:20 -07002262 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
Johannes Berg17741cd2008-09-11 00:02:02 +02002263 * must be set or cleared for a given STA. Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002264 *
2265 * @set_key: See the section "Hardware crypto acceleration"
Kalle Valoe1781ed2009-12-23 13:15:47 +01002266 * This callback is only called between add_interface and
2267 * remove_interface calls, i.e. while the given virtual interface
Johannes Bergdc822b52008-12-29 12:55:09 +01002268 * is enabled.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05002269 * Returns a negative error code if the key can't be added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002270 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002271 *
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02002272 * @update_tkip_key: See the section "Hardware crypto acceleration"
2273 * This callback will be called in the context of Rx. Called for drivers
2274 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
Kalle Valoeb807fb2010-01-24 14:55:12 +02002275 * The callback must be atomic.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02002276 *
Johannes Bergc68f4b82011-07-05 16:35:41 +02002277 * @set_rekey_data: If the device supports GTK rekeying, for example while the
2278 * host is suspended, it can assign this callback to retrieve the data
2279 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2280 * After rekeying was done it should (for example during resume) notify
2281 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2282 *
Yoni Divinskyde5fad82012-05-30 11:36:39 +03002283 * @set_default_unicast_key: Set the default (unicast) key index, useful for
2284 * WEP when the device sends data packets autonomously, e.g. for ARP
2285 * offloading. The index can be 0-3, or -1 for unsetting it.
2286 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002287 * @hw_scan: Ask the hardware to service the scan request, no need to start
Johannes Berg8318d782008-01-24 19:38:38 +01002288 * the scan state machine in stack. The scan must honour the channel
Kalle Valo9050bdd2009-03-22 21:57:21 +02002289 * configuration done by the regulatory agent in the wiphy's
2290 * registered bands. The hardware (or the driver) needs to make sure
Johannes Bergde95a542009-04-01 11:58:36 +02002291 * that power save is disabled.
2292 * The @req ie/ie_len members are rewritten by mac80211 to contain the
2293 * entire IEs after the SSID, so that drivers need not look at these
2294 * at all but just send them after the SSID -- mac80211 includes the
2295 * (extended) supported rates and HT information (where applicable).
2296 * When the scan finishes, ieee80211_scan_completed() must be called;
2297 * note that it also must be called when the scan cannot finish due to
2298 * any error unless this callback returned a negative error code.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002299 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002300 *
Eliad Pellerb8564392011-06-13 12:47:30 +03002301 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2302 * The driver should ask the hardware to cancel the scan (if possible),
2303 * but the scan will be completed only after the driver will call
2304 * ieee80211_scan_completed().
2305 * This callback is needed for wowlan, to prevent enqueueing a new
2306 * scan_work after the low-level driver was already suspended.
2307 * The callback can sleep.
2308 *
Luciano Coelho79f460c2011-05-11 17:09:36 +03002309 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2310 * specific intervals. The driver must call the
2311 * ieee80211_sched_scan_results() function whenever it finds results.
2312 * This process will continue until sched_scan_stop is called.
2313 *
2314 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
2315 *
Michael Buesch80e775b2009-02-20 15:37:03 +01002316 * @sw_scan_start: Notifier function that is called just before a software scan
2317 * is started. Can be NULL, if the driver doesn't need this notification.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002318 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01002319 *
Kalle Valoe1781ed2009-12-23 13:15:47 +01002320 * @sw_scan_complete: Notifier function that is called just after a
2321 * software scan finished. Can be NULL, if the driver doesn't need
2322 * this notification.
2323 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01002324 *
Bob Copeland6dd1bf32009-01-08 21:00:34 -05002325 * @get_stats: Return low-level statistics.
2326 * Returns zero if statistics are available.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002327 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002328 *
Johannes Berg62da92f2007-12-19 02:03:31 +01002329 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
2330 * callback should be provided to read the TKIP transmit IVs (both IV32
2331 * and IV16) for the given key from hardware.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002332 * The callback must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002333 *
Arik Nemtsovf23a4782010-11-08 11:51:06 +02002334 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
2335 * if the device does fragmentation by itself; if this callback is
2336 * implemented then the stack will not do fragmentation.
2337 * The callback can sleep.
2338 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002339 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
Kalle Valoe1781ed2009-12-23 13:15:47 +01002340 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002341 *
Johannes Berg34e89502010-02-03 13:59:58 +01002342 * @sta_add: Notifies low level driver about addition of an associated station,
2343 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2344 *
2345 * @sta_remove: Notifies low level driver about removal of an associated
2346 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2347 *
Sujith Manoharan77d2ece2012-11-20 08:46:02 +05302348 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
2349 * when a station is added to mac80211's station list. This callback
2350 * and @sta_remove_debugfs should be within a CONFIG_MAC80211_DEBUGFS
2351 * conditional. This callback can sleep.
2352 *
2353 * @sta_remove_debugfs: Remove the debugfs files which were added using
2354 * @sta_add_debugfs. This callback can sleep.
2355 *
Johannes Berg34e89502010-02-03 13:59:58 +01002356 * @sta_notify: Notifies low level driver about power state transition of an
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02002357 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
2358 * in AP mode, this callback will not be called when the flag
2359 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
Christian Lamparter4571d3b2008-11-30 00:48:41 +01002360 *
Johannes Bergf09603a2012-01-20 13:55:21 +01002361 * @sta_state: Notifies low level driver about state transition of a
2362 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
2363 * This callback is mutually exclusive with @sta_add/@sta_remove.
2364 * It must not fail for down transitions but may fail for transitions
2365 * up the list of states.
2366 * The callback can sleep.
2367 *
Johannes Berg8f727ef2012-03-30 08:43:32 +02002368 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
2369 * used to transmit to the station. The changes are advertised with bits
2370 * from &enum ieee80211_rate_control_changed and the values are reflected
2371 * in the station data. This callback should only be used when the driver
2372 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
2373 * otherwise the rate control algorithm is notified directly.
2374 * Must be atomic.
2375 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002376 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
Johannes Bergfe3fa822008-09-08 11:05:09 +02002377 * bursting) for a hardware TX queue.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05002378 * Returns a negative error code on failure.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002379 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002380 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002381 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01002382 * this is only used for IBSS mode BSSID merging and debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01002383 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002384 * The callback can sleep.
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01002385 *
2386 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
2387 * Currently, this is only used for IBSS mode debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01002388 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002389 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002390 *
2391 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
2392 * with other STAs in the IBSS. This is only used in IBSS mode. This
2393 * function is optional if the firmware/hardware takes full care of
2394 * TSF synchronization.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002395 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002396 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002397 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
2398 * This is needed only for IBSS mode and the result of this function is
2399 * used to determine whether to reply to Probe Requests.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05002400 * Returns non-zero if this device sent the last beacon.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002401 * The callback can sleep.
Ron Rindjunskyd3c990f2007-11-26 16:14:34 +02002402 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02002403 * @ampdu_action: Perform a certain A-MPDU action
2404 * The RA/TID combination determines the destination and TID we want
2405 * the ampdu action to be performed for. The action is defined through
2406 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
Bob Copeland6dd1bf32009-01-08 21:00:34 -05002407 * is the first frame we expect to perform the action on. Notice
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002408 * that TX/RX_STOP can pass NULL for this parameter.
Johannes Berg0b01f032011-01-18 13:51:05 +01002409 * The @buf_size parameter is only valid when the action is set to
2410 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
Johannes Berg5312c3f2011-04-01 13:52:34 +02002411 * buffer size (number of subframes) for this session -- the driver
2412 * may neither send aggregates containing more subframes than this
2413 * nor send aggregates in a way that lost frames would exceed the
2414 * buffer size. If just limiting the aggregate size, this would be
2415 * possible with a buf_size of 8:
2416 * - TX: 1.....7
2417 * - RX: 2....7 (lost frame #1)
2418 * - TX: 8..1...
2419 * which is invalid since #1 was now re-transmitted well past the
2420 * buffer size of 8. Correct ways to retransmit #1 would be:
2421 * - TX: 1 or 18 or 81
2422 * Even "189" would be wrong since 1 could be lost again.
2423 *
Bob Copeland6dd1bf32009-01-08 21:00:34 -05002424 * Returns a negative error code on failure.
Johannes Berg85ad1812010-06-10 10:21:49 +02002425 * The callback can sleep.
Johannes Berg1f87f7d2009-06-02 13:01:41 +02002426 *
Randy Dunlap4e8998f2010-05-21 11:28:33 -07002427 * @get_survey: Return per-channel survey information
2428 *
Johannes Berg1f87f7d2009-06-02 13:01:41 +02002429 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
2430 * need to set wiphy->rfkill_poll to %true before registration,
2431 * and need to call wiphy_rfkill_set_hw_state() in the callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002432 * The callback can sleep.
Johannes Bergaff89a92009-07-01 21:26:51 +02002433 *
Lukáš Turek310bc672009-12-21 22:50:48 +01002434 * @set_coverage_class: Set slot time for given coverage class as specified
2435 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
2436 * accordingly. This callback is not required and may sleep.
2437 *
Johannes Bergaff89a92009-07-01 21:26:51 +02002438 * @testmode_cmd: Implement a cfg80211 test mode command.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002439 * The callback can sleep.
Wey-Yi Guy71063f02011-05-20 09:05:54 -07002440 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
Johannes Berga80f7c02009-12-23 13:15:32 +01002441 *
2442 * @flush: Flush all pending frames from the hardware queue, making sure
Johannes Berg39ecc012013-02-13 12:11:00 +01002443 * that the hardware queues are empty. The @queues parameter is a bitmap
2444 * of queues to flush, which is useful if different virtual interfaces
2445 * use different hardware queues; it may also indicate all queues.
2446 * If the parameter @drop is set to %true, pending frames may be dropped.
2447 * The callback can sleep.
Johannes Berg5ce6e432010-05-11 16:20:57 +02002448 *
2449 * @channel_switch: Drivers that need (or want) to offload the channel
2450 * switch operation for CSAs received from the AP may implement this
2451 * callback. They must then call ieee80211_chswitch_done() to indicate
2452 * completion of the channel switch.
John W. Linville4e6cbfd2010-07-29 16:14:13 -04002453 *
2454 * @napi_poll: Poll Rx queue for incoming data frames.
Bruno Randolf79b1c462010-11-24 14:34:41 +09002455 *
2456 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2457 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2458 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2459 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2460 *
2461 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
Johannes Berg4976b4e2011-01-04 13:02:32 +01002462 *
2463 * @remain_on_channel: Starts an off-channel period on the given channel, must
2464 * call back to ieee80211_ready_on_channel() when on that channel. Note
2465 * that normal channel traffic is not stopped as this is intended for hw
2466 * offload. Frames to transmit on the off-channel channel are transmitted
2467 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
2468 * duration (which will always be non-zero) expires, the driver must call
Johannes Berg196ac1c2012-06-05 14:28:40 +02002469 * ieee80211_remain_on_channel_expired().
Johannes Berg196ac1c2012-06-05 14:28:40 +02002470 * Note that this callback may be called while the device is in IDLE and
2471 * must be accepted in this case.
2472 * This callback may sleep.
Johannes Berg4976b4e2011-01-04 13:02:32 +01002473 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
2474 * aborted before it expires. This callback may sleep.
John W. Linville38c09152011-03-07 16:19:18 -05002475 *
2476 * @set_ringparam: Set tx and rx ring sizes.
2477 *
2478 * @get_ringparam: Get tx and rx ring current and maximum sizes.
Vivek Natarajane8306f92011-04-06 11:41:10 +05302479 *
2480 * @tx_frames_pending: Check if there is any pending frame in the hardware
2481 * queues before entering power save.
Sujith Manoharanbdbfd6b2011-04-27 16:56:51 +05302482 *
2483 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
2484 * when transmitting a frame. Currently only legacy rates are handled.
2485 * The callback can sleep.
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -07002486 * @rssi_callback: Notify driver when the average RSSI goes above/below
2487 * thresholds that were registered previously. The callback can sleep.
Johannes Berg4049e092011-09-29 16:04:32 +02002488 *
2489 * @release_buffered_frames: Release buffered frames according to the given
2490 * parameters. In the case where the driver buffers some frames for
2491 * sleeping stations mac80211 will use this callback to tell the driver
2492 * to release some frames, either for PS-poll or uAPSD.
2493 * Note that if the @more_data paramter is %false the driver must check
2494 * if there are more frames on the given TIDs, and if there are more than
2495 * the frames being released then it must still set the more-data bit in
2496 * the frame. If the @more_data parameter is %true, then of course the
2497 * more-data bit must always be set.
2498 * The @tids parameter tells the driver which TIDs to release frames
2499 * from, for PS-poll it will always have only a single bit set.
Johannes Bergdeeaee12011-09-29 16:04:35 +02002500 * In the case this is used for a PS-poll initiated release, the
2501 * @num_frames parameter will always be 1 so code can be shared. In
2502 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
2503 * on the TX status (and must report TX status) so that the PS-poll
2504 * period is properly ended. This is used to avoid sending multiple
2505 * responses for a retried PS-poll frame.
Johannes Berg4049e092011-09-29 16:04:32 +02002506 * In the case this is used for uAPSD, the @num_frames parameter may be
2507 * bigger than one, but the driver may send fewer frames (it must send
2508 * at least one, however). In this case it is also responsible for
Johannes Berg47086fc2011-09-29 16:04:33 +02002509 * setting the EOSP flag in the QoS header of the frames. Also, when the
2510 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
Johannes Berg37fbd902011-09-29 16:04:39 +02002511 * on the last frame in the SP. Alternatively, it may call the function
Johannes Berge9437892013-02-15 21:38:08 +01002512 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
Johannes Berg4049e092011-09-29 16:04:32 +02002513 * This callback must be atomic.
Johannes Berg40b96402011-09-29 16:04:38 +02002514 * @allow_buffered_frames: Prepare device to allow the given number of frames
2515 * to go out to the given station. The frames will be sent by mac80211
2516 * via the usual TX path after this call. The TX information for frames
Johannes Berg02f2f1a2012-02-27 12:18:30 +01002517 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
Johannes Berg40b96402011-09-29 16:04:38 +02002518 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
2519 * frames from multiple TIDs are released and the driver might reorder
2520 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
2521 * on the last frame and clear it on all others and also handle the EOSP
Johannes Berg37fbd902011-09-29 16:04:39 +02002522 * bit in the QoS header correctly. Alternatively, it can also call the
Johannes Berge9437892013-02-15 21:38:08 +01002523 * ieee80211_sta_eosp() function.
Johannes Berg40b96402011-09-29 16:04:38 +02002524 * The @tids parameter is a bitmap and tells the driver which TIDs the
2525 * frames will be on; it will at most have two bits set.
2526 * This callback must be atomic.
Ben Greeare3521142012-04-23 12:50:31 -07002527 *
2528 * @get_et_sset_count: Ethtool API to get string-set count.
2529 *
2530 * @get_et_stats: Ethtool API to get a set of u64 stats.
2531 *
2532 * @get_et_strings: Ethtool API to get a set of strings to describe stats
2533 * and perhaps other supported types of ethtool data-sets.
2534 *
Victor Goldenshtein66572cf2012-06-21 10:56:46 +03002535 * @get_rssi: Get current signal strength in dBm, the function is optional
2536 * and can sleep.
2537 *
Johannes Berga1845fc2012-06-27 13:18:36 +02002538 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
2539 * before associated. In multi-channel scenarios, a virtual interface is
2540 * bound to a channel before it is associated, but as it isn't associated
2541 * yet it need not necessarily be given airtime, in particular since any
2542 * transmission to a P2P GO needs to be synchronized against the GO's
2543 * powersave state. mac80211 will call this function before transmitting a
2544 * management frame prior to having successfully associated to allow the
2545 * driver to give it channel time for the transmission, to get a response
2546 * and to be able to synchronize with the GO.
2547 * The callback will be called before each transmission and upon return
2548 * mac80211 will transmit the frame right away.
2549 * The callback is optional and can (should!) sleep.
Michal Kaziorc3645ea2012-06-26 14:37:17 +02002550 *
2551 * @add_chanctx: Notifies device driver about new channel context creation.
2552 * @remove_chanctx: Notifies device driver about channel context destruction.
2553 * @change_chanctx: Notifies device driver about channel context changes that
2554 * may happen when combining different virtual interfaces on the same
2555 * channel context with different settings
2556 * @assign_vif_chanctx: Notifies device driver about channel context being bound
2557 * to vif. Possible use is for hw queue remapping.
2558 * @unassign_vif_chanctx: Notifies device driver about channel context being
2559 * unbound from vif.
Johannes Berg10416382012-10-19 15:44:42 +02002560 * @start_ap: Start operation on the AP interface, this is called after all the
2561 * information in bss_conf is set and beacon can be retrieved. A channel
2562 * context is bound before this is called. Note that if the driver uses
2563 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
2564 * just "paused" for scanning/ROC, which is indicated by the beacon being
2565 * disabled/enabled via @bss_info_changed.
2566 * @stop_ap: Stop operation on the AP interface.
Johannes Berg9214ad72012-11-06 19:18:13 +01002567 *
2568 * @restart_complete: Called after a call to ieee80211_restart_hw(), when the
2569 * reconfiguration has completed. This can help the driver implement the
Johannes Berg8f21b0a2013-01-11 00:28:01 +01002570 * reconfiguration step. Also called when reconfiguring because the
2571 * driver's resume function returned 1, as this is just like an "inline"
2572 * hardware restart. This callback may sleep.
2573 *
Johannes Berga65240c2013-01-14 15:14:34 +01002574 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
2575 * Currently, this is only called for managed or P2P client interfaces.
2576 * This callback is optional; it must not sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002577 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002578struct ieee80211_ops {
Thomas Huehn36323f82012-07-23 21:33:42 +02002579 void (*tx)(struct ieee80211_hw *hw,
2580 struct ieee80211_tx_control *control,
2581 struct sk_buff *skb);
Johannes Berg4150c572007-09-17 01:29:23 -04002582 int (*start)(struct ieee80211_hw *hw);
Johannes Berg4150c572007-09-17 01:29:23 -04002583 void (*stop)(struct ieee80211_hw *hw);
Johannes Bergeecc4802011-05-04 15:37:29 +02002584#ifdef CONFIG_PM
2585 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
2586 int (*resume)(struct ieee80211_hw *hw);
Johannes Berg6d525632012-04-04 15:05:25 +02002587 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
Johannes Bergeecc4802011-05-04 15:37:29 +02002588#endif
Jiri Bencf0706e82007-05-05 11:45:53 -07002589 int (*add_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01002590 struct ieee80211_vif *vif);
Johannes Berg34d4bc42010-08-27 12:35:58 +02002591 int (*change_interface)(struct ieee80211_hw *hw,
2592 struct ieee80211_vif *vif,
Johannes Berg2ca27bc2010-09-16 14:58:23 +02002593 enum nl80211_iftype new_type, bool p2p);
Jiri Bencf0706e82007-05-05 11:45:53 -07002594 void (*remove_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01002595 struct ieee80211_vif *vif);
Johannes Berge8975582008-10-09 12:18:51 +02002596 int (*config)(struct ieee80211_hw *hw, u32 changed);
Johannes Berg471b3ef2007-12-28 14:32:58 +01002597 void (*bss_info_changed)(struct ieee80211_hw *hw,
2598 struct ieee80211_vif *vif,
2599 struct ieee80211_bss_conf *info,
2600 u32 changed);
Johannes Bergb2abb6e2011-07-19 10:39:53 +02002601
Johannes Berg10416382012-10-19 15:44:42 +02002602 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2603 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2604
Johannes Berg3ac64be2009-08-17 16:16:53 +02002605 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
Jiri Pirko22bedad32010-04-01 21:22:57 +00002606 struct netdev_hw_addr_list *mc_list);
Johannes Berg4150c572007-09-17 01:29:23 -04002607 void (*configure_filter)(struct ieee80211_hw *hw,
2608 unsigned int changed_flags,
2609 unsigned int *total_flags,
Johannes Berg3ac64be2009-08-17 16:16:53 +02002610 u64 multicast);
Alexander Bondar488b3662013-02-11 14:56:29 +02002611 void (*set_multicast_list)(struct ieee80211_hw *hw,
2612 struct ieee80211_vif *vif, bool allmulti,
2613 struct netdev_hw_addr_list *mc_list);
2614
Johannes Berg17741cd2008-09-11 00:02:02 +02002615 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
2616 bool set);
Johannes Bergea49c352007-09-18 17:29:21 -04002617 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
Johannes Bergdc822b52008-12-29 12:55:09 +01002618 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
Johannes Berg11a843b2007-08-28 17:01:55 -04002619 struct ieee80211_key_conf *key);
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02002620 void (*update_tkip_key)(struct ieee80211_hw *hw,
Johannes Bergb3fbdcf2010-01-21 11:40:47 +01002621 struct ieee80211_vif *vif,
2622 struct ieee80211_key_conf *conf,
2623 struct ieee80211_sta *sta,
2624 u32 iv32, u16 *phase1key);
Johannes Bergc68f4b82011-07-05 16:35:41 +02002625 void (*set_rekey_data)(struct ieee80211_hw *hw,
2626 struct ieee80211_vif *vif,
2627 struct cfg80211_gtk_rekey_data *data);
Yoni Divinskyde5fad82012-05-30 11:36:39 +03002628 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
2629 struct ieee80211_vif *vif, int idx);
Johannes Berga060bbf2010-04-27 11:59:34 +02002630 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg2a519312009-02-10 21:25:55 +01002631 struct cfg80211_scan_request *req);
Eliad Pellerb8564392011-06-13 12:47:30 +03002632 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
2633 struct ieee80211_vif *vif);
Luciano Coelho79f460c2011-05-11 17:09:36 +03002634 int (*sched_scan_start)(struct ieee80211_hw *hw,
2635 struct ieee80211_vif *vif,
2636 struct cfg80211_sched_scan_request *req,
2637 struct ieee80211_sched_scan_ies *ies);
2638 void (*sched_scan_stop)(struct ieee80211_hw *hw,
2639 struct ieee80211_vif *vif);
Michael Buesch80e775b2009-02-20 15:37:03 +01002640 void (*sw_scan_start)(struct ieee80211_hw *hw);
2641 void (*sw_scan_complete)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07002642 int (*get_stats)(struct ieee80211_hw *hw,
2643 struct ieee80211_low_level_stats *stats);
Johannes Berg62da92f2007-12-19 02:03:31 +01002644 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
2645 u32 *iv32, u16 *iv16);
Arik Nemtsovf23a4782010-11-08 11:51:06 +02002646 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
Jiri Bencf0706e82007-05-05 11:45:53 -07002647 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
Johannes Berg34e89502010-02-03 13:59:58 +01002648 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2649 struct ieee80211_sta *sta);
2650 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2651 struct ieee80211_sta *sta);
Sujith Manoharan77d2ece2012-11-20 08:46:02 +05302652#ifdef CONFIG_MAC80211_DEBUGFS
2653 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
2654 struct ieee80211_vif *vif,
2655 struct ieee80211_sta *sta,
2656 struct dentry *dir);
2657 void (*sta_remove_debugfs)(struct ieee80211_hw *hw,
2658 struct ieee80211_vif *vif,
2659 struct ieee80211_sta *sta,
2660 struct dentry *dir);
2661#endif
Johannes Berg32bfd352007-12-19 01:31:26 +01002662 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02002663 enum sta_notify_cmd, struct ieee80211_sta *sta);
Johannes Bergf09603a2012-01-20 13:55:21 +01002664 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2665 struct ieee80211_sta *sta,
2666 enum ieee80211_sta_state old_state,
2667 enum ieee80211_sta_state new_state);
Johannes Berg8f727ef2012-03-30 08:43:32 +02002668 void (*sta_rc_update)(struct ieee80211_hw *hw,
2669 struct ieee80211_vif *vif,
2670 struct ieee80211_sta *sta,
2671 u32 changed);
Eliad Peller8a3a3c82011-10-02 10:15:52 +02002672 int (*conf_tx)(struct ieee80211_hw *hw,
Johannes Berga3304b02012-03-28 11:04:24 +02002673 struct ieee80211_vif *vif, u16 ac,
Jiri Bencf0706e82007-05-05 11:45:53 -07002674 const struct ieee80211_tx_queue_params *params);
Eliad Peller37a41b42011-09-21 14:06:11 +03002675 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2676 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2677 u64 tsf);
2678 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07002679 int (*tx_last_beacon)(struct ieee80211_hw *hw);
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02002680 int (*ampdu_action)(struct ieee80211_hw *hw,
Johannes Bergc951ad32009-11-16 12:00:38 +01002681 struct ieee80211_vif *vif,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02002682 enum ieee80211_ampdu_mlme_action action,
Johannes Berg0b01f032011-01-18 13:51:05 +01002683 struct ieee80211_sta *sta, u16 tid, u16 *ssn,
2684 u8 buf_size);
Holger Schurig12897232010-04-19 10:23:57 +02002685 int (*get_survey)(struct ieee80211_hw *hw, int idx,
2686 struct survey_info *survey);
Johannes Berg1f87f7d2009-06-02 13:01:41 +02002687 void (*rfkill_poll)(struct ieee80211_hw *hw);
Lukáš Turek310bc672009-12-21 22:50:48 +01002688 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
Johannes Bergaff89a92009-07-01 21:26:51 +02002689#ifdef CONFIG_NL80211_TESTMODE
2690 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
Wey-Yi Guy71063f02011-05-20 09:05:54 -07002691 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
2692 struct netlink_callback *cb,
2693 void *data, int len);
Johannes Bergaff89a92009-07-01 21:26:51 +02002694#endif
Johannes Berg39ecc012013-02-13 12:11:00 +01002695 void (*flush)(struct ieee80211_hw *hw, u32 queues, bool drop);
Johannes Berg5ce6e432010-05-11 16:20:57 +02002696 void (*channel_switch)(struct ieee80211_hw *hw,
2697 struct ieee80211_channel_switch *ch_switch);
John W. Linville4e6cbfd2010-07-29 16:14:13 -04002698 int (*napi_poll)(struct ieee80211_hw *hw, int budget);
Bruno Randolf15d96752010-11-10 12:50:56 +09002699 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
2700 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
Johannes Berg21f83582010-12-18 17:20:47 +01002701
2702 int (*remain_on_channel)(struct ieee80211_hw *hw,
Eliad Peller49884562012-11-19 17:05:09 +02002703 struct ieee80211_vif *vif,
Johannes Berg21f83582010-12-18 17:20:47 +01002704 struct ieee80211_channel *chan,
Ilan Peerd339d5c2013-02-12 09:34:13 +02002705 int duration,
2706 enum ieee80211_roc_type type);
Johannes Berg21f83582010-12-18 17:20:47 +01002707 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
John W. Linville38c09152011-03-07 16:19:18 -05002708 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
2709 void (*get_ringparam)(struct ieee80211_hw *hw,
2710 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
Vivek Natarajane8306f92011-04-06 11:41:10 +05302711 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
Sujith Manoharanbdbfd6b2011-04-27 16:56:51 +05302712 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2713 const struct cfg80211_bitrate_mask *mask);
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -07002714 void (*rssi_callback)(struct ieee80211_hw *hw,
Emmanuel Grumbach887da912013-01-20 17:32:41 +02002715 struct ieee80211_vif *vif,
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -07002716 enum ieee80211_rssi_event rssi_event);
Johannes Berg4049e092011-09-29 16:04:32 +02002717
Johannes Berg40b96402011-09-29 16:04:38 +02002718 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
2719 struct ieee80211_sta *sta,
2720 u16 tids, int num_frames,
2721 enum ieee80211_frame_release_type reason,
2722 bool more_data);
Johannes Berg4049e092011-09-29 16:04:32 +02002723 void (*release_buffered_frames)(struct ieee80211_hw *hw,
2724 struct ieee80211_sta *sta,
2725 u16 tids, int num_frames,
2726 enum ieee80211_frame_release_type reason,
2727 bool more_data);
Ben Greeare3521142012-04-23 12:50:31 -07002728
2729 int (*get_et_sset_count)(struct ieee80211_hw *hw,
2730 struct ieee80211_vif *vif, int sset);
2731 void (*get_et_stats)(struct ieee80211_hw *hw,
2732 struct ieee80211_vif *vif,
2733 struct ethtool_stats *stats, u64 *data);
2734 void (*get_et_strings)(struct ieee80211_hw *hw,
2735 struct ieee80211_vif *vif,
2736 u32 sset, u8 *data);
Victor Goldenshtein66572cf2012-06-21 10:56:46 +03002737 int (*get_rssi)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2738 struct ieee80211_sta *sta, s8 *rssi_dbm);
Johannes Berga1845fc2012-06-27 13:18:36 +02002739
2740 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
2741 struct ieee80211_vif *vif);
Michal Kaziorc3645ea2012-06-26 14:37:17 +02002742
2743 int (*add_chanctx)(struct ieee80211_hw *hw,
2744 struct ieee80211_chanctx_conf *ctx);
2745 void (*remove_chanctx)(struct ieee80211_hw *hw,
2746 struct ieee80211_chanctx_conf *ctx);
2747 void (*change_chanctx)(struct ieee80211_hw *hw,
2748 struct ieee80211_chanctx_conf *ctx,
2749 u32 changed);
2750 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
2751 struct ieee80211_vif *vif,
2752 struct ieee80211_chanctx_conf *ctx);
2753 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
2754 struct ieee80211_vif *vif,
2755 struct ieee80211_chanctx_conf *ctx);
Johannes Berg9214ad72012-11-06 19:18:13 +01002756
2757 void (*restart_complete)(struct ieee80211_hw *hw);
Johannes Berga65240c2013-01-14 15:14:34 +01002758
2759#if IS_ENABLED(CONFIG_IPV6)
2760 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
2761 struct ieee80211_vif *vif,
2762 struct inet6_dev *idev);
2763#endif
Jiri Bencf0706e82007-05-05 11:45:53 -07002764};
2765
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002766/**
2767 * ieee80211_alloc_hw - Allocate a new hardware device
2768 *
2769 * This must be called once for each hardware device. The returned pointer
2770 * must be used to refer to this device when calling other functions.
2771 * mac80211 allocates a private data area for the driver pointed to by
2772 * @priv in &struct ieee80211_hw, the size of this area is given as
2773 * @priv_data_len.
2774 *
2775 * @priv_data_len: length of private data
2776 * @ops: callbacks for this device
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01002777 *
2778 * Return: A pointer to the new hardware device, or %NULL on error.
Jiri Bencf0706e82007-05-05 11:45:53 -07002779 */
2780struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
2781 const struct ieee80211_ops *ops);
2782
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002783/**
2784 * ieee80211_register_hw - Register hardware device
2785 *
Johannes Bergdbbea672008-02-26 14:34:06 +01002786 * You must call this function before any other functions in
2787 * mac80211. Note that before a hardware can be registered, you
2788 * need to fill the contained wiphy's information.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002789 *
2790 * @hw: the device to register as returned by ieee80211_alloc_hw()
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01002791 *
2792 * Return: 0 on success. An error code otherwise.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002793 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002794int ieee80211_register_hw(struct ieee80211_hw *hw);
2795
Johannes Berge1e54062010-11-30 08:58:45 +01002796/**
2797 * struct ieee80211_tpt_blink - throughput blink description
2798 * @throughput: throughput in Kbit/sec
2799 * @blink_time: blink time in milliseconds
2800 * (full cycle, ie. one off + one on period)
2801 */
2802struct ieee80211_tpt_blink {
2803 int throughput;
2804 int blink_time;
2805};
2806
Johannes Berg67408c82010-11-30 08:59:23 +01002807/**
2808 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
2809 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
2810 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
2811 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
2812 * interface is connected in some way, including being an AP
2813 */
2814enum ieee80211_tpt_led_trigger_flags {
2815 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
2816 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
2817 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
2818};
2819
Jiri Bencf0706e82007-05-05 11:45:53 -07002820#ifdef CONFIG_MAC80211_LEDS
2821extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
2822extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
Michael Buesch47f0c502007-09-27 15:10:44 +02002823extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
Ivo van Doorncdcb0062008-01-07 19:45:24 +01002824extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
Johannes Berge1e54062010-11-30 08:58:45 +01002825extern char *__ieee80211_create_tpt_led_trigger(
Johannes Berg67408c82010-11-30 08:59:23 +01002826 struct ieee80211_hw *hw, unsigned int flags,
Johannes Berge1e54062010-11-30 08:58:45 +01002827 const struct ieee80211_tpt_blink *blink_table,
2828 unsigned int blink_table_len);
Jiri Bencf0706e82007-05-05 11:45:53 -07002829#endif
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002830/**
2831 * ieee80211_get_tx_led_name - get name of TX LED
2832 *
2833 * mac80211 creates a transmit LED trigger for each wireless hardware
2834 * that can be used to drive LEDs if your driver registers a LED device.
2835 * This function returns the name (or %NULL if not configured for LEDs)
2836 * of the trigger so you can automatically link the LED device.
2837 *
2838 * @hw: the hardware to get the LED trigger name for
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01002839 *
2840 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002841 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002842static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
2843{
2844#ifdef CONFIG_MAC80211_LEDS
2845 return __ieee80211_get_tx_led_name(hw);
2846#else
2847 return NULL;
2848#endif
2849}
2850
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002851/**
2852 * ieee80211_get_rx_led_name - get name of RX LED
2853 *
2854 * mac80211 creates a receive LED trigger for each wireless hardware
2855 * that can be used to drive LEDs if your driver registers a LED device.
2856 * This function returns the name (or %NULL if not configured for LEDs)
2857 * of the trigger so you can automatically link the LED device.
2858 *
2859 * @hw: the hardware to get the LED trigger name for
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01002860 *
2861 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002862 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002863static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
2864{
2865#ifdef CONFIG_MAC80211_LEDS
2866 return __ieee80211_get_rx_led_name(hw);
2867#else
2868 return NULL;
2869#endif
2870}
2871
Ivo van Doorncdcb0062008-01-07 19:45:24 +01002872/**
2873 * ieee80211_get_assoc_led_name - get name of association LED
2874 *
2875 * mac80211 creates a association LED trigger for each wireless hardware
2876 * that can be used to drive LEDs if your driver registers a LED device.
2877 * This function returns the name (or %NULL if not configured for LEDs)
2878 * of the trigger so you can automatically link the LED device.
2879 *
2880 * @hw: the hardware to get the LED trigger name for
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01002881 *
2882 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
Ivo van Doorncdcb0062008-01-07 19:45:24 +01002883 */
Michael Buesch47f0c502007-09-27 15:10:44 +02002884static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
2885{
2886#ifdef CONFIG_MAC80211_LEDS
2887 return __ieee80211_get_assoc_led_name(hw);
2888#else
2889 return NULL;
2890#endif
2891}
2892
Ivo van Doorncdcb0062008-01-07 19:45:24 +01002893/**
2894 * ieee80211_get_radio_led_name - get name of radio LED
2895 *
2896 * mac80211 creates a radio change LED trigger for each wireless hardware
2897 * that can be used to drive LEDs if your driver registers a LED device.
2898 * This function returns the name (or %NULL if not configured for LEDs)
2899 * of the trigger so you can automatically link the LED device.
2900 *
2901 * @hw: the hardware to get the LED trigger name for
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01002902 *
2903 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
Ivo van Doorncdcb0062008-01-07 19:45:24 +01002904 */
2905static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
2906{
2907#ifdef CONFIG_MAC80211_LEDS
2908 return __ieee80211_get_radio_led_name(hw);
2909#else
2910 return NULL;
2911#endif
2912}
Michael Buesch47f0c502007-09-27 15:10:44 +02002913
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002914/**
Johannes Berge1e54062010-11-30 08:58:45 +01002915 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
2916 * @hw: the hardware to create the trigger for
Johannes Berg67408c82010-11-30 08:59:23 +01002917 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
Johannes Berge1e54062010-11-30 08:58:45 +01002918 * @blink_table: the blink table -- needs to be ordered by throughput
2919 * @blink_table_len: size of the blink table
2920 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01002921 * Return: %NULL (in case of error, or if no LED triggers are
2922 * configured) or the name of the new trigger.
2923 *
2924 * Note: This function must be called before ieee80211_register_hw().
Johannes Berge1e54062010-11-30 08:58:45 +01002925 */
2926static inline char *
Johannes Berg67408c82010-11-30 08:59:23 +01002927ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
Johannes Berge1e54062010-11-30 08:58:45 +01002928 const struct ieee80211_tpt_blink *blink_table,
2929 unsigned int blink_table_len)
2930{
2931#ifdef CONFIG_MAC80211_LEDS
Johannes Berg67408c82010-11-30 08:59:23 +01002932 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
Johannes Berge1e54062010-11-30 08:58:45 +01002933 blink_table_len);
2934#else
2935 return NULL;
2936#endif
2937}
2938
2939/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002940 * ieee80211_unregister_hw - Unregister a hardware device
2941 *
2942 * This function instructs mac80211 to free allocated resources
2943 * and unregister netdevices from the networking subsystem.
2944 *
2945 * @hw: the hardware to unregister
2946 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002947void ieee80211_unregister_hw(struct ieee80211_hw *hw);
2948
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002949/**
2950 * ieee80211_free_hw - free hardware descriptor
2951 *
2952 * This function frees everything that was allocated, including the
2953 * private data for the driver. You must call ieee80211_unregister_hw()
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002954 * before calling this function.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002955 *
2956 * @hw: the hardware to free
2957 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002958void ieee80211_free_hw(struct ieee80211_hw *hw);
2959
Johannes Bergf2753dd2009-04-14 10:09:24 +02002960/**
2961 * ieee80211_restart_hw - restart hardware completely
2962 *
2963 * Call this function when the hardware was restarted for some reason
2964 * (hardware error, ...) and the driver is unable to restore its state
2965 * by itself. mac80211 assumes that at this point the driver/hardware
2966 * is completely uninitialised and stopped, it starts the process by
2967 * calling the ->start() operation. The driver will need to reset all
2968 * internal state that it has prior to calling this function.
2969 *
2970 * @hw: the hardware to restart
2971 */
2972void ieee80211_restart_hw(struct ieee80211_hw *hw);
2973
John W. Linville4e6cbfd2010-07-29 16:14:13 -04002974/** ieee80211_napi_schedule - schedule NAPI poll
2975 *
2976 * Use this function to schedule NAPI polling on a device.
2977 *
2978 * @hw: the hardware to start polling
2979 */
2980void ieee80211_napi_schedule(struct ieee80211_hw *hw);
2981
2982/** ieee80211_napi_complete - complete NAPI polling
2983 *
2984 * Use this function to finish NAPI polling on a device.
2985 *
2986 * @hw: the hardware to stop polling
2987 */
2988void ieee80211_napi_complete(struct ieee80211_hw *hw);
2989
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002990/**
2991 * ieee80211_rx - receive frame
2992 *
2993 * Use this function to hand received frames to mac80211. The receive
Zhu Yie3cf8b32010-03-29 17:35:07 +08002994 * buffer in @skb must start with an IEEE 802.11 header. In case of a
2995 * paged @skb is used, the driver is recommended to put the ieee80211
2996 * header of the frame on the linear part of the @skb to avoid memory
2997 * allocation and/or memcpy by the stack.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002998 *
Johannes Berg2485f712008-02-25 16:27:41 +01002999 * This function may not be called in IRQ context. Calls to this function
Kalle Valoe36e49f2009-10-13 20:33:13 +03003000 * for a single hardware must be synchronized against each other. Calls to
3001 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3002 * mixed for a single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003003 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03003004 * In process context use instead ieee80211_rx_ni().
Johannes Bergd20ef632009-10-11 15:10:40 +02003005 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003006 * @hw: the hardware this frame came in on
3007 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003008 */
John W. Linville103bf9f2009-08-20 16:34:15 -04003009void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003010
3011/**
3012 * ieee80211_rx_irqsafe - receive frame
3013 *
3014 * Like ieee80211_rx() but can be called in IRQ context
Johannes Berg2485f712008-02-25 16:27:41 +01003015 * (internally defers to a tasklet.)
3016 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03003017 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
3018 * be mixed for a single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003019 *
3020 * @hw: the hardware this frame came in on
3021 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003022 */
Johannes Bergf1d58c22009-06-17 13:13:00 +02003023void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07003024
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003025/**
Kalle Valoe36e49f2009-10-13 20:33:13 +03003026 * ieee80211_rx_ni - receive frame (in process context)
3027 *
3028 * Like ieee80211_rx() but can be called in process context
3029 * (internally disables bottom halves).
3030 *
3031 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
3032 * not be mixed for a single hardware.
3033 *
3034 * @hw: the hardware this frame came in on
3035 * @skb: the buffer to receive, owned by mac80211 after this call
3036 */
3037static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
3038 struct sk_buff *skb)
3039{
3040 local_bh_disable();
3041 ieee80211_rx(hw, skb);
3042 local_bh_enable();
3043}
3044
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02003045/**
3046 * ieee80211_sta_ps_transition - PS transition for connected sta
3047 *
3048 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
3049 * flag set, use this function to inform mac80211 about a connected station
3050 * entering/leaving PS mode.
3051 *
3052 * This function may not be called in IRQ context or with softirqs enabled.
3053 *
3054 * Calls to this function for a single hardware must be synchronized against
3055 * each other.
3056 *
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02003057 * @sta: currently connected sta
3058 * @start: start or stop PS
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003059 *
3060 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02003061 */
3062int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
3063
3064/**
3065 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
3066 * (in process context)
3067 *
3068 * Like ieee80211_sta_ps_transition() but can be called in process context
3069 * (internally disables bottom halves). Concurrent call restriction still
3070 * applies.
3071 *
3072 * @sta: currently connected sta
3073 * @start: start or stop PS
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003074 *
3075 * Return: Like ieee80211_sta_ps_transition().
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02003076 */
3077static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
3078 bool start)
3079{
3080 int ret;
3081
3082 local_bh_disable();
3083 ret = ieee80211_sta_ps_transition(sta, start);
3084 local_bh_enable();
3085
3086 return ret;
3087}
3088
Gertjan van Wingerded24deb22009-12-04 23:46:54 +01003089/*
3090 * The TX headroom reserved by mac80211 for its own tx_status functions.
3091 * This is enough for the radiotap header.
3092 */
Helmut Schaa7f2a5e22011-10-11 18:08:55 +02003093#define IEEE80211_TX_STATUS_HEADROOM 14
Gertjan van Wingerded24deb22009-12-04 23:46:54 +01003094
Kalle Valoe36e49f2009-10-13 20:33:13 +03003095/**
Johannes Berg042ec452011-09-29 16:04:26 +02003096 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
Randy Dunlapbdfbe802011-05-22 17:22:45 -07003097 * @sta: &struct ieee80211_sta pointer for the sleeping station
Johannes Berg042ec452011-09-29 16:04:26 +02003098 * @tid: the TID that has buffered frames
3099 * @buffered: indicates whether or not frames are buffered for this TID
Felix Fietkaudcf55fb2011-04-17 17:45:00 +02003100 *
3101 * If a driver buffers frames for a powersave station instead of passing
Johannes Berg042ec452011-09-29 16:04:26 +02003102 * them back to mac80211 for retransmission, the station may still need
3103 * to be told that there are buffered frames via the TIM bit.
Felix Fietkaudcf55fb2011-04-17 17:45:00 +02003104 *
Johannes Berg042ec452011-09-29 16:04:26 +02003105 * This function informs mac80211 whether or not there are frames that are
3106 * buffered in the driver for a given TID; mac80211 can then use this data
3107 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
3108 * call! Beware of the locking!)
3109 *
3110 * If all frames are released to the station (due to PS-poll or uAPSD)
3111 * then the driver needs to inform mac80211 that there no longer are
3112 * frames buffered. However, when the station wakes up mac80211 assumes
3113 * that all buffered frames will be transmitted and clears this data,
3114 * drivers need to make sure they inform mac80211 about all buffered
3115 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
3116 *
3117 * Note that technically mac80211 only needs to know this per AC, not per
3118 * TID, but since driver buffering will inevitably happen per TID (since
3119 * it is related to aggregation) it is easier to make mac80211 map the
3120 * TID to the AC as required instead of keeping track in all drivers that
3121 * use this API.
Felix Fietkaudcf55fb2011-04-17 17:45:00 +02003122 */
Johannes Berg042ec452011-09-29 16:04:26 +02003123void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
3124 u8 tid, bool buffered);
Felix Fietkaudcf55fb2011-04-17 17:45:00 +02003125
3126/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003127 * ieee80211_tx_status - transmit status callback
3128 *
3129 * Call this function for all transmitted frames after they have been
3130 * transmitted. It is permissible to not call this function for
3131 * multicast frames but this can affect statistics.
3132 *
Johannes Berg2485f712008-02-25 16:27:41 +01003133 * This function may not be called in IRQ context. Calls to this function
3134 * for a single hardware must be synchronized against each other. Calls
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01003135 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
3136 * may not be mixed for a single hardware.
Johannes Berg2485f712008-02-25 16:27:41 +01003137 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003138 * @hw: the hardware the frame was transmitted by
3139 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003140 */
Jiri Bencf0706e82007-05-05 11:45:53 -07003141void ieee80211_tx_status(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02003142 struct sk_buff *skb);
Johannes Berg2485f712008-02-25 16:27:41 +01003143
3144/**
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01003145 * ieee80211_tx_status_ni - transmit status callback (in process context)
3146 *
3147 * Like ieee80211_tx_status() but can be called in process context.
3148 *
3149 * Calls to this function, ieee80211_tx_status() and
3150 * ieee80211_tx_status_irqsafe() may not be mixed
3151 * for a single hardware.
3152 *
3153 * @hw: the hardware the frame was transmitted by
3154 * @skb: the frame that was transmitted, owned by mac80211 after this call
3155 */
3156static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
3157 struct sk_buff *skb)
3158{
3159 local_bh_disable();
3160 ieee80211_tx_status(hw, skb);
3161 local_bh_enable();
3162}
3163
3164/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07003165 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
Johannes Berg2485f712008-02-25 16:27:41 +01003166 *
3167 * Like ieee80211_tx_status() but can be called in IRQ context
3168 * (internally defers to a tasklet.)
3169 *
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01003170 * Calls to this function, ieee80211_tx_status() and
3171 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
Johannes Berg2485f712008-02-25 16:27:41 +01003172 *
3173 * @hw: the hardware the frame was transmitted by
3174 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg2485f712008-02-25 16:27:41 +01003175 */
Jiri Bencf0706e82007-05-05 11:45:53 -07003176void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02003177 struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07003178
3179/**
Arik Nemtsov8178d382011-04-18 14:22:28 +03003180 * ieee80211_report_low_ack - report non-responding station
3181 *
3182 * When operating in AP-mode, call this function to report a non-responding
3183 * connected STA.
3184 *
3185 * @sta: the non-responding connected sta
3186 * @num_packets: number of packets sent to @sta without a response
3187 */
3188void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
3189
3190/**
Johannes Bergeddcbb92009-10-29 08:30:35 +01003191 * ieee80211_beacon_get_tim - beacon generation function
3192 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01003193 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Bergeddcbb92009-10-29 08:30:35 +01003194 * @tim_offset: pointer to variable that will receive the TIM IE offset.
3195 * Set to 0 if invalid (in non-AP modes).
3196 * @tim_length: pointer to variable that will receive the TIM IE length,
3197 * (including the ID and length bytes!).
3198 * Set to 0 if invalid (in non-AP modes).
3199 *
3200 * If the driver implements beaconing modes, it must use this function to
3201 * obtain the beacon frame/template.
3202 *
3203 * If the beacon frames are generated by the host system (i.e., not in
3204 * hardware/firmware), the driver uses this function to get each beacon
3205 * frame from mac80211 -- it is responsible for calling this function
3206 * before the beacon is needed (e.g. based on hardware interrupt).
3207 *
3208 * If the beacon frames are generated by the device, then the driver
3209 * must use the returned beacon as the template and change the TIM IE
3210 * according to the current DTIM parameters/TIM bitmap.
3211 *
3212 * The driver is responsible for freeing the returned skb.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003213 *
3214 * Return: The beacon template. %NULL on error.
Johannes Bergeddcbb92009-10-29 08:30:35 +01003215 */
3216struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
3217 struct ieee80211_vif *vif,
3218 u16 *tim_offset, u16 *tim_length);
3219
3220/**
Jiri Bencf0706e82007-05-05 11:45:53 -07003221 * ieee80211_beacon_get - beacon generation function
3222 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01003223 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07003224 *
Johannes Bergeddcbb92009-10-29 08:30:35 +01003225 * See ieee80211_beacon_get_tim().
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003226 *
3227 * Return: See ieee80211_beacon_get_tim().
Jiri Bencf0706e82007-05-05 11:45:53 -07003228 */
Johannes Bergeddcbb92009-10-29 08:30:35 +01003229static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
3230 struct ieee80211_vif *vif)
3231{
3232 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
3233}
Jiri Bencf0706e82007-05-05 11:45:53 -07003234
3235/**
Arik Nemtsov02945822011-11-10 11:28:57 +02003236 * ieee80211_proberesp_get - retrieve a Probe Response template
3237 * @hw: pointer obtained from ieee80211_alloc_hw().
3238 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3239 *
3240 * Creates a Probe Response template which can, for example, be uploaded to
3241 * hardware. The destination address should be set by the caller.
3242 *
3243 * Can only be called in AP mode.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003244 *
3245 * Return: The Probe Response template. %NULL on error.
Arik Nemtsov02945822011-11-10 11:28:57 +02003246 */
3247struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
3248 struct ieee80211_vif *vif);
3249
3250/**
Kalle Valo7044cc52010-01-05 20:16:19 +02003251 * ieee80211_pspoll_get - retrieve a PS Poll template
3252 * @hw: pointer obtained from ieee80211_alloc_hw().
3253 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3254 *
3255 * Creates a PS Poll a template which can, for example, uploaded to
3256 * hardware. The template must be updated after association so that correct
3257 * AID, BSSID and MAC address is used.
3258 *
3259 * Note: Caller (or hardware) is responsible for setting the
3260 * &IEEE80211_FCTL_PM bit.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003261 *
3262 * Return: The PS Poll template. %NULL on error.
Kalle Valo7044cc52010-01-05 20:16:19 +02003263 */
3264struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
3265 struct ieee80211_vif *vif);
3266
3267/**
3268 * ieee80211_nullfunc_get - retrieve a nullfunc template
3269 * @hw: pointer obtained from ieee80211_alloc_hw().
3270 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3271 *
3272 * Creates a Nullfunc template which can, for example, uploaded to
3273 * hardware. The template must be updated after association so that correct
3274 * BSSID and address is used.
3275 *
3276 * Note: Caller (or hardware) is responsible for setting the
3277 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003278 *
3279 * Return: The nullfunc template. %NULL on error.
Kalle Valo7044cc52010-01-05 20:16:19 +02003280 */
3281struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
3282 struct ieee80211_vif *vif);
3283
3284/**
Kalle Valo05e54ea2010-01-05 20:16:38 +02003285 * ieee80211_probereq_get - retrieve a Probe Request template
3286 * @hw: pointer obtained from ieee80211_alloc_hw().
3287 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3288 * @ssid: SSID buffer
3289 * @ssid_len: length of SSID
Johannes Bergb9a9ada2012-11-29 13:00:10 +01003290 * @tailroom: tailroom to reserve at end of SKB for IEs
Kalle Valo05e54ea2010-01-05 20:16:38 +02003291 *
3292 * Creates a Probe Request template which can, for example, be uploaded to
3293 * hardware.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003294 *
3295 * Return: The Probe Request template. %NULL on error.
Kalle Valo05e54ea2010-01-05 20:16:38 +02003296 */
3297struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
3298 struct ieee80211_vif *vif,
3299 const u8 *ssid, size_t ssid_len,
Johannes Bergb9a9ada2012-11-29 13:00:10 +01003300 size_t tailroom);
Kalle Valo05e54ea2010-01-05 20:16:38 +02003301
3302/**
Jiri Bencf0706e82007-05-05 11:45:53 -07003303 * ieee80211_rts_get - RTS frame generation function
3304 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01003305 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07003306 * @frame: pointer to the frame that is going to be protected by the RTS.
3307 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02003308 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07003309 * @rts: The buffer where to store the RTS frame.
3310 *
3311 * If the RTS frames are generated by the host system (i.e., not in
3312 * hardware/firmware), the low-level driver uses this function to receive
3313 * the next RTS frame from the 802.11 code. The low-level is responsible
3314 * for calling this function before and RTS frame is needed.
3315 */
Johannes Berg32bfd352007-12-19 01:31:26 +01003316void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07003317 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02003318 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07003319 struct ieee80211_rts *rts);
3320
3321/**
3322 * ieee80211_rts_duration - Get the duration field for an RTS frame
3323 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01003324 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07003325 * @frame_len: the length of the frame that is going to be protected by the RTS.
Johannes Berge039fa42008-05-15 12:55:29 +02003326 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07003327 *
3328 * If the RTS is generated in firmware, but the host system must provide
3329 * the duration field, the low-level driver uses this function to receive
3330 * the duration field value in little-endian byteorder.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003331 *
3332 * Return: The duration.
Jiri Bencf0706e82007-05-05 11:45:53 -07003333 */
Johannes Berg32bfd352007-12-19 01:31:26 +01003334__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
3335 struct ieee80211_vif *vif, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02003336 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07003337
3338/**
3339 * ieee80211_ctstoself_get - CTS-to-self frame generation function
3340 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01003341 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07003342 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
3343 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02003344 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07003345 * @cts: The buffer where to store the CTS-to-self frame.
3346 *
3347 * If the CTS-to-self frames are generated by the host system (i.e., not in
3348 * hardware/firmware), the low-level driver uses this function to receive
3349 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
3350 * for calling this function before and CTS-to-self frame is needed.
3351 */
Johannes Berg32bfd352007-12-19 01:31:26 +01003352void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
3353 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07003354 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02003355 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07003356 struct ieee80211_cts *cts);
3357
3358/**
3359 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
3360 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01003361 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07003362 * @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 +02003363 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07003364 *
3365 * If the CTS-to-self is generated in firmware, but the host system must provide
3366 * the duration field, the low-level driver uses this function to receive
3367 * the duration field value in little-endian byteorder.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003368 *
3369 * Return: The duration.
Jiri Bencf0706e82007-05-05 11:45:53 -07003370 */
Johannes Berg32bfd352007-12-19 01:31:26 +01003371__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
3372 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07003373 size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02003374 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07003375
3376/**
3377 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
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 Bergd13e1412012-06-09 10:31:09 +02003380 * @band: the band to calculate the frame duration on
Jiri Bencf0706e82007-05-05 11:45:53 -07003381 * @frame_len: the length of the frame.
Johannes Berg8318d782008-01-24 19:38:38 +01003382 * @rate: the rate at which the frame is going to be transmitted.
Jiri Bencf0706e82007-05-05 11:45:53 -07003383 *
3384 * Calculate the duration field of some generic frame, given its
3385 * length and transmission rate (in 100kbps).
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003386 *
3387 * Return: The duration.
Jiri Bencf0706e82007-05-05 11:45:53 -07003388 */
Johannes Berg32bfd352007-12-19 01:31:26 +01003389__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
3390 struct ieee80211_vif *vif,
Michal Kazior4ee73f32012-04-11 08:47:56 +02003391 enum ieee80211_band band,
Jiri Bencf0706e82007-05-05 11:45:53 -07003392 size_t frame_len,
Johannes Berg8318d782008-01-24 19:38:38 +01003393 struct ieee80211_rate *rate);
Jiri Bencf0706e82007-05-05 11:45:53 -07003394
3395/**
3396 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
3397 * @hw: pointer as obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01003398 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07003399 *
3400 * Function for accessing buffered broadcast and multicast frames. If
3401 * hardware/firmware does not implement buffering of broadcast/multicast
3402 * frames when power saving is used, 802.11 code buffers them in the host
3403 * memory. The low-level driver uses this function to fetch next buffered
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003404 * frame. In most cases, this is used when generating beacon frame.
3405 *
3406 * Return: A pointer to the next buffered skb or NULL if no more buffered
3407 * frames are available.
Jiri Bencf0706e82007-05-05 11:45:53 -07003408 *
3409 * Note: buffered frames are returned only after DTIM beacon frame was
3410 * generated with ieee80211_beacon_get() and the low-level driver must thus
3411 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
3412 * NULL if the previous generated beacon was not DTIM, so the low-level driver
3413 * does not need to check for DTIM beacons separately and should be able to
3414 * use common code for all beacons.
3415 */
3416struct sk_buff *
Johannes Berge039fa42008-05-15 12:55:29 +02003417ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07003418
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003419/**
Johannes Berg42d98792011-07-07 18:58:01 +02003420 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
3421 *
3422 * This function returns the TKIP phase 1 key for the given IV32.
3423 *
3424 * @keyconf: the parameter passed with the set key
3425 * @iv32: IV32 to get the P1K for
3426 * @p1k: a buffer to which the key will be written, as 5 u16 values
3427 */
3428void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
3429 u32 iv32, u16 *p1k);
3430
3431/**
Johannes Berg523b02e2011-07-07 22:28:01 +02003432 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02003433 *
Johannes Berg523b02e2011-07-07 22:28:01 +02003434 * This function returns the TKIP phase 1 key for the IV32 taken
3435 * from the given packet.
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02003436 *
3437 * @keyconf: the parameter passed with the set key
Johannes Berg523b02e2011-07-07 22:28:01 +02003438 * @skb: the packet to take the IV32 value from that will be encrypted
3439 * with this P1K
3440 * @p1k: a buffer to which the key will be written, as 5 u16 values
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02003441 */
Johannes Berg42d98792011-07-07 18:58:01 +02003442static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
3443 struct sk_buff *skb, u16 *p1k)
3444{
3445 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
3446 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
3447 u32 iv32 = get_unaligned_le32(&data[4]);
3448
3449 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
3450}
Johannes Berg523b02e2011-07-07 22:28:01 +02003451
3452/**
Johannes Berg8bca5d82011-07-13 19:50:34 +02003453 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
3454 *
3455 * This function returns the TKIP phase 1 key for the given IV32
3456 * and transmitter address.
3457 *
3458 * @keyconf: the parameter passed with the set key
3459 * @ta: TA that will be used with the key
3460 * @iv32: IV32 to get the P1K for
3461 * @p1k: a buffer to which the key will be written, as 5 u16 values
3462 */
3463void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
3464 const u8 *ta, u32 iv32, u16 *p1k);
3465
3466/**
Johannes Berg523b02e2011-07-07 22:28:01 +02003467 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
3468 *
3469 * This function computes the TKIP RC4 key for the IV values
3470 * in the packet.
3471 *
3472 * @keyconf: the parameter passed with the set key
3473 * @skb: the packet to take the IV32/IV16 values from that will be
3474 * encrypted with this key
3475 * @p2k: a buffer to which the key will be written, 16 bytes
3476 */
3477void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
3478 struct sk_buff *skb, u8 *p2k);
Johannes Bergc68f4b82011-07-05 16:35:41 +02003479
3480/**
Assaf Krauss5d0d04e2012-08-01 15:12:48 +03003481 * ieee80211_aes_cmac_calculate_k1_k2 - calculate the AES-CMAC sub keys
3482 *
3483 * This function computes the two AES-CMAC sub-keys, based on the
3484 * previously installed master key.
3485 *
3486 * @keyconf: the parameter passed with the set key
3487 * @k1: a buffer to be filled with the 1st sub-key
3488 * @k2: a buffer to be filled with the 2nd sub-key
3489 */
3490void ieee80211_aes_cmac_calculate_k1_k2(struct ieee80211_key_conf *keyconf,
3491 u8 *k1, u8 *k2);
3492
3493/**
Johannes Berg3ea542d2011-07-07 18:58:00 +02003494 * struct ieee80211_key_seq - key sequence counter
3495 *
3496 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
3497 * @ccmp: PN data, most significant byte first (big endian,
3498 * reverse order than in packet)
3499 * @aes_cmac: PN data, most significant byte first (big endian,
3500 * reverse order than in packet)
3501 */
3502struct ieee80211_key_seq {
3503 union {
3504 struct {
3505 u32 iv32;
3506 u16 iv16;
3507 } tkip;
3508 struct {
3509 u8 pn[6];
3510 } ccmp;
3511 struct {
3512 u8 pn[6];
3513 } aes_cmac;
3514 };
3515};
3516
3517/**
3518 * ieee80211_get_key_tx_seq - get key TX sequence counter
3519 *
3520 * @keyconf: the parameter passed with the set key
3521 * @seq: buffer to receive the sequence data
3522 *
3523 * This function allows a driver to retrieve the current TX IV/PN
3524 * for the given key. It must not be called if IV generation is
3525 * offloaded to the device.
3526 *
3527 * Note that this function may only be called when no TX processing
3528 * can be done concurrently, for example when queues are stopped
3529 * and the stop has been synchronized.
3530 */
3531void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
3532 struct ieee80211_key_seq *seq);
3533
3534/**
3535 * ieee80211_get_key_rx_seq - get key RX sequence counter
3536 *
3537 * @keyconf: the parameter passed with the set key
3538 * @tid: The TID, or -1 for the management frame value (CCMP only);
3539 * the value on TID 0 is also used for non-QoS frames. For
3540 * CMAC, only TID 0 is valid.
3541 * @seq: buffer to receive the sequence data
3542 *
3543 * This function allows a driver to retrieve the current RX IV/PNs
3544 * for the given key. It must not be called if IV checking is done
3545 * by the device and not by mac80211.
3546 *
3547 * Note that this function may only be called when no RX processing
3548 * can be done concurrently.
3549 */
3550void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
3551 int tid, struct ieee80211_key_seq *seq);
3552
3553/**
Johannes Bergc68f4b82011-07-05 16:35:41 +02003554 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
3555 * @vif: virtual interface the rekeying was done on
3556 * @bssid: The BSSID of the AP, for checking association
3557 * @replay_ctr: the new replay counter after GTK rekeying
3558 * @gfp: allocation flags
3559 */
3560void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
3561 const u8 *replay_ctr, gfp_t gfp);
3562
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02003563/**
Jiri Bencf0706e82007-05-05 11:45:53 -07003564 * ieee80211_wake_queue - wake specific queue
3565 * @hw: pointer as obtained from ieee80211_alloc_hw().
3566 * @queue: queue number (counted from zero).
3567 *
3568 * Drivers should use this function instead of netif_wake_queue.
3569 */
3570void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
3571
3572/**
3573 * ieee80211_stop_queue - stop specific queue
3574 * @hw: pointer as obtained from ieee80211_alloc_hw().
3575 * @queue: queue number (counted from zero).
3576 *
3577 * Drivers should use this function instead of netif_stop_queue.
3578 */
3579void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
3580
3581/**
Tomas Winkler92ab8532008-07-24 21:02:04 +03003582 * ieee80211_queue_stopped - test status of the queue
3583 * @hw: pointer as obtained from ieee80211_alloc_hw().
3584 * @queue: queue number (counted from zero).
3585 *
3586 * Drivers should use this function instead of netif_stop_queue.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003587 *
3588 * Return: %true if the queue is stopped. %false otherwise.
Tomas Winkler92ab8532008-07-24 21:02:04 +03003589 */
3590
3591int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
3592
3593/**
Jiri Bencf0706e82007-05-05 11:45:53 -07003594 * ieee80211_stop_queues - stop all queues
3595 * @hw: pointer as obtained from ieee80211_alloc_hw().
3596 *
3597 * Drivers should use this function instead of netif_stop_queue.
3598 */
3599void ieee80211_stop_queues(struct ieee80211_hw *hw);
3600
3601/**
3602 * ieee80211_wake_queues - wake all queues
3603 * @hw: pointer as obtained from ieee80211_alloc_hw().
3604 *
3605 * Drivers should use this function instead of netif_wake_queue.
3606 */
3607void ieee80211_wake_queues(struct ieee80211_hw *hw);
3608
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003609/**
3610 * ieee80211_scan_completed - completed hardware scan
3611 *
3612 * When hardware scan offload is used (i.e. the hw_scan() callback is
3613 * assigned) this function needs to be called by the driver to notify
Johannes Berg8789d452010-08-26 13:30:26 +02003614 * mac80211 that the scan finished. This function can be called from
3615 * any context, including hardirq context.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003616 *
3617 * @hw: the hardware that finished the scan
Johannes Berg2a519312009-02-10 21:25:55 +01003618 * @aborted: set to true if scan was aborted
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003619 */
Johannes Berg2a519312009-02-10 21:25:55 +01003620void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
Jiri Bencf0706e82007-05-05 11:45:53 -07003621
Johannes Bergdabeb342007-11-09 01:57:29 +01003622/**
Luciano Coelho79f460c2011-05-11 17:09:36 +03003623 * ieee80211_sched_scan_results - got results from scheduled scan
3624 *
3625 * When a scheduled scan is running, this function needs to be called by the
3626 * driver whenever there are new scan results available.
3627 *
3628 * @hw: the hardware that is performing scheduled scans
3629 */
3630void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
3631
3632/**
3633 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
3634 *
3635 * When a scheduled scan is running, this function can be called by
3636 * the driver if it needs to stop the scan to perform another task.
3637 * Usual scenarios are drivers that cannot continue the scheduled scan
3638 * while associating, for instance.
3639 *
3640 * @hw: the hardware that is performing scheduled scans
3641 */
3642void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
3643
3644/**
Johannes Berg8b2c9822012-11-06 20:23:30 +01003645 * enum ieee80211_interface_iteration_flags - interface iteration flags
3646 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
3647 * been added to the driver; However, note that during hardware
3648 * reconfiguration (after restart_hw) it will iterate over a new
3649 * interface and over all the existing interfaces even if they
3650 * haven't been re-added to the driver yet.
3651 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
3652 * interfaces, even if they haven't been re-added to the driver yet.
3653 */
3654enum ieee80211_interface_iteration_flags {
3655 IEEE80211_IFACE_ITER_NORMAL = 0,
3656 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
3657};
3658
3659/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07003660 * ieee80211_iterate_active_interfaces - iterate active interfaces
Johannes Bergdabeb342007-11-09 01:57:29 +01003661 *
3662 * This function iterates over the interfaces associated with a given
3663 * hardware that are currently active and calls the callback for them.
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02003664 * This function allows the iterator function to sleep, when the iterator
3665 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
3666 * be used.
Johannes Berg8b2c9822012-11-06 20:23:30 +01003667 * Does not iterate over a new interface during add_interface().
Johannes Bergdabeb342007-11-09 01:57:29 +01003668 *
3669 * @hw: the hardware struct of which the interfaces should be iterated over
Johannes Berg8b2c9822012-11-06 20:23:30 +01003670 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02003671 * @iterator: the iterator function to call
Johannes Bergdabeb342007-11-09 01:57:29 +01003672 * @data: first argument of the iterator function
3673 */
3674void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
Johannes Berg8b2c9822012-11-06 20:23:30 +01003675 u32 iter_flags,
Johannes Bergdabeb342007-11-09 01:57:29 +01003676 void (*iterator)(void *data, u8 *mac,
Johannes Berg32bfd352007-12-19 01:31:26 +01003677 struct ieee80211_vif *vif),
Johannes Bergdabeb342007-11-09 01:57:29 +01003678 void *data);
3679
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003680/**
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02003681 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
3682 *
3683 * This function iterates over the interfaces associated with a given
3684 * hardware that are currently active and calls the callback for them.
3685 * This function requires the iterator callback function to be atomic,
3686 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
Johannes Berg8b2c9822012-11-06 20:23:30 +01003687 * Does not iterate over a new interface during add_interface().
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02003688 *
3689 * @hw: the hardware struct of which the interfaces should be iterated over
Johannes Berg8b2c9822012-11-06 20:23:30 +01003690 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02003691 * @iterator: the iterator function to call, cannot sleep
3692 * @data: first argument of the iterator function
3693 */
3694void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
Johannes Berg8b2c9822012-11-06 20:23:30 +01003695 u32 iter_flags,
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02003696 void (*iterator)(void *data,
3697 u8 *mac,
3698 struct ieee80211_vif *vif),
3699 void *data);
3700
3701/**
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04003702 * ieee80211_queue_work - add work onto the mac80211 workqueue
3703 *
3704 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
3705 * This helper ensures drivers are not queueing work when they should not be.
3706 *
3707 * @hw: the hardware struct for the interface we are adding work for
3708 * @work: the work we want to add onto the mac80211 workqueue
3709 */
3710void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
3711
3712/**
3713 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
3714 *
3715 * Drivers and mac80211 use this to queue delayed work onto the mac80211
3716 * workqueue.
3717 *
3718 * @hw: the hardware struct for the interface we are adding work for
3719 * @dwork: delayable work to queue onto the mac80211 workqueue
3720 * @delay: number of jiffies to wait before queueing
3721 */
3722void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
3723 struct delayed_work *dwork,
3724 unsigned long delay);
3725
3726/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003727 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01003728 * @sta: the station for which to start a BA session
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003729 * @tid: the TID to BA on.
Sujith Manoharanbd2ce6e2010-12-15 07:47:10 +05303730 * @timeout: session timeout value (in TUs)
Randy Dunlapea2d8b52008-10-27 09:47:03 -07003731 *
3732 * Return: success if addBA request was sent, failure otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003733 *
3734 * Although mac80211/low level driver/user space application can estimate
3735 * the need to start aggregation on a certain RA/TID, the session level
3736 * will be managed by the mac80211.
3737 */
Sujith Manoharanbd2ce6e2010-12-15 07:47:10 +05303738int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
3739 u16 timeout);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003740
3741/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003742 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01003743 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003744 * @ra: receiver address of the BA session recipient.
3745 * @tid: the TID to BA on.
3746 *
3747 * This function must be called by low level driver once it has
Johannes Berg5d22c892010-06-10 10:21:40 +02003748 * finished with preparations for the BA session. It can be called
3749 * from any context.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003750 */
Johannes Bergc951ad32009-11-16 12:00:38 +01003751void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003752 u16 tid);
3753
3754/**
3755 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01003756 * @sta: the station whose BA session to stop
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003757 * @tid: the TID to stop BA.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07003758 *
Johannes Berg6a8579d2010-05-27 14:41:07 +02003759 * Return: negative error if the TID is invalid, or no aggregation active
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003760 *
3761 * Although mac80211/low level driver/user space application can estimate
3762 * the need to stop aggregation on a certain RA/TID, the session level
3763 * will be managed by the mac80211.
3764 */
Johannes Berg6a8579d2010-05-27 14:41:07 +02003765int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003766
3767/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003768 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01003769 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003770 * @ra: receiver address of the BA session recipient.
3771 * @tid: the desired TID to BA on.
3772 *
3773 * This function must be called by low level driver once it has
Johannes Berg5d22c892010-06-10 10:21:40 +02003774 * finished with preparations for the BA session tear down. It
3775 * can be called from any context.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003776 */
Johannes Bergc951ad32009-11-16 12:00:38 +01003777void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003778 u16 tid);
3779
Mohamed Abbas84363e62008-04-04 16:59:58 -07003780/**
Johannes Berg17741cd2008-09-11 00:02:02 +02003781 * ieee80211_find_sta - find a station
3782 *
Johannes Berg5ed176e2009-11-04 14:42:28 +01003783 * @vif: virtual interface to look for station on
Johannes Berg17741cd2008-09-11 00:02:02 +02003784 * @addr: station's address
3785 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003786 * Return: The station, if found. %NULL otherwise.
3787 *
3788 * Note: This function must be called under RCU lock and the
Johannes Berg17741cd2008-09-11 00:02:02 +02003789 * resulting pointer is only valid under RCU lock as well.
3790 */
Johannes Berg5ed176e2009-11-04 14:42:28 +01003791struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02003792 const u8 *addr);
3793
Kalle Valo04de8382009-03-22 21:57:35 +02003794/**
Ben Greear686b9cb2010-09-23 09:44:36 -07003795 * ieee80211_find_sta_by_ifaddr - find a station on hardware
Johannes Berg5ed176e2009-11-04 14:42:28 +01003796 *
3797 * @hw: pointer as obtained from ieee80211_alloc_hw()
Ben Greear686b9cb2010-09-23 09:44:36 -07003798 * @addr: remote station's address
3799 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
Johannes Berg5ed176e2009-11-04 14:42:28 +01003800 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003801 * Return: The station, if found. %NULL otherwise.
3802 *
3803 * Note: This function must be called under RCU lock and the
Johannes Berg5ed176e2009-11-04 14:42:28 +01003804 * resulting pointer is only valid under RCU lock as well.
3805 *
Ben Greear686b9cb2010-09-23 09:44:36 -07003806 * NOTE: You may pass NULL for localaddr, but then you will just get
3807 * the first STA that matches the remote address 'addr'.
3808 * We can have multiple STA associated with multiple
3809 * logical stations (e.g. consider a station connecting to another
3810 * BSSID on the same AP hardware without disconnecting first).
3811 * In this case, the result of this method with localaddr NULL
3812 * is not reliable.
Johannes Berg5ed176e2009-11-04 14:42:28 +01003813 *
Ben Greear686b9cb2010-09-23 09:44:36 -07003814 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
Johannes Berg5ed176e2009-11-04 14:42:28 +01003815 */
Ben Greear686b9cb2010-09-23 09:44:36 -07003816struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
3817 const u8 *addr,
3818 const u8 *localaddr);
Johannes Berg5ed176e2009-11-04 14:42:28 +01003819
3820/**
Johannes Bergaf818582009-11-06 11:35:50 +01003821 * ieee80211_sta_block_awake - block station from waking up
3822 * @hw: the hardware
3823 * @pubsta: the station
3824 * @block: whether to block or unblock
3825 *
3826 * Some devices require that all frames that are on the queues
3827 * for a specific station that went to sleep are flushed before
3828 * a poll response or frames after the station woke up can be
3829 * delivered to that it. Note that such frames must be rejected
3830 * by the driver as filtered, with the appropriate status flag.
3831 *
3832 * This function allows implementing this mode in a race-free
3833 * manner.
3834 *
3835 * To do this, a driver must keep track of the number of frames
3836 * still enqueued for a specific station. If this number is not
3837 * zero when the station goes to sleep, the driver must call
3838 * this function to force mac80211 to consider the station to
3839 * be asleep regardless of the station's actual state. Once the
3840 * number of outstanding frames reaches zero, the driver must
3841 * call this function again to unblock the station. That will
3842 * cause mac80211 to be able to send ps-poll responses, and if
3843 * the station queried in the meantime then frames will also
3844 * be sent out as a result of this. Additionally, the driver
3845 * will be notified that the station woke up some time after
3846 * it is unblocked, regardless of whether the station actually
3847 * woke up while blocked or not.
3848 */
3849void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
3850 struct ieee80211_sta *pubsta, bool block);
3851
3852/**
Johannes Berg37fbd902011-09-29 16:04:39 +02003853 * ieee80211_sta_eosp - notify mac80211 about end of SP
3854 * @pubsta: the station
3855 *
3856 * When a device transmits frames in a way that it can't tell
3857 * mac80211 in the TX status about the EOSP, it must clear the
3858 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
3859 * This applies for PS-Poll as well as uAPSD.
3860 *
Johannes Berge9437892013-02-15 21:38:08 +01003861 * Note that just like with _tx_status() and _rx() drivers must
3862 * not mix calls to irqsafe/non-irqsafe versions, this function
3863 * must not be mixed with those either. Use the all irqsafe, or
3864 * all non-irqsafe, don't mix!
3865 *
3866 * NB: the _irqsafe version of this function doesn't exist, no
3867 * driver needs it right now. Don't call this function if
3868 * you'd need the _irqsafe version, look at the git history
3869 * and restore the _irqsafe version!
Johannes Berg37fbd902011-09-29 16:04:39 +02003870 */
Johannes Berge9437892013-02-15 21:38:08 +01003871void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
Johannes Berg37fbd902011-09-29 16:04:39 +02003872
3873/**
Johannes Berg830af022011-07-05 16:35:39 +02003874 * ieee80211_iter_keys - iterate keys programmed into the device
3875 * @hw: pointer obtained from ieee80211_alloc_hw()
3876 * @vif: virtual interface to iterate, may be %NULL for all
3877 * @iter: iterator function that will be called for each key
3878 * @iter_data: custom data to pass to the iterator function
3879 *
3880 * This function can be used to iterate all the keys known to
3881 * mac80211, even those that weren't previously programmed into
3882 * the device. This is intended for use in WoWLAN if the device
3883 * needs reprogramming of the keys during suspend. Note that due
3884 * to locking reasons, it is also only safe to call this at few
3885 * spots since it must hold the RTNL and be able to sleep.
Johannes Bergf850e002011-07-13 19:50:53 +02003886 *
3887 * The order in which the keys are iterated matches the order
3888 * in which they were originally installed and handed to the
3889 * set_key callback.
Johannes Berg830af022011-07-05 16:35:39 +02003890 */
3891void ieee80211_iter_keys(struct ieee80211_hw *hw,
3892 struct ieee80211_vif *vif,
3893 void (*iter)(struct ieee80211_hw *hw,
3894 struct ieee80211_vif *vif,
3895 struct ieee80211_sta *sta,
3896 struct ieee80211_key_conf *key,
3897 void *data),
3898 void *iter_data);
3899
3900/**
Johannes Berg3448c002012-09-11 17:57:42 +02003901 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
3902 * @hw: pointre obtained from ieee80211_alloc_hw().
3903 * @iter: iterator function
3904 * @iter_data: data passed to iterator function
3905 *
3906 * Iterate all active channel contexts. This function is atomic and
3907 * doesn't acquire any locks internally that might be held in other
3908 * places while calling into the driver.
3909 *
3910 * The iterator will not find a context that's being added (during
3911 * the driver callback to add it) but will find it while it's being
3912 * removed.
Johannes Berg8a61af62012-12-13 17:42:30 +01003913 *
3914 * Note that during hardware restart, all contexts that existed
3915 * before the restart are considered already present so will be
3916 * found while iterating, whether they've been re-added already
3917 * or not.
Johannes Berg3448c002012-09-11 17:57:42 +02003918 */
3919void ieee80211_iter_chan_contexts_atomic(
3920 struct ieee80211_hw *hw,
3921 void (*iter)(struct ieee80211_hw *hw,
3922 struct ieee80211_chanctx_conf *chanctx_conf,
3923 void *data),
3924 void *iter_data);
3925
3926/**
Juuso Oikarinena619a4c2010-11-11 08:50:18 +02003927 * ieee80211_ap_probereq_get - retrieve a Probe Request template
3928 * @hw: pointer obtained from ieee80211_alloc_hw().
3929 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3930 *
3931 * Creates a Probe Request template which can, for example, be uploaded to
3932 * hardware. The template is filled with bssid, ssid and supported rate
3933 * information. This function must only be called from within the
3934 * .bss_info_changed callback function and only in managed mode. The function
3935 * is only useful when the interface is associated, otherwise it will return
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01003936 * %NULL.
3937 *
3938 * Return: The Probe Request template. %NULL on error.
Juuso Oikarinena619a4c2010-11-11 08:50:18 +02003939 */
3940struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
3941 struct ieee80211_vif *vif);
3942
3943/**
Kalle Valo04de8382009-03-22 21:57:35 +02003944 * ieee80211_beacon_loss - inform hardware does not receive beacons
3945 *
Johannes Berg1ed32e42009-12-23 13:15:45 +01003946 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Kalle Valo04de8382009-03-22 21:57:35 +02003947 *
Johannes Bergc1288b12012-01-19 09:29:57 +01003948 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02003949 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
Kalle Valo04de8382009-03-22 21:57:35 +02003950 * hardware is not receiving beacons with this function.
3951 */
3952void ieee80211_beacon_loss(struct ieee80211_vif *vif);
Johannes Berg4b7679a2008-09-18 18:14:18 +02003953
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02003954/**
3955 * ieee80211_connection_loss - inform hardware has lost connection to the AP
3956 *
3957 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3958 *
Johannes Bergc1288b12012-01-19 09:29:57 +01003959 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02003960 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
3961 * needs to inform if the connection to the AP has been lost.
Johannes Berg682bd382013-01-29 13:13:50 +01003962 * The function may also be called if the connection needs to be terminated
3963 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02003964 *
3965 * This function will cause immediate change to disassociated state,
3966 * without connection recovery attempts.
3967 */
3968void ieee80211_connection_loss(struct ieee80211_vif *vif);
3969
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02003970/**
Johannes Berg95acac62011-07-12 12:30:59 +02003971 * ieee80211_resume_disconnect - disconnect from AP after resume
3972 *
3973 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3974 *
3975 * Instructs mac80211 to disconnect from the AP after resume.
3976 * Drivers can use this after WoWLAN if they know that the
3977 * connection cannot be kept up, for example because keys were
3978 * used while the device was asleep but the replay counters or
3979 * similar cannot be retrieved from the device during resume.
3980 *
3981 * Note that due to implementation issues, if the driver uses
3982 * the reconfiguration functionality during resume the interface
3983 * will still be added as associated first during resume and then
3984 * disconnect normally later.
3985 *
3986 * This function can only be called from the resume callback and
3987 * the driver must not be holding any of its own locks while it
3988 * calls this function, or at least not any locks it needs in the
3989 * key configuration paths (if it supports HW crypto).
3990 */
3991void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
3992
3993/**
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02003994 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
3995 * rssi threshold triggered
3996 *
3997 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3998 * @rssi_event: the RSSI trigger event type
3999 * @gfp: context flags
4000 *
Johannes Bergea086352012-01-19 09:29:58 +01004001 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02004002 * monitoring is configured with an rssi threshold, the driver will inform
4003 * whenever the rssi level reaches the threshold.
4004 */
4005void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
4006 enum nl80211_cqm_rssi_threshold_event rssi_event,
4007 gfp_t gfp);
4008
Johannes Berg5ce6e432010-05-11 16:20:57 +02004009/**
Simon Wunderlich164eb022013-02-08 18:16:20 +01004010 * ieee80211_radar_detected - inform that a radar was detected
4011 *
4012 * @hw: pointer as obtained from ieee80211_alloc_hw()
4013 */
4014void ieee80211_radar_detected(struct ieee80211_hw *hw);
4015
4016/**
Johannes Berg5ce6e432010-05-11 16:20:57 +02004017 * ieee80211_chswitch_done - Complete channel switch process
4018 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4019 * @success: make the channel switch successful or not
4020 *
4021 * Complete the channel switch post-process: set the new operational channel
4022 * and wake up the suspended queues.
4023 */
4024void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
4025
Johannes Bergd1f5b7a2010-08-05 17:05:55 +02004026/**
4027 * ieee80211_request_smps - request SM PS transition
4028 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Berg633dd1e2010-08-18 15:01:23 +02004029 * @smps_mode: new SM PS mode
Johannes Bergd1f5b7a2010-08-05 17:05:55 +02004030 *
4031 * This allows the driver to request an SM PS transition in managed
4032 * mode. This is useful when the driver has more information than
4033 * the stack about possible interference, for example by bluetooth.
4034 */
4035void ieee80211_request_smps(struct ieee80211_vif *vif,
4036 enum ieee80211_smps_mode smps_mode);
4037
Johannes Berge31b8212010-10-05 19:39:30 +02004038/**
Johannes Berg21f83582010-12-18 17:20:47 +01004039 * ieee80211_ready_on_channel - notification of remain-on-channel start
4040 * @hw: pointer as obtained from ieee80211_alloc_hw()
4041 */
4042void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
4043
4044/**
4045 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
4046 * @hw: pointer as obtained from ieee80211_alloc_hw()
4047 */
4048void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
4049
Shahar Levif41ccd72011-05-22 16:10:21 +03004050/**
4051 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
4052 *
4053 * in order not to harm the system performance and user experience, the device
4054 * may request not to allow any rx ba session and tear down existing rx ba
4055 * sessions based on system constraints such as periodic BT activity that needs
4056 * to limit wlan activity (eg.sco or a2dp)."
4057 * in such cases, the intention is to limit the duration of the rx ppdu and
4058 * therefore prevent the peer device to use a-mpdu aggregation.
4059 *
4060 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4061 * @ba_rx_bitmap: Bit map of open rx ba per tid
4062 * @addr: & to bssid mac address
4063 */
4064void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
4065 const u8 *addr);
4066
Felix Fietkau8c771242011-08-20 15:53:55 +02004067/**
4068 * ieee80211_send_bar - send a BlockAckReq frame
4069 *
4070 * can be used to flush pending frames from the peer's aggregation reorder
4071 * buffer.
4072 *
4073 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4074 * @ra: the peer's destination address
4075 * @tid: the TID of the aggregation session
4076 * @ssn: the new starting sequence number for the receiver
4077 */
4078void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
4079
Johannes Berg4b7679a2008-09-18 18:14:18 +02004080/* Rate control API */
Johannes Berge6a98542008-10-21 12:40:02 +02004081
Johannes Berg4b7679a2008-09-18 18:14:18 +02004082/**
Johannes Berge6a98542008-10-21 12:40:02 +02004083 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
Johannes Berg4b7679a2008-09-18 18:14:18 +02004084 *
Johannes Berge6a98542008-10-21 12:40:02 +02004085 * @hw: The hardware the algorithm is invoked for.
4086 * @sband: The band this frame is being transmitted on.
4087 * @bss_conf: the current BSS configuration
Simon Wunderlichf44d4eb2012-03-07 21:31:13 +01004088 * @skb: the skb that will be transmitted, the control information in it needs
4089 * to be filled in
Johannes Berge6a98542008-10-21 12:40:02 +02004090 * @reported_rate: The rate control algorithm can fill this in to indicate
4091 * which rate should be reported to userspace as the current rate and
4092 * used for rate calculations in the mesh network.
4093 * @rts: whether RTS will be used for this frame because it is longer than the
4094 * RTS threshold
4095 * @short_preamble: whether mac80211 will request short-preamble transmission
4096 * if the selected rate supports it
Simon Wunderlichf44d4eb2012-03-07 21:31:13 +01004097 * @max_rate_idx: user-requested maximum (legacy) rate
Jouni Malinen37eb0b12010-01-06 13:09:08 +02004098 * (deprecated; this will be removed once drivers get updated to use
4099 * rate_idx_mask)
Simon Wunderlichf44d4eb2012-03-07 21:31:13 +01004100 * @rate_idx_mask: user-requested (legacy) rate mask
4101 * @rate_idx_mcs_mask: user-requested MCS rate mask
Felix Fietkau8f0729b2010-11-11 15:07:23 +01004102 * @bss: whether this frame is sent out in AP or IBSS mode
Johannes Berg4b7679a2008-09-18 18:14:18 +02004103 */
Johannes Berge6a98542008-10-21 12:40:02 +02004104struct ieee80211_tx_rate_control {
4105 struct ieee80211_hw *hw;
4106 struct ieee80211_supported_band *sband;
4107 struct ieee80211_bss_conf *bss_conf;
4108 struct sk_buff *skb;
4109 struct ieee80211_tx_rate reported_rate;
4110 bool rts, short_preamble;
4111 u8 max_rate_idx;
Jouni Malinen37eb0b12010-01-06 13:09:08 +02004112 u32 rate_idx_mask;
Simon Wunderlich19468412012-01-28 17:25:33 +01004113 u8 rate_idx_mcs_mask[IEEE80211_HT_MCS_MASK_LEN];
Felix Fietkau8f0729b2010-11-11 15:07:23 +01004114 bool bss;
Johannes Berg4b7679a2008-09-18 18:14:18 +02004115};
4116
4117struct rate_control_ops {
4118 struct module *module;
4119 const char *name;
4120 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
Johannes Berg4b7679a2008-09-18 18:14:18 +02004121 void (*free)(void *priv);
4122
4123 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
4124 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
4125 struct ieee80211_sta *sta, void *priv_sta);
Sujith81cb7622009-02-12 11:38:37 +05304126 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
Johannes Berg64f68e52012-03-28 10:58:37 +02004127 struct ieee80211_sta *sta, void *priv_sta,
4128 u32 changed);
Johannes Berg4b7679a2008-09-18 18:14:18 +02004129 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
4130 void *priv_sta);
4131
4132 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
4133 struct ieee80211_sta *sta, void *priv_sta,
4134 struct sk_buff *skb);
Johannes Berge6a98542008-10-21 12:40:02 +02004135 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
4136 struct ieee80211_tx_rate_control *txrc);
Johannes Berg4b7679a2008-09-18 18:14:18 +02004137
4138 void (*add_sta_debugfs)(void *priv, void *priv_sta,
4139 struct dentry *dir);
4140 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
4141};
4142
4143static inline int rate_supported(struct ieee80211_sta *sta,
4144 enum ieee80211_band band,
4145 int index)
4146{
4147 return (sta == NULL || sta->supp_rates[band] & BIT(index));
4148}
4149
Luis R. Rodriguez4c6d4f52009-07-16 10:05:41 -07004150/**
4151 * rate_control_send_low - helper for drivers for management/no-ack frames
4152 *
4153 * Rate control algorithms that agree to use the lowest rate to
4154 * send management frames and NO_ACK data with the respective hw
4155 * retries should use this in the beginning of their mac80211 get_rate
4156 * callback. If true is returned the rate control can simply return.
4157 * If false is returned we guarantee that sta and sta and priv_sta is
4158 * not null.
4159 *
4160 * Rate control algorithms wishing to do more intelligent selection of
4161 * rate for multicast/broadcast frames may choose to not use this.
4162 *
4163 * @sta: &struct ieee80211_sta pointer to the target destination. Note
4164 * that this may be null.
4165 * @priv_sta: private rate control structure. This may be null.
4166 * @txrc: rate control information we sholud populate for mac80211.
4167 */
4168bool rate_control_send_low(struct ieee80211_sta *sta,
4169 void *priv_sta,
4170 struct ieee80211_tx_rate_control *txrc);
4171
4172
Johannes Berg4b7679a2008-09-18 18:14:18 +02004173static inline s8
4174rate_lowest_index(struct ieee80211_supported_band *sband,
4175 struct ieee80211_sta *sta)
4176{
4177 int i;
4178
4179 for (i = 0; i < sband->n_bitrates; i++)
4180 if (rate_supported(sta, sband->band, i))
4181 return i;
4182
4183 /* warn when we cannot find a rate. */
Johannes Berg54d50262011-11-04 18:07:43 +01004184 WARN_ON_ONCE(1);
Johannes Berg4b7679a2008-09-18 18:14:18 +02004185
Johannes Berg54d50262011-11-04 18:07:43 +01004186 /* and return 0 (the lowest index) */
Johannes Berg4b7679a2008-09-18 18:14:18 +02004187 return 0;
4188}
4189
Luis R. Rodriguezb770b432009-07-16 10:15:09 -07004190static inline
4191bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
4192 struct ieee80211_sta *sta)
4193{
4194 unsigned int i;
4195
4196 for (i = 0; i < sband->n_bitrates; i++)
4197 if (rate_supported(sta, sband->band, i))
4198 return true;
4199 return false;
4200}
Johannes Berg4b7679a2008-09-18 18:14:18 +02004201
4202int ieee80211_rate_control_register(struct rate_control_ops *ops);
4203void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
4204
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08004205static inline bool
4206conf_is_ht20(struct ieee80211_conf *conf)
4207{
Johannes Berg47979382009-01-07 10:13:27 +01004208 return conf->channel_type == NL80211_CHAN_HT20;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08004209}
4210
4211static inline bool
4212conf_is_ht40_minus(struct ieee80211_conf *conf)
4213{
Johannes Berg47979382009-01-07 10:13:27 +01004214 return conf->channel_type == NL80211_CHAN_HT40MINUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08004215}
4216
4217static inline bool
4218conf_is_ht40_plus(struct ieee80211_conf *conf)
4219{
Johannes Berg47979382009-01-07 10:13:27 +01004220 return conf->channel_type == NL80211_CHAN_HT40PLUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08004221}
4222
4223static inline bool
4224conf_is_ht40(struct ieee80211_conf *conf)
4225{
4226 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
4227}
4228
4229static inline bool
4230conf_is_ht(struct ieee80211_conf *conf)
4231{
Johannes Berg47979382009-01-07 10:13:27 +01004232 return conf->channel_type != NL80211_CHAN_NO_HT;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08004233}
4234
Johannes Berg2ca27bc2010-09-16 14:58:23 +02004235static inline enum nl80211_iftype
4236ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
4237{
4238 if (p2p) {
4239 switch (type) {
4240 case NL80211_IFTYPE_STATION:
4241 return NL80211_IFTYPE_P2P_CLIENT;
4242 case NL80211_IFTYPE_AP:
4243 return NL80211_IFTYPE_P2P_GO;
4244 default:
4245 break;
4246 }
4247 }
4248 return type;
4249}
4250
4251static inline enum nl80211_iftype
4252ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
4253{
4254 return ieee80211_iftype_p2p(vif->type, vif->p2p);
4255}
4256
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -07004257void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
4258 int rssi_min_thold,
4259 int rssi_max_thold);
4260
4261void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
Arik Nemtsov768db342011-09-28 14:12:51 +03004262
Wey-Yi Guy0d8a0a12012-04-20 11:57:00 -07004263/**
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004264 * ieee80211_ave_rssi - report the average RSSI for the specified interface
Wey-Yi Guy0d8a0a12012-04-20 11:57:00 -07004265 *
4266 * @vif: the specified virtual interface
4267 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004268 * Note: This function assumes that the given vif is valid.
4269 *
4270 * Return: The average RSSI value for the requested interface, or 0 if not
4271 * applicable.
Wey-Yi Guy0d8a0a12012-04-20 11:57:00 -07004272 */
Wey-Yi Guy1dae27f2012-04-13 12:02:57 -07004273int ieee80211_ave_rssi(struct ieee80211_vif *vif);
4274
Johannes Bergcd8f7cb2013-01-22 12:34:29 +01004275/**
4276 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
4277 * @vif: virtual interface
4278 * @wakeup: wakeup reason(s)
4279 * @gfp: allocation flags
4280 *
4281 * See cfg80211_report_wowlan_wakeup().
4282 */
4283void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
4284 struct cfg80211_wowlan_wakeup *wakeup,
4285 gfp_t gfp);
4286
Jiri Bencf0706e82007-05-05 11:45:53 -07004287#endif /* MAC80211_H */