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