rt2x00: Fix quality houskeeping for software diversity
[pandora-kernel.git] / drivers / net / wireless / rt2x00 / rt2x00.h
1 /*
2         Copyright (C) 2004 - 2009 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 #include <linux/input-polldev.h>
37
38 #include <net/mac80211.h>
39
40 #include "rt2x00debug.h"
41 #include "rt2x00leds.h"
42 #include "rt2x00reg.h"
43 #include "rt2x00queue.h"
44
45 /*
46  * Module information.
47  */
48 #define DRV_VERSION     "2.3.0"
49 #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,                       \
57                wiphy_name((__dev)->hw->wiphy), __func__, __lvl, ##__args)
58
59 #define DEBUG_PRINTK_PROBE(__kernlvl, __lvl, __msg, __args...)  \
60         printk(__kernlvl "%s -> %s: %s - " __msg,               \
61                KBUILD_MODNAME, __func__, __lvl, ##__args)
62
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 /*
96  * 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 /*
106  * Determine the alignment requirement,
107  * to make sure the 802.11 payload is padded to a 4-byte boundrary
108  * we must determine the address of the payload and calculate the
109  * amount of bytes needed to move the data.
110  */
111 #define ALIGN_SIZE(__skb, __header) \
112         (  ((unsigned long)((__skb)->data + (__header))) & 3 )
113
114 /*
115  * Standard timing and size defines.
116  * These values should follow the ieee80211 specifications.
117  */
118 #define ACK_SIZE                14
119 #define IEEE80211_HEADER        24
120 #define PLCP                    48
121 #define BEACON                  100
122 #define PREAMBLE                144
123 #define SHORT_PREAMBLE          72
124 #define SLOT_TIME               20
125 #define SHORT_SLOT_TIME         9
126 #define SIFS                    10
127 #define PIFS                    ( SIFS + SLOT_TIME )
128 #define SHORT_PIFS              ( SIFS + SHORT_SLOT_TIME )
129 #define DIFS                    ( PIFS + SLOT_TIME )
130 #define SHORT_DIFS              ( SHORT_PIFS + SHORT_SLOT_TIME )
131 #define EIFS                    ( SIFS + DIFS + \
132                                   GET_DURATION(IEEE80211_HEADER + ACK_SIZE, 10) )
133 #define SHORT_EIFS              ( SIFS + SHORT_DIFS + \
134                                   GET_DURATION(IEEE80211_HEADER + ACK_SIZE, 10) )
135
136 /*
137  * Chipset identification
138  * The chipset on the device is composed of a RT and RF chip.
139  * The chipset combination is important for determining device capabilities.
140  */
141 struct rt2x00_chip {
142         u16 rt;
143 #define RT2460          0x0101
144 #define RT2560          0x0201
145 #define RT2570          0x1201
146 #define RT2561s         0x0301  /* Turbo */
147 #define RT2561          0x0302
148 #define RT2661          0x0401
149 #define RT2571          0x1300
150 #define RT2870          0x1600
151
152         u16 rf;
153         u32 rev;
154 };
155
156 /*
157  * RF register values that belong to a particular channel.
158  */
159 struct rf_channel {
160         int channel;
161         u32 rf1;
162         u32 rf2;
163         u32 rf3;
164         u32 rf4;
165 };
166
167 /*
168  * Channel information structure
169  */
170 struct channel_info {
171         unsigned int flags;
172 #define GEOGRAPHY_ALLOWED       0x00000001
173
174         short tx_power1;
175         short tx_power2;
176 };
177
178 /*
179  * Antenna setup values.
180  */
181 struct antenna_setup {
182         enum antenna rx;
183         enum antenna tx;
184 };
185
186 /*
187  * Quality statistics about the currently active link.
188  */
189 struct link_qual {
190         /*
191          * Statistics required for Link tuning by driver
192          * The rssi value is provided by rt2x00lib during the
193          * link_tuner() callback function.
194          * The false_cca field is filled during the link_stats()
195          * callback function and could be used during the
196          * link_tuner() callback function.
197          */
198         int rssi;
199         int false_cca;
200
201         /*
202          * VGC levels
203          * Hardware driver will tune the VGC level during each call
204          * to the link_tuner() callback function. This vgc_level is
205          * is determined based on the link quality statistics like
206          * average RSSI and the false CCA count.
207          *
208          * In some cases the drivers need to differentiate between
209          * the currently "desired" VGC level and the level configured
210          * in the hardware. The latter is important to reduce the
211          * number of BBP register reads to reduce register access
212          * overhead. For this reason we store both values here.
213          */
214         u8 vgc_level;
215         u8 vgc_level_reg;
216
217         /*
218          * Statistics required for Signal quality calculation.
219          * These fields might be changed during the link_stats()
220          * callback function.
221          */
222         int rx_success;
223         int rx_failed;
224         int tx_success;
225         int tx_failed;
226 };
227
228 /*
229  * Antenna settings about the currently active link.
230  */
231 struct link_ant {
232         /*
233          * Antenna flags
234          */
235         unsigned int flags;
236 #define ANTENNA_RX_DIVERSITY    0x00000001
237 #define ANTENNA_TX_DIVERSITY    0x00000002
238 #define ANTENNA_MODE_SAMPLE     0x00000004
239
240         /*
241          * Currently active TX/RX antenna setup.
242          * When software diversity is used, this will indicate
243          * which antenna is actually used at this time.
244          */
245         struct antenna_setup active;
246
247         /*
248          * RSSI history information for the antenna.
249          * Used to determine when to switch antenna
250          * when using software diversity.
251          */
252         int rssi_history;
253
254         /*
255          * Current RSSI average of the currently active antenna.
256          * Similar to the avg_rssi in the link_qual structure
257          * this value is updated by using the walking average.
258          */
259         int rssi_ant;
260 };
261
262 /*
263  * To optimize the quality of the link we need to store
264  * the quality of received frames and periodically
265  * optimize the link.
266  */
267 struct link {
268         /*
269          * Link tuner counter
270          * The number of times the link has been tuned
271          * since the radio has been switched on.
272          */
273         u32 count;
274
275         /*
276          * Quality measurement values.
277          */
278         struct link_qual qual;
279
280         /*
281          * TX/RX antenna setup.
282          */
283         struct link_ant ant;
284
285         /*
286          * Currently active average RSSI value
287          */
288         int avg_rssi;
289
290         /*
291          * Currently precalculated percentages of successful
292          * TX and RX frames.
293          */
294         int rx_percentage;
295         int tx_percentage;
296
297         /*
298          * Work structure for scheduling periodic link tuning.
299          */
300         struct delayed_work work;
301 };
302
303 /*
304  * Interface structure
305  * Per interface configuration details, this structure
306  * is allocated as the private data for ieee80211_vif.
307  */
308 struct rt2x00_intf {
309         /*
310          * All fields within the rt2x00_intf structure
311          * must be protected with a spinlock.
312          */
313         spinlock_t lock;
314
315         /*
316          * MAC of the device.
317          */
318         u8 mac[ETH_ALEN];
319
320         /*
321          * BBSID of the AP to associate with.
322          */
323         u8 bssid[ETH_ALEN];
324
325         /*
326          * Entry in the beacon queue which belongs to
327          * this interface. Each interface has its own
328          * dedicated beacon entry.
329          */
330         struct queue_entry *beacon;
331
332         /*
333          * Actions that needed rescheduling.
334          */
335         unsigned int delayed_flags;
336 #define DELAYED_UPDATE_BEACON           0x00000001
337 #define DELAYED_CONFIG_ERP              0x00000002
338 #define DELAYED_LED_ASSOC               0x00000004
339
340         /*
341          * Software sequence counter, this is only required
342          * for hardware which doesn't support hardware
343          * sequence counting.
344          */
345         spinlock_t seqlock;
346         u16 seqno;
347 };
348
349 static inline struct rt2x00_intf* vif_to_intf(struct ieee80211_vif *vif)
350 {
351         return (struct rt2x00_intf *)vif->drv_priv;
352 }
353
354 /**
355  * struct hw_mode_spec: Hardware specifications structure
356  *
357  * Details about the supported modes, rates and channels
358  * of a particular chipset. This is used by rt2x00lib
359  * to build the ieee80211_hw_mode array for mac80211.
360  *
361  * @supported_bands: Bitmask contained the supported bands (2.4GHz, 5.2GHz).
362  * @supported_rates: Rate types which are supported (CCK, OFDM).
363  * @num_channels: Number of supported channels. This is used as array size
364  *      for @tx_power_a, @tx_power_bg and @channels.
365  * @channels: Device/chipset specific channel values (See &struct rf_channel).
366  * @channels_info: Additional information for channels (See &struct channel_info).
367  * @ht: Driver HT Capabilities (See &ieee80211_sta_ht_cap).
368  */
369 struct hw_mode_spec {
370         unsigned int supported_bands;
371 #define SUPPORT_BAND_2GHZ       0x00000001
372 #define SUPPORT_BAND_5GHZ       0x00000002
373
374         unsigned int supported_rates;
375 #define SUPPORT_RATE_CCK        0x00000001
376 #define SUPPORT_RATE_OFDM       0x00000002
377
378         unsigned int num_channels;
379         const struct rf_channel *channels;
380         const struct channel_info *channels_info;
381
382         struct ieee80211_sta_ht_cap ht;
383 };
384
385 /*
386  * Configuration structure wrapper around the
387  * mac80211 configuration structure.
388  * When mac80211 configures the driver, rt2x00lib
389  * can precalculate values which are equal for all
390  * rt2x00 drivers. Those values can be stored in here.
391  */
392 struct rt2x00lib_conf {
393         struct ieee80211_conf *conf;
394
395         struct rf_channel rf;
396         struct channel_info channel;
397 };
398
399 /*
400  * Configuration structure for erp settings.
401  */
402 struct rt2x00lib_erp {
403         int short_preamble;
404         int cts_protection;
405
406         int ack_timeout;
407         int ack_consume_time;
408
409         u32 basic_rates;
410
411         int slot_time;
412
413         short sifs;
414         short pifs;
415         short difs;
416         short eifs;
417
418         u16 beacon_int;
419 };
420
421 /*
422  * Configuration structure for hardware encryption.
423  */
424 struct rt2x00lib_crypto {
425         enum cipher cipher;
426
427         enum set_key_cmd cmd;
428         const u8 *address;
429
430         u32 bssidx;
431         u32 aid;
432
433         u8 key[16];
434         u8 tx_mic[8];
435         u8 rx_mic[8];
436 };
437
438 /*
439  * Configuration structure wrapper around the
440  * rt2x00 interface configuration handler.
441  */
442 struct rt2x00intf_conf {
443         /*
444          * Interface type
445          */
446         enum nl80211_iftype type;
447
448         /*
449          * TSF sync value, this is dependant on the operation type.
450          */
451         enum tsf_sync sync;
452
453         /*
454          * The MAC and BSSID addressess are simple array of bytes,
455          * these arrays are little endian, so when sending the addressess
456          * to the drivers, copy the it into a endian-signed variable.
457          *
458          * Note that all devices (except rt2500usb) have 32 bits
459          * register word sizes. This means that whatever variable we
460          * pass _must_ be a multiple of 32 bits. Otherwise the device
461          * might not accept what we are sending to it.
462          * This will also make it easier for the driver to write
463          * the data to the device.
464          */
465         __le32 mac[2];
466         __le32 bssid[2];
467 };
468
469 /*
470  * rt2x00lib callback functions.
471  */
472 struct rt2x00lib_ops {
473         /*
474          * Interrupt handlers.
475          */
476         irq_handler_t irq_handler;
477
478         /*
479          * Device init handlers.
480          */
481         int (*probe_hw) (struct rt2x00_dev *rt2x00dev);
482         char *(*get_firmware_name) (struct rt2x00_dev *rt2x00dev);
483         int (*check_firmware) (struct rt2x00_dev *rt2x00dev,
484                                const u8 *data, const size_t len);
485         int (*load_firmware) (struct rt2x00_dev *rt2x00dev,
486                               const u8 *data, const size_t len);
487
488         /*
489          * Device initialization/deinitialization handlers.
490          */
491         int (*initialize) (struct rt2x00_dev *rt2x00dev);
492         void (*uninitialize) (struct rt2x00_dev *rt2x00dev);
493
494         /*
495          * queue initialization handlers
496          */
497         bool (*get_entry_state) (struct queue_entry *entry);
498         void (*clear_entry) (struct queue_entry *entry);
499
500         /*
501          * Radio control handlers.
502          */
503         int (*set_device_state) (struct rt2x00_dev *rt2x00dev,
504                                  enum dev_state state);
505         int (*rfkill_poll) (struct rt2x00_dev *rt2x00dev);
506         void (*link_stats) (struct rt2x00_dev *rt2x00dev,
507                             struct link_qual *qual);
508         void (*reset_tuner) (struct rt2x00_dev *rt2x00dev,
509                              struct link_qual *qual);
510         void (*link_tuner) (struct rt2x00_dev *rt2x00dev,
511                             struct link_qual *qual, const u32 count);
512
513         /*
514          * TX control handlers
515          */
516         void (*write_tx_desc) (struct rt2x00_dev *rt2x00dev,
517                                struct sk_buff *skb,
518                                struct txentry_desc *txdesc);
519         int (*write_tx_data) (struct queue_entry *entry);
520         void (*write_beacon) (struct queue_entry *entry);
521         int (*get_tx_data_len) (struct queue_entry *entry);
522         void (*kick_tx_queue) (struct rt2x00_dev *rt2x00dev,
523                                const enum data_queue_qid queue);
524         void (*kill_tx_queue) (struct rt2x00_dev *rt2x00dev,
525                                const enum data_queue_qid queue);
526
527         /*
528          * RX control handlers
529          */
530         void (*fill_rxdone) (struct queue_entry *entry,
531                              struct rxdone_entry_desc *rxdesc);
532
533         /*
534          * Configuration handlers.
535          */
536         int (*config_shared_key) (struct rt2x00_dev *rt2x00dev,
537                                   struct rt2x00lib_crypto *crypto,
538                                   struct ieee80211_key_conf *key);
539         int (*config_pairwise_key) (struct rt2x00_dev *rt2x00dev,
540                                     struct rt2x00lib_crypto *crypto,
541                                     struct ieee80211_key_conf *key);
542         void (*config_filter) (struct rt2x00_dev *rt2x00dev,
543                                const unsigned int filter_flags);
544         void (*config_intf) (struct rt2x00_dev *rt2x00dev,
545                              struct rt2x00_intf *intf,
546                              struct rt2x00intf_conf *conf,
547                              const unsigned int flags);
548 #define CONFIG_UPDATE_TYPE              ( 1 << 1 )
549 #define CONFIG_UPDATE_MAC               ( 1 << 2 )
550 #define CONFIG_UPDATE_BSSID             ( 1 << 3 )
551
552         void (*config_erp) (struct rt2x00_dev *rt2x00dev,
553                             struct rt2x00lib_erp *erp);
554         void (*config_ant) (struct rt2x00_dev *rt2x00dev,
555                             struct antenna_setup *ant);
556         void (*config) (struct rt2x00_dev *rt2x00dev,
557                         struct rt2x00lib_conf *libconf,
558                         const unsigned int changed_flags);
559 };
560
561 /*
562  * rt2x00 driver callback operation structure.
563  */
564 struct rt2x00_ops {
565         const char *name;
566         const unsigned int max_sta_intf;
567         const unsigned int max_ap_intf;
568         const unsigned int eeprom_size;
569         const unsigned int rf_size;
570         const unsigned int tx_queues;
571         const struct data_queue_desc *rx;
572         const struct data_queue_desc *tx;
573         const struct data_queue_desc *bcn;
574         const struct data_queue_desc *atim;
575         const struct rt2x00lib_ops *lib;
576         const struct ieee80211_ops *hw;
577 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
578         const struct rt2x00debug *debugfs;
579 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
580 };
581
582 /*
583  * rt2x00 device flags
584  */
585 enum rt2x00_flags {
586         /*
587          * Device state flags
588          */
589         DEVICE_STATE_PRESENT,
590         DEVICE_STATE_REGISTERED_HW,
591         DEVICE_STATE_INITIALIZED,
592         DEVICE_STATE_STARTED,
593         DEVICE_STATE_ENABLED_RADIO,
594
595         /*
596          * Driver requirements
597          */
598         DRIVER_REQUIRE_FIRMWARE,
599         DRIVER_REQUIRE_BEACON_GUARD,
600         DRIVER_REQUIRE_ATIM_QUEUE,
601         DRIVER_REQUIRE_SCHEDULED,
602         DRIVER_REQUIRE_DMA,
603         DRIVER_REQUIRE_COPY_IV,
604         DRIVER_REQUIRE_L2PAD,
605
606         /*
607          * Driver features
608          */
609         CONFIG_SUPPORT_HW_BUTTON,
610         CONFIG_SUPPORT_HW_CRYPTO,
611
612         /*
613          * Driver configuration
614          */
615         CONFIG_FRAME_TYPE,
616         CONFIG_RF_SEQUENCE,
617         CONFIG_EXTERNAL_LNA_A,
618         CONFIG_EXTERNAL_LNA_BG,
619         CONFIG_DOUBLE_ANTENNA,
620         CONFIG_DISABLE_LINK_TUNING,
621         CONFIG_CHANNEL_HT40,
622 };
623
624 /*
625  * rt2x00 device structure.
626  */
627 struct rt2x00_dev {
628         /*
629          * Device structure.
630          * The structure stored in here depends on the
631          * system bus (PCI or USB).
632          * When accessing this variable, the rt2x00dev_{pci,usb}
633          * macros should be used for correct typecasting.
634          */
635         struct device *dev;
636
637         /*
638          * Callback functions.
639          */
640         const struct rt2x00_ops *ops;
641
642         /*
643          * IEEE80211 control structure.
644          */
645         struct ieee80211_hw *hw;
646         struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
647         enum ieee80211_band curr_band;
648
649         /*
650          * If enabled, the debugfs interface structures
651          * required for deregistration of debugfs.
652          */
653 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
654         struct rt2x00debug_intf *debugfs_intf;
655 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
656
657         /*
658          * LED structure for changing the LED status
659          * by mac8011 or the kernel.
660          */
661 #ifdef CONFIG_RT2X00_LIB_LEDS
662         struct rt2x00_led led_radio;
663         struct rt2x00_led led_assoc;
664         struct rt2x00_led led_qual;
665         u16 led_mcu_reg;
666 #endif /* CONFIG_RT2X00_LIB_LEDS */
667
668         /*
669          * Device flags.
670          * In these flags the current status and some
671          * of the device capabilities are stored.
672          */
673         unsigned long flags;
674
675         /*
676          * Device information, Bus IRQ and name (PCI, SoC)
677          */
678         int irq;
679         const char *name;
680
681         /*
682          * Chipset identification.
683          */
684         struct rt2x00_chip chip;
685
686         /*
687          * hw capability specifications.
688          */
689         struct hw_mode_spec spec;
690
691         /*
692          * This is the default TX/RX antenna setup as indicated
693          * by the device's EEPROM.
694          */
695         struct antenna_setup default_ant;
696
697         /*
698          * Register pointers
699          * csr.base: CSR base register address. (PCI)
700          * csr.cache: CSR cache for usb_control_msg. (USB)
701          */
702         union csr {
703                 void __iomem *base;
704                 void *cache;
705         } csr;
706
707         /*
708          * Mutex to protect register accesses.
709          * For PCI and USB devices it protects against concurrent indirect
710          * register access (BBP, RF, MCU) since accessing those
711          * registers require multiple calls to the CSR registers.
712          * For USB devices it also protects the csr_cache since that
713          * field is used for normal CSR access and it cannot support
714          * multiple callers simultaneously.
715          */
716         struct mutex csr_mutex;
717
718         /*
719          * Current packet filter configuration for the device.
720          * This contains all currently active FIF_* flags send
721          * to us by mac80211 during configure_filter().
722          */
723         unsigned int packet_filter;
724
725         /*
726          * Interface details:
727          *  - Open ap interface count.
728          *  - Open sta interface count.
729          *  - Association count.
730          */
731         unsigned int intf_ap_count;
732         unsigned int intf_sta_count;
733         unsigned int intf_associated;
734
735         /*
736          * Link quality
737          */
738         struct link link;
739
740         /*
741          * EEPROM data.
742          */
743         __le16 *eeprom;
744
745         /*
746          * Active RF register values.
747          * These are stored here so we don't need
748          * to read the rf registers and can directly
749          * use this value instead.
750          * This field should be accessed by using
751          * rt2x00_rf_read() and rt2x00_rf_write().
752          */
753         u32 *rf;
754
755         /*
756          * LNA gain
757          */
758         short lna_gain;
759
760         /*
761          * Current TX power value.
762          */
763         u16 tx_power;
764
765         /*
766          * Current retry values.
767          */
768         u8 short_retry;
769         u8 long_retry;
770
771         /*
772          * Rssi <-> Dbm offset
773          */
774         u8 rssi_offset;
775
776         /*
777          * Frequency offset (for rt61pci & rt73usb).
778          */
779         u8 freq_offset;
780
781         /*
782          * Calibration information (for rt2800usb & rt2800pci).
783          * [0] -> BW20
784          * [1] -> BW40
785          */
786         u8 calibration[2];
787
788         /*
789          * Beacon interval.
790          */
791         u16 beacon_int;
792
793         /*
794          * Low level statistics which will have
795          * to be kept up to date while device is running.
796          */
797         struct ieee80211_low_level_stats low_level_stats;
798
799         /*
800          * RX configuration information.
801          */
802         struct ieee80211_rx_status rx_status;
803
804         /*
805          * Scheduled work.
806          * NOTE: intf_work will use ieee80211_iterate_active_interfaces()
807          * which means it cannot be placed on the hw->workqueue
808          * due to RTNL locking requirements.
809          */
810         struct work_struct intf_work;
811         struct work_struct filter_work;
812
813         /*
814          * Data queue arrays for RX, TX and Beacon.
815          * The Beacon array also contains the Atim queue
816          * if that is supported by the device.
817          */
818         unsigned int data_queues;
819         struct data_queue *rx;
820         struct data_queue *tx;
821         struct data_queue *bcn;
822
823         /*
824          * Firmware image.
825          */
826         const struct firmware *fw;
827 };
828
829 /*
830  * Generic RF access.
831  * The RF is being accessed by word index.
832  */
833 static inline void rt2x00_rf_read(struct rt2x00_dev *rt2x00dev,
834                                   const unsigned int word, u32 *data)
835 {
836         *data = rt2x00dev->rf[word];
837 }
838
839 static inline void rt2x00_rf_write(struct rt2x00_dev *rt2x00dev,
840                                    const unsigned int word, u32 data)
841 {
842         rt2x00dev->rf[word] = data;
843 }
844
845 /*
846  *  Generic EEPROM access.
847  * The EEPROM is being accessed by word index.
848  */
849 static inline void *rt2x00_eeprom_addr(struct rt2x00_dev *rt2x00dev,
850                                        const unsigned int word)
851 {
852         return (void *)&rt2x00dev->eeprom[word];
853 }
854
855 static inline void rt2x00_eeprom_read(struct rt2x00_dev *rt2x00dev,
856                                       const unsigned int word, u16 *data)
857 {
858         *data = le16_to_cpu(rt2x00dev->eeprom[word]);
859 }
860
861 static inline void rt2x00_eeprom_write(struct rt2x00_dev *rt2x00dev,
862                                        const unsigned int word, u16 data)
863 {
864         rt2x00dev->eeprom[word] = cpu_to_le16(data);
865 }
866
867 /*
868  * Chipset handlers
869  */
870 static inline void rt2x00_set_chip(struct rt2x00_dev *rt2x00dev,
871                                    const u16 rt, const u16 rf, const u32 rev)
872 {
873         INFO(rt2x00dev,
874              "Chipset detected - rt: %04x, rf: %04x, rev: %08x.\n",
875              rt, rf, rev);
876
877         rt2x00dev->chip.rt = rt;
878         rt2x00dev->chip.rf = rf;
879         rt2x00dev->chip.rev = rev;
880 }
881
882 static inline void rt2x00_set_chip_rt(struct rt2x00_dev *rt2x00dev,
883                                       const u16 rt)
884 {
885         rt2x00dev->chip.rt = rt;
886 }
887
888 static inline void rt2x00_set_chip_rf(struct rt2x00_dev *rt2x00dev,
889                                       const u16 rf, const u32 rev)
890 {
891         rt2x00_set_chip(rt2x00dev, rt2x00dev->chip.rt, rf, rev);
892 }
893
894 static inline char rt2x00_rt(const struct rt2x00_chip *chipset, const u16 chip)
895 {
896         return (chipset->rt == chip);
897 }
898
899 static inline char rt2x00_rf(const struct rt2x00_chip *chipset, const u16 chip)
900 {
901         return (chipset->rf == chip);
902 }
903
904 static inline u32 rt2x00_rev(const struct rt2x00_chip *chipset)
905 {
906         return chipset->rev;
907 }
908
909 static inline bool rt2x00_check_rev(const struct rt2x00_chip *chipset,
910                                     const u32 mask, const u32 rev)
911 {
912         return ((chipset->rev & mask) == rev);
913 }
914
915 /**
916  * rt2x00queue_map_txskb - Map a skb into DMA for TX purposes.
917  * @rt2x00dev: Pointer to &struct rt2x00_dev.
918  * @skb: The skb to map.
919  */
920 void rt2x00queue_map_txskb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb);
921
922 /**
923  * rt2x00queue_get_queue - Convert queue index to queue pointer
924  * @rt2x00dev: Pointer to &struct rt2x00_dev.
925  * @queue: rt2x00 queue index (see &enum data_queue_qid).
926  */
927 struct data_queue *rt2x00queue_get_queue(struct rt2x00_dev *rt2x00dev,
928                                          const enum data_queue_qid queue);
929
930 /**
931  * rt2x00queue_get_entry - Get queue entry where the given index points to.
932  * @queue: Pointer to &struct data_queue from where we obtain the entry.
933  * @index: Index identifier for obtaining the correct index.
934  */
935 struct queue_entry *rt2x00queue_get_entry(struct data_queue *queue,
936                                           enum queue_index index);
937
938 /*
939  * Interrupt context handlers.
940  */
941 void rt2x00lib_beacondone(struct rt2x00_dev *rt2x00dev);
942 void rt2x00lib_txdone(struct queue_entry *entry,
943                       struct txdone_entry_desc *txdesc);
944 void rt2x00lib_rxdone(struct rt2x00_dev *rt2x00dev,
945                       struct queue_entry *entry);
946
947 /*
948  * mac80211 handlers.
949  */
950 int rt2x00mac_tx(struct ieee80211_hw *hw, struct sk_buff *skb);
951 int rt2x00mac_start(struct ieee80211_hw *hw);
952 void rt2x00mac_stop(struct ieee80211_hw *hw);
953 int rt2x00mac_add_interface(struct ieee80211_hw *hw,
954                             struct ieee80211_if_init_conf *conf);
955 void rt2x00mac_remove_interface(struct ieee80211_hw *hw,
956                                 struct ieee80211_if_init_conf *conf);
957 int rt2x00mac_config(struct ieee80211_hw *hw, u32 changed);
958 void rt2x00mac_configure_filter(struct ieee80211_hw *hw,
959                                 unsigned int changed_flags,
960                                 unsigned int *total_flags,
961                                 int mc_count, struct dev_addr_list *mc_list);
962 int rt2x00mac_set_tim(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
963                       bool set);
964 #ifdef CONFIG_RT2X00_LIB_CRYPTO
965 int rt2x00mac_set_key(struct ieee80211_hw *hw, enum set_key_cmd cmd,
966                       struct ieee80211_vif *vif, struct ieee80211_sta *sta,
967                       struct ieee80211_key_conf *key);
968 #else
969 #define rt2x00mac_set_key       NULL
970 #endif /* CONFIG_RT2X00_LIB_CRYPTO */
971 int rt2x00mac_get_stats(struct ieee80211_hw *hw,
972                         struct ieee80211_low_level_stats *stats);
973 int rt2x00mac_get_tx_stats(struct ieee80211_hw *hw,
974                            struct ieee80211_tx_queue_stats *stats);
975 void rt2x00mac_bss_info_changed(struct ieee80211_hw *hw,
976                                 struct ieee80211_vif *vif,
977                                 struct ieee80211_bss_conf *bss_conf,
978                                 u32 changes);
979 int rt2x00mac_conf_tx(struct ieee80211_hw *hw, u16 queue,
980                       const struct ieee80211_tx_queue_params *params);
981 void rt2x00mac_rfkill_poll(struct ieee80211_hw *hw);
982
983 /*
984  * Driver allocation handlers.
985  */
986 int rt2x00lib_probe_dev(struct rt2x00_dev *rt2x00dev);
987 void rt2x00lib_remove_dev(struct rt2x00_dev *rt2x00dev);
988 #ifdef CONFIG_PM
989 int rt2x00lib_suspend(struct rt2x00_dev *rt2x00dev, pm_message_t state);
990 int rt2x00lib_resume(struct rt2x00_dev *rt2x00dev);
991 #endif /* CONFIG_PM */
992
993 #endif /* RT2X00_H */