dd0f66ade6e8ca475b9705177476bb67dfd60601
[linux-2.6.git] / drivers / net / wireless / rt2x00 / rt2x00.h
1 /*
2         Copyright (C) 2010 Willow Garage <http://www.willowgarage.com>
3         Copyright (C) 2004 - 2010 Ivo van Doorn <IvDoorn@gmail.com>
4         Copyright (C) 2004 - 2009 Gertjan van Wingerde <gwingerde@gmail.com>
5         <http://rt2x00.serialmonkey.com>
6
7         This program is free software; you can redistribute it and/or modify
8         it under the terms of the GNU General Public License as published by
9         the Free Software Foundation; either version 2 of the License, or
10         (at your option) any later version.
11
12         This program is distributed in the hope that it will be useful,
13         but WITHOUT ANY WARRANTY; without even the implied warranty of
14         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15         GNU General Public License for more details.
16
17         You should have received a copy of the GNU General Public License
18         along with this program; if not, write to the
19         Free Software Foundation, Inc.,
20         59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21  */
22
23 /*
24         Module: rt2x00
25         Abstract: rt2x00 global information.
26  */
27
28 #ifndef RT2X00_H
29 #define RT2X00_H
30
31 #include <linux/bitops.h>
32 #include <linux/skbuff.h>
33 #include <linux/workqueue.h>
34 #include <linux/firmware.h>
35 #include <linux/leds.h>
36 #include <linux/mutex.h>
37 #include <linux/etherdevice.h>
38 #include <linux/input-polldev.h>
39 #include <linux/kfifo.h>
40
41 #include <net/mac80211.h>
42
43 #include "rt2x00debug.h"
44 #include "rt2x00dump.h"
45 #include "rt2x00leds.h"
46 #include "rt2x00reg.h"
47 #include "rt2x00queue.h"
48
49 /*
50  * Module information.
51  */
52 #define DRV_VERSION     "2.3.0"
53 #define DRV_PROJECT     "http://rt2x00.serialmonkey.com"
54
55 /*
56  * Debug definitions.
57  * Debug output has to be enabled during compile time.
58  */
59 #define DEBUG_PRINTK_MSG(__dev, __kernlvl, __lvl, __msg, __args...)     \
60         printk(__kernlvl "%s -> %s: %s - " __msg,                       \
61                wiphy_name((__dev)->hw->wiphy), __func__, __lvl, ##__args)
62
63 #define DEBUG_PRINTK_PROBE(__kernlvl, __lvl, __msg, __args...)  \
64         printk(__kernlvl "%s -> %s: %s - " __msg,               \
65                KBUILD_MODNAME, __func__, __lvl, ##__args)
66
67 #ifdef CONFIG_RT2X00_DEBUG
68 #define DEBUG_PRINTK(__dev, __kernlvl, __lvl, __msg, __args...) \
69         DEBUG_PRINTK_MSG(__dev, __kernlvl, __lvl, __msg, ##__args)
70 #else
71 #define DEBUG_PRINTK(__dev, __kernlvl, __lvl, __msg, __args...) \
72         do { } while (0)
73 #endif /* CONFIG_RT2X00_DEBUG */
74
75 /*
76  * Various debug levels.
77  * The debug levels PANIC and ERROR both indicate serious problems,
78  * for this reason they should never be ignored.
79  * The special ERROR_PROBE message is for messages that are generated
80  * when the rt2x00_dev is not yet initialized.
81  */
82 #define PANIC(__dev, __msg, __args...) \
83         DEBUG_PRINTK_MSG(__dev, KERN_CRIT, "Panic", __msg, ##__args)
84 #define ERROR(__dev, __msg, __args...)  \
85         DEBUG_PRINTK_MSG(__dev, KERN_ERR, "Error", __msg, ##__args)
86 #define ERROR_PROBE(__msg, __args...) \
87         DEBUG_PRINTK_PROBE(KERN_ERR, "Error", __msg, ##__args)
88 #define WARNING(__dev, __msg, __args...) \
89         DEBUG_PRINTK(__dev, KERN_WARNING, "Warning", __msg, ##__args)
90 #define NOTICE(__dev, __msg, __args...) \
91         DEBUG_PRINTK(__dev, KERN_NOTICE, "Notice", __msg, ##__args)
92 #define INFO(__dev, __msg, __args...) \
93         DEBUG_PRINTK(__dev, KERN_INFO, "Info", __msg, ##__args)
94 #define DEBUG(__dev, __msg, __args...) \
95         DEBUG_PRINTK(__dev, KERN_DEBUG, "Debug", __msg, ##__args)
96 #define EEPROM(__dev, __msg, __args...) \
97         DEBUG_PRINTK(__dev, KERN_DEBUG, "EEPROM recovery", __msg, ##__args)
98
99 /*
100  * Duration calculations
101  * The rate variable passed is: 100kbs.
102  * To convert from bytes to bits we multiply size with 8,
103  * then the size is multiplied with 10 to make the
104  * real rate -> rate argument correction.
105  */
106 #define GET_DURATION(__size, __rate)    (((__size) * 8 * 10) / (__rate))
107 #define GET_DURATION_RES(__size, __rate)(((__size) * 8 * 10) % (__rate))
108
109 /*
110  * Determine the number of L2 padding bytes required between the header and
111  * the payload.
112  */
113 #define L2PAD_SIZE(__hdrlen)    (-(__hdrlen) & 3)
114
115 /*
116  * Determine the alignment requirement,
117  * to make sure the 802.11 payload is padded to a 4-byte boundrary
118  * we must determine the address of the payload and calculate the
119  * amount of bytes needed to move the data.
120  */
121 #define ALIGN_SIZE(__skb, __header) \
122         (  ((unsigned long)((__skb)->data + (__header))) & 3 )
123
124 /*
125  * Constants for extra TX headroom for alignment purposes.
126  */
127 #define RT2X00_ALIGN_SIZE       4 /* Only whole frame needs alignment */
128 #define RT2X00_L2PAD_SIZE       8 /* Both header & payload need alignment */
129
130 /*
131  * Standard timing and size defines.
132  * These values should follow the ieee80211 specifications.
133  */
134 #define ACK_SIZE                14
135 #define IEEE80211_HEADER        24
136 #define PLCP                    48
137 #define BEACON                  100
138 #define PREAMBLE                144
139 #define SHORT_PREAMBLE          72
140 #define SLOT_TIME               20
141 #define SHORT_SLOT_TIME         9
142 #define SIFS                    10
143 #define PIFS                    ( SIFS + SLOT_TIME )
144 #define SHORT_PIFS              ( SIFS + SHORT_SLOT_TIME )
145 #define DIFS                    ( PIFS + SLOT_TIME )
146 #define SHORT_DIFS              ( SHORT_PIFS + SHORT_SLOT_TIME )
147 #define EIFS                    ( SIFS + DIFS + \
148                                   GET_DURATION(IEEE80211_HEADER + ACK_SIZE, 10) )
149 #define SHORT_EIFS              ( SIFS + SHORT_DIFS + \
150                                   GET_DURATION(IEEE80211_HEADER + ACK_SIZE, 10) )
151
152 /*
153  * Structure for average calculation
154  * The avg field contains the actual average value,
155  * but avg_weight is internally used during calculations
156  * to prevent rounding errors.
157  */
158 struct avg_val {
159         int avg;
160         int avg_weight;
161 };
162
163 enum rt2x00_chip_intf {
164         RT2X00_CHIP_INTF_PCI,
165         RT2X00_CHIP_INTF_PCIE,
166         RT2X00_CHIP_INTF_USB,
167         RT2X00_CHIP_INTF_SOC,
168 };
169
170 /*
171  * Chipset identification
172  * The chipset on the device is composed of a RT and RF chip.
173  * The chipset combination is important for determining device capabilities.
174  */
175 struct rt2x00_chip {
176         u16 rt;
177 #define RT2460          0x2460
178 #define RT2560          0x2560
179 #define RT2570          0x2570
180 #define RT2661          0x2661
181 #define RT2573          0x2573
182 #define RT2860          0x2860  /* 2.4GHz */
183 #define RT2872          0x2872  /* WSOC */
184 #define RT2883          0x2883  /* WSOC */
185 #define RT3070          0x3070
186 #define RT3071          0x3071
187 #define RT3090          0x3090  /* 2.4GHz PCIe */
188 #define RT3390          0x3390
189 #define RT3572          0x3572
190 #define RT3593          0x3593  /* PCIe */
191 #define RT3883          0x3883  /* WSOC */
192 #define RT5390         0x5390  /* 2.4GHz */
193
194         u16 rf;
195         u16 rev;
196
197         enum rt2x00_chip_intf intf;
198 };
199
200 /*
201  * RF register values that belong to a particular channel.
202  */
203 struct rf_channel {
204         int channel;
205         u32 rf1;
206         u32 rf2;
207         u32 rf3;
208         u32 rf4;
209 };
210
211 /*
212  * Channel information structure
213  */
214 struct channel_info {
215         unsigned int flags;
216 #define GEOGRAPHY_ALLOWED       0x00000001
217
218         short max_power;
219         short default_power1;
220         short default_power2;
221 };
222
223 /*
224  * Antenna setup values.
225  */
226 struct antenna_setup {
227         enum antenna rx;
228         enum antenna tx;
229         u8 rx_chain_num;
230         u8 tx_chain_num;
231 };
232
233 /*
234  * Quality statistics about the currently active link.
235  */
236 struct link_qual {
237         /*
238          * Statistics required for Link tuning by driver
239          * The rssi value is provided by rt2x00lib during the
240          * link_tuner() callback function.
241          * The false_cca field is filled during the link_stats()
242          * callback function and could be used during the
243          * link_tuner() callback function.
244          */
245         int rssi;
246         int false_cca;
247
248         /*
249          * VGC levels
250          * Hardware driver will tune the VGC level during each call
251          * to the link_tuner() callback function. This vgc_level is
252          * is determined based on the link quality statistics like
253          * average RSSI and the false CCA count.
254          *
255          * In some cases the drivers need to differentiate between
256          * the currently "desired" VGC level and the level configured
257          * in the hardware. The latter is important to reduce the
258          * number of BBP register reads to reduce register access
259          * overhead. For this reason we store both values here.
260          */
261         u8 vgc_level;
262         u8 vgc_level_reg;
263
264         /*
265          * Statistics required for Signal quality calculation.
266          * These fields might be changed during the link_stats()
267          * callback function.
268          */
269         int rx_success;
270         int rx_failed;
271         int tx_success;
272         int tx_failed;
273 };
274
275 /*
276  * Antenna settings about the currently active link.
277  */
278 struct link_ant {
279         /*
280          * Antenna flags
281          */
282         unsigned int flags;
283 #define ANTENNA_RX_DIVERSITY    0x00000001
284 #define ANTENNA_TX_DIVERSITY    0x00000002
285 #define ANTENNA_MODE_SAMPLE     0x00000004
286
287         /*
288          * Currently active TX/RX antenna setup.
289          * When software diversity is used, this will indicate
290          * which antenna is actually used at this time.
291          */
292         struct antenna_setup active;
293
294         /*
295          * RSSI history information for the antenna.
296          * Used to determine when to switch antenna
297          * when using software diversity.
298          */
299         int rssi_history;
300
301         /*
302          * Current RSSI average of the currently active antenna.
303          * Similar to the avg_rssi in the link_qual structure
304          * this value is updated by using the walking average.
305          */
306         struct avg_val rssi_ant;
307 };
308
309 /*
310  * To optimize the quality of the link we need to store
311  * the quality of received frames and periodically
312  * optimize the link.
313  */
314 struct link {
315         /*
316          * Link tuner counter
317          * The number of times the link has been tuned
318          * since the radio has been switched on.
319          */
320         u32 count;
321
322         /*
323          * Quality measurement values.
324          */
325         struct link_qual qual;
326
327         /*
328          * TX/RX antenna setup.
329          */
330         struct link_ant ant;
331
332         /*
333          * Currently active average RSSI value
334          */
335         struct avg_val avg_rssi;
336
337         /*
338          * Work structure for scheduling periodic link tuning.
339          */
340         struct delayed_work work;
341
342         /*
343          * Work structure for scheduling periodic watchdog monitoring.
344          * This work must be scheduled on the kernel workqueue, while
345          * all other work structures must be queued on the mac80211
346          * workqueue. This guarantees that the watchdog can schedule
347          * other work structures and wait for their completion in order
348          * to bring the device/driver back into the desired state.
349          */
350         struct delayed_work watchdog_work;
351
352         /*
353          * Work structure for scheduling periodic AGC adjustments.
354          */
355         struct delayed_work agc_work;
356 };
357
358 enum rt2x00_delayed_flags {
359         DELAYED_UPDATE_BEACON,
360 };
361
362 /*
363  * Interface structure
364  * Per interface configuration details, this structure
365  * is allocated as the private data for ieee80211_vif.
366  */
367 struct rt2x00_intf {
368         /*
369          * beacon->skb must be protected with the mutex.
370          */
371         struct mutex beacon_skb_mutex;
372
373         /*
374          * Entry in the beacon queue which belongs to
375          * this interface. Each interface has its own
376          * dedicated beacon entry.
377          */
378         struct queue_entry *beacon;
379         bool enable_beacon;
380
381         /*
382          * Actions that needed rescheduling.
383          */
384         unsigned long delayed_flags;
385
386         /*
387          * Software sequence counter, this is only required
388          * for hardware which doesn't support hardware
389          * sequence counting.
390          */
391         spinlock_t seqlock;
392         u16 seqno;
393 };
394
395 static inline struct rt2x00_intf* vif_to_intf(struct ieee80211_vif *vif)
396 {
397         return (struct rt2x00_intf *)vif->drv_priv;
398 }
399
400 /**
401  * struct hw_mode_spec: Hardware specifications structure
402  *
403  * Details about the supported modes, rates and channels
404  * of a particular chipset. This is used by rt2x00lib
405  * to build the ieee80211_hw_mode array for mac80211.
406  *
407  * @supported_bands: Bitmask contained the supported bands (2.4GHz, 5.2GHz).
408  * @supported_rates: Rate types which are supported (CCK, OFDM).
409  * @num_channels: Number of supported channels. This is used as array size
410  *      for @tx_power_a, @tx_power_bg and @channels.
411  * @channels: Device/chipset specific channel values (See &struct rf_channel).
412  * @channels_info: Additional information for channels (See &struct channel_info).
413  * @ht: Driver HT Capabilities (See &ieee80211_sta_ht_cap).
414  */
415 struct hw_mode_spec {
416         unsigned int supported_bands;
417 #define SUPPORT_BAND_2GHZ       0x00000001
418 #define SUPPORT_BAND_5GHZ       0x00000002
419
420         unsigned int supported_rates;
421 #define SUPPORT_RATE_CCK        0x00000001
422 #define SUPPORT_RATE_OFDM       0x00000002
423
424         unsigned int num_channels;
425         const struct rf_channel *channels;
426         const struct channel_info *channels_info;
427
428         struct ieee80211_sta_ht_cap ht;
429 };
430
431 /*
432  * Configuration structure wrapper around the
433  * mac80211 configuration structure.
434  * When mac80211 configures the driver, rt2x00lib
435  * can precalculate values which are equal for all
436  * rt2x00 drivers. Those values can be stored in here.
437  */
438 struct rt2x00lib_conf {
439         struct ieee80211_conf *conf;
440
441         struct rf_channel rf;
442         struct channel_info channel;
443 };
444
445 /*
446  * Configuration structure for erp settings.
447  */
448 struct rt2x00lib_erp {
449         int short_preamble;
450         int cts_protection;
451
452         u32 basic_rates;
453
454         int slot_time;
455
456         short sifs;
457         short pifs;
458         short difs;
459         short eifs;
460
461         u16 beacon_int;
462         u16 ht_opmode;
463 };
464
465 /*
466  * Configuration structure for hardware encryption.
467  */
468 struct rt2x00lib_crypto {
469         enum cipher cipher;
470
471         enum set_key_cmd cmd;
472         const u8 *address;
473
474         u32 bssidx;
475
476         u8 key[16];
477         u8 tx_mic[8];
478         u8 rx_mic[8];
479 };
480
481 /*
482  * Configuration structure wrapper around the
483  * rt2x00 interface configuration handler.
484  */
485 struct rt2x00intf_conf {
486         /*
487          * Interface type
488          */
489         enum nl80211_iftype type;
490
491         /*
492          * TSF sync value, this is dependant on the operation type.
493          */
494         enum tsf_sync sync;
495
496         /*
497          * The MAC and BSSID addressess are simple array of bytes,
498          * these arrays are little endian, so when sending the addressess
499          * to the drivers, copy the it into a endian-signed variable.
500          *
501          * Note that all devices (except rt2500usb) have 32 bits
502          * register word sizes. This means that whatever variable we
503          * pass _must_ be a multiple of 32 bits. Otherwise the device
504          * might not accept what we are sending to it.
505          * This will also make it easier for the driver to write
506          * the data to the device.
507          */
508         __le32 mac[2];
509         __le32 bssid[2];
510 };
511
512 /*
513  * rt2x00lib callback functions.
514  */
515 struct rt2x00lib_ops {
516         /*
517          * Interrupt handlers.
518          */
519         irq_handler_t irq_handler;
520
521         /*
522          * TX status tasklet handler.
523          */
524         void (*txstatus_tasklet) (unsigned long data);
525         void (*pretbtt_tasklet) (unsigned long data);
526         void (*tbtt_tasklet) (unsigned long data);
527         void (*rxdone_tasklet) (unsigned long data);
528         void (*autowake_tasklet) (unsigned long data);
529
530         /*
531          * Device init handlers.
532          */
533         int (*probe_hw) (struct rt2x00_dev *rt2x00dev);
534         char *(*get_firmware_name) (struct rt2x00_dev *rt2x00dev);
535         int (*check_firmware) (struct rt2x00_dev *rt2x00dev,
536                                const u8 *data, const size_t len);
537         int (*load_firmware) (struct rt2x00_dev *rt2x00dev,
538                               const u8 *data, const size_t len);
539
540         /*
541          * Device initialization/deinitialization handlers.
542          */
543         int (*initialize) (struct rt2x00_dev *rt2x00dev);
544         void (*uninitialize) (struct rt2x00_dev *rt2x00dev);
545
546         /*
547          * queue initialization handlers
548          */
549         bool (*get_entry_state) (struct queue_entry *entry);
550         void (*clear_entry) (struct queue_entry *entry);
551
552         /*
553          * Radio control handlers.
554          */
555         int (*set_device_state) (struct rt2x00_dev *rt2x00dev,
556                                  enum dev_state state);
557         int (*rfkill_poll) (struct rt2x00_dev *rt2x00dev);
558         void (*link_stats) (struct rt2x00_dev *rt2x00dev,
559                             struct link_qual *qual);
560         void (*reset_tuner) (struct rt2x00_dev *rt2x00dev,
561                              struct link_qual *qual);
562         void (*link_tuner) (struct rt2x00_dev *rt2x00dev,
563                             struct link_qual *qual, const u32 count);
564         void (*gain_calibration) (struct rt2x00_dev *rt2x00dev);
565
566         /*
567          * Data queue handlers.
568          */
569         void (*watchdog) (struct rt2x00_dev *rt2x00dev);
570         void (*start_queue) (struct data_queue *queue);
571         void (*kick_queue) (struct data_queue *queue);
572         void (*stop_queue) (struct data_queue *queue);
573         void (*flush_queue) (struct data_queue *queue);
574
575         /*
576          * TX control handlers
577          */
578         void (*write_tx_desc) (struct queue_entry *entry,
579                                struct txentry_desc *txdesc);
580         void (*write_tx_data) (struct queue_entry *entry,
581                                struct txentry_desc *txdesc);
582         void (*write_beacon) (struct queue_entry *entry,
583                               struct txentry_desc *txdesc);
584         void (*clear_beacon) (struct queue_entry *entry);
585         int (*get_tx_data_len) (struct queue_entry *entry);
586
587         /*
588          * RX control handlers
589          */
590         void (*fill_rxdone) (struct queue_entry *entry,
591                              struct rxdone_entry_desc *rxdesc);
592
593         /*
594          * Configuration handlers.
595          */
596         int (*config_shared_key) (struct rt2x00_dev *rt2x00dev,
597                                   struct rt2x00lib_crypto *crypto,
598                                   struct ieee80211_key_conf *key);
599         int (*config_pairwise_key) (struct rt2x00_dev *rt2x00dev,
600                                     struct rt2x00lib_crypto *crypto,
601                                     struct ieee80211_key_conf *key);
602         void (*config_filter) (struct rt2x00_dev *rt2x00dev,
603                                const unsigned int filter_flags);
604         void (*config_intf) (struct rt2x00_dev *rt2x00dev,
605                              struct rt2x00_intf *intf,
606                              struct rt2x00intf_conf *conf,
607                              const unsigned int flags);
608 #define CONFIG_UPDATE_TYPE              ( 1 << 1 )
609 #define CONFIG_UPDATE_MAC               ( 1 << 2 )
610 #define CONFIG_UPDATE_BSSID             ( 1 << 3 )
611
612         void (*config_erp) (struct rt2x00_dev *rt2x00dev,
613                             struct rt2x00lib_erp *erp,
614                             u32 changed);
615         void (*config_ant) (struct rt2x00_dev *rt2x00dev,
616                             struct antenna_setup *ant);
617         void (*config) (struct rt2x00_dev *rt2x00dev,
618                         struct rt2x00lib_conf *libconf,
619                         const unsigned int changed_flags);
620 };
621
622 /*
623  * rt2x00 driver callback operation structure.
624  */
625 struct rt2x00_ops {
626         const char *name;
627         const unsigned int max_sta_intf;
628         const unsigned int max_ap_intf;
629         const unsigned int eeprom_size;
630         const unsigned int rf_size;
631         const unsigned int tx_queues;
632         const unsigned int extra_tx_headroom;
633         const struct data_queue_desc *rx;
634         const struct data_queue_desc *tx;
635         const struct data_queue_desc *bcn;
636         const struct data_queue_desc *atim;
637         const struct rt2x00lib_ops *lib;
638         const void *drv;
639         const struct ieee80211_ops *hw;
640 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
641         const struct rt2x00debug *debugfs;
642 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
643 };
644
645 /*
646  * rt2x00 device flags
647  */
648 enum rt2x00_flags {
649         /*
650          * Device state flags
651          */
652         DEVICE_STATE_PRESENT,
653         DEVICE_STATE_REGISTERED_HW,
654         DEVICE_STATE_INITIALIZED,
655         DEVICE_STATE_STARTED,
656         DEVICE_STATE_ENABLED_RADIO,
657         DEVICE_STATE_SCANNING,
658
659         /*
660          * Driver requirements
661          */
662         DRIVER_REQUIRE_FIRMWARE,
663         DRIVER_REQUIRE_BEACON_GUARD,
664         DRIVER_REQUIRE_ATIM_QUEUE,
665         DRIVER_REQUIRE_DMA,
666         DRIVER_REQUIRE_COPY_IV,
667         DRIVER_REQUIRE_L2PAD,
668         DRIVER_REQUIRE_TXSTATUS_FIFO,
669         DRIVER_REQUIRE_TASKLET_CONTEXT,
670         DRIVER_REQUIRE_SW_SEQNO,
671         DRIVER_REQUIRE_HT_TX_DESC,
672
673         /*
674          * Driver features
675          */
676         CONFIG_SUPPORT_HW_BUTTON,
677         CONFIG_SUPPORT_HW_CRYPTO,
678         CONFIG_SUPPORT_POWER_LIMIT,
679         DRIVER_SUPPORT_CONTROL_FILTERS,
680         DRIVER_SUPPORT_CONTROL_FILTER_PSPOLL,
681         DRIVER_SUPPORT_PRE_TBTT_INTERRUPT,
682         DRIVER_SUPPORT_LINK_TUNING,
683
684         /*
685          * Driver configuration
686          */
687         CONFIG_FRAME_TYPE,
688         CONFIG_RF_SEQUENCE,
689         CONFIG_EXTERNAL_LNA_A,
690         CONFIG_EXTERNAL_LNA_BG,
691         CONFIG_DOUBLE_ANTENNA,
692         CONFIG_CHANNEL_HT40,
693 };
694
695 /*
696  * rt2x00 device structure.
697  */
698 struct rt2x00_dev {
699         /*
700          * Device structure.
701          * The structure stored in here depends on the
702          * system bus (PCI or USB).
703          * When accessing this variable, the rt2x00dev_{pci,usb}
704          * macros should be used for correct typecasting.
705          */
706         struct device *dev;
707
708         /*
709          * Callback functions.
710          */
711         const struct rt2x00_ops *ops;
712
713         /*
714          * IEEE80211 control structure.
715          */
716         struct ieee80211_hw *hw;
717         struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
718         enum ieee80211_band curr_band;
719         int curr_freq;
720
721         /*
722          * If enabled, the debugfs interface structures
723          * required for deregistration of debugfs.
724          */
725 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
726         struct rt2x00debug_intf *debugfs_intf;
727 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
728
729         /*
730          * LED structure for changing the LED status
731          * by mac8011 or the kernel.
732          */
733 #ifdef CONFIG_RT2X00_LIB_LEDS
734         struct rt2x00_led led_radio;
735         struct rt2x00_led led_assoc;
736         struct rt2x00_led led_qual;
737         u16 led_mcu_reg;
738 #endif /* CONFIG_RT2X00_LIB_LEDS */
739
740         /*
741          * Device flags.
742          * In these flags the current status and some
743          * of the device capabilities are stored.
744          */
745         unsigned long flags;
746
747         /*
748          * Device information, Bus IRQ and name (PCI, SoC)
749          */
750         int irq;
751         const char *name;
752
753         /*
754          * Chipset identification.
755          */
756         struct rt2x00_chip chip;
757
758         /*
759          * hw capability specifications.
760          */
761         struct hw_mode_spec spec;
762
763         /*
764          * This is the default TX/RX antenna setup as indicated
765          * by the device's EEPROM.
766          */
767         struct antenna_setup default_ant;
768
769         /*
770          * Register pointers
771          * csr.base: CSR base register address. (PCI)
772          * csr.cache: CSR cache for usb_control_msg. (USB)
773          */
774         union csr {
775                 void __iomem *base;
776                 void *cache;
777         } csr;
778
779         /*
780          * Mutex to protect register accesses.
781          * For PCI and USB devices it protects against concurrent indirect
782          * register access (BBP, RF, MCU) since accessing those
783          * registers require multiple calls to the CSR registers.
784          * For USB devices it also protects the csr_cache since that
785          * field is used for normal CSR access and it cannot support
786          * multiple callers simultaneously.
787          */
788         struct mutex csr_mutex;
789
790         /*
791          * Current packet filter configuration for the device.
792          * This contains all currently active FIF_* flags send
793          * to us by mac80211 during configure_filter().
794          */
795         unsigned int packet_filter;
796
797         /*
798          * Interface details:
799          *  - Open ap interface count.
800          *  - Open sta interface count.
801          *  - Association count.
802          *  - Beaconing enabled count.
803          */
804         unsigned int intf_ap_count;
805         unsigned int intf_sta_count;
806         unsigned int intf_associated;
807         unsigned int intf_beaconing;
808
809         /*
810          * Link quality
811          */
812         struct link link;
813
814         /*
815          * EEPROM data.
816          */
817         __le16 *eeprom;
818
819         /*
820          * Active RF register values.
821          * These are stored here so we don't need
822          * to read the rf registers and can directly
823          * use this value instead.
824          * This field should be accessed by using
825          * rt2x00_rf_read() and rt2x00_rf_write().
826          */
827         u32 *rf;
828
829         /*
830          * LNA gain
831          */
832         short lna_gain;
833
834         /*
835          * Current TX power value.
836          */
837         u16 tx_power;
838
839         /*
840          * Current retry values.
841          */
842         u8 short_retry;
843         u8 long_retry;
844
845         /*
846          * Rssi <-> Dbm offset
847          */
848         u8 rssi_offset;
849
850         /*
851          * Frequency offset (for rt61pci & rt73usb).
852          */
853         u8 freq_offset;
854
855         /*
856          * Calibration information (for rt2800usb & rt2800pci).
857          * [0] -> BW20
858          * [1] -> BW40
859          */
860         u8 calibration[2];
861
862         /*
863          * Beacon interval.
864          */
865         u16 beacon_int;
866
867         /*
868          * Low level statistics which will have
869          * to be kept up to date while device is running.
870          */
871         struct ieee80211_low_level_stats low_level_stats;
872
873         /**
874          * Work queue for all work which should not be placed
875          * on the mac80211 workqueue (because of dependencies
876          * between various work structures).
877          */
878         struct workqueue_struct *workqueue;
879
880         /*
881          * Scheduled work.
882          * NOTE: intf_work will use ieee80211_iterate_active_interfaces()
883          * which means it cannot be placed on the hw->workqueue
884          * due to RTNL locking requirements.
885          */
886         struct work_struct intf_work;
887
888         /**
889          * Scheduled work for TX/RX done handling (USB devices)
890          */
891         struct work_struct rxdone_work;
892         struct work_struct txdone_work;
893
894         /*
895          * Data queue arrays for RX, TX, Beacon and ATIM.
896          */
897         unsigned int data_queues;
898         struct data_queue *rx;
899         struct data_queue *tx;
900         struct data_queue *bcn;
901         struct data_queue *atim;
902
903         /*
904          * Firmware image.
905          */
906         const struct firmware *fw;
907
908         /*
909          * FIFO for storing tx status reports between isr and tasklet.
910          */
911         DECLARE_KFIFO_PTR(txstatus_fifo, u32);
912
913         /*
914          * Tasklet for processing tx status reports (rt2800pci).
915          */
916         struct tasklet_struct txstatus_tasklet;
917         struct tasklet_struct pretbtt_tasklet;
918         struct tasklet_struct tbtt_tasklet;
919         struct tasklet_struct rxdone_tasklet;
920         struct tasklet_struct autowake_tasklet;
921
922         /*
923          * Protect the interrupt mask register.
924          */
925         spinlock_t irqmask_lock;
926 };
927
928 /*
929  * Register defines.
930  * Some registers require multiple attempts before success,
931  * in those cases REGISTER_BUSY_COUNT attempts should be
932  * taken with a REGISTER_BUSY_DELAY interval.
933  */
934 #define REGISTER_BUSY_COUNT     100
935 #define REGISTER_BUSY_DELAY     100
936
937 /*
938  * Generic RF access.
939  * The RF is being accessed by word index.
940  */
941 static inline void rt2x00_rf_read(struct rt2x00_dev *rt2x00dev,
942                                   const unsigned int word, u32 *data)
943 {
944         BUG_ON(word < 1 || word > rt2x00dev->ops->rf_size / sizeof(u32));
945         *data = rt2x00dev->rf[word - 1];
946 }
947
948 static inline void rt2x00_rf_write(struct rt2x00_dev *rt2x00dev,
949                                    const unsigned int word, u32 data)
950 {
951         BUG_ON(word < 1 || word > rt2x00dev->ops->rf_size / sizeof(u32));
952         rt2x00dev->rf[word - 1] = data;
953 }
954
955 /*
956  *  Generic EEPROM access.
957  * The EEPROM is being accessed by word index.
958  */
959 static inline void *rt2x00_eeprom_addr(struct rt2x00_dev *rt2x00dev,
960                                        const unsigned int word)
961 {
962         return (void *)&rt2x00dev->eeprom[word];
963 }
964
965 static inline void rt2x00_eeprom_read(struct rt2x00_dev *rt2x00dev,
966                                       const unsigned int word, u16 *data)
967 {
968         *data = le16_to_cpu(rt2x00dev->eeprom[word]);
969 }
970
971 static inline void rt2x00_eeprom_write(struct rt2x00_dev *rt2x00dev,
972                                        const unsigned int word, u16 data)
973 {
974         rt2x00dev->eeprom[word] = cpu_to_le16(data);
975 }
976
977 /*
978  * Chipset handlers
979  */
980 static inline void rt2x00_set_chip(struct rt2x00_dev *rt2x00dev,
981                                    const u16 rt, const u16 rf, const u16 rev)
982 {
983         rt2x00dev->chip.rt = rt;
984         rt2x00dev->chip.rf = rf;
985         rt2x00dev->chip.rev = rev;
986
987         INFO(rt2x00dev,
988              "Chipset detected - rt: %04x, rf: %04x, rev: %04x.\n",
989              rt2x00dev->chip.rt, rt2x00dev->chip.rf, rt2x00dev->chip.rev);
990 }
991
992 static inline bool rt2x00_rt(struct rt2x00_dev *rt2x00dev, const u16 rt)
993 {
994         return (rt2x00dev->chip.rt == rt);
995 }
996
997 static inline bool rt2x00_rf(struct rt2x00_dev *rt2x00dev, const u16 rf)
998 {
999         return (rt2x00dev->chip.rf == rf);
1000 }
1001
1002 static inline u16 rt2x00_rev(struct rt2x00_dev *rt2x00dev)
1003 {
1004         return rt2x00dev->chip.rev;
1005 }
1006
1007 static inline bool rt2x00_rt_rev(struct rt2x00_dev *rt2x00dev,
1008                                  const u16 rt, const u16 rev)
1009 {
1010         return (rt2x00_rt(rt2x00dev, rt) && rt2x00_rev(rt2x00dev) == rev);
1011 }
1012
1013 static inline bool rt2x00_rt_rev_lt(struct rt2x00_dev *rt2x00dev,
1014                                     const u16 rt, const u16 rev)
1015 {
1016         return (rt2x00_rt(rt2x00dev, rt) && rt2x00_rev(rt2x00dev) < rev);
1017 }
1018
1019 static inline bool rt2x00_rt_rev_gte(struct rt2x00_dev *rt2x00dev,
1020                                      const u16 rt, const u16 rev)
1021 {
1022         return (rt2x00_rt(rt2x00dev, rt) && rt2x00_rev(rt2x00dev) >= rev);
1023 }
1024
1025 static inline void rt2x00_set_chip_intf(struct rt2x00_dev *rt2x00dev,
1026                                         enum rt2x00_chip_intf intf)
1027 {
1028         rt2x00dev->chip.intf = intf;
1029 }
1030
1031 static inline bool rt2x00_intf(struct rt2x00_dev *rt2x00dev,
1032                                enum rt2x00_chip_intf intf)
1033 {
1034         return (rt2x00dev->chip.intf == intf);
1035 }
1036
1037 static inline bool rt2x00_is_pci(struct rt2x00_dev *rt2x00dev)
1038 {
1039         return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCI) ||
1040                rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCIE);
1041 }
1042
1043 static inline bool rt2x00_is_pcie(struct rt2x00_dev *rt2x00dev)
1044 {
1045         return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCIE);
1046 }
1047
1048 static inline bool rt2x00_is_usb(struct rt2x00_dev *rt2x00dev)
1049 {
1050         return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_USB);
1051 }
1052
1053 static inline bool rt2x00_is_soc(struct rt2x00_dev *rt2x00dev)
1054 {
1055         return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_SOC);
1056 }
1057
1058 /**
1059  * rt2x00queue_map_txskb - Map a skb into DMA for TX purposes.
1060  * @entry: Pointer to &struct queue_entry
1061  */
1062 void rt2x00queue_map_txskb(struct queue_entry *entry);
1063
1064 /**
1065  * rt2x00queue_unmap_skb - Unmap a skb from DMA.
1066  * @entry: Pointer to &struct queue_entry
1067  */
1068 void rt2x00queue_unmap_skb(struct queue_entry *entry);
1069
1070 /**
1071  * rt2x00queue_get_tx_queue - Convert tx queue index to queue pointer
1072  * @rt2x00dev: Pointer to &struct rt2x00_dev.
1073  * @queue: rt2x00 queue index (see &enum data_queue_qid).
1074  *
1075  * Returns NULL for non tx queues.
1076  */
1077 static inline struct data_queue *
1078 rt2x00queue_get_tx_queue(struct rt2x00_dev *rt2x00dev,
1079                          const enum data_queue_qid queue)
1080 {
1081         if (queue < rt2x00dev->ops->tx_queues && rt2x00dev->tx)
1082                 return &rt2x00dev->tx[queue];
1083
1084         if (queue == QID_ATIM)
1085                 return rt2x00dev->atim;
1086
1087         return NULL;
1088 }
1089
1090 /**
1091  * rt2x00queue_get_entry - Get queue entry where the given index points to.
1092  * @queue: Pointer to &struct data_queue from where we obtain the entry.
1093  * @index: Index identifier for obtaining the correct index.
1094  */
1095 struct queue_entry *rt2x00queue_get_entry(struct data_queue *queue,
1096                                           enum queue_index index);
1097
1098 /**
1099  * rt2x00queue_pause_queue - Pause a data queue
1100  * @queue: Pointer to &struct data_queue.
1101  *
1102  * This function will pause the data queue locally, preventing
1103  * new frames to be added to the queue (while the hardware is
1104  * still allowed to run).
1105  */
1106 void rt2x00queue_pause_queue(struct data_queue *queue);
1107
1108 /**
1109  * rt2x00queue_unpause_queue - unpause a data queue
1110  * @queue: Pointer to &struct data_queue.
1111  *
1112  * This function will unpause the data queue locally, allowing
1113  * new frames to be added to the queue again.
1114  */
1115 void rt2x00queue_unpause_queue(struct data_queue *queue);
1116
1117 /**
1118  * rt2x00queue_start_queue - Start a data queue
1119  * @queue: Pointer to &struct data_queue.
1120  *
1121  * This function will start handling all pending frames in the queue.
1122  */
1123 void rt2x00queue_start_queue(struct data_queue *queue);
1124
1125 /**
1126  * rt2x00queue_stop_queue - Halt a data queue
1127  * @queue: Pointer to &struct data_queue.
1128  *
1129  * This function will stop all pending frames in the queue.
1130  */
1131 void rt2x00queue_stop_queue(struct data_queue *queue);
1132
1133 /**
1134  * rt2x00queue_flush_queue - Flush a data queue
1135  * @queue: Pointer to &struct data_queue.
1136  * @drop: True to drop all pending frames.
1137  *
1138  * This function will flush the queue. After this call
1139  * the queue is guarenteed to be empty.
1140  */
1141 void rt2x00queue_flush_queue(struct data_queue *queue, bool drop);
1142
1143 /**
1144  * rt2x00queue_start_queues - Start all data queues
1145  * @rt2x00dev: Pointer to &struct rt2x00_dev.
1146  *
1147  * This function will loop through all available queues to start them
1148  */
1149 void rt2x00queue_start_queues(struct rt2x00_dev *rt2x00dev);
1150
1151 /**
1152  * rt2x00queue_stop_queues - Halt all data queues
1153  * @rt2x00dev: Pointer to &struct rt2x00_dev.
1154  *
1155  * This function will loop through all available queues to stop
1156  * any pending frames.
1157  */
1158 void rt2x00queue_stop_queues(struct rt2x00_dev *rt2x00dev);
1159
1160 /**
1161  * rt2x00queue_flush_queues - Flush all data queues
1162  * @rt2x00dev: Pointer to &struct rt2x00_dev.
1163  * @drop: True to drop all pending frames.
1164  *
1165  * This function will loop through all available queues to flush
1166  * any pending frames.
1167  */
1168 void rt2x00queue_flush_queues(struct rt2x00_dev *rt2x00dev, bool drop);
1169
1170 /*
1171  * Debugfs handlers.
1172  */
1173 /**
1174  * rt2x00debug_dump_frame - Dump a frame to userspace through debugfs.
1175  * @rt2x00dev: Pointer to &struct rt2x00_dev.
1176  * @type: The type of frame that is being dumped.
1177  * @skb: The skb containing the frame to be dumped.
1178  */
1179 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
1180 void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
1181                             enum rt2x00_dump_type type, struct sk_buff *skb);
1182 #else
1183 static inline void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
1184                                           enum rt2x00_dump_type type,
1185                                           struct sk_buff *skb)
1186 {
1187 }
1188 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
1189
1190 /*
1191  * Interrupt context handlers.
1192  */
1193 void rt2x00lib_beacondone(struct rt2x00_dev *rt2x00dev);
1194 void rt2x00lib_pretbtt(struct rt2x00_dev *rt2x00dev);
1195 void rt2x00lib_dmastart(struct queue_entry *entry);
1196 void rt2x00lib_dmadone(struct queue_entry *entry);
1197 void rt2x00lib_txdone(struct queue_entry *entry,
1198                       struct txdone_entry_desc *txdesc);
1199 void rt2x00lib_txdone_noinfo(struct queue_entry *entry, u32 status);
1200 void rt2x00lib_rxdone(struct queue_entry *entry);
1201
1202 /*
1203  * mac80211 handlers.
1204  */
1205 void rt2x00mac_tx(struct ieee80211_hw *hw, struct sk_buff *skb);
1206 int rt2x00mac_start(struct ieee80211_hw *hw);
1207 void rt2x00mac_stop(struct ieee80211_hw *hw);
1208 int rt2x00mac_add_interface(struct ieee80211_hw *hw,
1209                             struct ieee80211_vif *vif);
1210 void rt2x00mac_remove_interface(struct ieee80211_hw *hw,
1211                                 struct ieee80211_vif *vif);
1212 int rt2x00mac_config(struct ieee80211_hw *hw, u32 changed);
1213 void rt2x00mac_configure_filter(struct ieee80211_hw *hw,
1214                                 unsigned int changed_flags,
1215                                 unsigned int *total_flags,
1216                                 u64 multicast);
1217 int rt2x00mac_set_tim(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1218                       bool set);
1219 #ifdef CONFIG_RT2X00_LIB_CRYPTO
1220 int rt2x00mac_set_key(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1221                       struct ieee80211_vif *vif, struct ieee80211_sta *sta,
1222                       struct ieee80211_key_conf *key);
1223 #else
1224 #define rt2x00mac_set_key       NULL
1225 #endif /* CONFIG_RT2X00_LIB_CRYPTO */
1226 void rt2x00mac_sw_scan_start(struct ieee80211_hw *hw);
1227 void rt2x00mac_sw_scan_complete(struct ieee80211_hw *hw);
1228 int rt2x00mac_get_stats(struct ieee80211_hw *hw,
1229                         struct ieee80211_low_level_stats *stats);
1230 void rt2x00mac_bss_info_changed(struct ieee80211_hw *hw,
1231                                 struct ieee80211_vif *vif,
1232                                 struct ieee80211_bss_conf *bss_conf,
1233                                 u32 changes);
1234 int rt2x00mac_conf_tx(struct ieee80211_hw *hw, u16 queue,
1235                       const struct ieee80211_tx_queue_params *params);
1236 void rt2x00mac_rfkill_poll(struct ieee80211_hw *hw);
1237 void rt2x00mac_flush(struct ieee80211_hw *hw, bool drop);
1238
1239 /*
1240  * Driver allocation handlers.
1241  */
1242 int rt2x00lib_probe_dev(struct rt2x00_dev *rt2x00dev);
1243 void rt2x00lib_remove_dev(struct rt2x00_dev *rt2x00dev);
1244 #ifdef CONFIG_PM
1245 int rt2x00lib_suspend(struct rt2x00_dev *rt2x00dev, pm_message_t state);
1246 int rt2x00lib_resume(struct rt2x00_dev *rt2x00dev);
1247 #endif /* CONFIG_PM */
1248
1249 #endif /* RT2X00_H */