blob: 45d7d44d7cbe401ff92050f31531c2526a774b30 [file] [log] [blame]
Jiri Bencf0706e82007-05-05 11:45:53 -07001/*
Johannes Berg3017b802007-08-28 17:01:53 -04002 * mac80211 <-> driver interface
3 *
Jiri Bencf0706e82007-05-05 11:45:53 -07004 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
Jouni Malinen026331c2010-02-15 12:53:10 +02006 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
Jiri Bencf0706e82007-05-05 11:45:53 -07007 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13#ifndef MAC80211_H
14#define MAC80211_H
15
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 Bencf0706e82007-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 Bencf0706e82007-05-05 11:45:53 -070037 * called in hardware interrupt context. The low-level driver must not call any
38 * other functions in hardware interrupt context. If there is a need for such
39 * call, the low-level driver should first ACK the interrupt and perform the
Johannes Berg2485f712008-02-25 16:27:41 +010040 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
41 * tasklet function.
42 *
43 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
Randy Dunlap6ef307b2008-07-03 13:52:18 -070044 * use the non-IRQ-safe functions!
Jiri Bencf0706e82007-05-05 11:45:53 -070045 */
46
Johannes Berg75a5f0c2007-09-18 17:29:20 -040047/**
48 * DOC: Warning
Jiri Bencf0706e82007-05-05 11:45:53 -070049 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -040050 * If you're reading this document and not the header file itself, it will
51 * be incomplete because not all documentation has been converted yet.
52 */
53
54/**
55 * DOC: Frame format
Jiri Bencf0706e82007-05-05 11:45:53 -070056 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -040057 * As a general rule, when frames are passed between mac80211 and the driver,
58 * they start with the IEEE 802.11 header and include the same octets that are
59 * sent over the air except for the FCS which should be calculated by the
60 * hardware.
61 *
62 * There are, however, various exceptions to this rule for advanced features:
63 *
64 * The first exception is for hardware encryption and decryption offload
65 * where the IV/ICV may or may not be generated in hardware.
66 *
67 * Secondly, when the hardware handles fragmentation, the frame handed to
68 * the driver from mac80211 is the MSDU, not the MPDU.
69 *
70 * Finally, for received frames, the driver is able to indicate that it has
71 * filled a radiotap header and put that in front of the frame; if it does
72 * not do so then mac80211 may add this under certain circumstances.
Jiri Bencf0706e82007-05-05 11:45:53 -070073 */
74
Ron Rindjunsky10816d42007-11-26 16:14:30 +020075/**
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -040076 * DOC: mac80211 workqueue
77 *
78 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
79 * The workqueue is a single threaded workqueue and can only be accessed by
80 * helpers for sanity checking. Drivers must ensure all work added onto the
81 * mac80211 workqueue should be cancelled on the driver stop() callback.
82 *
83 * mac80211 will flushed the workqueue upon interface removal and during
84 * suspend.
85 *
86 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
87 *
88 */
89
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
Kalle Valo9d173fc2010-01-14 13:09:14 +0200110 * @uapsd: is U-APSD mode enabled for the queue
Johannes Berg6b301cd2007-09-18 17:29:20 -0400111 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700112struct ieee80211_tx_queue_params {
Johannes Bergf434b2d2008-07-10 11:22:31 +0200113 u16 txop;
Johannes Berg3330d7b2008-02-10 16:49:38 +0100114 u16 cw_min;
115 u16 cw_max;
Johannes Bergf434b2d2008-07-10 11:22:31 +0200116 u8 aifs;
Kalle Valoab133152010-01-12 10:42:31 +0200117 bool uapsd;
Jiri Bencf0706e82007-05-05 11:45:53 -0700118};
119
Jiri Bencf0706e82007-05-05 11:45:53 -0700120struct ieee80211_low_level_stats {
121 unsigned int dot11ACKFailureCount;
122 unsigned int dot11RTSFailureCount;
123 unsigned int dot11FCSErrorCount;
124 unsigned int dot11RTSSuccessCount;
125};
126
Johannes Berg471b3ef2007-12-28 14:32:58 +0100127/**
128 * enum ieee80211_bss_change - BSS change notification flags
129 *
130 * These flags are used with the bss_info_changed() callback
131 * to indicate which BSS parameter changed.
132 *
133 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
134 * also implies a change in the AID.
135 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
136 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300137 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler38668c02008-03-28 16:33:32 -0700138 * @BSS_CHANGED_HT: 802.11n parameters changed
Johannes Berg96dd22a2008-09-11 00:01:57 +0200139 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200140 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200141 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
142 * reason (IBSS and managed mode)
143 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
144 * new beacon (beaconing modes)
145 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
146 * enabled/disabled (beaconing modes)
Johannes Berg471b3ef2007-12-28 14:32:58 +0100147 */
148enum ieee80211_bss_change {
149 BSS_CHANGED_ASSOC = 1<<0,
150 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
151 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300152 BSS_CHANGED_ERP_SLOT = 1<<3,
Tomas Winkler38668c02008-03-28 16:33:32 -0700153 BSS_CHANGED_HT = 1<<4,
Johannes Berg96dd22a2008-09-11 00:01:57 +0200154 BSS_CHANGED_BASIC_RATES = 1<<5,
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200155 BSS_CHANGED_BEACON_INT = 1<<6,
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200156 BSS_CHANGED_BSSID = 1<<7,
157 BSS_CHANGED_BEACON = 1<<8,
158 BSS_CHANGED_BEACON_ENABLED = 1<<9,
Johannes Berg471b3ef2007-12-28 14:32:58 +0100159};
160
161/**
162 * struct ieee80211_bss_conf - holds the BSS's changing parameters
163 *
164 * This structure keeps information about a BSS (and an association
165 * to that BSS) that can change during the lifetime of the BSS.
166 *
167 * @assoc: association status
168 * @aid: association ID number, valid only when @assoc is true
169 * @use_cts_prot: use CTS protection
Johannes Berg7a5158e2008-10-08 10:59:33 +0200170 * @use_short_preamble: use 802.11b short preamble;
171 * if the hardware cannot handle this it must set the
172 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
173 * @use_short_slot: use short slot time (only relevant for ERP);
174 * if the hardware cannot handle this it must set the
175 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
Johannes Berg56007a02010-01-26 14:19:52 +0100176 * @dtim_period: num of beacons before the next DTIM, for beaconing,
177 * not valid in station mode (cf. hw conf ps_dtim_period)
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700178 * @timestamp: beacon timestamp
179 * @beacon_int: beacon interval
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800180 * @assoc_capability: capabilities taken from assoc resp
Johannes Berg96dd22a2008-09-11 00:01:57 +0200181 * @basic_rates: bitmap of basic rates, each bit stands for an
182 * index into the rate table configured by the driver in
183 * the current band.
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200184 * @bssid: The BSSID for this BSS
185 * @enable_beacon: whether beaconing should be enabled or not
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200186 * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
187 * This field is only valid when the channel type is one of the HT types.
Johannes Berg471b3ef2007-12-28 14:32:58 +0100188 */
189struct ieee80211_bss_conf {
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200190 const u8 *bssid;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100191 /* association related data */
192 bool assoc;
193 u16 aid;
194 /* erp related data */
195 bool use_cts_prot;
196 bool use_short_preamble;
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300197 bool use_short_slot;
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200198 bool enable_beacon;
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800199 u8 dtim_period;
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700200 u16 beacon_int;
201 u16 assoc_capability;
202 u64 timestamp;
Johannes Berg881d9482009-01-21 15:13:48 +0100203 u32 basic_rates;
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200204 u16 ht_operation_mode;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100205};
206
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800207/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700208 * enum mac80211_tx_control_flags - flags to describe transmission information/status
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800209 *
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700210 * These flags are used with the @flags member of &ieee80211_tx_info.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800211 *
Johannes Berg7351c6b2009-11-19 01:08:30 +0100212 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
Johannes Berge6a98542008-10-21 12:40:02 +0200213 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
214 * number to this frame, taking care of not overwriting the fragment
215 * number and increasing the sequence number only when the
216 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
217 * assign sequence numbers to QoS-data frames but cannot do so correctly
218 * for non-QoS-data and management frames because beacons need them from
219 * that counter as well and mac80211 cannot guarantee proper sequencing.
220 * If this flag is set, the driver should instruct the hardware to
221 * assign a sequence number to the frame or assign one itself. Cf. IEEE
222 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
223 * beacons and always be clear for frames without a sequence number field.
Johannes Berge039fa42008-05-15 12:55:29 +0200224 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
Johannes Berge039fa42008-05-15 12:55:29 +0200225 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
226 * station
Johannes Berge039fa42008-05-15 12:55:29 +0200227 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
Johannes Berge039fa42008-05-15 12:55:29 +0200228 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
229 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
Johannes Berge6a98542008-10-21 12:40:02 +0200230 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
Johannes Berge039fa42008-05-15 12:55:29 +0200231 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
Johannes Bergab5b5342009-08-07 16:28:09 +0200232 * because the destination STA was in powersave mode. Note that to
233 * avoid race conditions, the filter must be set by the hardware or
234 * firmware upon receiving a frame that indicates that the station
235 * went to sleep (must be done on device to filter frames already on
236 * the queue) and may only be unset after mac80211 gives the OK for
237 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
238 * since only then is it guaranteed that no more frames are in the
239 * hardware queue.
Johannes Berge039fa42008-05-15 12:55:29 +0200240 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
241 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
242 * is for the whole aggregation.
Ron Rindjunsky429a3802008-07-01 14:16:03 +0300243 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
244 * so consider using block ack request (BAR).
Johannes Berge6a98542008-10-21 12:40:02 +0200245 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
246 * set by rate control algorithms to indicate probe rate, will
247 * be cleared for fragmented frames (except on the last fragment)
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100248 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
249 * used to indicate that a pending frame requires TX processing before
250 * it can be sent out.
Johannes Berg8f77f382009-06-07 21:58:37 +0200251 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
252 * used to indicate that a frame was already retried due to PS
Johannes Berg3b8d81e02009-06-17 17:43:56 +0200253 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
254 * used to indicate frame should not be encrypted
Johannes Berg3fa52052009-07-24 13:23:09 +0200255 * @IEEE80211_TX_CTL_PSPOLL_RESPONSE: (internal?)
256 * This frame is a response to a PS-poll frame and should be sent
257 * although the station is in powersave mode.
Johannes Bergad5351d2009-08-07 16:42:15 +0200258 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
259 * transmit function after the current frame, this can be used
260 * by drivers to kick the DMA queue only if unset or when the
261 * queue gets full.
Johannes Bergc6fcf6b2010-01-17 01:47:59 +0100262 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
263 * after TX status because the destination was asleep, it must not
264 * be modified again (no seqno assignment, crypto, etc.)
Felix Fietkau17ad3532010-01-31 21:56:25 +0100265 * @IEEE80211_TX_INTFL_HAS_RADIOTAP: This frame was injected and still
266 * has a radiotap header at skb->data.
Jouni Malinen026331c2010-02-15 12:53:10 +0200267 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
268 * MLME command (internal to mac80211 to figure out whether to send TX
269 * status to user space)
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800270 */
271enum mac80211_tx_control_flags {
Johannes Berge039fa42008-05-15 12:55:29 +0200272 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
Johannes Berge6a98542008-10-21 12:40:02 +0200273 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
274 IEEE80211_TX_CTL_NO_ACK = BIT(2),
275 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
276 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
277 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
278 IEEE80211_TX_CTL_AMPDU = BIT(6),
279 IEEE80211_TX_CTL_INJECTED = BIT(7),
280 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
281 IEEE80211_TX_STAT_ACK = BIT(9),
282 IEEE80211_TX_STAT_AMPDU = BIT(10),
283 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
284 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100285 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
Johannes Berg8f77f382009-06-07 21:58:37 +0200286 IEEE80211_TX_INTFL_RETRIED = BIT(15),
Johannes Berg3b8d81e02009-06-17 17:43:56 +0200287 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
Johannes Berg3fa52052009-07-24 13:23:09 +0200288 IEEE80211_TX_CTL_PSPOLL_RESPONSE = BIT(17),
Johannes Bergad5351d2009-08-07 16:42:15 +0200289 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
Johannes Bergc6fcf6b2010-01-17 01:47:59 +0100290 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
Felix Fietkau17ad3532010-01-31 21:56:25 +0100291 IEEE80211_TX_INTFL_HAS_RADIOTAP = BIT(20),
Jouni Malinen026331c2010-02-15 12:53:10 +0200292 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
Johannes Berge6a98542008-10-21 12:40:02 +0200293};
294
Sujith2134e7e2009-01-22 09:00:52 +0530295/**
296 * enum mac80211_rate_control_flags - per-rate flags set by the
297 * Rate Control algorithm.
298 *
299 * These flags are set by the Rate control algorithm for each rate during tx,
300 * in the @flags member of struct ieee80211_tx_rate.
301 *
302 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
303 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
304 * This is set if the current BSS requires ERP protection.
305 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
306 * @IEEE80211_TX_RC_MCS: HT rate.
307 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
308 * Greenfield mode.
309 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
310 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
311 * adjacent 20 MHz channels, if the current channel type is
312 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
313 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
314 */
Johannes Berge6a98542008-10-21 12:40:02 +0200315enum mac80211_rate_control_flags {
316 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
317 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
318 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
319
320 /* rate index is an MCS rate number instead of an index */
321 IEEE80211_TX_RC_MCS = BIT(3),
322 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
323 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
324 IEEE80211_TX_RC_DUP_DATA = BIT(6),
325 IEEE80211_TX_RC_SHORT_GI = BIT(7),
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800326};
327
Johannes Berge039fa42008-05-15 12:55:29 +0200328
Johannes Berge6a98542008-10-21 12:40:02 +0200329/* there are 40 bytes if you don't need the rateset to be kept */
330#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
Johannes Berge039fa42008-05-15 12:55:29 +0200331
Johannes Berge6a98542008-10-21 12:40:02 +0200332/* if you do need the rateset, then you have less space */
333#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
334
335/* maximum number of rate stages */
336#define IEEE80211_TX_MAX_RATES 5
Felix Fietkau870abdf2008-10-05 18:04:24 +0200337
338/**
Johannes Berge6a98542008-10-21 12:40:02 +0200339 * struct ieee80211_tx_rate - rate selection/status
Felix Fietkau870abdf2008-10-05 18:04:24 +0200340 *
Johannes Berge6a98542008-10-21 12:40:02 +0200341 * @idx: rate index to attempt to send with
342 * @flags: rate control flags (&enum mac80211_rate_control_flags)
Johannes Berge25cf4a2008-10-23 08:51:20 +0200343 * @count: number of tries in this rate before going to the next rate
Johannes Berge6a98542008-10-21 12:40:02 +0200344 *
345 * A value of -1 for @idx indicates an invalid rate and, if used
346 * in an array of retry rates, that no more rates should be tried.
347 *
348 * When used for transmit status reporting, the driver should
349 * always report the rate along with the flags it used.
Johannes Bergc555b9b2009-08-07 16:23:43 +0200350 *
351 * &struct ieee80211_tx_info contains an array of these structs
352 * in the control information, and it will be filled by the rate
353 * control algorithm according to what should be sent. For example,
354 * if this array contains, in the format { <idx>, <count> } the
355 * information
356 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
357 * then this means that the frame should be transmitted
358 * up to twice at rate 3, up to twice at rate 2, and up to four
359 * times at rate 1 if it doesn't get acknowledged. Say it gets
360 * acknowledged by the peer after the fifth attempt, the status
361 * information should then contain
362 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
363 * since it was transmitted twice at rate 3, twice at rate 2
364 * and once at rate 1 after which we received an acknowledgement.
Felix Fietkau870abdf2008-10-05 18:04:24 +0200365 */
Johannes Berge6a98542008-10-21 12:40:02 +0200366struct ieee80211_tx_rate {
367 s8 idx;
368 u8 count;
369 u8 flags;
Felix Fietkau48212772008-11-03 21:05:01 +0100370} __attribute__((packed));
Felix Fietkau870abdf2008-10-05 18:04:24 +0200371
Johannes Berge039fa42008-05-15 12:55:29 +0200372/**
373 * struct ieee80211_tx_info - skb transmit information
Ivo van Doorn1c014422008-04-17 19:41:02 +0200374 *
Johannes Berge039fa42008-05-15 12:55:29 +0200375 * This structure is placed in skb->cb for three uses:
376 * (1) mac80211 TX control - mac80211 tells the driver what to do
377 * (2) driver internal use (if applicable)
378 * (3) TX status information - driver tells mac80211 what happened
379 *
Johannes Berg17741cd2008-09-11 00:02:02 +0200380 * The TX control's sta pointer is only valid during the ->tx call,
381 * it may be NULL.
382 *
Johannes Berge039fa42008-05-15 12:55:29 +0200383 * @flags: transmit info flags, defined above
Johannes Berge6a98542008-10-21 12:40:02 +0200384 * @band: the band to transmit on (use for checking for races)
Johannes Berg0f4ac382008-10-09 12:18:04 +0200385 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
Kalle Valo8bef7a12008-11-30 20:56:28 +0200386 * @pad: padding, ignore
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700387 * @control: union for control data
388 * @status: union for status data
389 * @driver_data: array of driver_data pointers
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100390 * @ampdu_ack_len: number of acked aggregated frames.
Johannes Berge039fa42008-05-15 12:55:29 +0200391 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
392 * @ampdu_ack_map: block ack bit map for the aggregation.
393 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100394 * @ampdu_len: number of aggregated frames.
395 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
Johannes Berge039fa42008-05-15 12:55:29 +0200396 * @ack_signal: signal strength of the ACK frame
Ivo van Doorn1c014422008-04-17 19:41:02 +0200397 */
Johannes Berge039fa42008-05-15 12:55:29 +0200398struct ieee80211_tx_info {
399 /* common information */
400 u32 flags;
401 u8 band;
Johannes Berge6a98542008-10-21 12:40:02 +0200402
Johannes Berge039fa42008-05-15 12:55:29 +0200403 u8 antenna_sel_tx;
Johannes Berg8318d782008-01-24 19:38:38 +0100404
Johannes Berge6a98542008-10-21 12:40:02 +0200405 /* 2 byte hole */
John W. Linville62727102008-11-12 10:01:41 -0500406 u8 pad[2];
Johannes Berg8318d782008-01-24 19:38:38 +0100407
Johannes Berge039fa42008-05-15 12:55:29 +0200408 union {
409 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200410 union {
411 /* rate control */
412 struct {
413 struct ieee80211_tx_rate rates[
414 IEEE80211_TX_MAX_RATES];
415 s8 rts_cts_rate_idx;
416 };
417 /* only needed before rate control */
418 unsigned long jiffies;
419 };
Johannes Berg25d834e2008-09-12 22:52:47 +0200420 /* NB: vif can be NULL for injected frames */
Johannes Berge039fa42008-05-15 12:55:29 +0200421 struct ieee80211_vif *vif;
422 struct ieee80211_key_conf *hw_key;
Johannes Berg17741cd2008-09-11 00:02:02 +0200423 struct ieee80211_sta *sta;
Johannes Berge039fa42008-05-15 12:55:29 +0200424 } control;
425 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200426 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
427 u8 ampdu_ack_len;
Johannes Berge039fa42008-05-15 12:55:29 +0200428 u64 ampdu_ack_map;
429 int ack_signal;
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100430 u8 ampdu_len;
431 /* 7 bytes free */
Johannes Berge039fa42008-05-15 12:55:29 +0200432 } status;
Johannes Berge6a98542008-10-21 12:40:02 +0200433 struct {
434 struct ieee80211_tx_rate driver_rates[
435 IEEE80211_TX_MAX_RATES];
436 void *rate_driver_data[
437 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
438 };
439 void *driver_data[
440 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
Johannes Berge039fa42008-05-15 12:55:29 +0200441 };
Jiri Bencf0706e82007-05-05 11:45:53 -0700442};
443
Johannes Berge039fa42008-05-15 12:55:29 +0200444static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
445{
446 return (struct ieee80211_tx_info *)skb->cb;
447}
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400448
Johannes Bergf1d58c22009-06-17 13:13:00 +0200449static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
450{
451 return (struct ieee80211_rx_status *)skb->cb;
452}
453
Johannes Berge6a98542008-10-21 12:40:02 +0200454/**
455 * ieee80211_tx_info_clear_status - clear TX status
456 *
457 * @info: The &struct ieee80211_tx_info to be cleared.
458 *
459 * When the driver passes an skb back to mac80211, it must report
460 * a number of things in TX status. This function clears everything
461 * in the TX status but the rate control information (it does clear
462 * the count since you need to fill that in anyway).
463 *
464 * NOTE: You can only use this function if you do NOT use
465 * info->driver_data! Use info->rate_driver_data
466 * instead if you need only the less space that allows.
467 */
468static inline void
469ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
470{
471 int i;
472
473 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
474 offsetof(struct ieee80211_tx_info, control.rates));
475 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
476 offsetof(struct ieee80211_tx_info, driver_rates));
477 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
478 /* clear the rate counts */
479 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
480 info->status.rates[i].count = 0;
481
482 BUILD_BUG_ON(
483 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
484 memset(&info->status.ampdu_ack_len, 0,
485 sizeof(struct ieee80211_tx_info) -
486 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
487}
488
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400489
490/**
491 * enum mac80211_rx_flags - receive flags
492 *
493 * These flags are used with the @flag member of &struct ieee80211_rx_status.
494 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
495 * Use together with %RX_FLAG_MMIC_STRIPPED.
496 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400497 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
498 * verification has been done by the hardware.
499 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
500 * If this flag is set, the stack cannot do any replay detection
501 * hence the driver or hardware will have to do that.
Johannes Berg72abd812007-09-17 01:29:22 -0400502 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
503 * the frame.
504 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
505 * the frame.
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100506 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
Bruno Randolf9d9bf772008-02-18 11:21:36 +0900507 * is valid. This is useful in monitor mode and necessary for beacon frames
508 * to enable IBSS merging.
Bruno Randolfb4f28bb2008-07-30 17:19:55 +0200509 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200510 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
511 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
512 * @RX_FLAG_SHORT_GI: Short guard interval was used
Johannes Berg8c0c7092009-11-25 17:46:15 +0100513 * @RX_FLAG_INTERNAL_CMTR: set internally after frame was reported
514 * on cooked monitor to avoid double-reporting it for multiple
515 * virtual interfaces
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400516 */
517enum mac80211_rx_flags {
518 RX_FLAG_MMIC_ERROR = 1<<0,
519 RX_FLAG_DECRYPTED = 1<<1,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400520 RX_FLAG_MMIC_STRIPPED = 1<<3,
521 RX_FLAG_IV_STRIPPED = 1<<4,
Johannes Berg72abd812007-09-17 01:29:22 -0400522 RX_FLAG_FAILED_FCS_CRC = 1<<5,
523 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100524 RX_FLAG_TSFT = 1<<7,
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200525 RX_FLAG_SHORTPRE = 1<<8,
526 RX_FLAG_HT = 1<<9,
527 RX_FLAG_40MHZ = 1<<10,
528 RX_FLAG_SHORT_GI = 1<<11,
Johannes Berg8c0c7092009-11-25 17:46:15 +0100529 RX_FLAG_INTERNAL_CMTR = 1<<12,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400530};
531
532/**
533 * struct ieee80211_rx_status - receive status
534 *
535 * The low-level driver should provide this information (the subset
536 * supported by hardware) to the 802.11 code with each received
Johannes Bergf1d58c22009-06-17 13:13:00 +0200537 * frame, in the skb's control buffer (cb).
Bruno Randolf566bfe52008-05-08 19:15:40 +0200538 *
Bruno Randolfc132bec2008-02-18 11:20:51 +0900539 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
540 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
Johannes Berg8318d782008-01-24 19:38:38 +0100541 * @band: the active band when this frame was received
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400542 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
Bruno Randolf566bfe52008-05-08 19:15:40 +0200543 * @signal: signal strength when receiving this frame, either in dBm, in dB or
544 * unspecified depending on the hardware capabilities flags
545 * @IEEE80211_HW_SIGNAL_*
546 * @noise: noise when receiving this frame, in dBm.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400547 * @antenna: antenna used
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200548 * @rate_idx: index of data rate into band's supported rates or MCS index if
549 * HT rates are use (RX_FLAG_HT)
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400550 * @flag: %RX_FLAG_*
551 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700552struct ieee80211_rx_status {
553 u64 mactime;
Johannes Berg8318d782008-01-24 19:38:38 +0100554 enum ieee80211_band band;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400555 int freq;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400556 int signal;
Jiri Bencf0706e82007-05-05 11:45:53 -0700557 int noise;
558 int antenna;
Johannes Berg8318d782008-01-24 19:38:38 +0100559 int rate_idx;
Jiri Bencf0706e82007-05-05 11:45:53 -0700560 int flag;
561};
562
Johannes Berg6b301cd2007-09-18 17:29:20 -0400563/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400564 * enum ieee80211_conf_flags - configuration flags
565 *
566 * Flags to define PHY configuration options
567 *
Johannes Berg0869aea2009-10-28 10:03:35 +0100568 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
569 * to determine for example whether to calculate timestamps for packets
570 * or not, do not use instead of filter flags!
Kalle Valoc99445b2010-01-14 13:09:21 +0200571 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
572 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
573 * meaning that the hardware still wakes up for beacons, is able to
574 * transmit frames and receive the possible acknowledgment frames.
575 * Not to be confused with hardware specific wakeup/sleep states,
576 * driver is responsible for that. See the section "Powersave support"
577 * for more.
Johannes Berg5cff20e2009-04-29 12:26:17 +0200578 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
579 * the driver should be prepared to handle configuration requests but
580 * may turn the device off as much as possible. Typically, this flag will
581 * be set when an interface is set UP but not associated or scanning, but
582 * it can also be unset in that case when monitor interfaces are active.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400583 */
584enum ieee80211_conf_flags {
Johannes Berg0869aea2009-10-28 10:03:35 +0100585 IEEE80211_CONF_MONITOR = (1<<0),
Johannes Bergae5eb022008-10-14 16:58:37 +0200586 IEEE80211_CONF_PS = (1<<1),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200587 IEEE80211_CONF_IDLE = (1<<2),
Johannes Berg6b301cd2007-09-18 17:29:20 -0400588};
Jiri Bencf0706e82007-05-05 11:45:53 -0700589
Johannes Berg7a5158e2008-10-08 10:59:33 +0200590
Jiri Bencf0706e82007-05-05 11:45:53 -0700591/**
Johannes Berge8975582008-10-09 12:18:51 +0200592 * enum ieee80211_conf_changed - denotes which configuration changed
593 *
Johannes Berge8975582008-10-09 12:18:51 +0200594 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
Johannes Berg0869aea2009-10-28 10:03:35 +0100595 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
Johannes Berge255d5e2009-04-22 12:40:07 +0200596 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
Johannes Berge8975582008-10-09 12:18:51 +0200597 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
Johannes Berg47979382009-01-07 10:13:27 +0100598 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
Johannes Berg9124b072008-10-14 19:17:54 +0200599 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
Johannes Berg5cff20e2009-04-29 12:26:17 +0200600 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
Johannes Berg0f782312009-12-01 13:37:02 +0100601 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
Johannes Berge8975582008-10-09 12:18:51 +0200602 */
603enum ieee80211_conf_changed {
Johannes Berg0f782312009-12-01 13:37:02 +0100604 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
Johannes Berge8975582008-10-09 12:18:51 +0200605 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
Johannes Berg0869aea2009-10-28 10:03:35 +0100606 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
Johannes Berge8975582008-10-09 12:18:51 +0200607 IEEE80211_CONF_CHANGE_PS = BIT(4),
Johannes Berge255d5e2009-04-22 12:40:07 +0200608 IEEE80211_CONF_CHANGE_POWER = BIT(5),
609 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
610 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200611 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
Johannes Berge8975582008-10-09 12:18:51 +0200612};
613
614/**
Johannes Berg0f782312009-12-01 13:37:02 +0100615 * enum ieee80211_smps_mode - spatial multiplexing power save mode
616 *
Kalle Valo9d173fc2010-01-14 13:09:14 +0200617 * @IEEE80211_SMPS_AUTOMATIC: automatic
618 * @IEEE80211_SMPS_OFF: off
619 * @IEEE80211_SMPS_STATIC: static
620 * @IEEE80211_SMPS_DYNAMIC: dynamic
621 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
Johannes Berg0f782312009-12-01 13:37:02 +0100622 */
623enum ieee80211_smps_mode {
624 IEEE80211_SMPS_AUTOMATIC,
625 IEEE80211_SMPS_OFF,
626 IEEE80211_SMPS_STATIC,
627 IEEE80211_SMPS_DYNAMIC,
628
629 /* keep last */
630 IEEE80211_SMPS_NUM_MODES,
631};
632
633/**
Jiri Bencf0706e82007-05-05 11:45:53 -0700634 * struct ieee80211_conf - configuration of the device
635 *
636 * This struct indicates how the driver shall configure the hardware.
637 *
Johannes Berg04fe2032009-04-22 18:44:37 +0200638 * @flags: configuration flags defined above
639 *
Tomas Winklerea95bba2008-07-18 13:53:00 +0800640 * @listen_interval: listen interval in units of beacon interval
Johannes Berg9ccebe62009-04-23 10:32:36 +0200641 * @max_sleep_period: the maximum number of beacon intervals to sleep for
Johannes Berg04fe2032009-04-22 18:44:37 +0200642 * before checking the beacon for a TIM bit (managed mode only); this
643 * value will be only achievable between DTIM frames, the hardware
644 * needs to check for the multicast traffic bit in DTIM beacons.
645 * This variable is valid only when the CONF_PS flag is set.
Johannes Berg56007a02010-01-26 14:19:52 +0100646 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
647 * in power saving. Power saving will not be enabled until a beacon
648 * has been received and the DTIM period is known.
Johannes Berg04fe2032009-04-22 18:44:37 +0200649 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
650 * powersave documentation below. This variable is valid only when
651 * the CONF_PS flag is set.
652 *
Johannes Berg8318d782008-01-24 19:38:38 +0100653 * @power_level: requested transmit power (in dBm)
Johannes Berg04fe2032009-04-22 18:44:37 +0200654 *
Johannes Berg8318d782008-01-24 19:38:38 +0100655 * @channel: the channel to tune to
Johannes Berg47979382009-01-07 10:13:27 +0100656 * @channel_type: the channel (HT) type
Johannes Berg04fe2032009-04-22 18:44:37 +0200657 *
Johannes Berg9124b072008-10-14 19:17:54 +0200658 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
659 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
660 * but actually means the number of transmissions not the number of retries
661 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
662 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
663 * number of transmissions not the number of retries
Johannes Berg0f782312009-12-01 13:37:02 +0100664 *
665 * @smps_mode: spatial multiplexing powersave mode; note that
666 * %IEEE80211_SMPS_STATIC is used when the device is not
667 * configured for an HT channel
Jiri Bencf0706e82007-05-05 11:45:53 -0700668 */
669struct ieee80211_conf {
Johannes Berg6b301cd2007-09-18 17:29:20 -0400670 u32 flags;
Johannes Berg46f2c4b2009-01-06 18:13:18 +0100671 int power_level, dynamic_ps_timeout;
Johannes Berg9ccebe62009-04-23 10:32:36 +0200672 int max_sleep_period;
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200673
Johannes Berge8975582008-10-09 12:18:51 +0200674 u16 listen_interval;
Johannes Berg56007a02010-01-26 14:19:52 +0100675 u8 ps_dtim_period;
Johannes Berge8975582008-10-09 12:18:51 +0200676
Johannes Berg9124b072008-10-14 19:17:54 +0200677 u8 long_frame_max_tx_count, short_frame_max_tx_count;
678
Johannes Berg8318d782008-01-24 19:38:38 +0100679 struct ieee80211_channel *channel;
Johannes Berg47979382009-01-07 10:13:27 +0100680 enum nl80211_channel_type channel_type;
Johannes Berg0f782312009-12-01 13:37:02 +0100681 enum ieee80211_smps_mode smps_mode;
Jiri Bencf0706e82007-05-05 11:45:53 -0700682};
683
684/**
Johannes Berg32bfd352007-12-19 01:31:26 +0100685 * struct ieee80211_vif - per-interface data
686 *
687 * Data in this structure is continually present for driver
688 * use during the life of a virtual interface.
689 *
Johannes Berg51fb61e2007-12-19 01:31:27 +0100690 * @type: type of this virtual interface
Johannes Bergbda39332008-10-11 01:51:51 +0200691 * @bss_conf: BSS configuration for this interface, either our own
692 * or the BSS we're associated to
Johannes Berg47846c92009-11-25 17:46:19 +0100693 * @addr: address of this interface
Johannes Berg32bfd352007-12-19 01:31:26 +0100694 * @drv_priv: data area for driver use, will always be aligned to
695 * sizeof(void *).
696 */
697struct ieee80211_vif {
Johannes Berg05c914f2008-09-11 00:01:58 +0200698 enum nl80211_iftype type;
Johannes Bergbda39332008-10-11 01:51:51 +0200699 struct ieee80211_bss_conf bss_conf;
Johannes Berg47846c92009-11-25 17:46:19 +0100700 u8 addr[ETH_ALEN];
Johannes Berg32bfd352007-12-19 01:31:26 +0100701 /* must be last */
702 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
703};
704
Johannes Berg902acc72008-02-23 15:17:19 +0100705static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
706{
707#ifdef CONFIG_MAC80211_MESH
Johannes Berg05c914f2008-09-11 00:01:58 +0200708 return vif->type == NL80211_IFTYPE_MESH_POINT;
Johannes Berg902acc72008-02-23 15:17:19 +0100709#endif
710 return false;
711}
712
Johannes Berg32bfd352007-12-19 01:31:26 +0100713/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400714 * enum ieee80211_key_alg - key algorithm
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400715 * @ALG_WEP: WEP40 or WEP104
716 * @ALG_TKIP: TKIP
717 * @ALG_CCMP: CCMP (AES)
Jouni Malinen3cfcf6ac2009-01-08 13:32:02 +0200718 * @ALG_AES_CMAC: AES-128-CMAC
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400719 */
Johannes Bergea49c352007-09-18 17:29:21 -0400720enum ieee80211_key_alg {
Johannes Berg8f20fc22007-08-28 17:01:54 -0400721 ALG_WEP,
722 ALG_TKIP,
723 ALG_CCMP,
Jouni Malinen3cfcf6ac2009-01-08 13:32:02 +0200724 ALG_AES_CMAC,
Johannes Bergea49c352007-09-18 17:29:21 -0400725};
Jiri Bencf0706e82007-05-05 11:45:53 -0700726
Emmanuel Grumbach23976ef2008-06-28 02:50:13 +0300727/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400728 * enum ieee80211_key_flags - key flags
729 *
730 * These flags are used for communication about keys between the driver
731 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
732 *
733 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
734 * that the STA this key will be used with could be using QoS.
735 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
736 * driver to indicate that it requires IV generation for this
737 * particular key.
738 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
739 * the driver for a TKIP key if it requires Michael MIC
740 * generation in software.
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200741 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
742 * that the key is pairwise rather then a shared key.
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200743 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
744 * CCMP key if it requires CCMP encryption of management frames (MFP) to
745 * be done in software.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400746 */
747enum ieee80211_key_flags {
748 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
749 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
750 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200751 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200752 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400753};
754
755/**
756 * struct ieee80211_key_conf - key information
757 *
758 * This key information is given by mac80211 to the driver by
759 * the set_key() callback in &struct ieee80211_ops.
760 *
761 * @hw_key_idx: To be set by the driver, this is the key index the driver
762 * wants to be given when a frame is transmitted and needs to be
Johannes Berg6a7664d2007-09-14 11:10:25 -0400763 * encrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400764 * @alg: The key algorithm.
765 * @flags: key flags, see &enum ieee80211_key_flags.
766 * @keyidx: the key index (0-3)
767 * @keylen: key material length
Luis R. Rodriguezffd78912008-06-21 10:02:46 -0400768 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
769 * data block:
770 * - Temporal Encryption Key (128 bits)
771 * - Temporal Authenticator Tx MIC Key (64 bits)
772 * - Temporal Authenticator Rx MIC Key (64 bits)
Johannes Bergdc822b52008-12-29 12:55:09 +0100773 * @icv_len: The ICV length for this key type
774 * @iv_len: The IV length for this key type
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400775 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700776struct ieee80211_key_conf {
Johannes Bergea49c352007-09-18 17:29:21 -0400777 enum ieee80211_key_alg alg;
Felix Fietkau76708de2008-10-05 18:02:48 +0200778 u8 icv_len;
779 u8 iv_len;
Johannes Berg6a7664d2007-09-14 11:10:25 -0400780 u8 hw_key_idx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400781 u8 flags;
Johannes Berg11a843b2007-08-28 17:01:55 -0400782 s8 keyidx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400783 u8 keylen;
Jiri Bencf0706e82007-05-05 11:45:53 -0700784 u8 key[0];
785};
786
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400787/**
788 * enum set_key_cmd - key command
789 *
790 * Used with the set_key() callback in &struct ieee80211_ops, this
791 * indicates whether a key is being removed or added.
792 *
793 * @SET_KEY: a key is set
794 * @DISABLE_KEY: a key must be disabled
795 */
Johannes Bergea49c352007-09-18 17:29:21 -0400796enum set_key_cmd {
Johannes Berg11a843b2007-08-28 17:01:55 -0400797 SET_KEY, DISABLE_KEY,
Johannes Bergea49c352007-09-18 17:29:21 -0400798};
Jiri Bencf0706e82007-05-05 11:45:53 -0700799
Tomas Winkler478f8d22007-09-30 13:52:37 +0200800/**
Johannes Berg17741cd2008-09-11 00:02:02 +0200801 * struct ieee80211_sta - station table entry
802 *
803 * A station table entry represents a station we are possibly
804 * communicating with. Since stations are RCU-managed in
805 * mac80211, any ieee80211_sta pointer you get access to must
806 * either be protected by rcu_read_lock() explicitly or implicitly,
807 * or you must take good care to not use such a pointer after a
Johannes Berg34e89502010-02-03 13:59:58 +0100808 * call to your sta_remove callback that removed it.
Johannes Berg17741cd2008-09-11 00:02:02 +0200809 *
810 * @addr: MAC address
811 * @aid: AID we assigned to the station if we're an AP
Johannes Berg323ce792008-09-11 02:45:11 +0200812 * @supp_rates: Bitmap of supported rates (per band)
Johannes Bergae5eb022008-10-14 16:58:37 +0200813 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
Johannes Berg17741cd2008-09-11 00:02:02 +0200814 * @drv_priv: data area for driver use, will always be aligned to
815 * sizeof(void *), size is determined in hw information.
816 */
817struct ieee80211_sta {
Johannes Berg881d9482009-01-21 15:13:48 +0100818 u32 supp_rates[IEEE80211_NUM_BANDS];
Johannes Berg17741cd2008-09-11 00:02:02 +0200819 u8 addr[ETH_ALEN];
820 u16 aid;
Johannes Bergd9fe60d2008-10-09 12:13:49 +0200821 struct ieee80211_sta_ht_cap ht_cap;
Johannes Berg17741cd2008-09-11 00:02:02 +0200822
823 /* must be last */
824 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
825};
826
827/**
Tomas Winkler478f8d22007-09-30 13:52:37 +0200828 * enum sta_notify_cmd - sta notify command
829 *
830 * Used with the sta_notify() callback in &struct ieee80211_ops, this
Christian Lamparter89fad572008-12-09 16:28:06 +0100831 * indicates addition and removal of a station to station table,
832 * or if a associated station made a power state transition.
Tomas Winkler478f8d22007-09-30 13:52:37 +0200833 *
Johannes Berg34e89502010-02-03 13:59:58 +0100834 * @STA_NOTIFY_ADD: (DEPRECATED) a station was added to the station table
835 * @STA_NOTIFY_REMOVE: (DEPRECATED) a station being removed from the station table
Christian Lamparter4571d3b2008-11-30 00:48:41 +0100836 * @STA_NOTIFY_SLEEP: a station is now sleeping
837 * @STA_NOTIFY_AWAKE: a sleeping station woke up
838 */
Christian Lamparter89fad572008-12-09 16:28:06 +0100839enum sta_notify_cmd {
840 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE,
Christian Lamparter4571d3b2008-11-30 00:48:41 +0100841 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
842};
843
844/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +0200845 * enum ieee80211_tkip_key_type - get tkip key
846 *
847 * Used by drivers which need to get a tkip key for skb. Some drivers need a
848 * phase 1 key, others need a phase 2 key. A single function allows the driver
849 * to get the key, this enum indicates what type of key is required.
850 *
851 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
852 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
853 */
854enum ieee80211_tkip_key_type {
855 IEEE80211_TKIP_P1_KEY,
856 IEEE80211_TKIP_P2_KEY,
857};
858
859/**
Johannes Berg1bc08262007-09-18 17:29:15 -0400860 * enum ieee80211_hw_flags - hardware flags
861 *
862 * These flags are used to indicate hardware capabilities to
863 * the stack. Generally, flags here should have their meaning
864 * done in a way that the simplest hardware doesn't need setting
865 * any particular flags. There are some exceptions to this rule,
866 * however, so you are advised to review these flags carefully.
867 *
Johannes Bergaf65cd962009-11-17 18:18:36 +0100868 * @IEEE80211_HW_HAS_RATE_CONTROL:
869 * The hardware or firmware includes rate control, and cannot be
870 * controlled by the stack. As such, no rate control algorithm
871 * should be instantiated, and the TX rate reported to userspace
872 * will be taken from the TX status instead of the rate control
873 * algorithm.
874 * Note that this requires that the driver implement a number of
875 * callbacks so it has the correct information, it needs to have
876 * the @set_rts_threshold callback and must look at the BSS config
877 * @use_cts_prot for G/N protection, @use_short_slot for slot
878 * timing in 2.4 GHz and @use_short_preamble for preambles for
879 * CCK frames.
880 *
Johannes Berg1bc08262007-09-18 17:29:15 -0400881 * @IEEE80211_HW_RX_INCLUDES_FCS:
882 * Indicates that received frames passed to the stack include
883 * the FCS at the end.
884 *
885 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
886 * Some wireless LAN chipsets buffer broadcast/multicast frames
887 * for power saving stations in the hardware/firmware and others
888 * rely on the host system for such buffering. This option is used
889 * to configure the IEEE 802.11 upper layer to buffer broadcast and
890 * multicast frames when there are power saving stations so that
Luis R. Rodriguez546c80c92008-08-14 11:43:20 -0700891 * the driver can fetch them with ieee80211_get_buffered_bc().
Johannes Berg1bc08262007-09-18 17:29:15 -0400892 *
Johannes Berg8318d782008-01-24 19:38:38 +0100893 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
894 * Hardware is not capable of short slot operation on the 2.4 GHz band.
895 *
896 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
897 * Hardware is not capable of receiving frames with short preamble on
898 * the 2.4 GHz band.
Bruno Randolf566bfe52008-05-08 19:15:40 +0200899 *
900 * @IEEE80211_HW_SIGNAL_UNSPEC:
901 * Hardware can provide signal values but we don't know its units. We
902 * expect values between 0 and @max_signal.
903 * If possible please provide dB or dBm instead.
904 *
Bruno Randolf566bfe52008-05-08 19:15:40 +0200905 * @IEEE80211_HW_SIGNAL_DBM:
906 * Hardware gives signal values in dBm, decibel difference from
907 * one milliwatt. This is the preferred method since it is standardized
908 * between different devices. @max_signal does not need to be set.
909 *
910 * @IEEE80211_HW_NOISE_DBM:
911 * Hardware can provide noise (radio interference) values in units dBm,
912 * decibel difference from one milliwatt.
Tomas Winkler06ff47b2008-06-18 17:53:44 +0300913 *
914 * @IEEE80211_HW_SPECTRUM_MGMT:
915 * Hardware supports spectrum management defined in 802.11h
916 * Measurement, Channel Switch, Quieting, TPC
Sujith8b30b1f2008-10-24 09:55:27 +0530917 *
918 * @IEEE80211_HW_AMPDU_AGGREGATION:
919 * Hardware supports 11n A-MPDU aggregation.
Kalle Valo520eb822008-12-18 23:35:27 +0200920 *
Johannes Berg4be8c382009-01-07 18:28:20 +0100921 * @IEEE80211_HW_SUPPORTS_PS:
922 * Hardware has power save support (i.e. can go to sleep).
923 *
924 * @IEEE80211_HW_PS_NULLFUNC_STACK:
925 * Hardware requires nullfunc frame handling in stack, implies
926 * stack support for dynamic PS.
927 *
928 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
929 * Hardware has support for dynamic PS.
Jouni Malinen4375d082009-01-08 13:32:11 +0200930 *
931 * @IEEE80211_HW_MFP_CAPABLE:
932 * Hardware supports management frame protection (MFP, IEEE 802.11w).
Kalle Valo04de8382009-03-22 21:57:35 +0200933 *
934 * @IEEE80211_HW_BEACON_FILTER:
935 * Hardware supports dropping of irrelevant beacon frames to
936 * avoid waking up cpu.
Johannes Berg0f782312009-12-01 13:37:02 +0100937 *
938 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
939 * Hardware supports static spatial multiplexing powersave,
940 * ie. can turn off all but one chain even on HT connections
941 * that should be using more chains.
942 *
943 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
944 * Hardware supports dynamic spatial multiplexing powersave,
945 * ie. can turn off all but one chain and then wake the rest
946 * up as required after, for example, rts/cts handshake.
Kalle Valoab133152010-01-12 10:42:31 +0200947 *
948 * @IEEE80211_HW_SUPPORTS_UAPSD:
949 * Hardware supports Unscheduled Automatic Power Save Delivery
950 * (U-APSD) in managed mode. The mode is configured with
951 * conf_tx() operation.
Vivek Natarajan375177b2010-02-09 14:50:28 +0530952 *
953 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
954 * Hardware can provide ack status reports of Tx frames to
955 * the stack.
956 *
Johannes Berg1bc08262007-09-18 17:29:15 -0400957 */
958enum ieee80211_hw_flags {
Johannes Bergaf65cd962009-11-17 18:18:36 +0100959 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
Johannes Berg1bc08262007-09-18 17:29:15 -0400960 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
961 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
Johannes Berg8318d782008-01-24 19:38:38 +0100962 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
963 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
Bruno Randolf566bfe52008-05-08 19:15:40 +0200964 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
Johannes Berg7fee5372009-01-30 11:13:06 +0100965 IEEE80211_HW_SIGNAL_DBM = 1<<6,
966 IEEE80211_HW_NOISE_DBM = 1<<7,
967 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
968 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
969 IEEE80211_HW_SUPPORTS_PS = 1<<10,
970 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
971 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
972 IEEE80211_HW_MFP_CAPABLE = 1<<13,
Kalle Valo04de8382009-03-22 21:57:35 +0200973 IEEE80211_HW_BEACON_FILTER = 1<<14,
Johannes Berg0f782312009-12-01 13:37:02 +0100974 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
975 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
Kalle Valoab133152010-01-12 10:42:31 +0200976 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
Vivek Natarajan375177b2010-02-09 14:50:28 +0530977 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
Johannes Berg1bc08262007-09-18 17:29:15 -0400978};
979
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400980/**
981 * struct ieee80211_hw - hardware information and state
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400982 *
983 * This structure contains the configuration and hardware
984 * information for an 802.11 PHY.
985 *
986 * @wiphy: This points to the &struct wiphy allocated for this
987 * 802.11 PHY. You must fill in the @perm_addr and @dev
988 * members of this structure using SET_IEEE80211_DEV()
Johannes Berg8318d782008-01-24 19:38:38 +0100989 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
990 * bands (with channels, bitrates) are registered here.
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400991 *
992 * @conf: &struct ieee80211_conf, device configuration, don't use.
993 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400994 * @priv: pointer to private area that was allocated for driver use
995 * along with this structure.
996 *
997 * @flags: hardware flags, see &enum ieee80211_hw_flags.
998 *
999 * @extra_tx_headroom: headroom to reserve in each transmit skb
1000 * for use by the driver (e.g. for transmit headers.)
1001 *
1002 * @channel_change_time: time (in microseconds) it takes to change channels.
1003 *
Bruno Randolf566bfe52008-05-08 19:15:40 +02001004 * @max_signal: Maximum value for signal (rssi) in RX information, used
1005 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001006 *
Tomas Winklerea95bba2008-07-18 13:53:00 +08001007 * @max_listen_interval: max listen interval in units of beacon interval
1008 * that HW supports
1009 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001010 * @queues: number of available hardware transmit queues for
Johannes Berge100bb62008-04-30 18:51:21 +02001011 * data packets. WMM/QoS requires at least four, these
1012 * queues need to have configurable access parameters.
1013 *
Johannes Berg830f9032007-10-28 14:51:05 +01001014 * @rate_control_algorithm: rate control algorithm for this hardware.
1015 * If unset (NULL), the default algorithm will be used. Must be
1016 * set before calling ieee80211_register_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001017 *
1018 * @vif_data_size: size (in bytes) of the drv_priv data area
1019 * within &struct ieee80211_vif.
Johannes Berg17741cd2008-09-11 00:02:02 +02001020 * @sta_data_size: size (in bytes) of the drv_priv data area
1021 * within &struct ieee80211_sta.
Felix Fietkau870abdf2008-10-05 18:04:24 +02001022 *
Johannes Berge6a98542008-10-21 12:40:02 +02001023 * @max_rates: maximum number of alternate rate retry stages
1024 * @max_rate_tries: maximum number of tries for each stage
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001025 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001026struct ieee80211_hw {
Jiri Bencf0706e82007-05-05 11:45:53 -07001027 struct ieee80211_conf conf;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001028 struct wiphy *wiphy;
Johannes Berg830f9032007-10-28 14:51:05 +01001029 const char *rate_control_algorithm;
Jiri Bencf0706e82007-05-05 11:45:53 -07001030 void *priv;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001031 u32 flags;
Jiri Bencf0706e82007-05-05 11:45:53 -07001032 unsigned int extra_tx_headroom;
Jiri Bencf0706e82007-05-05 11:45:53 -07001033 int channel_change_time;
Johannes Berg32bfd352007-12-19 01:31:26 +01001034 int vif_data_size;
Johannes Berg17741cd2008-09-11 00:02:02 +02001035 int sta_data_size;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001036 u16 queues;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001037 u16 max_listen_interval;
Jiri Bencf0706e82007-05-05 11:45:53 -07001038 s8 max_signal;
Johannes Berge6a98542008-10-21 12:40:02 +02001039 u8 max_rates;
1040 u8 max_rate_tries;
Jiri Bencf0706e82007-05-05 11:45:53 -07001041};
1042
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001043/**
Luis R. Rodriguez9a953712009-01-22 15:05:53 -08001044 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1045 *
1046 * @wiphy: the &struct wiphy which we want to query
1047 *
1048 * mac80211 drivers can use this to get to their respective
1049 * &struct ieee80211_hw. Drivers wishing to get to their own private
1050 * structure can then access it via hw->priv. Note that mac802111 drivers should
1051 * not use wiphy_priv() to try to get their private driver structure as this
1052 * is already used internally by mac80211.
1053 */
1054struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1055
1056/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001057 * SET_IEEE80211_DEV - set device for 802.11 hardware
1058 *
1059 * @hw: the &struct ieee80211_hw to set the device for
1060 * @dev: the &struct device of this 802.11 device
1061 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001062static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1063{
1064 set_wiphy_dev(hw->wiphy, dev);
1065}
1066
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001067/**
Bob Copelande37d4df2008-10-20 21:20:27 -04001068 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001069 *
1070 * @hw: the &struct ieee80211_hw to set the MAC address for
1071 * @addr: the address to set
1072 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001073static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1074{
1075 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1076}
1077
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001078static inline struct ieee80211_rate *
1079ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001080 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001081{
Johannes Berge6a98542008-10-21 12:40:02 +02001082 if (WARN_ON(c->control.rates[0].idx < 0))
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001083 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001084 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001085}
1086
1087static inline struct ieee80211_rate *
1088ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001089 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001090{
Johannes Berge039fa42008-05-15 12:55:29 +02001091 if (c->control.rts_cts_rate_idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001092 return NULL;
Johannes Berge039fa42008-05-15 12:55:29 +02001093 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001094}
1095
1096static inline struct ieee80211_rate *
1097ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
Felix Fietkau870abdf2008-10-05 18:04:24 +02001098 const struct ieee80211_tx_info *c, int idx)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001099{
Johannes Berge6a98542008-10-21 12:40:02 +02001100 if (c->control.rates[idx + 1].idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001101 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001102 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001103}
1104
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001105/**
1106 * DOC: Hardware crypto acceleration
Johannes Berg4150c572007-09-17 01:29:23 -04001107 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001108 * mac80211 is capable of taking advantage of many hardware
1109 * acceleration designs for encryption and decryption operations.
1110 *
1111 * The set_key() callback in the &struct ieee80211_ops for a given
1112 * device is called to enable hardware acceleration of encryption and
Johannes Bergdc822b52008-12-29 12:55:09 +01001113 * decryption. The callback takes a @sta parameter that will be NULL
1114 * for default keys or keys used for transmission only, or point to
1115 * the station information for the peer for individual keys.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001116 * Multiple transmission keys with the same key index may be used when
1117 * VLANs are configured for an access point.
1118 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001119 * When transmitting, the TX control data will use the @hw_key_idx
1120 * selected by the driver by modifying the &struct ieee80211_key_conf
1121 * pointed to by the @key parameter to the set_key() function.
1122 *
1123 * The set_key() call for the %SET_KEY command should return 0 if
1124 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1125 * added; if you return 0 then hw_key_idx must be assigned to the
1126 * hardware key index, you are free to use the full u8 range.
1127 *
1128 * When the cmd is %DISABLE_KEY then it must succeed.
1129 *
1130 * Note that it is permissible to not decrypt a frame even if a key
1131 * for it has been uploaded to hardware, the stack will not make any
1132 * decision based on whether a key has been uploaded or not but rather
1133 * based on the receive flags.
1134 *
1135 * The &struct ieee80211_key_conf structure pointed to by the @key
1136 * parameter is guaranteed to be valid until another call to set_key()
1137 * removes it, but it can only be used as a cookie to differentiate
1138 * keys.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001139 *
1140 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1141 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1142 * handler.
1143 * The update_tkip_key() call updates the driver with the new phase 1 key.
1144 * This happens everytime the iv16 wraps around (every 65536 packets). The
1145 * set_key() call will happen only once for each key (unless the AP did
1146 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
Bob Copelande37d4df2008-10-20 21:20:27 -04001147 * provided by update_tkip_key only. The trigger that makes mac80211 call this
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001148 * handler is software decryption with wrap around of iv16.
Johannes Berg4150c572007-09-17 01:29:23 -04001149 */
Johannes Berg4150c572007-09-17 01:29:23 -04001150
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001151/**
Johannes Berg4be8c382009-01-07 18:28:20 +01001152 * DOC: Powersave support
1153 *
1154 * mac80211 has support for various powersave implementations.
1155 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001156 * First, it can support hardware that handles all powersaving by itself,
1157 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1158 * flag. In that case, it will be told about the desired powersave mode
1159 * with the %IEEE80211_CONF_PS flag depending on the association status.
1160 * The hardware must take care of sending nullfunc frames when necessary,
1161 * i.e. when entering and leaving powersave mode. The hardware is required
1162 * to look at the AID in beacons and signal to the AP that it woke up when
1163 * it finds traffic directed to it.
Johannes Berg4be8c382009-01-07 18:28:20 +01001164 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001165 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1166 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1167 * with hardware wakeup and sleep states. Driver is responsible for waking
1168 * up the hardware before issueing commands to the hardware and putting it
1169 * back to sleep at approriate times.
1170 *
1171 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1172 * buffered multicast/broadcast frames after the beacon. Also it must be
1173 * possible to send frames and receive the acknowledment frame.
Johannes Berg4be8c382009-01-07 18:28:20 +01001174 *
1175 * Other hardware designs cannot send nullfunc frames by themselves and also
1176 * need software support for parsing the TIM bitmap. This is also supported
1177 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1178 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
Johannes Berg955394c2009-04-16 17:04:25 +02001179 * required to pass up beacons. The hardware is still required to handle
1180 * waking up for multicast traffic; if it cannot the driver must handle that
Kalle Valoc99445b2010-01-14 13:09:21 +02001181 * as best as it can, mac80211 is too slow to do that.
Johannes Berg4be8c382009-01-07 18:28:20 +01001182 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001183 * Dynamic powersave is an extension to normal powersave in which the
1184 * hardware stays awake for a user-specified period of time after sending a
1185 * frame so that reply frames need not be buffered and therefore delayed to
1186 * the next wakeup. It's compromise of getting good enough latency when
1187 * there's data traffic and still saving significantly power in idle
1188 * periods.
1189 *
1190 * Dynamic powersave is supported by simply mac80211 enabling and disabling
1191 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1192 * flag and mac80211 will handle everything automatically. Additionally,
1193 * hardware having support for the dynamic PS feature may set the
1194 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1195 * dynamic PS mode itself. The driver needs to look at the
1196 * @dynamic_ps_timeout hardware configuration value and use it that value
1197 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1198 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1199 * enabled whenever user has enabled powersave.
1200 *
1201 * Driver informs U-APSD client support by enabling
1202 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1203 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1204 * Nullfunc frames and stay awake until the service period has ended. To
1205 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1206 * from that AC are transmitted with powersave enabled.
1207 *
1208 * Note: U-APSD client mode is not yet supported with
1209 * %IEEE80211_HW_PS_NULLFUNC_STACK.
Johannes Berg4be8c382009-01-07 18:28:20 +01001210 */
1211
1212/**
Kalle Valo04de8382009-03-22 21:57:35 +02001213 * DOC: Beacon filter support
1214 *
1215 * Some hardware have beacon filter support to reduce host cpu wakeups
1216 * which will reduce system power consumption. It usuallly works so that
1217 * the firmware creates a checksum of the beacon but omits all constantly
1218 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1219 * beacon is forwarded to the host, otherwise it will be just dropped. That
1220 * way the host will only receive beacons where some relevant information
1221 * (for example ERP protection or WMM settings) have changed.
1222 *
Johannes Berg955394c2009-04-16 17:04:25 +02001223 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1224 * hardware capability. The driver needs to enable beacon filter support
1225 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1226 * power save is enabled, the stack will not check for beacon loss and the
1227 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1228 *
1229 * The time (or number of beacons missed) until the firmware notifies the
1230 * driver of a beacon loss event (which in turn causes the driver to call
1231 * ieee80211_beacon_loss()) should be configurable and will be controlled
1232 * by mac80211 and the roaming algorithm in the future.
1233 *
1234 * Since there may be constantly changing information elements that nothing
1235 * in the software stack cares about, we will, in the future, have mac80211
1236 * tell the driver which information elements are interesting in the sense
1237 * that we want to see changes in them. This will include
1238 * - a list of information element IDs
1239 * - a list of OUIs for the vendor information element
1240 *
1241 * Ideally, the hardware would filter out any beacons without changes in the
1242 * requested elements, but if it cannot support that it may, at the expense
1243 * of some efficiency, filter out only a subset. For example, if the device
1244 * doesn't support checking for OUIs it should pass up all changes in all
1245 * vendor information elements.
1246 *
1247 * Note that change, for the sake of simplification, also includes information
1248 * elements appearing or disappearing from the beacon.
1249 *
1250 * Some hardware supports an "ignore list" instead, just make sure nothing
1251 * that was requested is on the ignore list, and include commonly changing
1252 * information element IDs in the ignore list, for example 11 (BSS load) and
1253 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1254 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1255 * it could also include some currently unused IDs.
1256 *
1257 *
1258 * In addition to these capabilities, hardware should support notifying the
1259 * host of changes in the beacon RSSI. This is relevant to implement roaming
1260 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1261 * the received data packets). This can consist in notifying the host when
1262 * the RSSI changes significantly or when it drops below or rises above
1263 * configurable thresholds. In the future these thresholds will also be
1264 * configured by mac80211 (which gets them from userspace) to implement
1265 * them as the roaming algorithm requires.
1266 *
1267 * If the hardware cannot implement this, the driver should ask it to
1268 * periodically pass beacon frames to the host so that software can do the
1269 * signal strength threshold checking.
Kalle Valo04de8382009-03-22 21:57:35 +02001270 */
1271
1272/**
Johannes Berg0f782312009-12-01 13:37:02 +01001273 * DOC: Spatial multiplexing power save
1274 *
1275 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1276 * power in an 802.11n implementation. For details on the mechanism
1277 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1278 * "11.2.3 SM power save".
1279 *
1280 * The mac80211 implementation is capable of sending action frames
1281 * to update the AP about the station's SMPS mode, and will instruct
1282 * the driver to enter the specific mode. It will also announce the
1283 * requested SMPS mode during the association handshake. Hardware
1284 * support for this feature is required, and can be indicated by
1285 * hardware flags.
1286 *
1287 * The default mode will be "automatic", which nl80211/cfg80211
1288 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1289 * turned off otherwise.
1290 *
1291 * To support this feature, the driver must set the appropriate
1292 * hardware support flags, and handle the SMPS flag to the config()
1293 * operation. It will then with this mechanism be instructed to
1294 * enter the requested SMPS mode while associated to an HT AP.
1295 */
1296
1297/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001298 * DOC: Frame filtering
1299 *
1300 * mac80211 requires to see many management frames for proper
1301 * operation, and users may want to see many more frames when
1302 * in monitor mode. However, for best CPU usage and power consumption,
1303 * having as few frames as possible percolate through the stack is
1304 * desirable. Hence, the hardware should filter as much as possible.
1305 *
1306 * To achieve this, mac80211 uses filter flags (see below) to tell
1307 * the driver's configure_filter() function which frames should be
1308 * passed to mac80211 and which should be filtered out.
1309 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02001310 * Before configure_filter() is invoked, the prepare_multicast()
1311 * callback is invoked with the parameters @mc_count and @mc_list
1312 * for the combined multicast address list of all virtual interfaces.
1313 * It's use is optional, and it returns a u64 that is passed to
1314 * configure_filter(). Additionally, configure_filter() has the
1315 * arguments @changed_flags telling which flags were changed and
1316 * @total_flags with the new flag states.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001317 *
1318 * If your device has no multicast address filters your driver will
1319 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1320 * parameter to see whether multicast frames should be accepted
1321 * or dropped.
1322 *
Michael Bueschd0f5afb2008-02-12 20:12:45 +01001323 * All unsupported flags in @total_flags must be cleared.
1324 * Hardware does not support a flag if it is incapable of _passing_
1325 * the frame to the stack. Otherwise the driver must ignore
1326 * the flag, but not clear it.
1327 * You must _only_ clear the flag (announce no support for the
1328 * flag to mac80211) if you are not able to pass the packet type
1329 * to the stack (so the hardware always filters it).
1330 * So for example, you should clear @FIF_CONTROL, if your hardware
1331 * always filters control frames. If your hardware always passes
1332 * control frames to the kernel and is incapable of filtering them,
1333 * you do _not_ clear the @FIF_CONTROL flag.
1334 * This rule applies to all other FIF flags as well.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001335 */
1336
1337/**
1338 * enum ieee80211_filter_flags - hardware filter flags
1339 *
1340 * These flags determine what the filter in hardware should be
1341 * programmed to let through and what should not be passed to the
1342 * stack. It is always safe to pass more frames than requested,
1343 * but this has negative impact on power consumption.
1344 *
1345 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1346 * think of the BSS as your network segment and then this corresponds
1347 * to the regular ethernet device promiscuous mode.
1348 *
1349 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1350 * by the user or if the hardware is not capable of filtering by
1351 * multicast address.
1352 *
1353 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1354 * %RX_FLAG_FAILED_FCS_CRC for them)
1355 *
1356 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1357 * the %RX_FLAG_FAILED_PLCP_CRC for them
1358 *
1359 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1360 * to the hardware that it should not filter beacons or probe responses
1361 * by BSSID. Filtering them can greatly reduce the amount of processing
1362 * mac80211 needs to do and the amount of CPU wakeups, so you should
1363 * honour this flag if possible.
1364 *
Igor Perminove3b90ca2009-08-04 16:48:51 +04001365 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
1366 * is not set then only those addressed to this station.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001367 *
1368 * @FIF_OTHER_BSS: pass frames destined to other BSSes
Igor Perminove3b90ca2009-08-04 16:48:51 +04001369 *
1370 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1371 * those addressed to this station.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001372 */
1373enum ieee80211_filter_flags {
1374 FIF_PROMISC_IN_BSS = 1<<0,
1375 FIF_ALLMULTI = 1<<1,
1376 FIF_FCSFAIL = 1<<2,
1377 FIF_PLCPFAIL = 1<<3,
1378 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1379 FIF_CONTROL = 1<<5,
1380 FIF_OTHER_BSS = 1<<6,
Igor Perminove3b90ca2009-08-04 16:48:51 +04001381 FIF_PSPOLL = 1<<7,
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001382};
1383
1384/**
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001385 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1386 *
1387 * These flags are used with the ampdu_action() callback in
1388 * &struct ieee80211_ops to indicate which action is needed.
Johannes Berg827d42c2009-11-22 12:28:41 +01001389 *
1390 * Note that drivers MUST be able to deal with a TX aggregation
1391 * session being stopped even before they OK'ed starting it by
1392 * calling ieee80211_start_tx_ba_cb(_irqsafe), because the peer
1393 * might receive the addBA frame and send a delBA right away!
1394 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001395 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1396 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001397 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1398 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
Johannes Bergb1720232009-03-23 17:28:39 +01001399 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001400 */
1401enum ieee80211_ampdu_mlme_action {
1402 IEEE80211_AMPDU_RX_START,
1403 IEEE80211_AMPDU_RX_STOP,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001404 IEEE80211_AMPDU_TX_START,
1405 IEEE80211_AMPDU_TX_STOP,
Johannes Bergb1720232009-03-23 17:28:39 +01001406 IEEE80211_AMPDU_TX_OPERATIONAL,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001407};
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001408
1409/**
1410 * struct ieee80211_ops - callbacks from mac80211 to the driver
1411 *
1412 * This structure contains various callbacks that the driver may
1413 * handle or, in some cases, must handle, for example to configure
1414 * the hardware to a new channel or to transmit a frame.
1415 *
1416 * @tx: Handler that 802.11 module calls for each transmitted frame.
1417 * skb contains the buffer starting from the IEEE 802.11 header.
1418 * The low-level driver should send the frame out based on
Johannes Bergeefce912008-05-17 00:57:13 +02001419 * configuration in the TX control data. This handler should,
1420 * preferably, never fail and stop queues appropriately, more
1421 * importantly, however, it must never fail for A-MPDU-queues.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001422 * This function should return NETDEV_TX_OK except in very
1423 * limited cases.
Johannes Bergeefce912008-05-17 00:57:13 +02001424 * Must be implemented and atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001425 *
1426 * @start: Called before the first netdevice attached to the hardware
1427 * is enabled. This should turn on the hardware and must turn on
1428 * frame reception (for possibly enabled monitor interfaces.)
1429 * Returns negative error codes, these may be seen in userspace,
1430 * or zero.
1431 * When the device is started it should not have a MAC address
1432 * to avoid acknowledging frames before a non-monitor device
1433 * is added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001434 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001435 *
1436 * @stop: Called after last netdevice attached to the hardware
1437 * is disabled. This should turn off the hardware (at least
1438 * it must turn off frame reception.)
1439 * May be called right after add_interface if that rejects
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04001440 * an interface. If you added any work onto the mac80211 workqueue
1441 * you should ensure to cancel it on this callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001442 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001443 *
1444 * @add_interface: Called when a netdevice attached to the hardware is
Bob Copelande37d4df2008-10-20 21:20:27 -04001445 * enabled. Because it is not called for monitor mode devices, @start
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001446 * and @stop must be implemented.
1447 * The driver should perform any initialization it needs before
1448 * the device can be enabled. The initial configuration for the
1449 * interface is given in the conf parameter.
1450 * The callback may refuse to add an interface by returning a
1451 * negative error code (which will be seen in userspace.)
Kalle Valoe1781ed2009-12-23 13:15:47 +01001452 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001453 *
1454 * @remove_interface: Notifies a driver that an interface is going down.
1455 * The @stop callback is called after this if it is the last interface
1456 * and no monitor interfaces are present.
1457 * When all interfaces are removed, the MAC address in the hardware
1458 * must be cleared so the device no longer acknowledges packets,
1459 * the mac_addr member of the conf structure is, however, set to the
1460 * MAC address of the device going away.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001461 * Hence, this callback must be implemented. It can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001462 *
1463 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1464 * function to change hardware configuration, e.g., channel.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001465 * This function should never fail but returns a negative error code
Kalle Valoe1781ed2009-12-23 13:15:47 +01001466 * if it does. The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001467 *
Johannes Berg471b3ef2007-12-28 14:32:58 +01001468 * @bss_info_changed: Handler for configuration requests related to BSS
1469 * parameters that may vary during BSS's lifespan, and may affect low
1470 * level driver (e.g. assoc/disassoc status, erp parameters).
1471 * This function should not be used if no BSS has been set, unless
1472 * for association indication. The @changed parameter indicates which
Kalle Valoe1781ed2009-12-23 13:15:47 +01001473 * of the bss parameters has changed when a call is made. The callback
1474 * can sleep.
Johannes Berg471b3ef2007-12-28 14:32:58 +01001475 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02001476 * @prepare_multicast: Prepare for multicast filter configuration.
1477 * This callback is optional, and its return value is passed
1478 * to configure_filter(). This callback must be atomic.
1479 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001480 * @configure_filter: Configure the device's RX filter.
1481 * See the section "Frame filtering" for more information.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001482 * This callback must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001483 *
Luis R. Rodriguez546c80c92008-08-14 11:43:20 -07001484 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
Johannes Berg17741cd2008-09-11 00:02:02 +02001485 * must be set or cleared for a given STA. Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001486 *
1487 * @set_key: See the section "Hardware crypto acceleration"
Kalle Valoe1781ed2009-12-23 13:15:47 +01001488 * This callback is only called between add_interface and
1489 * remove_interface calls, i.e. while the given virtual interface
Johannes Bergdc822b52008-12-29 12:55:09 +01001490 * is enabled.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001491 * Returns a negative error code if the key can't be added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001492 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001493 *
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001494 * @update_tkip_key: See the section "Hardware crypto acceleration"
1495 * This callback will be called in the context of Rx. Called for drivers
1496 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
Kalle Valoeb807fb2010-01-24 14:55:12 +02001497 * The callback must be atomic.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001498 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001499 * @hw_scan: Ask the hardware to service the scan request, no need to start
Johannes Berg8318d782008-01-24 19:38:38 +01001500 * the scan state machine in stack. The scan must honour the channel
Kalle Valo9050bdd2009-03-22 21:57:21 +02001501 * configuration done by the regulatory agent in the wiphy's
1502 * registered bands. The hardware (or the driver) needs to make sure
Johannes Bergde95a542009-04-01 11:58:36 +02001503 * that power save is disabled.
1504 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1505 * entire IEs after the SSID, so that drivers need not look at these
1506 * at all but just send them after the SSID -- mac80211 includes the
1507 * (extended) supported rates and HT information (where applicable).
1508 * When the scan finishes, ieee80211_scan_completed() must be called;
1509 * note that it also must be called when the scan cannot finish due to
1510 * any error unless this callback returned a negative error code.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001511 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001512 *
Michael Buesch80e775b2009-02-20 15:37:03 +01001513 * @sw_scan_start: Notifier function that is called just before a software scan
1514 * is started. Can be NULL, if the driver doesn't need this notification.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001515 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01001516 *
Kalle Valoe1781ed2009-12-23 13:15:47 +01001517 * @sw_scan_complete: Notifier function that is called just after a
1518 * software scan finished. Can be NULL, if the driver doesn't need
1519 * this notification.
1520 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01001521 *
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001522 * @get_stats: Return low-level statistics.
1523 * Returns zero if statistics are available.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001524 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001525 *
Johannes Berg62da92f2007-12-19 02:03:31 +01001526 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1527 * callback should be provided to read the TKIP transmit IVs (both IV32
1528 * and IV16) for the given key from hardware.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001529 * The callback must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001530 *
1531 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
Kalle Valoe1781ed2009-12-23 13:15:47 +01001532 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001533 *
Johannes Berg34e89502010-02-03 13:59:58 +01001534 * @sta_add: Notifies low level driver about addition of an associated station,
1535 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1536 *
1537 * @sta_remove: Notifies low level driver about removal of an associated
1538 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1539 *
1540 * @sta_notify: Notifies low level driver about power state transition of an
1541 * associated station, AP, IBSS/WDS/mesh peer etc. Must be atomic.
Christian Lamparter4571d3b2008-11-30 00:48:41 +01001542 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001543 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
Johannes Bergfe3fa822008-09-08 11:05:09 +02001544 * bursting) for a hardware TX queue.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001545 * Returns a negative error code on failure.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001546 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001547 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001548 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001549 * this is only used for IBSS mode BSSID merging and debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001550 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001551 * The callback can sleep.
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001552 *
1553 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1554 * Currently, this is only used for IBSS mode debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001555 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001556 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001557 *
1558 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1559 * with other STAs in the IBSS. This is only used in IBSS mode. This
1560 * function is optional if the firmware/hardware takes full care of
1561 * TSF synchronization.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001562 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001563 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001564 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1565 * This is needed only for IBSS mode and the result of this function is
1566 * used to determine whether to reply to Probe Requests.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001567 * Returns non-zero if this device sent the last beacon.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001568 * The callback can sleep.
Ron Rindjunskyd3c990f2007-11-26 16:14:34 +02001569 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001570 * @ampdu_action: Perform a certain A-MPDU action
1571 * The RA/TID combination determines the destination and TID we want
1572 * the ampdu action to be performed for. The action is defined through
1573 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001574 * is the first frame we expect to perform the action on. Notice
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001575 * that TX/RX_STOP can pass NULL for this parameter.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001576 * Returns a negative error code on failure.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001577 * The callback must be atomic.
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001578 *
1579 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1580 * need to set wiphy->rfkill_poll to %true before registration,
1581 * and need to call wiphy_rfkill_set_hw_state() in the callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001582 * The callback can sleep.
Johannes Bergaff89a92009-07-01 21:26:51 +02001583 *
Lukáš Turek310bc672009-12-21 22:50:48 +01001584 * @set_coverage_class: Set slot time for given coverage class as specified
1585 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
1586 * accordingly. This callback is not required and may sleep.
1587 *
Johannes Bergaff89a92009-07-01 21:26:51 +02001588 * @testmode_cmd: Implement a cfg80211 test mode command.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001589 * The callback can sleep.
Johannes Berga80f7c02009-12-23 13:15:32 +01001590 *
1591 * @flush: Flush all pending frames from the hardware queue, making sure
1592 * that the hardware queues are empty. If the parameter @drop is set
Kalle Valoe1781ed2009-12-23 13:15:47 +01001593 * to %true, pending frames may be dropped. The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001594 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001595struct ieee80211_ops {
Johannes Berge039fa42008-05-15 12:55:29 +02001596 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg4150c572007-09-17 01:29:23 -04001597 int (*start)(struct ieee80211_hw *hw);
Johannes Berg4150c572007-09-17 01:29:23 -04001598 void (*stop)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001599 int (*add_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01001600 struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07001601 void (*remove_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01001602 struct ieee80211_vif *vif);
Johannes Berge8975582008-10-09 12:18:51 +02001603 int (*config)(struct ieee80211_hw *hw, u32 changed);
Johannes Berg471b3ef2007-12-28 14:32:58 +01001604 void (*bss_info_changed)(struct ieee80211_hw *hw,
1605 struct ieee80211_vif *vif,
1606 struct ieee80211_bss_conf *info,
1607 u32 changed);
Johannes Berg3ac64be2009-08-17 16:16:53 +02001608 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
1609 int mc_count, struct dev_addr_list *mc_list);
Johannes Berg4150c572007-09-17 01:29:23 -04001610 void (*configure_filter)(struct ieee80211_hw *hw,
1611 unsigned int changed_flags,
1612 unsigned int *total_flags,
Johannes Berg3ac64be2009-08-17 16:16:53 +02001613 u64 multicast);
Johannes Berg17741cd2008-09-11 00:02:02 +02001614 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1615 bool set);
Johannes Bergea49c352007-09-18 17:29:21 -04001616 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
Johannes Bergdc822b52008-12-29 12:55:09 +01001617 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
Johannes Berg11a843b2007-08-28 17:01:55 -04001618 struct ieee80211_key_conf *key);
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001619 void (*update_tkip_key)(struct ieee80211_hw *hw,
Johannes Bergb3fbdcf2010-01-21 11:40:47 +01001620 struct ieee80211_vif *vif,
1621 struct ieee80211_key_conf *conf,
1622 struct ieee80211_sta *sta,
1623 u32 iv32, u16 *phase1key);
Johannes Berg2a519312009-02-10 21:25:55 +01001624 int (*hw_scan)(struct ieee80211_hw *hw,
1625 struct cfg80211_scan_request *req);
Michael Buesch80e775b2009-02-20 15:37:03 +01001626 void (*sw_scan_start)(struct ieee80211_hw *hw);
1627 void (*sw_scan_complete)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001628 int (*get_stats)(struct ieee80211_hw *hw,
1629 struct ieee80211_low_level_stats *stats);
Johannes Berg62da92f2007-12-19 02:03:31 +01001630 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1631 u32 *iv32, u16 *iv16);
Jiri Bencf0706e82007-05-05 11:45:53 -07001632 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
Johannes Berg34e89502010-02-03 13:59:58 +01001633 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1634 struct ieee80211_sta *sta);
1635 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1636 struct ieee80211_sta *sta);
Johannes Berg32bfd352007-12-19 01:31:26 +01001637 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02001638 enum sta_notify_cmd, struct ieee80211_sta *sta);
Johannes Berge100bb62008-04-30 18:51:21 +02001639 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
Jiri Bencf0706e82007-05-05 11:45:53 -07001640 const struct ieee80211_tx_queue_params *params);
Jiri Bencf0706e82007-05-05 11:45:53 -07001641 u64 (*get_tsf)(struct ieee80211_hw *hw);
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001642 void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf);
Jiri Bencf0706e82007-05-05 11:45:53 -07001643 void (*reset_tsf)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001644 int (*tx_last_beacon)(struct ieee80211_hw *hw);
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001645 int (*ampdu_action)(struct ieee80211_hw *hw,
Johannes Bergc951ad32009-11-16 12:00:38 +01001646 struct ieee80211_vif *vif,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001647 enum ieee80211_ampdu_mlme_action action,
Johannes Berg17741cd2008-09-11 00:02:02 +02001648 struct ieee80211_sta *sta, u16 tid, u16 *ssn);
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001649
1650 void (*rfkill_poll)(struct ieee80211_hw *hw);
Lukáš Turek310bc672009-12-21 22:50:48 +01001651 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
Johannes Bergaff89a92009-07-01 21:26:51 +02001652#ifdef CONFIG_NL80211_TESTMODE
1653 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
1654#endif
Johannes Berga80f7c02009-12-23 13:15:32 +01001655 void (*flush)(struct ieee80211_hw *hw, bool drop);
Jiri Bencf0706e82007-05-05 11:45:53 -07001656};
1657
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001658/**
1659 * ieee80211_alloc_hw - Allocate a new hardware device
1660 *
1661 * This must be called once for each hardware device. The returned pointer
1662 * must be used to refer to this device when calling other functions.
1663 * mac80211 allocates a private data area for the driver pointed to by
1664 * @priv in &struct ieee80211_hw, the size of this area is given as
1665 * @priv_data_len.
1666 *
1667 * @priv_data_len: length of private data
1668 * @ops: callbacks for this device
Jiri Bencf0706e82007-05-05 11:45:53 -07001669 */
1670struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1671 const struct ieee80211_ops *ops);
1672
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001673/**
1674 * ieee80211_register_hw - Register hardware device
1675 *
Johannes Bergdbbea672008-02-26 14:34:06 +01001676 * You must call this function before any other functions in
1677 * mac80211. Note that before a hardware can be registered, you
1678 * need to fill the contained wiphy's information.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001679 *
1680 * @hw: the device to register as returned by ieee80211_alloc_hw()
1681 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001682int ieee80211_register_hw(struct ieee80211_hw *hw);
1683
Jiri Bencf0706e82007-05-05 11:45:53 -07001684#ifdef CONFIG_MAC80211_LEDS
1685extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1686extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
Michael Buesch47f0c502007-09-27 15:10:44 +02001687extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001688extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001689#endif
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001690/**
1691 * ieee80211_get_tx_led_name - get name of TX LED
1692 *
1693 * mac80211 creates a transmit LED trigger for each wireless hardware
1694 * that can be used to drive LEDs if your driver registers a LED device.
1695 * This function returns the name (or %NULL if not configured for LEDs)
1696 * of the trigger so you can automatically link the LED device.
1697 *
1698 * @hw: the hardware to get the LED trigger name for
1699 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001700static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1701{
1702#ifdef CONFIG_MAC80211_LEDS
1703 return __ieee80211_get_tx_led_name(hw);
1704#else
1705 return NULL;
1706#endif
1707}
1708
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001709/**
1710 * ieee80211_get_rx_led_name - get name of RX LED
1711 *
1712 * mac80211 creates a receive LED trigger for each wireless hardware
1713 * that can be used to drive LEDs if your driver registers a LED device.
1714 * This function returns the name (or %NULL if not configured for LEDs)
1715 * of the trigger so you can automatically link the LED device.
1716 *
1717 * @hw: the hardware to get the LED trigger name for
1718 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001719static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1720{
1721#ifdef CONFIG_MAC80211_LEDS
1722 return __ieee80211_get_rx_led_name(hw);
1723#else
1724 return NULL;
1725#endif
1726}
1727
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001728/**
1729 * ieee80211_get_assoc_led_name - get name of association LED
1730 *
1731 * mac80211 creates a association LED trigger for each wireless hardware
1732 * that can be used to drive LEDs if your driver registers a LED device.
1733 * This function returns the name (or %NULL if not configured for LEDs)
1734 * of the trigger so you can automatically link the LED device.
1735 *
1736 * @hw: the hardware to get the LED trigger name for
1737 */
Michael Buesch47f0c502007-09-27 15:10:44 +02001738static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1739{
1740#ifdef CONFIG_MAC80211_LEDS
1741 return __ieee80211_get_assoc_led_name(hw);
1742#else
1743 return NULL;
1744#endif
1745}
1746
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001747/**
1748 * ieee80211_get_radio_led_name - get name of radio LED
1749 *
1750 * mac80211 creates a radio change LED trigger for each wireless hardware
1751 * that can be used to drive LEDs if your driver registers a LED device.
1752 * This function returns the name (or %NULL if not configured for LEDs)
1753 * of the trigger so you can automatically link the LED device.
1754 *
1755 * @hw: the hardware to get the LED trigger name for
1756 */
1757static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1758{
1759#ifdef CONFIG_MAC80211_LEDS
1760 return __ieee80211_get_radio_led_name(hw);
1761#else
1762 return NULL;
1763#endif
1764}
Michael Buesch47f0c502007-09-27 15:10:44 +02001765
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001766/**
1767 * ieee80211_unregister_hw - Unregister a hardware device
1768 *
1769 * This function instructs mac80211 to free allocated resources
1770 * and unregister netdevices from the networking subsystem.
1771 *
1772 * @hw: the hardware to unregister
1773 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001774void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1775
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001776/**
1777 * ieee80211_free_hw - free hardware descriptor
1778 *
1779 * This function frees everything that was allocated, including the
1780 * private data for the driver. You must call ieee80211_unregister_hw()
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001781 * before calling this function.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001782 *
1783 * @hw: the hardware to free
1784 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001785void ieee80211_free_hw(struct ieee80211_hw *hw);
1786
Johannes Bergf2753dd2009-04-14 10:09:24 +02001787/**
1788 * ieee80211_restart_hw - restart hardware completely
1789 *
1790 * Call this function when the hardware was restarted for some reason
1791 * (hardware error, ...) and the driver is unable to restore its state
1792 * by itself. mac80211 assumes that at this point the driver/hardware
1793 * is completely uninitialised and stopped, it starts the process by
1794 * calling the ->start() operation. The driver will need to reset all
1795 * internal state that it has prior to calling this function.
1796 *
1797 * @hw: the hardware to restart
1798 */
1799void ieee80211_restart_hw(struct ieee80211_hw *hw);
1800
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001801/**
1802 * ieee80211_rx - receive frame
1803 *
1804 * Use this function to hand received frames to mac80211. The receive
Johannes Berg0869aea2009-10-28 10:03:35 +01001805 * buffer in @skb must start with an IEEE 802.11 header.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001806 *
Johannes Berg2485f712008-02-25 16:27:41 +01001807 * This function may not be called in IRQ context. Calls to this function
Kalle Valoe36e49f2009-10-13 20:33:13 +03001808 * for a single hardware must be synchronized against each other. Calls to
1809 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
1810 * mixed for a single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001811 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03001812 * In process context use instead ieee80211_rx_ni().
Johannes Bergd20ef632009-10-11 15:10:40 +02001813 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001814 * @hw: the hardware this frame came in on
1815 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001816 */
John W. Linville103bf9f2009-08-20 16:34:15 -04001817void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001818
1819/**
1820 * ieee80211_rx_irqsafe - receive frame
1821 *
1822 * Like ieee80211_rx() but can be called in IRQ context
Johannes Berg2485f712008-02-25 16:27:41 +01001823 * (internally defers to a tasklet.)
1824 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03001825 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
1826 * be mixed for a single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001827 *
1828 * @hw: the hardware this frame came in on
1829 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001830 */
Johannes Bergf1d58c22009-06-17 13:13:00 +02001831void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07001832
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001833/**
Kalle Valoe36e49f2009-10-13 20:33:13 +03001834 * ieee80211_rx_ni - receive frame (in process context)
1835 *
1836 * Like ieee80211_rx() but can be called in process context
1837 * (internally disables bottom halves).
1838 *
1839 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
1840 * not be mixed for a single hardware.
1841 *
1842 * @hw: the hardware this frame came in on
1843 * @skb: the buffer to receive, owned by mac80211 after this call
1844 */
1845static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
1846 struct sk_buff *skb)
1847{
1848 local_bh_disable();
1849 ieee80211_rx(hw, skb);
1850 local_bh_enable();
1851}
1852
Gertjan van Wingerded24deb22009-12-04 23:46:54 +01001853/*
1854 * The TX headroom reserved by mac80211 for its own tx_status functions.
1855 * This is enough for the radiotap header.
1856 */
1857#define IEEE80211_TX_STATUS_HEADROOM 13
1858
Kalle Valoe36e49f2009-10-13 20:33:13 +03001859/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001860 * ieee80211_tx_status - transmit status callback
1861 *
1862 * Call this function for all transmitted frames after they have been
1863 * transmitted. It is permissible to not call this function for
1864 * multicast frames but this can affect statistics.
1865 *
Johannes Berg2485f712008-02-25 16:27:41 +01001866 * This function may not be called in IRQ context. Calls to this function
1867 * for a single hardware must be synchronized against each other. Calls
1868 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1869 * for a single hardware.
1870 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001871 * @hw: the hardware the frame was transmitted by
1872 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001873 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001874void ieee80211_tx_status(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001875 struct sk_buff *skb);
Johannes Berg2485f712008-02-25 16:27:41 +01001876
1877/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001878 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
Johannes Berg2485f712008-02-25 16:27:41 +01001879 *
1880 * Like ieee80211_tx_status() but can be called in IRQ context
1881 * (internally defers to a tasklet.)
1882 *
1883 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1884 * single hardware.
1885 *
1886 * @hw: the hardware the frame was transmitted by
1887 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg2485f712008-02-25 16:27:41 +01001888 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001889void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001890 struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07001891
1892/**
Johannes Bergeddcbb92009-10-29 08:30:35 +01001893 * ieee80211_beacon_get_tim - beacon generation function
1894 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01001895 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Bergeddcbb92009-10-29 08:30:35 +01001896 * @tim_offset: pointer to variable that will receive the TIM IE offset.
1897 * Set to 0 if invalid (in non-AP modes).
1898 * @tim_length: pointer to variable that will receive the TIM IE length,
1899 * (including the ID and length bytes!).
1900 * Set to 0 if invalid (in non-AP modes).
1901 *
1902 * If the driver implements beaconing modes, it must use this function to
1903 * obtain the beacon frame/template.
1904 *
1905 * If the beacon frames are generated by the host system (i.e., not in
1906 * hardware/firmware), the driver uses this function to get each beacon
1907 * frame from mac80211 -- it is responsible for calling this function
1908 * before the beacon is needed (e.g. based on hardware interrupt).
1909 *
1910 * If the beacon frames are generated by the device, then the driver
1911 * must use the returned beacon as the template and change the TIM IE
1912 * according to the current DTIM parameters/TIM bitmap.
1913 *
1914 * The driver is responsible for freeing the returned skb.
1915 */
1916struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
1917 struct ieee80211_vif *vif,
1918 u16 *tim_offset, u16 *tim_length);
1919
1920/**
Jiri Bencf0706e82007-05-05 11:45:53 -07001921 * ieee80211_beacon_get - beacon generation function
1922 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01001923 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07001924 *
Johannes Bergeddcbb92009-10-29 08:30:35 +01001925 * See ieee80211_beacon_get_tim().
Jiri Bencf0706e82007-05-05 11:45:53 -07001926 */
Johannes Bergeddcbb92009-10-29 08:30:35 +01001927static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1928 struct ieee80211_vif *vif)
1929{
1930 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
1931}
Jiri Bencf0706e82007-05-05 11:45:53 -07001932
1933/**
Kalle Valo7044cc52010-01-05 20:16:19 +02001934 * ieee80211_pspoll_get - retrieve a PS Poll template
1935 * @hw: pointer obtained from ieee80211_alloc_hw().
1936 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1937 *
1938 * Creates a PS Poll a template which can, for example, uploaded to
1939 * hardware. The template must be updated after association so that correct
1940 * AID, BSSID and MAC address is used.
1941 *
1942 * Note: Caller (or hardware) is responsible for setting the
1943 * &IEEE80211_FCTL_PM bit.
1944 */
1945struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
1946 struct ieee80211_vif *vif);
1947
1948/**
1949 * ieee80211_nullfunc_get - retrieve a nullfunc template
1950 * @hw: pointer obtained from ieee80211_alloc_hw().
1951 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1952 *
1953 * Creates a Nullfunc template which can, for example, uploaded to
1954 * hardware. The template must be updated after association so that correct
1955 * BSSID and address is used.
1956 *
1957 * Note: Caller (or hardware) is responsible for setting the
1958 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
1959 */
1960struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
1961 struct ieee80211_vif *vif);
1962
1963/**
Kalle Valo05e54ea2010-01-05 20:16:38 +02001964 * ieee80211_probereq_get - retrieve a Probe Request template
1965 * @hw: pointer obtained from ieee80211_alloc_hw().
1966 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1967 * @ssid: SSID buffer
1968 * @ssid_len: length of SSID
1969 * @ie: buffer containing all IEs except SSID for the template
1970 * @ie_len: length of the IE buffer
1971 *
1972 * Creates a Probe Request template which can, for example, be uploaded to
1973 * hardware.
1974 */
1975struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
1976 struct ieee80211_vif *vif,
1977 const u8 *ssid, size_t ssid_len,
1978 const u8 *ie, size_t ie_len);
1979
1980/**
Jiri Bencf0706e82007-05-05 11:45:53 -07001981 * ieee80211_rts_get - RTS frame generation function
1982 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01001983 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07001984 * @frame: pointer to the frame that is going to be protected by the RTS.
1985 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02001986 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07001987 * @rts: The buffer where to store the RTS frame.
1988 *
1989 * If the RTS frames are generated by the host system (i.e., not in
1990 * hardware/firmware), the low-level driver uses this function to receive
1991 * the next RTS frame from the 802.11 code. The low-level is responsible
1992 * for calling this function before and RTS frame is needed.
1993 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001994void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07001995 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001996 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07001997 struct ieee80211_rts *rts);
1998
1999/**
2000 * ieee80211_rts_duration - Get the duration field for an RTS frame
2001 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002002 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002003 * @frame_len: the length of the frame that is going to be protected by the RTS.
Johannes Berge039fa42008-05-15 12:55:29 +02002004 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07002005 *
2006 * If the RTS is generated in firmware, but the host system must provide
2007 * the duration field, the low-level driver uses this function to receive
2008 * the duration field value in little-endian byteorder.
2009 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002010__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
2011 struct ieee80211_vif *vif, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002012 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07002013
2014/**
2015 * ieee80211_ctstoself_get - CTS-to-self frame generation function
2016 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002017 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002018 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
2019 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02002020 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07002021 * @cts: The buffer where to store the CTS-to-self frame.
2022 *
2023 * If the CTS-to-self frames are generated by the host system (i.e., not in
2024 * hardware/firmware), the low-level driver uses this function to receive
2025 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
2026 * for calling this function before and CTS-to-self frame is needed.
2027 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002028void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
2029 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07002030 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002031 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07002032 struct ieee80211_cts *cts);
2033
2034/**
2035 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
2036 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002037 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002038 * @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 +02002039 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07002040 *
2041 * If the CTS-to-self is generated in firmware, but the host system must provide
2042 * the duration field, the low-level driver uses this function to receive
2043 * the duration field value in little-endian byteorder.
2044 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002045__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
2046 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07002047 size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002048 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07002049
2050/**
2051 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
2052 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002053 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002054 * @frame_len: the length of the frame.
Johannes Berg8318d782008-01-24 19:38:38 +01002055 * @rate: the rate at which the frame is going to be transmitted.
Jiri Bencf0706e82007-05-05 11:45:53 -07002056 *
2057 * Calculate the duration field of some generic frame, given its
2058 * length and transmission rate (in 100kbps).
2059 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002060__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
2061 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07002062 size_t frame_len,
Johannes Berg8318d782008-01-24 19:38:38 +01002063 struct ieee80211_rate *rate);
Jiri Bencf0706e82007-05-05 11:45:53 -07002064
2065/**
2066 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
2067 * @hw: pointer as obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002068 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002069 *
2070 * Function for accessing buffered broadcast and multicast frames. If
2071 * hardware/firmware does not implement buffering of broadcast/multicast
2072 * frames when power saving is used, 802.11 code buffers them in the host
2073 * memory. The low-level driver uses this function to fetch next buffered
2074 * frame. In most cases, this is used when generating beacon frame. This
2075 * function returns a pointer to the next buffered skb or NULL if no more
2076 * buffered frames are available.
2077 *
2078 * Note: buffered frames are returned only after DTIM beacon frame was
2079 * generated with ieee80211_beacon_get() and the low-level driver must thus
2080 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
2081 * NULL if the previous generated beacon was not DTIM, so the low-level driver
2082 * does not need to check for DTIM beacons separately and should be able to
2083 * use common code for all beacons.
2084 */
2085struct sk_buff *
Johannes Berge039fa42008-05-15 12:55:29 +02002086ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07002087
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002088/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02002089 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
2090 *
2091 * This function computes a TKIP rc4 key for an skb. It computes
2092 * a phase 1 key if needed (iv16 wraps around). This function is to
2093 * be used by drivers which can do HW encryption but need to compute
2094 * to phase 1/2 key in SW.
2095 *
2096 * @keyconf: the parameter passed with the set key
2097 * @skb: the skb for which the key is needed
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002098 * @type: TBD
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002099 * @key: a buffer to which the key will be written
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02002100 */
2101void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
2102 struct sk_buff *skb,
2103 enum ieee80211_tkip_key_type type, u8 *key);
2104/**
Jiri Bencf0706e82007-05-05 11:45:53 -07002105 * ieee80211_wake_queue - wake specific queue
2106 * @hw: pointer as obtained from ieee80211_alloc_hw().
2107 * @queue: queue number (counted from zero).
2108 *
2109 * Drivers should use this function instead of netif_wake_queue.
2110 */
2111void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
2112
2113/**
2114 * ieee80211_stop_queue - stop specific queue
2115 * @hw: pointer as obtained from ieee80211_alloc_hw().
2116 * @queue: queue number (counted from zero).
2117 *
2118 * Drivers should use this function instead of netif_stop_queue.
2119 */
2120void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
2121
2122/**
Tomas Winkler92ab8532008-07-24 21:02:04 +03002123 * ieee80211_queue_stopped - test status of the queue
2124 * @hw: pointer as obtained from ieee80211_alloc_hw().
2125 * @queue: queue number (counted from zero).
2126 *
2127 * Drivers should use this function instead of netif_stop_queue.
2128 */
2129
2130int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
2131
2132/**
Jiri Bencf0706e82007-05-05 11:45:53 -07002133 * ieee80211_stop_queues - stop all queues
2134 * @hw: pointer as obtained from ieee80211_alloc_hw().
2135 *
2136 * Drivers should use this function instead of netif_stop_queue.
2137 */
2138void ieee80211_stop_queues(struct ieee80211_hw *hw);
2139
2140/**
2141 * ieee80211_wake_queues - wake all queues
2142 * @hw: pointer as obtained from ieee80211_alloc_hw().
2143 *
2144 * Drivers should use this function instead of netif_wake_queue.
2145 */
2146void ieee80211_wake_queues(struct ieee80211_hw *hw);
2147
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002148/**
2149 * ieee80211_scan_completed - completed hardware scan
2150 *
2151 * When hardware scan offload is used (i.e. the hw_scan() callback is
2152 * assigned) this function needs to be called by the driver to notify
2153 * mac80211 that the scan finished.
2154 *
2155 * @hw: the hardware that finished the scan
Johannes Berg2a519312009-02-10 21:25:55 +01002156 * @aborted: set to true if scan was aborted
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002157 */
Johannes Berg2a519312009-02-10 21:25:55 +01002158void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
Jiri Bencf0706e82007-05-05 11:45:53 -07002159
Johannes Bergdabeb342007-11-09 01:57:29 +01002160/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002161 * ieee80211_iterate_active_interfaces - iterate active interfaces
Johannes Bergdabeb342007-11-09 01:57:29 +01002162 *
2163 * This function iterates over the interfaces associated with a given
2164 * hardware that are currently active and calls the callback for them.
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002165 * This function allows the iterator function to sleep, when the iterator
2166 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
2167 * be used.
Johannes Bergdabeb342007-11-09 01:57:29 +01002168 *
2169 * @hw: the hardware struct of which the interfaces should be iterated over
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002170 * @iterator: the iterator function to call
Johannes Bergdabeb342007-11-09 01:57:29 +01002171 * @data: first argument of the iterator function
2172 */
2173void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
2174 void (*iterator)(void *data, u8 *mac,
Johannes Berg32bfd352007-12-19 01:31:26 +01002175 struct ieee80211_vif *vif),
Johannes Bergdabeb342007-11-09 01:57:29 +01002176 void *data);
2177
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002178/**
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002179 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
2180 *
2181 * This function iterates over the interfaces associated with a given
2182 * hardware that are currently active and calls the callback for them.
2183 * This function requires the iterator callback function to be atomic,
2184 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
2185 *
2186 * @hw: the hardware struct of which the interfaces should be iterated over
2187 * @iterator: the iterator function to call, cannot sleep
2188 * @data: first argument of the iterator function
2189 */
2190void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
2191 void (*iterator)(void *data,
2192 u8 *mac,
2193 struct ieee80211_vif *vif),
2194 void *data);
2195
2196/**
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04002197 * ieee80211_queue_work - add work onto the mac80211 workqueue
2198 *
2199 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
2200 * This helper ensures drivers are not queueing work when they should not be.
2201 *
2202 * @hw: the hardware struct for the interface we are adding work for
2203 * @work: the work we want to add onto the mac80211 workqueue
2204 */
2205void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
2206
2207/**
2208 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
2209 *
2210 * Drivers and mac80211 use this to queue delayed work onto the mac80211
2211 * workqueue.
2212 *
2213 * @hw: the hardware struct for the interface we are adding work for
2214 * @dwork: delayable work to queue onto the mac80211 workqueue
2215 * @delay: number of jiffies to wait before queueing
2216 */
2217void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
2218 struct delayed_work *dwork,
2219 unsigned long delay);
2220
2221/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002222 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01002223 * @sta: the station for which to start a BA session
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002224 * @tid: the TID to BA on.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002225 *
2226 * Return: success if addBA request was sent, failure otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002227 *
2228 * Although mac80211/low level driver/user space application can estimate
2229 * the need to start aggregation on a certain RA/TID, the session level
2230 * will be managed by the mac80211.
2231 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002232int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002233
2234/**
2235 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01002236 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002237 * @ra: receiver address of the BA session recipient.
2238 * @tid: the TID to BA on.
2239 *
2240 * This function must be called by low level driver once it has
2241 * finished with preparations for the BA session.
2242 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002243void ieee80211_start_tx_ba_cb(struct ieee80211_vif *vif, u8 *ra, u16 tid);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002244
2245/**
2246 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01002247 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002248 * @ra: receiver address of the BA session recipient.
2249 * @tid: the TID to BA on.
2250 *
2251 * This function must be called by low level driver once it has
2252 * finished with preparations for the BA session.
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002253 * This version of the function is IRQ-safe.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002254 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002255void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002256 u16 tid);
2257
2258/**
2259 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01002260 * @sta: the station whose BA session to stop
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002261 * @tid: the TID to stop BA.
2262 * @initiator: if indicates initiator DELBA frame will be sent.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002263 *
2264 * Return: error if no sta with matching da found, success otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002265 *
2266 * Although mac80211/low level driver/user space application can estimate
2267 * the need to stop aggregation on a certain RA/TID, the session level
2268 * will be managed by the mac80211.
2269 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002270int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002271 enum ieee80211_back_parties initiator);
2272
2273/**
2274 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01002275 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002276 * @ra: receiver address of the BA session recipient.
2277 * @tid: the desired TID to BA on.
2278 *
2279 * This function must be called by low level driver once it has
2280 * finished with preparations for the BA session tear down.
2281 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002282void ieee80211_stop_tx_ba_cb(struct ieee80211_vif *vif, u8 *ra, u8 tid);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002283
2284/**
2285 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01002286 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002287 * @ra: receiver address of the BA session recipient.
2288 * @tid: the desired TID to BA on.
2289 *
2290 * This function must be called by low level driver once it has
2291 * finished with preparations for the BA session tear down.
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002292 * This version of the function is IRQ-safe.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002293 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002294void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002295 u16 tid);
2296
Mohamed Abbas84363e62008-04-04 16:59:58 -07002297/**
Johannes Berg17741cd2008-09-11 00:02:02 +02002298 * ieee80211_find_sta - find a station
2299 *
Johannes Berg5ed176e2009-11-04 14:42:28 +01002300 * @vif: virtual interface to look for station on
Johannes Berg17741cd2008-09-11 00:02:02 +02002301 * @addr: station's address
2302 *
2303 * This function must be called under RCU lock and the
2304 * resulting pointer is only valid under RCU lock as well.
2305 */
Johannes Berg5ed176e2009-11-04 14:42:28 +01002306struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02002307 const u8 *addr);
2308
Kalle Valo04de8382009-03-22 21:57:35 +02002309/**
Johannes Berg5ed176e2009-11-04 14:42:28 +01002310 * ieee80211_find_sta_by_hw - find a station on hardware
2311 *
2312 * @hw: pointer as obtained from ieee80211_alloc_hw()
2313 * @addr: station's address
2314 *
2315 * This function must be called under RCU lock and the
2316 * resulting pointer is only valid under RCU lock as well.
2317 *
2318 * NOTE: This function should not be used! When mac80211 is converted
2319 * internally to properly keep track of stations on multiple
2320 * virtual interfaces, it will not always know which station to
2321 * return here since a single address might be used by multiple
2322 * logical stations (e.g. consider a station connecting to another
2323 * BSSID on the same AP hardware without disconnecting first).
2324 *
2325 * DO NOT USE THIS FUNCTION.
2326 */
2327struct ieee80211_sta *ieee80211_find_sta_by_hw(struct ieee80211_hw *hw,
2328 const u8 *addr);
2329
2330/**
Johannes Bergaf818582009-11-06 11:35:50 +01002331 * ieee80211_sta_block_awake - block station from waking up
2332 * @hw: the hardware
2333 * @pubsta: the station
2334 * @block: whether to block or unblock
2335 *
2336 * Some devices require that all frames that are on the queues
2337 * for a specific station that went to sleep are flushed before
2338 * a poll response or frames after the station woke up can be
2339 * delivered to that it. Note that such frames must be rejected
2340 * by the driver as filtered, with the appropriate status flag.
2341 *
2342 * This function allows implementing this mode in a race-free
2343 * manner.
2344 *
2345 * To do this, a driver must keep track of the number of frames
2346 * still enqueued for a specific station. If this number is not
2347 * zero when the station goes to sleep, the driver must call
2348 * this function to force mac80211 to consider the station to
2349 * be asleep regardless of the station's actual state. Once the
2350 * number of outstanding frames reaches zero, the driver must
2351 * call this function again to unblock the station. That will
2352 * cause mac80211 to be able to send ps-poll responses, and if
2353 * the station queried in the meantime then frames will also
2354 * be sent out as a result of this. Additionally, the driver
2355 * will be notified that the station woke up some time after
2356 * it is unblocked, regardless of whether the station actually
2357 * woke up while blocked or not.
2358 */
2359void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
2360 struct ieee80211_sta *pubsta, bool block);
2361
2362/**
Kalle Valo04de8382009-03-22 21:57:35 +02002363 * ieee80211_beacon_loss - inform hardware does not receive beacons
2364 *
Johannes Berg1ed32e42009-12-23 13:15:45 +01002365 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Kalle Valo04de8382009-03-22 21:57:35 +02002366 *
2367 * When beacon filtering is enabled with IEEE80211_HW_BEACON_FILTERING and
2368 * IEEE80211_CONF_PS is set, the driver needs to inform whenever the
2369 * hardware is not receiving beacons with this function.
2370 */
2371void ieee80211_beacon_loss(struct ieee80211_vif *vif);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002372
2373/* Rate control API */
Johannes Berge6a98542008-10-21 12:40:02 +02002374
Johannes Berg4b7679a2008-09-18 18:14:18 +02002375/**
Sujith81cb7622009-02-12 11:38:37 +05302376 * enum rate_control_changed - flags to indicate which parameter changed
2377 *
2378 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
2379 * changed, rate control algorithm can update its internal state if needed.
2380 */
2381enum rate_control_changed {
2382 IEEE80211_RC_HT_CHANGED = BIT(0)
2383};
2384
2385/**
Johannes Berge6a98542008-10-21 12:40:02 +02002386 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
Johannes Berg4b7679a2008-09-18 18:14:18 +02002387 *
Johannes Berge6a98542008-10-21 12:40:02 +02002388 * @hw: The hardware the algorithm is invoked for.
2389 * @sband: The band this frame is being transmitted on.
2390 * @bss_conf: the current BSS configuration
2391 * @reported_rate: The rate control algorithm can fill this in to indicate
2392 * which rate should be reported to userspace as the current rate and
2393 * used for rate calculations in the mesh network.
2394 * @rts: whether RTS will be used for this frame because it is longer than the
2395 * RTS threshold
2396 * @short_preamble: whether mac80211 will request short-preamble transmission
2397 * if the selected rate supports it
2398 * @max_rate_idx: user-requested maximum rate (not MCS for now)
Jouni Malinen37eb0b12010-01-06 13:09:08 +02002399 * (deprecated; this will be removed once drivers get updated to use
2400 * rate_idx_mask)
2401 * @rate_idx_mask: user-requested rate mask (not MCS for now)
Johannes Berge25cf4a2008-10-23 08:51:20 +02002402 * @skb: the skb that will be transmitted, the control information in it needs
2403 * to be filled in
Jouni Malinene00cfce2009-12-29 12:59:19 +02002404 * @ap: whether this frame is sent out in AP mode
Johannes Berg4b7679a2008-09-18 18:14:18 +02002405 */
Johannes Berge6a98542008-10-21 12:40:02 +02002406struct ieee80211_tx_rate_control {
2407 struct ieee80211_hw *hw;
2408 struct ieee80211_supported_band *sband;
2409 struct ieee80211_bss_conf *bss_conf;
2410 struct sk_buff *skb;
2411 struct ieee80211_tx_rate reported_rate;
2412 bool rts, short_preamble;
2413 u8 max_rate_idx;
Jouni Malinen37eb0b12010-01-06 13:09:08 +02002414 u32 rate_idx_mask;
Jouni Malinene00cfce2009-12-29 12:59:19 +02002415 bool ap;
Johannes Berg4b7679a2008-09-18 18:14:18 +02002416};
2417
2418struct rate_control_ops {
2419 struct module *module;
2420 const char *name;
2421 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002422 void (*free)(void *priv);
2423
2424 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
2425 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
2426 struct ieee80211_sta *sta, void *priv_sta);
Sujith81cb7622009-02-12 11:38:37 +05302427 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
2428 struct ieee80211_sta *sta,
Sujith4fa00432010-03-01 14:42:57 +05302429 void *priv_sta, u32 changed,
2430 enum nl80211_channel_type oper_chan_type);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002431 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
2432 void *priv_sta);
2433
2434 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
2435 struct ieee80211_sta *sta, void *priv_sta,
2436 struct sk_buff *skb);
Johannes Berge6a98542008-10-21 12:40:02 +02002437 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
2438 struct ieee80211_tx_rate_control *txrc);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002439
2440 void (*add_sta_debugfs)(void *priv, void *priv_sta,
2441 struct dentry *dir);
2442 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
2443};
2444
2445static inline int rate_supported(struct ieee80211_sta *sta,
2446 enum ieee80211_band band,
2447 int index)
2448{
2449 return (sta == NULL || sta->supp_rates[band] & BIT(index));
2450}
2451
Luis R. Rodriguez4c6d4f52009-07-16 10:05:41 -07002452/**
2453 * rate_control_send_low - helper for drivers for management/no-ack frames
2454 *
2455 * Rate control algorithms that agree to use the lowest rate to
2456 * send management frames and NO_ACK data with the respective hw
2457 * retries should use this in the beginning of their mac80211 get_rate
2458 * callback. If true is returned the rate control can simply return.
2459 * If false is returned we guarantee that sta and sta and priv_sta is
2460 * not null.
2461 *
2462 * Rate control algorithms wishing to do more intelligent selection of
2463 * rate for multicast/broadcast frames may choose to not use this.
2464 *
2465 * @sta: &struct ieee80211_sta pointer to the target destination. Note
2466 * that this may be null.
2467 * @priv_sta: private rate control structure. This may be null.
2468 * @txrc: rate control information we sholud populate for mac80211.
2469 */
2470bool rate_control_send_low(struct ieee80211_sta *sta,
2471 void *priv_sta,
2472 struct ieee80211_tx_rate_control *txrc);
2473
2474
Johannes Berg4b7679a2008-09-18 18:14:18 +02002475static inline s8
2476rate_lowest_index(struct ieee80211_supported_band *sband,
2477 struct ieee80211_sta *sta)
2478{
2479 int i;
2480
2481 for (i = 0; i < sband->n_bitrates; i++)
2482 if (rate_supported(sta, sband->band, i))
2483 return i;
2484
2485 /* warn when we cannot find a rate. */
2486 WARN_ON(1);
2487
2488 return 0;
2489}
2490
Luis R. Rodriguezb770b432009-07-16 10:15:09 -07002491static inline
2492bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
2493 struct ieee80211_sta *sta)
2494{
2495 unsigned int i;
2496
2497 for (i = 0; i < sband->n_bitrates; i++)
2498 if (rate_supported(sta, sband->band, i))
2499 return true;
2500 return false;
2501}
Johannes Berg4b7679a2008-09-18 18:14:18 +02002502
2503int ieee80211_rate_control_register(struct rate_control_ops *ops);
2504void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
2505
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002506static inline bool
2507conf_is_ht20(struct ieee80211_conf *conf)
2508{
Johannes Berg47979382009-01-07 10:13:27 +01002509 return conf->channel_type == NL80211_CHAN_HT20;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002510}
2511
2512static inline bool
2513conf_is_ht40_minus(struct ieee80211_conf *conf)
2514{
Johannes Berg47979382009-01-07 10:13:27 +01002515 return conf->channel_type == NL80211_CHAN_HT40MINUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002516}
2517
2518static inline bool
2519conf_is_ht40_plus(struct ieee80211_conf *conf)
2520{
Johannes Berg47979382009-01-07 10:13:27 +01002521 return conf->channel_type == NL80211_CHAN_HT40PLUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002522}
2523
2524static inline bool
2525conf_is_ht40(struct ieee80211_conf *conf)
2526{
2527 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
2528}
2529
2530static inline bool
2531conf_is_ht(struct ieee80211_conf *conf)
2532{
Johannes Berg47979382009-01-07 10:13:27 +01002533 return conf->channel_type != NL80211_CHAN_NO_HT;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002534}
2535
Jiri Bencf0706e82007-05-05 11:45:53 -07002536#endif /* MAC80211_H */