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