blob: 9210bdc7bd8d417b94cf721b9ac671f7f2e700ed [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 Berg42d987952011-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 Berge100bb62008-04-30 18:51:21 +020096 */
97enum ieee80211_max_queues {
Johannes Berg51b38142009-03-12 11:16:48 +010098 IEEE80211_MAX_QUEUES = 4,
Johannes Berge100bb62008-04-30 18:51:21 +020099};
100
101/**
Johannes Berg4bce22b2010-11-16 11:49:58 -0800102 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
103 * @IEEE80211_AC_VO: voice
104 * @IEEE80211_AC_VI: video
105 * @IEEE80211_AC_BE: best effort
106 * @IEEE80211_AC_BK: background
107 */
108enum ieee80211_ac_numbers {
109 IEEE80211_AC_VO = 0,
110 IEEE80211_AC_VI = 1,
111 IEEE80211_AC_BE = 2,
112 IEEE80211_AC_BK = 3,
113};
Johannes Berg948d8872011-09-29 16:04:29 +0200114#define IEEE80211_NUM_ACS 4
Johannes Berg4bce22b2010-11-16 11:49:58 -0800115
116/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400117 * struct ieee80211_tx_queue_params - transmit queue configuration
118 *
119 * The information provided in this structure is required for QoS
Johannes Berg3330d7b2008-02-10 16:49:38 +0100120 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400121 *
Bob Copelande37d4df2008-10-20 21:20:27 -0400122 * @aifs: arbitration interframe space [0..255]
Johannes Bergf434b2d2008-07-10 11:22:31 +0200123 * @cw_min: minimum contention window [a value of the form
124 * 2^n-1 in the range 1..32767]
Johannes Berg6b301cd2007-09-18 17:29:20 -0400125 * @cw_max: maximum contention window [like @cw_min]
Johannes Berg3330d7b2008-02-10 16:49:38 +0100126 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
Kalle Valo9d173fc2010-01-14 13:09:14 +0200127 * @uapsd: is U-APSD mode enabled for the queue
Johannes Berg6b301cd2007-09-18 17:29:20 -0400128 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700129struct ieee80211_tx_queue_params {
Johannes Bergf434b2d2008-07-10 11:22:31 +0200130 u16 txop;
Johannes Berg3330d7b2008-02-10 16:49:38 +0100131 u16 cw_min;
132 u16 cw_max;
Johannes Bergf434b2d2008-07-10 11:22:31 +0200133 u8 aifs;
Kalle Valoab133152010-01-12 10:42:31 +0200134 bool uapsd;
Jiri Bencf0706e82007-05-05 11:45:53 -0700135};
136
Jiri Bencf0706e82007-05-05 11:45:53 -0700137struct ieee80211_low_level_stats {
138 unsigned int dot11ACKFailureCount;
139 unsigned int dot11RTSFailureCount;
140 unsigned int dot11FCSErrorCount;
141 unsigned int dot11RTSSuccessCount;
142};
143
Johannes Berg471b3ef2007-12-28 14:32:58 +0100144/**
145 * enum ieee80211_bss_change - BSS change notification flags
146 *
147 * These flags are used with the bss_info_changed() callback
148 * to indicate which BSS parameter changed.
149 *
150 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
151 * also implies a change in the AID.
152 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
153 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300154 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler38668c02008-03-28 16:33:32 -0700155 * @BSS_CHANGED_HT: 802.11n parameters changed
Johannes Berg96dd22a2008-09-11 00:01:57 +0200156 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200157 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200158 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
159 * reason (IBSS and managed mode)
160 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
161 * new beacon (beaconing modes)
162 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
163 * enabled/disabled (beaconing modes)
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200164 * @BSS_CHANGED_CQM: Connection quality monitor config changed
Johannes Berg8fc214b2010-04-28 17:40:43 +0200165 * @BSS_CHANGED_IBSS: IBSS join status changed
Juuso Oikarinen68542962010-06-09 13:43:26 +0300166 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
Johannes Berg4ced3f72010-07-19 16:39:04 +0200167 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
168 * that it is only ever disabled for station mode.
Johannes Berg7da7cc12010-08-05 17:02:38 +0200169 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
Arik Nemtsov78274932011-09-04 11:11:32 +0300170 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP mode)
Arik Nemtsov02945822011-11-10 11:28:57 +0200171 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
Johannes Berg471b3ef2007-12-28 14:32:58 +0100172 */
173enum ieee80211_bss_change {
174 BSS_CHANGED_ASSOC = 1<<0,
175 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
176 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300177 BSS_CHANGED_ERP_SLOT = 1<<3,
Alexander Simona7ce1c92011-09-18 00:16:45 +0200178 BSS_CHANGED_HT = 1<<4,
Johannes Berg96dd22a2008-09-11 00:01:57 +0200179 BSS_CHANGED_BASIC_RATES = 1<<5,
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200180 BSS_CHANGED_BEACON_INT = 1<<6,
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200181 BSS_CHANGED_BSSID = 1<<7,
182 BSS_CHANGED_BEACON = 1<<8,
183 BSS_CHANGED_BEACON_ENABLED = 1<<9,
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200184 BSS_CHANGED_CQM = 1<<10,
Johannes Berg8fc214b2010-04-28 17:40:43 +0200185 BSS_CHANGED_IBSS = 1<<11,
Juuso Oikarinen68542962010-06-09 13:43:26 +0300186 BSS_CHANGED_ARP_FILTER = 1<<12,
Johannes Berg4ced3f72010-07-19 16:39:04 +0200187 BSS_CHANGED_QOS = 1<<13,
Johannes Berg7da7cc12010-08-05 17:02:38 +0200188 BSS_CHANGED_IDLE = 1<<14,
Arik Nemtsov78274932011-09-04 11:11:32 +0300189 BSS_CHANGED_SSID = 1<<15,
Arik Nemtsov02945822011-11-10 11:28:57 +0200190 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
Johannes Bergac8dd502010-05-05 09:44:02 +0200191
192 /* when adding here, make sure to change ieee80211_reconfig */
Johannes Berg471b3ef2007-12-28 14:32:58 +0100193};
194
Juuso Oikarinen68542962010-06-09 13:43:26 +0300195/*
196 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
197 * of addresses for an interface increase beyond this value, hardware ARP
198 * filtering will be disabled.
199 */
200#define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
201
Johannes Berg471b3ef2007-12-28 14:32:58 +0100202/**
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -0700203 * enum ieee80211_rssi_event - RSSI threshold event
204 * An indicator for when RSSI goes below/above a certain threshold.
205 * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
206 * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
207 */
208enum ieee80211_rssi_event {
209 RSSI_EVENT_HIGH,
210 RSSI_EVENT_LOW,
211};
212
213/**
Johannes Berg471b3ef2007-12-28 14:32:58 +0100214 * struct ieee80211_bss_conf - holds the BSS's changing parameters
215 *
216 * This structure keeps information about a BSS (and an association
217 * to that BSS) that can change during the lifetime of the BSS.
218 *
219 * @assoc: association status
Johannes Berg8fc214b2010-04-28 17:40:43 +0200220 * @ibss_joined: indicates whether this station is part of an IBSS
221 * or not
Johannes Berg471b3ef2007-12-28 14:32:58 +0100222 * @aid: association ID number, valid only when @assoc is true
223 * @use_cts_prot: use CTS protection
Johannes Berg7a5158e2008-10-08 10:59:33 +0200224 * @use_short_preamble: use 802.11b short preamble;
225 * if the hardware cannot handle this it must set the
226 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
227 * @use_short_slot: use short slot time (only relevant for ERP);
228 * if the hardware cannot handle this it must set the
229 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
Johannes Berg56007a02010-01-26 14:19:52 +0100230 * @dtim_period: num of beacons before the next DTIM, for beaconing,
Johannes Berge5b900d2010-07-29 16:08:55 +0200231 * valid in station mode only while @assoc is true and if also
232 * requested by %IEEE80211_HW_NEED_DTIM_PERIOD (cf. also hw conf
233 * @ps_dtim_period)
Johannes Berge9ac0742012-03-13 14:29:30 +0100234 * @last_tsf: last beacon's/probe response's TSF timestamp (could be old
235 * as it may have been received during scanning long ago)
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700236 * @beacon_int: beacon interval
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800237 * @assoc_capability: capabilities taken from assoc resp
Johannes Berg96dd22a2008-09-11 00:01:57 +0200238 * @basic_rates: bitmap of basic rates, each bit stands for an
239 * index into the rate table configured by the driver in
240 * the current band.
Felix Fietkaudd5b4cc2010-11-22 20:58:24 +0100241 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200242 * @bssid: The BSSID for this BSS
243 * @enable_beacon: whether beaconing should be enabled or not
Johannes Berg0aaffa92010-05-05 15:28:27 +0200244 * @channel_type: Channel type for this BSS -- the hardware might be
245 * configured for HT40+ while this BSS only uses no-HT, for
246 * example.
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200247 * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
248 * This field is only valid when the channel type is one of the HT types.
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200249 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
250 * implies disabled
251 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
Juuso Oikarinen68542962010-06-09 13:43:26 +0300252 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
253 * may filter ARP queries targeted for other addresses than listed here.
254 * The driver must allow ARP queries targeted for all address listed here
255 * to pass through. An empty list implies no ARP queries need to pass.
256 * @arp_addr_cnt: Number of addresses currently on the list.
257 * @arp_filter_enabled: Enable ARP filtering - if enabled, the hardware may
258 * filter ARP queries based on the @arp_addr_list, if disabled, the
259 * hardware must not perform any ARP filtering. Note, that the filter will
260 * be enabled also in promiscuous mode.
Johannes Berg4ced3f72010-07-19 16:39:04 +0200261 * @qos: This is a QoS-enabled BSS.
Johannes Berg7da7cc12010-08-05 17:02:38 +0200262 * @idle: This interface is idle. There's also a global idle flag in the
263 * hardware config which may be more appropriate depending on what
264 * your driver/device needs to do.
Arik Nemtsov78274932011-09-04 11:11:32 +0300265 * @ssid: The SSID of the current vif. Only valid in AP-mode.
266 * @ssid_len: Length of SSID given in @ssid.
267 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
Johannes Berg471b3ef2007-12-28 14:32:58 +0100268 */
269struct ieee80211_bss_conf {
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200270 const u8 *bssid;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100271 /* association related data */
Johannes Berg8fc214b2010-04-28 17:40:43 +0200272 bool assoc, ibss_joined;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100273 u16 aid;
274 /* erp related data */
275 bool use_cts_prot;
276 bool use_short_preamble;
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300277 bool use_short_slot;
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200278 bool enable_beacon;
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800279 u8 dtim_period;
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700280 u16 beacon_int;
281 u16 assoc_capability;
Johannes Berge9ac0742012-03-13 14:29:30 +0100282 u64 last_tsf;
Johannes Berg881d9482009-01-21 15:13:48 +0100283 u32 basic_rates;
Felix Fietkaudd5b4cc2010-11-22 20:58:24 +0100284 int mcast_rate[IEEE80211_NUM_BANDS];
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200285 u16 ht_operation_mode;
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200286 s32 cqm_rssi_thold;
287 u32 cqm_rssi_hyst;
Johannes Berg0aaffa92010-05-05 15:28:27 +0200288 enum nl80211_channel_type channel_type;
Juuso Oikarinen68542962010-06-09 13:43:26 +0300289 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
290 u8 arp_addr_cnt;
291 bool arp_filter_enabled;
Johannes Berg4ced3f72010-07-19 16:39:04 +0200292 bool qos;
Johannes Berg7da7cc12010-08-05 17:02:38 +0200293 bool idle;
Arik Nemtsov78274932011-09-04 11:11:32 +0300294 u8 ssid[IEEE80211_MAX_SSID_LEN];
295 size_t ssid_len;
296 bool hidden_ssid;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100297};
298
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800299/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700300 * enum mac80211_tx_control_flags - flags to describe transmission information/status
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800301 *
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700302 * These flags are used with the @flags member of &ieee80211_tx_info.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800303 *
Johannes Berg7351c6b2009-11-19 01:08:30 +0100304 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
Johannes Berge6a98542008-10-21 12:40:02 +0200305 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
306 * number to this frame, taking care of not overwriting the fragment
307 * number and increasing the sequence number only when the
308 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
309 * assign sequence numbers to QoS-data frames but cannot do so correctly
310 * for non-QoS-data and management frames because beacons need them from
311 * that counter as well and mac80211 cannot guarantee proper sequencing.
312 * If this flag is set, the driver should instruct the hardware to
313 * assign a sequence number to the frame or assign one itself. Cf. IEEE
314 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
315 * beacons and always be clear for frames without a sequence number field.
Johannes Berge039fa42008-05-15 12:55:29 +0200316 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
Johannes Berge039fa42008-05-15 12:55:29 +0200317 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
318 * station
Johannes Berge039fa42008-05-15 12:55:29 +0200319 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
Johannes Berge039fa42008-05-15 12:55:29 +0200320 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
321 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
Johannes Berge6a98542008-10-21 12:40:02 +0200322 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
Johannes Berge039fa42008-05-15 12:55:29 +0200323 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
Johannes Bergab5b5342009-08-07 16:28:09 +0200324 * because the destination STA was in powersave mode. Note that to
325 * avoid race conditions, the filter must be set by the hardware or
326 * firmware upon receiving a frame that indicates that the station
327 * went to sleep (must be done on device to filter frames already on
328 * the queue) and may only be unset after mac80211 gives the OK for
329 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
330 * since only then is it guaranteed that no more frames are in the
331 * hardware queue.
Johannes Berge039fa42008-05-15 12:55:29 +0200332 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
333 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
334 * is for the whole aggregation.
Ron Rindjunsky429a3802008-07-01 14:16:03 +0300335 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
336 * so consider using block ack request (BAR).
Johannes Berge6a98542008-10-21 12:40:02 +0200337 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
338 * set by rate control algorithms to indicate probe rate, will
339 * be cleared for fragmented frames (except on the last fragment)
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100340 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
341 * used to indicate that a pending frame requires TX processing before
342 * it can be sent out.
Johannes Berg8f77f382009-06-07 21:58:37 +0200343 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
344 * used to indicate that a frame was already retried due to PS
Johannes Berg3b8d81e02009-06-17 17:43:56 +0200345 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
346 * used to indicate frame should not be encrypted
Johannes Berg02f2f1a2012-02-27 12:18:30 +0100347 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
348 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
349 * be sent although the station is in powersave mode.
Johannes Bergad5351d2009-08-07 16:42:15 +0200350 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
351 * transmit function after the current frame, this can be used
352 * by drivers to kick the DMA queue only if unset or when the
353 * queue gets full.
Johannes Bergc6fcf6b2010-01-17 01:47:59 +0100354 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
355 * after TX status because the destination was asleep, it must not
356 * be modified again (no seqno assignment, crypto, etc.)
Jouni Malinen026331c2010-02-15 12:53:10 +0200357 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
358 * MLME command (internal to mac80211 to figure out whether to send TX
359 * status to user space)
Luis R. Rodriguez0a56bd02010-04-15 17:39:37 -0400360 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
Felix Fietkauf79d9ba2010-04-19 19:57:35 +0200361 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
362 * frame and selects the maximum number of streams that it can use.
Johannes Berg610dbc92011-01-06 22:36:44 +0100363 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
364 * the off-channel channel when a remain-on-channel offload is done
365 * in hardware -- normal packets still flow and are expected to be
366 * handled properly by the device.
Jouni Malinen681d1192011-02-03 18:35:19 +0200367 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
368 * testing. It will be sent out with incorrect Michael MIC key to allow
369 * TKIP countermeasures to be tested.
Rajkumar Manoharanaad14ce2011-09-25 14:53:31 +0530370 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
371 * This flag is actually used for management frame especially for P2P
372 * frames not being sent at CCK rate in 2GHz band.
Johannes Berg47086fc2011-09-29 16:04:33 +0200373 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
374 * when its status is reported the service period ends. For frames in
375 * an SP that mac80211 transmits, it is already set; for driver frames
Johannes Bergdeeaee192011-09-29 16:04:35 +0200376 * the driver may set this flag. It is also used to do the same for
377 * PS-Poll responses.
Rajkumar Manoharanb6f35302011-09-29 20:34:04 +0530378 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
379 * This flag is used to send nullfunc frame at minimum rate when
380 * the nullfunc is used for connection monitoring purpose.
Johannes Berga26eb272011-10-07 14:01:25 +0200381 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
382 * would be fragmented by size (this is optional, only used for
383 * monitor injection).
Christian Lampartereb7d3062010-09-21 21:36:18 +0200384 *
385 * Note: If you have to add new flags to the enumeration, then don't
386 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800387 */
388enum mac80211_tx_control_flags {
Johannes Berge039fa42008-05-15 12:55:29 +0200389 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
Johannes Berge6a98542008-10-21 12:40:02 +0200390 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
391 IEEE80211_TX_CTL_NO_ACK = BIT(2),
392 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
393 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
394 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
395 IEEE80211_TX_CTL_AMPDU = BIT(6),
396 IEEE80211_TX_CTL_INJECTED = BIT(7),
397 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
398 IEEE80211_TX_STAT_ACK = BIT(9),
399 IEEE80211_TX_STAT_AMPDU = BIT(10),
400 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
401 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100402 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
Johannes Berg8f77f382009-06-07 21:58:37 +0200403 IEEE80211_TX_INTFL_RETRIED = BIT(15),
Johannes Berg3b8d81e02009-06-17 17:43:56 +0200404 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
Johannes Berg02f2f1a2012-02-27 12:18:30 +0100405 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
Johannes Bergad5351d2009-08-07 16:42:15 +0200406 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
Johannes Bergc6fcf6b2010-01-17 01:47:59 +0100407 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
Johannes Berg73b9f032011-10-07 14:01:26 +0200408 /* hole at 20, use later */
Jouni Malinen026331c2010-02-15 12:53:10 +0200409 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
Luis R. Rodriguez0a56bd02010-04-15 17:39:37 -0400410 IEEE80211_TX_CTL_LDPC = BIT(22),
Felix Fietkauf79d9ba2010-04-19 19:57:35 +0200411 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
Johannes Berg21f83582010-12-18 17:20:47 +0100412 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
Jouni Malinen681d1192011-02-03 18:35:19 +0200413 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
Rajkumar Manoharanaad14ce2011-09-25 14:53:31 +0530414 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
Johannes Berg47086fc2011-09-29 16:04:33 +0200415 IEEE80211_TX_STATUS_EOSP = BIT(28),
Rajkumar Manoharanb6f35302011-09-29 20:34:04 +0530416 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
Johannes Berga26eb272011-10-07 14:01:25 +0200417 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
Johannes Berge6a98542008-10-21 12:40:02 +0200418};
419
Johannes Bergabe37c42010-06-07 11:12:27 +0200420#define IEEE80211_TX_CTL_STBC_SHIFT 23
421
Christian Lampartereb7d3062010-09-21 21:36:18 +0200422/*
423 * This definition is used as a mask to clear all temporary flags, which are
424 * set by the tx handlers for each transmission attempt by the mac80211 stack.
425 */
426#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
427 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
428 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
429 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
430 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
Johannes Berg02f2f1a2012-02-27 12:18:30 +0100431 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
Christian Lampartereb7d3062010-09-21 21:36:18 +0200432 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
Johannes Berg47086fc2011-09-29 16:04:33 +0200433 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
Christian Lampartereb7d3062010-09-21 21:36:18 +0200434
Sujith2134e7e2009-01-22 09:00:52 +0530435/**
436 * enum mac80211_rate_control_flags - per-rate flags set by the
437 * Rate Control algorithm.
438 *
439 * These flags are set by the Rate control algorithm for each rate during tx,
440 * in the @flags member of struct ieee80211_tx_rate.
441 *
442 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
443 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
444 * This is set if the current BSS requires ERP protection.
445 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
446 * @IEEE80211_TX_RC_MCS: HT rate.
447 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
448 * Greenfield mode.
449 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
450 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
451 * adjacent 20 MHz channels, if the current channel type is
452 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
453 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
454 */
Johannes Berge6a98542008-10-21 12:40:02 +0200455enum mac80211_rate_control_flags {
456 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
457 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
458 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
459
460 /* rate index is an MCS rate number instead of an index */
461 IEEE80211_TX_RC_MCS = BIT(3),
462 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
463 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
464 IEEE80211_TX_RC_DUP_DATA = BIT(6),
465 IEEE80211_TX_RC_SHORT_GI = BIT(7),
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800466};
467
Johannes Berge039fa42008-05-15 12:55:29 +0200468
Johannes Berge6a98542008-10-21 12:40:02 +0200469/* there are 40 bytes if you don't need the rateset to be kept */
470#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
Johannes Berge039fa42008-05-15 12:55:29 +0200471
Johannes Berge6a98542008-10-21 12:40:02 +0200472/* if you do need the rateset, then you have less space */
473#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
474
475/* maximum number of rate stages */
476#define IEEE80211_TX_MAX_RATES 5
Felix Fietkau870abdf2008-10-05 18:04:24 +0200477
478/**
Johannes Berge6a98542008-10-21 12:40:02 +0200479 * struct ieee80211_tx_rate - rate selection/status
Felix Fietkau870abdf2008-10-05 18:04:24 +0200480 *
Johannes Berge6a98542008-10-21 12:40:02 +0200481 * @idx: rate index to attempt to send with
482 * @flags: rate control flags (&enum mac80211_rate_control_flags)
Johannes Berge25cf4a2008-10-23 08:51:20 +0200483 * @count: number of tries in this rate before going to the next rate
Johannes Berge6a98542008-10-21 12:40:02 +0200484 *
485 * A value of -1 for @idx indicates an invalid rate and, if used
486 * in an array of retry rates, that no more rates should be tried.
487 *
488 * When used for transmit status reporting, the driver should
489 * always report the rate along with the flags it used.
Johannes Bergc555b9b2009-08-07 16:23:43 +0200490 *
491 * &struct ieee80211_tx_info contains an array of these structs
492 * in the control information, and it will be filled by the rate
493 * control algorithm according to what should be sent. For example,
494 * if this array contains, in the format { <idx>, <count> } the
495 * information
496 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
497 * then this means that the frame should be transmitted
498 * up to twice at rate 3, up to twice at rate 2, and up to four
499 * times at rate 1 if it doesn't get acknowledged. Say it gets
500 * acknowledged by the peer after the fifth attempt, the status
501 * information should then contain
502 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
503 * since it was transmitted twice at rate 3, twice at rate 2
504 * and once at rate 1 after which we received an acknowledgement.
Felix Fietkau870abdf2008-10-05 18:04:24 +0200505 */
Johannes Berge6a98542008-10-21 12:40:02 +0200506struct ieee80211_tx_rate {
507 s8 idx;
508 u8 count;
509 u8 flags;
Gustavo F. Padovan3f30fc12010-07-21 10:59:58 +0000510} __packed;
Felix Fietkau870abdf2008-10-05 18:04:24 +0200511
Johannes Berge039fa42008-05-15 12:55:29 +0200512/**
513 * struct ieee80211_tx_info - skb transmit information
Ivo van Doorn1c014422008-04-17 19:41:02 +0200514 *
Johannes Berge039fa42008-05-15 12:55:29 +0200515 * This structure is placed in skb->cb for three uses:
516 * (1) mac80211 TX control - mac80211 tells the driver what to do
517 * (2) driver internal use (if applicable)
518 * (3) TX status information - driver tells mac80211 what happened
519 *
Johannes Berg17741cd2008-09-11 00:02:02 +0200520 * The TX control's sta pointer is only valid during the ->tx call,
521 * it may be NULL.
522 *
Johannes Berge039fa42008-05-15 12:55:29 +0200523 * @flags: transmit info flags, defined above
Johannes Berge6a98542008-10-21 12:40:02 +0200524 * @band: the band to transmit on (use for checking for races)
Johannes Berg0f4ac382008-10-09 12:18:04 +0200525 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
Johannes Berga729cff2011-11-06 14:13:34 +0100526 * @ack_frame_id: internal frame ID for TX status, used internally
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700527 * @control: union for control data
528 * @status: union for status data
529 * @driver_data: array of driver_data pointers
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100530 * @ampdu_ack_len: number of acked aggregated frames.
Daniel Halperin93d95b12010-04-18 09:28:18 -0700531 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100532 * @ampdu_len: number of aggregated frames.
Daniel Halperin93d95b12010-04-18 09:28:18 -0700533 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
Johannes Berge039fa42008-05-15 12:55:29 +0200534 * @ack_signal: signal strength of the ACK frame
Ivo van Doorn1c014422008-04-17 19:41:02 +0200535 */
Johannes Berge039fa42008-05-15 12:55:29 +0200536struct ieee80211_tx_info {
537 /* common information */
538 u32 flags;
539 u8 band;
Johannes Berge6a98542008-10-21 12:40:02 +0200540
Johannes Berge039fa42008-05-15 12:55:29 +0200541 u8 antenna_sel_tx;
Johannes Berg8318d782008-01-24 19:38:38 +0100542
Johannes Berga729cff2011-11-06 14:13:34 +0100543 u16 ack_frame_id;
Johannes Berg8318d782008-01-24 19:38:38 +0100544
Johannes Berge039fa42008-05-15 12:55:29 +0200545 union {
546 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200547 union {
548 /* rate control */
549 struct {
550 struct ieee80211_tx_rate rates[
551 IEEE80211_TX_MAX_RATES];
552 s8 rts_cts_rate_idx;
553 };
554 /* only needed before rate control */
555 unsigned long jiffies;
556 };
Johannes Berg25d834e2008-09-12 22:52:47 +0200557 /* NB: vif can be NULL for injected frames */
Johannes Berge039fa42008-05-15 12:55:29 +0200558 struct ieee80211_vif *vif;
559 struct ieee80211_key_conf *hw_key;
Johannes Berg17741cd2008-09-11 00:02:02 +0200560 struct ieee80211_sta *sta;
Johannes Berge039fa42008-05-15 12:55:29 +0200561 } control;
562 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200563 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
564 u8 ampdu_ack_len;
Johannes Berge039fa42008-05-15 12:55:29 +0200565 int ack_signal;
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100566 u8 ampdu_len;
Johannes Berg095dfdb2010-05-26 17:19:25 +0200567 /* 15 bytes free */
Johannes Berge039fa42008-05-15 12:55:29 +0200568 } status;
Johannes Berge6a98542008-10-21 12:40:02 +0200569 struct {
570 struct ieee80211_tx_rate driver_rates[
571 IEEE80211_TX_MAX_RATES];
572 void *rate_driver_data[
573 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
574 };
575 void *driver_data[
576 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
Johannes Berge039fa42008-05-15 12:55:29 +0200577 };
Jiri Bencf0706e82007-05-05 11:45:53 -0700578};
579
Luciano Coelho79f460c2011-05-11 17:09:36 +0300580/**
Randy Dunlapbdfbe802011-05-22 17:22:45 -0700581 * struct ieee80211_sched_scan_ies - scheduled scan IEs
Luciano Coelho79f460c2011-05-11 17:09:36 +0300582 *
583 * This structure is used to pass the appropriate IEs to be used in scheduled
584 * scans for all bands. It contains both the IEs passed from the userspace
585 * and the ones generated by mac80211.
586 *
587 * @ie: array with the IEs for each supported band
588 * @len: array with the total length of the IEs for each band
589 */
590struct ieee80211_sched_scan_ies {
591 u8 *ie[IEEE80211_NUM_BANDS];
592 size_t len[IEEE80211_NUM_BANDS];
593};
594
Johannes Berge039fa42008-05-15 12:55:29 +0200595static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
596{
597 return (struct ieee80211_tx_info *)skb->cb;
598}
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400599
Johannes Bergf1d58c22009-06-17 13:13:00 +0200600static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
601{
602 return (struct ieee80211_rx_status *)skb->cb;
603}
604
Johannes Berge6a98542008-10-21 12:40:02 +0200605/**
606 * ieee80211_tx_info_clear_status - clear TX status
607 *
608 * @info: The &struct ieee80211_tx_info to be cleared.
609 *
610 * When the driver passes an skb back to mac80211, it must report
611 * a number of things in TX status. This function clears everything
612 * in the TX status but the rate control information (it does clear
613 * the count since you need to fill that in anyway).
614 *
615 * NOTE: You can only use this function if you do NOT use
616 * info->driver_data! Use info->rate_driver_data
617 * instead if you need only the less space that allows.
618 */
619static inline void
620ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
621{
622 int i;
623
624 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
625 offsetof(struct ieee80211_tx_info, control.rates));
626 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
627 offsetof(struct ieee80211_tx_info, driver_rates));
628 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
629 /* clear the rate counts */
630 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
631 info->status.rates[i].count = 0;
632
633 BUILD_BUG_ON(
634 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
635 memset(&info->status.ampdu_ack_len, 0,
636 sizeof(struct ieee80211_tx_info) -
637 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
638}
639
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400640
641/**
642 * enum mac80211_rx_flags - receive flags
643 *
644 * These flags are used with the @flag member of &struct ieee80211_rx_status.
645 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
646 * Use together with %RX_FLAG_MMIC_STRIPPED.
647 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400648 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
649 * verification has been done by the hardware.
650 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
651 * If this flag is set, the stack cannot do any replay detection
652 * hence the driver or hardware will have to do that.
Johannes Berg72abd812007-09-17 01:29:22 -0400653 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
654 * the frame.
655 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
656 * the frame.
Johannes Berg6ebacbb2011-02-23 15:06:08 +0100657 * @RX_FLAG_MACTIME_MPDU: The timestamp passed in the RX status (@mactime
658 * field) is valid and contains the time the first symbol of the MPDU
659 * was received. This is useful in monitor mode and for proper IBSS
660 * merging.
Bruno Randolfb4f28bb2008-07-30 17:19:55 +0200661 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200662 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
663 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
664 * @RX_FLAG_SHORT_GI: Short guard interval was used
Felix Fietkaufe8431f2012-03-01 18:00:07 +0100665 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
666 * Valid only for data frames (mainly A-MPDU)
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400667 */
668enum mac80211_rx_flags {
669 RX_FLAG_MMIC_ERROR = 1<<0,
670 RX_FLAG_DECRYPTED = 1<<1,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400671 RX_FLAG_MMIC_STRIPPED = 1<<3,
672 RX_FLAG_IV_STRIPPED = 1<<4,
Johannes Berg72abd812007-09-17 01:29:22 -0400673 RX_FLAG_FAILED_FCS_CRC = 1<<5,
674 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
Johannes Berg6ebacbb2011-02-23 15:06:08 +0100675 RX_FLAG_MACTIME_MPDU = 1<<7,
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200676 RX_FLAG_SHORTPRE = 1<<8,
677 RX_FLAG_HT = 1<<9,
678 RX_FLAG_40MHZ = 1<<10,
679 RX_FLAG_SHORT_GI = 1<<11,
Felix Fietkaufe8431f2012-03-01 18:00:07 +0100680 RX_FLAG_NO_SIGNAL_VAL = 1<<12,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400681};
682
683/**
684 * struct ieee80211_rx_status - receive status
685 *
686 * The low-level driver should provide this information (the subset
687 * supported by hardware) to the 802.11 code with each received
Johannes Bergf1d58c22009-06-17 13:13:00 +0200688 * frame, in the skb's control buffer (cb).
Bruno Randolf566bfe52008-05-08 19:15:40 +0200689 *
Bruno Randolfc132bec2008-02-18 11:20:51 +0900690 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
691 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
Johannes Berg8318d782008-01-24 19:38:38 +0100692 * @band: the active band when this frame was received
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400693 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
Bruno Randolf566bfe52008-05-08 19:15:40 +0200694 * @signal: signal strength when receiving this frame, either in dBm, in dB or
695 * unspecified depending on the hardware capabilities flags
696 * @IEEE80211_HW_SIGNAL_*
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400697 * @antenna: antenna used
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200698 * @rate_idx: index of data rate into band's supported rates or MCS index if
699 * HT rates are use (RX_FLAG_HT)
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400700 * @flag: %RX_FLAG_*
Johannes Berg554891e2010-09-24 12:38:25 +0200701 * @rx_flags: internal RX flags for mac80211
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400702 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700703struct ieee80211_rx_status {
704 u64 mactime;
Johannes Berg8318d782008-01-24 19:38:38 +0100705 enum ieee80211_band band;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400706 int freq;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400707 int signal;
Jiri Bencf0706e82007-05-05 11:45:53 -0700708 int antenna;
Johannes Berg8318d782008-01-24 19:38:38 +0100709 int rate_idx;
Jiri Bencf0706e82007-05-05 11:45:53 -0700710 int flag;
Johannes Berg554891e2010-09-24 12:38:25 +0200711 unsigned int rx_flags;
Jiri Bencf0706e82007-05-05 11:45:53 -0700712};
713
Johannes Berg6b301cd2007-09-18 17:29:20 -0400714/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400715 * enum ieee80211_conf_flags - configuration flags
716 *
717 * Flags to define PHY configuration options
718 *
Johannes Berg0869aea2009-10-28 10:03:35 +0100719 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
720 * to determine for example whether to calculate timestamps for packets
721 * or not, do not use instead of filter flags!
Kalle Valoc99445b2010-01-14 13:09:21 +0200722 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
723 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
724 * meaning that the hardware still wakes up for beacons, is able to
725 * transmit frames and receive the possible acknowledgment frames.
726 * Not to be confused with hardware specific wakeup/sleep states,
727 * driver is responsible for that. See the section "Powersave support"
728 * for more.
Johannes Berg5cff20e2009-04-29 12:26:17 +0200729 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
730 * the driver should be prepared to handle configuration requests but
731 * may turn the device off as much as possible. Typically, this flag will
732 * be set when an interface is set UP but not associated or scanning, but
733 * it can also be unset in that case when monitor interfaces are active.
Felix Fietkau45521242010-07-28 02:40:49 +0200734 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
735 * operating channel.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400736 */
737enum ieee80211_conf_flags {
Johannes Berg0869aea2009-10-28 10:03:35 +0100738 IEEE80211_CONF_MONITOR = (1<<0),
Johannes Bergae5eb022008-10-14 16:58:37 +0200739 IEEE80211_CONF_PS = (1<<1),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200740 IEEE80211_CONF_IDLE = (1<<2),
Felix Fietkau45521242010-07-28 02:40:49 +0200741 IEEE80211_CONF_OFFCHANNEL = (1<<3),
Johannes Berg6b301cd2007-09-18 17:29:20 -0400742};
Jiri Bencf0706e82007-05-05 11:45:53 -0700743
Johannes Berg7a5158e2008-10-08 10:59:33 +0200744
Jiri Bencf0706e82007-05-05 11:45:53 -0700745/**
Johannes Berge8975582008-10-09 12:18:51 +0200746 * enum ieee80211_conf_changed - denotes which configuration changed
747 *
Johannes Berge8975582008-10-09 12:18:51 +0200748 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
Johannes Berg0869aea2009-10-28 10:03:35 +0100749 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
Johannes Berge255d5e2009-04-22 12:40:07 +0200750 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
Johannes Berge8975582008-10-09 12:18:51 +0200751 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
Johannes Berg47979382009-01-07 10:13:27 +0100752 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
Johannes Berg9124b072008-10-14 19:17:54 +0200753 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
Johannes Berg5cff20e2009-04-29 12:26:17 +0200754 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
Johannes Berg0f782312009-12-01 13:37:02 +0100755 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
Johannes Berge8975582008-10-09 12:18:51 +0200756 */
757enum ieee80211_conf_changed {
Johannes Berg0f782312009-12-01 13:37:02 +0100758 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
Johannes Berge8975582008-10-09 12:18:51 +0200759 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
Johannes Berg0869aea2009-10-28 10:03:35 +0100760 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
Johannes Berge8975582008-10-09 12:18:51 +0200761 IEEE80211_CONF_CHANGE_PS = BIT(4),
Johannes Berge255d5e2009-04-22 12:40:07 +0200762 IEEE80211_CONF_CHANGE_POWER = BIT(5),
763 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
764 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200765 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
Johannes Berge8975582008-10-09 12:18:51 +0200766};
767
768/**
Johannes Berg0f782312009-12-01 13:37:02 +0100769 * enum ieee80211_smps_mode - spatial multiplexing power save mode
770 *
Kalle Valo9d173fc2010-01-14 13:09:14 +0200771 * @IEEE80211_SMPS_AUTOMATIC: automatic
772 * @IEEE80211_SMPS_OFF: off
773 * @IEEE80211_SMPS_STATIC: static
774 * @IEEE80211_SMPS_DYNAMIC: dynamic
775 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
Johannes Berg0f782312009-12-01 13:37:02 +0100776 */
777enum ieee80211_smps_mode {
778 IEEE80211_SMPS_AUTOMATIC,
779 IEEE80211_SMPS_OFF,
780 IEEE80211_SMPS_STATIC,
781 IEEE80211_SMPS_DYNAMIC,
782
783 /* keep last */
784 IEEE80211_SMPS_NUM_MODES,
785};
786
787/**
Jiri Bencf0706e82007-05-05 11:45:53 -0700788 * struct ieee80211_conf - configuration of the device
789 *
790 * This struct indicates how the driver shall configure the hardware.
791 *
Johannes Berg04fe2032009-04-22 18:44:37 +0200792 * @flags: configuration flags defined above
793 *
Tomas Winklerea95bba2008-07-18 13:53:00 +0800794 * @listen_interval: listen interval in units of beacon interval
Johannes Berg9ccebe62009-04-23 10:32:36 +0200795 * @max_sleep_period: the maximum number of beacon intervals to sleep for
Johannes Berg04fe2032009-04-22 18:44:37 +0200796 * before checking the beacon for a TIM bit (managed mode only); this
797 * value will be only achievable between DTIM frames, the hardware
798 * needs to check for the multicast traffic bit in DTIM beacons.
799 * This variable is valid only when the CONF_PS flag is set.
Johannes Berg56007a02010-01-26 14:19:52 +0100800 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
801 * in power saving. Power saving will not be enabled until a beacon
802 * has been received and the DTIM period is known.
Johannes Berg04fe2032009-04-22 18:44:37 +0200803 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
804 * powersave documentation below. This variable is valid only when
805 * the CONF_PS flag is set.
806 *
Johannes Berg8318d782008-01-24 19:38:38 +0100807 * @power_level: requested transmit power (in dBm)
Johannes Berg04fe2032009-04-22 18:44:37 +0200808 *
Johannes Berg8318d782008-01-24 19:38:38 +0100809 * @channel: the channel to tune to
Johannes Berg47979382009-01-07 10:13:27 +0100810 * @channel_type: the channel (HT) type
Johannes Berg04fe2032009-04-22 18:44:37 +0200811 *
Johannes Berg9124b072008-10-14 19:17:54 +0200812 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
813 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
814 * but actually means the number of transmissions not the number of retries
815 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
816 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
817 * number of transmissions not the number of retries
Johannes Berg0f782312009-12-01 13:37:02 +0100818 *
819 * @smps_mode: spatial multiplexing powersave mode; note that
820 * %IEEE80211_SMPS_STATIC is used when the device is not
821 * configured for an HT channel
Jiri Bencf0706e82007-05-05 11:45:53 -0700822 */
823struct ieee80211_conf {
Johannes Berg6b301cd2007-09-18 17:29:20 -0400824 u32 flags;
Juuso Oikarinenff616382010-06-09 09:51:52 +0300825 int power_level, dynamic_ps_timeout;
Johannes Berg9ccebe62009-04-23 10:32:36 +0200826 int max_sleep_period;
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200827
Johannes Berge8975582008-10-09 12:18:51 +0200828 u16 listen_interval;
Johannes Berg56007a02010-01-26 14:19:52 +0100829 u8 ps_dtim_period;
Johannes Berge8975582008-10-09 12:18:51 +0200830
Johannes Berg9124b072008-10-14 19:17:54 +0200831 u8 long_frame_max_tx_count, short_frame_max_tx_count;
832
Johannes Berg8318d782008-01-24 19:38:38 +0100833 struct ieee80211_channel *channel;
Johannes Berg47979382009-01-07 10:13:27 +0100834 enum nl80211_channel_type channel_type;
Johannes Berg0f782312009-12-01 13:37:02 +0100835 enum ieee80211_smps_mode smps_mode;
Jiri Bencf0706e82007-05-05 11:45:53 -0700836};
837
838/**
Johannes Berg5ce6e432010-05-11 16:20:57 +0200839 * struct ieee80211_channel_switch - holds the channel switch data
840 *
841 * The information provided in this structure is required for channel switch
842 * operation.
843 *
844 * @timestamp: value in microseconds of the 64-bit Time Synchronization
845 * Function (TSF) timer when the frame containing the channel switch
846 * announcement was received. This is simply the rx.mactime parameter
847 * the driver passed into mac80211.
848 * @block_tx: Indicates whether transmission must be blocked before the
849 * scheduled channel switch, as indicated by the AP.
850 * @channel: the new channel to switch to
851 * @count: the number of TBTT's until the channel switch event
852 */
853struct ieee80211_channel_switch {
854 u64 timestamp;
855 bool block_tx;
856 struct ieee80211_channel *channel;
857 u8 count;
858};
859
860/**
Johannes Bergc1288b12012-01-19 09:29:57 +0100861 * enum ieee80211_vif_flags - virtual interface flags
862 *
863 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
864 * on this virtual interface to avoid unnecessary CPU wakeups
Johannes Bergea086352012-01-19 09:29:58 +0100865 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
866 * monitoring on this virtual interface -- i.e. it can monitor
867 * connection quality related parameters, such as the RSSI level and
868 * provide notifications if configured trigger levels are reached.
Johannes Bergc1288b12012-01-19 09:29:57 +0100869 */
870enum ieee80211_vif_flags {
871 IEEE80211_VIF_BEACON_FILTER = BIT(0),
Johannes Bergea086352012-01-19 09:29:58 +0100872 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
Johannes Bergc1288b12012-01-19 09:29:57 +0100873};
874
875/**
Johannes Berg32bfd352007-12-19 01:31:26 +0100876 * struct ieee80211_vif - per-interface data
877 *
878 * Data in this structure is continually present for driver
879 * use during the life of a virtual interface.
880 *
Johannes Berg51fb61e2007-12-19 01:31:27 +0100881 * @type: type of this virtual interface
Johannes Bergbda39332008-10-11 01:51:51 +0200882 * @bss_conf: BSS configuration for this interface, either our own
883 * or the BSS we're associated to
Johannes Berg47846c92009-11-25 17:46:19 +0100884 * @addr: address of this interface
Johannes Berg2ca27bc2010-09-16 14:58:23 +0200885 * @p2p: indicates whether this AP or STA interface is a p2p
886 * interface, i.e. a GO or p2p-sta respectively
Johannes Bergc1288b12012-01-19 09:29:57 +0100887 * @driver_flags: flags/capabilities the driver has for this interface,
888 * these need to be set (or cleared) when the interface is added
889 * or, if supported by the driver, the interface type is changed
890 * at runtime, mac80211 will never touch this field
Johannes Berg32bfd352007-12-19 01:31:26 +0100891 * @drv_priv: data area for driver use, will always be aligned to
892 * sizeof(void *).
893 */
894struct ieee80211_vif {
Johannes Berg05c914f2008-09-11 00:01:58 +0200895 enum nl80211_iftype type;
Johannes Bergbda39332008-10-11 01:51:51 +0200896 struct ieee80211_bss_conf bss_conf;
Johannes Berg47846c92009-11-25 17:46:19 +0100897 u8 addr[ETH_ALEN];
Johannes Berg2ca27bc2010-09-16 14:58:23 +0200898 bool p2p;
Johannes Bergc1288b12012-01-19 09:29:57 +0100899 u32 driver_flags;
Johannes Berg32bfd352007-12-19 01:31:26 +0100900 /* must be last */
901 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
902};
903
Johannes Berg902acc72008-02-23 15:17:19 +0100904static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
905{
906#ifdef CONFIG_MAC80211_MESH
Johannes Berg05c914f2008-09-11 00:01:58 +0200907 return vif->type == NL80211_IFTYPE_MESH_POINT;
Johannes Berg902acc72008-02-23 15:17:19 +0100908#endif
909 return false;
910}
911
Johannes Berg32bfd352007-12-19 01:31:26 +0100912/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400913 * enum ieee80211_key_flags - key flags
914 *
915 * These flags are used for communication about keys between the driver
916 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
917 *
918 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
919 * that the STA this key will be used with could be using QoS.
920 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
921 * driver to indicate that it requires IV generation for this
922 * particular key.
923 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
924 * the driver for a TKIP key if it requires Michael MIC
925 * generation in software.
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200926 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
927 * that the key is pairwise rather then a shared key.
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200928 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
929 * CCMP key if it requires CCMP encryption of management frames (MFP) to
930 * be done in software.
Arik Nemtsov077a9152011-10-23 08:21:41 +0200931 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
932 * for a CCMP key if space should be prepared for the IV, but the IV
933 * itself should not be generated. Do not set together with
934 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400935 */
936enum ieee80211_key_flags {
937 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
938 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
939 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200940 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200941 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
Arik Nemtsov077a9152011-10-23 08:21:41 +0200942 IEEE80211_KEY_FLAG_PUT_IV_SPACE = 1<<5,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400943};
944
945/**
946 * struct ieee80211_key_conf - key information
947 *
948 * This key information is given by mac80211 to the driver by
949 * the set_key() callback in &struct ieee80211_ops.
950 *
951 * @hw_key_idx: To be set by the driver, this is the key index the driver
952 * wants to be given when a frame is transmitted and needs to be
Johannes Berg6a7664d2007-09-14 11:10:25 -0400953 * encrypted in hardware.
Johannes Berg97359d12010-08-10 09:46:38 +0200954 * @cipher: The key's cipher suite selector.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400955 * @flags: key flags, see &enum ieee80211_key_flags.
956 * @keyidx: the key index (0-3)
957 * @keylen: key material length
Luis R. Rodriguezffd78912008-06-21 10:02:46 -0400958 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
959 * data block:
960 * - Temporal Encryption Key (128 bits)
961 * - Temporal Authenticator Tx MIC Key (64 bits)
962 * - Temporal Authenticator Rx MIC Key (64 bits)
Johannes Bergdc822b52008-12-29 12:55:09 +0100963 * @icv_len: The ICV length for this key type
964 * @iv_len: The IV length for this key type
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400965 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700966struct ieee80211_key_conf {
Johannes Berg97359d12010-08-10 09:46:38 +0200967 u32 cipher;
Felix Fietkau76708de2008-10-05 18:02:48 +0200968 u8 icv_len;
969 u8 iv_len;
Johannes Berg6a7664d2007-09-14 11:10:25 -0400970 u8 hw_key_idx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400971 u8 flags;
Johannes Berg11a843b2007-08-28 17:01:55 -0400972 s8 keyidx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400973 u8 keylen;
Jiri Bencf0706e82007-05-05 11:45:53 -0700974 u8 key[0];
975};
976
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400977/**
978 * enum set_key_cmd - key command
979 *
980 * Used with the set_key() callback in &struct ieee80211_ops, this
981 * indicates whether a key is being removed or added.
982 *
983 * @SET_KEY: a key is set
984 * @DISABLE_KEY: a key must be disabled
985 */
Johannes Bergea49c352007-09-18 17:29:21 -0400986enum set_key_cmd {
Johannes Berg11a843b2007-08-28 17:01:55 -0400987 SET_KEY, DISABLE_KEY,
Johannes Bergea49c352007-09-18 17:29:21 -0400988};
Jiri Bencf0706e82007-05-05 11:45:53 -0700989
Tomas Winkler478f8d22007-09-30 13:52:37 +0200990/**
Johannes Bergf09603a2012-01-20 13:55:21 +0100991 * enum ieee80211_sta_state - station state
992 *
993 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
994 * this is a special state for add/remove transitions
995 * @IEEE80211_STA_NONE: station exists without special state
996 * @IEEE80211_STA_AUTH: station is authenticated
997 * @IEEE80211_STA_ASSOC: station is associated
998 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
999 */
1000enum ieee80211_sta_state {
1001 /* NOTE: These need to be ordered correctly! */
1002 IEEE80211_STA_NOTEXIST,
1003 IEEE80211_STA_NONE,
1004 IEEE80211_STA_AUTH,
1005 IEEE80211_STA_ASSOC,
1006 IEEE80211_STA_AUTHORIZED,
1007};
1008
1009/**
Johannes Berg17741cd2008-09-11 00:02:02 +02001010 * struct ieee80211_sta - station table entry
1011 *
1012 * A station table entry represents a station we are possibly
1013 * communicating with. Since stations are RCU-managed in
1014 * mac80211, any ieee80211_sta pointer you get access to must
1015 * either be protected by rcu_read_lock() explicitly or implicitly,
1016 * or you must take good care to not use such a pointer after a
Johannes Berg34e89502010-02-03 13:59:58 +01001017 * call to your sta_remove callback that removed it.
Johannes Berg17741cd2008-09-11 00:02:02 +02001018 *
1019 * @addr: MAC address
1020 * @aid: AID we assigned to the station if we're an AP
Johannes Berg323ce792008-09-11 02:45:11 +02001021 * @supp_rates: Bitmap of supported rates (per band)
Johannes Bergae5eb022008-10-14 16:58:37 +02001022 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
Arik Nemtsov39df6002011-06-27 23:58:45 +03001023 * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
Johannes Berg17741cd2008-09-11 00:02:02 +02001024 * @drv_priv: data area for driver use, will always be aligned to
1025 * sizeof(void *), size is determined in hw information.
Eliad Peller910868d2011-09-11 09:46:55 +03001026 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1027 * if wme is supported.
1028 * @max_sp: max Service Period. Only valid if wme is supported.
Johannes Berg17741cd2008-09-11 00:02:02 +02001029 */
1030struct ieee80211_sta {
Johannes Berg881d9482009-01-21 15:13:48 +01001031 u32 supp_rates[IEEE80211_NUM_BANDS];
Johannes Berg17741cd2008-09-11 00:02:02 +02001032 u8 addr[ETH_ALEN];
1033 u16 aid;
Johannes Bergd9fe60d2008-10-09 12:13:49 +02001034 struct ieee80211_sta_ht_cap ht_cap;
Arik Nemtsov39df6002011-06-27 23:58:45 +03001035 bool wme;
Eliad Peller9533b4a2011-08-23 14:37:47 +03001036 u8 uapsd_queues;
1037 u8 max_sp;
Johannes Berg17741cd2008-09-11 00:02:02 +02001038
1039 /* must be last */
1040 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
1041};
1042
1043/**
Tomas Winkler478f8d22007-09-30 13:52:37 +02001044 * enum sta_notify_cmd - sta notify command
1045 *
1046 * Used with the sta_notify() callback in &struct ieee80211_ops, this
Sujith38a6cc72010-05-19 11:32:30 +05301047 * indicates if an associated station made a power state transition.
Tomas Winkler478f8d22007-09-30 13:52:37 +02001048 *
Christian Lamparter4571d3b2008-11-30 00:48:41 +01001049 * @STA_NOTIFY_SLEEP: a station is now sleeping
1050 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1051 */
Christian Lamparter89fad572008-12-09 16:28:06 +01001052enum sta_notify_cmd {
Christian Lamparter4571d3b2008-11-30 00:48:41 +01001053 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1054};
1055
1056/**
Johannes Berg1bc08262007-09-18 17:29:15 -04001057 * enum ieee80211_hw_flags - hardware flags
1058 *
1059 * These flags are used to indicate hardware capabilities to
1060 * the stack. Generally, flags here should have their meaning
1061 * done in a way that the simplest hardware doesn't need setting
1062 * any particular flags. There are some exceptions to this rule,
1063 * however, so you are advised to review these flags carefully.
1064 *
Johannes Bergaf65cd962009-11-17 18:18:36 +01001065 * @IEEE80211_HW_HAS_RATE_CONTROL:
1066 * The hardware or firmware includes rate control, and cannot be
1067 * controlled by the stack. As such, no rate control algorithm
1068 * should be instantiated, and the TX rate reported to userspace
1069 * will be taken from the TX status instead of the rate control
1070 * algorithm.
1071 * Note that this requires that the driver implement a number of
1072 * callbacks so it has the correct information, it needs to have
1073 * the @set_rts_threshold callback and must look at the BSS config
1074 * @use_cts_prot for G/N protection, @use_short_slot for slot
1075 * timing in 2.4 GHz and @use_short_preamble for preambles for
1076 * CCK frames.
1077 *
Johannes Berg1bc08262007-09-18 17:29:15 -04001078 * @IEEE80211_HW_RX_INCLUDES_FCS:
1079 * Indicates that received frames passed to the stack include
1080 * the FCS at the end.
1081 *
1082 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1083 * Some wireless LAN chipsets buffer broadcast/multicast frames
1084 * for power saving stations in the hardware/firmware and others
1085 * rely on the host system for such buffering. This option is used
1086 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1087 * multicast frames when there are power saving stations so that
Luis R. Rodriguez546c80c92008-08-14 11:43:20 -07001088 * the driver can fetch them with ieee80211_get_buffered_bc().
Johannes Berg1bc08262007-09-18 17:29:15 -04001089 *
Johannes Berg8318d782008-01-24 19:38:38 +01001090 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1091 * Hardware is not capable of short slot operation on the 2.4 GHz band.
1092 *
1093 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1094 * Hardware is not capable of receiving frames with short preamble on
1095 * the 2.4 GHz band.
Bruno Randolf566bfe52008-05-08 19:15:40 +02001096 *
1097 * @IEEE80211_HW_SIGNAL_UNSPEC:
1098 * Hardware can provide signal values but we don't know its units. We
1099 * expect values between 0 and @max_signal.
1100 * If possible please provide dB or dBm instead.
1101 *
Bruno Randolf566bfe52008-05-08 19:15:40 +02001102 * @IEEE80211_HW_SIGNAL_DBM:
1103 * Hardware gives signal values in dBm, decibel difference from
1104 * one milliwatt. This is the preferred method since it is standardized
1105 * between different devices. @max_signal does not need to be set.
1106 *
Tomas Winkler06ff47b2008-06-18 17:53:44 +03001107 * @IEEE80211_HW_SPECTRUM_MGMT:
1108 * Hardware supports spectrum management defined in 802.11h
1109 * Measurement, Channel Switch, Quieting, TPC
Sujith8b30b1f2008-10-24 09:55:27 +05301110 *
1111 * @IEEE80211_HW_AMPDU_AGGREGATION:
1112 * Hardware supports 11n A-MPDU aggregation.
Kalle Valo520eb822008-12-18 23:35:27 +02001113 *
Johannes Berg4be8c382009-01-07 18:28:20 +01001114 * @IEEE80211_HW_SUPPORTS_PS:
1115 * Hardware has power save support (i.e. can go to sleep).
1116 *
1117 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1118 * Hardware requires nullfunc frame handling in stack, implies
1119 * stack support for dynamic PS.
1120 *
1121 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1122 * Hardware has support for dynamic PS.
Jouni Malinen4375d082009-01-08 13:32:11 +02001123 *
1124 * @IEEE80211_HW_MFP_CAPABLE:
1125 * Hardware supports management frame protection (MFP, IEEE 802.11w).
Kalle Valo04de8382009-03-22 21:57:35 +02001126 *
Johannes Berg0f782312009-12-01 13:37:02 +01001127 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1128 * Hardware supports static spatial multiplexing powersave,
1129 * ie. can turn off all but one chain even on HT connections
1130 * that should be using more chains.
1131 *
1132 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1133 * Hardware supports dynamic spatial multiplexing powersave,
1134 * ie. can turn off all but one chain and then wake the rest
1135 * up as required after, for example, rts/cts handshake.
Kalle Valoab133152010-01-12 10:42:31 +02001136 *
1137 * @IEEE80211_HW_SUPPORTS_UAPSD:
1138 * Hardware supports Unscheduled Automatic Power Save Delivery
1139 * (U-APSD) in managed mode. The mode is configured with
1140 * conf_tx() operation.
Vivek Natarajan375177b2010-02-09 14:50:28 +05301141 *
1142 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1143 * Hardware can provide ack status reports of Tx frames to
1144 * the stack.
1145 *
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02001146 * @IEEE80211_HW_CONNECTION_MONITOR:
1147 * The hardware performs its own connection monitoring, including
1148 * periodic keep-alives to the AP and probing the AP on beacon loss.
1149 * When this flag is set, signaling beacon-loss will cause an immediate
1150 * change to disassociated state.
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02001151 *
Johannes Berge5b900d2010-07-29 16:08:55 +02001152 * @IEEE80211_HW_NEED_DTIM_PERIOD:
1153 * This device needs to know the DTIM period for the BSS before
1154 * associating.
Johannes Berge31b8212010-10-05 19:39:30 +02001155 *
1156 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1157 * per-station GTKs as used by IBSS RSN or during fast transition. If
1158 * the device doesn't support per-station GTKs, but can be asked not
1159 * to decrypt group addressed frames, then IBSS RSN support is still
1160 * possible but software crypto will be used. Advertise the wiphy flag
1161 * only in that case.
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02001162 *
1163 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1164 * autonomously manages the PS status of connected stations. When
1165 * this flag is set mac80211 will not trigger PS mode for connected
1166 * stations based on the PM bit of incoming frames.
1167 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1168 * the PS mode of connected stations.
Arik Nemtsovedf6b782011-08-30 09:32:38 +03001169 *
1170 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1171 * setup strictly in HW. mac80211 should not attempt to do this in
1172 * software.
Eliad Peller885bd8e2012-02-02 17:44:55 +02001173 *
1174 * @IEEE80211_HW_SCAN_WHILE_IDLE: The device can do hw scan while
1175 * being idle (i.e. mac80211 doesn't have to go idle-off during the
1176 * the scan).
Johannes Berg1bc08262007-09-18 17:29:15 -04001177 */
1178enum ieee80211_hw_flags {
Johannes Bergaf65cd962009-11-17 18:18:36 +01001179 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
Johannes Berg1bc08262007-09-18 17:29:15 -04001180 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1181 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
Johannes Berg8318d782008-01-24 19:38:38 +01001182 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1183 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
Bruno Randolf566bfe52008-05-08 19:15:40 +02001184 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
Johannes Berg7fee5372009-01-30 11:13:06 +01001185 IEEE80211_HW_SIGNAL_DBM = 1<<6,
Johannes Berge5b900d2010-07-29 16:08:55 +02001186 IEEE80211_HW_NEED_DTIM_PERIOD = 1<<7,
Johannes Berg7fee5372009-01-30 11:13:06 +01001187 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1188 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1189 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1190 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1191 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1192 IEEE80211_HW_MFP_CAPABLE = 1<<13,
Johannes Bergc1288b12012-01-19 09:29:57 +01001193 /* reuse bit 14 */
Johannes Berg0f782312009-12-01 13:37:02 +01001194 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
1195 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
Kalle Valoab133152010-01-12 10:42:31 +02001196 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
Vivek Natarajan375177b2010-02-09 14:50:28 +05301197 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02001198 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
Johannes Bergea086352012-01-19 09:29:58 +01001199 /* reuse bit 20 */
Johannes Berge31b8212010-10-05 19:39:30 +02001200 IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02001201 IEEE80211_HW_AP_LINK_PS = 1<<22,
Arik Nemtsovedf6b782011-08-30 09:32:38 +03001202 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW = 1<<23,
Eliad Peller885bd8e2012-02-02 17:44:55 +02001203 IEEE80211_HW_SCAN_WHILE_IDLE = 1<<24,
Johannes Berg1bc08262007-09-18 17:29:15 -04001204};
1205
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001206/**
1207 * struct ieee80211_hw - hardware information and state
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001208 *
1209 * This structure contains the configuration and hardware
1210 * information for an 802.11 PHY.
1211 *
1212 * @wiphy: This points to the &struct wiphy allocated for this
1213 * 802.11 PHY. You must fill in the @perm_addr and @dev
1214 * members of this structure using SET_IEEE80211_DEV()
Johannes Berg8318d782008-01-24 19:38:38 +01001215 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1216 * bands (with channels, bitrates) are registered here.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001217 *
1218 * @conf: &struct ieee80211_conf, device configuration, don't use.
1219 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001220 * @priv: pointer to private area that was allocated for driver use
1221 * along with this structure.
1222 *
1223 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1224 *
1225 * @extra_tx_headroom: headroom to reserve in each transmit skb
1226 * for use by the driver (e.g. for transmit headers.)
1227 *
1228 * @channel_change_time: time (in microseconds) it takes to change channels.
1229 *
Bruno Randolf566bfe52008-05-08 19:15:40 +02001230 * @max_signal: Maximum value for signal (rssi) in RX information, used
1231 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001232 *
Tomas Winklerea95bba2008-07-18 13:53:00 +08001233 * @max_listen_interval: max listen interval in units of beacon interval
1234 * that HW supports
1235 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001236 * @queues: number of available hardware transmit queues for
Johannes Berge100bb62008-04-30 18:51:21 +02001237 * data packets. WMM/QoS requires at least four, these
1238 * queues need to have configurable access parameters.
1239 *
Johannes Berg830f9032007-10-28 14:51:05 +01001240 * @rate_control_algorithm: rate control algorithm for this hardware.
1241 * If unset (NULL), the default algorithm will be used. Must be
1242 * set before calling ieee80211_register_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001243 *
1244 * @vif_data_size: size (in bytes) of the drv_priv data area
1245 * within &struct ieee80211_vif.
Johannes Berg17741cd2008-09-11 00:02:02 +02001246 * @sta_data_size: size (in bytes) of the drv_priv data area
1247 * within &struct ieee80211_sta.
Felix Fietkau870abdf2008-10-05 18:04:24 +02001248 *
Helmut Schaa78be49e2010-10-02 11:31:55 +02001249 * @max_rates: maximum number of alternate rate retry stages the hw
1250 * can handle.
1251 * @max_report_rates: maximum number of alternate rate retry stages
1252 * the hw can report back.
Johannes Berge6a98542008-10-21 12:40:02 +02001253 * @max_rate_tries: maximum number of tries for each stage
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001254 *
1255 * @napi_weight: weight used for NAPI polling. You must specify an
1256 * appropriate value here if a napi_poll operation is provided
1257 * by your driver.
Randy Dunlap858022a2011-03-18 09:33:02 -07001258 *
Luciano Coelhodf6ba5d2011-01-12 15:26:30 +02001259 * @max_rx_aggregation_subframes: maximum buffer size (number of
1260 * sub-frames) to be used for A-MPDU block ack receiver
1261 * aggregation.
1262 * This is only relevant if the device has restrictions on the
1263 * number of subframes, if it relies on mac80211 to do reordering
1264 * it shouldn't be set.
Johannes Berg5dd36bc2011-01-18 13:52:23 +01001265 *
1266 * @max_tx_aggregation_subframes: maximum number of subframes in an
1267 * aggregate an HT driver will transmit, used by the peer as a
1268 * hint to size its reorder buffer.
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001269 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001270struct ieee80211_hw {
Jiri Bencf0706e82007-05-05 11:45:53 -07001271 struct ieee80211_conf conf;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001272 struct wiphy *wiphy;
Johannes Berg830f9032007-10-28 14:51:05 +01001273 const char *rate_control_algorithm;
Jiri Bencf0706e82007-05-05 11:45:53 -07001274 void *priv;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001275 u32 flags;
Jiri Bencf0706e82007-05-05 11:45:53 -07001276 unsigned int extra_tx_headroom;
Jiri Bencf0706e82007-05-05 11:45:53 -07001277 int channel_change_time;
Johannes Berg32bfd352007-12-19 01:31:26 +01001278 int vif_data_size;
Johannes Berg17741cd2008-09-11 00:02:02 +02001279 int sta_data_size;
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001280 int napi_weight;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001281 u16 queues;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001282 u16 max_listen_interval;
Jiri Bencf0706e82007-05-05 11:45:53 -07001283 s8 max_signal;
Johannes Berge6a98542008-10-21 12:40:02 +02001284 u8 max_rates;
Helmut Schaa78be49e2010-10-02 11:31:55 +02001285 u8 max_report_rates;
Johannes Berge6a98542008-10-21 12:40:02 +02001286 u8 max_rate_tries;
Luciano Coelhodf6ba5d2011-01-12 15:26:30 +02001287 u8 max_rx_aggregation_subframes;
Johannes Berg5dd36bc2011-01-18 13:52:23 +01001288 u8 max_tx_aggregation_subframes;
Jiri Bencf0706e82007-05-05 11:45:53 -07001289};
1290
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001291/**
Luis R. Rodriguez9a953712009-01-22 15:05:53 -08001292 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1293 *
1294 * @wiphy: the &struct wiphy which we want to query
1295 *
1296 * mac80211 drivers can use this to get to their respective
1297 * &struct ieee80211_hw. Drivers wishing to get to their own private
1298 * structure can then access it via hw->priv. Note that mac802111 drivers should
1299 * not use wiphy_priv() to try to get their private driver structure as this
1300 * is already used internally by mac80211.
1301 */
1302struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1303
1304/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001305 * SET_IEEE80211_DEV - set device for 802.11 hardware
1306 *
1307 * @hw: the &struct ieee80211_hw to set the device for
1308 * @dev: the &struct device of this 802.11 device
1309 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001310static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1311{
1312 set_wiphy_dev(hw->wiphy, dev);
1313}
1314
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001315/**
Bob Copelande37d4df2008-10-20 21:20:27 -04001316 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001317 *
1318 * @hw: the &struct ieee80211_hw to set the MAC address for
1319 * @addr: the address to set
1320 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001321static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1322{
1323 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1324}
1325
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001326static inline struct ieee80211_rate *
1327ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001328 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001329{
Larry Fingeraa331df2012-04-06 16:35:53 -05001330 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001331 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001332 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001333}
1334
1335static inline struct ieee80211_rate *
1336ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001337 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001338{
Johannes Berge039fa42008-05-15 12:55:29 +02001339 if (c->control.rts_cts_rate_idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001340 return NULL;
Johannes Berge039fa42008-05-15 12:55:29 +02001341 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001342}
1343
1344static inline struct ieee80211_rate *
1345ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
Felix Fietkau870abdf2008-10-05 18:04:24 +02001346 const struct ieee80211_tx_info *c, int idx)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001347{
Johannes Berge6a98542008-10-21 12:40:02 +02001348 if (c->control.rates[idx + 1].idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001349 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001350 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001351}
1352
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001353/**
Johannes Berg6096de72011-11-04 11:18:10 +01001354 * ieee80211_free_txskb - free TX skb
1355 * @hw: the hardware
1356 * @skb: the skb
1357 *
1358 * Free a transmit skb. Use this funtion when some failure
1359 * to transmit happened and thus status cannot be reported.
1360 */
1361void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
1362
1363/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001364 * DOC: Hardware crypto acceleration
Johannes Berg4150c572007-09-17 01:29:23 -04001365 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001366 * mac80211 is capable of taking advantage of many hardware
1367 * acceleration designs for encryption and decryption operations.
1368 *
1369 * The set_key() callback in the &struct ieee80211_ops for a given
1370 * device is called to enable hardware acceleration of encryption and
Johannes Bergdc822b52008-12-29 12:55:09 +01001371 * decryption. The callback takes a @sta parameter that will be NULL
1372 * for default keys or keys used for transmission only, or point to
1373 * the station information for the peer for individual keys.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001374 * Multiple transmission keys with the same key index may be used when
1375 * VLANs are configured for an access point.
1376 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001377 * When transmitting, the TX control data will use the @hw_key_idx
1378 * selected by the driver by modifying the &struct ieee80211_key_conf
1379 * pointed to by the @key parameter to the set_key() function.
1380 *
1381 * The set_key() call for the %SET_KEY command should return 0 if
1382 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1383 * added; if you return 0 then hw_key_idx must be assigned to the
1384 * hardware key index, you are free to use the full u8 range.
1385 *
1386 * When the cmd is %DISABLE_KEY then it must succeed.
1387 *
1388 * Note that it is permissible to not decrypt a frame even if a key
1389 * for it has been uploaded to hardware, the stack will not make any
1390 * decision based on whether a key has been uploaded or not but rather
1391 * based on the receive flags.
1392 *
1393 * The &struct ieee80211_key_conf structure pointed to by the @key
1394 * parameter is guaranteed to be valid until another call to set_key()
1395 * removes it, but it can only be used as a cookie to differentiate
1396 * keys.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001397 *
1398 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1399 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1400 * handler.
1401 * The update_tkip_key() call updates the driver with the new phase 1 key.
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001402 * This happens every time the iv16 wraps around (every 65536 packets). The
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001403 * set_key() call will happen only once for each key (unless the AP did
1404 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
Bob Copelande37d4df2008-10-20 21:20:27 -04001405 * provided by update_tkip_key only. The trigger that makes mac80211 call this
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001406 * handler is software decryption with wrap around of iv16.
Johannes Berg4150c572007-09-17 01:29:23 -04001407 */
Johannes Berg4150c572007-09-17 01:29:23 -04001408
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001409/**
Johannes Berg4be8c382009-01-07 18:28:20 +01001410 * DOC: Powersave support
1411 *
1412 * mac80211 has support for various powersave implementations.
1413 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001414 * First, it can support hardware that handles all powersaving by itself,
1415 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1416 * flag. In that case, it will be told about the desired powersave mode
1417 * with the %IEEE80211_CONF_PS flag depending on the association status.
1418 * The hardware must take care of sending nullfunc frames when necessary,
1419 * i.e. when entering and leaving powersave mode. The hardware is required
1420 * to look at the AID in beacons and signal to the AP that it woke up when
1421 * it finds traffic directed to it.
Johannes Berg4be8c382009-01-07 18:28:20 +01001422 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001423 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1424 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1425 * with hardware wakeup and sleep states. Driver is responsible for waking
Bob Copeland2738bd62010-08-21 16:39:01 -04001426 * up the hardware before issuing commands to the hardware and putting it
1427 * back to sleep at appropriate times.
Kalle Valoc99445b2010-01-14 13:09:21 +02001428 *
1429 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1430 * buffered multicast/broadcast frames after the beacon. Also it must be
1431 * possible to send frames and receive the acknowledment frame.
Johannes Berg4be8c382009-01-07 18:28:20 +01001432 *
1433 * Other hardware designs cannot send nullfunc frames by themselves and also
1434 * need software support for parsing the TIM bitmap. This is also supported
1435 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1436 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
Johannes Berg955394c2009-04-16 17:04:25 +02001437 * required to pass up beacons. The hardware is still required to handle
1438 * waking up for multicast traffic; if it cannot the driver must handle that
Kalle Valoc99445b2010-01-14 13:09:21 +02001439 * as best as it can, mac80211 is too slow to do that.
Johannes Berg4be8c382009-01-07 18:28:20 +01001440 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001441 * Dynamic powersave is an extension to normal powersave in which the
1442 * hardware stays awake for a user-specified period of time after sending a
1443 * frame so that reply frames need not be buffered and therefore delayed to
1444 * the next wakeup. It's compromise of getting good enough latency when
1445 * there's data traffic and still saving significantly power in idle
1446 * periods.
1447 *
Bob Copeland2738bd62010-08-21 16:39:01 -04001448 * Dynamic powersave is simply supported by mac80211 enabling and disabling
Kalle Valoc99445b2010-01-14 13:09:21 +02001449 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1450 * flag and mac80211 will handle everything automatically. Additionally,
1451 * hardware having support for the dynamic PS feature may set the
1452 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1453 * dynamic PS mode itself. The driver needs to look at the
1454 * @dynamic_ps_timeout hardware configuration value and use it that value
1455 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1456 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1457 * enabled whenever user has enabled powersave.
1458 *
Juuso Oikarinenf90754c2010-06-21 08:59:39 +03001459 * Some hardware need to toggle a single shared antenna between WLAN and
1460 * Bluetooth to facilitate co-existence. These types of hardware set
1461 * limitations on the use of host controlled dynamic powersave whenever there
1462 * is simultaneous WLAN and Bluetooth traffic. For these types of hardware, the
1463 * driver may request temporarily going into full power save, in order to
1464 * enable toggling the antenna between BT and WLAN. If the driver requests
1465 * disabling dynamic powersave, the @dynamic_ps_timeout value will be
1466 * temporarily set to zero until the driver re-enables dynamic powersave.
1467 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001468 * Driver informs U-APSD client support by enabling
1469 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1470 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1471 * Nullfunc frames and stay awake until the service period has ended. To
1472 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1473 * from that AC are transmitted with powersave enabled.
1474 *
1475 * Note: U-APSD client mode is not yet supported with
1476 * %IEEE80211_HW_PS_NULLFUNC_STACK.
Johannes Berg4be8c382009-01-07 18:28:20 +01001477 */
1478
1479/**
Kalle Valo04de8382009-03-22 21:57:35 +02001480 * DOC: Beacon filter support
1481 *
1482 * Some hardware have beacon filter support to reduce host cpu wakeups
Justin P. Mattock42b2aa82011-11-28 20:31:00 -08001483 * which will reduce system power consumption. It usually works so that
Kalle Valo04de8382009-03-22 21:57:35 +02001484 * the firmware creates a checksum of the beacon but omits all constantly
1485 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1486 * beacon is forwarded to the host, otherwise it will be just dropped. That
1487 * way the host will only receive beacons where some relevant information
1488 * (for example ERP protection or WMM settings) have changed.
1489 *
Johannes Bergc1288b12012-01-19 09:29:57 +01001490 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
1491 * interface capability. The driver needs to enable beacon filter support
Johannes Berg955394c2009-04-16 17:04:25 +02001492 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1493 * power save is enabled, the stack will not check for beacon loss and the
1494 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1495 *
1496 * The time (or number of beacons missed) until the firmware notifies the
1497 * driver of a beacon loss event (which in turn causes the driver to call
1498 * ieee80211_beacon_loss()) should be configurable and will be controlled
1499 * by mac80211 and the roaming algorithm in the future.
1500 *
1501 * Since there may be constantly changing information elements that nothing
1502 * in the software stack cares about, we will, in the future, have mac80211
1503 * tell the driver which information elements are interesting in the sense
1504 * that we want to see changes in them. This will include
1505 * - a list of information element IDs
1506 * - a list of OUIs for the vendor information element
1507 *
1508 * Ideally, the hardware would filter out any beacons without changes in the
1509 * requested elements, but if it cannot support that it may, at the expense
1510 * of some efficiency, filter out only a subset. For example, if the device
1511 * doesn't support checking for OUIs it should pass up all changes in all
1512 * vendor information elements.
1513 *
1514 * Note that change, for the sake of simplification, also includes information
1515 * elements appearing or disappearing from the beacon.
1516 *
1517 * Some hardware supports an "ignore list" instead, just make sure nothing
1518 * that was requested is on the ignore list, and include commonly changing
1519 * information element IDs in the ignore list, for example 11 (BSS load) and
1520 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1521 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1522 * it could also include some currently unused IDs.
1523 *
1524 *
1525 * In addition to these capabilities, hardware should support notifying the
1526 * host of changes in the beacon RSSI. This is relevant to implement roaming
1527 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1528 * the received data packets). This can consist in notifying the host when
1529 * the RSSI changes significantly or when it drops below or rises above
1530 * configurable thresholds. In the future these thresholds will also be
1531 * configured by mac80211 (which gets them from userspace) to implement
1532 * them as the roaming algorithm requires.
1533 *
1534 * If the hardware cannot implement this, the driver should ask it to
1535 * periodically pass beacon frames to the host so that software can do the
1536 * signal strength threshold checking.
Kalle Valo04de8382009-03-22 21:57:35 +02001537 */
1538
1539/**
Johannes Berg0f782312009-12-01 13:37:02 +01001540 * DOC: Spatial multiplexing power save
1541 *
1542 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1543 * power in an 802.11n implementation. For details on the mechanism
1544 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1545 * "11.2.3 SM power save".
1546 *
1547 * The mac80211 implementation is capable of sending action frames
1548 * to update the AP about the station's SMPS mode, and will instruct
1549 * the driver to enter the specific mode. It will also announce the
1550 * requested SMPS mode during the association handshake. Hardware
1551 * support for this feature is required, and can be indicated by
1552 * hardware flags.
1553 *
1554 * The default mode will be "automatic", which nl80211/cfg80211
1555 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1556 * turned off otherwise.
1557 *
1558 * To support this feature, the driver must set the appropriate
1559 * hardware support flags, and handle the SMPS flag to the config()
1560 * operation. It will then with this mechanism be instructed to
1561 * enter the requested SMPS mode while associated to an HT AP.
1562 */
1563
1564/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001565 * DOC: Frame filtering
1566 *
1567 * mac80211 requires to see many management frames for proper
1568 * operation, and users may want to see many more frames when
1569 * in monitor mode. However, for best CPU usage and power consumption,
1570 * having as few frames as possible percolate through the stack is
1571 * desirable. Hence, the hardware should filter as much as possible.
1572 *
1573 * To achieve this, mac80211 uses filter flags (see below) to tell
1574 * the driver's configure_filter() function which frames should be
1575 * passed to mac80211 and which should be filtered out.
1576 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02001577 * Before configure_filter() is invoked, the prepare_multicast()
1578 * callback is invoked with the parameters @mc_count and @mc_list
1579 * for the combined multicast address list of all virtual interfaces.
1580 * It's use is optional, and it returns a u64 that is passed to
1581 * configure_filter(). Additionally, configure_filter() has the
1582 * arguments @changed_flags telling which flags were changed and
1583 * @total_flags with the new flag states.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001584 *
1585 * If your device has no multicast address filters your driver will
1586 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1587 * parameter to see whether multicast frames should be accepted
1588 * or dropped.
1589 *
Michael Bueschd0f5afb2008-02-12 20:12:45 +01001590 * All unsupported flags in @total_flags must be cleared.
1591 * Hardware does not support a flag if it is incapable of _passing_
1592 * the frame to the stack. Otherwise the driver must ignore
1593 * the flag, but not clear it.
1594 * You must _only_ clear the flag (announce no support for the
1595 * flag to mac80211) if you are not able to pass the packet type
1596 * to the stack (so the hardware always filters it).
1597 * So for example, you should clear @FIF_CONTROL, if your hardware
1598 * always filters control frames. If your hardware always passes
1599 * control frames to the kernel and is incapable of filtering them,
1600 * you do _not_ clear the @FIF_CONTROL flag.
1601 * This rule applies to all other FIF flags as well.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001602 */
1603
1604/**
Johannes Berg4b801bc2011-09-29 16:04:40 +02001605 * DOC: AP support for powersaving clients
1606 *
1607 * In order to implement AP and P2P GO modes, mac80211 has support for
1608 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
1609 * There currently is no support for sAPSD.
1610 *
1611 * There is one assumption that mac80211 makes, namely that a client
1612 * will not poll with PS-Poll and trigger with uAPSD at the same time.
1613 * Both are supported, and both can be used by the same client, but
1614 * they can't be used concurrently by the same client. This simplifies
1615 * the driver code.
1616 *
1617 * The first thing to keep in mind is that there is a flag for complete
1618 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
1619 * mac80211 expects the driver to handle most of the state machine for
1620 * powersaving clients and will ignore the PM bit in incoming frames.
1621 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
1622 * stations' powersave transitions. In this mode, mac80211 also doesn't
1623 * handle PS-Poll/uAPSD.
1624 *
1625 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
1626 * PM bit in incoming frames for client powersave transitions. When a
1627 * station goes to sleep, we will stop transmitting to it. There is,
1628 * however, a race condition: a station might go to sleep while there is
1629 * data buffered on hardware queues. If the device has support for this
1630 * it will reject frames, and the driver should give the frames back to
1631 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
1632 * cause mac80211 to retry the frame when the station wakes up. The
1633 * driver is also notified of powersave transitions by calling its
1634 * @sta_notify callback.
1635 *
1636 * When the station is asleep, it has three choices: it can wake up,
1637 * it can PS-Poll, or it can possibly start a uAPSD service period.
1638 * Waking up is implemented by simply transmitting all buffered (and
1639 * filtered) frames to the station. This is the easiest case. When
1640 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
1641 * will inform the driver of this with the @allow_buffered_frames
1642 * callback; this callback is optional. mac80211 will then transmit
Johannes Berg02f2f1a2012-02-27 12:18:30 +01001643 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
Johannes Berg4b801bc2011-09-29 16:04:40 +02001644 * on each frame. The last frame in the service period (or the only
1645 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
1646 * indicate that it ends the service period; as this frame must have
1647 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
1648 * When TX status is reported for this frame, the service period is
1649 * marked has having ended and a new one can be started by the peer.
1650 *
Johannes Berg02f2f1a2012-02-27 12:18:30 +01001651 * Additionally, non-bufferable MMPDUs can also be transmitted by
1652 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
1653 *
Johannes Berg4b801bc2011-09-29 16:04:40 +02001654 * Another race condition can happen on some devices like iwlwifi
1655 * when there are frames queued for the station and it wakes up
1656 * or polls; the frames that are already queued could end up being
1657 * transmitted first instead, causing reordering and/or wrong
1658 * processing of the EOSP. The cause is that allowing frames to be
1659 * transmitted to a certain station is out-of-band communication to
1660 * the device. To allow this problem to be solved, the driver can
1661 * call ieee80211_sta_block_awake() if frames are buffered when it
1662 * is notified that the station went to sleep. When all these frames
1663 * have been filtered (see above), it must call the function again
1664 * to indicate that the station is no longer blocked.
1665 *
1666 * If the driver buffers frames in the driver for aggregation in any
1667 * way, it must use the ieee80211_sta_set_buffered() call when it is
1668 * notified of the station going to sleep to inform mac80211 of any
1669 * TIDs that have frames buffered. Note that when a station wakes up
1670 * this information is reset (hence the requirement to call it when
1671 * informed of the station going to sleep). Then, when a service
1672 * period starts for any reason, @release_buffered_frames is called
1673 * with the number of frames to be released and which TIDs they are
1674 * to come from. In this case, the driver is responsible for setting
1675 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
1676 * to help the @more_data paramter is passed to tell the driver if
1677 * there is more data on other TIDs -- the TIDs to release frames
1678 * from are ignored since mac80211 doesn't know how many frames the
1679 * buffers for those TIDs contain.
1680 *
1681 * If the driver also implement GO mode, where absence periods may
1682 * shorten service periods (or abort PS-Poll responses), it must
1683 * filter those response frames except in the case of frames that
1684 * are buffered in the driver -- those must remain buffered to avoid
1685 * reordering. Because it is possible that no frames are released
1686 * in this case, the driver must call ieee80211_sta_eosp_irqsafe()
1687 * to indicate to mac80211 that the service period ended anyway.
1688 *
1689 * Finally, if frames from multiple TIDs are released from mac80211
1690 * but the driver might reorder them, it must clear & set the flags
1691 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
1692 * and also take care of the EOSP and MORE_DATA bits in the frame.
1693 * The driver may also use ieee80211_sta_eosp_irqsafe() in this case.
1694 */
1695
1696/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001697 * enum ieee80211_filter_flags - hardware filter flags
1698 *
1699 * These flags determine what the filter in hardware should be
1700 * programmed to let through and what should not be passed to the
1701 * stack. It is always safe to pass more frames than requested,
1702 * but this has negative impact on power consumption.
1703 *
1704 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1705 * think of the BSS as your network segment and then this corresponds
1706 * to the regular ethernet device promiscuous mode.
1707 *
1708 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1709 * by the user or if the hardware is not capable of filtering by
1710 * multicast address.
1711 *
1712 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1713 * %RX_FLAG_FAILED_FCS_CRC for them)
1714 *
1715 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1716 * the %RX_FLAG_FAILED_PLCP_CRC for them
1717 *
1718 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1719 * to the hardware that it should not filter beacons or probe responses
1720 * by BSSID. Filtering them can greatly reduce the amount of processing
1721 * mac80211 needs to do and the amount of CPU wakeups, so you should
1722 * honour this flag if possible.
1723 *
Igor Perminove3b90ca2009-08-04 16:48:51 +04001724 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
Johannes Berg7be50862010-10-13 12:06:24 +02001725 * is not set then only those addressed to this station.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001726 *
1727 * @FIF_OTHER_BSS: pass frames destined to other BSSes
Igor Perminove3b90ca2009-08-04 16:48:51 +04001728 *
Johannes Berg7be50862010-10-13 12:06:24 +02001729 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1730 * those addressed to this station.
1731 *
1732 * @FIF_PROBE_REQ: pass probe request frames
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001733 */
1734enum ieee80211_filter_flags {
1735 FIF_PROMISC_IN_BSS = 1<<0,
1736 FIF_ALLMULTI = 1<<1,
1737 FIF_FCSFAIL = 1<<2,
1738 FIF_PLCPFAIL = 1<<3,
1739 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1740 FIF_CONTROL = 1<<5,
1741 FIF_OTHER_BSS = 1<<6,
Igor Perminove3b90ca2009-08-04 16:48:51 +04001742 FIF_PSPOLL = 1<<7,
Johannes Berg7be50862010-10-13 12:06:24 +02001743 FIF_PROBE_REQ = 1<<8,
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001744};
1745
1746/**
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001747 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1748 *
1749 * These flags are used with the ampdu_action() callback in
1750 * &struct ieee80211_ops to indicate which action is needed.
Johannes Berg827d42c2009-11-22 12:28:41 +01001751 *
1752 * Note that drivers MUST be able to deal with a TX aggregation
1753 * session being stopped even before they OK'ed starting it by
Johannes Berg5d22c892010-06-10 10:21:40 +02001754 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
Johannes Berg827d42c2009-11-22 12:28:41 +01001755 * might receive the addBA frame and send a delBA right away!
1756 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001757 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1758 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001759 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1760 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
Johannes Bergb1720232009-03-23 17:28:39 +01001761 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001762 */
1763enum ieee80211_ampdu_mlme_action {
1764 IEEE80211_AMPDU_RX_START,
1765 IEEE80211_AMPDU_RX_STOP,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001766 IEEE80211_AMPDU_TX_START,
1767 IEEE80211_AMPDU_TX_STOP,
Johannes Bergb1720232009-03-23 17:28:39 +01001768 IEEE80211_AMPDU_TX_OPERATIONAL,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001769};
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001770
1771/**
Johannes Berg4049e092011-09-29 16:04:32 +02001772 * enum ieee80211_frame_release_type - frame release reason
1773 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
Johannes Berg47086fc2011-09-29 16:04:33 +02001774 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
1775 * frame received on trigger-enabled AC
Johannes Berg4049e092011-09-29 16:04:32 +02001776 */
1777enum ieee80211_frame_release_type {
1778 IEEE80211_FRAME_RELEASE_PSPOLL,
Johannes Berg47086fc2011-09-29 16:04:33 +02001779 IEEE80211_FRAME_RELEASE_UAPSD,
Johannes Berg4049e092011-09-29 16:04:32 +02001780};
1781
1782/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001783 * struct ieee80211_ops - callbacks from mac80211 to the driver
1784 *
1785 * This structure contains various callbacks that the driver may
1786 * handle or, in some cases, must handle, for example to configure
1787 * the hardware to a new channel or to transmit a frame.
1788 *
1789 * @tx: Handler that 802.11 module calls for each transmitted frame.
1790 * skb contains the buffer starting from the IEEE 802.11 header.
1791 * The low-level driver should send the frame out based on
Johannes Bergeefce912008-05-17 00:57:13 +02001792 * configuration in the TX control data. This handler should,
Johannes Berg11127e92011-11-16 16:02:47 +01001793 * preferably, never fail and stop queues appropriately.
1794 * This must be implemented if @tx_frags is not.
1795 * Must be atomic.
1796 *
1797 * @tx_frags: Called to transmit multiple fragments of a single MSDU.
1798 * This handler must consume all fragments, sending out some of
1799 * them only is useless and it can't ask for some of them to be
1800 * queued again. If the frame is not fragmented the queue has a
1801 * single SKB only. To avoid issues with the networking stack
1802 * when TX status is reported the frames should be removed from
1803 * the skb queue.
1804 * If this is used, the tx_info @vif and @sta pointers will be
1805 * invalid -- you must not use them in that case.
1806 * This must be implemented if @tx isn't.
1807 * Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001808 *
1809 * @start: Called before the first netdevice attached to the hardware
1810 * is enabled. This should turn on the hardware and must turn on
1811 * frame reception (for possibly enabled monitor interfaces.)
1812 * Returns negative error codes, these may be seen in userspace,
1813 * or zero.
1814 * When the device is started it should not have a MAC address
1815 * to avoid acknowledging frames before a non-monitor device
1816 * is added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001817 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001818 *
1819 * @stop: Called after last netdevice attached to the hardware
1820 * is disabled. This should turn off the hardware (at least
1821 * it must turn off frame reception.)
1822 * May be called right after add_interface if that rejects
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04001823 * an interface. If you added any work onto the mac80211 workqueue
1824 * you should ensure to cancel it on this callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001825 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001826 *
Johannes Bergeecc4802011-05-04 15:37:29 +02001827 * @suspend: Suspend the device; mac80211 itself will quiesce before and
1828 * stop transmitting and doing any other configuration, and then
1829 * ask the device to suspend. This is only invoked when WoWLAN is
1830 * configured, otherwise the device is deconfigured completely and
1831 * reconfigured at resume time.
Johannes Berg2b4562d2011-07-02 00:02:01 +02001832 * The driver may also impose special conditions under which it
1833 * wants to use the "normal" suspend (deconfigure), say if it only
1834 * supports WoWLAN when the device is associated. In this case, it
1835 * must return 1 from this function.
Johannes Bergeecc4802011-05-04 15:37:29 +02001836 *
1837 * @resume: If WoWLAN was configured, this indicates that mac80211 is
1838 * now resuming its operation, after this the device must be fully
1839 * functional again. If this returns an error, the only way out is
1840 * to also unregister the device. If it returns 1, then mac80211
1841 * will also go through the regular complete restart on resume.
1842 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001843 * @add_interface: Called when a netdevice attached to the hardware is
Bob Copelande37d4df2008-10-20 21:20:27 -04001844 * enabled. Because it is not called for monitor mode devices, @start
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001845 * and @stop must be implemented.
1846 * The driver should perform any initialization it needs before
1847 * the device can be enabled. The initial configuration for the
1848 * interface is given in the conf parameter.
1849 * The callback may refuse to add an interface by returning a
1850 * negative error code (which will be seen in userspace.)
Kalle Valoe1781ed2009-12-23 13:15:47 +01001851 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001852 *
Johannes Berg34d4bc42010-08-27 12:35:58 +02001853 * @change_interface: Called when a netdevice changes type. This callback
1854 * is optional, but only if it is supported can interface types be
1855 * switched while the interface is UP. The callback may sleep.
1856 * Note that while an interface is being switched, it will not be
1857 * found by the interface iteration callbacks.
1858 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001859 * @remove_interface: Notifies a driver that an interface is going down.
1860 * The @stop callback is called after this if it is the last interface
1861 * and no monitor interfaces are present.
1862 * When all interfaces are removed, the MAC address in the hardware
1863 * must be cleared so the device no longer acknowledges packets,
1864 * the mac_addr member of the conf structure is, however, set to the
1865 * MAC address of the device going away.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001866 * Hence, this callback must be implemented. It can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001867 *
1868 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1869 * function to change hardware configuration, e.g., channel.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001870 * This function should never fail but returns a negative error code
Kalle Valoe1781ed2009-12-23 13:15:47 +01001871 * if it does. The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001872 *
Johannes Berg471b3ef2007-12-28 14:32:58 +01001873 * @bss_info_changed: Handler for configuration requests related to BSS
1874 * parameters that may vary during BSS's lifespan, and may affect low
1875 * level driver (e.g. assoc/disassoc status, erp parameters).
1876 * This function should not be used if no BSS has been set, unless
1877 * for association indication. The @changed parameter indicates which
Kalle Valoe1781ed2009-12-23 13:15:47 +01001878 * of the bss parameters has changed when a call is made. The callback
1879 * can sleep.
Johannes Berg471b3ef2007-12-28 14:32:58 +01001880 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02001881 * @prepare_multicast: Prepare for multicast filter configuration.
1882 * This callback is optional, and its return value is passed
1883 * to configure_filter(). This callback must be atomic.
1884 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001885 * @configure_filter: Configure the device's RX filter.
1886 * See the section "Frame filtering" for more information.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001887 * This callback must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001888 *
Luis R. Rodriguez546c80c92008-08-14 11:43:20 -07001889 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
Johannes Berg17741cd2008-09-11 00:02:02 +02001890 * must be set or cleared for a given STA. Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001891 *
1892 * @set_key: See the section "Hardware crypto acceleration"
Kalle Valoe1781ed2009-12-23 13:15:47 +01001893 * This callback is only called between add_interface and
1894 * remove_interface calls, i.e. while the given virtual interface
Johannes Bergdc822b52008-12-29 12:55:09 +01001895 * is enabled.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001896 * Returns a negative error code if the key can't be added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001897 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001898 *
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001899 * @update_tkip_key: See the section "Hardware crypto acceleration"
1900 * This callback will be called in the context of Rx. Called for drivers
1901 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
Kalle Valoeb807fb2010-01-24 14:55:12 +02001902 * The callback must be atomic.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001903 *
Johannes Bergc68f4b82011-07-05 16:35:41 +02001904 * @set_rekey_data: If the device supports GTK rekeying, for example while the
1905 * host is suspended, it can assign this callback to retrieve the data
1906 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
1907 * After rekeying was done it should (for example during resume) notify
1908 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
1909 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001910 * @hw_scan: Ask the hardware to service the scan request, no need to start
Johannes Berg8318d782008-01-24 19:38:38 +01001911 * the scan state machine in stack. The scan must honour the channel
Kalle Valo9050bdd2009-03-22 21:57:21 +02001912 * configuration done by the regulatory agent in the wiphy's
1913 * registered bands. The hardware (or the driver) needs to make sure
Johannes Bergde95a542009-04-01 11:58:36 +02001914 * that power save is disabled.
1915 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1916 * entire IEs after the SSID, so that drivers need not look at these
1917 * at all but just send them after the SSID -- mac80211 includes the
1918 * (extended) supported rates and HT information (where applicable).
1919 * When the scan finishes, ieee80211_scan_completed() must be called;
1920 * note that it also must be called when the scan cannot finish due to
1921 * any error unless this callback returned a negative error code.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001922 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001923 *
Eliad Pellerb8564392011-06-13 12:47:30 +03001924 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
1925 * The driver should ask the hardware to cancel the scan (if possible),
1926 * but the scan will be completed only after the driver will call
1927 * ieee80211_scan_completed().
1928 * This callback is needed for wowlan, to prevent enqueueing a new
1929 * scan_work after the low-level driver was already suspended.
1930 * The callback can sleep.
1931 *
Luciano Coelho79f460c2011-05-11 17:09:36 +03001932 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
1933 * specific intervals. The driver must call the
1934 * ieee80211_sched_scan_results() function whenever it finds results.
1935 * This process will continue until sched_scan_stop is called.
1936 *
1937 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
1938 *
Michael Buesch80e775b2009-02-20 15:37:03 +01001939 * @sw_scan_start: Notifier function that is called just before a software scan
1940 * is started. Can be NULL, if the driver doesn't need this notification.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001941 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01001942 *
Kalle Valoe1781ed2009-12-23 13:15:47 +01001943 * @sw_scan_complete: Notifier function that is called just after a
1944 * software scan finished. Can be NULL, if the driver doesn't need
1945 * this notification.
1946 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01001947 *
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001948 * @get_stats: Return low-level statistics.
1949 * Returns zero if statistics are available.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001950 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001951 *
Johannes Berg62da92f2007-12-19 02:03:31 +01001952 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1953 * callback should be provided to read the TKIP transmit IVs (both IV32
1954 * and IV16) for the given key from hardware.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001955 * The callback must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001956 *
Arik Nemtsovf23a4782010-11-08 11:51:06 +02001957 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
1958 * if the device does fragmentation by itself; if this callback is
1959 * implemented then the stack will not do fragmentation.
1960 * The callback can sleep.
1961 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001962 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
Kalle Valoe1781ed2009-12-23 13:15:47 +01001963 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001964 *
Johannes Berg34e89502010-02-03 13:59:58 +01001965 * @sta_add: Notifies low level driver about addition of an associated station,
1966 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1967 *
1968 * @sta_remove: Notifies low level driver about removal of an associated
1969 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1970 *
1971 * @sta_notify: Notifies low level driver about power state transition of an
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02001972 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
1973 * in AP mode, this callback will not be called when the flag
1974 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
Christian Lamparter4571d3b2008-11-30 00:48:41 +01001975 *
Johannes Bergf09603a2012-01-20 13:55:21 +01001976 * @sta_state: Notifies low level driver about state transition of a
1977 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
1978 * This callback is mutually exclusive with @sta_add/@sta_remove.
1979 * It must not fail for down transitions but may fail for transitions
1980 * up the list of states.
1981 * The callback can sleep.
1982 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001983 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
Johannes Bergfe3fa822008-09-08 11:05:09 +02001984 * bursting) for a hardware TX queue.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001985 * Returns a negative error code on failure.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001986 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001987 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001988 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001989 * this is only used for IBSS mode BSSID merging and debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001990 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001991 * The callback can sleep.
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001992 *
1993 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1994 * Currently, this is only used for IBSS mode debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001995 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001996 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001997 *
1998 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1999 * with other STAs in the IBSS. This is only used in IBSS mode. This
2000 * function is optional if the firmware/hardware takes full care of
2001 * TSF synchronization.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002002 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002003 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002004 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
2005 * This is needed only for IBSS mode and the result of this function is
2006 * used to determine whether to reply to Probe Requests.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05002007 * Returns non-zero if this device sent the last beacon.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002008 * The callback can sleep.
Ron Rindjunskyd3c990f2007-11-26 16:14:34 +02002009 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02002010 * @ampdu_action: Perform a certain A-MPDU action
2011 * The RA/TID combination determines the destination and TID we want
2012 * the ampdu action to be performed for. The action is defined through
2013 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
Bob Copeland6dd1bf32009-01-08 21:00:34 -05002014 * is the first frame we expect to perform the action on. Notice
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002015 * that TX/RX_STOP can pass NULL for this parameter.
Johannes Berg0b01f032011-01-18 13:51:05 +01002016 * The @buf_size parameter is only valid when the action is set to
2017 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
Johannes Berg5312c3f2011-04-01 13:52:34 +02002018 * buffer size (number of subframes) for this session -- the driver
2019 * may neither send aggregates containing more subframes than this
2020 * nor send aggregates in a way that lost frames would exceed the
2021 * buffer size. If just limiting the aggregate size, this would be
2022 * possible with a buf_size of 8:
2023 * - TX: 1.....7
2024 * - RX: 2....7 (lost frame #1)
2025 * - TX: 8..1...
2026 * which is invalid since #1 was now re-transmitted well past the
2027 * buffer size of 8. Correct ways to retransmit #1 would be:
2028 * - TX: 1 or 18 or 81
2029 * Even "189" would be wrong since 1 could be lost again.
2030 *
Bob Copeland6dd1bf32009-01-08 21:00:34 -05002031 * Returns a negative error code on failure.
Johannes Berg85ad1812010-06-10 10:21:49 +02002032 * The callback can sleep.
Johannes Berg1f87f7d2009-06-02 13:01:41 +02002033 *
Randy Dunlap4e8998f2010-05-21 11:28:33 -07002034 * @get_survey: Return per-channel survey information
2035 *
Johannes Berg1f87f7d2009-06-02 13:01:41 +02002036 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
2037 * need to set wiphy->rfkill_poll to %true before registration,
2038 * and need to call wiphy_rfkill_set_hw_state() in the callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002039 * The callback can sleep.
Johannes Bergaff89a92009-07-01 21:26:51 +02002040 *
Lukáš Turek310bc672009-12-21 22:50:48 +01002041 * @set_coverage_class: Set slot time for given coverage class as specified
2042 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
2043 * accordingly. This callback is not required and may sleep.
2044 *
Johannes Bergaff89a92009-07-01 21:26:51 +02002045 * @testmode_cmd: Implement a cfg80211 test mode command.
Kalle Valoe1781ed2009-12-23 13:15:47 +01002046 * The callback can sleep.
Wey-Yi Guy71063f02011-05-20 09:05:54 -07002047 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
Johannes Berga80f7c02009-12-23 13:15:32 +01002048 *
2049 * @flush: Flush all pending frames from the hardware queue, making sure
2050 * that the hardware queues are empty. If the parameter @drop is set
Kalle Valoe1781ed2009-12-23 13:15:47 +01002051 * to %true, pending frames may be dropped. The callback can sleep.
Johannes Berg5ce6e432010-05-11 16:20:57 +02002052 *
2053 * @channel_switch: Drivers that need (or want) to offload the channel
2054 * switch operation for CSAs received from the AP may implement this
2055 * callback. They must then call ieee80211_chswitch_done() to indicate
2056 * completion of the channel switch.
John W. Linville4e6cbfd2010-07-29 16:14:13 -04002057 *
2058 * @napi_poll: Poll Rx queue for incoming data frames.
Bruno Randolf79b1c462010-11-24 14:34:41 +09002059 *
2060 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2061 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2062 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2063 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2064 *
2065 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
Johannes Berg4976b4e2011-01-04 13:02:32 +01002066 *
2067 * @remain_on_channel: Starts an off-channel period on the given channel, must
2068 * call back to ieee80211_ready_on_channel() when on that channel. Note
2069 * that normal channel traffic is not stopped as this is intended for hw
2070 * offload. Frames to transmit on the off-channel channel are transmitted
2071 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
2072 * duration (which will always be non-zero) expires, the driver must call
2073 * ieee80211_remain_on_channel_expired(). This callback may sleep.
2074 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
2075 * aborted before it expires. This callback may sleep.
John W. Linville38c09152011-03-07 16:19:18 -05002076 *
2077 * @set_ringparam: Set tx and rx ring sizes.
2078 *
2079 * @get_ringparam: Get tx and rx ring current and maximum sizes.
Vivek Natarajane8306f92011-04-06 11:41:10 +05302080 *
2081 * @tx_frames_pending: Check if there is any pending frame in the hardware
2082 * queues before entering power save.
Sujith Manoharanbdbfd6b2011-04-27 16:56:51 +05302083 *
2084 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
2085 * when transmitting a frame. Currently only legacy rates are handled.
2086 * The callback can sleep.
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -07002087 * @rssi_callback: Notify driver when the average RSSI goes above/below
2088 * thresholds that were registered previously. The callback can sleep.
Johannes Berg4049e092011-09-29 16:04:32 +02002089 *
2090 * @release_buffered_frames: Release buffered frames according to the given
2091 * parameters. In the case where the driver buffers some frames for
2092 * sleeping stations mac80211 will use this callback to tell the driver
2093 * to release some frames, either for PS-poll or uAPSD.
2094 * Note that if the @more_data paramter is %false the driver must check
2095 * if there are more frames on the given TIDs, and if there are more than
2096 * the frames being released then it must still set the more-data bit in
2097 * the frame. If the @more_data parameter is %true, then of course the
2098 * more-data bit must always be set.
2099 * The @tids parameter tells the driver which TIDs to release frames
2100 * from, for PS-poll it will always have only a single bit set.
Johannes Bergdeeaee192011-09-29 16:04:35 +02002101 * In the case this is used for a PS-poll initiated release, the
2102 * @num_frames parameter will always be 1 so code can be shared. In
2103 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
2104 * on the TX status (and must report TX status) so that the PS-poll
2105 * period is properly ended. This is used to avoid sending multiple
2106 * responses for a retried PS-poll frame.
Johannes Berg4049e092011-09-29 16:04:32 +02002107 * In the case this is used for uAPSD, the @num_frames parameter may be
2108 * bigger than one, but the driver may send fewer frames (it must send
2109 * at least one, however). In this case it is also responsible for
Johannes Berg47086fc2011-09-29 16:04:33 +02002110 * setting the EOSP flag in the QoS header of the frames. Also, when the
2111 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
Johannes Berg37fbd902011-09-29 16:04:39 +02002112 * on the last frame in the SP. Alternatively, it may call the function
2113 * ieee80211_sta_eosp_irqsafe() to inform mac80211 of the end of the SP.
Johannes Berg4049e092011-09-29 16:04:32 +02002114 * This callback must be atomic.
Johannes Berg40b96402011-09-29 16:04:38 +02002115 * @allow_buffered_frames: Prepare device to allow the given number of frames
2116 * to go out to the given station. The frames will be sent by mac80211
2117 * via the usual TX path after this call. The TX information for frames
Johannes Berg02f2f1a2012-02-27 12:18:30 +01002118 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
Johannes Berg40b96402011-09-29 16:04:38 +02002119 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
2120 * frames from multiple TIDs are released and the driver might reorder
2121 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
2122 * on the last frame and clear it on all others and also handle the EOSP
Johannes Berg37fbd902011-09-29 16:04:39 +02002123 * bit in the QoS header correctly. Alternatively, it can also call the
2124 * ieee80211_sta_eosp_irqsafe() function.
Johannes Berg40b96402011-09-29 16:04:38 +02002125 * The @tids parameter is a bitmap and tells the driver which TIDs the
2126 * frames will be on; it will at most have two bits set.
2127 * This callback must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002128 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002129struct ieee80211_ops {
Johannes Berg7bb45682011-02-24 14:42:06 +01002130 void (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg11127e92011-11-16 16:02:47 +01002131 void (*tx_frags)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2132 struct ieee80211_sta *sta, struct sk_buff_head *skbs);
Johannes Berg4150c572007-09-17 01:29:23 -04002133 int (*start)(struct ieee80211_hw *hw);
Johannes Berg4150c572007-09-17 01:29:23 -04002134 void (*stop)(struct ieee80211_hw *hw);
Johannes Bergeecc4802011-05-04 15:37:29 +02002135#ifdef CONFIG_PM
2136 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
2137 int (*resume)(struct ieee80211_hw *hw);
2138#endif
Jiri Bencf0706e82007-05-05 11:45:53 -07002139 int (*add_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01002140 struct ieee80211_vif *vif);
Johannes Berg34d4bc42010-08-27 12:35:58 +02002141 int (*change_interface)(struct ieee80211_hw *hw,
2142 struct ieee80211_vif *vif,
Johannes Berg2ca27bc2010-09-16 14:58:23 +02002143 enum nl80211_iftype new_type, bool p2p);
Jiri Bencf0706e82007-05-05 11:45:53 -07002144 void (*remove_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01002145 struct ieee80211_vif *vif);
Johannes Berge8975582008-10-09 12:18:51 +02002146 int (*config)(struct ieee80211_hw *hw, u32 changed);
Johannes Berg471b3ef2007-12-28 14:32:58 +01002147 void (*bss_info_changed)(struct ieee80211_hw *hw,
2148 struct ieee80211_vif *vif,
2149 struct ieee80211_bss_conf *info,
2150 u32 changed);
Johannes Bergb2abb6e2011-07-19 10:39:53 +02002151
Johannes Berg3ac64be2009-08-17 16:16:53 +02002152 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
Jiri Pirko22bedad32010-04-01 21:22:57 +00002153 struct netdev_hw_addr_list *mc_list);
Johannes Berg4150c572007-09-17 01:29:23 -04002154 void (*configure_filter)(struct ieee80211_hw *hw,
2155 unsigned int changed_flags,
2156 unsigned int *total_flags,
Johannes Berg3ac64be2009-08-17 16:16:53 +02002157 u64 multicast);
Johannes Berg17741cd2008-09-11 00:02:02 +02002158 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
2159 bool set);
Johannes Bergea49c352007-09-18 17:29:21 -04002160 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
Johannes Bergdc822b52008-12-29 12:55:09 +01002161 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
Johannes Berg11a843b2007-08-28 17:01:55 -04002162 struct ieee80211_key_conf *key);
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02002163 void (*update_tkip_key)(struct ieee80211_hw *hw,
Johannes Bergb3fbdcf2010-01-21 11:40:47 +01002164 struct ieee80211_vif *vif,
2165 struct ieee80211_key_conf *conf,
2166 struct ieee80211_sta *sta,
2167 u32 iv32, u16 *phase1key);
Johannes Bergc68f4b82011-07-05 16:35:41 +02002168 void (*set_rekey_data)(struct ieee80211_hw *hw,
2169 struct ieee80211_vif *vif,
2170 struct cfg80211_gtk_rekey_data *data);
Johannes Berga060bbf2010-04-27 11:59:34 +02002171 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg2a519312009-02-10 21:25:55 +01002172 struct cfg80211_scan_request *req);
Eliad Pellerb8564392011-06-13 12:47:30 +03002173 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
2174 struct ieee80211_vif *vif);
Luciano Coelho79f460c2011-05-11 17:09:36 +03002175 int (*sched_scan_start)(struct ieee80211_hw *hw,
2176 struct ieee80211_vif *vif,
2177 struct cfg80211_sched_scan_request *req,
2178 struct ieee80211_sched_scan_ies *ies);
2179 void (*sched_scan_stop)(struct ieee80211_hw *hw,
2180 struct ieee80211_vif *vif);
Michael Buesch80e775b2009-02-20 15:37:03 +01002181 void (*sw_scan_start)(struct ieee80211_hw *hw);
2182 void (*sw_scan_complete)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07002183 int (*get_stats)(struct ieee80211_hw *hw,
2184 struct ieee80211_low_level_stats *stats);
Johannes Berg62da92f2007-12-19 02:03:31 +01002185 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
2186 u32 *iv32, u16 *iv16);
Arik Nemtsovf23a4782010-11-08 11:51:06 +02002187 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
Jiri Bencf0706e82007-05-05 11:45:53 -07002188 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
Johannes Berg34e89502010-02-03 13:59:58 +01002189 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2190 struct ieee80211_sta *sta);
2191 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2192 struct ieee80211_sta *sta);
Johannes Berg32bfd352007-12-19 01:31:26 +01002193 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02002194 enum sta_notify_cmd, struct ieee80211_sta *sta);
Johannes Bergf09603a2012-01-20 13:55:21 +01002195 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2196 struct ieee80211_sta *sta,
2197 enum ieee80211_sta_state old_state,
2198 enum ieee80211_sta_state new_state);
Eliad Peller8a3a3c82011-10-02 10:15:52 +02002199 int (*conf_tx)(struct ieee80211_hw *hw,
2200 struct ieee80211_vif *vif, u16 queue,
Jiri Bencf0706e82007-05-05 11:45:53 -07002201 const struct ieee80211_tx_queue_params *params);
Eliad Peller37a41b42011-09-21 14:06:11 +03002202 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2203 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2204 u64 tsf);
2205 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07002206 int (*tx_last_beacon)(struct ieee80211_hw *hw);
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02002207 int (*ampdu_action)(struct ieee80211_hw *hw,
Johannes Bergc951ad32009-11-16 12:00:38 +01002208 struct ieee80211_vif *vif,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02002209 enum ieee80211_ampdu_mlme_action action,
Johannes Berg0b01f032011-01-18 13:51:05 +01002210 struct ieee80211_sta *sta, u16 tid, u16 *ssn,
2211 u8 buf_size);
Holger Schurig12897232010-04-19 10:23:57 +02002212 int (*get_survey)(struct ieee80211_hw *hw, int idx,
2213 struct survey_info *survey);
Johannes Berg1f87f7d2009-06-02 13:01:41 +02002214 void (*rfkill_poll)(struct ieee80211_hw *hw);
Lukáš Turek310bc672009-12-21 22:50:48 +01002215 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
Johannes Bergaff89a92009-07-01 21:26:51 +02002216#ifdef CONFIG_NL80211_TESTMODE
2217 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
Wey-Yi Guy71063f02011-05-20 09:05:54 -07002218 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
2219 struct netlink_callback *cb,
2220 void *data, int len);
Johannes Bergaff89a92009-07-01 21:26:51 +02002221#endif
Johannes Berga80f7c02009-12-23 13:15:32 +01002222 void (*flush)(struct ieee80211_hw *hw, bool drop);
Johannes Berg5ce6e432010-05-11 16:20:57 +02002223 void (*channel_switch)(struct ieee80211_hw *hw,
2224 struct ieee80211_channel_switch *ch_switch);
John W. Linville4e6cbfd2010-07-29 16:14:13 -04002225 int (*napi_poll)(struct ieee80211_hw *hw, int budget);
Bruno Randolf15d96752010-11-10 12:50:56 +09002226 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
2227 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
Johannes Berg21f83582010-12-18 17:20:47 +01002228
2229 int (*remain_on_channel)(struct ieee80211_hw *hw,
2230 struct ieee80211_channel *chan,
2231 enum nl80211_channel_type channel_type,
2232 int duration);
2233 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
John W. Linville38c09152011-03-07 16:19:18 -05002234 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
2235 void (*get_ringparam)(struct ieee80211_hw *hw,
2236 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
Vivek Natarajane8306f92011-04-06 11:41:10 +05302237 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
Sujith Manoharanbdbfd6b2011-04-27 16:56:51 +05302238 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2239 const struct cfg80211_bitrate_mask *mask);
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -07002240 void (*rssi_callback)(struct ieee80211_hw *hw,
2241 enum ieee80211_rssi_event rssi_event);
Johannes Berg4049e092011-09-29 16:04:32 +02002242
Johannes Berg40b96402011-09-29 16:04:38 +02002243 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
2244 struct ieee80211_sta *sta,
2245 u16 tids, int num_frames,
2246 enum ieee80211_frame_release_type reason,
2247 bool more_data);
Johannes Berg4049e092011-09-29 16:04:32 +02002248 void (*release_buffered_frames)(struct ieee80211_hw *hw,
2249 struct ieee80211_sta *sta,
2250 u16 tids, int num_frames,
2251 enum ieee80211_frame_release_type reason,
2252 bool more_data);
Jiri Bencf0706e82007-05-05 11:45:53 -07002253};
2254
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002255/**
2256 * ieee80211_alloc_hw - Allocate a new hardware device
2257 *
2258 * This must be called once for each hardware device. The returned pointer
2259 * must be used to refer to this device when calling other functions.
2260 * mac80211 allocates a private data area for the driver pointed to by
2261 * @priv in &struct ieee80211_hw, the size of this area is given as
2262 * @priv_data_len.
2263 *
2264 * @priv_data_len: length of private data
2265 * @ops: callbacks for this device
Jiri Bencf0706e82007-05-05 11:45:53 -07002266 */
2267struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
2268 const struct ieee80211_ops *ops);
2269
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002270/**
2271 * ieee80211_register_hw - Register hardware device
2272 *
Johannes Bergdbbea672008-02-26 14:34:06 +01002273 * You must call this function before any other functions in
2274 * mac80211. Note that before a hardware can be registered, you
2275 * need to fill the contained wiphy's information.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002276 *
2277 * @hw: the device to register as returned by ieee80211_alloc_hw()
2278 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002279int ieee80211_register_hw(struct ieee80211_hw *hw);
2280
Johannes Berge1e54062010-11-30 08:58:45 +01002281/**
2282 * struct ieee80211_tpt_blink - throughput blink description
2283 * @throughput: throughput in Kbit/sec
2284 * @blink_time: blink time in milliseconds
2285 * (full cycle, ie. one off + one on period)
2286 */
2287struct ieee80211_tpt_blink {
2288 int throughput;
2289 int blink_time;
2290};
2291
Johannes Berg67408c82010-11-30 08:59:23 +01002292/**
2293 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
2294 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
2295 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
2296 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
2297 * interface is connected in some way, including being an AP
2298 */
2299enum ieee80211_tpt_led_trigger_flags {
2300 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
2301 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
2302 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
2303};
2304
Jiri Bencf0706e82007-05-05 11:45:53 -07002305#ifdef CONFIG_MAC80211_LEDS
2306extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
2307extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
Michael Buesch47f0c502007-09-27 15:10:44 +02002308extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
Ivo van Doorncdcb0062008-01-07 19:45:24 +01002309extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
Johannes Berge1e54062010-11-30 08:58:45 +01002310extern char *__ieee80211_create_tpt_led_trigger(
Johannes Berg67408c82010-11-30 08:59:23 +01002311 struct ieee80211_hw *hw, unsigned int flags,
Johannes Berge1e54062010-11-30 08:58:45 +01002312 const struct ieee80211_tpt_blink *blink_table,
2313 unsigned int blink_table_len);
Jiri Bencf0706e82007-05-05 11:45:53 -07002314#endif
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002315/**
2316 * ieee80211_get_tx_led_name - get name of TX LED
2317 *
2318 * mac80211 creates a transmit LED trigger for each wireless hardware
2319 * that can be used to drive LEDs if your driver registers a LED device.
2320 * This function returns the name (or %NULL if not configured for LEDs)
2321 * of the trigger so you can automatically link the LED device.
2322 *
2323 * @hw: the hardware to get the LED trigger name for
2324 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002325static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
2326{
2327#ifdef CONFIG_MAC80211_LEDS
2328 return __ieee80211_get_tx_led_name(hw);
2329#else
2330 return NULL;
2331#endif
2332}
2333
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002334/**
2335 * ieee80211_get_rx_led_name - get name of RX LED
2336 *
2337 * mac80211 creates a receive LED trigger for each wireless hardware
2338 * that can be used to drive LEDs if your driver registers a LED device.
2339 * This function returns the name (or %NULL if not configured for LEDs)
2340 * of the trigger so you can automatically link the LED device.
2341 *
2342 * @hw: the hardware to get the LED trigger name for
2343 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002344static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
2345{
2346#ifdef CONFIG_MAC80211_LEDS
2347 return __ieee80211_get_rx_led_name(hw);
2348#else
2349 return NULL;
2350#endif
2351}
2352
Ivo van Doorncdcb0062008-01-07 19:45:24 +01002353/**
2354 * ieee80211_get_assoc_led_name - get name of association LED
2355 *
2356 * mac80211 creates a association LED trigger for each wireless hardware
2357 * that can be used to drive LEDs if your driver registers a LED device.
2358 * This function returns the name (or %NULL if not configured for LEDs)
2359 * of the trigger so you can automatically link the LED device.
2360 *
2361 * @hw: the hardware to get the LED trigger name for
2362 */
Michael Buesch47f0c502007-09-27 15:10:44 +02002363static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
2364{
2365#ifdef CONFIG_MAC80211_LEDS
2366 return __ieee80211_get_assoc_led_name(hw);
2367#else
2368 return NULL;
2369#endif
2370}
2371
Ivo van Doorncdcb0062008-01-07 19:45:24 +01002372/**
2373 * ieee80211_get_radio_led_name - get name of radio LED
2374 *
2375 * mac80211 creates a radio change LED trigger for each wireless hardware
2376 * that can be used to drive LEDs if your driver registers a LED device.
2377 * This function returns the name (or %NULL if not configured for LEDs)
2378 * of the trigger so you can automatically link the LED device.
2379 *
2380 * @hw: the hardware to get the LED trigger name for
2381 */
2382static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
2383{
2384#ifdef CONFIG_MAC80211_LEDS
2385 return __ieee80211_get_radio_led_name(hw);
2386#else
2387 return NULL;
2388#endif
2389}
Michael Buesch47f0c502007-09-27 15:10:44 +02002390
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002391/**
Johannes Berge1e54062010-11-30 08:58:45 +01002392 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
2393 * @hw: the hardware to create the trigger for
Johannes Berg67408c82010-11-30 08:59:23 +01002394 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
Johannes Berge1e54062010-11-30 08:58:45 +01002395 * @blink_table: the blink table -- needs to be ordered by throughput
2396 * @blink_table_len: size of the blink table
2397 *
2398 * This function returns %NULL (in case of error, or if no LED
2399 * triggers are configured) or the name of the new trigger.
2400 * This function must be called before ieee80211_register_hw().
2401 */
2402static inline char *
Johannes Berg67408c82010-11-30 08:59:23 +01002403ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
Johannes Berge1e54062010-11-30 08:58:45 +01002404 const struct ieee80211_tpt_blink *blink_table,
2405 unsigned int blink_table_len)
2406{
2407#ifdef CONFIG_MAC80211_LEDS
Johannes Berg67408c82010-11-30 08:59:23 +01002408 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
Johannes Berge1e54062010-11-30 08:58:45 +01002409 blink_table_len);
2410#else
2411 return NULL;
2412#endif
2413}
2414
2415/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002416 * ieee80211_unregister_hw - Unregister a hardware device
2417 *
2418 * This function instructs mac80211 to free allocated resources
2419 * and unregister netdevices from the networking subsystem.
2420 *
2421 * @hw: the hardware to unregister
2422 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002423void ieee80211_unregister_hw(struct ieee80211_hw *hw);
2424
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002425/**
2426 * ieee80211_free_hw - free hardware descriptor
2427 *
2428 * This function frees everything that was allocated, including the
2429 * private data for the driver. You must call ieee80211_unregister_hw()
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002430 * before calling this function.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002431 *
2432 * @hw: the hardware to free
2433 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002434void ieee80211_free_hw(struct ieee80211_hw *hw);
2435
Johannes Bergf2753dd2009-04-14 10:09:24 +02002436/**
2437 * ieee80211_restart_hw - restart hardware completely
2438 *
2439 * Call this function when the hardware was restarted for some reason
2440 * (hardware error, ...) and the driver is unable to restore its state
2441 * by itself. mac80211 assumes that at this point the driver/hardware
2442 * is completely uninitialised and stopped, it starts the process by
2443 * calling the ->start() operation. The driver will need to reset all
2444 * internal state that it has prior to calling this function.
2445 *
2446 * @hw: the hardware to restart
2447 */
2448void ieee80211_restart_hw(struct ieee80211_hw *hw);
2449
John W. Linville4e6cbfd2010-07-29 16:14:13 -04002450/** ieee80211_napi_schedule - schedule NAPI poll
2451 *
2452 * Use this function to schedule NAPI polling on a device.
2453 *
2454 * @hw: the hardware to start polling
2455 */
2456void ieee80211_napi_schedule(struct ieee80211_hw *hw);
2457
2458/** ieee80211_napi_complete - complete NAPI polling
2459 *
2460 * Use this function to finish NAPI polling on a device.
2461 *
2462 * @hw: the hardware to stop polling
2463 */
2464void ieee80211_napi_complete(struct ieee80211_hw *hw);
2465
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002466/**
2467 * ieee80211_rx - receive frame
2468 *
2469 * Use this function to hand received frames to mac80211. The receive
Zhu Yie3cf8b32010-03-29 17:35:07 +08002470 * buffer in @skb must start with an IEEE 802.11 header. In case of a
2471 * paged @skb is used, the driver is recommended to put the ieee80211
2472 * header of the frame on the linear part of the @skb to avoid memory
2473 * allocation and/or memcpy by the stack.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002474 *
Johannes Berg2485f712008-02-25 16:27:41 +01002475 * This function may not be called in IRQ context. Calls to this function
Kalle Valoe36e49f2009-10-13 20:33:13 +03002476 * for a single hardware must be synchronized against each other. Calls to
2477 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
2478 * mixed for a single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002479 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03002480 * In process context use instead ieee80211_rx_ni().
Johannes Bergd20ef632009-10-11 15:10:40 +02002481 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002482 * @hw: the hardware this frame came in on
2483 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002484 */
John W. Linville103bf9f2009-08-20 16:34:15 -04002485void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002486
2487/**
2488 * ieee80211_rx_irqsafe - receive frame
2489 *
2490 * Like ieee80211_rx() but can be called in IRQ context
Johannes Berg2485f712008-02-25 16:27:41 +01002491 * (internally defers to a tasklet.)
2492 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03002493 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
2494 * be mixed for a single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002495 *
2496 * @hw: the hardware this frame came in on
2497 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002498 */
Johannes Bergf1d58c22009-06-17 13:13:00 +02002499void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07002500
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002501/**
Kalle Valoe36e49f2009-10-13 20:33:13 +03002502 * ieee80211_rx_ni - receive frame (in process context)
2503 *
2504 * Like ieee80211_rx() but can be called in process context
2505 * (internally disables bottom halves).
2506 *
2507 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
2508 * not be mixed for a single hardware.
2509 *
2510 * @hw: the hardware this frame came in on
2511 * @skb: the buffer to receive, owned by mac80211 after this call
2512 */
2513static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
2514 struct sk_buff *skb)
2515{
2516 local_bh_disable();
2517 ieee80211_rx(hw, skb);
2518 local_bh_enable();
2519}
2520
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02002521/**
2522 * ieee80211_sta_ps_transition - PS transition for connected sta
2523 *
2524 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
2525 * flag set, use this function to inform mac80211 about a connected station
2526 * entering/leaving PS mode.
2527 *
2528 * This function may not be called in IRQ context or with softirqs enabled.
2529 *
2530 * Calls to this function for a single hardware must be synchronized against
2531 * each other.
2532 *
2533 * The function returns -EINVAL when the requested PS mode is already set.
2534 *
2535 * @sta: currently connected sta
2536 * @start: start or stop PS
2537 */
2538int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
2539
2540/**
2541 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
2542 * (in process context)
2543 *
2544 * Like ieee80211_sta_ps_transition() but can be called in process context
2545 * (internally disables bottom halves). Concurrent call restriction still
2546 * applies.
2547 *
2548 * @sta: currently connected sta
2549 * @start: start or stop PS
2550 */
2551static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
2552 bool start)
2553{
2554 int ret;
2555
2556 local_bh_disable();
2557 ret = ieee80211_sta_ps_transition(sta, start);
2558 local_bh_enable();
2559
2560 return ret;
2561}
2562
Gertjan van Wingerded24deb22009-12-04 23:46:54 +01002563/*
2564 * The TX headroom reserved by mac80211 for its own tx_status functions.
2565 * This is enough for the radiotap header.
2566 */
Helmut Schaa7f2a5e22011-10-11 18:08:55 +02002567#define IEEE80211_TX_STATUS_HEADROOM 14
Gertjan van Wingerded24deb22009-12-04 23:46:54 +01002568
Kalle Valoe36e49f2009-10-13 20:33:13 +03002569/**
Johannes Berg042ec452011-09-29 16:04:26 +02002570 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
Randy Dunlapbdfbe802011-05-22 17:22:45 -07002571 * @sta: &struct ieee80211_sta pointer for the sleeping station
Johannes Berg042ec452011-09-29 16:04:26 +02002572 * @tid: the TID that has buffered frames
2573 * @buffered: indicates whether or not frames are buffered for this TID
Felix Fietkaudcf55fb2011-04-17 17:45:00 +02002574 *
2575 * If a driver buffers frames for a powersave station instead of passing
Johannes Berg042ec452011-09-29 16:04:26 +02002576 * them back to mac80211 for retransmission, the station may still need
2577 * to be told that there are buffered frames via the TIM bit.
Felix Fietkaudcf55fb2011-04-17 17:45:00 +02002578 *
Johannes Berg042ec452011-09-29 16:04:26 +02002579 * This function informs mac80211 whether or not there are frames that are
2580 * buffered in the driver for a given TID; mac80211 can then use this data
2581 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
2582 * call! Beware of the locking!)
2583 *
2584 * If all frames are released to the station (due to PS-poll or uAPSD)
2585 * then the driver needs to inform mac80211 that there no longer are
2586 * frames buffered. However, when the station wakes up mac80211 assumes
2587 * that all buffered frames will be transmitted and clears this data,
2588 * drivers need to make sure they inform mac80211 about all buffered
2589 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
2590 *
2591 * Note that technically mac80211 only needs to know this per AC, not per
2592 * TID, but since driver buffering will inevitably happen per TID (since
2593 * it is related to aggregation) it is easier to make mac80211 map the
2594 * TID to the AC as required instead of keeping track in all drivers that
2595 * use this API.
Felix Fietkaudcf55fb2011-04-17 17:45:00 +02002596 */
Johannes Berg042ec452011-09-29 16:04:26 +02002597void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
2598 u8 tid, bool buffered);
Felix Fietkaudcf55fb2011-04-17 17:45:00 +02002599
2600/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002601 * ieee80211_tx_status - transmit status callback
2602 *
2603 * Call this function for all transmitted frames after they have been
2604 * transmitted. It is permissible to not call this function for
2605 * multicast frames but this can affect statistics.
2606 *
Johannes Berg2485f712008-02-25 16:27:41 +01002607 * This function may not be called in IRQ context. Calls to this function
2608 * for a single hardware must be synchronized against each other. Calls
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01002609 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
2610 * may not be mixed for a single hardware.
Johannes Berg2485f712008-02-25 16:27:41 +01002611 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002612 * @hw: the hardware the frame was transmitted by
2613 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002614 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002615void ieee80211_tx_status(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02002616 struct sk_buff *skb);
Johannes Berg2485f712008-02-25 16:27:41 +01002617
2618/**
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01002619 * ieee80211_tx_status_ni - transmit status callback (in process context)
2620 *
2621 * Like ieee80211_tx_status() but can be called in process context.
2622 *
2623 * Calls to this function, ieee80211_tx_status() and
2624 * ieee80211_tx_status_irqsafe() may not be mixed
2625 * for a single hardware.
2626 *
2627 * @hw: the hardware the frame was transmitted by
2628 * @skb: the frame that was transmitted, owned by mac80211 after this call
2629 */
2630static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
2631 struct sk_buff *skb)
2632{
2633 local_bh_disable();
2634 ieee80211_tx_status(hw, skb);
2635 local_bh_enable();
2636}
2637
2638/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002639 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
Johannes Berg2485f712008-02-25 16:27:41 +01002640 *
2641 * Like ieee80211_tx_status() but can be called in IRQ context
2642 * (internally defers to a tasklet.)
2643 *
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01002644 * Calls to this function, ieee80211_tx_status() and
2645 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
Johannes Berg2485f712008-02-25 16:27:41 +01002646 *
2647 * @hw: the hardware the frame was transmitted by
2648 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg2485f712008-02-25 16:27:41 +01002649 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002650void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02002651 struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07002652
2653/**
Arik Nemtsov8178d382011-04-18 14:22:28 +03002654 * ieee80211_report_low_ack - report non-responding station
2655 *
2656 * When operating in AP-mode, call this function to report a non-responding
2657 * connected STA.
2658 *
2659 * @sta: the non-responding connected sta
2660 * @num_packets: number of packets sent to @sta without a response
2661 */
2662void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
2663
2664/**
Johannes Bergeddcbb942009-10-29 08:30:35 +01002665 * ieee80211_beacon_get_tim - beacon generation function
2666 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002667 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Bergeddcbb942009-10-29 08:30:35 +01002668 * @tim_offset: pointer to variable that will receive the TIM IE offset.
2669 * Set to 0 if invalid (in non-AP modes).
2670 * @tim_length: pointer to variable that will receive the TIM IE length,
2671 * (including the ID and length bytes!).
2672 * Set to 0 if invalid (in non-AP modes).
2673 *
2674 * If the driver implements beaconing modes, it must use this function to
2675 * obtain the beacon frame/template.
2676 *
2677 * If the beacon frames are generated by the host system (i.e., not in
2678 * hardware/firmware), the driver uses this function to get each beacon
2679 * frame from mac80211 -- it is responsible for calling this function
2680 * before the beacon is needed (e.g. based on hardware interrupt).
2681 *
2682 * If the beacon frames are generated by the device, then the driver
2683 * must use the returned beacon as the template and change the TIM IE
2684 * according to the current DTIM parameters/TIM bitmap.
2685 *
2686 * The driver is responsible for freeing the returned skb.
2687 */
2688struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
2689 struct ieee80211_vif *vif,
2690 u16 *tim_offset, u16 *tim_length);
2691
2692/**
Jiri Bencf0706e82007-05-05 11:45:53 -07002693 * ieee80211_beacon_get - beacon generation function
2694 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002695 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002696 *
Johannes Bergeddcbb942009-10-29 08:30:35 +01002697 * See ieee80211_beacon_get_tim().
Jiri Bencf0706e82007-05-05 11:45:53 -07002698 */
Johannes Bergeddcbb942009-10-29 08:30:35 +01002699static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
2700 struct ieee80211_vif *vif)
2701{
2702 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
2703}
Jiri Bencf0706e82007-05-05 11:45:53 -07002704
2705/**
Arik Nemtsov02945822011-11-10 11:28:57 +02002706 * ieee80211_proberesp_get - retrieve a Probe Response template
2707 * @hw: pointer obtained from ieee80211_alloc_hw().
2708 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2709 *
2710 * Creates a Probe Response template which can, for example, be uploaded to
2711 * hardware. The destination address should be set by the caller.
2712 *
2713 * Can only be called in AP mode.
2714 */
2715struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
2716 struct ieee80211_vif *vif);
2717
2718/**
Kalle Valo7044cc52010-01-05 20:16:19 +02002719 * ieee80211_pspoll_get - retrieve a PS Poll template
2720 * @hw: pointer obtained from ieee80211_alloc_hw().
2721 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2722 *
2723 * Creates a PS Poll a template which can, for example, uploaded to
2724 * hardware. The template must be updated after association so that correct
2725 * AID, BSSID and MAC address is used.
2726 *
2727 * Note: Caller (or hardware) is responsible for setting the
2728 * &IEEE80211_FCTL_PM bit.
2729 */
2730struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
2731 struct ieee80211_vif *vif);
2732
2733/**
2734 * ieee80211_nullfunc_get - retrieve a nullfunc template
2735 * @hw: pointer obtained from ieee80211_alloc_hw().
2736 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2737 *
2738 * Creates a Nullfunc template which can, for example, uploaded to
2739 * hardware. The template must be updated after association so that correct
2740 * BSSID and address is used.
2741 *
2742 * Note: Caller (or hardware) is responsible for setting the
2743 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
2744 */
2745struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
2746 struct ieee80211_vif *vif);
2747
2748/**
Kalle Valo05e54ea2010-01-05 20:16:38 +02002749 * ieee80211_probereq_get - retrieve a Probe Request template
2750 * @hw: pointer obtained from ieee80211_alloc_hw().
2751 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2752 * @ssid: SSID buffer
2753 * @ssid_len: length of SSID
2754 * @ie: buffer containing all IEs except SSID for the template
2755 * @ie_len: length of the IE buffer
2756 *
2757 * Creates a Probe Request template which can, for example, be uploaded to
2758 * hardware.
2759 */
2760struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
2761 struct ieee80211_vif *vif,
2762 const u8 *ssid, size_t ssid_len,
2763 const u8 *ie, size_t ie_len);
2764
2765/**
Jiri Bencf0706e82007-05-05 11:45:53 -07002766 * ieee80211_rts_get - RTS frame generation function
2767 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002768 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002769 * @frame: pointer to the frame that is going to be protected by the RTS.
2770 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02002771 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07002772 * @rts: The buffer where to store the RTS frame.
2773 *
2774 * If the RTS frames are generated by the host system (i.e., not in
2775 * hardware/firmware), the low-level driver uses this function to receive
2776 * the next RTS frame from the 802.11 code. The low-level is responsible
2777 * for calling this function before and RTS frame is needed.
2778 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002779void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07002780 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002781 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07002782 struct ieee80211_rts *rts);
2783
2784/**
2785 * ieee80211_rts_duration - Get the duration field for an RTS frame
2786 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002787 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002788 * @frame_len: the length of the frame that is going to be protected by the RTS.
Johannes Berge039fa42008-05-15 12:55:29 +02002789 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07002790 *
2791 * If the RTS is generated in firmware, but the host system must provide
2792 * the duration field, the low-level driver uses this function to receive
2793 * the duration field value in little-endian byteorder.
2794 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002795__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
2796 struct ieee80211_vif *vif, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002797 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07002798
2799/**
2800 * ieee80211_ctstoself_get - CTS-to-self frame generation function
2801 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002802 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002803 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
2804 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02002805 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07002806 * @cts: The buffer where to store the CTS-to-self frame.
2807 *
2808 * If the CTS-to-self frames are generated by the host system (i.e., not in
2809 * hardware/firmware), the low-level driver uses this function to receive
2810 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
2811 * for calling this function before and CTS-to-self frame is needed.
2812 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002813void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
2814 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07002815 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002816 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07002817 struct ieee80211_cts *cts);
2818
2819/**
2820 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
2821 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002822 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002823 * @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 +02002824 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07002825 *
2826 * If the CTS-to-self is generated in firmware, but the host system must provide
2827 * the duration field, the low-level driver uses this function to receive
2828 * the duration field value in little-endian byteorder.
2829 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002830__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
2831 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07002832 size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002833 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07002834
2835/**
2836 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
2837 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002838 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002839 * @frame_len: the length of the frame.
Johannes Berg8318d782008-01-24 19:38:38 +01002840 * @rate: the rate at which the frame is going to be transmitted.
Jiri Bencf0706e82007-05-05 11:45:53 -07002841 *
2842 * Calculate the duration field of some generic frame, given its
2843 * length and transmission rate (in 100kbps).
2844 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002845__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
2846 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07002847 size_t frame_len,
Johannes Berg8318d782008-01-24 19:38:38 +01002848 struct ieee80211_rate *rate);
Jiri Bencf0706e82007-05-05 11:45:53 -07002849
2850/**
2851 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
2852 * @hw: pointer as obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002853 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002854 *
2855 * Function for accessing buffered broadcast and multicast frames. If
2856 * hardware/firmware does not implement buffering of broadcast/multicast
2857 * frames when power saving is used, 802.11 code buffers them in the host
2858 * memory. The low-level driver uses this function to fetch next buffered
2859 * frame. In most cases, this is used when generating beacon frame. This
2860 * function returns a pointer to the next buffered skb or NULL if no more
2861 * buffered frames are available.
2862 *
2863 * Note: buffered frames are returned only after DTIM beacon frame was
2864 * generated with ieee80211_beacon_get() and the low-level driver must thus
2865 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
2866 * NULL if the previous generated beacon was not DTIM, so the low-level driver
2867 * does not need to check for DTIM beacons separately and should be able to
2868 * use common code for all beacons.
2869 */
2870struct sk_buff *
Johannes Berge039fa42008-05-15 12:55:29 +02002871ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07002872
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002873/**
Johannes Berg42d987952011-07-07 18:58:01 +02002874 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
2875 *
2876 * This function returns the TKIP phase 1 key for the given IV32.
2877 *
2878 * @keyconf: the parameter passed with the set key
2879 * @iv32: IV32 to get the P1K for
2880 * @p1k: a buffer to which the key will be written, as 5 u16 values
2881 */
2882void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
2883 u32 iv32, u16 *p1k);
2884
2885/**
Johannes Berg523b02e2011-07-07 22:28:01 +02002886 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02002887 *
Johannes Berg523b02e2011-07-07 22:28:01 +02002888 * This function returns the TKIP phase 1 key for the IV32 taken
2889 * from the given packet.
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02002890 *
2891 * @keyconf: the parameter passed with the set key
Johannes Berg523b02e2011-07-07 22:28:01 +02002892 * @skb: the packet to take the IV32 value from that will be encrypted
2893 * with this P1K
2894 * @p1k: a buffer to which the key will be written, as 5 u16 values
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02002895 */
Johannes Berg42d987952011-07-07 18:58:01 +02002896static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
2897 struct sk_buff *skb, u16 *p1k)
2898{
2899 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
2900 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
2901 u32 iv32 = get_unaligned_le32(&data[4]);
2902
2903 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
2904}
Johannes Berg523b02e2011-07-07 22:28:01 +02002905
2906/**
Johannes Berg8bca5d82011-07-13 19:50:34 +02002907 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
2908 *
2909 * This function returns the TKIP phase 1 key for the given IV32
2910 * and transmitter address.
2911 *
2912 * @keyconf: the parameter passed with the set key
2913 * @ta: TA that will be used with the key
2914 * @iv32: IV32 to get the P1K for
2915 * @p1k: a buffer to which the key will be written, as 5 u16 values
2916 */
2917void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
2918 const u8 *ta, u32 iv32, u16 *p1k);
2919
2920/**
Johannes Berg523b02e2011-07-07 22:28:01 +02002921 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
2922 *
2923 * This function computes the TKIP RC4 key for the IV values
2924 * in the packet.
2925 *
2926 * @keyconf: the parameter passed with the set key
2927 * @skb: the packet to take the IV32/IV16 values from that will be
2928 * encrypted with this key
2929 * @p2k: a buffer to which the key will be written, 16 bytes
2930 */
2931void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
2932 struct sk_buff *skb, u8 *p2k);
Johannes Bergc68f4b82011-07-05 16:35:41 +02002933
2934/**
Johannes Berg3ea542d2011-07-07 18:58:00 +02002935 * struct ieee80211_key_seq - key sequence counter
2936 *
2937 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
2938 * @ccmp: PN data, most significant byte first (big endian,
2939 * reverse order than in packet)
2940 * @aes_cmac: PN data, most significant byte first (big endian,
2941 * reverse order than in packet)
2942 */
2943struct ieee80211_key_seq {
2944 union {
2945 struct {
2946 u32 iv32;
2947 u16 iv16;
2948 } tkip;
2949 struct {
2950 u8 pn[6];
2951 } ccmp;
2952 struct {
2953 u8 pn[6];
2954 } aes_cmac;
2955 };
2956};
2957
2958/**
2959 * ieee80211_get_key_tx_seq - get key TX sequence counter
2960 *
2961 * @keyconf: the parameter passed with the set key
2962 * @seq: buffer to receive the sequence data
2963 *
2964 * This function allows a driver to retrieve the current TX IV/PN
2965 * for the given key. It must not be called if IV generation is
2966 * offloaded to the device.
2967 *
2968 * Note that this function may only be called when no TX processing
2969 * can be done concurrently, for example when queues are stopped
2970 * and the stop has been synchronized.
2971 */
2972void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
2973 struct ieee80211_key_seq *seq);
2974
2975/**
2976 * ieee80211_get_key_rx_seq - get key RX sequence counter
2977 *
2978 * @keyconf: the parameter passed with the set key
2979 * @tid: The TID, or -1 for the management frame value (CCMP only);
2980 * the value on TID 0 is also used for non-QoS frames. For
2981 * CMAC, only TID 0 is valid.
2982 * @seq: buffer to receive the sequence data
2983 *
2984 * This function allows a driver to retrieve the current RX IV/PNs
2985 * for the given key. It must not be called if IV checking is done
2986 * by the device and not by mac80211.
2987 *
2988 * Note that this function may only be called when no RX processing
2989 * can be done concurrently.
2990 */
2991void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
2992 int tid, struct ieee80211_key_seq *seq);
2993
2994/**
Johannes Bergc68f4b82011-07-05 16:35:41 +02002995 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
2996 * @vif: virtual interface the rekeying was done on
2997 * @bssid: The BSSID of the AP, for checking association
2998 * @replay_ctr: the new replay counter after GTK rekeying
2999 * @gfp: allocation flags
3000 */
3001void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
3002 const u8 *replay_ctr, gfp_t gfp);
3003
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02003004/**
Jiri Bencf0706e82007-05-05 11:45:53 -07003005 * ieee80211_wake_queue - wake specific queue
3006 * @hw: pointer as obtained from ieee80211_alloc_hw().
3007 * @queue: queue number (counted from zero).
3008 *
3009 * Drivers should use this function instead of netif_wake_queue.
3010 */
3011void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
3012
3013/**
3014 * ieee80211_stop_queue - stop specific queue
3015 * @hw: pointer as obtained from ieee80211_alloc_hw().
3016 * @queue: queue number (counted from zero).
3017 *
3018 * Drivers should use this function instead of netif_stop_queue.
3019 */
3020void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
3021
3022/**
Tomas Winkler92ab8532008-07-24 21:02:04 +03003023 * ieee80211_queue_stopped - test status of the queue
3024 * @hw: pointer as obtained from ieee80211_alloc_hw().
3025 * @queue: queue number (counted from zero).
3026 *
3027 * Drivers should use this function instead of netif_stop_queue.
3028 */
3029
3030int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
3031
3032/**
Jiri Bencf0706e82007-05-05 11:45:53 -07003033 * ieee80211_stop_queues - stop all queues
3034 * @hw: pointer as obtained from ieee80211_alloc_hw().
3035 *
3036 * Drivers should use this function instead of netif_stop_queue.
3037 */
3038void ieee80211_stop_queues(struct ieee80211_hw *hw);
3039
3040/**
3041 * ieee80211_wake_queues - wake all queues
3042 * @hw: pointer as obtained from ieee80211_alloc_hw().
3043 *
3044 * Drivers should use this function instead of netif_wake_queue.
3045 */
3046void ieee80211_wake_queues(struct ieee80211_hw *hw);
3047
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003048/**
3049 * ieee80211_scan_completed - completed hardware scan
3050 *
3051 * When hardware scan offload is used (i.e. the hw_scan() callback is
3052 * assigned) this function needs to be called by the driver to notify
Johannes Berg8789d452010-08-26 13:30:26 +02003053 * mac80211 that the scan finished. This function can be called from
3054 * any context, including hardirq context.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003055 *
3056 * @hw: the hardware that finished the scan
Johannes Berg2a519312009-02-10 21:25:55 +01003057 * @aborted: set to true if scan was aborted
Johannes Berg75a5f0c2007-09-18 17:29:20 -04003058 */
Johannes Berg2a519312009-02-10 21:25:55 +01003059void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
Jiri Bencf0706e82007-05-05 11:45:53 -07003060
Johannes Bergdabeb342007-11-09 01:57:29 +01003061/**
Luciano Coelho79f460c2011-05-11 17:09:36 +03003062 * ieee80211_sched_scan_results - got results from scheduled scan
3063 *
3064 * When a scheduled scan is running, this function needs to be called by the
3065 * driver whenever there are new scan results available.
3066 *
3067 * @hw: the hardware that is performing scheduled scans
3068 */
3069void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
3070
3071/**
3072 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
3073 *
3074 * When a scheduled scan is running, this function can be called by
3075 * the driver if it needs to stop the scan to perform another task.
3076 * Usual scenarios are drivers that cannot continue the scheduled scan
3077 * while associating, for instance.
3078 *
3079 * @hw: the hardware that is performing scheduled scans
3080 */
3081void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
3082
3083/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07003084 * ieee80211_iterate_active_interfaces - iterate active interfaces
Johannes Bergdabeb342007-11-09 01:57:29 +01003085 *
3086 * This function iterates over the interfaces associated with a given
3087 * hardware that are currently active and calls the callback for them.
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02003088 * This function allows the iterator function to sleep, when the iterator
3089 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
3090 * be used.
Felix Fietkau2944f452010-09-14 18:37:20 +02003091 * Does not iterate over a new interface during add_interface()
Johannes Bergdabeb342007-11-09 01:57:29 +01003092 *
3093 * @hw: the hardware struct of which the interfaces should be iterated over
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02003094 * @iterator: the iterator function to call
Johannes Bergdabeb342007-11-09 01:57:29 +01003095 * @data: first argument of the iterator function
3096 */
3097void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
3098 void (*iterator)(void *data, u8 *mac,
Johannes Berg32bfd352007-12-19 01:31:26 +01003099 struct ieee80211_vif *vif),
Johannes Bergdabeb342007-11-09 01:57:29 +01003100 void *data);
3101
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003102/**
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02003103 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
3104 *
3105 * This function iterates over the interfaces associated with a given
3106 * hardware that are currently active and calls the callback for them.
3107 * This function requires the iterator callback function to be atomic,
3108 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
Felix Fietkau2944f452010-09-14 18:37:20 +02003109 * Does not iterate over a new interface during add_interface()
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02003110 *
3111 * @hw: the hardware struct of which the interfaces should be iterated over
3112 * @iterator: the iterator function to call, cannot sleep
3113 * @data: first argument of the iterator function
3114 */
3115void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
3116 void (*iterator)(void *data,
3117 u8 *mac,
3118 struct ieee80211_vif *vif),
3119 void *data);
3120
3121/**
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04003122 * ieee80211_queue_work - add work onto the mac80211 workqueue
3123 *
3124 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
3125 * This helper ensures drivers are not queueing work when they should not be.
3126 *
3127 * @hw: the hardware struct for the interface we are adding work for
3128 * @work: the work we want to add onto the mac80211 workqueue
3129 */
3130void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
3131
3132/**
3133 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
3134 *
3135 * Drivers and mac80211 use this to queue delayed work onto the mac80211
3136 * workqueue.
3137 *
3138 * @hw: the hardware struct for the interface we are adding work for
3139 * @dwork: delayable work to queue onto the mac80211 workqueue
3140 * @delay: number of jiffies to wait before queueing
3141 */
3142void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
3143 struct delayed_work *dwork,
3144 unsigned long delay);
3145
3146/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003147 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01003148 * @sta: the station for which to start a BA session
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003149 * @tid: the TID to BA on.
Sujith Manoharanbd2ce6e2010-12-15 07:47:10 +05303150 * @timeout: session timeout value (in TUs)
Randy Dunlapea2d8b52008-10-27 09:47:03 -07003151 *
3152 * Return: success if addBA request was sent, failure otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003153 *
3154 * Although mac80211/low level driver/user space application can estimate
3155 * the need to start aggregation on a certain RA/TID, the session level
3156 * will be managed by the mac80211.
3157 */
Sujith Manoharanbd2ce6e2010-12-15 07:47:10 +05303158int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
3159 u16 timeout);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003160
3161/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003162 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01003163 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003164 * @ra: receiver address of the BA session recipient.
3165 * @tid: the TID to BA on.
3166 *
3167 * This function must be called by low level driver once it has
Johannes Berg5d22c892010-06-10 10:21:40 +02003168 * finished with preparations for the BA session. It can be called
3169 * from any context.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003170 */
Johannes Bergc951ad32009-11-16 12:00:38 +01003171void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003172 u16 tid);
3173
3174/**
3175 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01003176 * @sta: the station whose BA session to stop
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003177 * @tid: the TID to stop BA.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07003178 *
Johannes Berg6a8579d2010-05-27 14:41:07 +02003179 * Return: negative error if the TID is invalid, or no aggregation active
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003180 *
3181 * Although mac80211/low level driver/user space application can estimate
3182 * the need to stop aggregation on a certain RA/TID, the session level
3183 * will be managed by the mac80211.
3184 */
Johannes Berg6a8579d2010-05-27 14:41:07 +02003185int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003186
3187/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003188 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01003189 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003190 * @ra: receiver address of the BA session recipient.
3191 * @tid: the desired TID to BA on.
3192 *
3193 * This function must be called by low level driver once it has
Johannes Berg5d22c892010-06-10 10:21:40 +02003194 * finished with preparations for the BA session tear down. It
3195 * can be called from any context.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003196 */
Johannes Bergc951ad32009-11-16 12:00:38 +01003197void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02003198 u16 tid);
3199
Mohamed Abbas84363e62008-04-04 16:59:58 -07003200/**
Johannes Berg17741cd2008-09-11 00:02:02 +02003201 * ieee80211_find_sta - find a station
3202 *
Johannes Berg5ed176e2009-11-04 14:42:28 +01003203 * @vif: virtual interface to look for station on
Johannes Berg17741cd2008-09-11 00:02:02 +02003204 * @addr: station's address
3205 *
3206 * This function must be called under RCU lock and the
3207 * resulting pointer is only valid under RCU lock as well.
3208 */
Johannes Berg5ed176e2009-11-04 14:42:28 +01003209struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02003210 const u8 *addr);
3211
Kalle Valo04de8382009-03-22 21:57:35 +02003212/**
Ben Greear686b9cb2010-09-23 09:44:36 -07003213 * ieee80211_find_sta_by_ifaddr - find a station on hardware
Johannes Berg5ed176e2009-11-04 14:42:28 +01003214 *
3215 * @hw: pointer as obtained from ieee80211_alloc_hw()
Ben Greear686b9cb2010-09-23 09:44:36 -07003216 * @addr: remote station's address
3217 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
Johannes Berg5ed176e2009-11-04 14:42:28 +01003218 *
3219 * This function must be called under RCU lock and the
3220 * resulting pointer is only valid under RCU lock as well.
3221 *
Ben Greear686b9cb2010-09-23 09:44:36 -07003222 * NOTE: You may pass NULL for localaddr, but then you will just get
3223 * the first STA that matches the remote address 'addr'.
3224 * We can have multiple STA associated with multiple
3225 * logical stations (e.g. consider a station connecting to another
3226 * BSSID on the same AP hardware without disconnecting first).
3227 * In this case, the result of this method with localaddr NULL
3228 * is not reliable.
Johannes Berg5ed176e2009-11-04 14:42:28 +01003229 *
Ben Greear686b9cb2010-09-23 09:44:36 -07003230 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
Johannes Berg5ed176e2009-11-04 14:42:28 +01003231 */
Ben Greear686b9cb2010-09-23 09:44:36 -07003232struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
3233 const u8 *addr,
3234 const u8 *localaddr);
Johannes Berg5ed176e2009-11-04 14:42:28 +01003235
3236/**
Johannes Bergaf818582009-11-06 11:35:50 +01003237 * ieee80211_sta_block_awake - block station from waking up
3238 * @hw: the hardware
3239 * @pubsta: the station
3240 * @block: whether to block or unblock
3241 *
3242 * Some devices require that all frames that are on the queues
3243 * for a specific station that went to sleep are flushed before
3244 * a poll response or frames after the station woke up can be
3245 * delivered to that it. Note that such frames must be rejected
3246 * by the driver as filtered, with the appropriate status flag.
3247 *
3248 * This function allows implementing this mode in a race-free
3249 * manner.
3250 *
3251 * To do this, a driver must keep track of the number of frames
3252 * still enqueued for a specific station. If this number is not
3253 * zero when the station goes to sleep, the driver must call
3254 * this function to force mac80211 to consider the station to
3255 * be asleep regardless of the station's actual state. Once the
3256 * number of outstanding frames reaches zero, the driver must
3257 * call this function again to unblock the station. That will
3258 * cause mac80211 to be able to send ps-poll responses, and if
3259 * the station queried in the meantime then frames will also
3260 * be sent out as a result of this. Additionally, the driver
3261 * will be notified that the station woke up some time after
3262 * it is unblocked, regardless of whether the station actually
3263 * woke up while blocked or not.
3264 */
3265void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
3266 struct ieee80211_sta *pubsta, bool block);
3267
3268/**
Johannes Berg37fbd902011-09-29 16:04:39 +02003269 * ieee80211_sta_eosp - notify mac80211 about end of SP
3270 * @pubsta: the station
3271 *
3272 * When a device transmits frames in a way that it can't tell
3273 * mac80211 in the TX status about the EOSP, it must clear the
3274 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
3275 * This applies for PS-Poll as well as uAPSD.
3276 *
3277 * Note that there is no non-_irqsafe version right now as
3278 * it wasn't needed, but just like _tx_status() and _rx()
3279 * must not be mixed in irqsafe/non-irqsafe versions, this
3280 * function must not be mixed with those either. Use the
3281 * all irqsafe, or all non-irqsafe, don't mix! If you need
3282 * the non-irqsafe version of this, you need to add it.
3283 */
3284void ieee80211_sta_eosp_irqsafe(struct ieee80211_sta *pubsta);
3285
3286/**
Johannes Berg830af022011-07-05 16:35:39 +02003287 * ieee80211_iter_keys - iterate keys programmed into the device
3288 * @hw: pointer obtained from ieee80211_alloc_hw()
3289 * @vif: virtual interface to iterate, may be %NULL for all
3290 * @iter: iterator function that will be called for each key
3291 * @iter_data: custom data to pass to the iterator function
3292 *
3293 * This function can be used to iterate all the keys known to
3294 * mac80211, even those that weren't previously programmed into
3295 * the device. This is intended for use in WoWLAN if the device
3296 * needs reprogramming of the keys during suspend. Note that due
3297 * to locking reasons, it is also only safe to call this at few
3298 * spots since it must hold the RTNL and be able to sleep.
Johannes Bergf850e002011-07-13 19:50:53 +02003299 *
3300 * The order in which the keys are iterated matches the order
3301 * in which they were originally installed and handed to the
3302 * set_key callback.
Johannes Berg830af022011-07-05 16:35:39 +02003303 */
3304void ieee80211_iter_keys(struct ieee80211_hw *hw,
3305 struct ieee80211_vif *vif,
3306 void (*iter)(struct ieee80211_hw *hw,
3307 struct ieee80211_vif *vif,
3308 struct ieee80211_sta *sta,
3309 struct ieee80211_key_conf *key,
3310 void *data),
3311 void *iter_data);
3312
3313/**
Juuso Oikarinena619a4c2010-11-11 08:50:18 +02003314 * ieee80211_ap_probereq_get - retrieve a Probe Request template
3315 * @hw: pointer obtained from ieee80211_alloc_hw().
3316 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3317 *
3318 * Creates a Probe Request template which can, for example, be uploaded to
3319 * hardware. The template is filled with bssid, ssid and supported rate
3320 * information. This function must only be called from within the
3321 * .bss_info_changed callback function and only in managed mode. The function
3322 * is only useful when the interface is associated, otherwise it will return
3323 * NULL.
3324 */
3325struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
3326 struct ieee80211_vif *vif);
3327
3328/**
Kalle Valo04de8382009-03-22 21:57:35 +02003329 * ieee80211_beacon_loss - inform hardware does not receive beacons
3330 *
Johannes Berg1ed32e42009-12-23 13:15:45 +01003331 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Kalle Valo04de8382009-03-22 21:57:35 +02003332 *
Johannes Bergc1288b12012-01-19 09:29:57 +01003333 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02003334 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
Kalle Valo04de8382009-03-22 21:57:35 +02003335 * hardware is not receiving beacons with this function.
3336 */
3337void ieee80211_beacon_loss(struct ieee80211_vif *vif);
Johannes Berg4b7679a2008-09-18 18:14:18 +02003338
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02003339/**
3340 * ieee80211_connection_loss - inform hardware has lost connection to the AP
3341 *
3342 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3343 *
Johannes Bergc1288b12012-01-19 09:29:57 +01003344 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02003345 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
3346 * needs to inform if the connection to the AP has been lost.
3347 *
3348 * This function will cause immediate change to disassociated state,
3349 * without connection recovery attempts.
3350 */
3351void ieee80211_connection_loss(struct ieee80211_vif *vif);
3352
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02003353/**
Johannes Berg95acac62011-07-12 12:30:59 +02003354 * ieee80211_resume_disconnect - disconnect from AP after resume
3355 *
3356 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3357 *
3358 * Instructs mac80211 to disconnect from the AP after resume.
3359 * Drivers can use this after WoWLAN if they know that the
3360 * connection cannot be kept up, for example because keys were
3361 * used while the device was asleep but the replay counters or
3362 * similar cannot be retrieved from the device during resume.
3363 *
3364 * Note that due to implementation issues, if the driver uses
3365 * the reconfiguration functionality during resume the interface
3366 * will still be added as associated first during resume and then
3367 * disconnect normally later.
3368 *
3369 * This function can only be called from the resume callback and
3370 * the driver must not be holding any of its own locks while it
3371 * calls this function, or at least not any locks it needs in the
3372 * key configuration paths (if it supports HW crypto).
3373 */
3374void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
3375
3376/**
Juuso Oikarinenf90754c2010-06-21 08:59:39 +03003377 * ieee80211_disable_dyn_ps - force mac80211 to temporarily disable dynamic psm
3378 *
3379 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3380 *
3381 * Some hardware require full power save to manage simultaneous BT traffic
3382 * on the WLAN frequency. Full PSM is required periodically, whenever there are
3383 * burst of BT traffic. The hardware gets information of BT traffic via
3384 * hardware co-existence lines, and consequentially requests mac80211 to
3385 * (temporarily) enter full psm.
3386 * This function will only temporarily disable dynamic PS, not enable PSM if
3387 * it was not already enabled.
3388 * The driver must make sure to re-enable dynamic PS using
3389 * ieee80211_enable_dyn_ps() if the driver has disabled it.
3390 *
3391 */
3392void ieee80211_disable_dyn_ps(struct ieee80211_vif *vif);
3393
3394/**
3395 * ieee80211_enable_dyn_ps - restore dynamic psm after being disabled
3396 *
3397 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3398 *
3399 * This function restores dynamic PS after being temporarily disabled via
3400 * ieee80211_disable_dyn_ps(). Each ieee80211_disable_dyn_ps() call must
3401 * be coupled with an eventual call to this function.
3402 *
3403 */
3404void ieee80211_enable_dyn_ps(struct ieee80211_vif *vif);
3405
3406/**
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02003407 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
3408 * rssi threshold triggered
3409 *
3410 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3411 * @rssi_event: the RSSI trigger event type
3412 * @gfp: context flags
3413 *
Johannes Bergea086352012-01-19 09:29:58 +01003414 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02003415 * monitoring is configured with an rssi threshold, the driver will inform
3416 * whenever the rssi level reaches the threshold.
3417 */
3418void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
3419 enum nl80211_cqm_rssi_threshold_event rssi_event,
3420 gfp_t gfp);
3421
Johannes Berg5ce6e432010-05-11 16:20:57 +02003422/**
Eliad Peller1d34d102011-06-06 12:59:29 +03003423 * ieee80211_get_operstate - get the operstate of the vif
3424 *
3425 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3426 *
3427 * The driver might need to know the operstate of the net_device
3428 * (specifically, whether the link is IF_OPER_UP after resume)
3429 */
3430unsigned char ieee80211_get_operstate(struct ieee80211_vif *vif);
3431
3432/**
Johannes Berg5ce6e432010-05-11 16:20:57 +02003433 * ieee80211_chswitch_done - Complete channel switch process
3434 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3435 * @success: make the channel switch successful or not
3436 *
3437 * Complete the channel switch post-process: set the new operational channel
3438 * and wake up the suspended queues.
3439 */
3440void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
3441
Johannes Bergd1f5b7a2010-08-05 17:05:55 +02003442/**
3443 * ieee80211_request_smps - request SM PS transition
3444 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Berg633dd1e2010-08-18 15:01:23 +02003445 * @smps_mode: new SM PS mode
Johannes Bergd1f5b7a2010-08-05 17:05:55 +02003446 *
3447 * This allows the driver to request an SM PS transition in managed
3448 * mode. This is useful when the driver has more information than
3449 * the stack about possible interference, for example by bluetooth.
3450 */
3451void ieee80211_request_smps(struct ieee80211_vif *vif,
3452 enum ieee80211_smps_mode smps_mode);
3453
Johannes Berge31b8212010-10-05 19:39:30 +02003454/**
3455 * ieee80211_key_removed - disable hw acceleration for key
3456 * @key_conf: The key hw acceleration should be disabled for
3457 *
3458 * This allows drivers to indicate that the given key has been
3459 * removed from hardware acceleration, due to a new key that
3460 * was added. Don't use this if the key can continue to be used
3461 * for TX, if the key restriction is on RX only it is permitted
3462 * to keep the key for TX only and not call this function.
3463 *
3464 * Due to locking constraints, it may only be called during
3465 * @set_key. This function must be allowed to sleep, and the
3466 * key it tries to disable may still be used until it returns.
3467 */
3468void ieee80211_key_removed(struct ieee80211_key_conf *key_conf);
3469
Johannes Berg21f83582010-12-18 17:20:47 +01003470/**
3471 * ieee80211_ready_on_channel - notification of remain-on-channel start
3472 * @hw: pointer as obtained from ieee80211_alloc_hw()
3473 */
3474void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
3475
3476/**
3477 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
3478 * @hw: pointer as obtained from ieee80211_alloc_hw()
3479 */
3480void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
3481
Shahar Levif41ccd72011-05-22 16:10:21 +03003482/**
3483 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
3484 *
3485 * in order not to harm the system performance and user experience, the device
3486 * may request not to allow any rx ba session and tear down existing rx ba
3487 * sessions based on system constraints such as periodic BT activity that needs
3488 * to limit wlan activity (eg.sco or a2dp)."
3489 * in such cases, the intention is to limit the duration of the rx ppdu and
3490 * therefore prevent the peer device to use a-mpdu aggregation.
3491 *
3492 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3493 * @ba_rx_bitmap: Bit map of open rx ba per tid
3494 * @addr: & to bssid mac address
3495 */
3496void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
3497 const u8 *addr);
3498
Felix Fietkau8c771242011-08-20 15:53:55 +02003499/**
3500 * ieee80211_send_bar - send a BlockAckReq frame
3501 *
3502 * can be used to flush pending frames from the peer's aggregation reorder
3503 * buffer.
3504 *
3505 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3506 * @ra: the peer's destination address
3507 * @tid: the TID of the aggregation session
3508 * @ssn: the new starting sequence number for the receiver
3509 */
3510void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
3511
Johannes Berg4b7679a2008-09-18 18:14:18 +02003512/* Rate control API */
Johannes Berge6a98542008-10-21 12:40:02 +02003513
Johannes Berg4b7679a2008-09-18 18:14:18 +02003514/**
Sujith81cb7622009-02-12 11:38:37 +05303515 * enum rate_control_changed - flags to indicate which parameter changed
3516 *
3517 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
3518 * changed, rate control algorithm can update its internal state if needed.
Johannes Berg1d8d3de2011-12-16 15:28:57 +01003519 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed, the rate
3520 * control algorithm needs to adjust accordingly.
Sujith81cb7622009-02-12 11:38:37 +05303521 */
3522enum rate_control_changed {
Johannes Berg1d8d3de2011-12-16 15:28:57 +01003523 IEEE80211_RC_HT_CHANGED = BIT(0),
3524 IEEE80211_RC_SMPS_CHANGED = BIT(1),
Sujith81cb7622009-02-12 11:38:37 +05303525};
3526
3527/**
Johannes Berge6a98542008-10-21 12:40:02 +02003528 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
Johannes Berg4b7679a2008-09-18 18:14:18 +02003529 *
Johannes Berge6a98542008-10-21 12:40:02 +02003530 * @hw: The hardware the algorithm is invoked for.
3531 * @sband: The band this frame is being transmitted on.
3532 * @bss_conf: the current BSS configuration
Simon Wunderlichf44d4eb2012-03-07 21:31:13 +01003533 * @skb: the skb that will be transmitted, the control information in it needs
3534 * to be filled in
Johannes Berge6a98542008-10-21 12:40:02 +02003535 * @reported_rate: The rate control algorithm can fill this in to indicate
3536 * which rate should be reported to userspace as the current rate and
3537 * used for rate calculations in the mesh network.
3538 * @rts: whether RTS will be used for this frame because it is longer than the
3539 * RTS threshold
3540 * @short_preamble: whether mac80211 will request short-preamble transmission
3541 * if the selected rate supports it
Simon Wunderlichf44d4eb2012-03-07 21:31:13 +01003542 * @max_rate_idx: user-requested maximum (legacy) rate
Jouni Malinen37eb0b12010-01-06 13:09:08 +02003543 * (deprecated; this will be removed once drivers get updated to use
3544 * rate_idx_mask)
Simon Wunderlichf44d4eb2012-03-07 21:31:13 +01003545 * @rate_idx_mask: user-requested (legacy) rate mask
3546 * @rate_idx_mcs_mask: user-requested MCS rate mask
Felix Fietkau8f0729b2010-11-11 15:07:23 +01003547 * @bss: whether this frame is sent out in AP or IBSS mode
Johannes Berg4b7679a2008-09-18 18:14:18 +02003548 */
Johannes Berge6a98542008-10-21 12:40:02 +02003549struct ieee80211_tx_rate_control {
3550 struct ieee80211_hw *hw;
3551 struct ieee80211_supported_band *sband;
3552 struct ieee80211_bss_conf *bss_conf;
3553 struct sk_buff *skb;
3554 struct ieee80211_tx_rate reported_rate;
3555 bool rts, short_preamble;
3556 u8 max_rate_idx;
Jouni Malinen37eb0b12010-01-06 13:09:08 +02003557 u32 rate_idx_mask;
Simon Wunderlich19468412012-01-28 17:25:33 +01003558 u8 rate_idx_mcs_mask[IEEE80211_HT_MCS_MASK_LEN];
Felix Fietkau8f0729b2010-11-11 15:07:23 +01003559 bool bss;
Johannes Berg4b7679a2008-09-18 18:14:18 +02003560};
3561
3562struct rate_control_ops {
3563 struct module *module;
3564 const char *name;
3565 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
Johannes Berg4b7679a2008-09-18 18:14:18 +02003566 void (*free)(void *priv);
3567
3568 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
3569 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
3570 struct ieee80211_sta *sta, void *priv_sta);
Sujith81cb7622009-02-12 11:38:37 +05303571 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
3572 struct ieee80211_sta *sta,
Sujith4fa00432010-03-01 14:42:57 +05303573 void *priv_sta, u32 changed,
3574 enum nl80211_channel_type oper_chan_type);
Johannes Berg4b7679a2008-09-18 18:14:18 +02003575 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
3576 void *priv_sta);
3577
3578 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
3579 struct ieee80211_sta *sta, void *priv_sta,
3580 struct sk_buff *skb);
Johannes Berge6a98542008-10-21 12:40:02 +02003581 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
3582 struct ieee80211_tx_rate_control *txrc);
Johannes Berg4b7679a2008-09-18 18:14:18 +02003583
3584 void (*add_sta_debugfs)(void *priv, void *priv_sta,
3585 struct dentry *dir);
3586 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
3587};
3588
3589static inline int rate_supported(struct ieee80211_sta *sta,
3590 enum ieee80211_band band,
3591 int index)
3592{
3593 return (sta == NULL || sta->supp_rates[band] & BIT(index));
3594}
3595
Luis R. Rodriguez4c6d4f52009-07-16 10:05:41 -07003596/**
3597 * rate_control_send_low - helper for drivers for management/no-ack frames
3598 *
3599 * Rate control algorithms that agree to use the lowest rate to
3600 * send management frames and NO_ACK data with the respective hw
3601 * retries should use this in the beginning of their mac80211 get_rate
3602 * callback. If true is returned the rate control can simply return.
3603 * If false is returned we guarantee that sta and sta and priv_sta is
3604 * not null.
3605 *
3606 * Rate control algorithms wishing to do more intelligent selection of
3607 * rate for multicast/broadcast frames may choose to not use this.
3608 *
3609 * @sta: &struct ieee80211_sta pointer to the target destination. Note
3610 * that this may be null.
3611 * @priv_sta: private rate control structure. This may be null.
3612 * @txrc: rate control information we sholud populate for mac80211.
3613 */
3614bool rate_control_send_low(struct ieee80211_sta *sta,
3615 void *priv_sta,
3616 struct ieee80211_tx_rate_control *txrc);
3617
3618
Johannes Berg4b7679a2008-09-18 18:14:18 +02003619static inline s8
3620rate_lowest_index(struct ieee80211_supported_band *sband,
3621 struct ieee80211_sta *sta)
3622{
3623 int i;
3624
3625 for (i = 0; i < sband->n_bitrates; i++)
3626 if (rate_supported(sta, sband->band, i))
3627 return i;
3628
3629 /* warn when we cannot find a rate. */
Johannes Berg54d50262011-11-04 18:07:43 +01003630 WARN_ON_ONCE(1);
Johannes Berg4b7679a2008-09-18 18:14:18 +02003631
Johannes Berg54d50262011-11-04 18:07:43 +01003632 /* and return 0 (the lowest index) */
Johannes Berg4b7679a2008-09-18 18:14:18 +02003633 return 0;
3634}
3635
Luis R. Rodriguezb770b432009-07-16 10:15:09 -07003636static inline
3637bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
3638 struct ieee80211_sta *sta)
3639{
3640 unsigned int i;
3641
3642 for (i = 0; i < sband->n_bitrates; i++)
3643 if (rate_supported(sta, sband->band, i))
3644 return true;
3645 return false;
3646}
Johannes Berg4b7679a2008-09-18 18:14:18 +02003647
3648int ieee80211_rate_control_register(struct rate_control_ops *ops);
3649void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
3650
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08003651static inline bool
3652conf_is_ht20(struct ieee80211_conf *conf)
3653{
Johannes Berg47979382009-01-07 10:13:27 +01003654 return conf->channel_type == NL80211_CHAN_HT20;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08003655}
3656
3657static inline bool
3658conf_is_ht40_minus(struct ieee80211_conf *conf)
3659{
Johannes Berg47979382009-01-07 10:13:27 +01003660 return conf->channel_type == NL80211_CHAN_HT40MINUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08003661}
3662
3663static inline bool
3664conf_is_ht40_plus(struct ieee80211_conf *conf)
3665{
Johannes Berg47979382009-01-07 10:13:27 +01003666 return conf->channel_type == NL80211_CHAN_HT40PLUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08003667}
3668
3669static inline bool
3670conf_is_ht40(struct ieee80211_conf *conf)
3671{
3672 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
3673}
3674
3675static inline bool
3676conf_is_ht(struct ieee80211_conf *conf)
3677{
Johannes Berg47979382009-01-07 10:13:27 +01003678 return conf->channel_type != NL80211_CHAN_NO_HT;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08003679}
3680
Johannes Berg2ca27bc2010-09-16 14:58:23 +02003681static inline enum nl80211_iftype
3682ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
3683{
3684 if (p2p) {
3685 switch (type) {
3686 case NL80211_IFTYPE_STATION:
3687 return NL80211_IFTYPE_P2P_CLIENT;
3688 case NL80211_IFTYPE_AP:
3689 return NL80211_IFTYPE_P2P_GO;
3690 default:
3691 break;
3692 }
3693 }
3694 return type;
3695}
3696
3697static inline enum nl80211_iftype
3698ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
3699{
3700 return ieee80211_iftype_p2p(vif->type, vif->p2p);
3701}
3702
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -07003703void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
3704 int rssi_min_thold,
3705 int rssi_max_thold);
3706
3707void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
Arik Nemtsov768db342011-09-28 14:12:51 +03003708
3709int ieee80211_add_srates_ie(struct ieee80211_vif *vif, struct sk_buff *skb);
3710
3711int ieee80211_add_ext_srates_ie(struct ieee80211_vif *vif,
3712 struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07003713#endif /* MAC80211_H */