blob: 46918deceda13ccd1e30c14bb1e069a0c4a2b1c8 [file] [log] [blame]
Ivo van Doorn95ea3622007-09-25 17:57:13 -07001/*
Ivo van Doorn4e54c712009-01-17 20:42:32 +01002 Copyright (C) 2004 - 2009 rt2x00 SourceForge Project
Ivo van Doorn95ea3622007-09-25 17:57:13 -07003 <http://rt2x00.serialmonkey.com>
4
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the
17 Free Software Foundation, Inc.,
18 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 */
20
21/*
22 Module: rt2x00
23 Abstract: rt2x00 global information.
24 */
25
26#ifndef RT2X00_H
27#define RT2X00_H
28
29#include <linux/bitops.h>
Ivo van Doorn95ea3622007-09-25 17:57:13 -070030#include <linux/skbuff.h>
31#include <linux/workqueue.h>
32#include <linux/firmware.h>
Ivo van Doorna9450b72008-02-03 15:53:40 +010033#include <linux/leds.h>
Adam Baker3d823462007-10-27 13:43:29 +020034#include <linux/mutex.h>
Mattias Nissler61af43c2007-11-27 21:50:26 +010035#include <linux/etherdevice.h>
Ivo van Doorncca3e992009-01-03 19:56:02 +010036#include <linux/input-polldev.h>
Ivo van Doorn95ea3622007-09-25 17:57:13 -070037
38#include <net/mac80211.h>
39
40#include "rt2x00debug.h"
Ivo van Doorna9450b72008-02-03 15:53:40 +010041#include "rt2x00leds.h"
Ivo van Doorn95ea3622007-09-25 17:57:13 -070042#include "rt2x00reg.h"
Ivo van Doorn181d6902008-02-05 16:42:23 -050043#include "rt2x00queue.h"
Ivo van Doorn95ea3622007-09-25 17:57:13 -070044
45/*
46 * Module information.
Ivo van Doorn95ea3622007-09-25 17:57:13 -070047 */
Ivo van Doorn754be302008-12-20 11:00:49 +010048#define DRV_VERSION "2.3.0"
Ivo van Doorn95ea3622007-09-25 17:57:13 -070049#define DRV_PROJECT "http://rt2x00.serialmonkey.com"
50
51/*
52 * Debug definitions.
53 * Debug output has to be enabled during compile time.
54 */
55#define DEBUG_PRINTK_MSG(__dev, __kernlvl, __lvl, __msg, __args...) \
56 printk(__kernlvl "%s -> %s: %s - " __msg, \
Harvey Harrisonc94c93d2008-07-28 23:01:34 -070057 wiphy_name((__dev)->hw->wiphy), __func__, __lvl, ##__args)
Ivo van Doorn95ea3622007-09-25 17:57:13 -070058
59#define DEBUG_PRINTK_PROBE(__kernlvl, __lvl, __msg, __args...) \
60 printk(__kernlvl "%s -> %s: %s - " __msg, \
Harvey Harrisonc94c93d2008-07-28 23:01:34 -070061 KBUILD_MODNAME, __func__, __lvl, ##__args)
Ivo van Doorn95ea3622007-09-25 17:57:13 -070062
63#ifdef CONFIG_RT2X00_DEBUG
64#define DEBUG_PRINTK(__dev, __kernlvl, __lvl, __msg, __args...) \
65 DEBUG_PRINTK_MSG(__dev, __kernlvl, __lvl, __msg, ##__args);
66#else
67#define DEBUG_PRINTK(__dev, __kernlvl, __lvl, __msg, __args...) \
68 do { } while (0)
69#endif /* CONFIG_RT2X00_DEBUG */
70
71/*
72 * Various debug levels.
73 * The debug levels PANIC and ERROR both indicate serious problems,
74 * for this reason they should never be ignored.
75 * The special ERROR_PROBE message is for messages that are generated
76 * when the rt2x00_dev is not yet initialized.
77 */
78#define PANIC(__dev, __msg, __args...) \
79 DEBUG_PRINTK_MSG(__dev, KERN_CRIT, "Panic", __msg, ##__args)
80#define ERROR(__dev, __msg, __args...) \
81 DEBUG_PRINTK_MSG(__dev, KERN_ERR, "Error", __msg, ##__args)
82#define ERROR_PROBE(__msg, __args...) \
83 DEBUG_PRINTK_PROBE(KERN_ERR, "Error", __msg, ##__args)
84#define WARNING(__dev, __msg, __args...) \
85 DEBUG_PRINTK(__dev, KERN_WARNING, "Warning", __msg, ##__args)
86#define NOTICE(__dev, __msg, __args...) \
87 DEBUG_PRINTK(__dev, KERN_NOTICE, "Notice", __msg, ##__args)
88#define INFO(__dev, __msg, __args...) \
89 DEBUG_PRINTK(__dev, KERN_INFO, "Info", __msg, ##__args)
90#define DEBUG(__dev, __msg, __args...) \
91 DEBUG_PRINTK(__dev, KERN_DEBUG, "Debug", __msg, ##__args)
92#define EEPROM(__dev, __msg, __args...) \
93 DEBUG_PRINTK(__dev, KERN_DEBUG, "EEPROM recovery", __msg, ##__args)
94
95/*
Ivo van Doornbad13632008-11-09 20:47:00 +010096 * Duration calculations
97 * The rate variable passed is: 100kbs.
98 * To convert from bytes to bits we multiply size with 8,
99 * then the size is multiplied with 10 to make the
100 * real rate -> rate argument correction.
101 */
102#define GET_DURATION(__size, __rate) (((__size) * 8 * 10) / (__rate))
103#define GET_DURATION_RES(__size, __rate)(((__size) * 8 * 10) % (__rate))
104
105/*
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700106 * Standard timing and size defines.
107 * These values should follow the ieee80211 specifications.
108 */
109#define ACK_SIZE 14
110#define IEEE80211_HEADER 24
111#define PLCP 48
112#define BEACON 100
113#define PREAMBLE 144
114#define SHORT_PREAMBLE 72
115#define SLOT_TIME 20
116#define SHORT_SLOT_TIME 9
117#define SIFS 10
118#define PIFS ( SIFS + SLOT_TIME )
119#define SHORT_PIFS ( SIFS + SHORT_SLOT_TIME )
120#define DIFS ( PIFS + SLOT_TIME )
121#define SHORT_DIFS ( SHORT_PIFS + SHORT_SLOT_TIME )
Ivo van Doornf2fdbc42008-07-19 16:16:12 +0200122#define EIFS ( SIFS + DIFS + \
Ivo van Doornbad13632008-11-09 20:47:00 +0100123 GET_DURATION(IEEE80211_HEADER + ACK_SIZE, 10) )
Ivo van Doornf2fdbc42008-07-19 16:16:12 +0200124#define SHORT_EIFS ( SIFS + SHORT_DIFS + \
Ivo van Doornbad13632008-11-09 20:47:00 +0100125 GET_DURATION(IEEE80211_HEADER + ACK_SIZE, 10) )
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700126
127/*
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700128 * Chipset identification
129 * The chipset on the device is composed of a RT and RF chip.
130 * The chipset combination is important for determining device capabilities.
131 */
132struct rt2x00_chip {
133 u16 rt;
134#define RT2460 0x0101
135#define RT2560 0x0201
136#define RT2570 0x1201
Ivo van Doorn12dadb92007-09-25 20:54:44 +0200137#define RT2561s 0x0301 /* Turbo */
138#define RT2561 0x0302
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700139#define RT2661 0x0401
140#define RT2571 0x1300
141
142 u16 rf;
143 u32 rev;
144};
145
146/*
147 * RF register values that belong to a particular channel.
148 */
149struct rf_channel {
150 int channel;
151 u32 rf1;
152 u32 rf2;
153 u32 rf3;
154 u32 rf4;
155};
156
157/*
Ivo van Doorn8c5e7a52008-08-04 16:38:47 +0200158 * Channel information structure
159 */
160struct channel_info {
161 unsigned int flags;
162#define GEOGRAPHY_ALLOWED 0x00000001
163
164 short tx_power1;
165 short tx_power2;
166};
167
168/*
Ivo van Doornaddc81bd2007-10-13 16:26:23 +0200169 * Antenna setup values.
170 */
171struct antenna_setup {
172 enum antenna rx;
173 enum antenna tx;
174};
175
176/*
Ivo van Doornebcf26d2007-10-13 16:26:12 +0200177 * Quality statistics about the currently active link.
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700178 */
Ivo van Doornebcf26d2007-10-13 16:26:12 +0200179struct link_qual {
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700180 /*
Ivo van Doorn5352ff62008-12-20 10:54:54 +0100181 * Statistics required for Link tuning by driver
182 * The rssi value is provided by rt2x00lib during the
183 * link_tuner() callback function.
184 * The false_cca field is filled during the link_stats()
185 * callback function and could be used during the
186 * link_tuner() callback function.
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700187 */
Ivo van Doorn5352ff62008-12-20 10:54:54 +0100188 int rssi;
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700189 int false_cca;
190
191 /*
Ivo van Doorn5352ff62008-12-20 10:54:54 +0100192 * VGC levels
193 * Hardware driver will tune the VGC level during each call
194 * to the link_tuner() callback function. This vgc_level is
195 * is determined based on the link quality statistics like
196 * average RSSI and the false CCA count.
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700197 *
Ivo van Doorn5352ff62008-12-20 10:54:54 +0100198 * In some cases the drivers need to differentiate between
199 * the currently "desired" VGC level and the level configured
200 * in the hardware. The latter is important to reduce the
201 * number of BBP register reads to reduce register access
202 * overhead. For this reason we store both values here.
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700203 */
Ivo van Doorn5352ff62008-12-20 10:54:54 +0100204 u8 vgc_level;
205 u8 vgc_level_reg;
206
207 /*
208 * Statistics required for Signal quality calculation.
209 * These fields might be changed during the link_stats()
210 * callback function.
211 */
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700212 int rx_success;
213 int rx_failed;
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700214 int tx_success;
215 int tx_failed;
Ivo van Doornebcf26d2007-10-13 16:26:12 +0200216};
217
218/*
Ivo van Doorn69f81a22007-10-13 16:26:36 +0200219 * Antenna settings about the currently active link.
220 */
221struct link_ant {
222 /*
223 * Antenna flags
224 */
225 unsigned int flags;
226#define ANTENNA_RX_DIVERSITY 0x00000001
227#define ANTENNA_TX_DIVERSITY 0x00000002
228#define ANTENNA_MODE_SAMPLE 0x00000004
229
230 /*
231 * Currently active TX/RX antenna setup.
232 * When software diversity is used, this will indicate
233 * which antenna is actually used at this time.
234 */
235 struct antenna_setup active;
236
237 /*
238 * RSSI information for the different antenna's.
239 * These statistics are used to determine when
240 * to switch antenna when using software diversity.
241 *
242 * rssi[0] -> Antenna A RSSI
243 * rssi[1] -> Antenna B RSSI
244 */
245 int rssi_history[2];
246
247 /*
248 * Current RSSI average of the currently active antenna.
249 * Similar to the avg_rssi in the link_qual structure
250 * this value is updated by using the walking average.
251 */
252 int rssi_ant;
253};
254
255/*
Ivo van Doornebcf26d2007-10-13 16:26:12 +0200256 * To optimize the quality of the link we need to store
257 * the quality of received frames and periodically
258 * optimize the link.
259 */
260struct link {
261 /*
262 * Link tuner counter
263 * The number of times the link has been tuned
264 * since the radio has been switched on.
265 */
266 u32 count;
267
268 /*
269 * Quality measurement values.
270 */
271 struct link_qual qual;
272
273 /*
Ivo van Doorn69f81a22007-10-13 16:26:36 +0200274 * TX/RX antenna setup.
Ivo van Doornaddc81bd2007-10-13 16:26:23 +0200275 */
Ivo van Doorn69f81a22007-10-13 16:26:36 +0200276 struct link_ant ant;
Ivo van Doornaddc81bd2007-10-13 16:26:23 +0200277
278 /*
Ivo van Doorn5352ff62008-12-20 10:54:54 +0100279 * Currently active average RSSI value
Ivo van Doornebcf26d2007-10-13 16:26:12 +0200280 */
Ivo van Doorn5352ff62008-12-20 10:54:54 +0100281 int avg_rssi;
Ivo van Doorneb20b4e2008-12-20 10:54:22 +0100282
283 /*
Ivo van Doorn5352ff62008-12-20 10:54:54 +0100284 * Currently precalculated percentages of successful
285 * TX and RX frames.
Ivo van Doorneb20b4e2008-12-20 10:54:22 +0100286 */
Ivo van Doorn5352ff62008-12-20 10:54:54 +0100287 int rx_percentage;
288 int tx_percentage;
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700289
290 /*
291 * Work structure for scheduling periodic link tuning.
292 */
293 struct delayed_work work;
294};
295
296/*
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700297 * Interface structure
Ivo van Doorn6bb40dd2008-02-03 15:49:59 +0100298 * Per interface configuration details, this structure
299 * is allocated as the private data for ieee80211_vif.
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700300 */
Ivo van Doorn6bb40dd2008-02-03 15:49:59 +0100301struct rt2x00_intf {
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700302 /*
Ivo van Doorn6bb40dd2008-02-03 15:49:59 +0100303 * All fields within the rt2x00_intf structure
304 * must be protected with a spinlock.
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700305 */
Ivo van Doorn6bb40dd2008-02-03 15:49:59 +0100306 spinlock_t lock;
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700307
308 /*
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700309 * MAC of the device.
310 */
311 u8 mac[ETH_ALEN];
312
313 /*
314 * BBSID of the AP to associate with.
315 */
316 u8 bssid[ETH_ALEN];
Ivo van Doorn6bb40dd2008-02-03 15:49:59 +0100317
318 /*
319 * Entry in the beacon queue which belongs to
320 * this interface. Each interface has its own
321 * dedicated beacon entry.
322 */
323 struct queue_entry *beacon;
324
325 /*
326 * Actions that needed rescheduling.
327 */
328 unsigned int delayed_flags;
329#define DELAYED_UPDATE_BEACON 0x00000001
Ivo van Doorn72810372008-03-09 22:46:18 +0100330#define DELAYED_CONFIG_ERP 0x00000002
Ivo van Doorna2e1d522008-03-31 15:53:44 +0200331#define DELAYED_LED_ASSOC 0x00000004
Johannes Bergf591fa52008-07-10 11:21:26 +0200332
Ivo van Doornd4764b22008-07-28 10:21:16 +0200333 /*
334 * Software sequence counter, this is only required
335 * for hardware which doesn't support hardware
336 * sequence counting.
337 */
338 spinlock_t seqlock;
Johannes Bergf591fa52008-07-10 11:21:26 +0200339 u16 seqno;
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700340};
341
Ivo van Doorn6bb40dd2008-02-03 15:49:59 +0100342static inline struct rt2x00_intf* vif_to_intf(struct ieee80211_vif *vif)
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700343{
Ivo van Doorn6bb40dd2008-02-03 15:49:59 +0100344 return (struct rt2x00_intf *)vif->drv_priv;
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700345}
346
Ivo van Doorn31562e82008-02-17 17:35:05 +0100347/**
348 * struct hw_mode_spec: Hardware specifications structure
349 *
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700350 * Details about the supported modes, rates and channels
351 * of a particular chipset. This is used by rt2x00lib
352 * to build the ieee80211_hw_mode array for mac80211.
Ivo van Doorn31562e82008-02-17 17:35:05 +0100353 *
354 * @supported_bands: Bitmask contained the supported bands (2.4GHz, 5.2GHz).
355 * @supported_rates: Rate types which are supported (CCK, OFDM).
356 * @num_channels: Number of supported channels. This is used as array size
357 * for @tx_power_a, @tx_power_bg and @channels.
Ivo van Doorn9a46d442008-04-21 19:02:17 +0200358 * @channels: Device/chipset specific channel values (See &struct rf_channel).
Ivo van Doorn8c5e7a52008-08-04 16:38:47 +0200359 * @channels_info: Additional information for channels (See &struct channel_info).
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700360 */
361struct hw_mode_spec {
Ivo van Doorn31562e82008-02-17 17:35:05 +0100362 unsigned int supported_bands;
363#define SUPPORT_BAND_2GHZ 0x00000001
364#define SUPPORT_BAND_5GHZ 0x00000002
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700365
Ivo van Doorn31562e82008-02-17 17:35:05 +0100366 unsigned int supported_rates;
367#define SUPPORT_RATE_CCK 0x00000001
368#define SUPPORT_RATE_OFDM 0x00000002
369
370 unsigned int num_channels;
371 const struct rf_channel *channels;
Ivo van Doorn8c5e7a52008-08-04 16:38:47 +0200372 const struct channel_info *channels_info;
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700373};
374
375/*
Ivo van Doorn5c58ee52007-10-06 13:34:52 +0200376 * Configuration structure wrapper around the
377 * mac80211 configuration structure.
378 * When mac80211 configures the driver, rt2x00lib
379 * can precalculate values which are equal for all
380 * rt2x00 drivers. Those values can be stored in here.
381 */
382struct rt2x00lib_conf {
383 struct ieee80211_conf *conf;
Ivo van Doorn8c5e7a52008-08-04 16:38:47 +0200384
Ivo van Doorn5c58ee52007-10-06 13:34:52 +0200385 struct rf_channel rf;
Ivo van Doorn8c5e7a52008-08-04 16:38:47 +0200386 struct channel_info channel;
Ivo van Doorn5c58ee52007-10-06 13:34:52 +0200387};
388
389/*
Ivo van Doorn72810372008-03-09 22:46:18 +0100390 * Configuration structure for erp settings.
391 */
392struct rt2x00lib_erp {
393 int short_preamble;
Ivo van Doorne360c4c2008-07-09 15:12:06 +0200394 int cts_protection;
Ivo van Doorn72810372008-03-09 22:46:18 +0100395
396 int ack_timeout;
397 int ack_consume_time;
Ivo van Doorne4ea1c42008-10-29 17:17:57 +0100398
Johannes Berg881d9482009-01-21 15:13:48 +0100399 u32 basic_rates;
Ivo van Doorne4ea1c42008-10-29 17:17:57 +0100400
401 int slot_time;
402
403 short sifs;
404 short pifs;
405 short difs;
406 short eifs;
Ivo van Doorn72810372008-03-09 22:46:18 +0100407};
408
409/*
Ivo van Doorn2bb057d2008-08-04 16:37:44 +0200410 * Configuration structure for hardware encryption.
411 */
412struct rt2x00lib_crypto {
413 enum cipher cipher;
414
415 enum set_key_cmd cmd;
416 const u8 *address;
417
418 u32 bssidx;
419 u32 aid;
420
421 u8 key[16];
422 u8 tx_mic[8];
423 u8 rx_mic[8];
424};
425
426/*
Ivo van Doorn6bb40dd2008-02-03 15:49:59 +0100427 * Configuration structure wrapper around the
428 * rt2x00 interface configuration handler.
429 */
430struct rt2x00intf_conf {
431 /*
432 * Interface type
433 */
Johannes Berg05c914f2008-09-11 00:01:58 +0200434 enum nl80211_iftype type;
Ivo van Doorn6bb40dd2008-02-03 15:49:59 +0100435
436 /*
437 * TSF sync value, this is dependant on the operation type.
438 */
439 enum tsf_sync sync;
440
441 /*
442 * The MAC and BSSID addressess are simple array of bytes,
443 * these arrays are little endian, so when sending the addressess
444 * to the drivers, copy the it into a endian-signed variable.
445 *
446 * Note that all devices (except rt2500usb) have 32 bits
447 * register word sizes. This means that whatever variable we
448 * pass _must_ be a multiple of 32 bits. Otherwise the device
449 * might not accept what we are sending to it.
450 * This will also make it easier for the driver to write
451 * the data to the device.
452 */
453 __le32 mac[2];
454 __le32 bssid[2];
455};
456
457/*
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700458 * rt2x00lib callback functions.
459 */
460struct rt2x00lib_ops {
461 /*
462 * Interrupt handlers.
463 */
464 irq_handler_t irq_handler;
465
466 /*
467 * Device init handlers.
468 */
469 int (*probe_hw) (struct rt2x00_dev *rt2x00dev);
470 char *(*get_firmware_name) (struct rt2x00_dev *rt2x00dev);
David Woodhousef160ebc2008-05-24 00:08:39 +0100471 u16 (*get_firmware_crc) (const void *data, const size_t len);
472 int (*load_firmware) (struct rt2x00_dev *rt2x00dev, const void *data,
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700473 const size_t len);
474
475 /*
476 * Device initialization/deinitialization handlers.
477 */
478 int (*initialize) (struct rt2x00_dev *rt2x00dev);
479 void (*uninitialize) (struct rt2x00_dev *rt2x00dev);
480
481 /*
Ivo van Doorn181d6902008-02-05 16:42:23 -0500482 * queue initialization handlers
Ivo van Doorn837e7f22008-01-06 23:41:45 +0100483 */
Ivo van Doorn798b7ad2008-11-08 15:25:33 +0100484 bool (*get_entry_state) (struct queue_entry *entry);
485 void (*clear_entry) (struct queue_entry *entry);
Ivo van Doorn837e7f22008-01-06 23:41:45 +0100486
487 /*
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700488 * Radio control handlers.
489 */
490 int (*set_device_state) (struct rt2x00_dev *rt2x00dev,
491 enum dev_state state);
492 int (*rfkill_poll) (struct rt2x00_dev *rt2x00dev);
Ivo van Doornebcf26d2007-10-13 16:26:12 +0200493 void (*link_stats) (struct rt2x00_dev *rt2x00dev,
494 struct link_qual *qual);
Ivo van Doorn5352ff62008-12-20 10:54:54 +0100495 void (*reset_tuner) (struct rt2x00_dev *rt2x00dev,
496 struct link_qual *qual);
497 void (*link_tuner) (struct rt2x00_dev *rt2x00dev,
498 struct link_qual *qual, const u32 count);
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700499
500 /*
501 * TX control handlers
502 */
503 void (*write_tx_desc) (struct rt2x00_dev *rt2x00dev,
Ivo van Doorndd3193e2008-01-06 23:41:10 +0100504 struct sk_buff *skb,
Ivo van Doorn61486e02008-05-10 13:42:31 +0200505 struct txentry_desc *txdesc);
Ivo van Doorn6db37862008-06-06 22:50:28 +0200506 int (*write_tx_data) (struct queue_entry *entry);
Ivo van Doornbd88a782008-07-09 15:12:44 +0200507 void (*write_beacon) (struct queue_entry *entry);
Ivo van Doornf1ca2162008-11-13 23:07:33 +0100508 int (*get_tx_data_len) (struct queue_entry *entry);
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700509 void (*kick_tx_queue) (struct rt2x00_dev *rt2x00dev,
Ivo van Doorne58c6ac2008-04-21 19:00:47 +0200510 const enum data_queue_qid queue);
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700511
512 /*
513 * RX control handlers
514 */
Ivo van Doorn181d6902008-02-05 16:42:23 -0500515 void (*fill_rxdone) (struct queue_entry *entry,
516 struct rxdone_entry_desc *rxdesc);
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700517
518 /*
519 * Configuration handlers.
520 */
Ivo van Doorn2bb057d2008-08-04 16:37:44 +0200521 int (*config_shared_key) (struct rt2x00_dev *rt2x00dev,
522 struct rt2x00lib_crypto *crypto,
523 struct ieee80211_key_conf *key);
524 int (*config_pairwise_key) (struct rt2x00_dev *rt2x00dev,
525 struct rt2x00lib_crypto *crypto,
526 struct ieee80211_key_conf *key);
Ivo van Doorn3a643d22008-03-25 14:13:18 +0100527 void (*config_filter) (struct rt2x00_dev *rt2x00dev,
528 const unsigned int filter_flags);
Ivo van Doorn6bb40dd2008-02-03 15:49:59 +0100529 void (*config_intf) (struct rt2x00_dev *rt2x00dev,
530 struct rt2x00_intf *intf,
531 struct rt2x00intf_conf *conf,
532 const unsigned int flags);
533#define CONFIG_UPDATE_TYPE ( 1 << 1 )
534#define CONFIG_UPDATE_MAC ( 1 << 2 )
535#define CONFIG_UPDATE_BSSID ( 1 << 3 )
536
Ivo van Doorn3a643d22008-03-25 14:13:18 +0100537 void (*config_erp) (struct rt2x00_dev *rt2x00dev,
538 struct rt2x00lib_erp *erp);
Ivo van Doorne4ea1c42008-10-29 17:17:57 +0100539 void (*config_ant) (struct rt2x00_dev *rt2x00dev,
540 struct antenna_setup *ant);
Ivo van Doorn6bb40dd2008-02-03 15:49:59 +0100541 void (*config) (struct rt2x00_dev *rt2x00dev,
542 struct rt2x00lib_conf *libconf,
Ivo van Doorne4ea1c42008-10-29 17:17:57 +0100543 const unsigned int changed_flags);
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700544};
545
546/*
547 * rt2x00 driver callback operation structure.
548 */
549struct rt2x00_ops {
550 const char *name;
Ivo van Doorn6bb40dd2008-02-03 15:49:59 +0100551 const unsigned int max_sta_intf;
552 const unsigned int max_ap_intf;
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700553 const unsigned int eeprom_size;
554 const unsigned int rf_size;
Gertjan van Wingerde61448f82008-05-10 13:43:33 +0200555 const unsigned int tx_queues;
Ivo van Doorn181d6902008-02-05 16:42:23 -0500556 const struct data_queue_desc *rx;
557 const struct data_queue_desc *tx;
558 const struct data_queue_desc *bcn;
559 const struct data_queue_desc *atim;
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700560 const struct rt2x00lib_ops *lib;
561 const struct ieee80211_ops *hw;
562#ifdef CONFIG_RT2X00_LIB_DEBUGFS
563 const struct rt2x00debug *debugfs;
564#endif /* CONFIG_RT2X00_LIB_DEBUGFS */
565};
566
567/*
Ivo van Doorn483272f2007-10-06 14:13:06 +0200568 * rt2x00 device flags
569 */
570enum rt2x00_flags {
571 /*
572 * Device state flags
573 */
Ivo van Doorn0262ab02008-08-29 21:04:26 +0200574 DEVICE_STATE_PRESENT,
575 DEVICE_STATE_REGISTERED_HW,
576 DEVICE_STATE_INITIALIZED,
577 DEVICE_STATE_STARTED,
578 DEVICE_STATE_STARTED_SUSPEND,
579 DEVICE_STATE_ENABLED_RADIO,
580 DEVICE_STATE_DISABLED_RADIO_HW,
Ivo van Doorn483272f2007-10-06 14:13:06 +0200581
582 /*
Ivo van Doorn2bb057d2008-08-04 16:37:44 +0200583 * Driver requirements
Ivo van Doorn483272f2007-10-06 14:13:06 +0200584 */
585 DRIVER_REQUIRE_FIRMWARE,
Ivo van Doorn181d6902008-02-05 16:42:23 -0500586 DRIVER_REQUIRE_BEACON_GUARD,
587 DRIVER_REQUIRE_ATIM_QUEUE,
Ivo van Doorn3a643d22008-03-25 14:13:18 +0100588 DRIVER_REQUIRE_SCHEDULED,
Gertjan van Wingerdec4da0042008-06-16 19:56:31 +0200589 DRIVER_REQUIRE_DMA,
Ivo van Doorn3f787bd2008-12-20 10:56:36 +0100590 DRIVER_REQUIRE_COPY_IV,
Ivo van Doorn483272f2007-10-06 14:13:06 +0200591
592 /*
Ivo van Doorn2bb057d2008-08-04 16:37:44 +0200593 * Driver features
Ivo van Doorn483272f2007-10-06 14:13:06 +0200594 */
595 CONFIG_SUPPORT_HW_BUTTON,
Ivo van Doorn2bb057d2008-08-04 16:37:44 +0200596 CONFIG_SUPPORT_HW_CRYPTO,
597
598 /*
599 * Driver configuration
600 */
Ivo van Doorn483272f2007-10-06 14:13:06 +0200601 CONFIG_FRAME_TYPE,
602 CONFIG_RF_SEQUENCE,
603 CONFIG_EXTERNAL_LNA_A,
604 CONFIG_EXTERNAL_LNA_BG,
605 CONFIG_DOUBLE_ANTENNA,
606 CONFIG_DISABLE_LINK_TUNING,
607};
608
609/*
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700610 * rt2x00 device structure.
611 */
612struct rt2x00_dev {
613 /*
614 * Device structure.
615 * The structure stored in here depends on the
616 * system bus (PCI or USB).
617 * When accessing this variable, the rt2x00dev_{pci,usb}
618 * macro's should be used for correct typecasting.
619 */
Gertjan van Wingerde14a3bf82008-06-16 19:55:43 +0200620 struct device *dev;
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700621
622 /*
623 * Callback functions.
624 */
625 const struct rt2x00_ops *ops;
626
627 /*
628 * IEEE80211 control structure.
629 */
630 struct ieee80211_hw *hw;
Johannes Berg8318d782008-01-24 19:38:38 +0100631 struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
632 enum ieee80211_band curr_band;
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700633
634 /*
635 * rfkill structure for RF state switching support.
636 * This will only be compiled in when required.
637 */
638#ifdef CONFIG_RT2X00_LIB_RFKILL
John W. Linville3480a582008-03-27 19:54:13 -0400639 unsigned long rfkill_state;
Ivo van Doorn1682fe62008-03-13 15:38:03 +0100640#define RFKILL_STATE_ALLOCATED 1
641#define RFKILL_STATE_REGISTERED 2
Ivo van Doorncca3e992009-01-03 19:56:02 +0100642#define RFKILL_STATE_BLOCKED 3
643 struct input_polled_dev *rfkill_poll_dev;
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700644#endif /* CONFIG_RT2X00_LIB_RFKILL */
645
646 /*
647 * If enabled, the debugfs interface structures
648 * required for deregistration of debugfs.
649 */
650#ifdef CONFIG_RT2X00_LIB_DEBUGFS
Ivo van Doorn4d8dd662007-11-27 21:49:29 +0100651 struct rt2x00debug_intf *debugfs_intf;
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700652#endif /* CONFIG_RT2X00_LIB_DEBUGFS */
653
654 /*
Ivo van Doorna9450b72008-02-03 15:53:40 +0100655 * LED structure for changing the LED status
656 * by mac8011 or the kernel.
657 */
658#ifdef CONFIG_RT2X00_LIB_LEDS
Ivo van Doorna9450b72008-02-03 15:53:40 +0100659 struct rt2x00_led led_radio;
660 struct rt2x00_led led_assoc;
661 struct rt2x00_led led_qual;
662 u16 led_mcu_reg;
663#endif /* CONFIG_RT2X00_LIB_LEDS */
664
665 /*
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700666 * Device flags.
667 * In these flags the current status and some
668 * of the device capabilities are stored.
669 */
670 unsigned long flags;
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700671
672 /*
673 * Chipset identification.
674 */
675 struct rt2x00_chip chip;
676
677 /*
678 * hw capability specifications.
679 */
680 struct hw_mode_spec spec;
681
682 /*
Ivo van Doornaddc81bd2007-10-13 16:26:23 +0200683 * This is the default TX/RX antenna setup as indicated
Ivo van Doorn6d643602008-11-02 00:38:10 +0100684 * by the device's EEPROM.
Ivo van Doornaddc81bd2007-10-13 16:26:23 +0200685 */
686 struct antenna_setup default_ant;
687
688 /*
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700689 * Register pointers
Ivo van Doorn21795092008-02-10 22:49:13 +0100690 * csr.base: CSR base register address. (PCI)
691 * csr.cache: CSR cache for usb_control_msg. (USB)
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700692 */
Ivo van Doorn21795092008-02-10 22:49:13 +0100693 union csr {
694 void __iomem *base;
695 void *cache;
696 } csr;
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700697
698 /*
Ivo van Doorn8ff48a82008-11-09 23:40:46 +0100699 * Mutex to protect register accesses.
700 * For PCI and USB devices it protects against concurrent indirect
701 * register access (BBP, RF, MCU) since accessing those
702 * registers require multiple calls to the CSR registers.
703 * For USB devices it also protects the csr_cache since that
704 * field is used for normal CSR access and it cannot support
705 * multiple callers simultaneously.
Adam Baker3d823462007-10-27 13:43:29 +0200706 */
Ivo van Doorn8ff48a82008-11-09 23:40:46 +0100707 struct mutex csr_mutex;
Adam Baker3d823462007-10-27 13:43:29 +0200708
709 /*
Ivo van Doorn3c4f2082008-01-06 23:40:49 +0100710 * Current packet filter configuration for the device.
711 * This contains all currently active FIF_* flags send
712 * to us by mac80211 during configure_filter().
713 */
714 unsigned int packet_filter;
715
716 /*
Ivo van Doorn6bb40dd2008-02-03 15:49:59 +0100717 * Interface details:
718 * - Open ap interface count.
719 * - Open sta interface count.
720 * - Association count.
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700721 */
Ivo van Doorn6bb40dd2008-02-03 15:49:59 +0100722 unsigned int intf_ap_count;
723 unsigned int intf_sta_count;
724 unsigned int intf_associated;
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700725
726 /*
727 * Link quality
728 */
729 struct link link;
730
731 /*
732 * EEPROM data.
733 */
734 __le16 *eeprom;
735
736 /*
737 * Active RF register values.
738 * These are stored here so we don't need
739 * to read the rf registers and can directly
740 * use this value instead.
741 * This field should be accessed by using
742 * rt2x00_rf_read() and rt2x00_rf_write().
743 */
744 u32 *rf;
745
746 /*
Ivo van Doornba2ab472008-08-06 16:22:17 +0200747 * LNA gain
748 */
749 short lna_gain;
750
751 /*
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700752 * Current TX power value.
753 */
754 u16 tx_power;
755
756 /*
Ivo van Doorn42c82852008-12-02 18:20:04 +0100757 * Current retry values.
758 */
759 u8 short_retry;
760 u8 long_retry;
761
762 /*
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700763 * Rssi <-> Dbm offset
764 */
765 u8 rssi_offset;
766
767 /*
768 * Frequency offset (for rt61pci & rt73usb).
769 */
770 u8 freq_offset;
771
772 /*
773 * Low level statistics which will have
774 * to be kept up to date while device is running.
775 */
776 struct ieee80211_low_level_stats low_level_stats;
777
778 /*
779 * RX configuration information.
780 */
781 struct ieee80211_rx_status rx_status;
782
783 /*
Johannes Berg4150c572007-09-17 01:29:23 -0400784 * Scheduled work.
Ivo van Doorn8e260c22008-07-04 13:41:31 +0200785 * NOTE: intf_work will use ieee80211_iterate_active_interfaces()
786 * which means it cannot be placed on the hw->workqueue
787 * due to RTNL locking requirements.
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700788 */
Ivo van Doorn6bb40dd2008-02-03 15:49:59 +0100789 struct work_struct intf_work;
Johannes Berg4150c572007-09-17 01:29:23 -0400790 struct work_struct filter_work;
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700791
792 /*
Ivo van Doorn181d6902008-02-05 16:42:23 -0500793 * Data queue arrays for RX, TX and Beacon.
794 * The Beacon array also contains the Atim queue
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700795 * if that is supported by the device.
796 */
Ivo van Doornb8697672008-06-06 22:53:14 +0200797 unsigned int data_queues;
Ivo van Doorn181d6902008-02-05 16:42:23 -0500798 struct data_queue *rx;
799 struct data_queue *tx;
800 struct data_queue *bcn;
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700801
802 /*
803 * Firmware image.
804 */
805 const struct firmware *fw;
806};
807
808/*
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700809 * Generic RF access.
810 * The RF is being accessed by word index.
811 */
Adam Baker0e14f6d2007-10-27 13:41:25 +0200812static inline void rt2x00_rf_read(struct rt2x00_dev *rt2x00dev,
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700813 const unsigned int word, u32 *data)
814{
815 *data = rt2x00dev->rf[word];
816}
817
Adam Baker0e14f6d2007-10-27 13:41:25 +0200818static inline void rt2x00_rf_write(struct rt2x00_dev *rt2x00dev,
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700819 const unsigned int word, u32 data)
820{
821 rt2x00dev->rf[word] = data;
822}
823
824/*
825 * Generic EEPROM access.
826 * The EEPROM is being accessed by word index.
827 */
Adam Baker0e14f6d2007-10-27 13:41:25 +0200828static inline void *rt2x00_eeprom_addr(struct rt2x00_dev *rt2x00dev,
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700829 const unsigned int word)
830{
831 return (void *)&rt2x00dev->eeprom[word];
832}
833
Adam Baker0e14f6d2007-10-27 13:41:25 +0200834static inline void rt2x00_eeprom_read(struct rt2x00_dev *rt2x00dev,
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700835 const unsigned int word, u16 *data)
836{
837 *data = le16_to_cpu(rt2x00dev->eeprom[word]);
838}
839
Adam Baker0e14f6d2007-10-27 13:41:25 +0200840static inline void rt2x00_eeprom_write(struct rt2x00_dev *rt2x00dev,
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700841 const unsigned int word, u16 data)
842{
843 rt2x00dev->eeprom[word] = cpu_to_le16(data);
844}
845
846/*
847 * Chipset handlers
848 */
849static inline void rt2x00_set_chip(struct rt2x00_dev *rt2x00dev,
850 const u16 rt, const u16 rf, const u32 rev)
851{
852 INFO(rt2x00dev,
853 "Chipset detected - rt: %04x, rf: %04x, rev: %08x.\n",
854 rt, rf, rev);
855
856 rt2x00dev->chip.rt = rt;
857 rt2x00dev->chip.rf = rf;
858 rt2x00dev->chip.rev = rev;
859}
860
861static inline char rt2x00_rt(const struct rt2x00_chip *chipset, const u16 chip)
862{
863 return (chipset->rt == chip);
864}
865
866static inline char rt2x00_rf(const struct rt2x00_chip *chipset, const u16 chip)
867{
868 return (chipset->rf == chip);
869}
870
Ivo van Doorn755a9572007-11-12 15:02:22 +0100871static inline u16 rt2x00_rev(const struct rt2x00_chip *chipset)
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700872{
873 return chipset->rev;
874}
875
Ivo van Doorn755a9572007-11-12 15:02:22 +0100876static inline u16 rt2x00_check_rev(const struct rt2x00_chip *chipset,
877 const u32 rev)
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700878{
Ivo van Doorn755a9572007-11-12 15:02:22 +0100879 return (((chipset->rev & 0xffff0) == rev) &&
880 !!(chipset->rev & 0x0000f));
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700881}
882
Ivo van Doorn181d6902008-02-05 16:42:23 -0500883/**
Gertjan van Wingerdec4da0042008-06-16 19:56:31 +0200884 * rt2x00queue_map_txskb - Map a skb into DMA for TX purposes.
885 * @rt2x00dev: Pointer to &struct rt2x00_dev.
886 * @skb: The skb to map.
Gertjan van Wingerde239c2492008-06-06 22:54:12 +0200887 */
Gertjan van Wingerdec4da0042008-06-16 19:56:31 +0200888void rt2x00queue_map_txskb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb);
Gertjan van Wingerde239c2492008-06-06 22:54:12 +0200889
890/**
Ivo van Doorne58c6ac2008-04-21 19:00:47 +0200891 * rt2x00queue_get_queue - Convert queue index to queue pointer
Ivo van Doorn181d6902008-02-05 16:42:23 -0500892 * @rt2x00dev: Pointer to &struct rt2x00_dev.
Ivo van Doorne58c6ac2008-04-21 19:00:47 +0200893 * @queue: rt2x00 queue index (see &enum data_queue_qid).
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700894 */
Ivo van Doorn181d6902008-02-05 16:42:23 -0500895struct data_queue *rt2x00queue_get_queue(struct rt2x00_dev *rt2x00dev,
Ivo van Doorne58c6ac2008-04-21 19:00:47 +0200896 const enum data_queue_qid queue);
Ivo van Doorn181d6902008-02-05 16:42:23 -0500897
898/**
899 * rt2x00queue_get_entry - Get queue entry where the given index points to.
Ivo van Doorn9a46d442008-04-21 19:02:17 +0200900 * @queue: Pointer to &struct data_queue from where we obtain the entry.
Ivo van Doorn181d6902008-02-05 16:42:23 -0500901 * @index: Index identifier for obtaining the correct index.
902 */
903struct queue_entry *rt2x00queue_get_entry(struct data_queue *queue,
904 enum queue_index index);
905
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700906/*
907 * Interrupt context handlers.
908 */
909void rt2x00lib_beacondone(struct rt2x00_dev *rt2x00dev);
Ivo van Doorn181d6902008-02-05 16:42:23 -0500910void rt2x00lib_txdone(struct queue_entry *entry,
911 struct txdone_entry_desc *txdesc);
Gertjan van Wingerdec4da0042008-06-16 19:56:31 +0200912void rt2x00lib_rxdone(struct rt2x00_dev *rt2x00dev,
913 struct queue_entry *entry);
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700914
915/*
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700916 * mac80211 handlers.
917 */
Johannes Berge039fa42008-05-15 12:55:29 +0200918int rt2x00mac_tx(struct ieee80211_hw *hw, struct sk_buff *skb);
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700919int rt2x00mac_start(struct ieee80211_hw *hw);
920void rt2x00mac_stop(struct ieee80211_hw *hw);
921int rt2x00mac_add_interface(struct ieee80211_hw *hw,
922 struct ieee80211_if_init_conf *conf);
923void rt2x00mac_remove_interface(struct ieee80211_hw *hw,
924 struct ieee80211_if_init_conf *conf);
Johannes Berge8975582008-10-09 12:18:51 +0200925int rt2x00mac_config(struct ieee80211_hw *hw, u32 changed);
Johannes Berg32bfd352007-12-19 01:31:26 +0100926int rt2x00mac_config_interface(struct ieee80211_hw *hw,
927 struct ieee80211_vif *vif,
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700928 struct ieee80211_if_conf *conf);
Ivo van Doorn3a643d22008-03-25 14:13:18 +0100929void rt2x00mac_configure_filter(struct ieee80211_hw *hw,
930 unsigned int changed_flags,
931 unsigned int *total_flags,
932 int mc_count, struct dev_addr_list *mc_list);
Ivo van Doorn2bb057d2008-08-04 16:37:44 +0200933#ifdef CONFIG_RT2X00_LIB_CRYPTO
934int rt2x00mac_set_key(struct ieee80211_hw *hw, enum set_key_cmd cmd,
Johannes Bergdc822b52008-12-29 12:55:09 +0100935 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
Ivo van Doorn2bb057d2008-08-04 16:37:44 +0200936 struct ieee80211_key_conf *key);
937#else
938#define rt2x00mac_set_key NULL
939#endif /* CONFIG_RT2X00_LIB_CRYPTO */
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700940int rt2x00mac_get_stats(struct ieee80211_hw *hw,
941 struct ieee80211_low_level_stats *stats);
942int rt2x00mac_get_tx_stats(struct ieee80211_hw *hw,
943 struct ieee80211_tx_queue_stats *stats);
Johannes Berg471b3ef2007-12-28 14:32:58 +0100944void rt2x00mac_bss_info_changed(struct ieee80211_hw *hw,
945 struct ieee80211_vif *vif,
946 struct ieee80211_bss_conf *bss_conf,
947 u32 changes);
Johannes Berge100bb62008-04-30 18:51:21 +0200948int rt2x00mac_conf_tx(struct ieee80211_hw *hw, u16 queue,
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700949 const struct ieee80211_tx_queue_params *params);
950
951/*
952 * Driver allocation handlers.
953 */
954int rt2x00lib_probe_dev(struct rt2x00_dev *rt2x00dev);
955void rt2x00lib_remove_dev(struct rt2x00_dev *rt2x00dev);
956#ifdef CONFIG_PM
957int rt2x00lib_suspend(struct rt2x00_dev *rt2x00dev, pm_message_t state);
958int rt2x00lib_resume(struct rt2x00_dev *rt2x00dev);
959#endif /* CONFIG_PM */
960
961#endif /* RT2X00_H */