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