cbec91ef6f7613b39927e51a69ecd3e186398fb7
[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 information for the different antennas.
249          * These statistics are used to determine when
250          * to switch antenna when using software diversity.
251          *
252          *        rssi[0] -> Antenna A RSSI
253          *        rssi[1] -> Antenna B RSSI
254          */
255         int rssi_history[2];
256
257         /*
258          * Current RSSI average of the currently active antenna.
259          * Similar to the avg_rssi in the link_qual structure
260          * this value is updated by using the walking average.
261          */
262         int rssi_ant;
263 };
264
265 /*
266  * To optimize the quality of the link we need to store
267  * the quality of received frames and periodically
268  * optimize the link.
269  */
270 struct link {
271         /*
272          * Link tuner counter
273          * The number of times the link has been tuned
274          * since the radio has been switched on.
275          */
276         u32 count;
277
278         /*
279          * Quality measurement values.
280          */
281         struct link_qual qual;
282
283         /*
284          * TX/RX antenna setup.
285          */
286         struct link_ant ant;
287
288         /*
289          * Currently active average RSSI value
290          */
291         int avg_rssi;
292
293         /*
294          * Currently precalculated percentages of successful
295          * TX and RX frames.
296          */
297         int rx_percentage;
298         int tx_percentage;
299
300         /*
301          * Work structure for scheduling periodic link tuning.
302          */
303         struct delayed_work work;
304 };
305
306 /*
307  * Interface structure
308  * Per interface configuration details, this structure
309  * is allocated as the private data for ieee80211_vif.
310  */
311 struct rt2x00_intf {
312         /*
313          * All fields within the rt2x00_intf structure
314          * must be protected with a spinlock.
315          */
316         spinlock_t lock;
317
318         /*
319          * MAC of the device.
320          */
321         u8 mac[ETH_ALEN];
322
323         /*
324          * BBSID of the AP to associate with.
325          */
326         u8 bssid[ETH_ALEN];
327
328         /*
329          * Entry in the beacon queue which belongs to
330          * this interface. Each interface has its own
331          * dedicated beacon entry.
332          */
333         struct queue_entry *beacon;
334
335         /*
336          * Actions that needed rescheduling.
337          */
338         unsigned int delayed_flags;
339 #define DELAYED_UPDATE_BEACON           0x00000001
340 #define DELAYED_CONFIG_ERP              0x00000002
341 #define DELAYED_LED_ASSOC               0x00000004
342
343         /*
344          * Software sequence counter, this is only required
345          * for hardware which doesn't support hardware
346          * sequence counting.
347          */
348         spinlock_t seqlock;
349         u16 seqno;
350 };
351
352 static inline struct rt2x00_intf* vif_to_intf(struct ieee80211_vif *vif)
353 {
354         return (struct rt2x00_intf *)vif->drv_priv;
355 }
356
357 /**
358  * struct hw_mode_spec: Hardware specifications structure
359  *
360  * Details about the supported modes, rates and channels
361  * of a particular chipset. This is used by rt2x00lib
362  * to build the ieee80211_hw_mode array for mac80211.
363  *
364  * @supported_bands: Bitmask contained the supported bands (2.4GHz, 5.2GHz).
365  * @supported_rates: Rate types which are supported (CCK, OFDM).
366  * @num_channels: Number of supported channels. This is used as array size
367  *      for @tx_power_a, @tx_power_bg and @channels.
368  * @channels: Device/chipset specific channel values (See &struct rf_channel).
369  * @channels_info: Additional information for channels (See &struct channel_info).
370  * @ht: Driver HT Capabilities (See &ieee80211_sta_ht_cap).
371  */
372 struct hw_mode_spec {
373         unsigned int supported_bands;
374 #define SUPPORT_BAND_2GHZ       0x00000001
375 #define SUPPORT_BAND_5GHZ       0x00000002
376
377         unsigned int supported_rates;
378 #define SUPPORT_RATE_CCK        0x00000001
379 #define SUPPORT_RATE_OFDM       0x00000002
380
381         unsigned int num_channels;
382         const struct rf_channel *channels;
383         const struct channel_info *channels_info;
384
385         struct ieee80211_sta_ht_cap ht;
386 };
387
388 /*
389  * Configuration structure wrapper around the
390  * mac80211 configuration structure.
391  * When mac80211 configures the driver, rt2x00lib
392  * can precalculate values which are equal for all
393  * rt2x00 drivers. Those values can be stored in here.
394  */
395 struct rt2x00lib_conf {
396         struct ieee80211_conf *conf;
397
398         struct rf_channel rf;
399         struct channel_info channel;
400 };
401
402 /*
403  * Configuration structure for erp settings.
404  */
405 struct rt2x00lib_erp {
406         int short_preamble;
407         int cts_protection;
408
409         int ack_timeout;
410         int ack_consume_time;
411
412         u32 basic_rates;
413
414         int slot_time;
415
416         short sifs;
417         short pifs;
418         short difs;
419         short eifs;
420
421         u16 beacon_int;
422 };
423
424 /*
425  * Configuration structure for hardware encryption.
426  */
427 struct rt2x00lib_crypto {
428         enum cipher cipher;
429
430         enum set_key_cmd cmd;
431         const u8 *address;
432
433         u32 bssidx;
434         u32 aid;
435
436         u8 key[16];
437         u8 tx_mic[8];
438         u8 rx_mic[8];
439 };
440
441 /*
442  * Configuration structure wrapper around the
443  * rt2x00 interface configuration handler.
444  */
445 struct rt2x00intf_conf {
446         /*
447          * Interface type
448          */
449         enum nl80211_iftype type;
450
451         /*
452          * TSF sync value, this is dependant on the operation type.
453          */
454         enum tsf_sync sync;
455
456         /*
457          * The MAC and BSSID addressess are simple array of bytes,
458          * these arrays are little endian, so when sending the addressess
459          * to the drivers, copy the it into a endian-signed variable.
460          *
461          * Note that all devices (except rt2500usb) have 32 bits
462          * register word sizes. This means that whatever variable we
463          * pass _must_ be a multiple of 32 bits. Otherwise the device
464          * might not accept what we are sending to it.
465          * This will also make it easier for the driver to write
466          * the data to the device.
467          */
468         __le32 mac[2];
469         __le32 bssid[2];
470 };
471
472 /*
473  * rt2x00lib callback functions.
474  */
475 struct rt2x00lib_ops {
476         /*
477          * Interrupt handlers.
478          */
479         irq_handler_t irq_handler;
480
481         /*
482          * Device init handlers.
483          */
484         int (*probe_hw) (struct rt2x00_dev *rt2x00dev);
485         char *(*get_firmware_name) (struct rt2x00_dev *rt2x00dev);
486         int (*check_firmware) (struct rt2x00_dev *rt2x00dev,
487                                const u8 *data, const size_t len);
488         int (*load_firmware) (struct rt2x00_dev *rt2x00dev,
489                               const u8 *data, const size_t len);
490
491         /*
492          * Device initialization/deinitialization handlers.
493          */
494         int (*initialize) (struct rt2x00_dev *rt2x00dev);
495         void (*uninitialize) (struct rt2x00_dev *rt2x00dev);
496
497         /*
498          * queue initialization handlers
499          */
500         bool (*get_entry_state) (struct queue_entry *entry);
501         void (*clear_entry) (struct queue_entry *entry);
502
503         /*
504          * Radio control handlers.
505          */
506         int (*set_device_state) (struct rt2x00_dev *rt2x00dev,
507                                  enum dev_state state);
508         int (*rfkill_poll) (struct rt2x00_dev *rt2x00dev);
509         void (*link_stats) (struct rt2x00_dev *rt2x00dev,
510                             struct link_qual *qual);
511         void (*reset_tuner) (struct rt2x00_dev *rt2x00dev,
512                              struct link_qual *qual);
513         void (*link_tuner) (struct rt2x00_dev *rt2x00dev,
514                             struct link_qual *qual, const u32 count);
515
516         /*
517          * TX control handlers
518          */
519         void (*write_tx_desc) (struct rt2x00_dev *rt2x00dev,
520                                struct sk_buff *skb,
521                                struct txentry_desc *txdesc);
522         int (*write_tx_data) (struct queue_entry *entry);
523         void (*write_beacon) (struct queue_entry *entry);
524         int (*get_tx_data_len) (struct queue_entry *entry);
525         void (*kick_tx_queue) (struct rt2x00_dev *rt2x00dev,
526                                const enum data_queue_qid queue);
527         void (*kill_tx_queue) (struct rt2x00_dev *rt2x00dev,
528                                const enum data_queue_qid queue);
529
530         /*
531          * RX control handlers
532          */
533         void (*fill_rxdone) (struct queue_entry *entry,
534                              struct rxdone_entry_desc *rxdesc);
535
536         /*
537          * Configuration handlers.
538          */
539         int (*config_shared_key) (struct rt2x00_dev *rt2x00dev,
540                                   struct rt2x00lib_crypto *crypto,
541                                   struct ieee80211_key_conf *key);
542         int (*config_pairwise_key) (struct rt2x00_dev *rt2x00dev,
543                                     struct rt2x00lib_crypto *crypto,
544                                     struct ieee80211_key_conf *key);
545         void (*config_filter) (struct rt2x00_dev *rt2x00dev,
546                                const unsigned int filter_flags);
547         void (*config_intf) (struct rt2x00_dev *rt2x00dev,
548                              struct rt2x00_intf *intf,
549                              struct rt2x00intf_conf *conf,
550                              const unsigned int flags);
551 #define CONFIG_UPDATE_TYPE              ( 1 << 1 )
552 #define CONFIG_UPDATE_MAC               ( 1 << 2 )
553 #define CONFIG_UPDATE_BSSID             ( 1 << 3 )
554
555         void (*config_erp) (struct rt2x00_dev *rt2x00dev,
556                             struct rt2x00lib_erp *erp);
557         void (*config_ant) (struct rt2x00_dev *rt2x00dev,
558                             struct antenna_setup *ant);
559         void (*config) (struct rt2x00_dev *rt2x00dev,
560                         struct rt2x00lib_conf *libconf,
561                         const unsigned int changed_flags);
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_STATE_PRESENT,
593         DEVICE_STATE_REGISTERED_HW,
594         DEVICE_STATE_INITIALIZED,
595         DEVICE_STATE_STARTED,
596         DEVICE_STATE_ENABLED_RADIO,
597
598         /*
599          * Driver requirements
600          */
601         DRIVER_REQUIRE_FIRMWARE,
602         DRIVER_REQUIRE_BEACON_GUARD,
603         DRIVER_REQUIRE_ATIM_QUEUE,
604         DRIVER_REQUIRE_SCHEDULED,
605         DRIVER_REQUIRE_DMA,
606         DRIVER_REQUIRE_COPY_IV,
607         DRIVER_REQUIRE_L2PAD,
608
609         /*
610          * Driver features
611          */
612         CONFIG_SUPPORT_HW_BUTTON,
613         CONFIG_SUPPORT_HW_CRYPTO,
614
615         /*
616          * Driver configuration
617          */
618         CONFIG_FRAME_TYPE,
619         CONFIG_RF_SEQUENCE,
620         CONFIG_EXTERNAL_LNA_A,
621         CONFIG_EXTERNAL_LNA_BG,
622         CONFIG_DOUBLE_ANTENNA,
623         CONFIG_DISABLE_LINK_TUNING,
624         CONFIG_CHANNEL_HT40,
625 };
626
627 /*
628  * rt2x00 device structure.
629  */
630 struct rt2x00_dev {
631         /*
632          * Device structure.
633          * The structure stored in here depends on the
634          * system bus (PCI or USB).
635          * When accessing this variable, the rt2x00dev_{pci,usb}
636          * macros should be used for correct typecasting.
637          */
638         struct device *dev;
639
640         /*
641          * Callback functions.
642          */
643         const struct rt2x00_ops *ops;
644
645         /*
646          * IEEE80211 control structure.
647          */
648         struct ieee80211_hw *hw;
649         struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
650         enum ieee80211_band curr_band;
651
652         /*
653          * If enabled, the debugfs interface structures
654          * required for deregistration of debugfs.
655          */
656 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
657         struct rt2x00debug_intf *debugfs_intf;
658 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
659
660         /*
661          * LED structure for changing the LED status
662          * by mac8011 or the kernel.
663          */
664 #ifdef CONFIG_RT2X00_LIB_LEDS
665         struct rt2x00_led led_radio;
666         struct rt2x00_led led_assoc;
667         struct rt2x00_led led_qual;
668         u16 led_mcu_reg;
669 #endif /* CONFIG_RT2X00_LIB_LEDS */
670
671         /*
672          * Device flags.
673          * In these flags the current status and some
674          * of the device capabilities are stored.
675          */
676         unsigned long flags;
677
678         /*
679          * Device information, Bus IRQ and name (PCI, SoC)
680          */
681         int irq;
682         const char *name;
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.
697          */
698         struct antenna_setup default_ant;
699
700         /*
701          * Register pointers
702          * csr.base: CSR base register address. (PCI)
703          * csr.cache: CSR cache for usb_control_msg. (USB)
704          */
705         union csr {
706                 void __iomem *base;
707                 void *cache;
708         } csr;
709
710         /*
711          * Mutex to protect register accesses.
712          * For PCI and USB devices it protects against concurrent indirect
713          * register access (BBP, RF, MCU) since accessing those
714          * registers require multiple calls to the CSR registers.
715          * For USB devices it also protects the csr_cache since that
716          * field is used for normal CSR access and it cannot support
717          * multiple callers simultaneously.
718          */
719         struct mutex csr_mutex;
720
721         /*
722          * Current packet filter configuration for the device.
723          * This contains all currently active FIF_* flags send
724          * to us by mac80211 during configure_filter().
725          */
726         unsigned int packet_filter;
727
728         /*
729          * Interface details:
730          *  - Open ap interface count.
731          *  - Open sta interface count.
732          *  - Association count.
733          */
734         unsigned int intf_ap_count;
735         unsigned int intf_sta_count;
736         unsigned int intf_associated;
737
738         /*
739          * Link quality
740          */
741         struct link link;
742
743         /*
744          * EEPROM data.
745          */
746         __le16 *eeprom;
747
748         /*
749          * Active RF register values.
750          * These are stored here so we don't need
751          * to read the rf registers and can directly
752          * use this value instead.
753          * This field should be accessed by using
754          * rt2x00_rf_read() and rt2x00_rf_write().
755          */
756         u32 *rf;
757
758         /*
759          * LNA gain
760          */
761         short lna_gain;
762
763         /*
764          * Current TX power value.
765          */
766         u16 tx_power;
767
768         /*
769          * Current retry values.
770          */
771         u8 short_retry;
772         u8 long_retry;
773
774         /*
775          * Rssi <-> Dbm offset
776          */
777         u8 rssi_offset;
778
779         /*
780          * Frequency offset (for rt61pci & rt73usb).
781          */
782         u8 freq_offset;
783
784         /*
785          * Calibration information (for rt2800usb & rt2800pci).
786          * [0] -> BW20
787          * [1] -> BW40
788          */
789         u8 calibration[2];
790
791         /*
792          * Beacon interval.
793          */
794         u16 beacon_int;
795
796         /*
797          * Low level statistics which will have
798          * to be kept up to date while device is running.
799          */
800         struct ieee80211_low_level_stats low_level_stats;
801
802         /*
803          * RX configuration information.
804          */
805         struct ieee80211_rx_status rx_status;
806
807         /*
808          * Scheduled work.
809          * NOTE: intf_work will use ieee80211_iterate_active_interfaces()
810          * which means it cannot be placed on the hw->workqueue
811          * due to RTNL locking requirements.
812          */
813         struct work_struct intf_work;
814         struct work_struct filter_work;
815
816         /*
817          * Data queue arrays for RX, TX and Beacon.
818          * The Beacon array also contains the Atim queue
819          * if that is supported by the device.
820          */
821         unsigned int data_queues;
822         struct data_queue *rx;
823         struct data_queue *tx;
824         struct data_queue *bcn;
825
826         /*
827          * Firmware image.
828          */
829         const struct firmware *fw;
830 };
831
832 /*
833  * Generic RF access.
834  * The RF is being accessed by word index.
835  */
836 static inline void rt2x00_rf_read(struct rt2x00_dev *rt2x00dev,
837                                   const unsigned int word, u32 *data)
838 {
839         *data = rt2x00dev->rf[word];
840 }
841
842 static inline void rt2x00_rf_write(struct rt2x00_dev *rt2x00dev,
843                                    const unsigned int word, u32 data)
844 {
845         rt2x00dev->rf[word] = data;
846 }
847
848 /*
849  *  Generic EEPROM access.
850  * The EEPROM is being accessed by word index.
851  */
852 static inline void *rt2x00_eeprom_addr(struct rt2x00_dev *rt2x00dev,
853                                        const unsigned int word)
854 {
855         return (void *)&rt2x00dev->eeprom[word];
856 }
857
858 static inline void rt2x00_eeprom_read(struct rt2x00_dev *rt2x00dev,
859                                       const unsigned int word, u16 *data)
860 {
861         *data = le16_to_cpu(rt2x00dev->eeprom[word]);
862 }
863
864 static inline void rt2x00_eeprom_write(struct rt2x00_dev *rt2x00dev,
865                                        const unsigned int word, u16 data)
866 {
867         rt2x00dev->eeprom[word] = cpu_to_le16(data);
868 }
869
870 /*
871  * Chipset handlers
872  */
873 static inline void rt2x00_set_chip(struct rt2x00_dev *rt2x00dev,
874                                    const u16 rt, const u16 rf, const u32 rev)
875 {
876         INFO(rt2x00dev,
877              "Chipset detected - rt: %04x, rf: %04x, rev: %08x.\n",
878              rt, rf, rev);
879
880         rt2x00dev->chip.rt = rt;
881         rt2x00dev->chip.rf = rf;
882         rt2x00dev->chip.rev = rev;
883 }
884
885 static inline void rt2x00_set_chip_rt(struct rt2x00_dev *rt2x00dev,
886                                       const u16 rt)
887 {
888         rt2x00dev->chip.rt = rt;
889 }
890
891 static inline void rt2x00_set_chip_rf(struct rt2x00_dev *rt2x00dev,
892                                       const u16 rf, const u32 rev)
893 {
894         rt2x00_set_chip(rt2x00dev, rt2x00dev->chip.rt, rf, rev);
895 }
896
897 static inline char rt2x00_rt(const struct rt2x00_chip *chipset, const u16 chip)
898 {
899         return (chipset->rt == chip);
900 }
901
902 static inline char rt2x00_rf(const struct rt2x00_chip *chipset, const u16 chip)
903 {
904         return (chipset->rf == chip);
905 }
906
907 static inline u32 rt2x00_rev(const struct rt2x00_chip *chipset)
908 {
909         return chipset->rev;
910 }
911
912 static inline bool rt2x00_check_rev(const struct rt2x00_chip *chipset,
913                                     const u32 mask, const u32 rev)
914 {
915         return ((chipset->rev & mask) == rev);
916 }
917
918 /**
919  * rt2x00queue_map_txskb - Map a skb into DMA for TX purposes.
920  * @rt2x00dev: Pointer to &struct rt2x00_dev.
921  * @skb: The skb to map.
922  */
923 void rt2x00queue_map_txskb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb);
924
925 /**
926  * rt2x00queue_get_queue - Convert queue index to queue pointer
927  * @rt2x00dev: Pointer to &struct rt2x00_dev.
928  * @queue: rt2x00 queue index (see &enum data_queue_qid).
929  */
930 struct data_queue *rt2x00queue_get_queue(struct rt2x00_dev *rt2x00dev,
931                                          const enum data_queue_qid queue);
932
933 /**
934  * rt2x00queue_get_entry - Get queue entry where the given index points to.
935  * @queue: Pointer to &struct data_queue from where we obtain the entry.
936  * @index: Index identifier for obtaining the correct index.
937  */
938 struct queue_entry *rt2x00queue_get_entry(struct data_queue *queue,
939                                           enum queue_index index);
940
941 /*
942  * Interrupt context handlers.
943  */
944 void rt2x00lib_beacondone(struct rt2x00_dev *rt2x00dev);
945 void rt2x00lib_txdone(struct queue_entry *entry,
946                       struct txdone_entry_desc *txdesc);
947 void rt2x00lib_rxdone(struct rt2x00_dev *rt2x00dev,
948                       struct queue_entry *entry);
949
950 /*
951  * mac80211 handlers.
952  */
953 int rt2x00mac_tx(struct ieee80211_hw *hw, struct sk_buff *skb);
954 int rt2x00mac_start(struct ieee80211_hw *hw);
955 void rt2x00mac_stop(struct ieee80211_hw *hw);
956 int rt2x00mac_add_interface(struct ieee80211_hw *hw,
957                             struct ieee80211_if_init_conf *conf);
958 void rt2x00mac_remove_interface(struct ieee80211_hw *hw,
959                                 struct ieee80211_if_init_conf *conf);
960 int rt2x00mac_config(struct ieee80211_hw *hw, u32 changed);
961 void rt2x00mac_configure_filter(struct ieee80211_hw *hw,
962                                 unsigned int changed_flags,
963                                 unsigned int *total_flags,
964                                 int mc_count, struct dev_addr_list *mc_list);
965 int rt2x00mac_set_tim(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
966                       bool set);
967 #ifdef CONFIG_RT2X00_LIB_CRYPTO
968 int rt2x00mac_set_key(struct ieee80211_hw *hw, enum set_key_cmd cmd,
969                       struct ieee80211_vif *vif, struct ieee80211_sta *sta,
970                       struct ieee80211_key_conf *key);
971 #else
972 #define rt2x00mac_set_key       NULL
973 #endif /* CONFIG_RT2X00_LIB_CRYPTO */
974 int rt2x00mac_get_stats(struct ieee80211_hw *hw,
975                         struct ieee80211_low_level_stats *stats);
976 int rt2x00mac_get_tx_stats(struct ieee80211_hw *hw,
977                            struct ieee80211_tx_queue_stats *stats);
978 void rt2x00mac_bss_info_changed(struct ieee80211_hw *hw,
979                                 struct ieee80211_vif *vif,
980                                 struct ieee80211_bss_conf *bss_conf,
981                                 u32 changes);
982 int rt2x00mac_conf_tx(struct ieee80211_hw *hw, u16 queue,
983                       const struct ieee80211_tx_queue_params *params);
984 void rt2x00mac_rfkill_poll(struct ieee80211_hw *hw);
985
986 /*
987  * Driver allocation handlers.
988  */
989 int rt2x00lib_probe_dev(struct rt2x00_dev *rt2x00dev);
990 void rt2x00lib_remove_dev(struct rt2x00_dev *rt2x00dev);
991 #ifdef CONFIG_PM
992 int rt2x00lib_suspend(struct rt2x00_dev *rt2x00dev, pm_message_t state);
993 int rt2x00lib_resume(struct rt2x00_dev *rt2x00dev);
994 #endif /* CONFIG_PM */
995
996 #endif /* RT2X00_H */