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>
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.
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.
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.
25 Abstract: rt2x00 global information.
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>
43 #include <net/mac80211.h>
45 #include "rt2x00debug.h"
46 #include "rt2x00dump.h"
47 #include "rt2x00leds.h"
48 #include "rt2x00reg.h"
49 #include "rt2x00queue.h"
54 #define DRV_VERSION "2.3.0"
55 #define DRV_PROJECT "http://rt2x00.serialmonkey.com"
59 * Debug output has to be enabled during compile time.
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)
65 #define DEBUG_PRINTK_PROBE(__kernlvl, __lvl, __msg, __args...) \
66 printk(__kernlvl "%s -> %s: %s - " __msg, \
67 KBUILD_MODNAME, __func__, __lvl, ##__args)
69 #ifdef CONFIG_RT2X00_DEBUG
70 #define DEBUG_PRINTK(__dev, __kernlvl, __lvl, __msg, __args...) \
71 DEBUG_PRINTK_MSG(__dev, __kernlvl, __lvl, __msg, ##__args)
73 #define DEBUG_PRINTK(__dev, __kernlvl, __lvl, __msg, __args...) \
75 #endif /* CONFIG_RT2X00_DEBUG */
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.
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)
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.
108 #define GET_DURATION(__size, __rate) (((__size) * 8 * 10) / (__rate))
109 #define GET_DURATION_RES(__size, __rate)(((__size) * 8 * 10) % (__rate))
112 * Determine the number of L2 padding bytes required between the header and
115 #define L2PAD_SIZE(__hdrlen) (-(__hdrlen) & 3)
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.
123 #define ALIGN_SIZE(__skb, __header) \
124 ( ((unsigned long)((__skb)->data + (__header))) & 3 )
127 * Constants for extra TX headroom for alignment purposes.
129 #define RT2X00_ALIGN_SIZE 4 /* Only whole frame needs alignment */
130 #define RT2X00_L2PAD_SIZE 8 /* Both header & payload need alignment */
133 * Standard timing and size defines.
134 * These values should follow the ieee80211 specifications.
137 #define IEEE80211_HEADER 24
141 #define SHORT_PREAMBLE 72
143 #define SHORT_SLOT_TIME 9
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) )
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.
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,
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.
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 */
200 enum rt2x00_chip_intf intf;
204 * RF register values that belong to a particular channel.
215 * Channel information structure
217 struct channel_info {
219 #define GEOGRAPHY_ALLOWED 0x00000001
222 short default_power1;
223 short default_power2;
227 * Antenna setup values.
229 struct antenna_setup {
237 * Quality statistics about the currently active link.
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.
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.
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.
268 * Statistics required for Signal quality calculation.
269 * These fields might be changed during the link_stats()
279 * Antenna settings about the currently active link.
286 #define ANTENNA_RX_DIVERSITY 0x00000001
287 #define ANTENNA_TX_DIVERSITY 0x00000002
288 #define ANTENNA_MODE_SAMPLE 0x00000004
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.
295 struct antenna_setup active;
298 * RSSI history information for the antenna.
299 * Used to determine when to switch antenna
300 * when using software diversity.
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.
309 struct avg_val rssi_ant;
313 * To optimize the quality of the link we need to store
314 * the quality of received frames and periodically
320 * The number of times the link has been tuned
321 * since the radio has been switched on.
326 * Quality measurement values.
328 struct link_qual qual;
331 * TX/RX antenna setup.
336 * Currently active average RSSI value
338 struct avg_val avg_rssi;
341 * Work structure for scheduling periodic link tuning.
343 struct delayed_work work;
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.
353 struct delayed_work watchdog_work;
356 * Work structure for scheduling periodic AGC adjustments.
358 struct delayed_work agc_work;
361 * Work structure for scheduling periodic VCO calibration.
363 struct delayed_work vco_work;
366 enum rt2x00_delayed_flags {
367 DELAYED_UPDATE_BEACON,
371 * Interface structure
372 * Per interface configuration details, this structure
373 * is allocated as the private data for ieee80211_vif.
377 * beacon->skb must be protected with the mutex.
379 struct mutex beacon_skb_mutex;
382 * Entry in the beacon queue which belongs to
383 * this interface. Each interface has its own
384 * dedicated beacon entry.
386 struct queue_entry *beacon;
390 * Actions that needed rescheduling.
392 unsigned long delayed_flags;
395 * Software sequence counter, this is only required
396 * for hardware which doesn't support hardware
403 static inline struct rt2x00_intf* vif_to_intf(struct ieee80211_vif *vif)
405 return (struct rt2x00_intf *)vif->drv_priv;
409 * struct hw_mode_spec: Hardware specifications structure
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.
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).
423 struct hw_mode_spec {
424 unsigned int supported_bands;
425 #define SUPPORT_BAND_2GHZ 0x00000001
426 #define SUPPORT_BAND_5GHZ 0x00000002
428 unsigned int supported_rates;
429 #define SUPPORT_RATE_CCK 0x00000001
430 #define SUPPORT_RATE_OFDM 0x00000002
432 unsigned int num_channels;
433 const struct rf_channel *channels;
434 const struct channel_info *channels_info;
436 struct ieee80211_sta_ht_cap ht;
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.
446 struct rt2x00lib_conf {
447 struct ieee80211_conf *conf;
449 struct rf_channel rf;
450 struct channel_info channel;
454 * Configuration structure for erp settings.
456 struct rt2x00lib_erp {
474 * Configuration structure for hardware encryption.
476 struct rt2x00lib_crypto {
479 enum set_key_cmd cmd;
492 * Configuration structure wrapper around the
493 * rt2x00 interface configuration handler.
495 struct rt2x00intf_conf {
499 enum nl80211_iftype type;
502 * TSF sync value, this is dependent on the operation type.
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.
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.
523 * Private structure for storing STA details
524 * wcid: Wireless Client ID
530 static inline struct rt2x00_sta* sta_to_rt2x00_sta(struct ieee80211_sta *sta)
532 return (struct rt2x00_sta *)sta->drv_priv;
536 * rt2x00lib callback functions.
538 struct rt2x00lib_ops {
540 * Interrupt handlers.
542 irq_handler_t irq_handler;
545 * TX status tasklet handler.
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);
554 * Device init handlers.
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);
564 * Device initialization/deinitialization handlers.
566 int (*initialize) (struct rt2x00_dev *rt2x00dev);
567 void (*uninitialize) (struct rt2x00_dev *rt2x00dev);
570 * queue initialization handlers
572 bool (*get_entry_state) (struct queue_entry *entry);
573 void (*clear_entry) (struct queue_entry *entry);
576 * Radio control handlers.
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);
591 * Data queue handlers.
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);
601 * TX control handlers
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);
613 * RX control handlers
615 void (*fill_rxdone) (struct queue_entry *entry,
616 struct rxdone_entry_desc *rxdesc);
619 * Configuration handlers.
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 )
637 void (*config_erp) (struct rt2x00_dev *rt2x00dev,
638 struct rt2x00lib_erp *erp,
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,
653 * rt2x00 driver callback operation structure.
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;
670 const struct ieee80211_ops *hw;
671 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
672 const struct rt2x00debug *debugfs;
673 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
679 enum rt2x00_state_flags {
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,
691 * Driver configuration
698 * rt2x00 capability flags
700 enum rt2x00_capability_flags {
705 REQUIRE_BEACON_GUARD,
710 REQUIRE_TXSTATUS_FIFO,
711 REQUIRE_TASKLET_CONTEXT,
719 CAPABILITY_HW_BUTTON,
720 CAPABILITY_HW_CRYPTO,
721 CAPABILITY_POWER_LIMIT,
722 CAPABILITY_CONTROL_FILTERS,
723 CAPABILITY_CONTROL_FILTER_PSPOLL,
724 CAPABILITY_PRE_TBTT_INTERRUPT,
725 CAPABILITY_LINK_TUNING,
726 CAPABILITY_FRAME_TYPE,
727 CAPABILITY_RF_SEQUENCE,
728 CAPABILITY_EXTERNAL_LNA_A,
729 CAPABILITY_EXTERNAL_LNA_BG,
730 CAPABILITY_DOUBLE_ANTENNA,
731 CAPABILITY_BT_COEXIST,
732 CAPABILITY_VCO_RECALIBRATION,
736 * rt2x00 device structure.
741 * The structure stored in here depends on the
742 * system bus (PCI or USB).
743 * When accessing this variable, the rt2x00dev_{pci,usb}
744 * macros should be used for correct typecasting.
749 * Callback functions.
751 const struct rt2x00_ops *ops;
759 * IEEE80211 control structure.
761 struct ieee80211_hw *hw;
762 struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
763 enum ieee80211_band curr_band;
767 * If enabled, the debugfs interface structures
768 * required for deregistration of debugfs.
770 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
771 struct rt2x00debug_intf *debugfs_intf;
772 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
775 * LED structure for changing the LED status
776 * by mac8011 or the kernel.
778 #ifdef CONFIG_RT2X00_LIB_LEDS
779 struct rt2x00_led led_radio;
780 struct rt2x00_led led_assoc;
781 struct rt2x00_led led_qual;
783 #endif /* CONFIG_RT2X00_LIB_LEDS */
786 * Device state flags.
787 * In these flags the current status is stored.
788 * Access to these flags should occur atomically.
793 * Device capabiltiy flags.
794 * In these flags the device/driver capabilities are stored.
795 * Access to these flags should occur non-atomically.
797 unsigned long cap_flags;
800 * Device information, Bus IRQ and name (PCI, SoC)
806 * Chipset identification.
808 struct rt2x00_chip chip;
811 * hw capability specifications.
813 struct hw_mode_spec spec;
816 * This is the default TX/RX antenna setup as indicated
817 * by the device's EEPROM.
819 struct antenna_setup default_ant;
823 * csr.base: CSR base register address. (PCI)
824 * csr.cache: CSR cache for usb_control_msg. (USB)
832 * Mutex to protect register accesses.
833 * For PCI and USB devices it protects against concurrent indirect
834 * register access (BBP, RF, MCU) since accessing those
835 * registers require multiple calls to the CSR registers.
836 * For USB devices it also protects the csr_cache since that
837 * field is used for normal CSR access and it cannot support
838 * multiple callers simultaneously.
840 struct mutex csr_mutex;
843 * Current packet filter configuration for the device.
844 * This contains all currently active FIF_* flags send
845 * to us by mac80211 during configure_filter().
847 unsigned int packet_filter;
851 * - Open ap interface count.
852 * - Open sta interface count.
853 * - Association count.
854 * - Beaconing enabled count.
856 unsigned int intf_ap_count;
857 unsigned int intf_sta_count;
858 unsigned int intf_associated;
859 unsigned int intf_beaconing;
872 * Active RF register values.
873 * These are stored here so we don't need
874 * to read the rf registers and can directly
875 * use this value instead.
876 * This field should be accessed by using
877 * rt2x00_rf_read() and rt2x00_rf_write().
887 * Current TX power value.
892 * Current retry values.
898 * Rssi <-> Dbm offset
918 * Timestamp of last received beacon
920 unsigned long last_beacon;
923 * Low level statistics which will have
924 * to be kept up to date while device is running.
926 struct ieee80211_low_level_stats low_level_stats;
929 * Work queue for all work which should not be placed
930 * on the mac80211 workqueue (because of dependencies
931 * between various work structures).
933 struct workqueue_struct *workqueue;
937 * NOTE: intf_work will use ieee80211_iterate_active_interfaces()
938 * which means it cannot be placed on the hw->workqueue
939 * due to RTNL locking requirements.
941 struct work_struct intf_work;
944 * Scheduled work for TX/RX done handling (USB devices)
946 struct work_struct rxdone_work;
947 struct work_struct txdone_work;
952 struct delayed_work autowakeup_work;
953 struct work_struct sleep_work;
956 * Data queue arrays for RX, TX, Beacon and ATIM.
958 unsigned int data_queues;
959 struct data_queue *rx;
960 struct data_queue *tx;
961 struct data_queue *bcn;
962 struct data_queue *atim;
967 const struct firmware *fw;
970 * FIFO for storing tx status reports between isr and tasklet.
972 DECLARE_KFIFO_PTR(txstatus_fifo, u32);
975 * Timer to ensure tx status reports are read (rt2800usb).
977 struct timer_list txstatus_timer;
980 * Tasklet for processing tx status reports (rt2800pci).
982 struct tasklet_struct txstatus_tasklet;
983 struct tasklet_struct pretbtt_tasklet;
984 struct tasklet_struct tbtt_tasklet;
985 struct tasklet_struct rxdone_tasklet;
986 struct tasklet_struct autowake_tasklet;
989 * Used for VCO periodic calibration.
994 * Protect the interrupt mask register.
996 spinlock_t irqmask_lock;
1001 * Some registers require multiple attempts before success,
1002 * in those cases REGISTER_BUSY_COUNT attempts should be
1003 * taken with a REGISTER_BUSY_DELAY interval.
1005 #define REGISTER_BUSY_COUNT 100
1006 #define REGISTER_BUSY_DELAY 100
1009 * Generic RF access.
1010 * The RF is being accessed by word index.
1012 static inline void rt2x00_rf_read(struct rt2x00_dev *rt2x00dev,
1013 const unsigned int word, u32 *data)
1015 BUG_ON(word < 1 || word > rt2x00dev->ops->rf_size / sizeof(u32));
1016 *data = rt2x00dev->rf[word - 1];
1019 static inline void rt2x00_rf_write(struct rt2x00_dev *rt2x00dev,
1020 const unsigned int word, u32 data)
1022 BUG_ON(word < 1 || word > rt2x00dev->ops->rf_size / sizeof(u32));
1023 rt2x00dev->rf[word - 1] = data;
1027 * Generic EEPROM access.
1028 * The EEPROM is being accessed by word index.
1030 static inline void *rt2x00_eeprom_addr(struct rt2x00_dev *rt2x00dev,
1031 const unsigned int word)
1033 return (void *)&rt2x00dev->eeprom[word];
1036 static inline void rt2x00_eeprom_read(struct rt2x00_dev *rt2x00dev,
1037 const unsigned int word, u16 *data)
1039 *data = le16_to_cpu(rt2x00dev->eeprom[word]);
1042 static inline void rt2x00_eeprom_write(struct rt2x00_dev *rt2x00dev,
1043 const unsigned int word, u16 data)
1045 rt2x00dev->eeprom[word] = cpu_to_le16(data);
1051 static inline void rt2x00_set_chip(struct rt2x00_dev *rt2x00dev,
1052 const u16 rt, const u16 rf, const u16 rev)
1054 rt2x00dev->chip.rt = rt;
1055 rt2x00dev->chip.rf = rf;
1056 rt2x00dev->chip.rev = rev;
1059 "Chipset detected - rt: %04x, rf: %04x, rev: %04x.\n",
1060 rt2x00dev->chip.rt, rt2x00dev->chip.rf, rt2x00dev->chip.rev);
1063 static inline bool rt2x00_rt(struct rt2x00_dev *rt2x00dev, const u16 rt)
1065 return (rt2x00dev->chip.rt == rt);
1068 static inline bool rt2x00_rf(struct rt2x00_dev *rt2x00dev, const u16 rf)
1070 return (rt2x00dev->chip.rf == rf);
1073 static inline u16 rt2x00_rev(struct rt2x00_dev *rt2x00dev)
1075 return rt2x00dev->chip.rev;
1078 static inline bool rt2x00_rt_rev(struct rt2x00_dev *rt2x00dev,
1079 const u16 rt, const u16 rev)
1081 return (rt2x00_rt(rt2x00dev, rt) && rt2x00_rev(rt2x00dev) == rev);
1084 static inline bool rt2x00_rt_rev_lt(struct rt2x00_dev *rt2x00dev,
1085 const u16 rt, const u16 rev)
1087 return (rt2x00_rt(rt2x00dev, rt) && rt2x00_rev(rt2x00dev) < rev);
1090 static inline bool rt2x00_rt_rev_gte(struct rt2x00_dev *rt2x00dev,
1091 const u16 rt, const u16 rev)
1093 return (rt2x00_rt(rt2x00dev, rt) && rt2x00_rev(rt2x00dev) >= rev);
1096 static inline void rt2x00_set_chip_intf(struct rt2x00_dev *rt2x00dev,
1097 enum rt2x00_chip_intf intf)
1099 rt2x00dev->chip.intf = intf;
1102 static inline bool rt2x00_intf(struct rt2x00_dev *rt2x00dev,
1103 enum rt2x00_chip_intf intf)
1105 return (rt2x00dev->chip.intf == intf);
1108 static inline bool rt2x00_is_pci(struct rt2x00_dev *rt2x00dev)
1110 return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCI) ||
1111 rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCIE);
1114 static inline bool rt2x00_is_pcie(struct rt2x00_dev *rt2x00dev)
1116 return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCIE);
1119 static inline bool rt2x00_is_usb(struct rt2x00_dev *rt2x00dev)
1121 return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_USB);
1124 static inline bool rt2x00_is_soc(struct rt2x00_dev *rt2x00dev)
1126 return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_SOC);
1130 * rt2x00queue_map_txskb - Map a skb into DMA for TX purposes.
1131 * @entry: Pointer to &struct queue_entry
1133 void rt2x00queue_map_txskb(struct queue_entry *entry);
1136 * rt2x00queue_unmap_skb - Unmap a skb from DMA.
1137 * @entry: Pointer to &struct queue_entry
1139 void rt2x00queue_unmap_skb(struct queue_entry *entry);
1142 * rt2x00queue_get_tx_queue - Convert tx queue index to queue pointer
1143 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1144 * @queue: rt2x00 queue index (see &enum data_queue_qid).
1146 * Returns NULL for non tx queues.
1148 static inline struct data_queue *
1149 rt2x00queue_get_tx_queue(struct rt2x00_dev *rt2x00dev,
1150 const enum data_queue_qid queue)
1152 if (queue < rt2x00dev->ops->tx_queues && rt2x00dev->tx)
1153 return &rt2x00dev->tx[queue];
1155 if (queue == QID_ATIM)
1156 return rt2x00dev->atim;
1162 * rt2x00queue_get_entry - Get queue entry where the given index points to.
1163 * @queue: Pointer to &struct data_queue from where we obtain the entry.
1164 * @index: Index identifier for obtaining the correct index.
1166 struct queue_entry *rt2x00queue_get_entry(struct data_queue *queue,
1167 enum queue_index index);
1170 * rt2x00queue_pause_queue - Pause a data queue
1171 * @queue: Pointer to &struct data_queue.
1173 * This function will pause the data queue locally, preventing
1174 * new frames to be added to the queue (while the hardware is
1175 * still allowed to run).
1177 void rt2x00queue_pause_queue(struct data_queue *queue);
1180 * rt2x00queue_unpause_queue - unpause a data queue
1181 * @queue: Pointer to &struct data_queue.
1183 * This function will unpause the data queue locally, allowing
1184 * new frames to be added to the queue again.
1186 void rt2x00queue_unpause_queue(struct data_queue *queue);
1189 * rt2x00queue_start_queue - Start a data queue
1190 * @queue: Pointer to &struct data_queue.
1192 * This function will start handling all pending frames in the queue.
1194 void rt2x00queue_start_queue(struct data_queue *queue);
1197 * rt2x00queue_stop_queue - Halt a data queue
1198 * @queue: Pointer to &struct data_queue.
1200 * This function will stop all pending frames in the queue.
1202 void rt2x00queue_stop_queue(struct data_queue *queue);
1205 * rt2x00queue_flush_queue - Flush a data queue
1206 * @queue: Pointer to &struct data_queue.
1207 * @drop: True to drop all pending frames.
1209 * This function will flush the queue. After this call
1210 * the queue is guaranteed to be empty.
1212 void rt2x00queue_flush_queue(struct data_queue *queue, bool drop);
1215 * rt2x00queue_start_queues - Start all data queues
1216 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1218 * This function will loop through all available queues to start them
1220 void rt2x00queue_start_queues(struct rt2x00_dev *rt2x00dev);
1223 * rt2x00queue_stop_queues - Halt all data queues
1224 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1226 * This function will loop through all available queues to stop
1227 * any pending frames.
1229 void rt2x00queue_stop_queues(struct rt2x00_dev *rt2x00dev);
1232 * rt2x00queue_flush_queues - Flush all data queues
1233 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1234 * @drop: True to drop all pending frames.
1236 * This function will loop through all available queues to flush
1237 * any pending frames.
1239 void rt2x00queue_flush_queues(struct rt2x00_dev *rt2x00dev, bool drop);
1245 * rt2x00debug_dump_frame - Dump a frame to userspace through debugfs.
1246 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1247 * @type: The type of frame that is being dumped.
1248 * @skb: The skb containing the frame to be dumped.
1250 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
1251 void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
1252 enum rt2x00_dump_type type, struct sk_buff *skb);
1254 static inline void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
1255 enum rt2x00_dump_type type,
1256 struct sk_buff *skb)
1259 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
1262 * Utility functions.
1264 u32 rt2x00lib_get_bssidx(struct rt2x00_dev *rt2x00dev,
1265 struct ieee80211_vif *vif);
1268 * Interrupt context handlers.
1270 void rt2x00lib_beacondone(struct rt2x00_dev *rt2x00dev);
1271 void rt2x00lib_pretbtt(struct rt2x00_dev *rt2x00dev);
1272 void rt2x00lib_dmastart(struct queue_entry *entry);
1273 void rt2x00lib_dmadone(struct queue_entry *entry);
1274 void rt2x00lib_txdone(struct queue_entry *entry,
1275 struct txdone_entry_desc *txdesc);
1276 void rt2x00lib_txdone_noinfo(struct queue_entry *entry, u32 status);
1277 void rt2x00lib_rxdone(struct queue_entry *entry);
1280 * mac80211 handlers.
1282 void rt2x00mac_tx(struct ieee80211_hw *hw, struct sk_buff *skb);
1283 int rt2x00mac_start(struct ieee80211_hw *hw);
1284 void rt2x00mac_stop(struct ieee80211_hw *hw);
1285 int rt2x00mac_add_interface(struct ieee80211_hw *hw,
1286 struct ieee80211_vif *vif);
1287 void rt2x00mac_remove_interface(struct ieee80211_hw *hw,
1288 struct ieee80211_vif *vif);
1289 int rt2x00mac_config(struct ieee80211_hw *hw, u32 changed);
1290 void rt2x00mac_configure_filter(struct ieee80211_hw *hw,
1291 unsigned int changed_flags,
1292 unsigned int *total_flags,
1294 int rt2x00mac_set_tim(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1296 #ifdef CONFIG_RT2X00_LIB_CRYPTO
1297 int rt2x00mac_set_key(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1298 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
1299 struct ieee80211_key_conf *key);
1301 #define rt2x00mac_set_key NULL
1302 #endif /* CONFIG_RT2X00_LIB_CRYPTO */
1303 int rt2x00mac_sta_add(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1304 struct ieee80211_sta *sta);
1305 int rt2x00mac_sta_remove(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1306 struct ieee80211_sta *sta);
1307 void rt2x00mac_sw_scan_start(struct ieee80211_hw *hw);
1308 void rt2x00mac_sw_scan_complete(struct ieee80211_hw *hw);
1309 int rt2x00mac_get_stats(struct ieee80211_hw *hw,
1310 struct ieee80211_low_level_stats *stats);
1311 void rt2x00mac_bss_info_changed(struct ieee80211_hw *hw,
1312 struct ieee80211_vif *vif,
1313 struct ieee80211_bss_conf *bss_conf,
1315 int rt2x00mac_conf_tx(struct ieee80211_hw *hw,
1316 struct ieee80211_vif *vif, u16 queue,
1317 const struct ieee80211_tx_queue_params *params);
1318 void rt2x00mac_rfkill_poll(struct ieee80211_hw *hw);
1319 void rt2x00mac_flush(struct ieee80211_hw *hw, bool drop);
1320 int rt2x00mac_set_antenna(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
1321 int rt2x00mac_get_antenna(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
1322 void rt2x00mac_get_ringparam(struct ieee80211_hw *hw,
1323 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
1324 bool rt2x00mac_tx_frames_pending(struct ieee80211_hw *hw);
1327 * Driver allocation handlers.
1329 int rt2x00lib_probe_dev(struct rt2x00_dev *rt2x00dev);
1330 void rt2x00lib_remove_dev(struct rt2x00_dev *rt2x00dev);
1332 int rt2x00lib_suspend(struct rt2x00_dev *rt2x00dev, pm_message_t state);
1333 int rt2x00lib_resume(struct rt2x00_dev *rt2x00dev);
1334 #endif /* CONFIG_PM */
1336 #endif /* RT2X00_H */