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