blob: 2aff4906b2aeec8011b9de98e744d0b396a8232e [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 Berg2b874e82009-03-23 14:10:22 +0100258 * @IEEE80211_TX_INTFL_RCALGO: mac80211 internal flag, do not test or
259 * set this flag in the driver; indicates that the rate control
260 * algorithm was used and should be notified of TX status
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100261 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
262 * used to indicate that a pending frame requires TX processing before
263 * it can be sent out.
Johannes Berg8f77f382009-06-07 21:58:37 +0200264 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
265 * used to indicate that a frame was already retried due to PS
Johannes Berg3b8d81e2009-06-17 17:43:56 +0200266 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
267 * used to indicate frame should not be encrypted
Johannes Berg3fa52052009-07-24 13:23:09 +0200268 * @IEEE80211_TX_CTL_PSPOLL_RESPONSE: (internal?)
269 * This frame is a response to a PS-poll frame and should be sent
270 * although the station is in powersave mode.
Johannes Bergad5351d2009-08-07 16:42:15 +0200271 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
272 * transmit function after the current frame, this can be used
273 * by drivers to kick the DMA queue only if unset or when the
274 * queue gets full.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800275 */
276enum mac80211_tx_control_flags {
Johannes Berge039fa42008-05-15 12:55:29 +0200277 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
Johannes Berge6a98542008-10-21 12:40:02 +0200278 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
279 IEEE80211_TX_CTL_NO_ACK = BIT(2),
280 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
281 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
282 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
283 IEEE80211_TX_CTL_AMPDU = BIT(6),
284 IEEE80211_TX_CTL_INJECTED = BIT(7),
285 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
286 IEEE80211_TX_STAT_ACK = BIT(9),
287 IEEE80211_TX_STAT_AMPDU = BIT(10),
288 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
289 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
Johannes Berg2b874e82009-03-23 14:10:22 +0100290 IEEE80211_TX_INTFL_RCALGO = BIT(13),
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100291 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
Johannes Berg8f77f382009-06-07 21:58:37 +0200292 IEEE80211_TX_INTFL_RETRIED = BIT(15),
Johannes Berg3b8d81e2009-06-17 17:43:56 +0200293 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
Johannes Berg3fa52052009-07-24 13:23:09 +0200294 IEEE80211_TX_CTL_PSPOLL_RESPONSE = BIT(17),
Johannes Bergad5351d2009-08-07 16:42:15 +0200295 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
Johannes Berge6a98542008-10-21 12:40:02 +0200296};
297
Sujith2134e7e2009-01-22 09:00:52 +0530298/**
299 * enum mac80211_rate_control_flags - per-rate flags set by the
300 * Rate Control algorithm.
301 *
302 * These flags are set by the Rate control algorithm for each rate during tx,
303 * in the @flags member of struct ieee80211_tx_rate.
304 *
305 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
306 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
307 * This is set if the current BSS requires ERP protection.
308 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
309 * @IEEE80211_TX_RC_MCS: HT rate.
310 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
311 * Greenfield mode.
312 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
313 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
314 * adjacent 20 MHz channels, if the current channel type is
315 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
316 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
317 */
Johannes Berge6a98542008-10-21 12:40:02 +0200318enum mac80211_rate_control_flags {
319 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
320 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
321 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
322
323 /* rate index is an MCS rate number instead of an index */
324 IEEE80211_TX_RC_MCS = BIT(3),
325 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
326 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
327 IEEE80211_TX_RC_DUP_DATA = BIT(6),
328 IEEE80211_TX_RC_SHORT_GI = BIT(7),
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800329};
330
Johannes Berge039fa42008-05-15 12:55:29 +0200331
Johannes Berge6a98542008-10-21 12:40:02 +0200332/* there are 40 bytes if you don't need the rateset to be kept */
333#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
Johannes Berge039fa42008-05-15 12:55:29 +0200334
Johannes Berge6a98542008-10-21 12:40:02 +0200335/* if you do need the rateset, then you have less space */
336#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
337
338/* maximum number of rate stages */
339#define IEEE80211_TX_MAX_RATES 5
Felix Fietkau870abdf2008-10-05 18:04:24 +0200340
341/**
Johannes Berge6a98542008-10-21 12:40:02 +0200342 * struct ieee80211_tx_rate - rate selection/status
Felix Fietkau870abdf2008-10-05 18:04:24 +0200343 *
Johannes Berge6a98542008-10-21 12:40:02 +0200344 * @idx: rate index to attempt to send with
345 * @flags: rate control flags (&enum mac80211_rate_control_flags)
Johannes Berge25cf4a2008-10-23 08:51:20 +0200346 * @count: number of tries in this rate before going to the next rate
Johannes Berge6a98542008-10-21 12:40:02 +0200347 *
348 * A value of -1 for @idx indicates an invalid rate and, if used
349 * in an array of retry rates, that no more rates should be tried.
350 *
351 * When used for transmit status reporting, the driver should
352 * always report the rate along with the flags it used.
Johannes Bergc555b9b2009-08-07 16:23:43 +0200353 *
354 * &struct ieee80211_tx_info contains an array of these structs
355 * in the control information, and it will be filled by the rate
356 * control algorithm according to what should be sent. For example,
357 * if this array contains, in the format { <idx>, <count> } the
358 * information
359 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
360 * then this means that the frame should be transmitted
361 * up to twice at rate 3, up to twice at rate 2, and up to four
362 * times at rate 1 if it doesn't get acknowledged. Say it gets
363 * acknowledged by the peer after the fifth attempt, the status
364 * information should then contain
365 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
366 * since it was transmitted twice at rate 3, twice at rate 2
367 * and once at rate 1 after which we received an acknowledgement.
Felix Fietkau870abdf2008-10-05 18:04:24 +0200368 */
Johannes Berge6a98542008-10-21 12:40:02 +0200369struct ieee80211_tx_rate {
370 s8 idx;
371 u8 count;
372 u8 flags;
Felix Fietkau48212772008-11-03 21:05:01 +0100373} __attribute__((packed));
Felix Fietkau870abdf2008-10-05 18:04:24 +0200374
Johannes Berge039fa42008-05-15 12:55:29 +0200375/**
376 * struct ieee80211_tx_info - skb transmit information
Ivo van Doorn1c014422008-04-17 19:41:02 +0200377 *
Johannes Berge039fa42008-05-15 12:55:29 +0200378 * This structure is placed in skb->cb for three uses:
379 * (1) mac80211 TX control - mac80211 tells the driver what to do
380 * (2) driver internal use (if applicable)
381 * (3) TX status information - driver tells mac80211 what happened
382 *
Johannes Berg17741cd2008-09-11 00:02:02 +0200383 * The TX control's sta pointer is only valid during the ->tx call,
384 * it may be NULL.
385 *
Johannes Berge039fa42008-05-15 12:55:29 +0200386 * @flags: transmit info flags, defined above
Johannes Berge6a98542008-10-21 12:40:02 +0200387 * @band: the band to transmit on (use for checking for races)
Johannes Berg0f4ac382008-10-09 12:18:04 +0200388 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
Kalle Valo8bef7a12008-11-30 20:56:28 +0200389 * @pad: padding, ignore
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700390 * @control: union for control data
391 * @status: union for status data
392 * @driver_data: array of driver_data pointers
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100393 * @ampdu_ack_len: number of acked aggregated frames.
Johannes Berge039fa42008-05-15 12:55:29 +0200394 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
395 * @ampdu_ack_map: block ack bit map for the aggregation.
396 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100397 * @ampdu_len: number of aggregated frames.
398 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
Johannes Berge039fa42008-05-15 12:55:29 +0200399 * @ack_signal: signal strength of the ACK frame
Ivo van Doorn1c014422008-04-17 19:41:02 +0200400 */
Johannes Berge039fa42008-05-15 12:55:29 +0200401struct ieee80211_tx_info {
402 /* common information */
403 u32 flags;
404 u8 band;
Johannes Berge6a98542008-10-21 12:40:02 +0200405
Johannes Berge039fa42008-05-15 12:55:29 +0200406 u8 antenna_sel_tx;
Johannes Berg8318d782008-01-24 19:38:38 +0100407
Johannes Berge6a98542008-10-21 12:40:02 +0200408 /* 2 byte hole */
John W. Linville62727102008-11-12 10:01:41 -0500409 u8 pad[2];
Johannes Berg8318d782008-01-24 19:38:38 +0100410
Johannes Berge039fa42008-05-15 12:55:29 +0200411 union {
412 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200413 union {
414 /* rate control */
415 struct {
416 struct ieee80211_tx_rate rates[
417 IEEE80211_TX_MAX_RATES];
418 s8 rts_cts_rate_idx;
419 };
420 /* only needed before rate control */
421 unsigned long jiffies;
422 };
Johannes Berg25d834e2008-09-12 22:52:47 +0200423 /* NB: vif can be NULL for injected frames */
Johannes Berge039fa42008-05-15 12:55:29 +0200424 struct ieee80211_vif *vif;
425 struct ieee80211_key_conf *hw_key;
Johannes Berg17741cd2008-09-11 00:02:02 +0200426 struct ieee80211_sta *sta;
Johannes Berge039fa42008-05-15 12:55:29 +0200427 } control;
428 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200429 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
430 u8 ampdu_ack_len;
Johannes Berge039fa42008-05-15 12:55:29 +0200431 u64 ampdu_ack_map;
432 int ack_signal;
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100433 u8 ampdu_len;
434 /* 7 bytes free */
Johannes Berge039fa42008-05-15 12:55:29 +0200435 } status;
Johannes Berge6a98542008-10-21 12:40:02 +0200436 struct {
437 struct ieee80211_tx_rate driver_rates[
438 IEEE80211_TX_MAX_RATES];
439 void *rate_driver_data[
440 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
441 };
442 void *driver_data[
443 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
Johannes Berge039fa42008-05-15 12:55:29 +0200444 };
Jiri Bencf0706e822007-05-05 11:45:53 -0700445};
446
Johannes Berge039fa42008-05-15 12:55:29 +0200447static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
448{
449 return (struct ieee80211_tx_info *)skb->cb;
450}
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400451
Johannes Bergf1d58c22009-06-17 13:13:00 +0200452static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
453{
454 return (struct ieee80211_rx_status *)skb->cb;
455}
456
Johannes Berge6a98542008-10-21 12:40:02 +0200457/**
458 * ieee80211_tx_info_clear_status - clear TX status
459 *
460 * @info: The &struct ieee80211_tx_info to be cleared.
461 *
462 * When the driver passes an skb back to mac80211, it must report
463 * a number of things in TX status. This function clears everything
464 * in the TX status but the rate control information (it does clear
465 * the count since you need to fill that in anyway).
466 *
467 * NOTE: You can only use this function if you do NOT use
468 * info->driver_data! Use info->rate_driver_data
469 * instead if you need only the less space that allows.
470 */
471static inline void
472ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
473{
474 int i;
475
476 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
477 offsetof(struct ieee80211_tx_info, control.rates));
478 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
479 offsetof(struct ieee80211_tx_info, driver_rates));
480 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
481 /* clear the rate counts */
482 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
483 info->status.rates[i].count = 0;
484
485 BUILD_BUG_ON(
486 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
487 memset(&info->status.ampdu_ack_len, 0,
488 sizeof(struct ieee80211_tx_info) -
489 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
490}
491
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400492
493/**
494 * enum mac80211_rx_flags - receive flags
495 *
496 * These flags are used with the @flag member of &struct ieee80211_rx_status.
497 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
498 * Use together with %RX_FLAG_MMIC_STRIPPED.
499 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400500 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
501 * verification has been done by the hardware.
502 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
503 * If this flag is set, the stack cannot do any replay detection
504 * hence the driver or hardware will have to do that.
Johannes Berg72abd812007-09-17 01:29:22 -0400505 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
506 * the frame.
507 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
508 * the frame.
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100509 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
Bruno Randolf9d9bf772008-02-18 11:21:36 +0900510 * is valid. This is useful in monitor mode and necessary for beacon frames
511 * to enable IBSS merging.
Bruno Randolfb4f28bb2008-07-30 17:19:55 +0200512 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200513 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
514 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
515 * @RX_FLAG_SHORT_GI: Short guard interval was used
Johannes Berg8c0c7092009-11-25 17:46:15 +0100516 * @RX_FLAG_INTERNAL_CMTR: set internally after frame was reported
517 * on cooked monitor to avoid double-reporting it for multiple
518 * virtual interfaces
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400519 */
520enum mac80211_rx_flags {
521 RX_FLAG_MMIC_ERROR = 1<<0,
522 RX_FLAG_DECRYPTED = 1<<1,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400523 RX_FLAG_MMIC_STRIPPED = 1<<3,
524 RX_FLAG_IV_STRIPPED = 1<<4,
Johannes Berg72abd812007-09-17 01:29:22 -0400525 RX_FLAG_FAILED_FCS_CRC = 1<<5,
526 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100527 RX_FLAG_TSFT = 1<<7,
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200528 RX_FLAG_SHORTPRE = 1<<8,
529 RX_FLAG_HT = 1<<9,
530 RX_FLAG_40MHZ = 1<<10,
531 RX_FLAG_SHORT_GI = 1<<11,
Johannes Berg8c0c7092009-11-25 17:46:15 +0100532 RX_FLAG_INTERNAL_CMTR = 1<<12,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400533};
534
535/**
536 * struct ieee80211_rx_status - receive status
537 *
538 * The low-level driver should provide this information (the subset
539 * supported by hardware) to the 802.11 code with each received
Johannes Bergf1d58c22009-06-17 13:13:00 +0200540 * frame, in the skb's control buffer (cb).
Bruno Randolf566bfe52008-05-08 19:15:40 +0200541 *
Bruno Randolfc132bec2008-02-18 11:20:51 +0900542 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
543 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
Johannes Berg8318d782008-01-24 19:38:38 +0100544 * @band: the active band when this frame was received
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400545 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
Bruno Randolf566bfe52008-05-08 19:15:40 +0200546 * @signal: signal strength when receiving this frame, either in dBm, in dB or
547 * unspecified depending on the hardware capabilities flags
548 * @IEEE80211_HW_SIGNAL_*
549 * @noise: noise when receiving this frame, in dBm.
550 * @qual: overall signal quality indication, in percent (0-100).
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400551 * @antenna: antenna used
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200552 * @rate_idx: index of data rate into band's supported rates or MCS index if
553 * HT rates are use (RX_FLAG_HT)
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400554 * @flag: %RX_FLAG_*
555 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700556struct ieee80211_rx_status {
557 u64 mactime;
Johannes Berg8318d782008-01-24 19:38:38 +0100558 enum ieee80211_band band;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400559 int freq;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400560 int signal;
Jiri Bencf0706e822007-05-05 11:45:53 -0700561 int noise;
Johannes Bergc27f2fd2009-10-29 08:41:25 +0100562 int __deprecated qual;
Jiri Bencf0706e822007-05-05 11:45:53 -0700563 int antenna;
Johannes Berg8318d782008-01-24 19:38:38 +0100564 int rate_idx;
Jiri Bencf0706e822007-05-05 11:45:53 -0700565 int flag;
566};
567
Johannes Berg6b301cd2007-09-18 17:29:20 -0400568/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400569 * enum ieee80211_conf_flags - configuration flags
570 *
571 * Flags to define PHY configuration options
572 *
Johannes Berg0869aea2009-10-28 10:03:35 +0100573 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
574 * to determine for example whether to calculate timestamps for packets
575 * or not, do not use instead of filter flags!
Johannes Berg04fe2032009-04-22 18:44:37 +0200576 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only)
Johannes Berg5cff20e2009-04-29 12:26:17 +0200577 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
578 * the driver should be prepared to handle configuration requests but
579 * may turn the device off as much as possible. Typically, this flag will
580 * be set when an interface is set UP but not associated or scanning, but
581 * it can also be unset in that case when monitor interfaces are active.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400582 */
583enum ieee80211_conf_flags {
Johannes Berg0869aea2009-10-28 10:03:35 +0100584 IEEE80211_CONF_MONITOR = (1<<0),
Johannes Bergae5eb022008-10-14 16:58:37 +0200585 IEEE80211_CONF_PS = (1<<1),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200586 IEEE80211_CONF_IDLE = (1<<2),
Johannes Berg6b301cd2007-09-18 17:29:20 -0400587};
Jiri Bencf0706e822007-05-05 11:45:53 -0700588
Johannes Berg7a5158e2008-10-08 10:59:33 +0200589
Jiri Bencf0706e822007-05-05 11:45:53 -0700590/**
Johannes Berge8975582008-10-09 12:18:51 +0200591 * enum ieee80211_conf_changed - denotes which configuration changed
592 *
Johannes Berge8975582008-10-09 12:18:51 +0200593 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
Johannes Berg0869aea2009-10-28 10:03:35 +0100594 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
Johannes Berge255d5e2009-04-22 12:40:07 +0200595 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
Johannes Berge8975582008-10-09 12:18:51 +0200596 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
Johannes Berg47979382009-01-07 10:13:27 +0100597 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
Johannes Berg9124b072008-10-14 19:17:54 +0200598 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
Johannes Berg5cff20e2009-04-29 12:26:17 +0200599 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
Johannes Berge8975582008-10-09 12:18:51 +0200600 */
601enum ieee80211_conf_changed {
Johannes Berge8975582008-10-09 12:18:51 +0200602 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
Johannes Berg0869aea2009-10-28 10:03:35 +0100603 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
Johannes Berge8975582008-10-09 12:18:51 +0200604 IEEE80211_CONF_CHANGE_PS = BIT(4),
Johannes Berge255d5e2009-04-22 12:40:07 +0200605 IEEE80211_CONF_CHANGE_POWER = BIT(5),
606 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
607 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200608 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
Johannes Berge8975582008-10-09 12:18:51 +0200609};
610
611/**
Jiri Bencf0706e822007-05-05 11:45:53 -0700612 * struct ieee80211_conf - configuration of the device
613 *
614 * This struct indicates how the driver shall configure the hardware.
615 *
Johannes Berg04fe2032009-04-22 18:44:37 +0200616 * @flags: configuration flags defined above
617 *
Tomas Winklerea95bba2008-07-18 13:53:00 +0800618 * @listen_interval: listen interval in units of beacon interval
Johannes Berg9ccebe62009-04-23 10:32:36 +0200619 * @max_sleep_period: the maximum number of beacon intervals to sleep for
Johannes Berg04fe2032009-04-22 18:44:37 +0200620 * before checking the beacon for a TIM bit (managed mode only); this
621 * value will be only achievable between DTIM frames, the hardware
622 * needs to check for the multicast traffic bit in DTIM beacons.
623 * This variable is valid only when the CONF_PS flag is set.
624 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
625 * powersave documentation below. This variable is valid only when
626 * the CONF_PS flag is set.
627 *
Johannes Berg8318d782008-01-24 19:38:38 +0100628 * @power_level: requested transmit power (in dBm)
Johannes Berg04fe2032009-04-22 18:44:37 +0200629 *
Johannes Berg8318d782008-01-24 19:38:38 +0100630 * @channel: the channel to tune to
Johannes Berg47979382009-01-07 10:13:27 +0100631 * @channel_type: the channel (HT) type
Johannes Berg04fe2032009-04-22 18:44:37 +0200632 *
Johannes Berg9124b072008-10-14 19:17:54 +0200633 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
634 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
635 * but actually means the number of transmissions not the number of retries
636 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
637 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
638 * number of transmissions not the number of retries
Jiri Bencf0706e822007-05-05 11:45:53 -0700639 */
640struct ieee80211_conf {
Johannes Berg6b301cd2007-09-18 17:29:20 -0400641 u32 flags;
Johannes Berg46f2c4b2009-01-06 18:13:18 +0100642 int power_level, dynamic_ps_timeout;
Johannes Berg9ccebe62009-04-23 10:32:36 +0200643 int max_sleep_period;
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200644
Johannes Berge8975582008-10-09 12:18:51 +0200645 u16 listen_interval;
Johannes Berge8975582008-10-09 12:18:51 +0200646
Johannes Berg9124b072008-10-14 19:17:54 +0200647 u8 long_frame_max_tx_count, short_frame_max_tx_count;
648
Johannes Berg8318d782008-01-24 19:38:38 +0100649 struct ieee80211_channel *channel;
Johannes Berg47979382009-01-07 10:13:27 +0100650 enum nl80211_channel_type channel_type;
Jiri Bencf0706e822007-05-05 11:45:53 -0700651};
652
653/**
Johannes Berg32bfd352007-12-19 01:31:26 +0100654 * struct ieee80211_vif - per-interface data
655 *
656 * Data in this structure is continually present for driver
657 * use during the life of a virtual interface.
658 *
Johannes Berg51fb61e2007-12-19 01:31:27 +0100659 * @type: type of this virtual interface
Johannes Bergbda39332008-10-11 01:51:51 +0200660 * @bss_conf: BSS configuration for this interface, either our own
661 * or the BSS we're associated to
Johannes Berg32bfd352007-12-19 01:31:26 +0100662 * @drv_priv: data area for driver use, will always be aligned to
663 * sizeof(void *).
664 */
665struct ieee80211_vif {
Johannes Berg05c914f2008-09-11 00:01:58 +0200666 enum nl80211_iftype type;
Johannes Bergbda39332008-10-11 01:51:51 +0200667 struct ieee80211_bss_conf bss_conf;
Johannes Berg32bfd352007-12-19 01:31:26 +0100668 /* must be last */
669 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
670};
671
Johannes Berg902acc72008-02-23 15:17:19 +0100672static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
673{
674#ifdef CONFIG_MAC80211_MESH
Johannes Berg05c914f2008-09-11 00:01:58 +0200675 return vif->type == NL80211_IFTYPE_MESH_POINT;
Johannes Berg902acc72008-02-23 15:17:19 +0100676#endif
677 return false;
678}
679
Johannes Berg32bfd352007-12-19 01:31:26 +0100680/**
Jiri Bencf0706e822007-05-05 11:45:53 -0700681 * struct ieee80211_if_init_conf - initial configuration of an interface
682 *
Johannes Berg32bfd352007-12-19 01:31:26 +0100683 * @vif: pointer to a driver-use per-interface structure. The pointer
684 * itself is also used for various functions including
685 * ieee80211_beacon_get() and ieee80211_get_buffered_bc().
Johannes Berg05c914f2008-09-11 00:01:58 +0200686 * @type: one of &enum nl80211_iftype constants. Determines the type of
Jiri Bencf0706e822007-05-05 11:45:53 -0700687 * added/removed interface.
688 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
689 * until the interface is removed (i.e. it cannot be used after
690 * remove_interface() callback was called for this interface).
691 *
692 * This structure is used in add_interface() and remove_interface()
693 * callbacks of &struct ieee80211_hw.
Johannes Berg4480f15c2007-07-10 19:32:10 +0200694 *
695 * When you allow multiple interfaces to be added to your PHY, take care
696 * that the hardware can actually handle multiple MAC addresses. However,
697 * also take care that when there's no interface left with mac_addr != %NULL
698 * you remove the MAC address from the device to avoid acknowledging packets
699 * in pure monitor mode.
Jiri Bencf0706e822007-05-05 11:45:53 -0700700 */
701struct ieee80211_if_init_conf {
Johannes Berg05c914f2008-09-11 00:01:58 +0200702 enum nl80211_iftype type;
Johannes Berg32bfd352007-12-19 01:31:26 +0100703 struct ieee80211_vif *vif;
Jiri Bencf0706e822007-05-05 11:45:53 -0700704 void *mac_addr;
705};
706
707/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400708 * enum ieee80211_key_alg - key algorithm
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400709 * @ALG_WEP: WEP40 or WEP104
710 * @ALG_TKIP: TKIP
711 * @ALG_CCMP: CCMP (AES)
Jouni Malinen3cfcf6a2009-01-08 13:32:02 +0200712 * @ALG_AES_CMAC: AES-128-CMAC
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400713 */
Johannes Bergea49c352007-09-18 17:29:21 -0400714enum ieee80211_key_alg {
Johannes Berg8f20fc22007-08-28 17:01:54 -0400715 ALG_WEP,
716 ALG_TKIP,
717 ALG_CCMP,
Jouni Malinen3cfcf6a2009-01-08 13:32:02 +0200718 ALG_AES_CMAC,
Johannes Bergea49c352007-09-18 17:29:21 -0400719};
Jiri Bencf0706e822007-05-05 11:45:53 -0700720
Emmanuel Grumbach23976ef2008-06-28 02:50:13 +0300721/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400722 * enum ieee80211_key_flags - key flags
723 *
724 * These flags are used for communication about keys between the driver
725 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
726 *
727 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
728 * that the STA this key will be used with could be using QoS.
729 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
730 * driver to indicate that it requires IV generation for this
731 * particular key.
732 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
733 * the driver for a TKIP key if it requires Michael MIC
734 * generation in software.
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200735 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
736 * that the key is pairwise rather then a shared key.
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200737 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
738 * CCMP key if it requires CCMP encryption of management frames (MFP) to
739 * be done in software.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400740 */
741enum ieee80211_key_flags {
742 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
743 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
744 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200745 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200746 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400747};
748
749/**
750 * struct ieee80211_key_conf - key information
751 *
752 * This key information is given by mac80211 to the driver by
753 * the set_key() callback in &struct ieee80211_ops.
754 *
755 * @hw_key_idx: To be set by the driver, this is the key index the driver
756 * wants to be given when a frame is transmitted and needs to be
Johannes Berg6a7664d2007-09-14 11:10:25 -0400757 * encrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400758 * @alg: The key algorithm.
759 * @flags: key flags, see &enum ieee80211_key_flags.
760 * @keyidx: the key index (0-3)
761 * @keylen: key material length
Luis R. Rodriguezffd78912008-06-21 10:02:46 -0400762 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
763 * data block:
764 * - Temporal Encryption Key (128 bits)
765 * - Temporal Authenticator Tx MIC Key (64 bits)
766 * - Temporal Authenticator Rx MIC Key (64 bits)
Johannes Bergdc822b52008-12-29 12:55:09 +0100767 * @icv_len: The ICV length for this key type
768 * @iv_len: The IV length for this key type
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400769 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700770struct ieee80211_key_conf {
Johannes Bergea49c352007-09-18 17:29:21 -0400771 enum ieee80211_key_alg alg;
Felix Fietkau76708de2008-10-05 18:02:48 +0200772 u8 icv_len;
773 u8 iv_len;
Johannes Berg6a7664d2007-09-14 11:10:25 -0400774 u8 hw_key_idx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400775 u8 flags;
Johannes Berg11a843b2007-08-28 17:01:55 -0400776 s8 keyidx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400777 u8 keylen;
Jiri Bencf0706e822007-05-05 11:45:53 -0700778 u8 key[0];
779};
780
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400781/**
782 * enum set_key_cmd - key command
783 *
784 * Used with the set_key() callback in &struct ieee80211_ops, this
785 * indicates whether a key is being removed or added.
786 *
787 * @SET_KEY: a key is set
788 * @DISABLE_KEY: a key must be disabled
789 */
Johannes Bergea49c352007-09-18 17:29:21 -0400790enum set_key_cmd {
Johannes Berg11a843b2007-08-28 17:01:55 -0400791 SET_KEY, DISABLE_KEY,
Johannes Bergea49c352007-09-18 17:29:21 -0400792};
Jiri Bencf0706e822007-05-05 11:45:53 -0700793
Tomas Winkler478f8d22007-09-30 13:52:37 +0200794/**
Johannes Berg17741cd2008-09-11 00:02:02 +0200795 * struct ieee80211_sta - station table entry
796 *
797 * A station table entry represents a station we are possibly
798 * communicating with. Since stations are RCU-managed in
799 * mac80211, any ieee80211_sta pointer you get access to must
800 * either be protected by rcu_read_lock() explicitly or implicitly,
801 * or you must take good care to not use such a pointer after a
802 * call to your sta_notify callback that removed it.
803 *
804 * @addr: MAC address
805 * @aid: AID we assigned to the station if we're an AP
Johannes Berg323ce792008-09-11 02:45:11 +0200806 * @supp_rates: Bitmap of supported rates (per band)
Johannes Bergae5eb022008-10-14 16:58:37 +0200807 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
Johannes Berg17741cd2008-09-11 00:02:02 +0200808 * @drv_priv: data area for driver use, will always be aligned to
809 * sizeof(void *), size is determined in hw information.
810 */
811struct ieee80211_sta {
Johannes Berg881d9482009-01-21 15:13:48 +0100812 u32 supp_rates[IEEE80211_NUM_BANDS];
Johannes Berg17741cd2008-09-11 00:02:02 +0200813 u8 addr[ETH_ALEN];
814 u16 aid;
Johannes Bergd9fe60d2008-10-09 12:13:49 +0200815 struct ieee80211_sta_ht_cap ht_cap;
Johannes Berg17741cd2008-09-11 00:02:02 +0200816
817 /* must be last */
818 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
819};
820
821/**
Tomas Winkler478f8d22007-09-30 13:52:37 +0200822 * enum sta_notify_cmd - sta notify command
823 *
824 * Used with the sta_notify() callback in &struct ieee80211_ops, this
Christian Lamparter89fad572008-12-09 16:28:06 +0100825 * indicates addition and removal of a station to station table,
826 * or if a associated station made a power state transition.
Tomas Winkler478f8d22007-09-30 13:52:37 +0200827 *
828 * @STA_NOTIFY_ADD: a station was added to the station table
829 * @STA_NOTIFY_REMOVE: a station being removed from the station table
Christian Lamparter4571d3b2008-11-30 00:48:41 +0100830 * @STA_NOTIFY_SLEEP: a station is now sleeping
831 * @STA_NOTIFY_AWAKE: a sleeping station woke up
832 */
Christian Lamparter89fad572008-12-09 16:28:06 +0100833enum sta_notify_cmd {
834 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE,
Christian Lamparter4571d3b2008-11-30 00:48:41 +0100835 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
836};
837
838/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +0200839 * enum ieee80211_tkip_key_type - get tkip key
840 *
841 * Used by drivers which need to get a tkip key for skb. Some drivers need a
842 * phase 1 key, others need a phase 2 key. A single function allows the driver
843 * to get the key, this enum indicates what type of key is required.
844 *
845 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
846 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
847 */
848enum ieee80211_tkip_key_type {
849 IEEE80211_TKIP_P1_KEY,
850 IEEE80211_TKIP_P2_KEY,
851};
852
853/**
Johannes Berg1bc08262007-09-18 17:29:15 -0400854 * enum ieee80211_hw_flags - hardware flags
855 *
856 * These flags are used to indicate hardware capabilities to
857 * the stack. Generally, flags here should have their meaning
858 * done in a way that the simplest hardware doesn't need setting
859 * any particular flags. There are some exceptions to this rule,
860 * however, so you are advised to review these flags carefully.
861 *
Johannes Bergaf65cd92009-11-17 18:18:36 +0100862 * @IEEE80211_HW_HAS_RATE_CONTROL:
863 * The hardware or firmware includes rate control, and cannot be
864 * controlled by the stack. As such, no rate control algorithm
865 * should be instantiated, and the TX rate reported to userspace
866 * will be taken from the TX status instead of the rate control
867 * algorithm.
868 * Note that this requires that the driver implement a number of
869 * callbacks so it has the correct information, it needs to have
870 * the @set_rts_threshold callback and must look at the BSS config
871 * @use_cts_prot for G/N protection, @use_short_slot for slot
872 * timing in 2.4 GHz and @use_short_preamble for preambles for
873 * CCK frames.
874 *
Johannes Berg1bc08262007-09-18 17:29:15 -0400875 * @IEEE80211_HW_RX_INCLUDES_FCS:
876 * Indicates that received frames passed to the stack include
877 * the FCS at the end.
878 *
879 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
880 * Some wireless LAN chipsets buffer broadcast/multicast frames
881 * for power saving stations in the hardware/firmware and others
882 * rely on the host system for such buffering. This option is used
883 * to configure the IEEE 802.11 upper layer to buffer broadcast and
884 * multicast frames when there are power saving stations so that
Luis R. Rodriguez546c80c2008-08-14 11:43:20 -0700885 * the driver can fetch them with ieee80211_get_buffered_bc().
Johannes Berg1bc08262007-09-18 17:29:15 -0400886 *
Johannes Berg8318d782008-01-24 19:38:38 +0100887 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
888 * Hardware is not capable of short slot operation on the 2.4 GHz band.
889 *
890 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
891 * Hardware is not capable of receiving frames with short preamble on
892 * the 2.4 GHz band.
Bruno Randolf566bfe52008-05-08 19:15:40 +0200893 *
894 * @IEEE80211_HW_SIGNAL_UNSPEC:
895 * Hardware can provide signal values but we don't know its units. We
896 * expect values between 0 and @max_signal.
897 * If possible please provide dB or dBm instead.
898 *
Bruno Randolf566bfe52008-05-08 19:15:40 +0200899 * @IEEE80211_HW_SIGNAL_DBM:
900 * Hardware gives signal values in dBm, decibel difference from
901 * one milliwatt. This is the preferred method since it is standardized
902 * between different devices. @max_signal does not need to be set.
903 *
904 * @IEEE80211_HW_NOISE_DBM:
905 * Hardware can provide noise (radio interference) values in units dBm,
906 * decibel difference from one milliwatt.
Tomas Winkler06ff47b2008-06-18 17:53:44 +0300907 *
908 * @IEEE80211_HW_SPECTRUM_MGMT:
909 * Hardware supports spectrum management defined in 802.11h
910 * Measurement, Channel Switch, Quieting, TPC
Sujith8b30b1f2008-10-24 09:55:27 +0530911 *
912 * @IEEE80211_HW_AMPDU_AGGREGATION:
913 * Hardware supports 11n A-MPDU aggregation.
Kalle Valo520eb822008-12-18 23:35:27 +0200914 *
Johannes Berg4be8c382009-01-07 18:28:20 +0100915 * @IEEE80211_HW_SUPPORTS_PS:
916 * Hardware has power save support (i.e. can go to sleep).
917 *
918 * @IEEE80211_HW_PS_NULLFUNC_STACK:
919 * Hardware requires nullfunc frame handling in stack, implies
920 * stack support for dynamic PS.
921 *
922 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
923 * Hardware has support for dynamic PS.
Jouni Malinen4375d082009-01-08 13:32:11 +0200924 *
925 * @IEEE80211_HW_MFP_CAPABLE:
926 * Hardware supports management frame protection (MFP, IEEE 802.11w).
Kalle Valo04de8382009-03-22 21:57:35 +0200927 *
928 * @IEEE80211_HW_BEACON_FILTER:
929 * Hardware supports dropping of irrelevant beacon frames to
930 * avoid waking up cpu.
Johannes Berg1bc08262007-09-18 17:29:15 -0400931 */
932enum ieee80211_hw_flags {
Johannes Bergaf65cd92009-11-17 18:18:36 +0100933 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
Johannes Berg1bc08262007-09-18 17:29:15 -0400934 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
935 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
Johannes Berg8318d782008-01-24 19:38:38 +0100936 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
937 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
Bruno Randolf566bfe52008-05-08 19:15:40 +0200938 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
Johannes Berg7fee5372009-01-30 11:13:06 +0100939 IEEE80211_HW_SIGNAL_DBM = 1<<6,
940 IEEE80211_HW_NOISE_DBM = 1<<7,
941 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
942 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
943 IEEE80211_HW_SUPPORTS_PS = 1<<10,
944 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
945 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
946 IEEE80211_HW_MFP_CAPABLE = 1<<13,
Kalle Valo04de8382009-03-22 21:57:35 +0200947 IEEE80211_HW_BEACON_FILTER = 1<<14,
Johannes Berg1bc08262007-09-18 17:29:15 -0400948};
949
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400950/**
951 * struct ieee80211_hw - hardware information and state
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400952 *
953 * This structure contains the configuration and hardware
954 * information for an 802.11 PHY.
955 *
956 * @wiphy: This points to the &struct wiphy allocated for this
957 * 802.11 PHY. You must fill in the @perm_addr and @dev
958 * members of this structure using SET_IEEE80211_DEV()
Johannes Berg8318d782008-01-24 19:38:38 +0100959 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
960 * bands (with channels, bitrates) are registered here.
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400961 *
962 * @conf: &struct ieee80211_conf, device configuration, don't use.
963 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400964 * @priv: pointer to private area that was allocated for driver use
965 * along with this structure.
966 *
967 * @flags: hardware flags, see &enum ieee80211_hw_flags.
968 *
969 * @extra_tx_headroom: headroom to reserve in each transmit skb
970 * for use by the driver (e.g. for transmit headers.)
971 *
972 * @channel_change_time: time (in microseconds) it takes to change channels.
973 *
Bruno Randolf566bfe52008-05-08 19:15:40 +0200974 * @max_signal: Maximum value for signal (rssi) in RX information, used
975 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400976 *
Tomas Winklerea95bba2008-07-18 13:53:00 +0800977 * @max_listen_interval: max listen interval in units of beacon interval
978 * that HW supports
979 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400980 * @queues: number of available hardware transmit queues for
Johannes Berge100bb62008-04-30 18:51:21 +0200981 * data packets. WMM/QoS requires at least four, these
982 * queues need to have configurable access parameters.
983 *
Johannes Berg830f9032007-10-28 14:51:05 +0100984 * @rate_control_algorithm: rate control algorithm for this hardware.
985 * If unset (NULL), the default algorithm will be used. Must be
986 * set before calling ieee80211_register_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +0100987 *
988 * @vif_data_size: size (in bytes) of the drv_priv data area
989 * within &struct ieee80211_vif.
Johannes Berg17741cd2008-09-11 00:02:02 +0200990 * @sta_data_size: size (in bytes) of the drv_priv data area
991 * within &struct ieee80211_sta.
Felix Fietkau870abdf2008-10-05 18:04:24 +0200992 *
Johannes Berge6a98542008-10-21 12:40:02 +0200993 * @max_rates: maximum number of alternate rate retry stages
994 * @max_rate_tries: maximum number of tries for each stage
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400995 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700996struct ieee80211_hw {
Jiri Bencf0706e822007-05-05 11:45:53 -0700997 struct ieee80211_conf conf;
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400998 struct wiphy *wiphy;
Johannes Berg830f9032007-10-28 14:51:05 +0100999 const char *rate_control_algorithm;
Jiri Bencf0706e822007-05-05 11:45:53 -07001000 void *priv;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001001 u32 flags;
Jiri Bencf0706e822007-05-05 11:45:53 -07001002 unsigned int extra_tx_headroom;
Jiri Bencf0706e822007-05-05 11:45:53 -07001003 int channel_change_time;
Johannes Berg32bfd352007-12-19 01:31:26 +01001004 int vif_data_size;
Johannes Berg17741cd2008-09-11 00:02:02 +02001005 int sta_data_size;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001006 u16 queues;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001007 u16 max_listen_interval;
Jiri Bencf0706e822007-05-05 11:45:53 -07001008 s8 max_signal;
Johannes Berge6a98542008-10-21 12:40:02 +02001009 u8 max_rates;
1010 u8 max_rate_tries;
Jiri Bencf0706e822007-05-05 11:45:53 -07001011};
1012
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001013/**
Luis R. Rodriguez9a953712009-01-22 15:05:53 -08001014 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1015 *
1016 * @wiphy: the &struct wiphy which we want to query
1017 *
1018 * mac80211 drivers can use this to get to their respective
1019 * &struct ieee80211_hw. Drivers wishing to get to their own private
1020 * structure can then access it via hw->priv. Note that mac802111 drivers should
1021 * not use wiphy_priv() to try to get their private driver structure as this
1022 * is already used internally by mac80211.
1023 */
1024struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1025
1026/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001027 * SET_IEEE80211_DEV - set device for 802.11 hardware
1028 *
1029 * @hw: the &struct ieee80211_hw to set the device for
1030 * @dev: the &struct device of this 802.11 device
1031 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001032static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1033{
1034 set_wiphy_dev(hw->wiphy, dev);
1035}
1036
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001037/**
Bob Copelande37d4df2008-10-20 21:20:27 -04001038 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001039 *
1040 * @hw: the &struct ieee80211_hw to set the MAC address for
1041 * @addr: the address to set
1042 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001043static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1044{
1045 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1046}
1047
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001048static inline struct ieee80211_rate *
1049ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001050 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001051{
Johannes Berge6a98542008-10-21 12:40:02 +02001052 if (WARN_ON(c->control.rates[0].idx < 0))
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001053 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001054 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001055}
1056
1057static inline struct ieee80211_rate *
1058ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001059 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001060{
Johannes Berge039fa42008-05-15 12:55:29 +02001061 if (c->control.rts_cts_rate_idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001062 return NULL;
Johannes Berge039fa42008-05-15 12:55:29 +02001063 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001064}
1065
1066static inline struct ieee80211_rate *
1067ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
Felix Fietkau870abdf2008-10-05 18:04:24 +02001068 const struct ieee80211_tx_info *c, int idx)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001069{
Johannes Berge6a98542008-10-21 12:40:02 +02001070 if (c->control.rates[idx + 1].idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001071 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001072 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001073}
1074
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001075/**
1076 * DOC: Hardware crypto acceleration
Johannes Berg4150c572007-09-17 01:29:23 -04001077 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001078 * mac80211 is capable of taking advantage of many hardware
1079 * acceleration designs for encryption and decryption operations.
1080 *
1081 * The set_key() callback in the &struct ieee80211_ops for a given
1082 * device is called to enable hardware acceleration of encryption and
Johannes Bergdc822b52008-12-29 12:55:09 +01001083 * decryption. The callback takes a @sta parameter that will be NULL
1084 * for default keys or keys used for transmission only, or point to
1085 * the station information for the peer for individual keys.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001086 * Multiple transmission keys with the same key index may be used when
1087 * VLANs are configured for an access point.
1088 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001089 * When transmitting, the TX control data will use the @hw_key_idx
1090 * selected by the driver by modifying the &struct ieee80211_key_conf
1091 * pointed to by the @key parameter to the set_key() function.
1092 *
1093 * The set_key() call for the %SET_KEY command should return 0 if
1094 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1095 * added; if you return 0 then hw_key_idx must be assigned to the
1096 * hardware key index, you are free to use the full u8 range.
1097 *
1098 * When the cmd is %DISABLE_KEY then it must succeed.
1099 *
1100 * Note that it is permissible to not decrypt a frame even if a key
1101 * for it has been uploaded to hardware, the stack will not make any
1102 * decision based on whether a key has been uploaded or not but rather
1103 * based on the receive flags.
1104 *
1105 * The &struct ieee80211_key_conf structure pointed to by the @key
1106 * parameter is guaranteed to be valid until another call to set_key()
1107 * removes it, but it can only be used as a cookie to differentiate
1108 * keys.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001109 *
1110 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1111 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1112 * handler.
1113 * The update_tkip_key() call updates the driver with the new phase 1 key.
1114 * This happens everytime the iv16 wraps around (every 65536 packets). The
1115 * set_key() call will happen only once for each key (unless the AP did
1116 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
Bob Copelande37d4df2008-10-20 21:20:27 -04001117 * provided by update_tkip_key only. The trigger that makes mac80211 call this
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001118 * handler is software decryption with wrap around of iv16.
Johannes Berg4150c572007-09-17 01:29:23 -04001119 */
Johannes Berg4150c572007-09-17 01:29:23 -04001120
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001121/**
Johannes Berg4be8c382009-01-07 18:28:20 +01001122 * DOC: Powersave support
1123 *
1124 * mac80211 has support for various powersave implementations.
1125 *
1126 * First, it can support hardware that handles all powersaving by
1127 * itself, such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS
1128 * hardware flag. In that case, it will be told about the desired
1129 * powersave mode depending on the association status, and the driver
1130 * must take care of sending nullfunc frames when necessary, i.e. when
1131 * entering and leaving powersave mode. The driver is required to look at
1132 * the AID in beacons and signal to the AP that it woke up when it finds
1133 * traffic directed to it. This mode supports dynamic PS by simply
1134 * enabling/disabling PS.
1135 *
1136 * Additionally, such hardware may set the %IEEE80211_HW_SUPPORTS_DYNAMIC_PS
1137 * flag to indicate that it can support dynamic PS mode itself (see below).
1138 *
1139 * Other hardware designs cannot send nullfunc frames by themselves and also
1140 * need software support for parsing the TIM bitmap. This is also supported
1141 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1142 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
Johannes Berg955394c2009-04-16 17:04:25 +02001143 * required to pass up beacons. The hardware is still required to handle
1144 * waking up for multicast traffic; if it cannot the driver must handle that
1145 * as best as it can, mac80211 is too slow.
Johannes Berg4be8c382009-01-07 18:28:20 +01001146 *
1147 * Dynamic powersave mode is an extension to normal powersave mode in which
1148 * the hardware stays awake for a user-specified period of time after sending
1149 * a frame so that reply frames need not be buffered and therefore delayed
1150 * to the next wakeup. This can either be supported by hardware, in which case
1151 * the driver needs to look at the @dynamic_ps_timeout hardware configuration
1152 * value, or by the stack if all nullfunc handling is in the stack.
1153 */
1154
1155/**
Kalle Valo04de8382009-03-22 21:57:35 +02001156 * DOC: Beacon filter support
1157 *
1158 * Some hardware have beacon filter support to reduce host cpu wakeups
1159 * which will reduce system power consumption. It usuallly works so that
1160 * the firmware creates a checksum of the beacon but omits all constantly
1161 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1162 * beacon is forwarded to the host, otherwise it will be just dropped. That
1163 * way the host will only receive beacons where some relevant information
1164 * (for example ERP protection or WMM settings) have changed.
1165 *
Johannes Berg955394c2009-04-16 17:04:25 +02001166 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1167 * hardware capability. The driver needs to enable beacon filter support
1168 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1169 * power save is enabled, the stack will not check for beacon loss and the
1170 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1171 *
1172 * The time (or number of beacons missed) until the firmware notifies the
1173 * driver of a beacon loss event (which in turn causes the driver to call
1174 * ieee80211_beacon_loss()) should be configurable and will be controlled
1175 * by mac80211 and the roaming algorithm in the future.
1176 *
1177 * Since there may be constantly changing information elements that nothing
1178 * in the software stack cares about, we will, in the future, have mac80211
1179 * tell the driver which information elements are interesting in the sense
1180 * that we want to see changes in them. This will include
1181 * - a list of information element IDs
1182 * - a list of OUIs for the vendor information element
1183 *
1184 * Ideally, the hardware would filter out any beacons without changes in the
1185 * requested elements, but if it cannot support that it may, at the expense
1186 * of some efficiency, filter out only a subset. For example, if the device
1187 * doesn't support checking for OUIs it should pass up all changes in all
1188 * vendor information elements.
1189 *
1190 * Note that change, for the sake of simplification, also includes information
1191 * elements appearing or disappearing from the beacon.
1192 *
1193 * Some hardware supports an "ignore list" instead, just make sure nothing
1194 * that was requested is on the ignore list, and include commonly changing
1195 * information element IDs in the ignore list, for example 11 (BSS load) and
1196 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1197 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1198 * it could also include some currently unused IDs.
1199 *
1200 *
1201 * In addition to these capabilities, hardware should support notifying the
1202 * host of changes in the beacon RSSI. This is relevant to implement roaming
1203 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1204 * the received data packets). This can consist in notifying the host when
1205 * the RSSI changes significantly or when it drops below or rises above
1206 * configurable thresholds. In the future these thresholds will also be
1207 * configured by mac80211 (which gets them from userspace) to implement
1208 * them as the roaming algorithm requires.
1209 *
1210 * If the hardware cannot implement this, the driver should ask it to
1211 * periodically pass beacon frames to the host so that software can do the
1212 * signal strength threshold checking.
Kalle Valo04de8382009-03-22 21:57:35 +02001213 */
1214
1215/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001216 * DOC: Frame filtering
1217 *
1218 * mac80211 requires to see many management frames for proper
1219 * operation, and users may want to see many more frames when
1220 * in monitor mode. However, for best CPU usage and power consumption,
1221 * having as few frames as possible percolate through the stack is
1222 * desirable. Hence, the hardware should filter as much as possible.
1223 *
1224 * To achieve this, mac80211 uses filter flags (see below) to tell
1225 * the driver's configure_filter() function which frames should be
1226 * passed to mac80211 and which should be filtered out.
1227 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02001228 * Before configure_filter() is invoked, the prepare_multicast()
1229 * callback is invoked with the parameters @mc_count and @mc_list
1230 * for the combined multicast address list of all virtual interfaces.
1231 * It's use is optional, and it returns a u64 that is passed to
1232 * configure_filter(). Additionally, configure_filter() has the
1233 * arguments @changed_flags telling which flags were changed and
1234 * @total_flags with the new flag states.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001235 *
1236 * If your device has no multicast address filters your driver will
1237 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1238 * parameter to see whether multicast frames should be accepted
1239 * or dropped.
1240 *
Michael Bueschd0f5afb2008-02-12 20:12:45 +01001241 * All unsupported flags in @total_flags must be cleared.
1242 * Hardware does not support a flag if it is incapable of _passing_
1243 * the frame to the stack. Otherwise the driver must ignore
1244 * the flag, but not clear it.
1245 * You must _only_ clear the flag (announce no support for the
1246 * flag to mac80211) if you are not able to pass the packet type
1247 * to the stack (so the hardware always filters it).
1248 * So for example, you should clear @FIF_CONTROL, if your hardware
1249 * always filters control frames. If your hardware always passes
1250 * control frames to the kernel and is incapable of filtering them,
1251 * you do _not_ clear the @FIF_CONTROL flag.
1252 * This rule applies to all other FIF flags as well.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001253 */
1254
1255/**
1256 * enum ieee80211_filter_flags - hardware filter flags
1257 *
1258 * These flags determine what the filter in hardware should be
1259 * programmed to let through and what should not be passed to the
1260 * stack. It is always safe to pass more frames than requested,
1261 * but this has negative impact on power consumption.
1262 *
1263 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1264 * think of the BSS as your network segment and then this corresponds
1265 * to the regular ethernet device promiscuous mode.
1266 *
1267 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1268 * by the user or if the hardware is not capable of filtering by
1269 * multicast address.
1270 *
1271 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1272 * %RX_FLAG_FAILED_FCS_CRC for them)
1273 *
1274 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1275 * the %RX_FLAG_FAILED_PLCP_CRC for them
1276 *
1277 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1278 * to the hardware that it should not filter beacons or probe responses
1279 * by BSSID. Filtering them can greatly reduce the amount of processing
1280 * mac80211 needs to do and the amount of CPU wakeups, so you should
1281 * honour this flag if possible.
1282 *
Igor Perminove3b90ca2009-08-04 16:48:51 +04001283 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
1284 * is not set then only those addressed to this station.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001285 *
1286 * @FIF_OTHER_BSS: pass frames destined to other BSSes
Igor Perminove3b90ca2009-08-04 16:48:51 +04001287 *
1288 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1289 * those addressed to this station.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001290 */
1291enum ieee80211_filter_flags {
1292 FIF_PROMISC_IN_BSS = 1<<0,
1293 FIF_ALLMULTI = 1<<1,
1294 FIF_FCSFAIL = 1<<2,
1295 FIF_PLCPFAIL = 1<<3,
1296 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1297 FIF_CONTROL = 1<<5,
1298 FIF_OTHER_BSS = 1<<6,
Igor Perminove3b90ca2009-08-04 16:48:51 +04001299 FIF_PSPOLL = 1<<7,
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001300};
1301
1302/**
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001303 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1304 *
1305 * These flags are used with the ampdu_action() callback in
1306 * &struct ieee80211_ops to indicate which action is needed.
Johannes Berg827d42c2009-11-22 12:28:41 +01001307 *
1308 * Note that drivers MUST be able to deal with a TX aggregation
1309 * session being stopped even before they OK'ed starting it by
1310 * calling ieee80211_start_tx_ba_cb(_irqsafe), because the peer
1311 * might receive the addBA frame and send a delBA right away!
1312 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001313 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1314 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001315 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1316 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
Johannes Bergb1720232009-03-23 17:28:39 +01001317 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001318 */
1319enum ieee80211_ampdu_mlme_action {
1320 IEEE80211_AMPDU_RX_START,
1321 IEEE80211_AMPDU_RX_STOP,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001322 IEEE80211_AMPDU_TX_START,
1323 IEEE80211_AMPDU_TX_STOP,
Johannes Bergb1720232009-03-23 17:28:39 +01001324 IEEE80211_AMPDU_TX_OPERATIONAL,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001325};
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001326
1327/**
1328 * struct ieee80211_ops - callbacks from mac80211 to the driver
1329 *
1330 * This structure contains various callbacks that the driver may
1331 * handle or, in some cases, must handle, for example to configure
1332 * the hardware to a new channel or to transmit a frame.
1333 *
1334 * @tx: Handler that 802.11 module calls for each transmitted frame.
1335 * skb contains the buffer starting from the IEEE 802.11 header.
1336 * The low-level driver should send the frame out based on
Johannes Bergeefce912008-05-17 00:57:13 +02001337 * configuration in the TX control data. This handler should,
1338 * preferably, never fail and stop queues appropriately, more
1339 * importantly, however, it must never fail for A-MPDU-queues.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001340 * This function should return NETDEV_TX_OK except in very
1341 * limited cases.
Johannes Bergeefce912008-05-17 00:57:13 +02001342 * Must be implemented and atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001343 *
1344 * @start: Called before the first netdevice attached to the hardware
1345 * is enabled. This should turn on the hardware and must turn on
1346 * frame reception (for possibly enabled monitor interfaces.)
1347 * Returns negative error codes, these may be seen in userspace,
1348 * or zero.
1349 * When the device is started it should not have a MAC address
1350 * to avoid acknowledging frames before a non-monitor device
1351 * is added.
1352 * Must be implemented.
1353 *
1354 * @stop: Called after last netdevice attached to the hardware
1355 * is disabled. This should turn off the hardware (at least
1356 * it must turn off frame reception.)
1357 * May be called right after add_interface if that rejects
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04001358 * an interface. If you added any work onto the mac80211 workqueue
1359 * you should ensure to cancel it on this callback.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001360 * Must be implemented.
1361 *
1362 * @add_interface: Called when a netdevice attached to the hardware is
Bob Copelande37d4df2008-10-20 21:20:27 -04001363 * enabled. Because it is not called for monitor mode devices, @start
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001364 * and @stop must be implemented.
1365 * The driver should perform any initialization it needs before
1366 * the device can be enabled. The initial configuration for the
1367 * interface is given in the conf parameter.
1368 * The callback may refuse to add an interface by returning a
1369 * negative error code (which will be seen in userspace.)
1370 * Must be implemented.
1371 *
1372 * @remove_interface: Notifies a driver that an interface is going down.
1373 * The @stop callback is called after this if it is the last interface
1374 * and no monitor interfaces are present.
1375 * When all interfaces are removed, the MAC address in the hardware
1376 * must be cleared so the device no longer acknowledges packets,
1377 * the mac_addr member of the conf structure is, however, set to the
1378 * MAC address of the device going away.
1379 * Hence, this callback must be implemented.
1380 *
1381 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1382 * function to change hardware configuration, e.g., channel.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001383 * This function should never fail but returns a negative error code
1384 * if it does.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001385 *
Johannes Berg471b3ef2007-12-28 14:32:58 +01001386 * @bss_info_changed: Handler for configuration requests related to BSS
1387 * parameters that may vary during BSS's lifespan, and may affect low
1388 * level driver (e.g. assoc/disassoc status, erp parameters).
1389 * This function should not be used if no BSS has been set, unless
1390 * for association indication. The @changed parameter indicates which
Reinette Chatred18ef292008-04-09 16:56:15 -07001391 * of the bss parameters has changed when a call is made.
Johannes Berg471b3ef2007-12-28 14:32:58 +01001392 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02001393 * @prepare_multicast: Prepare for multicast filter configuration.
1394 * This callback is optional, and its return value is passed
1395 * to configure_filter(). This callback must be atomic.
1396 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001397 * @configure_filter: Configure the device's RX filter.
1398 * See the section "Frame filtering" for more information.
Johannes Berg3ac64be2009-08-17 16:16:53 +02001399 * This callback must be implemented.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001400 *
Luis R. Rodriguez546c80c2008-08-14 11:43:20 -07001401 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
Johannes Berg17741cd2008-09-11 00:02:02 +02001402 * must be set or cleared for a given STA. Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001403 *
1404 * @set_key: See the section "Hardware crypto acceleration"
1405 * This callback can sleep, and is only called between add_interface
Johannes Bergdc822b52008-12-29 12:55:09 +01001406 * and remove_interface calls, i.e. while the given virtual interface
1407 * is enabled.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001408 * Returns a negative error code if the key can't be added.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001409 *
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001410 * @update_tkip_key: See the section "Hardware crypto acceleration"
1411 * This callback will be called in the context of Rx. Called for drivers
1412 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1413 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001414 * @hw_scan: Ask the hardware to service the scan request, no need to start
Johannes Berg8318d782008-01-24 19:38:38 +01001415 * the scan state machine in stack. The scan must honour the channel
Kalle Valo9050bdd2009-03-22 21:57:21 +02001416 * configuration done by the regulatory agent in the wiphy's
1417 * registered bands. The hardware (or the driver) needs to make sure
Johannes Bergde95a542009-04-01 11:58:36 +02001418 * that power save is disabled.
1419 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1420 * entire IEs after the SSID, so that drivers need not look at these
1421 * at all but just send them after the SSID -- mac80211 includes the
1422 * (extended) supported rates and HT information (where applicable).
1423 * When the scan finishes, ieee80211_scan_completed() must be called;
1424 * note that it also must be called when the scan cannot finish due to
1425 * any error unless this callback returned a negative error code.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001426 *
Michael Buesch80e775b2009-02-20 15:37:03 +01001427 * @sw_scan_start: Notifier function that is called just before a software scan
1428 * is started. Can be NULL, if the driver doesn't need this notification.
1429 *
1430 * @sw_scan_complete: Notifier function that is called just after a software scan
1431 * finished. Can be NULL, if the driver doesn't need this notification.
1432 *
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001433 * @get_stats: Return low-level statistics.
1434 * Returns zero if statistics are available.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001435 *
Johannes Berg62da92f2007-12-19 02:03:31 +01001436 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1437 * callback should be provided to read the TKIP transmit IVs (both IV32
1438 * and IV16) for the given key from hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001439 *
1440 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1441 *
Christian Lamparter89fad572008-12-09 16:28:06 +01001442 * @sta_notify: Notifies low level driver about addition, removal or power
1443 * state transition of an associated station, AP, IBSS/WDS/mesh peer etc.
1444 * Must be atomic.
Christian Lamparter4571d3b2008-11-30 00:48:41 +01001445 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001446 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
Johannes Bergfe3fa822008-09-08 11:05:09 +02001447 * bursting) for a hardware TX queue.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001448 * Returns a negative error code on failure.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001449 *
1450 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1451 * to get number of currently queued packets (queue length), maximum queue
1452 * size (limit), and total number of packets sent using each TX queue
Johannes Berge4e72fb2009-03-23 17:28:42 +01001453 * (count). The 'stats' pointer points to an array that has hw->queues
1454 * items.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001455 *
1456 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001457 * this is only used for IBSS mode BSSID merging and debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001458 * required function.
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001459 *
1460 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1461 * Currently, this is only used for IBSS mode debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001462 * required function.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001463 *
1464 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1465 * with other STAs in the IBSS. This is only used in IBSS mode. This
1466 * function is optional if the firmware/hardware takes full care of
1467 * TSF synchronization.
1468 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001469 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1470 * This is needed only for IBSS mode and the result of this function is
1471 * used to determine whether to reply to Probe Requests.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001472 * Returns non-zero if this device sent the last beacon.
Ron Rindjunskyd3c990f2007-11-26 16:14:34 +02001473 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001474 * @ampdu_action: Perform a certain A-MPDU action
1475 * The RA/TID combination determines the destination and TID we want
1476 * the ampdu action to be performed for. The action is defined through
1477 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001478 * is the first frame we expect to perform the action on. Notice
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001479 * that TX/RX_STOP can pass NULL for this parameter.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001480 * Returns a negative error code on failure.
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001481 *
1482 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1483 * need to set wiphy->rfkill_poll to %true before registration,
1484 * and need to call wiphy_rfkill_set_hw_state() in the callback.
Johannes Bergaff89a92009-07-01 21:26:51 +02001485 *
1486 * @testmode_cmd: Implement a cfg80211 test mode command.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001487 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001488struct ieee80211_ops {
Johannes Berge039fa42008-05-15 12:55:29 +02001489 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg4150c572007-09-17 01:29:23 -04001490 int (*start)(struct ieee80211_hw *hw);
Johannes Berg4150c572007-09-17 01:29:23 -04001491 void (*stop)(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001492 int (*add_interface)(struct ieee80211_hw *hw,
1493 struct ieee80211_if_init_conf *conf);
Jiri Bencf0706e822007-05-05 11:45:53 -07001494 void (*remove_interface)(struct ieee80211_hw *hw,
1495 struct ieee80211_if_init_conf *conf);
Johannes Berge8975582008-10-09 12:18:51 +02001496 int (*config)(struct ieee80211_hw *hw, u32 changed);
Johannes Berg471b3ef2007-12-28 14:32:58 +01001497 void (*bss_info_changed)(struct ieee80211_hw *hw,
1498 struct ieee80211_vif *vif,
1499 struct ieee80211_bss_conf *info,
1500 u32 changed);
Johannes Berg3ac64be2009-08-17 16:16:53 +02001501 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
1502 int mc_count, struct dev_addr_list *mc_list);
Johannes Berg4150c572007-09-17 01:29:23 -04001503 void (*configure_filter)(struct ieee80211_hw *hw,
1504 unsigned int changed_flags,
1505 unsigned int *total_flags,
Johannes Berg3ac64be2009-08-17 16:16:53 +02001506 u64 multicast);
Johannes Berg17741cd2008-09-11 00:02:02 +02001507 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1508 bool set);
Johannes Bergea49c352007-09-18 17:29:21 -04001509 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
Johannes Bergdc822b52008-12-29 12:55:09 +01001510 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
Johannes Berg11a843b2007-08-28 17:01:55 -04001511 struct ieee80211_key_conf *key);
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001512 void (*update_tkip_key)(struct ieee80211_hw *hw,
1513 struct ieee80211_key_conf *conf, const u8 *address,
1514 u32 iv32, u16 *phase1key);
Johannes Berg2a519312009-02-10 21:25:55 +01001515 int (*hw_scan)(struct ieee80211_hw *hw,
1516 struct cfg80211_scan_request *req);
Michael Buesch80e775b2009-02-20 15:37:03 +01001517 void (*sw_scan_start)(struct ieee80211_hw *hw);
1518 void (*sw_scan_complete)(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001519 int (*get_stats)(struct ieee80211_hw *hw,
1520 struct ieee80211_low_level_stats *stats);
Johannes Berg62da92f2007-12-19 02:03:31 +01001521 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1522 u32 *iv32, u16 *iv16);
Jiri Bencf0706e822007-05-05 11:45:53 -07001523 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
Johannes Berg32bfd352007-12-19 01:31:26 +01001524 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02001525 enum sta_notify_cmd, struct ieee80211_sta *sta);
Johannes Berge100bb62008-04-30 18:51:21 +02001526 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
Jiri Bencf0706e822007-05-05 11:45:53 -07001527 const struct ieee80211_tx_queue_params *params);
Jiri Bencf0706e822007-05-05 11:45:53 -07001528 int (*get_tx_stats)(struct ieee80211_hw *hw,
1529 struct ieee80211_tx_queue_stats *stats);
Jiri Bencf0706e822007-05-05 11:45:53 -07001530 u64 (*get_tsf)(struct ieee80211_hw *hw);
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001531 void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf);
Jiri Bencf0706e822007-05-05 11:45:53 -07001532 void (*reset_tsf)(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001533 int (*tx_last_beacon)(struct ieee80211_hw *hw);
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001534 int (*ampdu_action)(struct ieee80211_hw *hw,
Johannes Bergc951ad32009-11-16 12:00:38 +01001535 struct ieee80211_vif *vif,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001536 enum ieee80211_ampdu_mlme_action action,
Johannes Berg17741cd2008-09-11 00:02:02 +02001537 struct ieee80211_sta *sta, u16 tid, u16 *ssn);
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001538
1539 void (*rfkill_poll)(struct ieee80211_hw *hw);
Johannes Bergaff89a92009-07-01 21:26:51 +02001540#ifdef CONFIG_NL80211_TESTMODE
1541 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
1542#endif
Jiri Bencf0706e822007-05-05 11:45:53 -07001543};
1544
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001545/**
1546 * ieee80211_alloc_hw - Allocate a new hardware device
1547 *
1548 * This must be called once for each hardware device. The returned pointer
1549 * must be used to refer to this device when calling other functions.
1550 * mac80211 allocates a private data area for the driver pointed to by
1551 * @priv in &struct ieee80211_hw, the size of this area is given as
1552 * @priv_data_len.
1553 *
1554 * @priv_data_len: length of private data
1555 * @ops: callbacks for this device
Jiri Bencf0706e822007-05-05 11:45:53 -07001556 */
1557struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1558 const struct ieee80211_ops *ops);
1559
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001560/**
1561 * ieee80211_register_hw - Register hardware device
1562 *
Johannes Bergdbbea672008-02-26 14:34:06 +01001563 * You must call this function before any other functions in
1564 * mac80211. Note that before a hardware can be registered, you
1565 * need to fill the contained wiphy's information.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001566 *
1567 * @hw: the device to register as returned by ieee80211_alloc_hw()
1568 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001569int ieee80211_register_hw(struct ieee80211_hw *hw);
1570
Jiri Bencf0706e822007-05-05 11:45:53 -07001571#ifdef CONFIG_MAC80211_LEDS
1572extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1573extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
Michael Buesch47f0c502007-09-27 15:10:44 +02001574extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001575extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001576#endif
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001577/**
1578 * ieee80211_get_tx_led_name - get name of TX LED
1579 *
1580 * mac80211 creates a transmit LED trigger for each wireless hardware
1581 * that can be used to drive LEDs if your driver registers a LED device.
1582 * This function returns the name (or %NULL if not configured for LEDs)
1583 * of the trigger so you can automatically link the LED device.
1584 *
1585 * @hw: the hardware to get the LED trigger name for
1586 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001587static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1588{
1589#ifdef CONFIG_MAC80211_LEDS
1590 return __ieee80211_get_tx_led_name(hw);
1591#else
1592 return NULL;
1593#endif
1594}
1595
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001596/**
1597 * ieee80211_get_rx_led_name - get name of RX LED
1598 *
1599 * mac80211 creates a receive LED trigger for each wireless hardware
1600 * that can be used to drive LEDs if your driver registers a LED device.
1601 * This function returns the name (or %NULL if not configured for LEDs)
1602 * of the trigger so you can automatically link the LED device.
1603 *
1604 * @hw: the hardware to get the LED trigger name for
1605 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001606static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1607{
1608#ifdef CONFIG_MAC80211_LEDS
1609 return __ieee80211_get_rx_led_name(hw);
1610#else
1611 return NULL;
1612#endif
1613}
1614
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001615/**
1616 * ieee80211_get_assoc_led_name - get name of association LED
1617 *
1618 * mac80211 creates a association LED trigger for each wireless hardware
1619 * that can be used to drive LEDs if your driver registers a LED device.
1620 * This function returns the name (or %NULL if not configured for LEDs)
1621 * of the trigger so you can automatically link the LED device.
1622 *
1623 * @hw: the hardware to get the LED trigger name for
1624 */
Michael Buesch47f0c502007-09-27 15:10:44 +02001625static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1626{
1627#ifdef CONFIG_MAC80211_LEDS
1628 return __ieee80211_get_assoc_led_name(hw);
1629#else
1630 return NULL;
1631#endif
1632}
1633
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001634/**
1635 * ieee80211_get_radio_led_name - get name of radio LED
1636 *
1637 * mac80211 creates a radio change 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 */
1644static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1645{
1646#ifdef CONFIG_MAC80211_LEDS
1647 return __ieee80211_get_radio_led_name(hw);
1648#else
1649 return NULL;
1650#endif
1651}
Michael Buesch47f0c502007-09-27 15:10:44 +02001652
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001653/**
1654 * ieee80211_unregister_hw - Unregister a hardware device
1655 *
1656 * This function instructs mac80211 to free allocated resources
1657 * and unregister netdevices from the networking subsystem.
1658 *
1659 * @hw: the hardware to unregister
1660 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001661void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1662
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001663/**
1664 * ieee80211_free_hw - free hardware descriptor
1665 *
1666 * This function frees everything that was allocated, including the
1667 * private data for the driver. You must call ieee80211_unregister_hw()
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001668 * before calling this function.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001669 *
1670 * @hw: the hardware to free
1671 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001672void ieee80211_free_hw(struct ieee80211_hw *hw);
1673
Johannes Bergf2753dd2009-04-14 10:09:24 +02001674/**
1675 * ieee80211_restart_hw - restart hardware completely
1676 *
1677 * Call this function when the hardware was restarted for some reason
1678 * (hardware error, ...) and the driver is unable to restore its state
1679 * by itself. mac80211 assumes that at this point the driver/hardware
1680 * is completely uninitialised and stopped, it starts the process by
1681 * calling the ->start() operation. The driver will need to reset all
1682 * internal state that it has prior to calling this function.
1683 *
1684 * @hw: the hardware to restart
1685 */
1686void ieee80211_restart_hw(struct ieee80211_hw *hw);
1687
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001688/**
1689 * ieee80211_rx - receive frame
1690 *
1691 * Use this function to hand received frames to mac80211. The receive
Johannes Berg0869aea2009-10-28 10:03:35 +01001692 * buffer in @skb must start with an IEEE 802.11 header.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001693 *
Johannes Berg2485f712008-02-25 16:27:41 +01001694 * This function may not be called in IRQ context. Calls to this function
Kalle Valoe36e49f2009-10-13 20:33:13 +03001695 * for a single hardware must be synchronized against each other. Calls to
1696 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
1697 * mixed for a single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001698 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03001699 * In process context use instead ieee80211_rx_ni().
Johannes Bergd20ef632009-10-11 15:10:40 +02001700 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001701 * @hw: the hardware this frame came in on
1702 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001703 */
John W. Linville103bf9f2009-08-20 16:34:15 -04001704void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001705
1706/**
1707 * ieee80211_rx_irqsafe - receive frame
1708 *
1709 * Like ieee80211_rx() but can be called in IRQ context
Johannes Berg2485f712008-02-25 16:27:41 +01001710 * (internally defers to a tasklet.)
1711 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03001712 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
1713 * be mixed for a single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001714 *
1715 * @hw: the hardware this frame came in on
1716 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001717 */
Johannes Bergf1d58c22009-06-17 13:13:00 +02001718void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
Jiri Bencf0706e822007-05-05 11:45:53 -07001719
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001720/**
Kalle Valoe36e49f2009-10-13 20:33:13 +03001721 * ieee80211_rx_ni - receive frame (in process context)
1722 *
1723 * Like ieee80211_rx() but can be called in process context
1724 * (internally disables bottom halves).
1725 *
1726 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
1727 * not be mixed for a single hardware.
1728 *
1729 * @hw: the hardware this frame came in on
1730 * @skb: the buffer to receive, owned by mac80211 after this call
1731 */
1732static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
1733 struct sk_buff *skb)
1734{
1735 local_bh_disable();
1736 ieee80211_rx(hw, skb);
1737 local_bh_enable();
1738}
1739
1740/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001741 * ieee80211_tx_status - transmit status callback
1742 *
1743 * Call this function for all transmitted frames after they have been
1744 * transmitted. It is permissible to not call this function for
1745 * multicast frames but this can affect statistics.
1746 *
Johannes Berg2485f712008-02-25 16:27:41 +01001747 * This function may not be called in IRQ context. Calls to this function
1748 * for a single hardware must be synchronized against each other. Calls
1749 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1750 * for a single hardware.
1751 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001752 * @hw: the hardware the frame was transmitted by
1753 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001754 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001755void ieee80211_tx_status(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001756 struct sk_buff *skb);
Johannes Berg2485f712008-02-25 16:27:41 +01001757
1758/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001759 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
Johannes Berg2485f712008-02-25 16:27:41 +01001760 *
1761 * Like ieee80211_tx_status() but can be called in IRQ context
1762 * (internally defers to a tasklet.)
1763 *
1764 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1765 * single hardware.
1766 *
1767 * @hw: the hardware the frame was transmitted by
1768 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg2485f712008-02-25 16:27:41 +01001769 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001770void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001771 struct sk_buff *skb);
Jiri Bencf0706e822007-05-05 11:45:53 -07001772
1773/**
Johannes Bergeddcbb92009-10-29 08:30:35 +01001774 * ieee80211_beacon_get_tim - beacon generation function
1775 * @hw: pointer obtained from ieee80211_alloc_hw().
1776 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1777 * @tim_offset: pointer to variable that will receive the TIM IE offset.
1778 * Set to 0 if invalid (in non-AP modes).
1779 * @tim_length: pointer to variable that will receive the TIM IE length,
1780 * (including the ID and length bytes!).
1781 * Set to 0 if invalid (in non-AP modes).
1782 *
1783 * If the driver implements beaconing modes, it must use this function to
1784 * obtain the beacon frame/template.
1785 *
1786 * If the beacon frames are generated by the host system (i.e., not in
1787 * hardware/firmware), the driver uses this function to get each beacon
1788 * frame from mac80211 -- it is responsible for calling this function
1789 * before the beacon is needed (e.g. based on hardware interrupt).
1790 *
1791 * If the beacon frames are generated by the device, then the driver
1792 * must use the returned beacon as the template and change the TIM IE
1793 * according to the current DTIM parameters/TIM bitmap.
1794 *
1795 * The driver is responsible for freeing the returned skb.
1796 */
1797struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
1798 struct ieee80211_vif *vif,
1799 u16 *tim_offset, u16 *tim_length);
1800
1801/**
Jiri Bencf0706e822007-05-05 11:45:53 -07001802 * ieee80211_beacon_get - beacon generation function
1803 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001804 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e822007-05-05 11:45:53 -07001805 *
Johannes Bergeddcbb92009-10-29 08:30:35 +01001806 * See ieee80211_beacon_get_tim().
Jiri Bencf0706e822007-05-05 11:45:53 -07001807 */
Johannes Bergeddcbb92009-10-29 08:30:35 +01001808static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1809 struct ieee80211_vif *vif)
1810{
1811 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
1812}
Jiri Bencf0706e822007-05-05 11:45:53 -07001813
1814/**
1815 * ieee80211_rts_get - RTS frame generation function
1816 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001817 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e822007-05-05 11:45:53 -07001818 * @frame: pointer to the frame that is going to be protected by the RTS.
1819 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02001820 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07001821 * @rts: The buffer where to store the RTS frame.
1822 *
1823 * If the RTS frames are generated by the host system (i.e., not in
1824 * hardware/firmware), the low-level driver uses this function to receive
1825 * the next RTS frame from the 802.11 code. The low-level is responsible
1826 * for calling this function before and RTS frame is needed.
1827 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001828void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07001829 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001830 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e822007-05-05 11:45:53 -07001831 struct ieee80211_rts *rts);
1832
1833/**
1834 * ieee80211_rts_duration - Get the duration field for an RTS frame
1835 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001836 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e822007-05-05 11:45:53 -07001837 * @frame_len: the length of the frame that is going to be protected by the RTS.
Johannes Berge039fa42008-05-15 12:55:29 +02001838 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07001839 *
1840 * If the RTS is generated in firmware, but the host system must provide
1841 * the duration field, the low-level driver uses this function to receive
1842 * the duration field value in little-endian byteorder.
1843 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001844__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1845 struct ieee80211_vif *vif, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001846 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e822007-05-05 11:45:53 -07001847
1848/**
1849 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1850 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001851 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e822007-05-05 11:45:53 -07001852 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1853 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02001854 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07001855 * @cts: The buffer where to store the CTS-to-self frame.
1856 *
1857 * If the CTS-to-self frames are generated by the host system (i.e., not in
1858 * hardware/firmware), the low-level driver uses this function to receive
1859 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1860 * for calling this function before and CTS-to-self frame is needed.
1861 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001862void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1863 struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07001864 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001865 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e822007-05-05 11:45:53 -07001866 struct ieee80211_cts *cts);
1867
1868/**
1869 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1870 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001871 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e822007-05-05 11:45:53 -07001872 * @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 +02001873 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07001874 *
1875 * If the CTS-to-self is generated in firmware, but the host system must provide
1876 * the duration field, the low-level driver uses this function to receive
1877 * the duration field value in little-endian byteorder.
1878 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001879__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1880 struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07001881 size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001882 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e822007-05-05 11:45:53 -07001883
1884/**
1885 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1886 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001887 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e822007-05-05 11:45:53 -07001888 * @frame_len: the length of the frame.
Johannes Berg8318d782008-01-24 19:38:38 +01001889 * @rate: the rate at which the frame is going to be transmitted.
Jiri Bencf0706e822007-05-05 11:45:53 -07001890 *
1891 * Calculate the duration field of some generic frame, given its
1892 * length and transmission rate (in 100kbps).
1893 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001894__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1895 struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07001896 size_t frame_len,
Johannes Berg8318d782008-01-24 19:38:38 +01001897 struct ieee80211_rate *rate);
Jiri Bencf0706e822007-05-05 11:45:53 -07001898
1899/**
1900 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1901 * @hw: pointer as obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001902 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e822007-05-05 11:45:53 -07001903 *
1904 * Function for accessing buffered broadcast and multicast frames. If
1905 * hardware/firmware does not implement buffering of broadcast/multicast
1906 * frames when power saving is used, 802.11 code buffers them in the host
1907 * memory. The low-level driver uses this function to fetch next buffered
1908 * frame. In most cases, this is used when generating beacon frame. This
1909 * function returns a pointer to the next buffered skb or NULL if no more
1910 * buffered frames are available.
1911 *
1912 * Note: buffered frames are returned only after DTIM beacon frame was
1913 * generated with ieee80211_beacon_get() and the low-level driver must thus
1914 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1915 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1916 * does not need to check for DTIM beacons separately and should be able to
1917 * use common code for all beacons.
1918 */
1919struct sk_buff *
Johannes Berge039fa42008-05-15 12:55:29 +02001920ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e822007-05-05 11:45:53 -07001921
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001922/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02001923 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
1924 *
1925 * This function computes a TKIP rc4 key for an skb. It computes
1926 * a phase 1 key if needed (iv16 wraps around). This function is to
1927 * be used by drivers which can do HW encryption but need to compute
1928 * to phase 1/2 key in SW.
1929 *
1930 * @keyconf: the parameter passed with the set key
1931 * @skb: the skb for which the key is needed
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001932 * @type: TBD
Randy Dunlapea2d8b52008-10-27 09:47:03 -07001933 * @key: a buffer to which the key will be written
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02001934 */
1935void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
1936 struct sk_buff *skb,
1937 enum ieee80211_tkip_key_type type, u8 *key);
1938/**
Jiri Bencf0706e822007-05-05 11:45:53 -07001939 * ieee80211_wake_queue - wake specific queue
1940 * @hw: pointer as obtained from ieee80211_alloc_hw().
1941 * @queue: queue number (counted from zero).
1942 *
1943 * Drivers should use this function instead of netif_wake_queue.
1944 */
1945void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1946
1947/**
1948 * ieee80211_stop_queue - stop specific queue
1949 * @hw: pointer as obtained from ieee80211_alloc_hw().
1950 * @queue: queue number (counted from zero).
1951 *
1952 * Drivers should use this function instead of netif_stop_queue.
1953 */
1954void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1955
1956/**
Tomas Winkler92ab8532008-07-24 21:02:04 +03001957 * ieee80211_queue_stopped - test status of the queue
1958 * @hw: pointer as obtained from ieee80211_alloc_hw().
1959 * @queue: queue number (counted from zero).
1960 *
1961 * Drivers should use this function instead of netif_stop_queue.
1962 */
1963
1964int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
1965
1966/**
Jiri Bencf0706e822007-05-05 11:45:53 -07001967 * ieee80211_stop_queues - stop all queues
1968 * @hw: pointer as obtained from ieee80211_alloc_hw().
1969 *
1970 * Drivers should use this function instead of netif_stop_queue.
1971 */
1972void ieee80211_stop_queues(struct ieee80211_hw *hw);
1973
1974/**
1975 * ieee80211_wake_queues - wake all queues
1976 * @hw: pointer as obtained from ieee80211_alloc_hw().
1977 *
1978 * Drivers should use this function instead of netif_wake_queue.
1979 */
1980void ieee80211_wake_queues(struct ieee80211_hw *hw);
1981
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001982/**
1983 * ieee80211_scan_completed - completed hardware scan
1984 *
1985 * When hardware scan offload is used (i.e. the hw_scan() callback is
1986 * assigned) this function needs to be called by the driver to notify
1987 * mac80211 that the scan finished.
1988 *
1989 * @hw: the hardware that finished the scan
Johannes Berg2a519312009-02-10 21:25:55 +01001990 * @aborted: set to true if scan was aborted
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001991 */
Johannes Berg2a519312009-02-10 21:25:55 +01001992void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
Jiri Bencf0706e822007-05-05 11:45:53 -07001993
Johannes Bergdabeb342007-11-09 01:57:29 +01001994/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001995 * ieee80211_iterate_active_interfaces - iterate active interfaces
Johannes Bergdabeb342007-11-09 01:57:29 +01001996 *
1997 * This function iterates over the interfaces associated with a given
1998 * hardware that are currently active and calls the callback for them.
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02001999 * This function allows the iterator function to sleep, when the iterator
2000 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
2001 * be used.
Johannes Bergdabeb342007-11-09 01:57:29 +01002002 *
2003 * @hw: the hardware struct of which the interfaces should be iterated over
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002004 * @iterator: the iterator function to call
Johannes Bergdabeb342007-11-09 01:57:29 +01002005 * @data: first argument of the iterator function
2006 */
2007void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
2008 void (*iterator)(void *data, u8 *mac,
Johannes Berg32bfd352007-12-19 01:31:26 +01002009 struct ieee80211_vif *vif),
Johannes Bergdabeb342007-11-09 01:57:29 +01002010 void *data);
2011
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002012/**
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002013 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
2014 *
2015 * This function iterates over the interfaces associated with a given
2016 * hardware that are currently active and calls the callback for them.
2017 * This function requires the iterator callback function to be atomic,
2018 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
2019 *
2020 * @hw: the hardware struct of which the interfaces should be iterated over
2021 * @iterator: the iterator function to call, cannot sleep
2022 * @data: first argument of the iterator function
2023 */
2024void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
2025 void (*iterator)(void *data,
2026 u8 *mac,
2027 struct ieee80211_vif *vif),
2028 void *data);
2029
2030/**
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04002031 * ieee80211_queue_work - add work onto the mac80211 workqueue
2032 *
2033 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
2034 * This helper ensures drivers are not queueing work when they should not be.
2035 *
2036 * @hw: the hardware struct for the interface we are adding work for
2037 * @work: the work we want to add onto the mac80211 workqueue
2038 */
2039void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
2040
2041/**
2042 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
2043 *
2044 * Drivers and mac80211 use this to queue delayed work onto the mac80211
2045 * workqueue.
2046 *
2047 * @hw: the hardware struct for the interface we are adding work for
2048 * @dwork: delayable work to queue onto the mac80211 workqueue
2049 * @delay: number of jiffies to wait before queueing
2050 */
2051void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
2052 struct delayed_work *dwork,
2053 unsigned long delay);
2054
2055/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002056 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01002057 * @sta: the station for which to start a BA session
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002058 * @tid: the TID to BA on.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002059 *
2060 * Return: success if addBA request was sent, failure otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002061 *
2062 * Although mac80211/low level driver/user space application can estimate
2063 * the need to start aggregation on a certain RA/TID, the session level
2064 * will be managed by the mac80211.
2065 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002066int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002067
2068/**
2069 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
Johannes Bergc951ad32009-11-16 12:00:38 +01002070 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002071 * @ra: receiver address of the BA session recipient.
2072 * @tid: the TID to BA on.
2073 *
2074 * This function must be called by low level driver once it has
2075 * finished with preparations for the BA session.
2076 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002077void ieee80211_start_tx_ba_cb(struct ieee80211_vif *vif, u8 *ra, u16 tid);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002078
2079/**
2080 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
Johannes Bergc951ad32009-11-16 12:00:38 +01002081 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002082 * @ra: receiver address of the BA session recipient.
2083 * @tid: the TID to BA on.
2084 *
2085 * This function must be called by low level driver once it has
2086 * finished with preparations for the BA session.
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002087 * This version of the function is IRQ-safe.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002088 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002089void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002090 u16 tid);
2091
2092/**
2093 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01002094 * @sta: the station whose BA session to stop
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002095 * @tid: the TID to stop BA.
2096 * @initiator: if indicates initiator DELBA frame will be sent.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002097 *
2098 * Return: error if no sta with matching da found, success otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002099 *
2100 * Although mac80211/low level driver/user space application can estimate
2101 * the need to stop aggregation on a certain RA/TID, the session level
2102 * will be managed by the mac80211.
2103 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002104int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002105 enum ieee80211_back_parties initiator);
2106
2107/**
2108 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
Johannes Bergc951ad32009-11-16 12:00:38 +01002109 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002110 * @ra: receiver address of the BA session recipient.
2111 * @tid: the desired TID to BA on.
2112 *
2113 * This function must be called by low level driver once it has
2114 * finished with preparations for the BA session tear down.
2115 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002116void ieee80211_stop_tx_ba_cb(struct ieee80211_vif *vif, u8 *ra, u8 tid);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002117
2118/**
2119 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
Johannes Bergc951ad32009-11-16 12:00:38 +01002120 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002121 * @ra: receiver address of the BA session recipient.
2122 * @tid: the desired TID to BA on.
2123 *
2124 * This function must be called by low level driver once it has
2125 * finished with preparations for the BA session tear down.
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002126 * This version of the function is IRQ-safe.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002127 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002128void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002129 u16 tid);
2130
Mohamed Abbas84363e62008-04-04 16:59:58 -07002131/**
Johannes Berg17741cd2008-09-11 00:02:02 +02002132 * ieee80211_find_sta - find a station
2133 *
Johannes Berg5ed176e2009-11-04 14:42:28 +01002134 * @vif: virtual interface to look for station on
Johannes Berg17741cd2008-09-11 00:02:02 +02002135 * @addr: station's address
2136 *
2137 * This function must be called under RCU lock and the
2138 * resulting pointer is only valid under RCU lock as well.
2139 */
Johannes Berg5ed176e2009-11-04 14:42:28 +01002140struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02002141 const u8 *addr);
2142
Kalle Valo04de8382009-03-22 21:57:35 +02002143/**
Johannes Berg5ed176e2009-11-04 14:42:28 +01002144 * ieee80211_find_sta_by_hw - find a station on hardware
2145 *
2146 * @hw: pointer as obtained from ieee80211_alloc_hw()
2147 * @addr: station's address
2148 *
2149 * This function must be called under RCU lock and the
2150 * resulting pointer is only valid under RCU lock as well.
2151 *
2152 * NOTE: This function should not be used! When mac80211 is converted
2153 * internally to properly keep track of stations on multiple
2154 * virtual interfaces, it will not always know which station to
2155 * return here since a single address might be used by multiple
2156 * logical stations (e.g. consider a station connecting to another
2157 * BSSID on the same AP hardware without disconnecting first).
2158 *
2159 * DO NOT USE THIS FUNCTION.
2160 */
2161struct ieee80211_sta *ieee80211_find_sta_by_hw(struct ieee80211_hw *hw,
2162 const u8 *addr);
2163
2164/**
Johannes Bergaf818582009-11-06 11:35:50 +01002165 * ieee80211_sta_block_awake - block station from waking up
2166 * @hw: the hardware
2167 * @pubsta: the station
2168 * @block: whether to block or unblock
2169 *
2170 * Some devices require that all frames that are on the queues
2171 * for a specific station that went to sleep are flushed before
2172 * a poll response or frames after the station woke up can be
2173 * delivered to that it. Note that such frames must be rejected
2174 * by the driver as filtered, with the appropriate status flag.
2175 *
2176 * This function allows implementing this mode in a race-free
2177 * manner.
2178 *
2179 * To do this, a driver must keep track of the number of frames
2180 * still enqueued for a specific station. If this number is not
2181 * zero when the station goes to sleep, the driver must call
2182 * this function to force mac80211 to consider the station to
2183 * be asleep regardless of the station's actual state. Once the
2184 * number of outstanding frames reaches zero, the driver must
2185 * call this function again to unblock the station. That will
2186 * cause mac80211 to be able to send ps-poll responses, and if
2187 * the station queried in the meantime then frames will also
2188 * be sent out as a result of this. Additionally, the driver
2189 * will be notified that the station woke up some time after
2190 * it is unblocked, regardless of whether the station actually
2191 * woke up while blocked or not.
2192 */
2193void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
2194 struct ieee80211_sta *pubsta, bool block);
2195
2196/**
Kalle Valo04de8382009-03-22 21:57:35 +02002197 * ieee80211_beacon_loss - inform hardware does not receive beacons
2198 *
2199 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
2200 *
2201 * When beacon filtering is enabled with IEEE80211_HW_BEACON_FILTERING and
2202 * IEEE80211_CONF_PS is set, the driver needs to inform whenever the
2203 * hardware is not receiving beacons with this function.
2204 */
2205void ieee80211_beacon_loss(struct ieee80211_vif *vif);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002206
2207/* Rate control API */
Johannes Berge6a98542008-10-21 12:40:02 +02002208
Johannes Berg4b7679a2008-09-18 18:14:18 +02002209/**
Sujith81cb7622009-02-12 11:38:37 +05302210 * enum rate_control_changed - flags to indicate which parameter changed
2211 *
2212 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
2213 * changed, rate control algorithm can update its internal state if needed.
2214 */
2215enum rate_control_changed {
2216 IEEE80211_RC_HT_CHANGED = BIT(0)
2217};
2218
2219/**
Johannes Berge6a98542008-10-21 12:40:02 +02002220 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
Johannes Berg4b7679a2008-09-18 18:14:18 +02002221 *
Johannes Berge6a98542008-10-21 12:40:02 +02002222 * @hw: The hardware the algorithm is invoked for.
2223 * @sband: The band this frame is being transmitted on.
2224 * @bss_conf: the current BSS configuration
2225 * @reported_rate: The rate control algorithm can fill this in to indicate
2226 * which rate should be reported to userspace as the current rate and
2227 * used for rate calculations in the mesh network.
2228 * @rts: whether RTS will be used for this frame because it is longer than the
2229 * RTS threshold
2230 * @short_preamble: whether mac80211 will request short-preamble transmission
2231 * if the selected rate supports it
2232 * @max_rate_idx: user-requested maximum rate (not MCS for now)
Johannes Berge25cf4a2008-10-23 08:51:20 +02002233 * @skb: the skb that will be transmitted, the control information in it needs
2234 * to be filled in
Johannes Berg4b7679a2008-09-18 18:14:18 +02002235 */
Johannes Berge6a98542008-10-21 12:40:02 +02002236struct ieee80211_tx_rate_control {
2237 struct ieee80211_hw *hw;
2238 struct ieee80211_supported_band *sband;
2239 struct ieee80211_bss_conf *bss_conf;
2240 struct sk_buff *skb;
2241 struct ieee80211_tx_rate reported_rate;
2242 bool rts, short_preamble;
2243 u8 max_rate_idx;
Johannes Berg4b7679a2008-09-18 18:14:18 +02002244};
2245
2246struct rate_control_ops {
2247 struct module *module;
2248 const char *name;
2249 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002250 void (*free)(void *priv);
2251
2252 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
2253 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
2254 struct ieee80211_sta *sta, void *priv_sta);
Sujith81cb7622009-02-12 11:38:37 +05302255 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
2256 struct ieee80211_sta *sta,
2257 void *priv_sta, u32 changed);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002258 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
2259 void *priv_sta);
2260
2261 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
2262 struct ieee80211_sta *sta, void *priv_sta,
2263 struct sk_buff *skb);
Johannes Berge6a98542008-10-21 12:40:02 +02002264 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
2265 struct ieee80211_tx_rate_control *txrc);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002266
2267 void (*add_sta_debugfs)(void *priv, void *priv_sta,
2268 struct dentry *dir);
2269 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
2270};
2271
2272static inline int rate_supported(struct ieee80211_sta *sta,
2273 enum ieee80211_band band,
2274 int index)
2275{
2276 return (sta == NULL || sta->supp_rates[band] & BIT(index));
2277}
2278
Luis R. Rodriguez4c6d4f52009-07-16 10:05:41 -07002279/**
2280 * rate_control_send_low - helper for drivers for management/no-ack frames
2281 *
2282 * Rate control algorithms that agree to use the lowest rate to
2283 * send management frames and NO_ACK data with the respective hw
2284 * retries should use this in the beginning of their mac80211 get_rate
2285 * callback. If true is returned the rate control can simply return.
2286 * If false is returned we guarantee that sta and sta and priv_sta is
2287 * not null.
2288 *
2289 * Rate control algorithms wishing to do more intelligent selection of
2290 * rate for multicast/broadcast frames may choose to not use this.
2291 *
2292 * @sta: &struct ieee80211_sta pointer to the target destination. Note
2293 * that this may be null.
2294 * @priv_sta: private rate control structure. This may be null.
2295 * @txrc: rate control information we sholud populate for mac80211.
2296 */
2297bool rate_control_send_low(struct ieee80211_sta *sta,
2298 void *priv_sta,
2299 struct ieee80211_tx_rate_control *txrc);
2300
2301
Johannes Berg4b7679a2008-09-18 18:14:18 +02002302static inline s8
2303rate_lowest_index(struct ieee80211_supported_band *sband,
2304 struct ieee80211_sta *sta)
2305{
2306 int i;
2307
2308 for (i = 0; i < sband->n_bitrates; i++)
2309 if (rate_supported(sta, sband->band, i))
2310 return i;
2311
2312 /* warn when we cannot find a rate. */
2313 WARN_ON(1);
2314
2315 return 0;
2316}
2317
Luis R. Rodriguezb770b432009-07-16 10:15:09 -07002318static inline
2319bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
2320 struct ieee80211_sta *sta)
2321{
2322 unsigned int i;
2323
2324 for (i = 0; i < sband->n_bitrates; i++)
2325 if (rate_supported(sta, sband->band, i))
2326 return true;
2327 return false;
2328}
Johannes Berg4b7679a2008-09-18 18:14:18 +02002329
2330int ieee80211_rate_control_register(struct rate_control_ops *ops);
2331void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
2332
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002333static inline bool
2334conf_is_ht20(struct ieee80211_conf *conf)
2335{
Johannes Berg47979382009-01-07 10:13:27 +01002336 return conf->channel_type == NL80211_CHAN_HT20;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002337}
2338
2339static inline bool
2340conf_is_ht40_minus(struct ieee80211_conf *conf)
2341{
Johannes Berg47979382009-01-07 10:13:27 +01002342 return conf->channel_type == NL80211_CHAN_HT40MINUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002343}
2344
2345static inline bool
2346conf_is_ht40_plus(struct ieee80211_conf *conf)
2347{
Johannes Berg47979382009-01-07 10:13:27 +01002348 return conf->channel_type == NL80211_CHAN_HT40PLUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002349}
2350
2351static inline bool
2352conf_is_ht40(struct ieee80211_conf *conf)
2353{
2354 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
2355}
2356
2357static inline bool
2358conf_is_ht(struct ieee80211_conf *conf)
2359{
Johannes Berg47979382009-01-07 10:13:27 +01002360 return conf->channel_type != NL80211_CHAN_NO_HT;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002361}
2362
Jiri Bencf0706e822007-05-05 11:45:53 -07002363#endif /* MAC80211_H */