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