84aaf393da43a06144b838d820e78f3cf866e068
[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
193         u16 rf;
194         u16 rev;
195
196         enum rt2x00_chip_intf intf;
197 };
198
199 /*
200  * RF register values that belong to a particular channel.
201  */
202 struct rf_channel {
203         int channel;
204         u32 rf1;
205         u32 rf2;
206         u32 rf3;
207         u32 rf4;
208 };
209
210 /*
211  * Channel information structure
212  */
213 struct channel_info {
214         unsigned int flags;
215 #define GEOGRAPHY_ALLOWED       0x00000001
216
217         short max_power;
218         short default_power1;
219         short default_power2;
220 };
221
222 /*
223  * Antenna setup values.
224  */
225 struct antenna_setup {
226         enum antenna rx;
227         enum antenna tx;
228 };
229
230 /*
231  * Quality statistics about the currently active link.
232  */
233 struct link_qual {
234         /*
235          * Statistics required for Link tuning by driver
236          * The rssi value is provided by rt2x00lib during the
237          * link_tuner() callback function.
238          * The false_cca field is filled during the link_stats()
239          * callback function and could be used during the
240          * link_tuner() callback function.
241          */
242         int rssi;
243         int false_cca;
244
245         /*
246          * VGC levels
247          * Hardware driver will tune the VGC level during each call
248          * to the link_tuner() callback function. This vgc_level is
249          * is determined based on the link quality statistics like
250          * average RSSI and the false CCA count.
251          *
252          * In some cases the drivers need to differentiate between
253          * the currently "desired" VGC level and the level configured
254          * in the hardware. The latter is important to reduce the
255          * number of BBP register reads to reduce register access
256          * overhead. For this reason we store both values here.
257          */
258         u8 vgc_level;
259         u8 vgc_level_reg;
260
261         /*
262          * Statistics required for Signal quality calculation.
263          * These fields might be changed during the link_stats()
264          * callback function.
265          */
266         int rx_success;
267         int rx_failed;
268         int tx_success;
269         int tx_failed;
270 };
271
272 /*
273  * Antenna settings about the currently active link.
274  */
275 struct link_ant {
276         /*
277          * Antenna flags
278          */
279         unsigned int flags;
280 #define ANTENNA_RX_DIVERSITY    0x00000001
281 #define ANTENNA_TX_DIVERSITY    0x00000002
282 #define ANTENNA_MODE_SAMPLE     0x00000004
283
284         /*
285          * Currently active TX/RX antenna setup.
286          * When software diversity is used, this will indicate
287          * which antenna is actually used at this time.
288          */
289         struct antenna_setup active;
290
291         /*
292          * RSSI history information for the antenna.
293          * Used to determine when to switch antenna
294          * when using software diversity.
295          */
296         int rssi_history;
297
298         /*
299          * Current RSSI average of the currently active antenna.
300          * Similar to the avg_rssi in the link_qual structure
301          * this value is updated by using the walking average.
302          */
303         struct avg_val rssi_ant;
304 };
305
306 /*
307  * To optimize the quality of the link we need to store
308  * the quality of received frames and periodically
309  * optimize the link.
310  */
311 struct link {
312         /*
313          * Link tuner counter
314          * The number of times the link has been tuned
315          * since the radio has been switched on.
316          */
317         u32 count;
318
319         /*
320          * Quality measurement values.
321          */
322         struct link_qual qual;
323
324         /*
325          * TX/RX antenna setup.
326          */
327         struct link_ant ant;
328
329         /*
330          * Currently active average RSSI value
331          */
332         struct avg_val avg_rssi;
333
334         /*
335          * Work structure for scheduling periodic link tuning.
336          */
337         struct delayed_work work;
338
339         /*
340          * Work structure for scheduling periodic watchdog monitoring.
341          * This work must be scheduled on the kernel workqueue, while
342          * all other work structures must be queued on the mac80211
343          * workqueue. This guarantees that the watchdog can schedule
344          * other work structures and wait for their completion in order
345          * to bring the device/driver back into the desired state.
346          */
347         struct delayed_work watchdog_work;
348 };
349
350 enum rt2x00_delayed_flags {
351         DELAYED_UPDATE_BEACON,
352 };
353
354 /*
355  * Interface structure
356  * Per interface configuration details, this structure
357  * is allocated as the private data for ieee80211_vif.
358  */
359 struct rt2x00_intf {
360         /*
361          * beacon->skb must be protected with the mutex.
362          */
363         struct mutex beacon_skb_mutex;
364
365         /*
366          * Entry in the beacon queue which belongs to
367          * this interface. Each interface has its own
368          * dedicated beacon entry.
369          */
370         struct queue_entry *beacon;
371
372         /*
373          * Actions that needed rescheduling.
374          */
375         unsigned long delayed_flags;
376
377         /*
378          * Software sequence counter, this is only required
379          * for hardware which doesn't support hardware
380          * sequence counting.
381          */
382         spinlock_t seqlock;
383         u16 seqno;
384 };
385
386 static inline struct rt2x00_intf* vif_to_intf(struct ieee80211_vif *vif)
387 {
388         return (struct rt2x00_intf *)vif->drv_priv;
389 }
390
391 /**
392  * struct hw_mode_spec: Hardware specifications structure
393  *
394  * Details about the supported modes, rates and channels
395  * of a particular chipset. This is used by rt2x00lib
396  * to build the ieee80211_hw_mode array for mac80211.
397  *
398  * @supported_bands: Bitmask contained the supported bands (2.4GHz, 5.2GHz).
399  * @supported_rates: Rate types which are supported (CCK, OFDM).
400  * @num_channels: Number of supported channels. This is used as array size
401  *      for @tx_power_a, @tx_power_bg and @channels.
402  * @channels: Device/chipset specific channel values (See &struct rf_channel).
403  * @channels_info: Additional information for channels (See &struct channel_info).
404  * @ht: Driver HT Capabilities (See &ieee80211_sta_ht_cap).
405  */
406 struct hw_mode_spec {
407         unsigned int supported_bands;
408 #define SUPPORT_BAND_2GHZ       0x00000001
409 #define SUPPORT_BAND_5GHZ       0x00000002
410
411         unsigned int supported_rates;
412 #define SUPPORT_RATE_CCK        0x00000001
413 #define SUPPORT_RATE_OFDM       0x00000002
414
415         unsigned int num_channels;
416         const struct rf_channel *channels;
417         const struct channel_info *channels_info;
418
419         struct ieee80211_sta_ht_cap ht;
420 };
421
422 /*
423  * Configuration structure wrapper around the
424  * mac80211 configuration structure.
425  * When mac80211 configures the driver, rt2x00lib
426  * can precalculate values which are equal for all
427  * rt2x00 drivers. Those values can be stored in here.
428  */
429 struct rt2x00lib_conf {
430         struct ieee80211_conf *conf;
431
432         struct rf_channel rf;
433         struct channel_info channel;
434 };
435
436 /*
437  * Configuration structure for erp settings.
438  */
439 struct rt2x00lib_erp {
440         int short_preamble;
441         int cts_protection;
442
443         u32 basic_rates;
444
445         int slot_time;
446
447         short sifs;
448         short pifs;
449         short difs;
450         short eifs;
451
452         u16 beacon_int;
453         u16 ht_opmode;
454 };
455
456 /*
457  * Configuration structure for hardware encryption.
458  */
459 struct rt2x00lib_crypto {
460         enum cipher cipher;
461
462         enum set_key_cmd cmd;
463         const u8 *address;
464
465         u32 bssidx;
466         u32 aid;
467
468         u8 key[16];
469         u8 tx_mic[8];
470         u8 rx_mic[8];
471 };
472
473 /*
474  * Configuration structure wrapper around the
475  * rt2x00 interface configuration handler.
476  */
477 struct rt2x00intf_conf {
478         /*
479          * Interface type
480          */
481         enum nl80211_iftype type;
482
483         /*
484          * TSF sync value, this is dependant on the operation type.
485          */
486         enum tsf_sync sync;
487
488         /*
489          * The MAC and BSSID addressess are simple array of bytes,
490          * these arrays are little endian, so when sending the addressess
491          * to the drivers, copy the it into a endian-signed variable.
492          *
493          * Note that all devices (except rt2500usb) have 32 bits
494          * register word sizes. This means that whatever variable we
495          * pass _must_ be a multiple of 32 bits. Otherwise the device
496          * might not accept what we are sending to it.
497          * This will also make it easier for the driver to write
498          * the data to the device.
499          */
500         __le32 mac[2];
501         __le32 bssid[2];
502 };
503
504 /*
505  * rt2x00lib callback functions.
506  */
507 struct rt2x00lib_ops {
508         /*
509          * Interrupt handlers.
510          */
511         irq_handler_t irq_handler;
512
513         /*
514          * Threaded Interrupt handlers.
515          */
516         irq_handler_t irq_handler_thread;
517
518         /*
519          * TX status tasklet handler.
520          */
521         void (*txstatus_tasklet) (unsigned long data);
522
523         /*
524          * Device init handlers.
525          */
526         int (*probe_hw) (struct rt2x00_dev *rt2x00dev);
527         char *(*get_firmware_name) (struct rt2x00_dev *rt2x00dev);
528         int (*check_firmware) (struct rt2x00_dev *rt2x00dev,
529                                const u8 *data, const size_t len);
530         int (*load_firmware) (struct rt2x00_dev *rt2x00dev,
531                               const u8 *data, const size_t len);
532
533         /*
534          * Device initialization/deinitialization handlers.
535          */
536         int (*initialize) (struct rt2x00_dev *rt2x00dev);
537         void (*uninitialize) (struct rt2x00_dev *rt2x00dev);
538
539         /*
540          * queue initialization handlers
541          */
542         bool (*get_entry_state) (struct queue_entry *entry);
543         void (*clear_entry) (struct queue_entry *entry);
544
545         /*
546          * Radio control handlers.
547          */
548         int (*set_device_state) (struct rt2x00_dev *rt2x00dev,
549                                  enum dev_state state);
550         int (*rfkill_poll) (struct rt2x00_dev *rt2x00dev);
551         void (*link_stats) (struct rt2x00_dev *rt2x00dev,
552                             struct link_qual *qual);
553         void (*reset_tuner) (struct rt2x00_dev *rt2x00dev,
554                              struct link_qual *qual);
555         void (*link_tuner) (struct rt2x00_dev *rt2x00dev,
556                             struct link_qual *qual, const u32 count);
557
558         /*
559          * Data queue handlers.
560          */
561         void (*watchdog) (struct rt2x00_dev *rt2x00dev);
562         void (*start_queue) (struct data_queue *queue);
563         void (*kick_queue) (struct data_queue *queue);
564         void (*stop_queue) (struct data_queue *queue);
565         void (*flush_queue) (struct data_queue *queue);
566
567         /*
568          * TX control handlers
569          */
570         void (*write_tx_desc) (struct queue_entry *entry,
571                                struct txentry_desc *txdesc);
572         void (*write_tx_data) (struct queue_entry *entry,
573                                struct txentry_desc *txdesc);
574         void (*write_beacon) (struct queue_entry *entry,
575                               struct txentry_desc *txdesc);
576         int (*get_tx_data_len) (struct queue_entry *entry);
577
578         /*
579          * RX control handlers
580          */
581         void (*fill_rxdone) (struct queue_entry *entry,
582                              struct rxdone_entry_desc *rxdesc);
583
584         /*
585          * Configuration handlers.
586          */
587         int (*config_shared_key) (struct rt2x00_dev *rt2x00dev,
588                                   struct rt2x00lib_crypto *crypto,
589                                   struct ieee80211_key_conf *key);
590         int (*config_pairwise_key) (struct rt2x00_dev *rt2x00dev,
591                                     struct rt2x00lib_crypto *crypto,
592                                     struct ieee80211_key_conf *key);
593         void (*config_filter) (struct rt2x00_dev *rt2x00dev,
594                                const unsigned int filter_flags);
595         void (*config_intf) (struct rt2x00_dev *rt2x00dev,
596                              struct rt2x00_intf *intf,
597                              struct rt2x00intf_conf *conf,
598                              const unsigned int flags);
599 #define CONFIG_UPDATE_TYPE              ( 1 << 1 )
600 #define CONFIG_UPDATE_MAC               ( 1 << 2 )
601 #define CONFIG_UPDATE_BSSID             ( 1 << 3 )
602
603         void (*config_erp) (struct rt2x00_dev *rt2x00dev,
604                             struct rt2x00lib_erp *erp,
605                             u32 changed);
606         void (*config_ant) (struct rt2x00_dev *rt2x00dev,
607                             struct antenna_setup *ant);
608         void (*config) (struct rt2x00_dev *rt2x00dev,
609                         struct rt2x00lib_conf *libconf,
610                         const unsigned int changed_flags);
611 };
612
613 /*
614  * rt2x00 driver callback operation structure.
615  */
616 struct rt2x00_ops {
617         const char *name;
618         const unsigned int max_sta_intf;
619         const unsigned int max_ap_intf;
620         const unsigned int eeprom_size;
621         const unsigned int rf_size;
622         const unsigned int tx_queues;
623         const unsigned int extra_tx_headroom;
624         const struct data_queue_desc *rx;
625         const struct data_queue_desc *tx;
626         const struct data_queue_desc *bcn;
627         const struct data_queue_desc *atim;
628         const struct rt2x00lib_ops *lib;
629         const void *drv;
630         const struct ieee80211_ops *hw;
631 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
632         const struct rt2x00debug *debugfs;
633 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
634 };
635
636 /*
637  * rt2x00 device flags
638  */
639 enum rt2x00_flags {
640         /*
641          * Device state flags
642          */
643         DEVICE_STATE_PRESENT,
644         DEVICE_STATE_REGISTERED_HW,
645         DEVICE_STATE_INITIALIZED,
646         DEVICE_STATE_STARTED,
647         DEVICE_STATE_ENABLED_RADIO,
648         DEVICE_STATE_SCANNING,
649
650         /*
651          * Driver requirements
652          */
653         DRIVER_REQUIRE_FIRMWARE,
654         DRIVER_REQUIRE_BEACON_GUARD,
655         DRIVER_REQUIRE_ATIM_QUEUE,
656         DRIVER_REQUIRE_DMA,
657         DRIVER_REQUIRE_COPY_IV,
658         DRIVER_REQUIRE_L2PAD,
659         DRIVER_REQUIRE_TXSTATUS_FIFO,
660         DRIVER_REQUIRE_TASKLET_CONTEXT,
661
662         /*
663          * Driver features
664          */
665         CONFIG_SUPPORT_HW_BUTTON,
666         CONFIG_SUPPORT_HW_CRYPTO,
667         DRIVER_SUPPORT_CONTROL_FILTERS,
668         DRIVER_SUPPORT_CONTROL_FILTER_PSPOLL,
669         DRIVER_SUPPORT_PRE_TBTT_INTERRUPT,
670         DRIVER_SUPPORT_LINK_TUNING,
671         DRIVER_SUPPORT_WATCHDOG,
672
673         /*
674          * Driver configuration
675          */
676         CONFIG_FRAME_TYPE,
677         CONFIG_RF_SEQUENCE,
678         CONFIG_EXTERNAL_LNA_A,
679         CONFIG_EXTERNAL_LNA_BG,
680         CONFIG_DOUBLE_ANTENNA,
681         CONFIG_CHANNEL_HT40,
682 };
683
684 /*
685  * rt2x00 device structure.
686  */
687 struct rt2x00_dev {
688         /*
689          * Device structure.
690          * The structure stored in here depends on the
691          * system bus (PCI or USB).
692          * When accessing this variable, the rt2x00dev_{pci,usb}
693          * macros should be used for correct typecasting.
694          */
695         struct device *dev;
696
697         /*
698          * Callback functions.
699          */
700         const struct rt2x00_ops *ops;
701
702         /*
703          * IEEE80211 control structure.
704          */
705         struct ieee80211_hw *hw;
706         struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
707         enum ieee80211_band curr_band;
708         int curr_freq;
709
710         /*
711          * If enabled, the debugfs interface structures
712          * required for deregistration of debugfs.
713          */
714 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
715         struct rt2x00debug_intf *debugfs_intf;
716 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
717
718         /*
719          * LED structure for changing the LED status
720          * by mac8011 or the kernel.
721          */
722 #ifdef CONFIG_RT2X00_LIB_LEDS
723         struct rt2x00_led led_radio;
724         struct rt2x00_led led_assoc;
725         struct rt2x00_led led_qual;
726         u16 led_mcu_reg;
727 #endif /* CONFIG_RT2X00_LIB_LEDS */
728
729         /*
730          * Device flags.
731          * In these flags the current status and some
732          * of the device capabilities are stored.
733          */
734         unsigned long flags;
735
736         /*
737          * Device information, Bus IRQ and name (PCI, SoC)
738          */
739         int irq;
740         const char *name;
741
742         /*
743          * Chipset identification.
744          */
745         struct rt2x00_chip chip;
746
747         /*
748          * hw capability specifications.
749          */
750         struct hw_mode_spec spec;
751
752         /*
753          * This is the default TX/RX antenna setup as indicated
754          * by the device's EEPROM.
755          */
756         struct antenna_setup default_ant;
757
758         /*
759          * Register pointers
760          * csr.base: CSR base register address. (PCI)
761          * csr.cache: CSR cache for usb_control_msg. (USB)
762          */
763         union csr {
764                 void __iomem *base;
765                 void *cache;
766         } csr;
767
768         /*
769          * Mutex to protect register accesses.
770          * For PCI and USB devices it protects against concurrent indirect
771          * register access (BBP, RF, MCU) since accessing those
772          * registers require multiple calls to the CSR registers.
773          * For USB devices it also protects the csr_cache since that
774          * field is used for normal CSR access and it cannot support
775          * multiple callers simultaneously.
776          */
777         struct mutex csr_mutex;
778
779         /*
780          * Current packet filter configuration for the device.
781          * This contains all currently active FIF_* flags send
782          * to us by mac80211 during configure_filter().
783          */
784         unsigned int packet_filter;
785
786         /*
787          * Interface details:
788          *  - Open ap interface count.
789          *  - Open sta interface count.
790          *  - Association count.
791          */
792         unsigned int intf_ap_count;
793         unsigned int intf_sta_count;
794         unsigned int intf_associated;
795
796         /*
797          * Link quality
798          */
799         struct link link;
800
801         /*
802          * EEPROM data.
803          */
804         __le16 *eeprom;
805
806         /*
807          * Active RF register values.
808          * These are stored here so we don't need
809          * to read the rf registers and can directly
810          * use this value instead.
811          * This field should be accessed by using
812          * rt2x00_rf_read() and rt2x00_rf_write().
813          */
814         u32 *rf;
815
816         /*
817          * LNA gain
818          */
819         short lna_gain;
820
821         /*
822          * Current TX power value.
823          */
824         u16 tx_power;
825
826         /*
827          * Current retry values.
828          */
829         u8 short_retry;
830         u8 long_retry;
831
832         /*
833          * Rssi <-> Dbm offset
834          */
835         u8 rssi_offset;
836
837         /*
838          * Frequency offset (for rt61pci & rt73usb).
839          */
840         u8 freq_offset;
841
842         /*
843          * Calibration information (for rt2800usb & rt2800pci).
844          * [0] -> BW20
845          * [1] -> BW40
846          */
847         u8 calibration[2];
848
849         /*
850          * Beacon interval.
851          */
852         u16 beacon_int;
853
854         /*
855          * Low level statistics which will have
856          * to be kept up to date while device is running.
857          */
858         struct ieee80211_low_level_stats low_level_stats;
859
860         /*
861          * Scheduled work.
862          * NOTE: intf_work will use ieee80211_iterate_active_interfaces()
863          * which means it cannot be placed on the hw->workqueue
864          * due to RTNL locking requirements.
865          */
866         struct work_struct intf_work;
867
868         /**
869          * Scheduled work for TX/RX done handling (USB devices)
870          */
871         struct work_struct rxdone_work;
872         struct work_struct txdone_work;
873
874         /*
875          * Data queue arrays for RX, TX and Beacon.
876          * The Beacon array also contains the Atim queue
877          * if that is supported by the device.
878          */
879         unsigned int data_queues;
880         struct data_queue *rx;
881         struct data_queue *tx;
882         struct data_queue *bcn;
883
884         /*
885          * Firmware image.
886          */
887         const struct firmware *fw;
888
889         /*
890          * Interrupt values, stored between interrupt service routine
891          * and interrupt thread routine.
892          */
893         u32 irqvalue[2];
894
895         /*
896          * FIFO for storing tx status reports between isr and tasklet.
897          */
898         DECLARE_KFIFO_PTR(txstatus_fifo, u32);
899
900         /*
901          * Tasklet for processing tx status reports (rt2800pci).
902          */
903         struct tasklet_struct txstatus_tasklet;
904 };
905
906 /*
907  * Register defines.
908  * Some registers require multiple attempts before success,
909  * in those cases REGISTER_BUSY_COUNT attempts should be
910  * taken with a REGISTER_BUSY_DELAY interval.
911  */
912 #define REGISTER_BUSY_COUNT     100
913 #define REGISTER_BUSY_DELAY     100
914
915 /*
916  * Generic RF access.
917  * The RF is being accessed by word index.
918  */
919 static inline void rt2x00_rf_read(struct rt2x00_dev *rt2x00dev,
920                                   const unsigned int word, u32 *data)
921 {
922         BUG_ON(word < 1 || word > rt2x00dev->ops->rf_size / sizeof(u32));
923         *data = rt2x00dev->rf[word - 1];
924 }
925
926 static inline void rt2x00_rf_write(struct rt2x00_dev *rt2x00dev,
927                                    const unsigned int word, u32 data)
928 {
929         BUG_ON(word < 1 || word > rt2x00dev->ops->rf_size / sizeof(u32));
930         rt2x00dev->rf[word - 1] = data;
931 }
932
933 /*
934  *  Generic EEPROM access.
935  * The EEPROM is being accessed by word index.
936  */
937 static inline void *rt2x00_eeprom_addr(struct rt2x00_dev *rt2x00dev,
938                                        const unsigned int word)
939 {
940         return (void *)&rt2x00dev->eeprom[word];
941 }
942
943 static inline void rt2x00_eeprom_read(struct rt2x00_dev *rt2x00dev,
944                                       const unsigned int word, u16 *data)
945 {
946         *data = le16_to_cpu(rt2x00dev->eeprom[word]);
947 }
948
949 static inline void rt2x00_eeprom_write(struct rt2x00_dev *rt2x00dev,
950                                        const unsigned int word, u16 data)
951 {
952         rt2x00dev->eeprom[word] = cpu_to_le16(data);
953 }
954
955 /*
956  * Chipset handlers
957  */
958 static inline void rt2x00_set_chip(struct rt2x00_dev *rt2x00dev,
959                                    const u16 rt, const u16 rf, const u16 rev)
960 {
961         rt2x00dev->chip.rt = rt;
962         rt2x00dev->chip.rf = rf;
963         rt2x00dev->chip.rev = rev;
964
965         INFO(rt2x00dev,
966              "Chipset detected - rt: %04x, rf: %04x, rev: %04x.\n",
967              rt2x00dev->chip.rt, rt2x00dev->chip.rf, rt2x00dev->chip.rev);
968 }
969
970 static inline bool rt2x00_rt(struct rt2x00_dev *rt2x00dev, const u16 rt)
971 {
972         return (rt2x00dev->chip.rt == rt);
973 }
974
975 static inline bool rt2x00_rf(struct rt2x00_dev *rt2x00dev, const u16 rf)
976 {
977         return (rt2x00dev->chip.rf == rf);
978 }
979
980 static inline u16 rt2x00_rev(struct rt2x00_dev *rt2x00dev)
981 {
982         return rt2x00dev->chip.rev;
983 }
984
985 static inline bool rt2x00_rt_rev(struct rt2x00_dev *rt2x00dev,
986                                  const u16 rt, const u16 rev)
987 {
988         return (rt2x00_rt(rt2x00dev, rt) && rt2x00_rev(rt2x00dev) == rev);
989 }
990
991 static inline bool rt2x00_rt_rev_lt(struct rt2x00_dev *rt2x00dev,
992                                     const u16 rt, const u16 rev)
993 {
994         return (rt2x00_rt(rt2x00dev, rt) && rt2x00_rev(rt2x00dev) < rev);
995 }
996
997 static inline bool rt2x00_rt_rev_gte(struct rt2x00_dev *rt2x00dev,
998                                      const u16 rt, const u16 rev)
999 {
1000         return (rt2x00_rt(rt2x00dev, rt) && rt2x00_rev(rt2x00dev) >= rev);
1001 }
1002
1003 static inline void rt2x00_set_chip_intf(struct rt2x00_dev *rt2x00dev,
1004                                         enum rt2x00_chip_intf intf)
1005 {
1006         rt2x00dev->chip.intf = intf;
1007 }
1008
1009 static inline bool rt2x00_intf(struct rt2x00_dev *rt2x00dev,
1010                                enum rt2x00_chip_intf intf)
1011 {
1012         return (rt2x00dev->chip.intf == intf);
1013 }
1014
1015 static inline bool rt2x00_is_pci(struct rt2x00_dev *rt2x00dev)
1016 {
1017         return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCI) ||
1018                rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCIE);
1019 }
1020
1021 static inline bool rt2x00_is_pcie(struct rt2x00_dev *rt2x00dev)
1022 {
1023         return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCIE);
1024 }
1025
1026 static inline bool rt2x00_is_usb(struct rt2x00_dev *rt2x00dev)
1027 {
1028         return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_USB);
1029 }
1030
1031 static inline bool rt2x00_is_soc(struct rt2x00_dev *rt2x00dev)
1032 {
1033         return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_SOC);
1034 }
1035
1036 /**
1037  * rt2x00queue_map_txskb - Map a skb into DMA for TX purposes.
1038  * @entry: Pointer to &struct queue_entry
1039  */
1040 void rt2x00queue_map_txskb(struct queue_entry *entry);
1041
1042 /**
1043  * rt2x00queue_unmap_skb - Unmap a skb from DMA.
1044  * @entry: Pointer to &struct queue_entry
1045  */
1046 void rt2x00queue_unmap_skb(struct queue_entry *entry);
1047
1048 /**
1049  * rt2x00queue_get_queue - Convert queue index to queue pointer
1050  * @rt2x00dev: Pointer to &struct rt2x00_dev.
1051  * @queue: rt2x00 queue index (see &enum data_queue_qid).
1052  */
1053 struct data_queue *rt2x00queue_get_queue(struct rt2x00_dev *rt2x00dev,
1054                                          const enum data_queue_qid queue);
1055
1056 /**
1057  * rt2x00queue_get_entry - Get queue entry where the given index points to.
1058  * @queue: Pointer to &struct data_queue from where we obtain the entry.
1059  * @index: Index identifier for obtaining the correct index.
1060  */
1061 struct queue_entry *rt2x00queue_get_entry(struct data_queue *queue,
1062                                           enum queue_index index);
1063
1064 /**
1065  * rt2x00queue_pause_queue - Pause a data queue
1066  * @queue: Pointer to &struct data_queue.
1067  *
1068  * This function will pause the data queue locally, preventing
1069  * new frames to be added to the queue (while the hardware is
1070  * still allowed to run).
1071  */
1072 void rt2x00queue_pause_queue(struct data_queue *queue);
1073
1074 /**
1075  * rt2x00queue_unpause_queue - unpause a data queue
1076  * @queue: Pointer to &struct data_queue.
1077  *
1078  * This function will unpause the data queue locally, allowing
1079  * new frames to be added to the queue again.
1080  */
1081 void rt2x00queue_unpause_queue(struct data_queue *queue);
1082
1083 /**
1084  * rt2x00queue_start_queue - Start a data queue
1085  * @queue: Pointer to &struct data_queue.
1086  *
1087  * This function will start handling all pending frames in the queue.
1088  */
1089 void rt2x00queue_start_queue(struct data_queue *queue);
1090
1091 /**
1092  * rt2x00queue_stop_queue - Halt a data queue
1093  * @queue: Pointer to &struct data_queue.
1094  *
1095  * This function will stop all pending frames in the queue.
1096  */
1097 void rt2x00queue_stop_queue(struct data_queue *queue);
1098
1099 /**
1100  * rt2x00queue_flush_queue - Flush a data queue
1101  * @queue: Pointer to &struct data_queue.
1102  * @drop: True to drop all pending frames.
1103  *
1104  * This function will flush the queue. After this call
1105  * the queue is guarenteed to be empty.
1106  */
1107 void rt2x00queue_flush_queue(struct data_queue *queue, bool drop);
1108
1109 /**
1110  * rt2x00queue_start_queues - Start all data queues
1111  * @rt2x00dev: Pointer to &struct rt2x00_dev.
1112  *
1113  * This function will loop through all available queues to start them
1114  */
1115 void rt2x00queue_start_queues(struct rt2x00_dev *rt2x00dev);
1116
1117 /**
1118  * rt2x00queue_stop_queues - Halt all data queues
1119  * @rt2x00dev: Pointer to &struct rt2x00_dev.
1120  *
1121  * This function will loop through all available queues to stop
1122  * any pending frames.
1123  */
1124 void rt2x00queue_stop_queues(struct rt2x00_dev *rt2x00dev);
1125
1126 /**
1127  * rt2x00queue_flush_queues - Flush all data queues
1128  * @rt2x00dev: Pointer to &struct rt2x00_dev.
1129  * @drop: True to drop all pending frames.
1130  *
1131  * This function will loop through all available queues to flush
1132  * any pending frames.
1133  */
1134 void rt2x00queue_flush_queues(struct rt2x00_dev *rt2x00dev, bool drop);
1135
1136 /*
1137  * Debugfs handlers.
1138  */
1139 /**
1140  * rt2x00debug_dump_frame - Dump a frame to userspace through debugfs.
1141  * @rt2x00dev: Pointer to &struct rt2x00_dev.
1142  * @type: The type of frame that is being dumped.
1143  * @skb: The skb containing the frame to be dumped.
1144  */
1145 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
1146 void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
1147                             enum rt2x00_dump_type type, struct sk_buff *skb);
1148 #else
1149 static inline void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
1150                                           enum rt2x00_dump_type type,
1151                                           struct sk_buff *skb)
1152 {
1153 }
1154 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
1155
1156 /*
1157  * Interrupt context handlers.
1158  */
1159 void rt2x00lib_beacondone(struct rt2x00_dev *rt2x00dev);
1160 void rt2x00lib_pretbtt(struct rt2x00_dev *rt2x00dev);
1161 void rt2x00lib_dmastart(struct queue_entry *entry);
1162 void rt2x00lib_dmadone(struct queue_entry *entry);
1163 void rt2x00lib_txdone(struct queue_entry *entry,
1164                       struct txdone_entry_desc *txdesc);
1165 void rt2x00lib_txdone_noinfo(struct queue_entry *entry, u32 status);
1166 void rt2x00lib_rxdone(struct queue_entry *entry);
1167
1168 /*
1169  * mac80211 handlers.
1170  */
1171 int rt2x00mac_tx(struct ieee80211_hw *hw, struct sk_buff *skb);
1172 int rt2x00mac_start(struct ieee80211_hw *hw);
1173 void rt2x00mac_stop(struct ieee80211_hw *hw);
1174 int rt2x00mac_add_interface(struct ieee80211_hw *hw,
1175                             struct ieee80211_vif *vif);
1176 void rt2x00mac_remove_interface(struct ieee80211_hw *hw,
1177                                 struct ieee80211_vif *vif);
1178 int rt2x00mac_config(struct ieee80211_hw *hw, u32 changed);
1179 void rt2x00mac_configure_filter(struct ieee80211_hw *hw,
1180                                 unsigned int changed_flags,
1181                                 unsigned int *total_flags,
1182                                 u64 multicast);
1183 int rt2x00mac_set_tim(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1184                       bool set);
1185 #ifdef CONFIG_RT2X00_LIB_CRYPTO
1186 int rt2x00mac_set_key(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1187                       struct ieee80211_vif *vif, struct ieee80211_sta *sta,
1188                       struct ieee80211_key_conf *key);
1189 #else
1190 #define rt2x00mac_set_key       NULL
1191 #endif /* CONFIG_RT2X00_LIB_CRYPTO */
1192 void rt2x00mac_sw_scan_start(struct ieee80211_hw *hw);
1193 void rt2x00mac_sw_scan_complete(struct ieee80211_hw *hw);
1194 int rt2x00mac_get_stats(struct ieee80211_hw *hw,
1195                         struct ieee80211_low_level_stats *stats);
1196 void rt2x00mac_bss_info_changed(struct ieee80211_hw *hw,
1197                                 struct ieee80211_vif *vif,
1198                                 struct ieee80211_bss_conf *bss_conf,
1199                                 u32 changes);
1200 int rt2x00mac_conf_tx(struct ieee80211_hw *hw, u16 queue,
1201                       const struct ieee80211_tx_queue_params *params);
1202 void rt2x00mac_rfkill_poll(struct ieee80211_hw *hw);
1203 void rt2x00mac_flush(struct ieee80211_hw *hw, bool drop);
1204
1205 /*
1206  * Driver allocation handlers.
1207  */
1208 int rt2x00lib_probe_dev(struct rt2x00_dev *rt2x00dev);
1209 void rt2x00lib_remove_dev(struct rt2x00_dev *rt2x00dev);
1210 #ifdef CONFIG_PM
1211 int rt2x00lib_suspend(struct rt2x00_dev *rt2x00dev, pm_message_t state);
1212 int rt2x00lib_resume(struct rt2x00_dev *rt2x00dev);
1213 #endif /* CONFIG_PM */
1214
1215 #endif /* RT2X00_H */