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, see <http://www.gnu.org/licenses/>.
23 Abstract: rt2x00 global information.
29 #include <linux/bitops.h>
30 #include <linux/interrupt.h>
31 #include <linux/skbuff.h>
32 #include <linux/workqueue.h>
33 #include <linux/firmware.h>
34 #include <linux/leds.h>
35 #include <linux/mutex.h>
36 #include <linux/etherdevice.h>
37 #include <linux/input-polldev.h>
38 #include <linux/kfifo.h>
39 #include <linux/hrtimer.h>
40 #include <linux/average.h>
41 #include <linux/usb.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"
58 * Debug output has to be enabled during compile time.
60 #ifdef CONFIG_RT2X00_DEBUG
62 #endif /* CONFIG_RT2X00_DEBUG */
64 /* Utility printing macros
65 * rt2x00_probe_err is for messages when rt2x00_dev is uninitialized
67 #define rt2x00_probe_err(fmt, ...) \
68 printk(KERN_ERR KBUILD_MODNAME ": %s: Error - " fmt, \
69 __func__, ##__VA_ARGS__)
70 #define rt2x00_err(dev, fmt, ...) \
71 wiphy_err((dev)->hw->wiphy, "%s: Error - " fmt, \
72 __func__, ##__VA_ARGS__)
73 #define rt2x00_warn(dev, fmt, ...) \
74 wiphy_warn((dev)->hw->wiphy, "%s: Warning - " fmt, \
75 __func__, ##__VA_ARGS__)
76 #define rt2x00_info(dev, fmt, ...) \
77 wiphy_info((dev)->hw->wiphy, "%s: Info - " fmt, \
78 __func__, ##__VA_ARGS__)
80 /* Various debug levels */
81 #define rt2x00_dbg(dev, fmt, ...) \
82 wiphy_dbg((dev)->hw->wiphy, "%s: Debug - " fmt, \
83 __func__, ##__VA_ARGS__)
84 #define rt2x00_eeprom_dbg(dev, fmt, ...) \
85 wiphy_dbg((dev)->hw->wiphy, "%s: EEPROM recovery - " fmt, \
86 __func__, ##__VA_ARGS__)
89 * Duration calculations
90 * The rate variable passed is: 100kbs.
91 * To convert from bytes to bits we multiply size with 8,
92 * then the size is multiplied with 10 to make the
93 * real rate -> rate argument correction.
95 #define GET_DURATION(__size, __rate) (((__size) * 8 * 10) / (__rate))
96 #define GET_DURATION_RES(__size, __rate)(((__size) * 8 * 10) % (__rate))
99 * Determine the number of L2 padding bytes required between the header and
102 #define L2PAD_SIZE(__hdrlen) (-(__hdrlen) & 3)
105 * Determine the alignment requirement,
106 * to make sure the 802.11 payload is padded to a 4-byte boundrary
107 * we must determine the address of the payload and calculate the
108 * amount of bytes needed to move the data.
110 #define ALIGN_SIZE(__skb, __header) \
111 (((unsigned long)((__skb)->data + (__header))) & 3)
114 * Constants for extra TX headroom for alignment purposes.
116 #define RT2X00_ALIGN_SIZE 4 /* Only whole frame needs alignment */
117 #define RT2X00_L2PAD_SIZE 8 /* Both header & payload need alignment */
120 * Standard timing and size defines.
121 * These values should follow the ieee80211 specifications.
124 #define IEEE80211_HEADER 24
128 #define SHORT_PREAMBLE 72
130 #define SHORT_SLOT_TIME 9
132 #define PIFS (SIFS + SLOT_TIME)
133 #define SHORT_PIFS (SIFS + SHORT_SLOT_TIME)
134 #define DIFS (PIFS + SLOT_TIME)
135 #define SHORT_DIFS (SHORT_PIFS + SHORT_SLOT_TIME)
136 #define EIFS (SIFS + DIFS + \
137 GET_DURATION(IEEE80211_HEADER + ACK_SIZE, 10))
138 #define SHORT_EIFS (SIFS + SHORT_DIFS + \
139 GET_DURATION(IEEE80211_HEADER + ACK_SIZE, 10))
141 enum rt2x00_chip_intf {
142 RT2X00_CHIP_INTF_PCI,
143 RT2X00_CHIP_INTF_PCIE,
144 RT2X00_CHIP_INTF_USB,
145 RT2X00_CHIP_INTF_SOC,
149 * Chipset identification
150 * The chipset on the device is composed of a RT and RF chip.
151 * The chipset combination is important for determining device capabilities.
155 #define RT2460 0x2460
156 #define RT2560 0x2560
157 #define RT2570 0x2570
158 #define RT2661 0x2661
159 #define RT2573 0x2573
160 #define RT2860 0x2860 /* 2.4GHz */
161 #define RT2872 0x2872 /* WSOC */
162 #define RT2883 0x2883 /* WSOC */
163 #define RT3070 0x3070
164 #define RT3071 0x3071
165 #define RT3090 0x3090 /* 2.4GHz PCIe */
166 #define RT3290 0x3290
167 #define RT3352 0x3352 /* WSOC */
168 #define RT3390 0x3390
169 #define RT3572 0x3572
170 #define RT3593 0x3593
171 #define RT3883 0x3883 /* WSOC */
172 #define RT5390 0x5390 /* 2.4GHz */
173 #define RT5392 0x5392 /* 2.4GHz */
174 #define RT5592 0x5592
179 enum rt2x00_chip_intf intf;
183 * RF register values that belong to a particular channel.
194 * Channel information structure
196 struct channel_info {
198 #define GEOGRAPHY_ALLOWED 0x00000001
201 short default_power1;
202 short default_power2;
203 short default_power3;
207 * Antenna setup values.
209 struct antenna_setup {
217 * Quality statistics about the currently active link.
221 * Statistics required for Link tuning by driver
222 * The rssi value is provided by rt2x00lib during the
223 * link_tuner() callback function.
224 * The false_cca field is filled during the link_stats()
225 * callback function and could be used during the
226 * link_tuner() callback function.
233 * Hardware driver will tune the VGC level during each call
234 * to the link_tuner() callback function. This vgc_level is
235 * is determined based on the link quality statistics like
236 * average RSSI and the false CCA count.
238 * In some cases the drivers need to differentiate between
239 * the currently "desired" VGC level and the level configured
240 * in the hardware. The latter is important to reduce the
241 * number of BBP register reads to reduce register access
242 * overhead. For this reason we store both values here.
248 * Statistics required for Signal quality calculation.
249 * These fields might be changed during the link_stats()
258 DECLARE_EWMA(rssi, 1024, 8)
261 * Antenna settings about the currently active link.
268 #define ANTENNA_RX_DIVERSITY 0x00000001
269 #define ANTENNA_TX_DIVERSITY 0x00000002
270 #define ANTENNA_MODE_SAMPLE 0x00000004
273 * Currently active TX/RX antenna setup.
274 * When software diversity is used, this will indicate
275 * which antenna is actually used at this time.
277 struct antenna_setup active;
280 * RSSI history information for the antenna.
281 * Used to determine when to switch antenna
282 * when using software diversity.
287 * Current RSSI average of the currently active antenna.
288 * Similar to the avg_rssi in the link_qual structure
289 * this value is updated by using the walking average.
291 struct ewma_rssi rssi_ant;
295 * To optimize the quality of the link we need to store
296 * the quality of received frames and periodically
302 * The number of times the link has been tuned
303 * since the radio has been switched on.
308 * Quality measurement values.
310 struct link_qual qual;
313 * TX/RX antenna setup.
318 * Currently active average RSSI value
320 struct ewma_rssi avg_rssi;
323 * Work structure for scheduling periodic link tuning.
325 struct delayed_work work;
328 * Work structure for scheduling periodic watchdog monitoring.
329 * This work must be scheduled on the kernel workqueue, while
330 * all other work structures must be queued on the mac80211
331 * workqueue. This guarantees that the watchdog can schedule
332 * other work structures and wait for their completion in order
333 * to bring the device/driver back into the desired state.
335 struct delayed_work watchdog_work;
338 * Work structure for scheduling periodic AGC adjustments.
340 struct delayed_work agc_work;
343 * Work structure for scheduling periodic VCO calibration.
345 struct delayed_work vco_work;
348 enum rt2x00_delayed_flags {
349 DELAYED_UPDATE_BEACON,
353 * Interface structure
354 * Per interface configuration details, this structure
355 * is allocated as the private data for ieee80211_vif.
359 * beacon->skb must be protected with the mutex.
361 struct mutex beacon_skb_mutex;
364 * Entry in the beacon queue which belongs to
365 * this interface. Each interface has its own
366 * dedicated beacon entry.
368 struct queue_entry *beacon;
372 * Actions that needed rescheduling.
374 unsigned long delayed_flags;
377 * Software sequence counter, this is only required
378 * for hardware which doesn't support hardware
384 static inline struct rt2x00_intf* vif_to_intf(struct ieee80211_vif *vif)
386 return (struct rt2x00_intf *)vif->drv_priv;
390 * struct hw_mode_spec: Hardware specifications structure
392 * Details about the supported modes, rates and channels
393 * of a particular chipset. This is used by rt2x00lib
394 * to build the ieee80211_hw_mode array for mac80211.
396 * @supported_bands: Bitmask contained the supported bands (2.4GHz, 5.2GHz).
397 * @supported_rates: Rate types which are supported (CCK, OFDM).
398 * @num_channels: Number of supported channels. This is used as array size
399 * for @tx_power_a, @tx_power_bg and @channels.
400 * @channels: Device/chipset specific channel values (See &struct rf_channel).
401 * @channels_info: Additional information for channels (See &struct channel_info).
402 * @ht: Driver HT Capabilities (See &ieee80211_sta_ht_cap).
404 struct hw_mode_spec {
405 unsigned int supported_bands;
406 #define SUPPORT_BAND_2GHZ 0x00000001
407 #define SUPPORT_BAND_5GHZ 0x00000002
409 unsigned int supported_rates;
410 #define SUPPORT_RATE_CCK 0x00000001
411 #define SUPPORT_RATE_OFDM 0x00000002
413 unsigned int num_channels;
414 const struct rf_channel *channels;
415 const struct channel_info *channels_info;
417 struct ieee80211_sta_ht_cap ht;
421 * Configuration structure wrapper around the
422 * mac80211 configuration structure.
423 * When mac80211 configures the driver, rt2x00lib
424 * can precalculate values which are equal for all
425 * rt2x00 drivers. Those values can be stored in here.
427 struct rt2x00lib_conf {
428 struct ieee80211_conf *conf;
430 struct rf_channel rf;
431 struct channel_info channel;
435 * Configuration structure for erp settings.
437 struct rt2x00lib_erp {
455 * Configuration structure for hardware encryption.
457 struct rt2x00lib_crypto {
460 enum set_key_cmd cmd;
473 * Configuration structure wrapper around the
474 * rt2x00 interface configuration handler.
476 struct rt2x00intf_conf {
480 enum nl80211_iftype type;
483 * TSF sync value, this is dependent on the operation type.
488 * The MAC and BSSID addresses are simple array of bytes,
489 * these arrays are little endian, so when sending the addresses
490 * to the drivers, copy the it into a endian-signed variable.
492 * Note that all devices (except rt2500usb) have 32 bits
493 * register word sizes. This means that whatever variable we
494 * pass _must_ be a multiple of 32 bits. Otherwise the device
495 * might not accept what we are sending to it.
496 * This will also make it easier for the driver to write
497 * the data to the device.
504 * Private structure for storing STA details
505 * wcid: Wireless Client ID
511 static inline struct rt2x00_sta* sta_to_rt2x00_sta(struct ieee80211_sta *sta)
513 return (struct rt2x00_sta *)sta->drv_priv;
517 * rt2x00lib callback functions.
519 struct rt2x00lib_ops {
521 * Interrupt handlers.
523 irq_handler_t irq_handler;
526 * TX status tasklet handler.
528 void (*txstatus_tasklet) (unsigned long data);
529 void (*pretbtt_tasklet) (unsigned long data);
530 void (*tbtt_tasklet) (unsigned long data);
531 void (*rxdone_tasklet) (unsigned long data);
532 void (*autowake_tasklet) (unsigned long data);
535 * Device init handlers.
537 int (*probe_hw) (struct rt2x00_dev *rt2x00dev);
538 char *(*get_firmware_name) (struct rt2x00_dev *rt2x00dev);
539 int (*check_firmware) (struct rt2x00_dev *rt2x00dev,
540 const u8 *data, const size_t len);
541 int (*load_firmware) (struct rt2x00_dev *rt2x00dev,
542 const u8 *data, const size_t len);
545 * Device initialization/deinitialization handlers.
547 int (*initialize) (struct rt2x00_dev *rt2x00dev);
548 void (*uninitialize) (struct rt2x00_dev *rt2x00dev);
551 * queue initialization handlers
553 bool (*get_entry_state) (struct queue_entry *entry);
554 void (*clear_entry) (struct queue_entry *entry);
557 * Radio control handlers.
559 int (*set_device_state) (struct rt2x00_dev *rt2x00dev,
560 enum dev_state state);
561 int (*rfkill_poll) (struct rt2x00_dev *rt2x00dev);
562 void (*link_stats) (struct rt2x00_dev *rt2x00dev,
563 struct link_qual *qual);
564 void (*reset_tuner) (struct rt2x00_dev *rt2x00dev,
565 struct link_qual *qual);
566 void (*link_tuner) (struct rt2x00_dev *rt2x00dev,
567 struct link_qual *qual, const u32 count);
568 void (*gain_calibration) (struct rt2x00_dev *rt2x00dev);
569 void (*vco_calibration) (struct rt2x00_dev *rt2x00dev);
572 * Data queue handlers.
574 void (*watchdog) (struct rt2x00_dev *rt2x00dev);
575 void (*start_queue) (struct data_queue *queue);
576 void (*kick_queue) (struct data_queue *queue);
577 void (*stop_queue) (struct data_queue *queue);
578 void (*flush_queue) (struct data_queue *queue, bool drop);
579 void (*tx_dma_done) (struct queue_entry *entry);
582 * TX control handlers
584 void (*write_tx_desc) (struct queue_entry *entry,
585 struct txentry_desc *txdesc);
586 void (*write_tx_data) (struct queue_entry *entry,
587 struct txentry_desc *txdesc);
588 void (*write_beacon) (struct queue_entry *entry,
589 struct txentry_desc *txdesc);
590 void (*clear_beacon) (struct queue_entry *entry);
591 int (*get_tx_data_len) (struct queue_entry *entry);
594 * RX control handlers
596 void (*fill_rxdone) (struct queue_entry *entry,
597 struct rxdone_entry_desc *rxdesc);
600 * Configuration handlers.
602 int (*config_shared_key) (struct rt2x00_dev *rt2x00dev,
603 struct rt2x00lib_crypto *crypto,
604 struct ieee80211_key_conf *key);
605 int (*config_pairwise_key) (struct rt2x00_dev *rt2x00dev,
606 struct rt2x00lib_crypto *crypto,
607 struct ieee80211_key_conf *key);
608 void (*config_filter) (struct rt2x00_dev *rt2x00dev,
609 const unsigned int filter_flags);
610 void (*config_intf) (struct rt2x00_dev *rt2x00dev,
611 struct rt2x00_intf *intf,
612 struct rt2x00intf_conf *conf,
613 const unsigned int flags);
614 #define CONFIG_UPDATE_TYPE ( 1 << 1 )
615 #define CONFIG_UPDATE_MAC ( 1 << 2 )
616 #define CONFIG_UPDATE_BSSID ( 1 << 3 )
618 void (*config_erp) (struct rt2x00_dev *rt2x00dev,
619 struct rt2x00lib_erp *erp,
621 void (*config_ant) (struct rt2x00_dev *rt2x00dev,
622 struct antenna_setup *ant);
623 void (*config) (struct rt2x00_dev *rt2x00dev,
624 struct rt2x00lib_conf *libconf,
625 const unsigned int changed_flags);
626 int (*sta_add) (struct rt2x00_dev *rt2x00dev,
627 struct ieee80211_vif *vif,
628 struct ieee80211_sta *sta);
629 int (*sta_remove) (struct rt2x00_dev *rt2x00dev,
634 * rt2x00 driver callback operation structure.
638 const unsigned int drv_data_size;
639 const unsigned int max_ap_intf;
640 const unsigned int eeprom_size;
641 const unsigned int rf_size;
642 const unsigned int tx_queues;
643 void (*queue_init)(struct data_queue *queue);
644 const struct rt2x00lib_ops *lib;
646 const struct ieee80211_ops *hw;
647 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
648 const struct rt2x00debug *debugfs;
649 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
655 enum rt2x00_state_flags {
659 DEVICE_STATE_PRESENT,
660 DEVICE_STATE_REGISTERED_HW,
661 DEVICE_STATE_INITIALIZED,
662 DEVICE_STATE_STARTED,
663 DEVICE_STATE_ENABLED_RADIO,
664 DEVICE_STATE_SCANNING,
667 * Driver configuration
675 * Mark we currently are sequentially reading TX_STA_FIFO register
676 * FIXME: this is for only rt2800usb, should go to private data
682 * rt2x00 capability flags
684 enum rt2x00_capability_flags {
689 REQUIRE_BEACON_GUARD,
694 REQUIRE_TXSTATUS_FIFO,
695 REQUIRE_TASKLET_CONTEXT,
699 REQUIRE_DELAYED_RFKILL,
704 CAPABILITY_HW_BUTTON,
705 CAPABILITY_HW_CRYPTO,
706 CAPABILITY_POWER_LIMIT,
707 CAPABILITY_CONTROL_FILTERS,
708 CAPABILITY_CONTROL_FILTER_PSPOLL,
709 CAPABILITY_PRE_TBTT_INTERRUPT,
710 CAPABILITY_LINK_TUNING,
711 CAPABILITY_FRAME_TYPE,
712 CAPABILITY_RF_SEQUENCE,
713 CAPABILITY_EXTERNAL_LNA_A,
714 CAPABILITY_EXTERNAL_LNA_BG,
715 CAPABILITY_DOUBLE_ANTENNA,
716 CAPABILITY_BT_COEXIST,
717 CAPABILITY_VCO_RECALIBRATION,
721 * Interface combinations
729 * rt2x00 device structure.
734 * The structure stored in here depends on the
735 * system bus (PCI or USB).
736 * When accessing this variable, the rt2x00dev_{pci,usb}
737 * macros should be used for correct typecasting.
742 * Callback functions.
744 const struct rt2x00_ops *ops;
752 * IEEE80211 control structure.
754 struct ieee80211_hw *hw;
755 struct ieee80211_supported_band bands[NUM_NL80211_BANDS];
756 enum nl80211_band curr_band;
760 * If enabled, the debugfs interface structures
761 * required for deregistration of debugfs.
763 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
764 struct rt2x00debug_intf *debugfs_intf;
765 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
768 * LED structure for changing the LED status
769 * by mac8011 or the kernel.
771 #ifdef CONFIG_RT2X00_LIB_LEDS
772 struct rt2x00_led led_radio;
773 struct rt2x00_led led_assoc;
774 struct rt2x00_led led_qual;
776 #endif /* CONFIG_RT2X00_LIB_LEDS */
779 * Device state flags.
780 * In these flags the current status is stored.
781 * Access to these flags should occur atomically.
786 * Device capabiltiy flags.
787 * In these flags the device/driver capabilities are stored.
788 * Access to these flags should occur non-atomically.
790 unsigned long cap_flags;
793 * Device information, Bus IRQ and name (PCI, SoC)
799 * Chipset identification.
801 struct rt2x00_chip chip;
804 * hw capability specifications.
806 struct hw_mode_spec spec;
809 * This is the default TX/RX antenna setup as indicated
810 * by the device's EEPROM.
812 struct antenna_setup default_ant;
816 * csr.base: CSR base register address. (PCI)
817 * csr.cache: CSR cache for usb_control_msg. (USB)
825 * Mutex to protect register accesses.
826 * For PCI and USB devices it protects against concurrent indirect
827 * register access (BBP, RF, MCU) since accessing those
828 * registers require multiple calls to the CSR registers.
829 * For USB devices it also protects the csr_cache since that
830 * field is used for normal CSR access and it cannot support
831 * multiple callers simultaneously.
833 struct mutex csr_mutex;
836 * Current packet filter configuration for the device.
837 * This contains all currently active FIF_* flags send
838 * to us by mac80211 during configure_filter().
840 unsigned int packet_filter;
844 * - Open ap interface count.
845 * - Open sta interface count.
846 * - Association count.
847 * - Beaconing enabled count.
849 unsigned int intf_ap_count;
850 unsigned int intf_sta_count;
851 unsigned int intf_associated;
852 unsigned int intf_beaconing;
855 * Interface combinations
857 struct ieee80211_iface_limit if_limits_ap;
858 struct ieee80211_iface_combination if_combinations[NUM_IF_COMB];
871 * Active RF register values.
872 * These are stored here so we don't need
873 * to read the rf registers and can directly
874 * use this value instead.
875 * This field should be accessed by using
876 * rt2x00_rf_read() and rt2x00_rf_write().
886 * Current TX power value.
891 * Current retry values.
897 * Rssi <-> Dbm offset
917 * Timestamp of last received beacon
919 unsigned long last_beacon;
922 * Low level statistics which will have
923 * to be kept up to date while device is running.
925 struct ieee80211_low_level_stats low_level_stats;
928 * Work queue for all work which should not be placed
929 * on the mac80211 workqueue (because of dependencies
930 * between various work structures).
932 struct workqueue_struct *workqueue;
936 * NOTE: intf_work will use ieee80211_iterate_active_interfaces()
937 * which means it cannot be placed on the hw->workqueue
938 * due to RTNL locking requirements.
940 struct work_struct intf_work;
943 * Scheduled work for TX/RX done handling (USB devices)
945 struct work_struct rxdone_work;
946 struct work_struct txdone_work;
951 struct delayed_work autowakeup_work;
952 struct work_struct sleep_work;
955 * Data queue arrays for RX, TX, Beacon and ATIM.
957 unsigned int data_queues;
958 struct data_queue *rx;
959 struct data_queue *tx;
960 struct data_queue *bcn;
961 struct data_queue *atim;
966 const struct firmware *fw;
969 * FIFO for storing tx status reports between isr and tasklet.
971 DECLARE_KFIFO_PTR(txstatus_fifo, u32);
974 * Timer to ensure tx status reports are read (rt2800usb).
976 struct hrtimer txstatus_timer;
979 * Tasklet for processing tx status reports (rt2800pci).
981 struct tasklet_struct txstatus_tasklet;
982 struct tasklet_struct pretbtt_tasklet;
983 struct tasklet_struct tbtt_tasklet;
984 struct tasklet_struct rxdone_tasklet;
985 struct tasklet_struct autowake_tasklet;
988 * Used for VCO periodic calibration.
993 * Protect the interrupt mask register.
995 spinlock_t irqmask_lock;
998 * List of BlockAckReq TX entries that need driver BlockAck processing.
1000 struct list_head bar_list;
1001 spinlock_t bar_list_lock;
1003 /* Extra TX headroom required for alignment purposes. */
1004 unsigned int extra_tx_headroom;
1006 struct usb_anchor *anchor;
1009 struct rt2x00_bar_list_entry {
1010 struct list_head list;
1011 struct rcu_head head;
1013 struct queue_entry *entry;
1016 /* Relevant parts of the IEEE80211 BAR header */
1020 __le16 start_seq_num;
1025 * Some registers require multiple attempts before success,
1026 * in those cases REGISTER_BUSY_COUNT attempts should be
1027 * taken with a REGISTER_BUSY_DELAY interval. Due to USB
1028 * bus delays, we do not have to loop so many times to wait
1029 * for valid register value on that bus.
1031 #define REGISTER_BUSY_COUNT 100
1032 #define REGISTER_USB_BUSY_COUNT 20
1033 #define REGISTER_BUSY_DELAY 100
1036 * Generic RF access.
1037 * The RF is being accessed by word index.
1039 static inline void rt2x00_rf_read(struct rt2x00_dev *rt2x00dev,
1040 const unsigned int word, u32 *data)
1042 BUG_ON(word < 1 || word > rt2x00dev->ops->rf_size / sizeof(u32));
1043 *data = rt2x00dev->rf[word - 1];
1046 static inline void rt2x00_rf_write(struct rt2x00_dev *rt2x00dev,
1047 const unsigned int word, u32 data)
1049 BUG_ON(word < 1 || word > rt2x00dev->ops->rf_size / sizeof(u32));
1050 rt2x00dev->rf[word - 1] = data;
1054 * Generic EEPROM access. The EEPROM is being accessed by word or byte index.
1056 static inline void *rt2x00_eeprom_addr(struct rt2x00_dev *rt2x00dev,
1057 const unsigned int word)
1059 return (void *)&rt2x00dev->eeprom[word];
1062 static inline void rt2x00_eeprom_read(struct rt2x00_dev *rt2x00dev,
1063 const unsigned int word, u16 *data)
1065 *data = le16_to_cpu(rt2x00dev->eeprom[word]);
1068 static inline void rt2x00_eeprom_write(struct rt2x00_dev *rt2x00dev,
1069 const unsigned int word, u16 data)
1071 rt2x00dev->eeprom[word] = cpu_to_le16(data);
1074 static inline u8 rt2x00_eeprom_byte(struct rt2x00_dev *rt2x00dev,
1075 const unsigned int byte)
1077 return *(((u8 *)rt2x00dev->eeprom) + byte);
1083 static inline void rt2x00_set_chip(struct rt2x00_dev *rt2x00dev,
1084 const u16 rt, const u16 rf, const u16 rev)
1086 rt2x00dev->chip.rt = rt;
1087 rt2x00dev->chip.rf = rf;
1088 rt2x00dev->chip.rev = rev;
1090 rt2x00_info(rt2x00dev, "Chipset detected - rt: %04x, rf: %04x, rev: %04x\n",
1091 rt2x00dev->chip.rt, rt2x00dev->chip.rf,
1092 rt2x00dev->chip.rev);
1095 static inline void rt2x00_set_rt(struct rt2x00_dev *rt2x00dev,
1096 const u16 rt, const u16 rev)
1098 rt2x00dev->chip.rt = rt;
1099 rt2x00dev->chip.rev = rev;
1101 rt2x00_info(rt2x00dev, "RT chipset %04x, rev %04x detected\n",
1102 rt2x00dev->chip.rt, rt2x00dev->chip.rev);
1105 static inline void rt2x00_set_rf(struct rt2x00_dev *rt2x00dev, const u16 rf)
1107 rt2x00dev->chip.rf = rf;
1109 rt2x00_info(rt2x00dev, "RF chipset %04x detected\n",
1110 rt2x00dev->chip.rf);
1113 static inline bool rt2x00_rt(struct rt2x00_dev *rt2x00dev, const u16 rt)
1115 return (rt2x00dev->chip.rt == rt);
1118 static inline bool rt2x00_rf(struct rt2x00_dev *rt2x00dev, const u16 rf)
1120 return (rt2x00dev->chip.rf == rf);
1123 static inline u16 rt2x00_rev(struct rt2x00_dev *rt2x00dev)
1125 return rt2x00dev->chip.rev;
1128 static inline bool rt2x00_rt_rev(struct rt2x00_dev *rt2x00dev,
1129 const u16 rt, const u16 rev)
1131 return (rt2x00_rt(rt2x00dev, rt) && rt2x00_rev(rt2x00dev) == rev);
1134 static inline bool rt2x00_rt_rev_lt(struct rt2x00_dev *rt2x00dev,
1135 const u16 rt, const u16 rev)
1137 return (rt2x00_rt(rt2x00dev, rt) && rt2x00_rev(rt2x00dev) < rev);
1140 static inline bool rt2x00_rt_rev_gte(struct rt2x00_dev *rt2x00dev,
1141 const u16 rt, const u16 rev)
1143 return (rt2x00_rt(rt2x00dev, rt) && rt2x00_rev(rt2x00dev) >= rev);
1146 static inline void rt2x00_set_chip_intf(struct rt2x00_dev *rt2x00dev,
1147 enum rt2x00_chip_intf intf)
1149 rt2x00dev->chip.intf = intf;
1152 static inline bool rt2x00_intf(struct rt2x00_dev *rt2x00dev,
1153 enum rt2x00_chip_intf intf)
1155 return (rt2x00dev->chip.intf == intf);
1158 static inline bool rt2x00_is_pci(struct rt2x00_dev *rt2x00dev)
1160 return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCI) ||
1161 rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCIE);
1164 static inline bool rt2x00_is_pcie(struct rt2x00_dev *rt2x00dev)
1166 return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCIE);
1169 static inline bool rt2x00_is_usb(struct rt2x00_dev *rt2x00dev)
1171 return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_USB);
1174 static inline bool rt2x00_is_soc(struct rt2x00_dev *rt2x00dev)
1176 return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_SOC);
1179 /* Helpers for capability flags */
1182 rt2x00_has_cap_flag(struct rt2x00_dev *rt2x00dev,
1183 enum rt2x00_capability_flags cap_flag)
1185 return test_bit(cap_flag, &rt2x00dev->cap_flags);
1189 rt2x00_has_cap_hw_crypto(struct rt2x00_dev *rt2x00dev)
1191 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_HW_CRYPTO);
1195 rt2x00_has_cap_power_limit(struct rt2x00_dev *rt2x00dev)
1197 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_POWER_LIMIT);
1201 rt2x00_has_cap_control_filters(struct rt2x00_dev *rt2x00dev)
1203 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_CONTROL_FILTERS);
1207 rt2x00_has_cap_control_filter_pspoll(struct rt2x00_dev *rt2x00dev)
1209 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_CONTROL_FILTER_PSPOLL);
1213 rt2x00_has_cap_pre_tbtt_interrupt(struct rt2x00_dev *rt2x00dev)
1215 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_PRE_TBTT_INTERRUPT);
1219 rt2x00_has_cap_link_tuning(struct rt2x00_dev *rt2x00dev)
1221 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_LINK_TUNING);
1225 rt2x00_has_cap_frame_type(struct rt2x00_dev *rt2x00dev)
1227 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_FRAME_TYPE);
1231 rt2x00_has_cap_rf_sequence(struct rt2x00_dev *rt2x00dev)
1233 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_RF_SEQUENCE);
1237 rt2x00_has_cap_external_lna_a(struct rt2x00_dev *rt2x00dev)
1239 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_EXTERNAL_LNA_A);
1243 rt2x00_has_cap_external_lna_bg(struct rt2x00_dev *rt2x00dev)
1245 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_EXTERNAL_LNA_BG);
1249 rt2x00_has_cap_double_antenna(struct rt2x00_dev *rt2x00dev)
1251 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_DOUBLE_ANTENNA);
1255 rt2x00_has_cap_bt_coexist(struct rt2x00_dev *rt2x00dev)
1257 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_BT_COEXIST);
1261 rt2x00_has_cap_vco_recalibration(struct rt2x00_dev *rt2x00dev)
1263 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_VCO_RECALIBRATION);
1267 * rt2x00queue_map_txskb - Map a skb into DMA for TX purposes.
1268 * @entry: Pointer to &struct queue_entry
1270 * Returns -ENOMEM if mapping fail, 0 otherwise.
1272 int rt2x00queue_map_txskb(struct queue_entry *entry);
1275 * rt2x00queue_unmap_skb - Unmap a skb from DMA.
1276 * @entry: Pointer to &struct queue_entry
1278 void rt2x00queue_unmap_skb(struct queue_entry *entry);
1281 * rt2x00queue_get_tx_queue - Convert tx queue index to queue pointer
1282 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1283 * @queue: rt2x00 queue index (see &enum data_queue_qid).
1285 * Returns NULL for non tx queues.
1287 static inline struct data_queue *
1288 rt2x00queue_get_tx_queue(struct rt2x00_dev *rt2x00dev,
1289 const enum data_queue_qid queue)
1291 if (queue < rt2x00dev->ops->tx_queues && rt2x00dev->tx)
1292 return &rt2x00dev->tx[queue];
1294 if (queue == QID_ATIM)
1295 return rt2x00dev->atim;
1301 * rt2x00queue_get_entry - Get queue entry where the given index points to.
1302 * @queue: Pointer to &struct data_queue from where we obtain the entry.
1303 * @index: Index identifier for obtaining the correct index.
1305 struct queue_entry *rt2x00queue_get_entry(struct data_queue *queue,
1306 enum queue_index index);
1309 * rt2x00queue_pause_queue - Pause a data queue
1310 * @queue: Pointer to &struct data_queue.
1312 * This function will pause the data queue locally, preventing
1313 * new frames to be added to the queue (while the hardware is
1314 * still allowed to run).
1316 void rt2x00queue_pause_queue(struct data_queue *queue);
1319 * rt2x00queue_unpause_queue - unpause a data queue
1320 * @queue: Pointer to &struct data_queue.
1322 * This function will unpause the data queue locally, allowing
1323 * new frames to be added to the queue again.
1325 void rt2x00queue_unpause_queue(struct data_queue *queue);
1328 * rt2x00queue_start_queue - Start a data queue
1329 * @queue: Pointer to &struct data_queue.
1331 * This function will start handling all pending frames in the queue.
1333 void rt2x00queue_start_queue(struct data_queue *queue);
1336 * rt2x00queue_stop_queue - Halt a data queue
1337 * @queue: Pointer to &struct data_queue.
1339 * This function will stop all pending frames in the queue.
1341 void rt2x00queue_stop_queue(struct data_queue *queue);
1344 * rt2x00queue_flush_queue - Flush a data queue
1345 * @queue: Pointer to &struct data_queue.
1346 * @drop: True to drop all pending frames.
1348 * This function will flush the queue. After this call
1349 * the queue is guaranteed to be empty.
1351 void rt2x00queue_flush_queue(struct data_queue *queue, bool drop);
1354 * rt2x00queue_start_queues - Start all data queues
1355 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1357 * This function will loop through all available queues to start them
1359 void rt2x00queue_start_queues(struct rt2x00_dev *rt2x00dev);
1362 * rt2x00queue_stop_queues - Halt all data queues
1363 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1365 * This function will loop through all available queues to stop
1366 * any pending frames.
1368 void rt2x00queue_stop_queues(struct rt2x00_dev *rt2x00dev);
1371 * rt2x00queue_flush_queues - Flush all data queues
1372 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1373 * @drop: True to drop all pending frames.
1375 * This function will loop through all available queues to flush
1376 * any pending frames.
1378 void rt2x00queue_flush_queues(struct rt2x00_dev *rt2x00dev, bool drop);
1384 * rt2x00debug_dump_frame - Dump a frame to userspace through debugfs.
1385 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1386 * @type: The type of frame that is being dumped.
1387 * @skb: The skb containing the frame to be dumped.
1389 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
1390 void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
1391 enum rt2x00_dump_type type, struct sk_buff *skb);
1393 static inline void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
1394 enum rt2x00_dump_type type,
1395 struct sk_buff *skb)
1398 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
1401 * Utility functions.
1403 u32 rt2x00lib_get_bssidx(struct rt2x00_dev *rt2x00dev,
1404 struct ieee80211_vif *vif);
1407 * Interrupt context handlers.
1409 void rt2x00lib_beacondone(struct rt2x00_dev *rt2x00dev);
1410 void rt2x00lib_pretbtt(struct rt2x00_dev *rt2x00dev);
1411 void rt2x00lib_dmastart(struct queue_entry *entry);
1412 void rt2x00lib_dmadone(struct queue_entry *entry);
1413 void rt2x00lib_txdone(struct queue_entry *entry,
1414 struct txdone_entry_desc *txdesc);
1415 void rt2x00lib_txdone_noinfo(struct queue_entry *entry, u32 status);
1416 void rt2x00lib_rxdone(struct queue_entry *entry, gfp_t gfp);
1419 * mac80211 handlers.
1421 void rt2x00mac_tx(struct ieee80211_hw *hw,
1422 struct ieee80211_tx_control *control,
1423 struct sk_buff *skb);
1424 int rt2x00mac_start(struct ieee80211_hw *hw);
1425 void rt2x00mac_stop(struct ieee80211_hw *hw);
1426 int rt2x00mac_add_interface(struct ieee80211_hw *hw,
1427 struct ieee80211_vif *vif);
1428 void rt2x00mac_remove_interface(struct ieee80211_hw *hw,
1429 struct ieee80211_vif *vif);
1430 int rt2x00mac_config(struct ieee80211_hw *hw, u32 changed);
1431 void rt2x00mac_configure_filter(struct ieee80211_hw *hw,
1432 unsigned int changed_flags,
1433 unsigned int *total_flags,
1435 int rt2x00mac_set_tim(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1437 #ifdef CONFIG_RT2X00_LIB_CRYPTO
1438 int rt2x00mac_set_key(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1439 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
1440 struct ieee80211_key_conf *key);
1442 #define rt2x00mac_set_key NULL
1443 #endif /* CONFIG_RT2X00_LIB_CRYPTO */
1444 int rt2x00mac_sta_add(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1445 struct ieee80211_sta *sta);
1446 int rt2x00mac_sta_remove(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1447 struct ieee80211_sta *sta);
1448 void rt2x00mac_sw_scan_start(struct ieee80211_hw *hw,
1449 struct ieee80211_vif *vif,
1450 const u8 *mac_addr);
1451 void rt2x00mac_sw_scan_complete(struct ieee80211_hw *hw,
1452 struct ieee80211_vif *vif);
1453 int rt2x00mac_get_stats(struct ieee80211_hw *hw,
1454 struct ieee80211_low_level_stats *stats);
1455 void rt2x00mac_bss_info_changed(struct ieee80211_hw *hw,
1456 struct ieee80211_vif *vif,
1457 struct ieee80211_bss_conf *bss_conf,
1459 int rt2x00mac_conf_tx(struct ieee80211_hw *hw,
1460 struct ieee80211_vif *vif, u16 queue,
1461 const struct ieee80211_tx_queue_params *params);
1462 void rt2x00mac_rfkill_poll(struct ieee80211_hw *hw);
1463 void rt2x00mac_flush(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1464 u32 queues, bool drop);
1465 int rt2x00mac_set_antenna(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
1466 int rt2x00mac_get_antenna(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
1467 void rt2x00mac_get_ringparam(struct ieee80211_hw *hw,
1468 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
1469 bool rt2x00mac_tx_frames_pending(struct ieee80211_hw *hw);
1472 * Driver allocation handlers.
1474 int rt2x00lib_probe_dev(struct rt2x00_dev *rt2x00dev);
1475 void rt2x00lib_remove_dev(struct rt2x00_dev *rt2x00dev);
1477 int rt2x00lib_suspend(struct rt2x00_dev *rt2x00dev, pm_message_t state);
1478 int rt2x00lib_resume(struct rt2x00_dev *rt2x00dev);
1479 #endif /* CONFIG_PM */
1481 #endif /* RT2X00_H */