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