b32fedf4a1b907f005fce31f38befca45d722b4b
[kernel.git] / drivers / net / wireless / rt2x00 / rt2x00.h
1 /*
2         Copyright (C) 2004 - 2008 rt2x00 SourceForge Project
3         <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>
30 #include <linux/skbuff.h>
31 #include <linux/workqueue.h>
32 #include <linux/firmware.h>
33 #include <linux/leds.h>
34 #include <linux/mutex.h>
35 #include <linux/etherdevice.h>
36
37 #include <net/mac80211.h>
38
39 #include "rt2x00debug.h"
40 #include "rt2x00leds.h"
41 #include "rt2x00reg.h"
42 #include "rt2x00queue.h"
43
44 /*
45  * Module information.
46  */
47 #define DRV_VERSION     "2.1.8"
48 #define DRV_PROJECT     "http://rt2x00.serialmonkey.com"
49
50 /*
51  * Debug definitions.
52  * Debug output has to be enabled during compile time.
53  */
54 #define DEBUG_PRINTK_MSG(__dev, __kernlvl, __lvl, __msg, __args...)     \
55         printk(__kernlvl "%s -> %s: %s - " __msg,                       \
56                wiphy_name((__dev)->hw->wiphy), __FUNCTION__, __lvl, ##__args)
57
58 #define DEBUG_PRINTK_PROBE(__kernlvl, __lvl, __msg, __args...)  \
59         printk(__kernlvl "%s -> %s: %s - " __msg,               \
60                KBUILD_MODNAME, __FUNCTION__, __lvl, ##__args)
61
62 #ifdef CONFIG_RT2X00_DEBUG
63 #define DEBUG_PRINTK(__dev, __kernlvl, __lvl, __msg, __args...) \
64         DEBUG_PRINTK_MSG(__dev, __kernlvl, __lvl, __msg, ##__args);
65 #else
66 #define DEBUG_PRINTK(__dev, __kernlvl, __lvl, __msg, __args...) \
67         do { } while (0)
68 #endif /* CONFIG_RT2X00_DEBUG */
69
70 /*
71  * Various debug levels.
72  * The debug levels PANIC and ERROR both indicate serious problems,
73  * for this reason they should never be ignored.
74  * The special ERROR_PROBE message is for messages that are generated
75  * when the rt2x00_dev is not yet initialized.
76  */
77 #define PANIC(__dev, __msg, __args...) \
78         DEBUG_PRINTK_MSG(__dev, KERN_CRIT, "Panic", __msg, ##__args)
79 #define ERROR(__dev, __msg, __args...)  \
80         DEBUG_PRINTK_MSG(__dev, KERN_ERR, "Error", __msg, ##__args)
81 #define ERROR_PROBE(__msg, __args...) \
82         DEBUG_PRINTK_PROBE(KERN_ERR, "Error", __msg, ##__args)
83 #define WARNING(__dev, __msg, __args...) \
84         DEBUG_PRINTK(__dev, KERN_WARNING, "Warning", __msg, ##__args)
85 #define NOTICE(__dev, __msg, __args...) \
86         DEBUG_PRINTK(__dev, KERN_NOTICE, "Notice", __msg, ##__args)
87 #define INFO(__dev, __msg, __args...) \
88         DEBUG_PRINTK(__dev, KERN_INFO, "Info", __msg, ##__args)
89 #define DEBUG(__dev, __msg, __args...) \
90         DEBUG_PRINTK(__dev, KERN_DEBUG, "Debug", __msg, ##__args)
91 #define EEPROM(__dev, __msg, __args...) \
92         DEBUG_PRINTK(__dev, KERN_DEBUG, "EEPROM recovery", __msg, ##__args)
93
94 /*
95  * Standard timing and size defines.
96  * These values should follow the ieee80211 specifications.
97  */
98 #define ACK_SIZE                14
99 #define IEEE80211_HEADER        24
100 #define PLCP                    48
101 #define BEACON                  100
102 #define PREAMBLE                144
103 #define SHORT_PREAMBLE          72
104 #define SLOT_TIME               20
105 #define SHORT_SLOT_TIME         9
106 #define SIFS                    10
107 #define PIFS                    ( SIFS + SLOT_TIME )
108 #define SHORT_PIFS              ( SIFS + SHORT_SLOT_TIME )
109 #define DIFS                    ( PIFS + SLOT_TIME )
110 #define SHORT_DIFS              ( SHORT_PIFS + SHORT_SLOT_TIME )
111 #define EIFS                    ( SIFS + (8 * (IEEE80211_HEADER + ACK_SIZE)) )
112
113 /*
114  * Chipset identification
115  * The chipset on the device is composed of a RT and RF chip.
116  * The chipset combination is important for determining device capabilities.
117  */
118 struct rt2x00_chip {
119         u16 rt;
120 #define RT2460          0x0101
121 #define RT2560          0x0201
122 #define RT2570          0x1201
123 #define RT2561s         0x0301  /* Turbo */
124 #define RT2561          0x0302
125 #define RT2661          0x0401
126 #define RT2571          0x1300
127
128         u16 rf;
129         u32 rev;
130 };
131
132 /*
133  * RF register values that belong to a particular channel.
134  */
135 struct rf_channel {
136         int channel;
137         u32 rf1;
138         u32 rf2;
139         u32 rf3;
140         u32 rf4;
141 };
142
143 /*
144  * Antenna setup values.
145  */
146 struct antenna_setup {
147         enum antenna rx;
148         enum antenna tx;
149 };
150
151 /*
152  * Quality statistics about the currently active link.
153  */
154 struct link_qual {
155         /*
156          * Statistics required for Link tuning.
157          * For the average RSSI value we use the "Walking average" approach.
158          * When adding RSSI to the average value the following calculation
159          * is needed:
160          *
161          *        avg_rssi = ((avg_rssi * 7) + rssi) / 8;
162          *
163          * The advantage of this approach is that we only need 1 variable
164          * to store the average in (No need for a count and a total).
165          * But more importantly, normal average values will over time
166          * move less and less towards newly added values this results
167          * that with link tuning, the device can have a very good RSSI
168          * for a few minutes but when the device is moved away from the AP
169          * the average will not decrease fast enough to compensate.
170          * The walking average compensates this and will move towards
171          * the new values correctly allowing a effective link tuning.
172          */
173         int avg_rssi;
174         int false_cca;
175
176         /*
177          * Statistics required for Signal quality calculation.
178          * For calculating the Signal quality we have to determine
179          * the total number of success and failed RX and TX frames.
180          * After that we also use the average RSSI value to help
181          * determining the signal quality.
182          * For the calculation we will use the following algorithm:
183          *
184          *         rssi_percentage = (avg_rssi * 100) / rssi_offset
185          *         rx_percentage = (rx_success * 100) / rx_total
186          *         tx_percentage = (tx_success * 100) / tx_total
187          *         avg_signal = ((WEIGHT_RSSI * avg_rssi) +
188          *                       (WEIGHT_TX * tx_percentage) +
189          *                       (WEIGHT_RX * rx_percentage)) / 100
190          *
191          * This value should then be checked to not be greated then 100.
192          */
193         int rx_percentage;
194         int rx_success;
195         int rx_failed;
196         int tx_percentage;
197         int tx_success;
198         int tx_failed;
199 #define WEIGHT_RSSI     20
200 #define WEIGHT_RX       40
201 #define WEIGHT_TX       40
202 };
203
204 /*
205  * Antenna settings about the currently active link.
206  */
207 struct link_ant {
208         /*
209          * Antenna flags
210          */
211         unsigned int flags;
212 #define ANTENNA_RX_DIVERSITY    0x00000001
213 #define ANTENNA_TX_DIVERSITY    0x00000002
214 #define ANTENNA_MODE_SAMPLE     0x00000004
215
216         /*
217          * Currently active TX/RX antenna setup.
218          * When software diversity is used, this will indicate
219          * which antenna is actually used at this time.
220          */
221         struct antenna_setup active;
222
223         /*
224          * RSSI information for the different antenna's.
225          * These statistics are used to determine when
226          * to switch antenna when using software diversity.
227          *
228          *        rssi[0] -> Antenna A RSSI
229          *        rssi[1] -> Antenna B RSSI
230          */
231         int rssi_history[2];
232
233         /*
234          * Current RSSI average of the currently active antenna.
235          * Similar to the avg_rssi in the link_qual structure
236          * this value is updated by using the walking average.
237          */
238         int rssi_ant;
239 };
240
241 /*
242  * To optimize the quality of the link we need to store
243  * the quality of received frames and periodically
244  * optimize the link.
245  */
246 struct link {
247         /*
248          * Link tuner counter
249          * The number of times the link has been tuned
250          * since the radio has been switched on.
251          */
252         u32 count;
253
254         /*
255          * Quality measurement values.
256          */
257         struct link_qual qual;
258
259         /*
260          * TX/RX antenna setup.
261          */
262         struct link_ant ant;
263
264         /*
265          * Active VGC level
266          */
267         int vgc_level;
268
269         /*
270          * Work structure for scheduling periodic link tuning.
271          */
272         struct delayed_work work;
273 };
274
275 /*
276  * Small helper macro to work with moving/walking averages.
277  */
278 #define MOVING_AVERAGE(__avg, __val, __samples) \
279         ( (((__avg) * ((__samples) - 1)) + (__val)) / (__samples) )
280
281 /*
282  * When we lack RSSI information return something less then -80 to
283  * tell the driver to tune the device to maximum sensitivity.
284  */
285 #define DEFAULT_RSSI    ( -128 )
286
287 /*
288  * Link quality access functions.
289  */
290 static inline int rt2x00_get_link_rssi(struct link *link)
291 {
292         if (link->qual.avg_rssi && link->qual.rx_success)
293                 return link->qual.avg_rssi;
294         return DEFAULT_RSSI;
295 }
296
297 static inline int rt2x00_get_link_ant_rssi(struct link *link)
298 {
299         if (link->ant.rssi_ant && link->qual.rx_success)
300                 return link->ant.rssi_ant;
301         return DEFAULT_RSSI;
302 }
303
304 static inline void rt2x00_reset_link_ant_rssi(struct link *link)
305 {
306         link->ant.rssi_ant = 0;
307 }
308
309 static inline int rt2x00_get_link_ant_rssi_history(struct link *link,
310                                                    enum antenna ant)
311 {
312         if (link->ant.rssi_history[ant - ANTENNA_A])
313                 return link->ant.rssi_history[ant - ANTENNA_A];
314         return DEFAULT_RSSI;
315 }
316
317 static inline int rt2x00_update_ant_rssi(struct link *link, int rssi)
318 {
319         int old_rssi = link->ant.rssi_history[link->ant.active.rx - ANTENNA_A];
320         link->ant.rssi_history[link->ant.active.rx - ANTENNA_A] = rssi;
321         return old_rssi;
322 }
323
324 /*
325  * Interface structure
326  * Per interface configuration details, this structure
327  * is allocated as the private data for ieee80211_vif.
328  */
329 struct rt2x00_intf {
330         /*
331          * All fields within the rt2x00_intf structure
332          * must be protected with a spinlock.
333          */
334         spinlock_t lock;
335
336         /*
337          * BSS configuration. Copied from the structure
338          * passed to us through the bss_info_changed()
339          * callback funtion.
340          */
341         struct ieee80211_bss_conf conf;
342
343         /*
344          * MAC of the device.
345          */
346         u8 mac[ETH_ALEN];
347
348         /*
349          * BBSID of the AP to associate with.
350          */
351         u8 bssid[ETH_ALEN];
352
353         /*
354          * Entry in the beacon queue which belongs to
355          * this interface. Each interface has its own
356          * dedicated beacon entry.
357          */
358         struct queue_entry *beacon;
359
360         /*
361          * Actions that needed rescheduling.
362          */
363         unsigned int delayed_flags;
364 #define DELAYED_UPDATE_BEACON           0x00000001
365 #define DELAYED_CONFIG_ERP              0x00000002
366 #define DELAYED_LED_ASSOC               0x00000004
367 };
368
369 static inline struct rt2x00_intf* vif_to_intf(struct ieee80211_vif *vif)
370 {
371         return (struct rt2x00_intf *)vif->drv_priv;
372 }
373
374 /**
375  * struct hw_mode_spec: Hardware specifications structure
376  *
377  * Details about the supported modes, rates and channels
378  * of a particular chipset. This is used by rt2x00lib
379  * to build the ieee80211_hw_mode array for mac80211.
380  *
381  * @supported_bands: Bitmask contained the supported bands (2.4GHz, 5.2GHz).
382  * @supported_rates: Rate types which are supported (CCK, OFDM).
383  * @num_channels: Number of supported channels. This is used as array size
384  *      for @tx_power_a, @tx_power_bg and @channels.
385  * @channels: Device/chipset specific channel values (See &struct rf_channel).
386  * @tx_power_a: TX power values for all 5.2GHz channels (may be NULL).
387  * @tx_power_bg: TX power values for all 2.4GHz channels (may be NULL).
388  * @tx_power_default: Default TX power value to use when either
389  *      @tx_power_a or @tx_power_bg is missing.
390  */
391 struct hw_mode_spec {
392         unsigned int supported_bands;
393 #define SUPPORT_BAND_2GHZ       0x00000001
394 #define SUPPORT_BAND_5GHZ       0x00000002
395
396         unsigned int supported_rates;
397 #define SUPPORT_RATE_CCK        0x00000001
398 #define SUPPORT_RATE_OFDM       0x00000002
399
400         unsigned int num_channels;
401         const struct rf_channel *channels;
402
403         const u8 *tx_power_a;
404         const u8 *tx_power_bg;
405         u8 tx_power_default;
406 };
407
408 /*
409  * Configuration structure wrapper around the
410  * mac80211 configuration structure.
411  * When mac80211 configures the driver, rt2x00lib
412  * can precalculate values which are equal for all
413  * rt2x00 drivers. Those values can be stored in here.
414  */
415 struct rt2x00lib_conf {
416         struct ieee80211_conf *conf;
417         struct rf_channel rf;
418
419         struct antenna_setup ant;
420
421         enum ieee80211_band band;
422
423         u32 basic_rates;
424         u32 slot_time;
425
426         short sifs;
427         short pifs;
428         short difs;
429         short eifs;
430 };
431
432 /*
433  * Configuration structure for erp settings.
434  */
435 struct rt2x00lib_erp {
436         int short_preamble;
437         int cts_protection;
438
439         int ack_timeout;
440         int ack_consume_time;
441 };
442
443 /*
444  * Configuration structure wrapper around the
445  * rt2x00 interface configuration handler.
446  */
447 struct rt2x00intf_conf {
448         /*
449          * Interface type
450          */
451         enum ieee80211_if_types type;
452
453         /*
454          * TSF sync value, this is dependant on the operation type.
455          */
456         enum tsf_sync sync;
457
458         /*
459          * The MAC and BSSID addressess are simple array of bytes,
460          * these arrays are little endian, so when sending the addressess
461          * to the drivers, copy the it into a endian-signed variable.
462          *
463          * Note that all devices (except rt2500usb) have 32 bits
464          * register word sizes. This means that whatever variable we
465          * pass _must_ be a multiple of 32 bits. Otherwise the device
466          * might not accept what we are sending to it.
467          * This will also make it easier for the driver to write
468          * the data to the device.
469          */
470         __le32 mac[2];
471         __le32 bssid[2];
472 };
473
474 /*
475  * rt2x00lib callback functions.
476  */
477 struct rt2x00lib_ops {
478         /*
479          * Interrupt handlers.
480          */
481         irq_handler_t irq_handler;
482
483         /*
484          * Device init handlers.
485          */
486         int (*probe_hw) (struct rt2x00_dev *rt2x00dev);
487         char *(*get_firmware_name) (struct rt2x00_dev *rt2x00dev);
488         u16 (*get_firmware_crc) (void *data, const size_t len);
489         int (*load_firmware) (struct rt2x00_dev *rt2x00dev, void *data,
490                               const size_t len);
491
492         /*
493          * Device initialization/deinitialization handlers.
494          */
495         int (*initialize) (struct rt2x00_dev *rt2x00dev);
496         void (*uninitialize) (struct rt2x00_dev *rt2x00dev);
497
498         /*
499          * queue initialization handlers
500          */
501         void (*init_rxentry) (struct rt2x00_dev *rt2x00dev,
502                               struct queue_entry *entry);
503         void (*init_txentry) (struct rt2x00_dev *rt2x00dev,
504                               struct queue_entry *entry);
505
506         /*
507          * Radio control handlers.
508          */
509         int (*set_device_state) (struct rt2x00_dev *rt2x00dev,
510                                  enum dev_state state);
511         int (*rfkill_poll) (struct rt2x00_dev *rt2x00dev);
512         void (*link_stats) (struct rt2x00_dev *rt2x00dev,
513                             struct link_qual *qual);
514         void (*reset_tuner) (struct rt2x00_dev *rt2x00dev);
515         void (*link_tuner) (struct rt2x00_dev *rt2x00dev);
516
517         /*
518          * TX control handlers
519          */
520         void (*write_tx_desc) (struct rt2x00_dev *rt2x00dev,
521                                struct sk_buff *skb,
522                                struct txentry_desc *txdesc);
523         int (*write_tx_data) (struct queue_entry *entry);
524         int (*get_tx_data_len) (struct rt2x00_dev *rt2x00dev,
525                                 struct sk_buff *skb);
526         void (*kick_tx_queue) (struct rt2x00_dev *rt2x00dev,
527                                const enum data_queue_qid queue);
528
529         /*
530          * RX control handlers
531          */
532         void (*fill_rxdone) (struct queue_entry *entry,
533                              struct rxdone_entry_desc *rxdesc);
534
535         /*
536          * Configuration handlers.
537          */
538         int (*beacon_update) (struct ieee80211_hw *hw, struct sk_buff *bcn);
539
540         void (*config_filter) (struct rt2x00_dev *rt2x00dev,
541                                const unsigned int filter_flags);
542         void (*config_intf) (struct rt2x00_dev *rt2x00dev,
543                              struct rt2x00_intf *intf,
544                              struct rt2x00intf_conf *conf,
545                              const unsigned int flags);
546 #define CONFIG_UPDATE_TYPE              ( 1 << 1 )
547 #define CONFIG_UPDATE_MAC               ( 1 << 2 )
548 #define CONFIG_UPDATE_BSSID             ( 1 << 3 )
549
550         void (*config_erp) (struct rt2x00_dev *rt2x00dev,
551                             struct rt2x00lib_erp *erp);
552         void (*config) (struct rt2x00_dev *rt2x00dev,
553                         struct rt2x00lib_conf *libconf,
554                         const unsigned int flags);
555 #define CONFIG_UPDATE_PHYMODE           ( 1 << 1 )
556 #define CONFIG_UPDATE_CHANNEL           ( 1 << 2 )
557 #define CONFIG_UPDATE_TXPOWER           ( 1 << 3 )
558 #define CONFIG_UPDATE_ANTENNA           ( 1 << 4 )
559 #define CONFIG_UPDATE_SLOT_TIME         ( 1 << 5 )
560 #define CONFIG_UPDATE_BEACON_INT        ( 1 << 6 )
561 #define CONFIG_UPDATE_ALL               0xffff
562 };
563
564 /*
565  * rt2x00 driver callback operation structure.
566  */
567 struct rt2x00_ops {
568         const char *name;
569         const unsigned int max_sta_intf;
570         const unsigned int max_ap_intf;
571         const unsigned int eeprom_size;
572         const unsigned int rf_size;
573         const unsigned int tx_queues;
574         const struct data_queue_desc *rx;
575         const struct data_queue_desc *tx;
576         const struct data_queue_desc *bcn;
577         const struct data_queue_desc *atim;
578         const struct rt2x00lib_ops *lib;
579         const struct ieee80211_ops *hw;
580 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
581         const struct rt2x00debug *debugfs;
582 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
583 };
584
585 /*
586  * rt2x00 device flags
587  */
588 enum rt2x00_flags {
589         /*
590          * Device state flags
591          */
592         DEVICE_PRESENT,
593         DEVICE_REGISTERED_HW,
594         DEVICE_INITIALIZED,
595         DEVICE_STARTED,
596         DEVICE_STARTED_SUSPEND,
597         DEVICE_ENABLED_RADIO,
598         DEVICE_DISABLED_RADIO_HW,
599
600         /*
601          * Driver features
602          */
603         DRIVER_REQUIRE_FIRMWARE,
604         DRIVER_REQUIRE_BEACON_GUARD,
605         DRIVER_REQUIRE_ATIM_QUEUE,
606         DRIVER_REQUIRE_SCHEDULED,
607         DRIVER_REQUIRE_DMA,
608
609         /*
610          * Driver configuration
611          */
612         CONFIG_SUPPORT_HW_BUTTON,
613         CONFIG_FRAME_TYPE,
614         CONFIG_RF_SEQUENCE,
615         CONFIG_EXTERNAL_LNA_A,
616         CONFIG_EXTERNAL_LNA_BG,
617         CONFIG_DOUBLE_ANTENNA,
618         CONFIG_DISABLE_LINK_TUNING,
619 };
620
621 /*
622  * rt2x00 device structure.
623  */
624 struct rt2x00_dev {
625         /*
626          * Device structure.
627          * The structure stored in here depends on the
628          * system bus (PCI or USB).
629          * When accessing this variable, the rt2x00dev_{pci,usb}
630          * macro's should be used for correct typecasting.
631          */
632         struct device *dev;
633
634         /*
635          * Callback functions.
636          */
637         const struct rt2x00_ops *ops;
638
639         /*
640          * IEEE80211 control structure.
641          */
642         struct ieee80211_hw *hw;
643         struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
644         enum ieee80211_band curr_band;
645
646         /*
647          * rfkill structure for RF state switching support.
648          * This will only be compiled in when required.
649          */
650 #ifdef CONFIG_RT2X00_LIB_RFKILL
651         unsigned long rfkill_state;
652 #define RFKILL_STATE_ALLOCATED          1
653 #define RFKILL_STATE_REGISTERED         2
654         struct rfkill *rfkill;
655         struct delayed_work rfkill_work;
656 #endif /* CONFIG_RT2X00_LIB_RFKILL */
657
658         /*
659          * If enabled, the debugfs interface structures
660          * required for deregistration of debugfs.
661          */
662 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
663         struct rt2x00debug_intf *debugfs_intf;
664 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
665
666         /*
667          * LED structure for changing the LED status
668          * by mac8011 or the kernel.
669          */
670 #ifdef CONFIG_RT2X00_LIB_LEDS
671         struct rt2x00_led led_radio;
672         struct rt2x00_led led_assoc;
673         struct rt2x00_led led_qual;
674         u16 led_mcu_reg;
675 #endif /* CONFIG_RT2X00_LIB_LEDS */
676
677         /*
678          * Device flags.
679          * In these flags the current status and some
680          * of the device capabilities are stored.
681          */
682         unsigned long flags;
683
684         /*
685          * Chipset identification.
686          */
687         struct rt2x00_chip chip;
688
689         /*
690          * hw capability specifications.
691          */
692         struct hw_mode_spec spec;
693
694         /*
695          * This is the default TX/RX antenna setup as indicated
696          * by the device's EEPROM. When mac80211 sets its
697          * antenna value to 0 we should be using these values.
698          */
699         struct antenna_setup default_ant;
700
701         /*
702          * Register pointers
703          * csr.base: CSR base register address. (PCI)
704          * csr.cache: CSR cache for usb_control_msg. (USB)
705          */
706         union csr {
707                 void __iomem *base;
708                 void *cache;
709         } csr;
710
711         /*
712          * Mutex to protect register accesses on USB devices.
713          * There are 2 reasons this is needed, one is to ensure
714          * use of the csr_cache (for USB devices) by one thread
715          * isn't corrupted by another thread trying to access it.
716          * The other is that access to BBP and RF registers
717          * require multiple BUS transactions and if another thread
718          * attempted to access one of those registers at the same
719          * time one of the writes could silently fail.
720          */
721         struct mutex usb_cache_mutex;
722
723         /*
724          * Current packet filter configuration for the device.
725          * This contains all currently active FIF_* flags send
726          * to us by mac80211 during configure_filter().
727          */
728         unsigned int packet_filter;
729
730         /*
731          * Interface details:
732          *  - Open ap interface count.
733          *  - Open sta interface count.
734          *  - Association count.
735          */
736         unsigned int intf_ap_count;
737         unsigned int intf_sta_count;
738         unsigned int intf_associated;
739
740         /*
741          * Link quality
742          */
743         struct link link;
744
745         /*
746          * EEPROM data.
747          */
748         __le16 *eeprom;
749
750         /*
751          * Active RF register values.
752          * These are stored here so we don't need
753          * to read the rf registers and can directly
754          * use this value instead.
755          * This field should be accessed by using
756          * rt2x00_rf_read() and rt2x00_rf_write().
757          */
758         u32 *rf;
759
760         /*
761          * USB Max frame size (for rt2500usb & rt73usb).
762          */
763         u16 usb_maxpacket;
764
765         /*
766          * Current TX power value.
767          */
768         u16 tx_power;
769
770         /*
771          * Rssi <-> Dbm offset
772          */
773         u8 rssi_offset;
774
775         /*
776          * Frequency offset (for rt61pci & rt73usb).
777          */
778         u8 freq_offset;
779
780         /*
781          * Low level statistics which will have
782          * to be kept up to date while device is running.
783          */
784         struct ieee80211_low_level_stats low_level_stats;
785
786         /*
787          * RX configuration information.
788          */
789         struct ieee80211_rx_status rx_status;
790
791         /*
792          * Scheduled work.
793          * NOTE: intf_work will use ieee80211_iterate_active_interfaces()
794          * which means it cannot be placed on the hw->workqueue
795          * due to RTNL locking requirements.
796          */
797         struct work_struct intf_work;
798         struct work_struct filter_work;
799
800         /*
801          * Data queue arrays for RX, TX and Beacon.
802          * The Beacon array also contains the Atim queue
803          * if that is supported by the device.
804          */
805         unsigned int data_queues;
806         struct data_queue *rx;
807         struct data_queue *tx;
808         struct data_queue *bcn;
809
810         /*
811          * Firmware image.
812          */
813         const struct firmware *fw;
814 };
815
816 /*
817  * Generic RF access.
818  * The RF is being accessed by word index.
819  */
820 static inline void rt2x00_rf_read(struct rt2x00_dev *rt2x00dev,
821                                   const unsigned int word, u32 *data)
822 {
823         *data = rt2x00dev->rf[word];
824 }
825
826 static inline void rt2x00_rf_write(struct rt2x00_dev *rt2x00dev,
827                                    const unsigned int word, u32 data)
828 {
829         rt2x00dev->rf[word] = data;
830 }
831
832 /*
833  *  Generic EEPROM access.
834  * The EEPROM is being accessed by word index.
835  */
836 static inline void *rt2x00_eeprom_addr(struct rt2x00_dev *rt2x00dev,
837                                        const unsigned int word)
838 {
839         return (void *)&rt2x00dev->eeprom[word];
840 }
841
842 static inline void rt2x00_eeprom_read(struct rt2x00_dev *rt2x00dev,
843                                       const unsigned int word, u16 *data)
844 {
845         *data = le16_to_cpu(rt2x00dev->eeprom[word]);
846 }
847
848 static inline void rt2x00_eeprom_write(struct rt2x00_dev *rt2x00dev,
849                                        const unsigned int word, u16 data)
850 {
851         rt2x00dev->eeprom[word] = cpu_to_le16(data);
852 }
853
854 /*
855  * Chipset handlers
856  */
857 static inline void rt2x00_set_chip(struct rt2x00_dev *rt2x00dev,
858                                    const u16 rt, const u16 rf, const u32 rev)
859 {
860         INFO(rt2x00dev,
861              "Chipset detected - rt: %04x, rf: %04x, rev: %08x.\n",
862              rt, rf, rev);
863
864         rt2x00dev->chip.rt = rt;
865         rt2x00dev->chip.rf = rf;
866         rt2x00dev->chip.rev = rev;
867 }
868
869 static inline char rt2x00_rt(const struct rt2x00_chip *chipset, const u16 chip)
870 {
871         return (chipset->rt == chip);
872 }
873
874 static inline char rt2x00_rf(const struct rt2x00_chip *chipset, const u16 chip)
875 {
876         return (chipset->rf == chip);
877 }
878
879 static inline u16 rt2x00_rev(const struct rt2x00_chip *chipset)
880 {
881         return chipset->rev;
882 }
883
884 static inline u16 rt2x00_check_rev(const struct rt2x00_chip *chipset,
885                                    const u32 rev)
886 {
887         return (((chipset->rev & 0xffff0) == rev) &&
888                 !!(chipset->rev & 0x0000f));
889 }
890
891 /*
892  * Duration calculations
893  * The rate variable passed is: 100kbs.
894  * To convert from bytes to bits we multiply size with 8,
895  * then the size is multiplied with 10 to make the
896  * real rate -> rate argument correction.
897  */
898 static inline u16 get_duration(const unsigned int size, const u8 rate)
899 {
900         return ((size * 8 * 10) / rate);
901 }
902
903 static inline u16 get_duration_res(const unsigned int size, const u8 rate)
904 {
905         return ((size * 8 * 10) % rate);
906 }
907
908 /**
909  * rt2x00queue_map_txskb - Map a skb into DMA for TX purposes.
910  * @rt2x00dev: Pointer to &struct rt2x00_dev.
911  * @skb: The skb to map.
912  */
913 void rt2x00queue_map_txskb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb);
914
915 /**
916  * rt2x00queue_create_tx_descriptor - Create TX descriptor from mac80211 input
917  * @entry: The entry which will be used to transfer the TX frame.
918  * @txdesc: rt2x00 TX descriptor which will be initialized by this function.
919  *
920  * This function will initialize the &struct txentry_desc based on information
921  * from mac80211. This descriptor can then be used by rt2x00lib and the drivers
922  * to correctly initialize the hardware descriptor.
923  * Note that before calling this function the skb->cb array must be untouched
924  * by rt2x00lib. Only after this function completes will it be save to
925  * overwrite the skb->cb information.
926  * The reason for this is that mac80211 writes its own tx information into
927  * the skb->cb array, and this function will use that information to initialize
928  * the &struct txentry_desc structure.
929  */
930 void rt2x00queue_create_tx_descriptor(struct queue_entry *entry,
931                                       struct txentry_desc *txdesc);
932
933 /**
934  * rt2x00queue_write_tx_descriptor - Write TX descriptor to hardware
935  * @entry: The entry which will be used to transfer the TX frame.
936  * @txdesc: TX descriptor which will be used to write hardware descriptor
937  *
938  * This function will write a TX descriptor initialized by
939  * &rt2x00queue_create_tx_descriptor to the hardware. After this call
940  * has completed the frame is now owned by the hardware, the hardware
941  * queue will have automatically be kicked unless this frame was generated
942  * by rt2x00lib, in which case the frame is "special" and must be kicked
943  * by the caller.
944  */
945 void rt2x00queue_write_tx_descriptor(struct queue_entry *entry,
946                                      struct txentry_desc *txdesc);
947
948 /**
949  * rt2x00queue_get_queue - Convert queue index to queue pointer
950  * @rt2x00dev: Pointer to &struct rt2x00_dev.
951  * @queue: rt2x00 queue index (see &enum data_queue_qid).
952  */
953 struct data_queue *rt2x00queue_get_queue(struct rt2x00_dev *rt2x00dev,
954                                          const enum data_queue_qid queue);
955
956 /**
957  * rt2x00queue_get_entry - Get queue entry where the given index points to.
958  * @queue: Pointer to &struct data_queue from where we obtain the entry.
959  * @index: Index identifier for obtaining the correct index.
960  */
961 struct queue_entry *rt2x00queue_get_entry(struct data_queue *queue,
962                                           enum queue_index index);
963
964 /*
965  * Interrupt context handlers.
966  */
967 void rt2x00lib_beacondone(struct rt2x00_dev *rt2x00dev);
968 void rt2x00lib_txdone(struct queue_entry *entry,
969                       struct txdone_entry_desc *txdesc);
970 void rt2x00lib_rxdone(struct rt2x00_dev *rt2x00dev,
971                       struct queue_entry *entry);
972
973 /*
974  * mac80211 handlers.
975  */
976 int rt2x00mac_tx(struct ieee80211_hw *hw, struct sk_buff *skb);
977 int rt2x00mac_start(struct ieee80211_hw *hw);
978 void rt2x00mac_stop(struct ieee80211_hw *hw);
979 int rt2x00mac_add_interface(struct ieee80211_hw *hw,
980                             struct ieee80211_if_init_conf *conf);
981 void rt2x00mac_remove_interface(struct ieee80211_hw *hw,
982                                 struct ieee80211_if_init_conf *conf);
983 int rt2x00mac_config(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
984 int rt2x00mac_config_interface(struct ieee80211_hw *hw,
985                                struct ieee80211_vif *vif,
986                                struct ieee80211_if_conf *conf);
987 void rt2x00mac_configure_filter(struct ieee80211_hw *hw,
988                                 unsigned int changed_flags,
989                                 unsigned int *total_flags,
990                                 int mc_count, struct dev_addr_list *mc_list);
991 int rt2x00mac_get_stats(struct ieee80211_hw *hw,
992                         struct ieee80211_low_level_stats *stats);
993 int rt2x00mac_get_tx_stats(struct ieee80211_hw *hw,
994                            struct ieee80211_tx_queue_stats *stats);
995 void rt2x00mac_bss_info_changed(struct ieee80211_hw *hw,
996                                 struct ieee80211_vif *vif,
997                                 struct ieee80211_bss_conf *bss_conf,
998                                 u32 changes);
999 int rt2x00mac_conf_tx(struct ieee80211_hw *hw, u16 queue,
1000                       const struct ieee80211_tx_queue_params *params);
1001
1002 /*
1003  * Driver allocation handlers.
1004  */
1005 int rt2x00lib_probe_dev(struct rt2x00_dev *rt2x00dev);
1006 void rt2x00lib_remove_dev(struct rt2x00_dev *rt2x00dev);
1007 #ifdef CONFIG_PM
1008 int rt2x00lib_suspend(struct rt2x00_dev *rt2x00dev, pm_message_t state);
1009 int rt2x00lib_resume(struct rt2x00_dev *rt2x00dev);
1010 #endif /* CONFIG_PM */
1011
1012 #endif /* RT2X00_H */