blob: e1e73c6abeff59b0adda5b1aef26d8fe2e87ca19 [file] [log] [blame]
Jiri Bencf0706e822007-05-05 11:45:53 -07001/*
Johannes Berg3017b802007-08-28 17:01:53 -04002 * mac80211 <-> driver interface
3 *
Jiri Bencf0706e822007-05-05 11:45:53 -07004 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
Johannes Bergae5eb022008-10-14 16:58:37 +02006 * Copyright 2007-2008 Johannes Berg <johannes@sipsolutions.net>
Jiri Bencf0706e822007-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
16#include <linux/kernel.h>
17#include <linux/if_ether.h>
18#include <linux/skbuff.h>
19#include <linux/wireless.h>
20#include <linux/device.h>
21#include <linux/ieee80211.h>
Jiri Bencf0706e822007-05-05 11:45:53 -070022#include <net/cfg80211.h>
23
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 Bencf0706e822007-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 Bencf0706e822007-05-05 11:45:53 -070045 */
46
Johannes Berg75a5f0c2007-09-18 17:29:20 -040047/**
48 * DOC: Warning
Jiri Bencf0706e822007-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 Bencf0706e822007-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 Bencf0706e822007-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
90/**
Johannes Berge100bb62008-04-30 18:51:21 +020091 * enum ieee80211_max_queues - maximum number of queues
92 *
93 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
Johannes Berge100bb62008-04-30 18:51:21 +020094 */
95enum ieee80211_max_queues {
Johannes Berg51b38142009-03-12 11:16:48 +010096 IEEE80211_MAX_QUEUES = 4,
Johannes Berge100bb62008-04-30 18:51:21 +020097};
98
99/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400100 * struct ieee80211_tx_queue_params - transmit queue configuration
101 *
102 * The information provided in this structure is required for QoS
Johannes Berg3330d7b2008-02-10 16:49:38 +0100103 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400104 *
Bob Copelande37d4df2008-10-20 21:20:27 -0400105 * @aifs: arbitration interframe space [0..255]
Johannes Bergf434b2d2008-07-10 11:22:31 +0200106 * @cw_min: minimum contention window [a value of the form
107 * 2^n-1 in the range 1..32767]
Johannes Berg6b301cd2007-09-18 17:29:20 -0400108 * @cw_max: maximum contention window [like @cw_min]
Johannes Berg3330d7b2008-02-10 16:49:38 +0100109 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
Johannes Berg6b301cd2007-09-18 17:29:20 -0400110 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700111struct ieee80211_tx_queue_params {
Johannes Bergf434b2d2008-07-10 11:22:31 +0200112 u16 txop;
Johannes Berg3330d7b2008-02-10 16:49:38 +0100113 u16 cw_min;
114 u16 cw_max;
Johannes Bergf434b2d2008-07-10 11:22:31 +0200115 u8 aifs;
Jiri Bencf0706e822007-05-05 11:45:53 -0700116};
117
Johannes Berg6b301cd2007-09-18 17:29:20 -0400118/**
Johannes Berg57ffc582008-04-29 17:18:59 +0200119 * struct ieee80211_tx_queue_stats - transmit queue statistics
Johannes Berg6b301cd2007-09-18 17:29:20 -0400120 *
121 * @len: number of packets in queue
122 * @limit: queue length limit
123 * @count: number of frames sent
124 */
Johannes Berg57ffc582008-04-29 17:18:59 +0200125struct ieee80211_tx_queue_stats {
Johannes Berg6b301cd2007-09-18 17:29:20 -0400126 unsigned int len;
127 unsigned int limit;
128 unsigned int count;
Jiri Bencf0706e822007-05-05 11:45:53 -0700129};
130
Jiri Bencf0706e822007-05-05 11:45:53 -0700131struct ieee80211_low_level_stats {
132 unsigned int dot11ACKFailureCount;
133 unsigned int dot11RTSFailureCount;
134 unsigned int dot11FCSErrorCount;
135 unsigned int dot11RTSSuccessCount;
136};
137
Johannes Berg471b3ef2007-12-28 14:32:58 +0100138/**
139 * enum ieee80211_bss_change - BSS change notification flags
140 *
141 * These flags are used with the bss_info_changed() callback
142 * to indicate which BSS parameter changed.
143 *
144 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
145 * also implies a change in the AID.
146 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
147 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300148 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler38668c02008-03-28 16:33:32 -0700149 * @BSS_CHANGED_HT: 802.11n parameters changed
Johannes Berg96dd22a2008-09-11 00:01:57 +0200150 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200151 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200152 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
153 * reason (IBSS and managed mode)
154 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
155 * new beacon (beaconing modes)
156 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
157 * enabled/disabled (beaconing modes)
Johannes Berg471b3ef2007-12-28 14:32:58 +0100158 */
159enum ieee80211_bss_change {
160 BSS_CHANGED_ASSOC = 1<<0,
161 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
162 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300163 BSS_CHANGED_ERP_SLOT = 1<<3,
Tomas Winkler38668c02008-03-28 16:33:32 -0700164 BSS_CHANGED_HT = 1<<4,
Johannes Berg96dd22a2008-09-11 00:01:57 +0200165 BSS_CHANGED_BASIC_RATES = 1<<5,
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200166 BSS_CHANGED_BEACON_INT = 1<<6,
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200167 BSS_CHANGED_BSSID = 1<<7,
168 BSS_CHANGED_BEACON = 1<<8,
169 BSS_CHANGED_BEACON_ENABLED = 1<<9,
Johannes Berg471b3ef2007-12-28 14:32:58 +0100170};
171
172/**
173 * struct ieee80211_bss_conf - holds the BSS's changing parameters
174 *
175 * This structure keeps information about a BSS (and an association
176 * to that BSS) that can change during the lifetime of the BSS.
177 *
178 * @assoc: association status
179 * @aid: association ID number, valid only when @assoc is true
180 * @use_cts_prot: use CTS protection
Johannes Berg7a5158e2008-10-08 10:59:33 +0200181 * @use_short_preamble: use 802.11b short preamble;
182 * if the hardware cannot handle this it must set the
183 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
184 * @use_short_slot: use short slot time (only relevant for ERP);
185 * if the hardware cannot handle this it must set the
186 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800187 * @dtim_period: num of beacons before the next DTIM, for PSM
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700188 * @timestamp: beacon timestamp
189 * @beacon_int: beacon interval
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800190 * @assoc_capability: capabilities taken from assoc resp
Johannes Berg96dd22a2008-09-11 00:01:57 +0200191 * @basic_rates: bitmap of basic rates, each bit stands for an
192 * index into the rate table configured by the driver in
193 * the current band.
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200194 * @bssid: The BSSID for this BSS
195 * @enable_beacon: whether beaconing should be enabled or not
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200196 * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
197 * This field is only valid when the channel type is one of the HT types.
Johannes Berg471b3ef2007-12-28 14:32:58 +0100198 */
199struct ieee80211_bss_conf {
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200200 const u8 *bssid;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100201 /* association related data */
202 bool assoc;
203 u16 aid;
204 /* erp related data */
205 bool use_cts_prot;
206 bool use_short_preamble;
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300207 bool use_short_slot;
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200208 bool enable_beacon;
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800209 u8 dtim_period;
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700210 u16 beacon_int;
211 u16 assoc_capability;
212 u64 timestamp;
Johannes Berg881d9482009-01-21 15:13:48 +0100213 u32 basic_rates;
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200214 u16 ht_operation_mode;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100215};
216
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800217/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700218 * enum mac80211_tx_control_flags - flags to describe transmission information/status
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800219 *
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700220 * These flags are used with the @flags member of &ieee80211_tx_info.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800221 *
Johannes Berg7351c6b2009-11-19 01:08:30 +0100222 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
Johannes Berge6a98542008-10-21 12:40:02 +0200223 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
224 * number to this frame, taking care of not overwriting the fragment
225 * number and increasing the sequence number only when the
226 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
227 * assign sequence numbers to QoS-data frames but cannot do so correctly
228 * for non-QoS-data and management frames because beacons need them from
229 * that counter as well and mac80211 cannot guarantee proper sequencing.
230 * If this flag is set, the driver should instruct the hardware to
231 * assign a sequence number to the frame or assign one itself. Cf. IEEE
232 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
233 * beacons and always be clear for frames without a sequence number field.
Johannes Berge039fa42008-05-15 12:55:29 +0200234 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
Johannes Berge039fa42008-05-15 12:55:29 +0200235 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
236 * station
Johannes Berge039fa42008-05-15 12:55:29 +0200237 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
Johannes Berge039fa42008-05-15 12:55:29 +0200238 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
239 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
Johannes Berge6a98542008-10-21 12:40:02 +0200240 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
Johannes Berge039fa42008-05-15 12:55:29 +0200241 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
Johannes Bergab5b5342009-08-07 16:28:09 +0200242 * because the destination STA was in powersave mode. Note that to
243 * avoid race conditions, the filter must be set by the hardware or
244 * firmware upon receiving a frame that indicates that the station
245 * went to sleep (must be done on device to filter frames already on
246 * the queue) and may only be unset after mac80211 gives the OK for
247 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
248 * since only then is it guaranteed that no more frames are in the
249 * hardware queue.
Johannes Berge039fa42008-05-15 12:55:29 +0200250 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
251 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
252 * is for the whole aggregation.
Ron Rindjunsky429a3802008-07-01 14:16:03 +0300253 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
254 * so consider using block ack request (BAR).
Johannes Berge6a98542008-10-21 12:40:02 +0200255 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
256 * set by rate control algorithms to indicate probe rate, will
257 * be cleared for fragmented frames (except on the last fragment)
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100258 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
259 * used to indicate that a pending frame requires TX processing before
260 * it can be sent out.
Johannes Berg8f77f382009-06-07 21:58:37 +0200261 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
262 * used to indicate that a frame was already retried due to PS
Johannes Berg3b8d81e2009-06-17 17:43:56 +0200263 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
264 * used to indicate frame should not be encrypted
Johannes Berg3fa52052009-07-24 13:23:09 +0200265 * @IEEE80211_TX_CTL_PSPOLL_RESPONSE: (internal?)
266 * This frame is a response to a PS-poll frame and should be sent
267 * although the station is in powersave mode.
Johannes Bergad5351d2009-08-07 16:42:15 +0200268 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
269 * transmit function after the current frame, this can be used
270 * by drivers to kick the DMA queue only if unset or when the
271 * queue gets full.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800272 */
273enum mac80211_tx_control_flags {
Johannes Berge039fa42008-05-15 12:55:29 +0200274 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
Johannes Berge6a98542008-10-21 12:40:02 +0200275 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
276 IEEE80211_TX_CTL_NO_ACK = BIT(2),
277 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
278 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
279 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
280 IEEE80211_TX_CTL_AMPDU = BIT(6),
281 IEEE80211_TX_CTL_INJECTED = BIT(7),
282 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
283 IEEE80211_TX_STAT_ACK = BIT(9),
284 IEEE80211_TX_STAT_AMPDU = BIT(10),
285 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
286 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100287 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
Johannes Berg8f77f382009-06-07 21:58:37 +0200288 IEEE80211_TX_INTFL_RETRIED = BIT(15),
Johannes Berg3b8d81e2009-06-17 17:43:56 +0200289 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
Johannes Berg3fa52052009-07-24 13:23:09 +0200290 IEEE80211_TX_CTL_PSPOLL_RESPONSE = BIT(17),
Johannes Bergad5351d2009-08-07 16:42:15 +0200291 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
Johannes Berge6a98542008-10-21 12:40:02 +0200292};
293
Sujith2134e7e2009-01-22 09:00:52 +0530294/**
295 * enum mac80211_rate_control_flags - per-rate flags set by the
296 * Rate Control algorithm.
297 *
298 * These flags are set by the Rate control algorithm for each rate during tx,
299 * in the @flags member of struct ieee80211_tx_rate.
300 *
301 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
302 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
303 * This is set if the current BSS requires ERP protection.
304 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
305 * @IEEE80211_TX_RC_MCS: HT rate.
306 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
307 * Greenfield mode.
308 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
309 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
310 * adjacent 20 MHz channels, if the current channel type is
311 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
312 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
313 */
Johannes Berge6a98542008-10-21 12:40:02 +0200314enum mac80211_rate_control_flags {
315 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
316 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
317 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
318
319 /* rate index is an MCS rate number instead of an index */
320 IEEE80211_TX_RC_MCS = BIT(3),
321 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
322 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
323 IEEE80211_TX_RC_DUP_DATA = BIT(6),
324 IEEE80211_TX_RC_SHORT_GI = BIT(7),
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800325};
326
Johannes Berge039fa42008-05-15 12:55:29 +0200327
Johannes Berge6a98542008-10-21 12:40:02 +0200328/* there are 40 bytes if you don't need the rateset to be kept */
329#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
Johannes Berge039fa42008-05-15 12:55:29 +0200330
Johannes Berge6a98542008-10-21 12:40:02 +0200331/* if you do need the rateset, then you have less space */
332#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
333
334/* maximum number of rate stages */
335#define IEEE80211_TX_MAX_RATES 5
Felix Fietkau870abdf2008-10-05 18:04:24 +0200336
337/**
Johannes Berge6a98542008-10-21 12:40:02 +0200338 * struct ieee80211_tx_rate - rate selection/status
Felix Fietkau870abdf2008-10-05 18:04:24 +0200339 *
Johannes Berge6a98542008-10-21 12:40:02 +0200340 * @idx: rate index to attempt to send with
341 * @flags: rate control flags (&enum mac80211_rate_control_flags)
Johannes Berge25cf4a2008-10-23 08:51:20 +0200342 * @count: number of tries in this rate before going to the next rate
Johannes Berge6a98542008-10-21 12:40:02 +0200343 *
344 * A value of -1 for @idx indicates an invalid rate and, if used
345 * in an array of retry rates, that no more rates should be tried.
346 *
347 * When used for transmit status reporting, the driver should
348 * always report the rate along with the flags it used.
Johannes Bergc555b9b2009-08-07 16:23:43 +0200349 *
350 * &struct ieee80211_tx_info contains an array of these structs
351 * in the control information, and it will be filled by the rate
352 * control algorithm according to what should be sent. For example,
353 * if this array contains, in the format { <idx>, <count> } the
354 * information
355 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
356 * then this means that the frame should be transmitted
357 * up to twice at rate 3, up to twice at rate 2, and up to four
358 * times at rate 1 if it doesn't get acknowledged. Say it gets
359 * acknowledged by the peer after the fifth attempt, the status
360 * information should then contain
361 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
362 * since it was transmitted twice at rate 3, twice at rate 2
363 * and once at rate 1 after which we received an acknowledgement.
Felix Fietkau870abdf2008-10-05 18:04:24 +0200364 */
Johannes Berge6a98542008-10-21 12:40:02 +0200365struct ieee80211_tx_rate {
366 s8 idx;
367 u8 count;
368 u8 flags;
Felix Fietkau48212772008-11-03 21:05:01 +0100369} __attribute__((packed));
Felix Fietkau870abdf2008-10-05 18:04:24 +0200370
Johannes Berge039fa42008-05-15 12:55:29 +0200371/**
372 * struct ieee80211_tx_info - skb transmit information
Ivo van Doorn1c014422008-04-17 19:41:02 +0200373 *
Johannes Berge039fa42008-05-15 12:55:29 +0200374 * This structure is placed in skb->cb for three uses:
375 * (1) mac80211 TX control - mac80211 tells the driver what to do
376 * (2) driver internal use (if applicable)
377 * (3) TX status information - driver tells mac80211 what happened
378 *
Johannes Berg17741cd2008-09-11 00:02:02 +0200379 * The TX control's sta pointer is only valid during the ->tx call,
380 * it may be NULL.
381 *
Johannes Berge039fa42008-05-15 12:55:29 +0200382 * @flags: transmit info flags, defined above
Johannes Berge6a98542008-10-21 12:40:02 +0200383 * @band: the band to transmit on (use for checking for races)
Johannes Berg0f4ac382008-10-09 12:18:04 +0200384 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
Kalle Valo8bef7a12008-11-30 20:56:28 +0200385 * @pad: padding, ignore
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700386 * @control: union for control data
387 * @status: union for status data
388 * @driver_data: array of driver_data pointers
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100389 * @ampdu_ack_len: number of acked aggregated frames.
Johannes Berge039fa42008-05-15 12:55:29 +0200390 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
391 * @ampdu_ack_map: block ack bit map for the aggregation.
392 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100393 * @ampdu_len: number of aggregated frames.
394 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
Johannes Berge039fa42008-05-15 12:55:29 +0200395 * @ack_signal: signal strength of the ACK frame
Ivo van Doorn1c014422008-04-17 19:41:02 +0200396 */
Johannes Berge039fa42008-05-15 12:55:29 +0200397struct ieee80211_tx_info {
398 /* common information */
399 u32 flags;
400 u8 band;
Johannes Berge6a98542008-10-21 12:40:02 +0200401
Johannes Berge039fa42008-05-15 12:55:29 +0200402 u8 antenna_sel_tx;
Johannes Berg8318d782008-01-24 19:38:38 +0100403
Johannes Berge6a98542008-10-21 12:40:02 +0200404 /* 2 byte hole */
John W. Linville62727102008-11-12 10:01:41 -0500405 u8 pad[2];
Johannes Berg8318d782008-01-24 19:38:38 +0100406
Johannes Berge039fa42008-05-15 12:55:29 +0200407 union {
408 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200409 union {
410 /* rate control */
411 struct {
412 struct ieee80211_tx_rate rates[
413 IEEE80211_TX_MAX_RATES];
414 s8 rts_cts_rate_idx;
415 };
416 /* only needed before rate control */
417 unsigned long jiffies;
418 };
Johannes Berg25d834e2008-09-12 22:52:47 +0200419 /* NB: vif can be NULL for injected frames */
Johannes Berge039fa42008-05-15 12:55:29 +0200420 struct ieee80211_vif *vif;
421 struct ieee80211_key_conf *hw_key;
Johannes Berg17741cd2008-09-11 00:02:02 +0200422 struct ieee80211_sta *sta;
Johannes Berge039fa42008-05-15 12:55:29 +0200423 } control;
424 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200425 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
426 u8 ampdu_ack_len;
Johannes Berge039fa42008-05-15 12:55:29 +0200427 u64 ampdu_ack_map;
428 int ack_signal;
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100429 u8 ampdu_len;
430 /* 7 bytes free */
Johannes Berge039fa42008-05-15 12:55:29 +0200431 } status;
Johannes Berge6a98542008-10-21 12:40:02 +0200432 struct {
433 struct ieee80211_tx_rate driver_rates[
434 IEEE80211_TX_MAX_RATES];
435 void *rate_driver_data[
436 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
437 };
438 void *driver_data[
439 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
Johannes Berge039fa42008-05-15 12:55:29 +0200440 };
Jiri Bencf0706e822007-05-05 11:45:53 -0700441};
442
Johannes Berge039fa42008-05-15 12:55:29 +0200443static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
444{
445 return (struct ieee80211_tx_info *)skb->cb;
446}
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400447
Johannes Bergf1d58c22009-06-17 13:13:00 +0200448static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
449{
450 return (struct ieee80211_rx_status *)skb->cb;
451}
452
Johannes Berge6a98542008-10-21 12:40:02 +0200453/**
454 * ieee80211_tx_info_clear_status - clear TX status
455 *
456 * @info: The &struct ieee80211_tx_info to be cleared.
457 *
458 * When the driver passes an skb back to mac80211, it must report
459 * a number of things in TX status. This function clears everything
460 * in the TX status but the rate control information (it does clear
461 * the count since you need to fill that in anyway).
462 *
463 * NOTE: You can only use this function if you do NOT use
464 * info->driver_data! Use info->rate_driver_data
465 * instead if you need only the less space that allows.
466 */
467static inline void
468ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
469{
470 int i;
471
472 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
473 offsetof(struct ieee80211_tx_info, control.rates));
474 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
475 offsetof(struct ieee80211_tx_info, driver_rates));
476 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
477 /* clear the rate counts */
478 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
479 info->status.rates[i].count = 0;
480
481 BUILD_BUG_ON(
482 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
483 memset(&info->status.ampdu_ack_len, 0,
484 sizeof(struct ieee80211_tx_info) -
485 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
486}
487
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400488
489/**
490 * enum mac80211_rx_flags - receive flags
491 *
492 * These flags are used with the @flag member of &struct ieee80211_rx_status.
493 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
494 * Use together with %RX_FLAG_MMIC_STRIPPED.
495 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400496 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
497 * verification has been done by the hardware.
498 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
499 * If this flag is set, the stack cannot do any replay detection
500 * hence the driver or hardware will have to do that.
Johannes Berg72abd812007-09-17 01:29:22 -0400501 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
502 * the frame.
503 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
504 * the frame.
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100505 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
Bruno Randolf9d9bf772008-02-18 11:21:36 +0900506 * is valid. This is useful in monitor mode and necessary for beacon frames
507 * to enable IBSS merging.
Bruno Randolfb4f28bb2008-07-30 17:19:55 +0200508 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200509 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
510 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
511 * @RX_FLAG_SHORT_GI: Short guard interval was used
Johannes Berg8c0c7092009-11-25 17:46:15 +0100512 * @RX_FLAG_INTERNAL_CMTR: set internally after frame was reported
513 * on cooked monitor to avoid double-reporting it for multiple
514 * virtual interfaces
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400515 */
516enum mac80211_rx_flags {
517 RX_FLAG_MMIC_ERROR = 1<<0,
518 RX_FLAG_DECRYPTED = 1<<1,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400519 RX_FLAG_MMIC_STRIPPED = 1<<3,
520 RX_FLAG_IV_STRIPPED = 1<<4,
Johannes Berg72abd812007-09-17 01:29:22 -0400521 RX_FLAG_FAILED_FCS_CRC = 1<<5,
522 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100523 RX_FLAG_TSFT = 1<<7,
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200524 RX_FLAG_SHORTPRE = 1<<8,
525 RX_FLAG_HT = 1<<9,
526 RX_FLAG_40MHZ = 1<<10,
527 RX_FLAG_SHORT_GI = 1<<11,
Johannes Berg8c0c7092009-11-25 17:46:15 +0100528 RX_FLAG_INTERNAL_CMTR = 1<<12,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400529};
530
531/**
532 * struct ieee80211_rx_status - receive status
533 *
534 * The low-level driver should provide this information (the subset
535 * supported by hardware) to the 802.11 code with each received
Johannes Bergf1d58c22009-06-17 13:13:00 +0200536 * frame, in the skb's control buffer (cb).
Bruno Randolf566bfe52008-05-08 19:15:40 +0200537 *
Bruno Randolfc132bec2008-02-18 11:20:51 +0900538 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
539 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
Johannes Berg8318d782008-01-24 19:38:38 +0100540 * @band: the active band when this frame was received
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400541 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
Bruno Randolf566bfe52008-05-08 19:15:40 +0200542 * @signal: signal strength when receiving this frame, either in dBm, in dB or
543 * unspecified depending on the hardware capabilities flags
544 * @IEEE80211_HW_SIGNAL_*
545 * @noise: noise when receiving this frame, in dBm.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400546 * @antenna: antenna used
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200547 * @rate_idx: index of data rate into band's supported rates or MCS index if
548 * HT rates are use (RX_FLAG_HT)
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400549 * @flag: %RX_FLAG_*
550 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700551struct ieee80211_rx_status {
552 u64 mactime;
Johannes Berg8318d782008-01-24 19:38:38 +0100553 enum ieee80211_band band;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400554 int freq;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400555 int signal;
Jiri Bencf0706e822007-05-05 11:45:53 -0700556 int noise;
557 int antenna;
Johannes Berg8318d782008-01-24 19:38:38 +0100558 int rate_idx;
Jiri Bencf0706e822007-05-05 11:45:53 -0700559 int flag;
560};
561
Johannes Berg6b301cd2007-09-18 17:29:20 -0400562/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400563 * enum ieee80211_conf_flags - configuration flags
564 *
565 * Flags to define PHY configuration options
566 *
Johannes Berg0869aea2009-10-28 10:03:35 +0100567 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
568 * to determine for example whether to calculate timestamps for packets
569 * or not, do not use instead of filter flags!
Johannes Berg04fe2032009-04-22 18:44:37 +0200570 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only)
Johannes Berg5cff20e2009-04-29 12:26:17 +0200571 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
572 * the driver should be prepared to handle configuration requests but
573 * may turn the device off as much as possible. Typically, this flag will
574 * be set when an interface is set UP but not associated or scanning, but
575 * it can also be unset in that case when monitor interfaces are active.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400576 */
577enum ieee80211_conf_flags {
Johannes Berg0869aea2009-10-28 10:03:35 +0100578 IEEE80211_CONF_MONITOR = (1<<0),
Johannes Bergae5eb022008-10-14 16:58:37 +0200579 IEEE80211_CONF_PS = (1<<1),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200580 IEEE80211_CONF_IDLE = (1<<2),
Johannes Berg6b301cd2007-09-18 17:29:20 -0400581};
Jiri Bencf0706e822007-05-05 11:45:53 -0700582
Johannes Berg7a5158e2008-10-08 10:59:33 +0200583
Jiri Bencf0706e822007-05-05 11:45:53 -0700584/**
Johannes Berge8975582008-10-09 12:18:51 +0200585 * enum ieee80211_conf_changed - denotes which configuration changed
586 *
Johannes Berge8975582008-10-09 12:18:51 +0200587 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
Johannes Berg0869aea2009-10-28 10:03:35 +0100588 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
Johannes Berge255d5e2009-04-22 12:40:07 +0200589 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
Johannes Berge8975582008-10-09 12:18:51 +0200590 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
Johannes Berg47979382009-01-07 10:13:27 +0100591 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
Johannes Berg9124b072008-10-14 19:17:54 +0200592 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
Johannes Berg5cff20e2009-04-29 12:26:17 +0200593 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
Johannes Berg0f782312009-12-01 13:37:02 +0100594 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
Johannes Berge8975582008-10-09 12:18:51 +0200595 */
596enum ieee80211_conf_changed {
Johannes Berg0f782312009-12-01 13:37:02 +0100597 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
Johannes Berge8975582008-10-09 12:18:51 +0200598 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
Johannes Berg0869aea2009-10-28 10:03:35 +0100599 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
Johannes Berge8975582008-10-09 12:18:51 +0200600 IEEE80211_CONF_CHANGE_PS = BIT(4),
Johannes Berge255d5e2009-04-22 12:40:07 +0200601 IEEE80211_CONF_CHANGE_POWER = BIT(5),
602 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
603 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200604 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
Johannes Berge8975582008-10-09 12:18:51 +0200605};
606
607/**
Johannes Berg0f782312009-12-01 13:37:02 +0100608 * enum ieee80211_smps_mode - spatial multiplexing power save mode
609 *
610 * @
611 */
612enum ieee80211_smps_mode {
613 IEEE80211_SMPS_AUTOMATIC,
614 IEEE80211_SMPS_OFF,
615 IEEE80211_SMPS_STATIC,
616 IEEE80211_SMPS_DYNAMIC,
617
618 /* keep last */
619 IEEE80211_SMPS_NUM_MODES,
620};
621
622/**
Jiri Bencf0706e822007-05-05 11:45:53 -0700623 * struct ieee80211_conf - configuration of the device
624 *
625 * This struct indicates how the driver shall configure the hardware.
626 *
Johannes Berg04fe2032009-04-22 18:44:37 +0200627 * @flags: configuration flags defined above
628 *
Tomas Winklerea95bba2008-07-18 13:53:00 +0800629 * @listen_interval: listen interval in units of beacon interval
Johannes Berg9ccebe62009-04-23 10:32:36 +0200630 * @max_sleep_period: the maximum number of beacon intervals to sleep for
Johannes Berg04fe2032009-04-22 18:44:37 +0200631 * before checking the beacon for a TIM bit (managed mode only); this
632 * value will be only achievable between DTIM frames, the hardware
633 * needs to check for the multicast traffic bit in DTIM beacons.
634 * This variable is valid only when the CONF_PS flag is set.
635 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
636 * powersave documentation below. This variable is valid only when
637 * the CONF_PS flag is set.
638 *
Johannes Berg8318d782008-01-24 19:38:38 +0100639 * @power_level: requested transmit power (in dBm)
Johannes Berg04fe2032009-04-22 18:44:37 +0200640 *
Johannes Berg8318d782008-01-24 19:38:38 +0100641 * @channel: the channel to tune to
Johannes Berg47979382009-01-07 10:13:27 +0100642 * @channel_type: the channel (HT) type
Johannes Berg04fe2032009-04-22 18:44:37 +0200643 *
Johannes Berg9124b072008-10-14 19:17:54 +0200644 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
645 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
646 * but actually means the number of transmissions not the number of retries
647 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
648 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
649 * number of transmissions not the number of retries
Johannes Berg0f782312009-12-01 13:37:02 +0100650 *
651 * @smps_mode: spatial multiplexing powersave mode; note that
652 * %IEEE80211_SMPS_STATIC is used when the device is not
653 * configured for an HT channel
Jiri Bencf0706e822007-05-05 11:45:53 -0700654 */
655struct ieee80211_conf {
Johannes Berg6b301cd2007-09-18 17:29:20 -0400656 u32 flags;
Johannes Berg46f2c4b2009-01-06 18:13:18 +0100657 int power_level, dynamic_ps_timeout;
Johannes Berg9ccebe62009-04-23 10:32:36 +0200658 int max_sleep_period;
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200659
Johannes Berge8975582008-10-09 12:18:51 +0200660 u16 listen_interval;
Johannes Berge8975582008-10-09 12:18:51 +0200661
Johannes Berg9124b072008-10-14 19:17:54 +0200662 u8 long_frame_max_tx_count, short_frame_max_tx_count;
663
Johannes Berg8318d782008-01-24 19:38:38 +0100664 struct ieee80211_channel *channel;
Johannes Berg47979382009-01-07 10:13:27 +0100665 enum nl80211_channel_type channel_type;
Johannes Berg0f782312009-12-01 13:37:02 +0100666 enum ieee80211_smps_mode smps_mode;
Jiri Bencf0706e822007-05-05 11:45:53 -0700667};
668
669/**
Johannes Berg32bfd352007-12-19 01:31:26 +0100670 * struct ieee80211_vif - per-interface data
671 *
672 * Data in this structure is continually present for driver
673 * use during the life of a virtual interface.
674 *
Johannes Berg51fb61e2007-12-19 01:31:27 +0100675 * @type: type of this virtual interface
Johannes Bergbda39332008-10-11 01:51:51 +0200676 * @bss_conf: BSS configuration for this interface, either our own
677 * or the BSS we're associated to
Johannes Berg47846c92009-11-25 17:46:19 +0100678 * @addr: address of this interface
Johannes Berg32bfd352007-12-19 01:31:26 +0100679 * @drv_priv: data area for driver use, will always be aligned to
680 * sizeof(void *).
681 */
682struct ieee80211_vif {
Johannes Berg05c914f2008-09-11 00:01:58 +0200683 enum nl80211_iftype type;
Johannes Bergbda39332008-10-11 01:51:51 +0200684 struct ieee80211_bss_conf bss_conf;
Johannes Berg47846c92009-11-25 17:46:19 +0100685 u8 addr[ETH_ALEN];
Johannes Berg32bfd352007-12-19 01:31:26 +0100686 /* must be last */
687 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
688};
689
Johannes Berg902acc72008-02-23 15:17:19 +0100690static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
691{
692#ifdef CONFIG_MAC80211_MESH
Johannes Berg05c914f2008-09-11 00:01:58 +0200693 return vif->type == NL80211_IFTYPE_MESH_POINT;
Johannes Berg902acc72008-02-23 15:17:19 +0100694#endif
695 return false;
696}
697
Johannes Berg32bfd352007-12-19 01:31:26 +0100698/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400699 * enum ieee80211_key_alg - key algorithm
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400700 * @ALG_WEP: WEP40 or WEP104
701 * @ALG_TKIP: TKIP
702 * @ALG_CCMP: CCMP (AES)
Jouni Malinen3cfcf6a2009-01-08 13:32:02 +0200703 * @ALG_AES_CMAC: AES-128-CMAC
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400704 */
Johannes Bergea49c352007-09-18 17:29:21 -0400705enum ieee80211_key_alg {
Johannes Berg8f20fc22007-08-28 17:01:54 -0400706 ALG_WEP,
707 ALG_TKIP,
708 ALG_CCMP,
Jouni Malinen3cfcf6a2009-01-08 13:32:02 +0200709 ALG_AES_CMAC,
Johannes Bergea49c352007-09-18 17:29:21 -0400710};
Jiri Bencf0706e822007-05-05 11:45:53 -0700711
Emmanuel Grumbach23976ef2008-06-28 02:50:13 +0300712/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400713 * enum ieee80211_key_flags - key flags
714 *
715 * These flags are used for communication about keys between the driver
716 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
717 *
718 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
719 * that the STA this key will be used with could be using QoS.
720 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
721 * driver to indicate that it requires IV generation for this
722 * particular key.
723 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
724 * the driver for a TKIP key if it requires Michael MIC
725 * generation in software.
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200726 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
727 * that the key is pairwise rather then a shared key.
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200728 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
729 * CCMP key if it requires CCMP encryption of management frames (MFP) to
730 * be done in software.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400731 */
732enum ieee80211_key_flags {
733 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
734 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
735 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200736 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200737 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400738};
739
740/**
741 * struct ieee80211_key_conf - key information
742 *
743 * This key information is given by mac80211 to the driver by
744 * the set_key() callback in &struct ieee80211_ops.
745 *
746 * @hw_key_idx: To be set by the driver, this is the key index the driver
747 * wants to be given when a frame is transmitted and needs to be
Johannes Berg6a7664d2007-09-14 11:10:25 -0400748 * encrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400749 * @alg: The key algorithm.
750 * @flags: key flags, see &enum ieee80211_key_flags.
751 * @keyidx: the key index (0-3)
752 * @keylen: key material length
Luis R. Rodriguezffd78912008-06-21 10:02:46 -0400753 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
754 * data block:
755 * - Temporal Encryption Key (128 bits)
756 * - Temporal Authenticator Tx MIC Key (64 bits)
757 * - Temporal Authenticator Rx MIC Key (64 bits)
Johannes Bergdc822b52008-12-29 12:55:09 +0100758 * @icv_len: The ICV length for this key type
759 * @iv_len: The IV length for this key type
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400760 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700761struct ieee80211_key_conf {
Johannes Bergea49c352007-09-18 17:29:21 -0400762 enum ieee80211_key_alg alg;
Felix Fietkau76708de2008-10-05 18:02:48 +0200763 u8 icv_len;
764 u8 iv_len;
Johannes Berg6a7664d2007-09-14 11:10:25 -0400765 u8 hw_key_idx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400766 u8 flags;
Johannes Berg11a843b2007-08-28 17:01:55 -0400767 s8 keyidx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400768 u8 keylen;
Jiri Bencf0706e822007-05-05 11:45:53 -0700769 u8 key[0];
770};
771
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400772/**
773 * enum set_key_cmd - key command
774 *
775 * Used with the set_key() callback in &struct ieee80211_ops, this
776 * indicates whether a key is being removed or added.
777 *
778 * @SET_KEY: a key is set
779 * @DISABLE_KEY: a key must be disabled
780 */
Johannes Bergea49c352007-09-18 17:29:21 -0400781enum set_key_cmd {
Johannes Berg11a843b2007-08-28 17:01:55 -0400782 SET_KEY, DISABLE_KEY,
Johannes Bergea49c352007-09-18 17:29:21 -0400783};
Jiri Bencf0706e822007-05-05 11:45:53 -0700784
Tomas Winkler478f8d22007-09-30 13:52:37 +0200785/**
Johannes Berg17741cd2008-09-11 00:02:02 +0200786 * struct ieee80211_sta - station table entry
787 *
788 * A station table entry represents a station we are possibly
789 * communicating with. Since stations are RCU-managed in
790 * mac80211, any ieee80211_sta pointer you get access to must
791 * either be protected by rcu_read_lock() explicitly or implicitly,
792 * or you must take good care to not use such a pointer after a
793 * call to your sta_notify callback that removed it.
794 *
795 * @addr: MAC address
796 * @aid: AID we assigned to the station if we're an AP
Johannes Berg323ce792008-09-11 02:45:11 +0200797 * @supp_rates: Bitmap of supported rates (per band)
Johannes Bergae5eb022008-10-14 16:58:37 +0200798 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
Johannes Berg17741cd2008-09-11 00:02:02 +0200799 * @drv_priv: data area for driver use, will always be aligned to
800 * sizeof(void *), size is determined in hw information.
801 */
802struct ieee80211_sta {
Johannes Berg881d9482009-01-21 15:13:48 +0100803 u32 supp_rates[IEEE80211_NUM_BANDS];
Johannes Berg17741cd2008-09-11 00:02:02 +0200804 u8 addr[ETH_ALEN];
805 u16 aid;
Johannes Bergd9fe60d2008-10-09 12:13:49 +0200806 struct ieee80211_sta_ht_cap ht_cap;
Johannes Berg17741cd2008-09-11 00:02:02 +0200807
808 /* must be last */
809 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
810};
811
812/**
Tomas Winkler478f8d22007-09-30 13:52:37 +0200813 * enum sta_notify_cmd - sta notify command
814 *
815 * Used with the sta_notify() callback in &struct ieee80211_ops, this
Christian Lamparter89fad572008-12-09 16:28:06 +0100816 * indicates addition and removal of a station to station table,
817 * or if a associated station made a power state transition.
Tomas Winkler478f8d22007-09-30 13:52:37 +0200818 *
819 * @STA_NOTIFY_ADD: a station was added to the station table
820 * @STA_NOTIFY_REMOVE: a station being removed from the station table
Christian Lamparter4571d3b2008-11-30 00:48:41 +0100821 * @STA_NOTIFY_SLEEP: a station is now sleeping
822 * @STA_NOTIFY_AWAKE: a sleeping station woke up
823 */
Christian Lamparter89fad572008-12-09 16:28:06 +0100824enum sta_notify_cmd {
825 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE,
Christian Lamparter4571d3b2008-11-30 00:48:41 +0100826 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
827};
828
829/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +0200830 * enum ieee80211_tkip_key_type - get tkip key
831 *
832 * Used by drivers which need to get a tkip key for skb. Some drivers need a
833 * phase 1 key, others need a phase 2 key. A single function allows the driver
834 * to get the key, this enum indicates what type of key is required.
835 *
836 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
837 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
838 */
839enum ieee80211_tkip_key_type {
840 IEEE80211_TKIP_P1_KEY,
841 IEEE80211_TKIP_P2_KEY,
842};
843
844/**
Johannes Berg1bc08262007-09-18 17:29:15 -0400845 * enum ieee80211_hw_flags - hardware flags
846 *
847 * These flags are used to indicate hardware capabilities to
848 * the stack. Generally, flags here should have their meaning
849 * done in a way that the simplest hardware doesn't need setting
850 * any particular flags. There are some exceptions to this rule,
851 * however, so you are advised to review these flags carefully.
852 *
Johannes Bergaf65cd92009-11-17 18:18:36 +0100853 * @IEEE80211_HW_HAS_RATE_CONTROL:
854 * The hardware or firmware includes rate control, and cannot be
855 * controlled by the stack. As such, no rate control algorithm
856 * should be instantiated, and the TX rate reported to userspace
857 * will be taken from the TX status instead of the rate control
858 * algorithm.
859 * Note that this requires that the driver implement a number of
860 * callbacks so it has the correct information, it needs to have
861 * the @set_rts_threshold callback and must look at the BSS config
862 * @use_cts_prot for G/N protection, @use_short_slot for slot
863 * timing in 2.4 GHz and @use_short_preamble for preambles for
864 * CCK frames.
865 *
Johannes Berg1bc08262007-09-18 17:29:15 -0400866 * @IEEE80211_HW_RX_INCLUDES_FCS:
867 * Indicates that received frames passed to the stack include
868 * the FCS at the end.
869 *
870 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
871 * Some wireless LAN chipsets buffer broadcast/multicast frames
872 * for power saving stations in the hardware/firmware and others
873 * rely on the host system for such buffering. This option is used
874 * to configure the IEEE 802.11 upper layer to buffer broadcast and
875 * multicast frames when there are power saving stations so that
Luis R. Rodriguez546c80c2008-08-14 11:43:20 -0700876 * the driver can fetch them with ieee80211_get_buffered_bc().
Johannes Berg1bc08262007-09-18 17:29:15 -0400877 *
Johannes Berg8318d782008-01-24 19:38:38 +0100878 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
879 * Hardware is not capable of short slot operation on the 2.4 GHz band.
880 *
881 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
882 * Hardware is not capable of receiving frames with short preamble on
883 * the 2.4 GHz band.
Bruno Randolf566bfe52008-05-08 19:15:40 +0200884 *
885 * @IEEE80211_HW_SIGNAL_UNSPEC:
886 * Hardware can provide signal values but we don't know its units. We
887 * expect values between 0 and @max_signal.
888 * If possible please provide dB or dBm instead.
889 *
Bruno Randolf566bfe52008-05-08 19:15:40 +0200890 * @IEEE80211_HW_SIGNAL_DBM:
891 * Hardware gives signal values in dBm, decibel difference from
892 * one milliwatt. This is the preferred method since it is standardized
893 * between different devices. @max_signal does not need to be set.
894 *
895 * @IEEE80211_HW_NOISE_DBM:
896 * Hardware can provide noise (radio interference) values in units dBm,
897 * decibel difference from one milliwatt.
Tomas Winkler06ff47b2008-06-18 17:53:44 +0300898 *
899 * @IEEE80211_HW_SPECTRUM_MGMT:
900 * Hardware supports spectrum management defined in 802.11h
901 * Measurement, Channel Switch, Quieting, TPC
Sujith8b30b1f2008-10-24 09:55:27 +0530902 *
903 * @IEEE80211_HW_AMPDU_AGGREGATION:
904 * Hardware supports 11n A-MPDU aggregation.
Kalle Valo520eb822008-12-18 23:35:27 +0200905 *
Johannes Berg4be8c382009-01-07 18:28:20 +0100906 * @IEEE80211_HW_SUPPORTS_PS:
907 * Hardware has power save support (i.e. can go to sleep).
908 *
909 * @IEEE80211_HW_PS_NULLFUNC_STACK:
910 * Hardware requires nullfunc frame handling in stack, implies
911 * stack support for dynamic PS.
912 *
913 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
914 * Hardware has support for dynamic PS.
Jouni Malinen4375d082009-01-08 13:32:11 +0200915 *
916 * @IEEE80211_HW_MFP_CAPABLE:
917 * Hardware supports management frame protection (MFP, IEEE 802.11w).
Kalle Valo04de8382009-03-22 21:57:35 +0200918 *
919 * @IEEE80211_HW_BEACON_FILTER:
920 * Hardware supports dropping of irrelevant beacon frames to
921 * avoid waking up cpu.
Johannes Berg0f782312009-12-01 13:37:02 +0100922 *
923 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
924 * Hardware supports static spatial multiplexing powersave,
925 * ie. can turn off all but one chain even on HT connections
926 * that should be using more chains.
927 *
928 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
929 * Hardware supports dynamic spatial multiplexing powersave,
930 * ie. can turn off all but one chain and then wake the rest
931 * up as required after, for example, rts/cts handshake.
Johannes Berg1bc08262007-09-18 17:29:15 -0400932 */
933enum ieee80211_hw_flags {
Johannes Bergaf65cd92009-11-17 18:18:36 +0100934 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
Johannes Berg1bc08262007-09-18 17:29:15 -0400935 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
936 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
Johannes Berg8318d782008-01-24 19:38:38 +0100937 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
938 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
Bruno Randolf566bfe52008-05-08 19:15:40 +0200939 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
Johannes Berg7fee5372009-01-30 11:13:06 +0100940 IEEE80211_HW_SIGNAL_DBM = 1<<6,
941 IEEE80211_HW_NOISE_DBM = 1<<7,
942 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
943 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
944 IEEE80211_HW_SUPPORTS_PS = 1<<10,
945 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
946 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
947 IEEE80211_HW_MFP_CAPABLE = 1<<13,
Kalle Valo04de8382009-03-22 21:57:35 +0200948 IEEE80211_HW_BEACON_FILTER = 1<<14,
Johannes Berg0f782312009-12-01 13:37:02 +0100949 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
950 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
Johannes Berg1bc08262007-09-18 17:29:15 -0400951};
952
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400953/**
954 * struct ieee80211_hw - hardware information and state
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400955 *
956 * This structure contains the configuration and hardware
957 * information for an 802.11 PHY.
958 *
959 * @wiphy: This points to the &struct wiphy allocated for this
960 * 802.11 PHY. You must fill in the @perm_addr and @dev
961 * members of this structure using SET_IEEE80211_DEV()
Johannes Berg8318d782008-01-24 19:38:38 +0100962 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
963 * bands (with channels, bitrates) are registered here.
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400964 *
965 * @conf: &struct ieee80211_conf, device configuration, don't use.
966 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400967 * @priv: pointer to private area that was allocated for driver use
968 * along with this structure.
969 *
970 * @flags: hardware flags, see &enum ieee80211_hw_flags.
971 *
972 * @extra_tx_headroom: headroom to reserve in each transmit skb
973 * for use by the driver (e.g. for transmit headers.)
974 *
975 * @channel_change_time: time (in microseconds) it takes to change channels.
976 *
Bruno Randolf566bfe52008-05-08 19:15:40 +0200977 * @max_signal: Maximum value for signal (rssi) in RX information, used
978 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400979 *
Tomas Winklerea95bba2008-07-18 13:53:00 +0800980 * @max_listen_interval: max listen interval in units of beacon interval
981 * that HW supports
982 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400983 * @queues: number of available hardware transmit queues for
Johannes Berge100bb62008-04-30 18:51:21 +0200984 * data packets. WMM/QoS requires at least four, these
985 * queues need to have configurable access parameters.
986 *
Johannes Berg830f9032007-10-28 14:51:05 +0100987 * @rate_control_algorithm: rate control algorithm for this hardware.
988 * If unset (NULL), the default algorithm will be used. Must be
989 * set before calling ieee80211_register_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +0100990 *
991 * @vif_data_size: size (in bytes) of the drv_priv data area
992 * within &struct ieee80211_vif.
Johannes Berg17741cd2008-09-11 00:02:02 +0200993 * @sta_data_size: size (in bytes) of the drv_priv data area
994 * within &struct ieee80211_sta.
Felix Fietkau870abdf2008-10-05 18:04:24 +0200995 *
Johannes Berge6a98542008-10-21 12:40:02 +0200996 * @max_rates: maximum number of alternate rate retry stages
997 * @max_rate_tries: maximum number of tries for each stage
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400998 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700999struct ieee80211_hw {
Jiri Bencf0706e822007-05-05 11:45:53 -07001000 struct ieee80211_conf conf;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001001 struct wiphy *wiphy;
Johannes Berg830f9032007-10-28 14:51:05 +01001002 const char *rate_control_algorithm;
Jiri Bencf0706e822007-05-05 11:45:53 -07001003 void *priv;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001004 u32 flags;
Jiri Bencf0706e822007-05-05 11:45:53 -07001005 unsigned int extra_tx_headroom;
Jiri Bencf0706e822007-05-05 11:45:53 -07001006 int channel_change_time;
Johannes Berg32bfd352007-12-19 01:31:26 +01001007 int vif_data_size;
Johannes Berg17741cd2008-09-11 00:02:02 +02001008 int sta_data_size;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001009 u16 queues;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001010 u16 max_listen_interval;
Jiri Bencf0706e822007-05-05 11:45:53 -07001011 s8 max_signal;
Johannes Berge6a98542008-10-21 12:40:02 +02001012 u8 max_rates;
1013 u8 max_rate_tries;
Jiri Bencf0706e822007-05-05 11:45:53 -07001014};
1015
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001016/**
Luis R. Rodriguez9a953712009-01-22 15:05:53 -08001017 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1018 *
1019 * @wiphy: the &struct wiphy which we want to query
1020 *
1021 * mac80211 drivers can use this to get to their respective
1022 * &struct ieee80211_hw. Drivers wishing to get to their own private
1023 * structure can then access it via hw->priv. Note that mac802111 drivers should
1024 * not use wiphy_priv() to try to get their private driver structure as this
1025 * is already used internally by mac80211.
1026 */
1027struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1028
1029/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001030 * SET_IEEE80211_DEV - set device for 802.11 hardware
1031 *
1032 * @hw: the &struct ieee80211_hw to set the device for
1033 * @dev: the &struct device of this 802.11 device
1034 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001035static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1036{
1037 set_wiphy_dev(hw->wiphy, dev);
1038}
1039
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001040/**
Bob Copelande37d4df2008-10-20 21:20:27 -04001041 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001042 *
1043 * @hw: the &struct ieee80211_hw to set the MAC address for
1044 * @addr: the address to set
1045 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001046static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1047{
1048 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1049}
1050
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001051static inline struct ieee80211_rate *
1052ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001053 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001054{
Johannes Berge6a98542008-10-21 12:40:02 +02001055 if (WARN_ON(c->control.rates[0].idx < 0))
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001056 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001057 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001058}
1059
1060static inline struct ieee80211_rate *
1061ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001062 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001063{
Johannes Berge039fa42008-05-15 12:55:29 +02001064 if (c->control.rts_cts_rate_idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001065 return NULL;
Johannes Berge039fa42008-05-15 12:55:29 +02001066 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001067}
1068
1069static inline struct ieee80211_rate *
1070ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
Felix Fietkau870abdf2008-10-05 18:04:24 +02001071 const struct ieee80211_tx_info *c, int idx)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001072{
Johannes Berge6a98542008-10-21 12:40:02 +02001073 if (c->control.rates[idx + 1].idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001074 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001075 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001076}
1077
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001078/**
1079 * DOC: Hardware crypto acceleration
Johannes Berg4150c572007-09-17 01:29:23 -04001080 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001081 * mac80211 is capable of taking advantage of many hardware
1082 * acceleration designs for encryption and decryption operations.
1083 *
1084 * The set_key() callback in the &struct ieee80211_ops for a given
1085 * device is called to enable hardware acceleration of encryption and
Johannes Bergdc822b52008-12-29 12:55:09 +01001086 * decryption. The callback takes a @sta parameter that will be NULL
1087 * for default keys or keys used for transmission only, or point to
1088 * the station information for the peer for individual keys.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001089 * Multiple transmission keys with the same key index may be used when
1090 * VLANs are configured for an access point.
1091 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001092 * When transmitting, the TX control data will use the @hw_key_idx
1093 * selected by the driver by modifying the &struct ieee80211_key_conf
1094 * pointed to by the @key parameter to the set_key() function.
1095 *
1096 * The set_key() call for the %SET_KEY command should return 0 if
1097 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1098 * added; if you return 0 then hw_key_idx must be assigned to the
1099 * hardware key index, you are free to use the full u8 range.
1100 *
1101 * When the cmd is %DISABLE_KEY then it must succeed.
1102 *
1103 * Note that it is permissible to not decrypt a frame even if a key
1104 * for it has been uploaded to hardware, the stack will not make any
1105 * decision based on whether a key has been uploaded or not but rather
1106 * based on the receive flags.
1107 *
1108 * The &struct ieee80211_key_conf structure pointed to by the @key
1109 * parameter is guaranteed to be valid until another call to set_key()
1110 * removes it, but it can only be used as a cookie to differentiate
1111 * keys.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001112 *
1113 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1114 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1115 * handler.
1116 * The update_tkip_key() call updates the driver with the new phase 1 key.
1117 * This happens everytime the iv16 wraps around (every 65536 packets). The
1118 * set_key() call will happen only once for each key (unless the AP did
1119 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
Bob Copelande37d4df2008-10-20 21:20:27 -04001120 * provided by update_tkip_key only. The trigger that makes mac80211 call this
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001121 * handler is software decryption with wrap around of iv16.
Johannes Berg4150c572007-09-17 01:29:23 -04001122 */
Johannes Berg4150c572007-09-17 01:29:23 -04001123
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001124/**
Johannes Berg4be8c382009-01-07 18:28:20 +01001125 * DOC: Powersave support
1126 *
1127 * mac80211 has support for various powersave implementations.
1128 *
1129 * First, it can support hardware that handles all powersaving by
1130 * itself, such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS
1131 * hardware flag. In that case, it will be told about the desired
1132 * powersave mode depending on the association status, and the driver
1133 * must take care of sending nullfunc frames when necessary, i.e. when
1134 * entering and leaving powersave mode. The driver is required to look at
1135 * the AID in beacons and signal to the AP that it woke up when it finds
1136 * traffic directed to it. This mode supports dynamic PS by simply
1137 * enabling/disabling PS.
1138 *
1139 * Additionally, such hardware may set the %IEEE80211_HW_SUPPORTS_DYNAMIC_PS
1140 * flag to indicate that it can support dynamic PS mode itself (see below).
1141 *
1142 * Other hardware designs cannot send nullfunc frames by themselves and also
1143 * need software support for parsing the TIM bitmap. This is also supported
1144 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1145 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
Johannes Berg955394c2009-04-16 17:04:25 +02001146 * required to pass up beacons. The hardware is still required to handle
1147 * waking up for multicast traffic; if it cannot the driver must handle that
1148 * as best as it can, mac80211 is too slow.
Johannes Berg4be8c382009-01-07 18:28:20 +01001149 *
1150 * Dynamic powersave mode is an extension to normal powersave mode in which
1151 * the hardware stays awake for a user-specified period of time after sending
1152 * a frame so that reply frames need not be buffered and therefore delayed
1153 * to the next wakeup. This can either be supported by hardware, in which case
1154 * the driver needs to look at the @dynamic_ps_timeout hardware configuration
1155 * value, or by the stack if all nullfunc handling is in the stack.
1156 */
1157
1158/**
Kalle Valo04de8382009-03-22 21:57:35 +02001159 * DOC: Beacon filter support
1160 *
1161 * Some hardware have beacon filter support to reduce host cpu wakeups
1162 * which will reduce system power consumption. It usuallly works so that
1163 * the firmware creates a checksum of the beacon but omits all constantly
1164 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1165 * beacon is forwarded to the host, otherwise it will be just dropped. That
1166 * way the host will only receive beacons where some relevant information
1167 * (for example ERP protection or WMM settings) have changed.
1168 *
Johannes Berg955394c2009-04-16 17:04:25 +02001169 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1170 * hardware capability. The driver needs to enable beacon filter support
1171 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1172 * power save is enabled, the stack will not check for beacon loss and the
1173 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1174 *
1175 * The time (or number of beacons missed) until the firmware notifies the
1176 * driver of a beacon loss event (which in turn causes the driver to call
1177 * ieee80211_beacon_loss()) should be configurable and will be controlled
1178 * by mac80211 and the roaming algorithm in the future.
1179 *
1180 * Since there may be constantly changing information elements that nothing
1181 * in the software stack cares about, we will, in the future, have mac80211
1182 * tell the driver which information elements are interesting in the sense
1183 * that we want to see changes in them. This will include
1184 * - a list of information element IDs
1185 * - a list of OUIs for the vendor information element
1186 *
1187 * Ideally, the hardware would filter out any beacons without changes in the
1188 * requested elements, but if it cannot support that it may, at the expense
1189 * of some efficiency, filter out only a subset. For example, if the device
1190 * doesn't support checking for OUIs it should pass up all changes in all
1191 * vendor information elements.
1192 *
1193 * Note that change, for the sake of simplification, also includes information
1194 * elements appearing or disappearing from the beacon.
1195 *
1196 * Some hardware supports an "ignore list" instead, just make sure nothing
1197 * that was requested is on the ignore list, and include commonly changing
1198 * information element IDs in the ignore list, for example 11 (BSS load) and
1199 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1200 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1201 * it could also include some currently unused IDs.
1202 *
1203 *
1204 * In addition to these capabilities, hardware should support notifying the
1205 * host of changes in the beacon RSSI. This is relevant to implement roaming
1206 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1207 * the received data packets). This can consist in notifying the host when
1208 * the RSSI changes significantly or when it drops below or rises above
1209 * configurable thresholds. In the future these thresholds will also be
1210 * configured by mac80211 (which gets them from userspace) to implement
1211 * them as the roaming algorithm requires.
1212 *
1213 * If the hardware cannot implement this, the driver should ask it to
1214 * periodically pass beacon frames to the host so that software can do the
1215 * signal strength threshold checking.
Kalle Valo04de8382009-03-22 21:57:35 +02001216 */
1217
1218/**
Johannes Berg0f782312009-12-01 13:37:02 +01001219 * DOC: Spatial multiplexing power save
1220 *
1221 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1222 * power in an 802.11n implementation. For details on the mechanism
1223 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1224 * "11.2.3 SM power save".
1225 *
1226 * The mac80211 implementation is capable of sending action frames
1227 * to update the AP about the station's SMPS mode, and will instruct
1228 * the driver to enter the specific mode. It will also announce the
1229 * requested SMPS mode during the association handshake. Hardware
1230 * support for this feature is required, and can be indicated by
1231 * hardware flags.
1232 *
1233 * The default mode will be "automatic", which nl80211/cfg80211
1234 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1235 * turned off otherwise.
1236 *
1237 * To support this feature, the driver must set the appropriate
1238 * hardware support flags, and handle the SMPS flag to the config()
1239 * operation. It will then with this mechanism be instructed to
1240 * enter the requested SMPS mode while associated to an HT AP.
1241 */
1242
1243/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001244 * DOC: Frame filtering
1245 *
1246 * mac80211 requires to see many management frames for proper
1247 * operation, and users may want to see many more frames when
1248 * in monitor mode. However, for best CPU usage and power consumption,
1249 * having as few frames as possible percolate through the stack is
1250 * desirable. Hence, the hardware should filter as much as possible.
1251 *
1252 * To achieve this, mac80211 uses filter flags (see below) to tell
1253 * the driver's configure_filter() function which frames should be
1254 * passed to mac80211 and which should be filtered out.
1255 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02001256 * Before configure_filter() is invoked, the prepare_multicast()
1257 * callback is invoked with the parameters @mc_count and @mc_list
1258 * for the combined multicast address list of all virtual interfaces.
1259 * It's use is optional, and it returns a u64 that is passed to
1260 * configure_filter(). Additionally, configure_filter() has the
1261 * arguments @changed_flags telling which flags were changed and
1262 * @total_flags with the new flag states.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001263 *
1264 * If your device has no multicast address filters your driver will
1265 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1266 * parameter to see whether multicast frames should be accepted
1267 * or dropped.
1268 *
Michael Bueschd0f5afb2008-02-12 20:12:45 +01001269 * All unsupported flags in @total_flags must be cleared.
1270 * Hardware does not support a flag if it is incapable of _passing_
1271 * the frame to the stack. Otherwise the driver must ignore
1272 * the flag, but not clear it.
1273 * You must _only_ clear the flag (announce no support for the
1274 * flag to mac80211) if you are not able to pass the packet type
1275 * to the stack (so the hardware always filters it).
1276 * So for example, you should clear @FIF_CONTROL, if your hardware
1277 * always filters control frames. If your hardware always passes
1278 * control frames to the kernel and is incapable of filtering them,
1279 * you do _not_ clear the @FIF_CONTROL flag.
1280 * This rule applies to all other FIF flags as well.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001281 */
1282
1283/**
1284 * enum ieee80211_filter_flags - hardware filter flags
1285 *
1286 * These flags determine what the filter in hardware should be
1287 * programmed to let through and what should not be passed to the
1288 * stack. It is always safe to pass more frames than requested,
1289 * but this has negative impact on power consumption.
1290 *
1291 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1292 * think of the BSS as your network segment and then this corresponds
1293 * to the regular ethernet device promiscuous mode.
1294 *
1295 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1296 * by the user or if the hardware is not capable of filtering by
1297 * multicast address.
1298 *
1299 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1300 * %RX_FLAG_FAILED_FCS_CRC for them)
1301 *
1302 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1303 * the %RX_FLAG_FAILED_PLCP_CRC for them
1304 *
1305 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1306 * to the hardware that it should not filter beacons or probe responses
1307 * by BSSID. Filtering them can greatly reduce the amount of processing
1308 * mac80211 needs to do and the amount of CPU wakeups, so you should
1309 * honour this flag if possible.
1310 *
Igor Perminove3b90ca2009-08-04 16:48:51 +04001311 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
1312 * is not set then only those addressed to this station.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001313 *
1314 * @FIF_OTHER_BSS: pass frames destined to other BSSes
Igor Perminove3b90ca2009-08-04 16:48:51 +04001315 *
1316 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1317 * those addressed to this station.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001318 */
1319enum ieee80211_filter_flags {
1320 FIF_PROMISC_IN_BSS = 1<<0,
1321 FIF_ALLMULTI = 1<<1,
1322 FIF_FCSFAIL = 1<<2,
1323 FIF_PLCPFAIL = 1<<3,
1324 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1325 FIF_CONTROL = 1<<5,
1326 FIF_OTHER_BSS = 1<<6,
Igor Perminove3b90ca2009-08-04 16:48:51 +04001327 FIF_PSPOLL = 1<<7,
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001328};
1329
1330/**
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001331 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1332 *
1333 * These flags are used with the ampdu_action() callback in
1334 * &struct ieee80211_ops to indicate which action is needed.
Johannes Berg827d42c2009-11-22 12:28:41 +01001335 *
1336 * Note that drivers MUST be able to deal with a TX aggregation
1337 * session being stopped even before they OK'ed starting it by
1338 * calling ieee80211_start_tx_ba_cb(_irqsafe), because the peer
1339 * might receive the addBA frame and send a delBA right away!
1340 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001341 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1342 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001343 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1344 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
Johannes Bergb1720232009-03-23 17:28:39 +01001345 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001346 */
1347enum ieee80211_ampdu_mlme_action {
1348 IEEE80211_AMPDU_RX_START,
1349 IEEE80211_AMPDU_RX_STOP,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001350 IEEE80211_AMPDU_TX_START,
1351 IEEE80211_AMPDU_TX_STOP,
Johannes Bergb1720232009-03-23 17:28:39 +01001352 IEEE80211_AMPDU_TX_OPERATIONAL,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001353};
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001354
1355/**
1356 * struct ieee80211_ops - callbacks from mac80211 to the driver
1357 *
1358 * This structure contains various callbacks that the driver may
1359 * handle or, in some cases, must handle, for example to configure
1360 * the hardware to a new channel or to transmit a frame.
1361 *
1362 * @tx: Handler that 802.11 module calls for each transmitted frame.
1363 * skb contains the buffer starting from the IEEE 802.11 header.
1364 * The low-level driver should send the frame out based on
Johannes Bergeefce912008-05-17 00:57:13 +02001365 * configuration in the TX control data. This handler should,
1366 * preferably, never fail and stop queues appropriately, more
1367 * importantly, however, it must never fail for A-MPDU-queues.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001368 * This function should return NETDEV_TX_OK except in very
1369 * limited cases.
Johannes Bergeefce912008-05-17 00:57:13 +02001370 * Must be implemented and atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001371 *
1372 * @start: Called before the first netdevice attached to the hardware
1373 * is enabled. This should turn on the hardware and must turn on
1374 * frame reception (for possibly enabled monitor interfaces.)
1375 * Returns negative error codes, these may be seen in userspace,
1376 * or zero.
1377 * When the device is started it should not have a MAC address
1378 * to avoid acknowledging frames before a non-monitor device
1379 * is added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001380 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001381 *
1382 * @stop: Called after last netdevice attached to the hardware
1383 * is disabled. This should turn off the hardware (at least
1384 * it must turn off frame reception.)
1385 * May be called right after add_interface if that rejects
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04001386 * an interface. If you added any work onto the mac80211 workqueue
1387 * you should ensure to cancel it on this callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001388 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001389 *
1390 * @add_interface: Called when a netdevice attached to the hardware is
Bob Copelande37d4df2008-10-20 21:20:27 -04001391 * enabled. Because it is not called for monitor mode devices, @start
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001392 * and @stop must be implemented.
1393 * The driver should perform any initialization it needs before
1394 * the device can be enabled. The initial configuration for the
1395 * interface is given in the conf parameter.
1396 * The callback may refuse to add an interface by returning a
1397 * negative error code (which will be seen in userspace.)
Kalle Valoe1781ed2009-12-23 13:15:47 +01001398 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001399 *
1400 * @remove_interface: Notifies a driver that an interface is going down.
1401 * The @stop callback is called after this if it is the last interface
1402 * and no monitor interfaces are present.
1403 * When all interfaces are removed, the MAC address in the hardware
1404 * must be cleared so the device no longer acknowledges packets,
1405 * the mac_addr member of the conf structure is, however, set to the
1406 * MAC address of the device going away.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001407 * Hence, this callback must be implemented. It can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001408 *
1409 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1410 * function to change hardware configuration, e.g., channel.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001411 * This function should never fail but returns a negative error code
Kalle Valoe1781ed2009-12-23 13:15:47 +01001412 * if it does. The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001413 *
Johannes Berg471b3ef2007-12-28 14:32:58 +01001414 * @bss_info_changed: Handler for configuration requests related to BSS
1415 * parameters that may vary during BSS's lifespan, and may affect low
1416 * level driver (e.g. assoc/disassoc status, erp parameters).
1417 * This function should not be used if no BSS has been set, unless
1418 * for association indication. The @changed parameter indicates which
Kalle Valoe1781ed2009-12-23 13:15:47 +01001419 * of the bss parameters has changed when a call is made. The callback
1420 * can sleep.
Johannes Berg471b3ef2007-12-28 14:32:58 +01001421 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02001422 * @prepare_multicast: Prepare for multicast filter configuration.
1423 * This callback is optional, and its return value is passed
1424 * to configure_filter(). This callback must be atomic.
1425 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001426 * @configure_filter: Configure the device's RX filter.
1427 * See the section "Frame filtering" for more information.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001428 * This callback must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001429 *
Luis R. Rodriguez546c80c2008-08-14 11:43:20 -07001430 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
Johannes Berg17741cd2008-09-11 00:02:02 +02001431 * must be set or cleared for a given STA. Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001432 *
1433 * @set_key: See the section "Hardware crypto acceleration"
Kalle Valoe1781ed2009-12-23 13:15:47 +01001434 * This callback is only called between add_interface and
1435 * remove_interface calls, i.e. while the given virtual interface
Johannes Bergdc822b52008-12-29 12:55:09 +01001436 * is enabled.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001437 * Returns a negative error code if the key can't be added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001438 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001439 *
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001440 * @update_tkip_key: See the section "Hardware crypto acceleration"
1441 * This callback will be called in the context of Rx. Called for drivers
1442 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001443 * The callback can sleep.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001444 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001445 * @hw_scan: Ask the hardware to service the scan request, no need to start
Johannes Berg8318d782008-01-24 19:38:38 +01001446 * the scan state machine in stack. The scan must honour the channel
Kalle Valo9050bdd2009-03-22 21:57:21 +02001447 * configuration done by the regulatory agent in the wiphy's
1448 * registered bands. The hardware (or the driver) needs to make sure
Johannes Bergde95a542009-04-01 11:58:36 +02001449 * that power save is disabled.
1450 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1451 * entire IEs after the SSID, so that drivers need not look at these
1452 * at all but just send them after the SSID -- mac80211 includes the
1453 * (extended) supported rates and HT information (where applicable).
1454 * When the scan finishes, ieee80211_scan_completed() must be called;
1455 * note that it also must be called when the scan cannot finish due to
1456 * any error unless this callback returned a negative error code.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001457 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001458 *
Michael Buesch80e775b2009-02-20 15:37:03 +01001459 * @sw_scan_start: Notifier function that is called just before a software scan
1460 * is started. Can be NULL, if the driver doesn't need this notification.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001461 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01001462 *
Kalle Valoe1781ed2009-12-23 13:15:47 +01001463 * @sw_scan_complete: Notifier function that is called just after a
1464 * software scan finished. Can be NULL, if the driver doesn't need
1465 * this notification.
1466 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01001467 *
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001468 * @get_stats: Return low-level statistics.
1469 * Returns zero if statistics are available.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001470 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001471 *
Johannes Berg62da92f2007-12-19 02:03:31 +01001472 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1473 * callback should be provided to read the TKIP transmit IVs (both IV32
1474 * and IV16) for the given key from hardware.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001475 * The callback must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001476 *
1477 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
Kalle Valoe1781ed2009-12-23 13:15:47 +01001478 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001479 *
Christian Lamparter89fad572008-12-09 16:28:06 +01001480 * @sta_notify: Notifies low level driver about addition, removal or power
1481 * state transition of an associated station, AP, IBSS/WDS/mesh peer etc.
1482 * Must be atomic.
Christian Lamparter4571d3b2008-11-30 00:48:41 +01001483 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001484 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
Johannes Bergfe3fa822008-09-08 11:05:09 +02001485 * bursting) for a hardware TX queue.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001486 * Returns a negative error code on failure.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001487 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001488 *
1489 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1490 * to get number of currently queued packets (queue length), maximum queue
1491 * size (limit), and total number of packets sent using each TX queue
Johannes Berge4e72fb2009-03-23 17:28:42 +01001492 * (count). The 'stats' pointer points to an array that has hw->queues
1493 * items.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001494 * The callback must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001495 *
1496 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001497 * this is only used for IBSS mode BSSID merging and debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001498 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001499 * The callback can sleep.
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001500 *
1501 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1502 * Currently, this is only used for IBSS mode debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001503 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001504 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001505 *
1506 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1507 * with other STAs in the IBSS. This is only used in IBSS mode. This
1508 * function is optional if the firmware/hardware takes full care of
1509 * TSF synchronization.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001510 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001511 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001512 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1513 * This is needed only for IBSS mode and the result of this function is
1514 * used to determine whether to reply to Probe Requests.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001515 * Returns non-zero if this device sent the last beacon.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001516 * The callback can sleep.
Ron Rindjunskyd3c990f2007-11-26 16:14:34 +02001517 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001518 * @ampdu_action: Perform a certain A-MPDU action
1519 * The RA/TID combination determines the destination and TID we want
1520 * the ampdu action to be performed for. The action is defined through
1521 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001522 * is the first frame we expect to perform the action on. Notice
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001523 * that TX/RX_STOP can pass NULL for this parameter.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001524 * Returns a negative error code on failure.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001525 * The callback must be atomic.
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001526 *
1527 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1528 * need to set wiphy->rfkill_poll to %true before registration,
1529 * and need to call wiphy_rfkill_set_hw_state() in the callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001530 * The callback can sleep.
Johannes Bergaff89a92009-07-01 21:26:51 +02001531 *
Lukáš Turek310bc672009-12-21 22:50:48 +01001532 * @set_coverage_class: Set slot time for given coverage class as specified
1533 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
1534 * accordingly. This callback is not required and may sleep.
1535 *
Johannes Bergaff89a92009-07-01 21:26:51 +02001536 * @testmode_cmd: Implement a cfg80211 test mode command.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001537 * The callback can sleep.
Johannes Berga80f7c02009-12-23 13:15:32 +01001538 *
1539 * @flush: Flush all pending frames from the hardware queue, making sure
1540 * that the hardware queues are empty. If the parameter @drop is set
Kalle Valoe1781ed2009-12-23 13:15:47 +01001541 * to %true, pending frames may be dropped. The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001542 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001543struct ieee80211_ops {
Johannes Berge039fa42008-05-15 12:55:29 +02001544 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg4150c572007-09-17 01:29:23 -04001545 int (*start)(struct ieee80211_hw *hw);
Johannes Berg4150c572007-09-17 01:29:23 -04001546 void (*stop)(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001547 int (*add_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01001548 struct ieee80211_vif *vif);
Jiri Bencf0706e822007-05-05 11:45:53 -07001549 void (*remove_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01001550 struct ieee80211_vif *vif);
Johannes Berge8975582008-10-09 12:18:51 +02001551 int (*config)(struct ieee80211_hw *hw, u32 changed);
Johannes Berg471b3ef2007-12-28 14:32:58 +01001552 void (*bss_info_changed)(struct ieee80211_hw *hw,
1553 struct ieee80211_vif *vif,
1554 struct ieee80211_bss_conf *info,
1555 u32 changed);
Johannes Berg3ac64be2009-08-17 16:16:53 +02001556 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
1557 int mc_count, struct dev_addr_list *mc_list);
Johannes Berg4150c572007-09-17 01:29:23 -04001558 void (*configure_filter)(struct ieee80211_hw *hw,
1559 unsigned int changed_flags,
1560 unsigned int *total_flags,
Johannes Berg3ac64be2009-08-17 16:16:53 +02001561 u64 multicast);
Johannes Berg17741cd2008-09-11 00:02:02 +02001562 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1563 bool set);
Johannes Bergea49c352007-09-18 17:29:21 -04001564 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
Johannes Bergdc822b52008-12-29 12:55:09 +01001565 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
Johannes Berg11a843b2007-08-28 17:01:55 -04001566 struct ieee80211_key_conf *key);
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001567 void (*update_tkip_key)(struct ieee80211_hw *hw,
1568 struct ieee80211_key_conf *conf, const u8 *address,
1569 u32 iv32, u16 *phase1key);
Johannes Berg2a519312009-02-10 21:25:55 +01001570 int (*hw_scan)(struct ieee80211_hw *hw,
1571 struct cfg80211_scan_request *req);
Michael Buesch80e775b2009-02-20 15:37:03 +01001572 void (*sw_scan_start)(struct ieee80211_hw *hw);
1573 void (*sw_scan_complete)(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001574 int (*get_stats)(struct ieee80211_hw *hw,
1575 struct ieee80211_low_level_stats *stats);
Johannes Berg62da92f2007-12-19 02:03:31 +01001576 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1577 u32 *iv32, u16 *iv16);
Jiri Bencf0706e822007-05-05 11:45:53 -07001578 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
Johannes Berg32bfd352007-12-19 01:31:26 +01001579 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02001580 enum sta_notify_cmd, struct ieee80211_sta *sta);
Johannes Berge100bb62008-04-30 18:51:21 +02001581 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
Jiri Bencf0706e822007-05-05 11:45:53 -07001582 const struct ieee80211_tx_queue_params *params);
Jiri Bencf0706e822007-05-05 11:45:53 -07001583 int (*get_tx_stats)(struct ieee80211_hw *hw,
1584 struct ieee80211_tx_queue_stats *stats);
Jiri Bencf0706e822007-05-05 11:45:53 -07001585 u64 (*get_tsf)(struct ieee80211_hw *hw);
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001586 void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf);
Jiri Bencf0706e822007-05-05 11:45:53 -07001587 void (*reset_tsf)(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001588 int (*tx_last_beacon)(struct ieee80211_hw *hw);
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001589 int (*ampdu_action)(struct ieee80211_hw *hw,
Johannes Bergc951ad32009-11-16 12:00:38 +01001590 struct ieee80211_vif *vif,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001591 enum ieee80211_ampdu_mlme_action action,
Johannes Berg17741cd2008-09-11 00:02:02 +02001592 struct ieee80211_sta *sta, u16 tid, u16 *ssn);
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001593
1594 void (*rfkill_poll)(struct ieee80211_hw *hw);
Lukáš Turek310bc672009-12-21 22:50:48 +01001595 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
Johannes Bergaff89a92009-07-01 21:26:51 +02001596#ifdef CONFIG_NL80211_TESTMODE
1597 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
1598#endif
Johannes Berga80f7c02009-12-23 13:15:32 +01001599 void (*flush)(struct ieee80211_hw *hw, bool drop);
Jiri Bencf0706e822007-05-05 11:45:53 -07001600};
1601
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001602/**
1603 * ieee80211_alloc_hw - Allocate a new hardware device
1604 *
1605 * This must be called once for each hardware device. The returned pointer
1606 * must be used to refer to this device when calling other functions.
1607 * mac80211 allocates a private data area for the driver pointed to by
1608 * @priv in &struct ieee80211_hw, the size of this area is given as
1609 * @priv_data_len.
1610 *
1611 * @priv_data_len: length of private data
1612 * @ops: callbacks for this device
Jiri Bencf0706e822007-05-05 11:45:53 -07001613 */
1614struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1615 const struct ieee80211_ops *ops);
1616
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001617/**
1618 * ieee80211_register_hw - Register hardware device
1619 *
Johannes Bergdbbea672008-02-26 14:34:06 +01001620 * You must call this function before any other functions in
1621 * mac80211. Note that before a hardware can be registered, you
1622 * need to fill the contained wiphy's information.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001623 *
1624 * @hw: the device to register as returned by ieee80211_alloc_hw()
1625 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001626int ieee80211_register_hw(struct ieee80211_hw *hw);
1627
Jiri Bencf0706e822007-05-05 11:45:53 -07001628#ifdef CONFIG_MAC80211_LEDS
1629extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1630extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
Michael Buesch47f0c502007-09-27 15:10:44 +02001631extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001632extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001633#endif
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001634/**
1635 * ieee80211_get_tx_led_name - get name of TX LED
1636 *
1637 * mac80211 creates a transmit LED trigger for each wireless hardware
1638 * that can be used to drive LEDs if your driver registers a LED device.
1639 * This function returns the name (or %NULL if not configured for LEDs)
1640 * of the trigger so you can automatically link the LED device.
1641 *
1642 * @hw: the hardware to get the LED trigger name for
1643 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001644static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1645{
1646#ifdef CONFIG_MAC80211_LEDS
1647 return __ieee80211_get_tx_led_name(hw);
1648#else
1649 return NULL;
1650#endif
1651}
1652
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001653/**
1654 * ieee80211_get_rx_led_name - get name of RX LED
1655 *
1656 * mac80211 creates a receive LED trigger for each wireless hardware
1657 * that can be used to drive LEDs if your driver registers a LED device.
1658 * This function returns the name (or %NULL if not configured for LEDs)
1659 * of the trigger so you can automatically link the LED device.
1660 *
1661 * @hw: the hardware to get the LED trigger name for
1662 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001663static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1664{
1665#ifdef CONFIG_MAC80211_LEDS
1666 return __ieee80211_get_rx_led_name(hw);
1667#else
1668 return NULL;
1669#endif
1670}
1671
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001672/**
1673 * ieee80211_get_assoc_led_name - get name of association LED
1674 *
1675 * mac80211 creates a association LED trigger for each wireless hardware
1676 * that can be used to drive LEDs if your driver registers a LED device.
1677 * This function returns the name (or %NULL if not configured for LEDs)
1678 * of the trigger so you can automatically link the LED device.
1679 *
1680 * @hw: the hardware to get the LED trigger name for
1681 */
Michael Buesch47f0c502007-09-27 15:10:44 +02001682static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1683{
1684#ifdef CONFIG_MAC80211_LEDS
1685 return __ieee80211_get_assoc_led_name(hw);
1686#else
1687 return NULL;
1688#endif
1689}
1690
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001691/**
1692 * ieee80211_get_radio_led_name - get name of radio LED
1693 *
1694 * mac80211 creates a radio change LED trigger for each wireless hardware
1695 * that can be used to drive LEDs if your driver registers a LED device.
1696 * This function returns the name (or %NULL if not configured for LEDs)
1697 * of the trigger so you can automatically link the LED device.
1698 *
1699 * @hw: the hardware to get the LED trigger name for
1700 */
1701static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1702{
1703#ifdef CONFIG_MAC80211_LEDS
1704 return __ieee80211_get_radio_led_name(hw);
1705#else
1706 return NULL;
1707#endif
1708}
Michael Buesch47f0c502007-09-27 15:10:44 +02001709
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001710/**
1711 * ieee80211_unregister_hw - Unregister a hardware device
1712 *
1713 * This function instructs mac80211 to free allocated resources
1714 * and unregister netdevices from the networking subsystem.
1715 *
1716 * @hw: the hardware to unregister
1717 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001718void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1719
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001720/**
1721 * ieee80211_free_hw - free hardware descriptor
1722 *
1723 * This function frees everything that was allocated, including the
1724 * private data for the driver. You must call ieee80211_unregister_hw()
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001725 * before calling this function.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001726 *
1727 * @hw: the hardware to free
1728 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001729void ieee80211_free_hw(struct ieee80211_hw *hw);
1730
Johannes Bergf2753dd2009-04-14 10:09:24 +02001731/**
1732 * ieee80211_restart_hw - restart hardware completely
1733 *
1734 * Call this function when the hardware was restarted for some reason
1735 * (hardware error, ...) and the driver is unable to restore its state
1736 * by itself. mac80211 assumes that at this point the driver/hardware
1737 * is completely uninitialised and stopped, it starts the process by
1738 * calling the ->start() operation. The driver will need to reset all
1739 * internal state that it has prior to calling this function.
1740 *
1741 * @hw: the hardware to restart
1742 */
1743void ieee80211_restart_hw(struct ieee80211_hw *hw);
1744
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001745/**
1746 * ieee80211_rx - receive frame
1747 *
1748 * Use this function to hand received frames to mac80211. The receive
Johannes Berg0869aea2009-10-28 10:03:35 +01001749 * buffer in @skb must start with an IEEE 802.11 header.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001750 *
Johannes Berg2485f712008-02-25 16:27:41 +01001751 * This function may not be called in IRQ context. Calls to this function
Kalle Valoe36e49f2009-10-13 20:33:13 +03001752 * for a single hardware must be synchronized against each other. Calls to
1753 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
1754 * mixed for a single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001755 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03001756 * In process context use instead ieee80211_rx_ni().
Johannes Bergd20ef632009-10-11 15:10:40 +02001757 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001758 * @hw: the hardware this frame came in on
1759 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001760 */
John W. Linville103bf9f2009-08-20 16:34:15 -04001761void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001762
1763/**
1764 * ieee80211_rx_irqsafe - receive frame
1765 *
1766 * Like ieee80211_rx() but can be called in IRQ context
Johannes Berg2485f712008-02-25 16:27:41 +01001767 * (internally defers to a tasklet.)
1768 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03001769 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
1770 * be mixed for a single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001771 *
1772 * @hw: the hardware this frame came in on
1773 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001774 */
Johannes Bergf1d58c22009-06-17 13:13:00 +02001775void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
Jiri Bencf0706e822007-05-05 11:45:53 -07001776
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001777/**
Kalle Valoe36e49f2009-10-13 20:33:13 +03001778 * ieee80211_rx_ni - receive frame (in process context)
1779 *
1780 * Like ieee80211_rx() but can be called in process context
1781 * (internally disables bottom halves).
1782 *
1783 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
1784 * not be mixed for a single hardware.
1785 *
1786 * @hw: the hardware this frame came in on
1787 * @skb: the buffer to receive, owned by mac80211 after this call
1788 */
1789static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
1790 struct sk_buff *skb)
1791{
1792 local_bh_disable();
1793 ieee80211_rx(hw, skb);
1794 local_bh_enable();
1795}
1796
Gertjan van Wingerded24deb22009-12-04 23:46:54 +01001797/*
1798 * The TX headroom reserved by mac80211 for its own tx_status functions.
1799 * This is enough for the radiotap header.
1800 */
1801#define IEEE80211_TX_STATUS_HEADROOM 13
1802
Kalle Valoe36e49f2009-10-13 20:33:13 +03001803/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001804 * ieee80211_tx_status - transmit status callback
1805 *
1806 * Call this function for all transmitted frames after they have been
1807 * transmitted. It is permissible to not call this function for
1808 * multicast frames but this can affect statistics.
1809 *
Johannes Berg2485f712008-02-25 16:27:41 +01001810 * This function may not be called in IRQ context. Calls to this function
1811 * for a single hardware must be synchronized against each other. Calls
1812 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1813 * for a single hardware.
1814 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001815 * @hw: the hardware the frame was transmitted by
1816 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001817 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001818void ieee80211_tx_status(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001819 struct sk_buff *skb);
Johannes Berg2485f712008-02-25 16:27:41 +01001820
1821/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001822 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
Johannes Berg2485f712008-02-25 16:27:41 +01001823 *
1824 * Like ieee80211_tx_status() but can be called in IRQ context
1825 * (internally defers to a tasklet.)
1826 *
1827 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1828 * single hardware.
1829 *
1830 * @hw: the hardware the frame was transmitted by
1831 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg2485f712008-02-25 16:27:41 +01001832 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001833void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001834 struct sk_buff *skb);
Jiri Bencf0706e822007-05-05 11:45:53 -07001835
1836/**
Johannes Bergeddcbb92009-10-29 08:30:35 +01001837 * ieee80211_beacon_get_tim - beacon generation function
1838 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01001839 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Bergeddcbb92009-10-29 08:30:35 +01001840 * @tim_offset: pointer to variable that will receive the TIM IE offset.
1841 * Set to 0 if invalid (in non-AP modes).
1842 * @tim_length: pointer to variable that will receive the TIM IE length,
1843 * (including the ID and length bytes!).
1844 * Set to 0 if invalid (in non-AP modes).
1845 *
1846 * If the driver implements beaconing modes, it must use this function to
1847 * obtain the beacon frame/template.
1848 *
1849 * If the beacon frames are generated by the host system (i.e., not in
1850 * hardware/firmware), the driver uses this function to get each beacon
1851 * frame from mac80211 -- it is responsible for calling this function
1852 * before the beacon is needed (e.g. based on hardware interrupt).
1853 *
1854 * If the beacon frames are generated by the device, then the driver
1855 * must use the returned beacon as the template and change the TIM IE
1856 * according to the current DTIM parameters/TIM bitmap.
1857 *
1858 * The driver is responsible for freeing the returned skb.
1859 */
1860struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
1861 struct ieee80211_vif *vif,
1862 u16 *tim_offset, u16 *tim_length);
1863
1864/**
Jiri Bencf0706e822007-05-05 11:45:53 -07001865 * ieee80211_beacon_get - beacon generation function
1866 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01001867 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07001868 *
Johannes Bergeddcbb92009-10-29 08:30:35 +01001869 * See ieee80211_beacon_get_tim().
Jiri Bencf0706e822007-05-05 11:45:53 -07001870 */
Johannes Bergeddcbb92009-10-29 08:30:35 +01001871static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1872 struct ieee80211_vif *vif)
1873{
1874 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
1875}
Jiri Bencf0706e822007-05-05 11:45:53 -07001876
1877/**
Kalle Valo7044cc52010-01-05 20:16:19 +02001878 * ieee80211_pspoll_get - retrieve a PS Poll template
1879 * @hw: pointer obtained from ieee80211_alloc_hw().
1880 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1881 *
1882 * Creates a PS Poll a template which can, for example, uploaded to
1883 * hardware. The template must be updated after association so that correct
1884 * AID, BSSID and MAC address is used.
1885 *
1886 * Note: Caller (or hardware) is responsible for setting the
1887 * &IEEE80211_FCTL_PM bit.
1888 */
1889struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
1890 struct ieee80211_vif *vif);
1891
1892/**
1893 * ieee80211_nullfunc_get - retrieve a nullfunc template
1894 * @hw: pointer obtained from ieee80211_alloc_hw().
1895 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1896 *
1897 * Creates a Nullfunc template which can, for example, uploaded to
1898 * hardware. The template must be updated after association so that correct
1899 * BSSID and address is used.
1900 *
1901 * Note: Caller (or hardware) is responsible for setting the
1902 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
1903 */
1904struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
1905 struct ieee80211_vif *vif);
1906
1907/**
Kalle Valo05e54ea2010-01-05 20:16:38 +02001908 * ieee80211_probereq_get - retrieve a Probe Request template
1909 * @hw: pointer obtained from ieee80211_alloc_hw().
1910 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1911 * @ssid: SSID buffer
1912 * @ssid_len: length of SSID
1913 * @ie: buffer containing all IEs except SSID for the template
1914 * @ie_len: length of the IE buffer
1915 *
1916 * Creates a Probe Request template which can, for example, be uploaded to
1917 * hardware.
1918 */
1919struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
1920 struct ieee80211_vif *vif,
1921 const u8 *ssid, size_t ssid_len,
1922 const u8 *ie, size_t ie_len);
1923
1924/**
Jiri Bencf0706e822007-05-05 11:45:53 -07001925 * ieee80211_rts_get - RTS frame generation function
1926 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01001927 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07001928 * @frame: pointer to the frame that is going to be protected by the RTS.
1929 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02001930 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07001931 * @rts: The buffer where to store the RTS frame.
1932 *
1933 * If the RTS frames are generated by the host system (i.e., not in
1934 * hardware/firmware), the low-level driver uses this function to receive
1935 * the next RTS frame from the 802.11 code. The low-level is responsible
1936 * for calling this function before and RTS frame is needed.
1937 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001938void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07001939 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001940 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e822007-05-05 11:45:53 -07001941 struct ieee80211_rts *rts);
1942
1943/**
1944 * ieee80211_rts_duration - Get the duration field for an RTS frame
1945 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01001946 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07001947 * @frame_len: the length of the frame that is going to be protected by the RTS.
Johannes Berge039fa42008-05-15 12:55:29 +02001948 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07001949 *
1950 * If the RTS is generated in firmware, but the host system must provide
1951 * the duration field, the low-level driver uses this function to receive
1952 * the duration field value in little-endian byteorder.
1953 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001954__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1955 struct ieee80211_vif *vif, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001956 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e822007-05-05 11:45:53 -07001957
1958/**
1959 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1960 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01001961 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07001962 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1963 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02001964 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07001965 * @cts: The buffer where to store the CTS-to-self frame.
1966 *
1967 * If the CTS-to-self frames are generated by the host system (i.e., not in
1968 * hardware/firmware), the low-level driver uses this function to receive
1969 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1970 * for calling this function before and CTS-to-self frame is needed.
1971 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001972void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1973 struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07001974 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001975 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e822007-05-05 11:45:53 -07001976 struct ieee80211_cts *cts);
1977
1978/**
1979 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1980 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01001981 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07001982 * @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 +02001983 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07001984 *
1985 * If the CTS-to-self is generated in firmware, but the host system must provide
1986 * the duration field, the low-level driver uses this function to receive
1987 * the duration field value in little-endian byteorder.
1988 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001989__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1990 struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07001991 size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001992 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e822007-05-05 11:45:53 -07001993
1994/**
1995 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1996 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01001997 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07001998 * @frame_len: the length of the frame.
Johannes Berg8318d782008-01-24 19:38:38 +01001999 * @rate: the rate at which the frame is going to be transmitted.
Jiri Bencf0706e822007-05-05 11:45:53 -07002000 *
2001 * Calculate the duration field of some generic frame, given its
2002 * length and transmission rate (in 100kbps).
2003 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002004__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
2005 struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07002006 size_t frame_len,
Johannes Berg8318d782008-01-24 19:38:38 +01002007 struct ieee80211_rate *rate);
Jiri Bencf0706e822007-05-05 11:45:53 -07002008
2009/**
2010 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
2011 * @hw: pointer as obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002012 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07002013 *
2014 * Function for accessing buffered broadcast and multicast frames. If
2015 * hardware/firmware does not implement buffering of broadcast/multicast
2016 * frames when power saving is used, 802.11 code buffers them in the host
2017 * memory. The low-level driver uses this function to fetch next buffered
2018 * frame. In most cases, this is used when generating beacon frame. This
2019 * function returns a pointer to the next buffered skb or NULL if no more
2020 * buffered frames are available.
2021 *
2022 * Note: buffered frames are returned only after DTIM beacon frame was
2023 * generated with ieee80211_beacon_get() and the low-level driver must thus
2024 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
2025 * NULL if the previous generated beacon was not DTIM, so the low-level driver
2026 * does not need to check for DTIM beacons separately and should be able to
2027 * use common code for all beacons.
2028 */
2029struct sk_buff *
Johannes Berge039fa42008-05-15 12:55:29 +02002030ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e822007-05-05 11:45:53 -07002031
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002032/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02002033 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
2034 *
2035 * This function computes a TKIP rc4 key for an skb. It computes
2036 * a phase 1 key if needed (iv16 wraps around). This function is to
2037 * be used by drivers which can do HW encryption but need to compute
2038 * to phase 1/2 key in SW.
2039 *
2040 * @keyconf: the parameter passed with the set key
2041 * @skb: the skb for which the key is needed
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002042 * @type: TBD
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002043 * @key: a buffer to which the key will be written
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02002044 */
2045void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
2046 struct sk_buff *skb,
2047 enum ieee80211_tkip_key_type type, u8 *key);
2048/**
Jiri Bencf0706e822007-05-05 11:45:53 -07002049 * ieee80211_wake_queue - wake specific queue
2050 * @hw: pointer as obtained from ieee80211_alloc_hw().
2051 * @queue: queue number (counted from zero).
2052 *
2053 * Drivers should use this function instead of netif_wake_queue.
2054 */
2055void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
2056
2057/**
2058 * ieee80211_stop_queue - stop specific queue
2059 * @hw: pointer as obtained from ieee80211_alloc_hw().
2060 * @queue: queue number (counted from zero).
2061 *
2062 * Drivers should use this function instead of netif_stop_queue.
2063 */
2064void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
2065
2066/**
Tomas Winkler92ab8532008-07-24 21:02:04 +03002067 * ieee80211_queue_stopped - test status of the queue
2068 * @hw: pointer as obtained from ieee80211_alloc_hw().
2069 * @queue: queue number (counted from zero).
2070 *
2071 * Drivers should use this function instead of netif_stop_queue.
2072 */
2073
2074int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
2075
2076/**
Jiri Bencf0706e822007-05-05 11:45:53 -07002077 * ieee80211_stop_queues - stop all queues
2078 * @hw: pointer as obtained from ieee80211_alloc_hw().
2079 *
2080 * Drivers should use this function instead of netif_stop_queue.
2081 */
2082void ieee80211_stop_queues(struct ieee80211_hw *hw);
2083
2084/**
2085 * ieee80211_wake_queues - wake all queues
2086 * @hw: pointer as obtained from ieee80211_alloc_hw().
2087 *
2088 * Drivers should use this function instead of netif_wake_queue.
2089 */
2090void ieee80211_wake_queues(struct ieee80211_hw *hw);
2091
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002092/**
2093 * ieee80211_scan_completed - completed hardware scan
2094 *
2095 * When hardware scan offload is used (i.e. the hw_scan() callback is
2096 * assigned) this function needs to be called by the driver to notify
2097 * mac80211 that the scan finished.
2098 *
2099 * @hw: the hardware that finished the scan
Johannes Berg2a519312009-02-10 21:25:55 +01002100 * @aborted: set to true if scan was aborted
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002101 */
Johannes Berg2a519312009-02-10 21:25:55 +01002102void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
Jiri Bencf0706e822007-05-05 11:45:53 -07002103
Johannes Bergdabeb342007-11-09 01:57:29 +01002104/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002105 * ieee80211_iterate_active_interfaces - iterate active interfaces
Johannes Bergdabeb342007-11-09 01:57:29 +01002106 *
2107 * This function iterates over the interfaces associated with a given
2108 * hardware that are currently active and calls the callback for them.
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002109 * This function allows the iterator function to sleep, when the iterator
2110 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
2111 * be used.
Johannes Bergdabeb342007-11-09 01:57:29 +01002112 *
2113 * @hw: the hardware struct of which the interfaces should be iterated over
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002114 * @iterator: the iterator function to call
Johannes Bergdabeb342007-11-09 01:57:29 +01002115 * @data: first argument of the iterator function
2116 */
2117void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
2118 void (*iterator)(void *data, u8 *mac,
Johannes Berg32bfd352007-12-19 01:31:26 +01002119 struct ieee80211_vif *vif),
Johannes Bergdabeb342007-11-09 01:57:29 +01002120 void *data);
2121
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002122/**
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002123 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
2124 *
2125 * This function iterates over the interfaces associated with a given
2126 * hardware that are currently active and calls the callback for them.
2127 * This function requires the iterator callback function to be atomic,
2128 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
2129 *
2130 * @hw: the hardware struct of which the interfaces should be iterated over
2131 * @iterator: the iterator function to call, cannot sleep
2132 * @data: first argument of the iterator function
2133 */
2134void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
2135 void (*iterator)(void *data,
2136 u8 *mac,
2137 struct ieee80211_vif *vif),
2138 void *data);
2139
2140/**
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04002141 * ieee80211_queue_work - add work onto the mac80211 workqueue
2142 *
2143 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
2144 * This helper ensures drivers are not queueing work when they should not be.
2145 *
2146 * @hw: the hardware struct for the interface we are adding work for
2147 * @work: the work we want to add onto the mac80211 workqueue
2148 */
2149void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
2150
2151/**
2152 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
2153 *
2154 * Drivers and mac80211 use this to queue delayed work onto the mac80211
2155 * workqueue.
2156 *
2157 * @hw: the hardware struct for the interface we are adding work for
2158 * @dwork: delayable work to queue onto the mac80211 workqueue
2159 * @delay: number of jiffies to wait before queueing
2160 */
2161void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
2162 struct delayed_work *dwork,
2163 unsigned long delay);
2164
2165/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002166 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01002167 * @sta: the station for which to start a BA session
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002168 * @tid: the TID to BA on.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002169 *
2170 * Return: success if addBA request was sent, failure otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002171 *
2172 * Although mac80211/low level driver/user space application can estimate
2173 * the need to start aggregation on a certain RA/TID, the session level
2174 * will be managed by the mac80211.
2175 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002176int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002177
2178/**
2179 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01002180 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002181 * @ra: receiver address of the BA session recipient.
2182 * @tid: the TID to BA on.
2183 *
2184 * This function must be called by low level driver once it has
2185 * finished with preparations for the BA session.
2186 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002187void ieee80211_start_tx_ba_cb(struct ieee80211_vif *vif, u8 *ra, u16 tid);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002188
2189/**
2190 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01002191 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002192 * @ra: receiver address of the BA session recipient.
2193 * @tid: the TID to BA on.
2194 *
2195 * This function must be called by low level driver once it has
2196 * finished with preparations for the BA session.
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002197 * This version of the function is IRQ-safe.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002198 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002199void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002200 u16 tid);
2201
2202/**
2203 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01002204 * @sta: the station whose BA session to stop
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002205 * @tid: the TID to stop BA.
2206 * @initiator: if indicates initiator DELBA frame will be sent.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002207 *
2208 * Return: error if no sta with matching da found, success otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002209 *
2210 * Although mac80211/low level driver/user space application can estimate
2211 * the need to stop aggregation on a certain RA/TID, the session level
2212 * will be managed by the mac80211.
2213 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002214int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002215 enum ieee80211_back_parties initiator);
2216
2217/**
2218 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01002219 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002220 * @ra: receiver address of the BA session recipient.
2221 * @tid: the desired TID to BA on.
2222 *
2223 * This function must be called by low level driver once it has
2224 * finished with preparations for the BA session tear down.
2225 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002226void ieee80211_stop_tx_ba_cb(struct ieee80211_vif *vif, u8 *ra, u8 tid);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002227
2228/**
2229 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01002230 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002231 * @ra: receiver address of the BA session recipient.
2232 * @tid: the desired TID to BA on.
2233 *
2234 * This function must be called by low level driver once it has
2235 * finished with preparations for the BA session tear down.
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002236 * This version of the function is IRQ-safe.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002237 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002238void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002239 u16 tid);
2240
Mohamed Abbas84363e62008-04-04 16:59:58 -07002241/**
Johannes Berg17741cd2008-09-11 00:02:02 +02002242 * ieee80211_find_sta - find a station
2243 *
Johannes Berg5ed176e2009-11-04 14:42:28 +01002244 * @vif: virtual interface to look for station on
Johannes Berg17741cd2008-09-11 00:02:02 +02002245 * @addr: station's address
2246 *
2247 * This function must be called under RCU lock and the
2248 * resulting pointer is only valid under RCU lock as well.
2249 */
Johannes Berg5ed176e2009-11-04 14:42:28 +01002250struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02002251 const u8 *addr);
2252
Kalle Valo04de8382009-03-22 21:57:35 +02002253/**
Johannes Berg5ed176e2009-11-04 14:42:28 +01002254 * ieee80211_find_sta_by_hw - find a station on hardware
2255 *
2256 * @hw: pointer as obtained from ieee80211_alloc_hw()
2257 * @addr: station's address
2258 *
2259 * This function must be called under RCU lock and the
2260 * resulting pointer is only valid under RCU lock as well.
2261 *
2262 * NOTE: This function should not be used! When mac80211 is converted
2263 * internally to properly keep track of stations on multiple
2264 * virtual interfaces, it will not always know which station to
2265 * return here since a single address might be used by multiple
2266 * logical stations (e.g. consider a station connecting to another
2267 * BSSID on the same AP hardware without disconnecting first).
2268 *
2269 * DO NOT USE THIS FUNCTION.
2270 */
2271struct ieee80211_sta *ieee80211_find_sta_by_hw(struct ieee80211_hw *hw,
2272 const u8 *addr);
2273
2274/**
Johannes Bergaf818582009-11-06 11:35:50 +01002275 * ieee80211_sta_block_awake - block station from waking up
2276 * @hw: the hardware
2277 * @pubsta: the station
2278 * @block: whether to block or unblock
2279 *
2280 * Some devices require that all frames that are on the queues
2281 * for a specific station that went to sleep are flushed before
2282 * a poll response or frames after the station woke up can be
2283 * delivered to that it. Note that such frames must be rejected
2284 * by the driver as filtered, with the appropriate status flag.
2285 *
2286 * This function allows implementing this mode in a race-free
2287 * manner.
2288 *
2289 * To do this, a driver must keep track of the number of frames
2290 * still enqueued for a specific station. If this number is not
2291 * zero when the station goes to sleep, the driver must call
2292 * this function to force mac80211 to consider the station to
2293 * be asleep regardless of the station's actual state. Once the
2294 * number of outstanding frames reaches zero, the driver must
2295 * call this function again to unblock the station. That will
2296 * cause mac80211 to be able to send ps-poll responses, and if
2297 * the station queried in the meantime then frames will also
2298 * be sent out as a result of this. Additionally, the driver
2299 * will be notified that the station woke up some time after
2300 * it is unblocked, regardless of whether the station actually
2301 * woke up while blocked or not.
2302 */
2303void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
2304 struct ieee80211_sta *pubsta, bool block);
2305
2306/**
Kalle Valo04de8382009-03-22 21:57:35 +02002307 * ieee80211_beacon_loss - inform hardware does not receive beacons
2308 *
Johannes Berg1ed32e42009-12-23 13:15:45 +01002309 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Kalle Valo04de8382009-03-22 21:57:35 +02002310 *
2311 * When beacon filtering is enabled with IEEE80211_HW_BEACON_FILTERING and
2312 * IEEE80211_CONF_PS is set, the driver needs to inform whenever the
2313 * hardware is not receiving beacons with this function.
2314 */
2315void ieee80211_beacon_loss(struct ieee80211_vif *vif);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002316
2317/* Rate control API */
Johannes Berge6a98542008-10-21 12:40:02 +02002318
Johannes Berg4b7679a2008-09-18 18:14:18 +02002319/**
Sujith81cb7622009-02-12 11:38:37 +05302320 * enum rate_control_changed - flags to indicate which parameter changed
2321 *
2322 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
2323 * changed, rate control algorithm can update its internal state if needed.
2324 */
2325enum rate_control_changed {
2326 IEEE80211_RC_HT_CHANGED = BIT(0)
2327};
2328
2329/**
Johannes Berge6a98542008-10-21 12:40:02 +02002330 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
Johannes Berg4b7679a2008-09-18 18:14:18 +02002331 *
Johannes Berge6a98542008-10-21 12:40:02 +02002332 * @hw: The hardware the algorithm is invoked for.
2333 * @sband: The band this frame is being transmitted on.
2334 * @bss_conf: the current BSS configuration
2335 * @reported_rate: The rate control algorithm can fill this in to indicate
2336 * which rate should be reported to userspace as the current rate and
2337 * used for rate calculations in the mesh network.
2338 * @rts: whether RTS will be used for this frame because it is longer than the
2339 * RTS threshold
2340 * @short_preamble: whether mac80211 will request short-preamble transmission
2341 * if the selected rate supports it
2342 * @max_rate_idx: user-requested maximum rate (not MCS for now)
Jouni Malinen37eb0b12010-01-06 13:09:08 +02002343 * (deprecated; this will be removed once drivers get updated to use
2344 * rate_idx_mask)
2345 * @rate_idx_mask: user-requested rate mask (not MCS for now)
Johannes Berge25cf4a2008-10-23 08:51:20 +02002346 * @skb: the skb that will be transmitted, the control information in it needs
2347 * to be filled in
Jouni Malinene00cfce2009-12-29 12:59:19 +02002348 * @ap: whether this frame is sent out in AP mode
Johannes Berg4b7679a2008-09-18 18:14:18 +02002349 */
Johannes Berge6a98542008-10-21 12:40:02 +02002350struct ieee80211_tx_rate_control {
2351 struct ieee80211_hw *hw;
2352 struct ieee80211_supported_band *sband;
2353 struct ieee80211_bss_conf *bss_conf;
2354 struct sk_buff *skb;
2355 struct ieee80211_tx_rate reported_rate;
2356 bool rts, short_preamble;
2357 u8 max_rate_idx;
Jouni Malinen37eb0b12010-01-06 13:09:08 +02002358 u32 rate_idx_mask;
Jouni Malinene00cfce2009-12-29 12:59:19 +02002359 bool ap;
Johannes Berg4b7679a2008-09-18 18:14:18 +02002360};
2361
2362struct rate_control_ops {
2363 struct module *module;
2364 const char *name;
2365 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002366 void (*free)(void *priv);
2367
2368 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
2369 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
2370 struct ieee80211_sta *sta, void *priv_sta);
Sujith81cb7622009-02-12 11:38:37 +05302371 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
2372 struct ieee80211_sta *sta,
2373 void *priv_sta, u32 changed);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002374 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
2375 void *priv_sta);
2376
2377 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
2378 struct ieee80211_sta *sta, void *priv_sta,
2379 struct sk_buff *skb);
Johannes Berge6a98542008-10-21 12:40:02 +02002380 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
2381 struct ieee80211_tx_rate_control *txrc);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002382
2383 void (*add_sta_debugfs)(void *priv, void *priv_sta,
2384 struct dentry *dir);
2385 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
2386};
2387
2388static inline int rate_supported(struct ieee80211_sta *sta,
2389 enum ieee80211_band band,
2390 int index)
2391{
2392 return (sta == NULL || sta->supp_rates[band] & BIT(index));
2393}
2394
Luis R. Rodriguez4c6d4f52009-07-16 10:05:41 -07002395/**
2396 * rate_control_send_low - helper for drivers for management/no-ack frames
2397 *
2398 * Rate control algorithms that agree to use the lowest rate to
2399 * send management frames and NO_ACK data with the respective hw
2400 * retries should use this in the beginning of their mac80211 get_rate
2401 * callback. If true is returned the rate control can simply return.
2402 * If false is returned we guarantee that sta and sta and priv_sta is
2403 * not null.
2404 *
2405 * Rate control algorithms wishing to do more intelligent selection of
2406 * rate for multicast/broadcast frames may choose to not use this.
2407 *
2408 * @sta: &struct ieee80211_sta pointer to the target destination. Note
2409 * that this may be null.
2410 * @priv_sta: private rate control structure. This may be null.
2411 * @txrc: rate control information we sholud populate for mac80211.
2412 */
2413bool rate_control_send_low(struct ieee80211_sta *sta,
2414 void *priv_sta,
2415 struct ieee80211_tx_rate_control *txrc);
2416
2417
Johannes Berg4b7679a2008-09-18 18:14:18 +02002418static inline s8
2419rate_lowest_index(struct ieee80211_supported_band *sband,
2420 struct ieee80211_sta *sta)
2421{
2422 int i;
2423
2424 for (i = 0; i < sband->n_bitrates; i++)
2425 if (rate_supported(sta, sband->band, i))
2426 return i;
2427
2428 /* warn when we cannot find a rate. */
2429 WARN_ON(1);
2430
2431 return 0;
2432}
2433
Luis R. Rodriguezb770b432009-07-16 10:15:09 -07002434static inline
2435bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
2436 struct ieee80211_sta *sta)
2437{
2438 unsigned int i;
2439
2440 for (i = 0; i < sband->n_bitrates; i++)
2441 if (rate_supported(sta, sband->band, i))
2442 return true;
2443 return false;
2444}
Johannes Berg4b7679a2008-09-18 18:14:18 +02002445
2446int ieee80211_rate_control_register(struct rate_control_ops *ops);
2447void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
2448
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002449static inline bool
2450conf_is_ht20(struct ieee80211_conf *conf)
2451{
Johannes Berg47979382009-01-07 10:13:27 +01002452 return conf->channel_type == NL80211_CHAN_HT20;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002453}
2454
2455static inline bool
2456conf_is_ht40_minus(struct ieee80211_conf *conf)
2457{
Johannes Berg47979382009-01-07 10:13:27 +01002458 return conf->channel_type == NL80211_CHAN_HT40MINUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002459}
2460
2461static inline bool
2462conf_is_ht40_plus(struct ieee80211_conf *conf)
2463{
Johannes Berg47979382009-01-07 10:13:27 +01002464 return conf->channel_type == NL80211_CHAN_HT40PLUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002465}
2466
2467static inline bool
2468conf_is_ht40(struct ieee80211_conf *conf)
2469{
2470 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
2471}
2472
2473static inline bool
2474conf_is_ht(struct ieee80211_conf *conf)
2475{
Johannes Berg47979382009-01-07 10:13:27 +01002476 return conf->channel_type != NL80211_CHAN_NO_HT;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002477}
2478
Jiri Bencf0706e822007-05-05 11:45:53 -07002479#endif /* MAC80211_H */