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