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/hrtimer.h>
42 #include <linux/average.h>
44 #include <net/mac80211.h>
46 #include "rt2x00debug.h"
47 #include "rt2x00dump.h"
48 #include "rt2x00leds.h"
49 #include "rt2x00reg.h"
50 #include "rt2x00queue.h"
55 #define DRV_VERSION "2.3.0"
56 #define DRV_PROJECT "http://rt2x00.serialmonkey.com"
59 * Debug output has to be enabled during compile time.
61 #ifdef CONFIG_RT2X00_DEBUG
63 #endif /* CONFIG_RT2X00_DEBUG */
65 /* Utility printing macros
66 * rt2x00_probe_err is for messages when rt2x00_dev is uninitialized
68 #define rt2x00_probe_err(fmt, ...) \
69 printk(KERN_ERR KBUILD_MODNAME ": %s: Error - " fmt, \
70 __func__, ##__VA_ARGS__)
71 #define rt2x00_err(dev, fmt, ...) \
72 wiphy_err((dev)->hw->wiphy, "%s: Error - " fmt, \
73 __func__, ##__VA_ARGS__)
74 #define rt2x00_warn(dev, fmt, ...) \
75 wiphy_warn((dev)->hw->wiphy, "%s: Warning - " fmt, \
76 __func__, ##__VA_ARGS__)
77 #define rt2x00_info(dev, fmt, ...) \
78 wiphy_info((dev)->hw->wiphy, "%s: Info - " fmt, \
79 __func__, ##__VA_ARGS__)
81 /* Various debug levels */
82 #define rt2x00_dbg(dev, fmt, ...) \
83 wiphy_dbg((dev)->hw->wiphy, "%s: Debug - " fmt, \
84 __func__, ##__VA_ARGS__)
85 #define rt2x00_eeprom_dbg(dev, fmt, ...) \
86 wiphy_dbg((dev)->hw->wiphy, "%s: EEPROM recovery - " fmt, \
87 __func__, ##__VA_ARGS__)
90 * Duration calculations
91 * The rate variable passed is: 100kbs.
92 * To convert from bytes to bits we multiply size with 8,
93 * then the size is multiplied with 10 to make the
94 * real rate -> rate argument correction.
96 #define GET_DURATION(__size, __rate) (((__size) * 8 * 10) / (__rate))
97 #define GET_DURATION_RES(__size, __rate)(((__size) * 8 * 10) % (__rate))
100 * Determine the number of L2 padding bytes required between the header and
103 #define L2PAD_SIZE(__hdrlen) (-(__hdrlen) & 3)
106 * Determine the alignment requirement,
107 * to make sure the 802.11 payload is padded to a 4-byte boundrary
108 * we must determine the address of the payload and calculate the
109 * amount of bytes needed to move the data.
111 #define ALIGN_SIZE(__skb, __header) \
112 ( ((unsigned long)((__skb)->data + (__header))) & 3 )
115 * Constants for extra TX headroom for alignment purposes.
117 #define RT2X00_ALIGN_SIZE 4 /* Only whole frame needs alignment */
118 #define RT2X00_L2PAD_SIZE 8 /* Both header & payload need alignment */
121 * Standard timing and size defines.
122 * These values should follow the ieee80211 specifications.
125 #define IEEE80211_HEADER 24
129 #define SHORT_PREAMBLE 72
131 #define SHORT_SLOT_TIME 9
133 #define PIFS ( SIFS + SLOT_TIME )
134 #define SHORT_PIFS ( SIFS + SHORT_SLOT_TIME )
135 #define DIFS ( PIFS + SLOT_TIME )
136 #define SHORT_DIFS ( SHORT_PIFS + SHORT_SLOT_TIME )
137 #define EIFS ( SIFS + DIFS + \
138 GET_DURATION(IEEE80211_HEADER + ACK_SIZE, 10) )
139 #define SHORT_EIFS ( SIFS + SHORT_DIFS + \
140 GET_DURATION(IEEE80211_HEADER + ACK_SIZE, 10) )
142 enum rt2x00_chip_intf {
143 RT2X00_CHIP_INTF_PCI,
144 RT2X00_CHIP_INTF_PCIE,
145 RT2X00_CHIP_INTF_USB,
146 RT2X00_CHIP_INTF_SOC,
150 * Chipset identification
151 * The chipset on the device is composed of a RT and RF chip.
152 * The chipset combination is important for determining device capabilities.
156 #define RT2460 0x2460
157 #define RT2560 0x2560
158 #define RT2570 0x2570
159 #define RT2661 0x2661
160 #define RT2573 0x2573
161 #define RT2860 0x2860 /* 2.4GHz */
162 #define RT2872 0x2872 /* WSOC */
163 #define RT2883 0x2883 /* WSOC */
164 #define RT3070 0x3070
165 #define RT3071 0x3071
166 #define RT3090 0x3090 /* 2.4GHz PCIe */
167 #define RT3290 0x3290
168 #define RT3352 0x3352 /* WSOC */
169 #define RT3390 0x3390
170 #define RT3572 0x3572
171 #define RT3593 0x3593
172 #define RT3883 0x3883 /* WSOC */
173 #define RT5390 0x5390 /* 2.4GHz */
174 #define RT5392 0x5392 /* 2.4GHz */
175 #define RT5592 0x5592
180 enum rt2x00_chip_intf intf;
184 * RF register values that belong to a particular channel.
195 * Channel information structure
197 struct channel_info {
199 #define GEOGRAPHY_ALLOWED 0x00000001
202 short default_power1;
203 short default_power2;
204 short default_power3;
208 * Antenna setup values.
210 struct antenna_setup {
218 * Quality statistics about the currently active link.
222 * Statistics required for Link tuning by driver
223 * The rssi value is provided by rt2x00lib during the
224 * link_tuner() callback function.
225 * The false_cca field is filled during the link_stats()
226 * callback function and could be used during the
227 * link_tuner() callback function.
234 * Hardware driver will tune the VGC level during each call
235 * to the link_tuner() callback function. This vgc_level is
236 * is determined based on the link quality statistics like
237 * average RSSI and the false CCA count.
239 * In some cases the drivers need to differentiate between
240 * the currently "desired" VGC level and the level configured
241 * in the hardware. The latter is important to reduce the
242 * number of BBP register reads to reduce register access
243 * overhead. For this reason we store both values here.
249 * Statistics required for Signal quality calculation.
250 * These fields might be changed during the link_stats()
260 * Antenna settings about the currently active link.
267 #define ANTENNA_RX_DIVERSITY 0x00000001
268 #define ANTENNA_TX_DIVERSITY 0x00000002
269 #define ANTENNA_MODE_SAMPLE 0x00000004
272 * Currently active TX/RX antenna setup.
273 * When software diversity is used, this will indicate
274 * which antenna is actually used at this time.
276 struct antenna_setup active;
279 * RSSI history information for the antenna.
280 * Used to determine when to switch antenna
281 * when using software diversity.
286 * Current RSSI average of the currently active antenna.
287 * Similar to the avg_rssi in the link_qual structure
288 * this value is updated by using the walking average.
290 struct ewma rssi_ant;
294 * To optimize the quality of the link we need to store
295 * the quality of received frames and periodically
301 * The number of times the link has been tuned
302 * since the radio has been switched on.
307 * Quality measurement values.
309 struct link_qual qual;
312 * TX/RX antenna setup.
317 * Currently active average RSSI value
319 struct ewma avg_rssi;
322 * Work structure for scheduling periodic link tuning.
324 struct delayed_work work;
327 * Work structure for scheduling periodic watchdog monitoring.
328 * This work must be scheduled on the kernel workqueue, while
329 * all other work structures must be queued on the mac80211
330 * workqueue. This guarantees that the watchdog can schedule
331 * other work structures and wait for their completion in order
332 * to bring the device/driver back into the desired state.
334 struct delayed_work watchdog_work;
337 * Work structure for scheduling periodic AGC adjustments.
339 struct delayed_work agc_work;
342 * Work structure for scheduling periodic VCO calibration.
344 struct delayed_work vco_work;
347 enum rt2x00_delayed_flags {
348 DELAYED_UPDATE_BEACON,
352 * Interface structure
353 * Per interface configuration details, this structure
354 * is allocated as the private data for ieee80211_vif.
358 * beacon->skb must be protected with the mutex.
360 struct mutex beacon_skb_mutex;
363 * Entry in the beacon queue which belongs to
364 * this interface. Each interface has its own
365 * dedicated beacon entry.
367 struct queue_entry *beacon;
371 * Actions that needed rescheduling.
373 unsigned long delayed_flags;
376 * Software sequence counter, this is only required
377 * for hardware which doesn't support hardware
383 static inline struct rt2x00_intf* vif_to_intf(struct ieee80211_vif *vif)
385 return (struct rt2x00_intf *)vif->drv_priv;
389 * struct hw_mode_spec: Hardware specifications structure
391 * Details about the supported modes, rates and channels
392 * of a particular chipset. This is used by rt2x00lib
393 * to build the ieee80211_hw_mode array for mac80211.
395 * @supported_bands: Bitmask contained the supported bands (2.4GHz, 5.2GHz).
396 * @supported_rates: Rate types which are supported (CCK, OFDM).
397 * @num_channels: Number of supported channels. This is used as array size
398 * for @tx_power_a, @tx_power_bg and @channels.
399 * @channels: Device/chipset specific channel values (See &struct rf_channel).
400 * @channels_info: Additional information for channels (See &struct channel_info).
401 * @ht: Driver HT Capabilities (See &ieee80211_sta_ht_cap).
403 struct hw_mode_spec {
404 unsigned int supported_bands;
405 #define SUPPORT_BAND_2GHZ 0x00000001
406 #define SUPPORT_BAND_5GHZ 0x00000002
408 unsigned int supported_rates;
409 #define SUPPORT_RATE_CCK 0x00000001
410 #define SUPPORT_RATE_OFDM 0x00000002
412 unsigned int num_channels;
413 const struct rf_channel *channels;
414 const struct channel_info *channels_info;
416 struct ieee80211_sta_ht_cap ht;
420 * Configuration structure wrapper around the
421 * mac80211 configuration structure.
422 * When mac80211 configures the driver, rt2x00lib
423 * can precalculate values which are equal for all
424 * rt2x00 drivers. Those values can be stored in here.
426 struct rt2x00lib_conf {
427 struct ieee80211_conf *conf;
429 struct rf_channel rf;
430 struct channel_info channel;
434 * Configuration structure for erp settings.
436 struct rt2x00lib_erp {
454 * Configuration structure for hardware encryption.
456 struct rt2x00lib_crypto {
459 enum set_key_cmd cmd;
472 * Configuration structure wrapper around the
473 * rt2x00 interface configuration handler.
475 struct rt2x00intf_conf {
479 enum nl80211_iftype type;
482 * TSF sync value, this is dependent on the operation type.
487 * The MAC and BSSID addresses are simple array of bytes,
488 * these arrays are little endian, so when sending the addresses
489 * to the drivers, copy the it into a endian-signed variable.
491 * Note that all devices (except rt2500usb) have 32 bits
492 * register word sizes. This means that whatever variable we
493 * pass _must_ be a multiple of 32 bits. Otherwise the device
494 * might not accept what we are sending to it.
495 * This will also make it easier for the driver to write
496 * the data to the device.
503 * Private structure for storing STA details
504 * wcid: Wireless Client ID
510 static inline struct rt2x00_sta* sta_to_rt2x00_sta(struct ieee80211_sta *sta)
512 return (struct rt2x00_sta *)sta->drv_priv;
516 * rt2x00lib callback functions.
518 struct rt2x00lib_ops {
520 * Interrupt handlers.
522 irq_handler_t irq_handler;
525 * TX status tasklet handler.
527 void (*txstatus_tasklet) (unsigned long data);
528 void (*pretbtt_tasklet) (unsigned long data);
529 void (*tbtt_tasklet) (unsigned long data);
530 void (*rxdone_tasklet) (unsigned long data);
531 void (*autowake_tasklet) (unsigned long data);
534 * Device init handlers.
536 int (*probe_hw) (struct rt2x00_dev *rt2x00dev);
537 char *(*get_firmware_name) (struct rt2x00_dev *rt2x00dev);
538 int (*check_firmware) (struct rt2x00_dev *rt2x00dev,
539 const u8 *data, const size_t len);
540 int (*load_firmware) (struct rt2x00_dev *rt2x00dev,
541 const u8 *data, const size_t len);
544 * Device initialization/deinitialization handlers.
546 int (*initialize) (struct rt2x00_dev *rt2x00dev);
547 void (*uninitialize) (struct rt2x00_dev *rt2x00dev);
550 * queue initialization handlers
552 bool (*get_entry_state) (struct queue_entry *entry);
553 void (*clear_entry) (struct queue_entry *entry);
556 * Radio control handlers.
558 int (*set_device_state) (struct rt2x00_dev *rt2x00dev,
559 enum dev_state state);
560 int (*rfkill_poll) (struct rt2x00_dev *rt2x00dev);
561 void (*link_stats) (struct rt2x00_dev *rt2x00dev,
562 struct link_qual *qual);
563 void (*reset_tuner) (struct rt2x00_dev *rt2x00dev,
564 struct link_qual *qual);
565 void (*link_tuner) (struct rt2x00_dev *rt2x00dev,
566 struct link_qual *qual, const u32 count);
567 void (*gain_calibration) (struct rt2x00_dev *rt2x00dev);
568 void (*vco_calibration) (struct rt2x00_dev *rt2x00dev);
571 * Data queue handlers.
573 void (*watchdog) (struct rt2x00_dev *rt2x00dev);
574 void (*start_queue) (struct data_queue *queue);
575 void (*kick_queue) (struct data_queue *queue);
576 void (*stop_queue) (struct data_queue *queue);
577 void (*flush_queue) (struct data_queue *queue, bool drop);
578 void (*tx_dma_done) (struct queue_entry *entry);
581 * TX control handlers
583 void (*write_tx_desc) (struct queue_entry *entry,
584 struct txentry_desc *txdesc);
585 void (*write_tx_data) (struct queue_entry *entry,
586 struct txentry_desc *txdesc);
587 void (*write_beacon) (struct queue_entry *entry,
588 struct txentry_desc *txdesc);
589 void (*clear_beacon) (struct queue_entry *entry);
590 int (*get_tx_data_len) (struct queue_entry *entry);
593 * RX control handlers
595 void (*fill_rxdone) (struct queue_entry *entry,
596 struct rxdone_entry_desc *rxdesc);
599 * Configuration handlers.
601 int (*config_shared_key) (struct rt2x00_dev *rt2x00dev,
602 struct rt2x00lib_crypto *crypto,
603 struct ieee80211_key_conf *key);
604 int (*config_pairwise_key) (struct rt2x00_dev *rt2x00dev,
605 struct rt2x00lib_crypto *crypto,
606 struct ieee80211_key_conf *key);
607 void (*config_filter) (struct rt2x00_dev *rt2x00dev,
608 const unsigned int filter_flags);
609 void (*config_intf) (struct rt2x00_dev *rt2x00dev,
610 struct rt2x00_intf *intf,
611 struct rt2x00intf_conf *conf,
612 const unsigned int flags);
613 #define CONFIG_UPDATE_TYPE ( 1 << 1 )
614 #define CONFIG_UPDATE_MAC ( 1 << 2 )
615 #define CONFIG_UPDATE_BSSID ( 1 << 3 )
617 void (*config_erp) (struct rt2x00_dev *rt2x00dev,
618 struct rt2x00lib_erp *erp,
620 void (*config_ant) (struct rt2x00_dev *rt2x00dev,
621 struct antenna_setup *ant);
622 void (*config) (struct rt2x00_dev *rt2x00dev,
623 struct rt2x00lib_conf *libconf,
624 const unsigned int changed_flags);
625 int (*sta_add) (struct rt2x00_dev *rt2x00dev,
626 struct ieee80211_vif *vif,
627 struct ieee80211_sta *sta);
628 int (*sta_remove) (struct rt2x00_dev *rt2x00dev,
633 * rt2x00 driver callback operation structure.
637 const unsigned int drv_data_size;
638 const unsigned int max_ap_intf;
639 const unsigned int eeprom_size;
640 const unsigned int rf_size;
641 const unsigned int tx_queues;
642 void (*queue_init)(struct data_queue *queue);
643 const struct rt2x00lib_ops *lib;
645 const struct ieee80211_ops *hw;
646 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
647 const struct rt2x00debug *debugfs;
648 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
654 enum rt2x00_state_flags {
658 DEVICE_STATE_PRESENT,
659 DEVICE_STATE_REGISTERED_HW,
660 DEVICE_STATE_INITIALIZED,
661 DEVICE_STATE_STARTED,
662 DEVICE_STATE_ENABLED_RADIO,
663 DEVICE_STATE_SCANNING,
666 * Driver configuration
674 * Mark we currently are sequentially reading TX_STA_FIFO register
675 * FIXME: this is for only rt2800usb, should go to private data
681 * rt2x00 capability flags
683 enum rt2x00_capability_flags {
688 REQUIRE_BEACON_GUARD,
693 REQUIRE_TXSTATUS_FIFO,
694 REQUIRE_TASKLET_CONTEXT,
702 CAPABILITY_HW_BUTTON,
703 CAPABILITY_HW_CRYPTO,
704 CAPABILITY_POWER_LIMIT,
705 CAPABILITY_CONTROL_FILTERS,
706 CAPABILITY_CONTROL_FILTER_PSPOLL,
707 CAPABILITY_PRE_TBTT_INTERRUPT,
708 CAPABILITY_LINK_TUNING,
709 CAPABILITY_FRAME_TYPE,
710 CAPABILITY_RF_SEQUENCE,
711 CAPABILITY_EXTERNAL_LNA_A,
712 CAPABILITY_EXTERNAL_LNA_BG,
713 CAPABILITY_DOUBLE_ANTENNA,
714 CAPABILITY_BT_COEXIST,
715 CAPABILITY_VCO_RECALIBRATION,
719 * Interface combinations
727 * rt2x00 device structure.
732 * The structure stored in here depends on the
733 * system bus (PCI or USB).
734 * When accessing this variable, the rt2x00dev_{pci,usb}
735 * macros should be used for correct typecasting.
740 * Callback functions.
742 const struct rt2x00_ops *ops;
750 * IEEE80211 control structure.
752 struct ieee80211_hw *hw;
753 struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
754 enum ieee80211_band curr_band;
758 * If enabled, the debugfs interface structures
759 * required for deregistration of debugfs.
761 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
762 struct rt2x00debug_intf *debugfs_intf;
763 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
766 * LED structure for changing the LED status
767 * by mac8011 or the kernel.
769 #ifdef CONFIG_RT2X00_LIB_LEDS
770 struct rt2x00_led led_radio;
771 struct rt2x00_led led_assoc;
772 struct rt2x00_led led_qual;
774 #endif /* CONFIG_RT2X00_LIB_LEDS */
777 * Device state flags.
778 * In these flags the current status is stored.
779 * Access to these flags should occur atomically.
784 * Device capabiltiy flags.
785 * In these flags the device/driver capabilities are stored.
786 * Access to these flags should occur non-atomically.
788 unsigned long cap_flags;
791 * Device information, Bus IRQ and name (PCI, SoC)
797 * Chipset identification.
799 struct rt2x00_chip chip;
802 * hw capability specifications.
804 struct hw_mode_spec spec;
807 * This is the default TX/RX antenna setup as indicated
808 * by the device's EEPROM.
810 struct antenna_setup default_ant;
814 * csr.base: CSR base register address. (PCI)
815 * csr.cache: CSR cache for usb_control_msg. (USB)
823 * Mutex to protect register accesses.
824 * For PCI and USB devices it protects against concurrent indirect
825 * register access (BBP, RF, MCU) since accessing those
826 * registers require multiple calls to the CSR registers.
827 * For USB devices it also protects the csr_cache since that
828 * field is used for normal CSR access and it cannot support
829 * multiple callers simultaneously.
831 struct mutex csr_mutex;
834 * Current packet filter configuration for the device.
835 * This contains all currently active FIF_* flags send
836 * to us by mac80211 during configure_filter().
838 unsigned int packet_filter;
842 * - Open ap interface count.
843 * - Open sta interface count.
844 * - Association count.
845 * - Beaconing enabled count.
847 unsigned int intf_ap_count;
848 unsigned int intf_sta_count;
849 unsigned int intf_associated;
850 unsigned int intf_beaconing;
853 * Interface combinations
855 struct ieee80211_iface_limit if_limits_ap;
856 struct ieee80211_iface_combination if_combinations[NUM_IF_COMB];
869 * Active RF register values.
870 * These are stored here so we don't need
871 * to read the rf registers and can directly
872 * use this value instead.
873 * This field should be accessed by using
874 * rt2x00_rf_read() and rt2x00_rf_write().
884 * Current TX power value.
889 * Current retry values.
895 * Rssi <-> Dbm offset
915 * Timestamp of last received beacon
917 unsigned long last_beacon;
920 * Low level statistics which will have
921 * to be kept up to date while device is running.
923 struct ieee80211_low_level_stats low_level_stats;
926 * Work queue for all work which should not be placed
927 * on the mac80211 workqueue (because of dependencies
928 * between various work structures).
930 struct workqueue_struct *workqueue;
934 * NOTE: intf_work will use ieee80211_iterate_active_interfaces()
935 * which means it cannot be placed on the hw->workqueue
936 * due to RTNL locking requirements.
938 struct work_struct intf_work;
941 * Scheduled work for TX/RX done handling (USB devices)
943 struct work_struct rxdone_work;
944 struct work_struct txdone_work;
949 struct delayed_work autowakeup_work;
950 struct work_struct sleep_work;
953 * Data queue arrays for RX, TX, Beacon and ATIM.
955 unsigned int data_queues;
956 struct data_queue *rx;
957 struct data_queue *tx;
958 struct data_queue *bcn;
959 struct data_queue *atim;
964 const struct firmware *fw;
967 * FIFO for storing tx status reports between isr and tasklet.
969 DECLARE_KFIFO_PTR(txstatus_fifo, u32);
972 * Timer to ensure tx status reports are read (rt2800usb).
974 struct hrtimer txstatus_timer;
977 * Tasklet for processing tx status reports (rt2800pci).
979 struct tasklet_struct txstatus_tasklet;
980 struct tasklet_struct pretbtt_tasklet;
981 struct tasklet_struct tbtt_tasklet;
982 struct tasklet_struct rxdone_tasklet;
983 struct tasklet_struct autowake_tasklet;
986 * Used for VCO periodic calibration.
991 * Protect the interrupt mask register.
993 spinlock_t irqmask_lock;
996 * List of BlockAckReq TX entries that need driver BlockAck processing.
998 struct list_head bar_list;
999 spinlock_t bar_list_lock;
1001 /* Extra TX headroom required for alignment purposes. */
1002 unsigned int extra_tx_headroom;
1005 struct rt2x00_bar_list_entry {
1006 struct list_head list;
1007 struct rcu_head head;
1009 struct queue_entry *entry;
1012 /* Relevant parts of the IEEE80211 BAR header */
1016 __le16 start_seq_num;
1021 * Some registers require multiple attempts before success,
1022 * in those cases REGISTER_BUSY_COUNT attempts should be
1023 * taken with a REGISTER_BUSY_DELAY interval.
1025 #define REGISTER_BUSY_COUNT 100
1026 #define REGISTER_BUSY_DELAY 100
1029 * Generic RF access.
1030 * The RF is being accessed by word index.
1032 static inline void rt2x00_rf_read(struct rt2x00_dev *rt2x00dev,
1033 const unsigned int word, u32 *data)
1035 BUG_ON(word < 1 || word > rt2x00dev->ops->rf_size / sizeof(u32));
1036 *data = rt2x00dev->rf[word - 1];
1039 static inline void rt2x00_rf_write(struct rt2x00_dev *rt2x00dev,
1040 const unsigned int word, u32 data)
1042 BUG_ON(word < 1 || word > rt2x00dev->ops->rf_size / sizeof(u32));
1043 rt2x00dev->rf[word - 1] = data;
1047 * Generic EEPROM access. The EEPROM is being accessed by word or byte index.
1049 static inline void *rt2x00_eeprom_addr(struct rt2x00_dev *rt2x00dev,
1050 const unsigned int word)
1052 return (void *)&rt2x00dev->eeprom[word];
1055 static inline void rt2x00_eeprom_read(struct rt2x00_dev *rt2x00dev,
1056 const unsigned int word, u16 *data)
1058 *data = le16_to_cpu(rt2x00dev->eeprom[word]);
1061 static inline void rt2x00_eeprom_write(struct rt2x00_dev *rt2x00dev,
1062 const unsigned int word, u16 data)
1064 rt2x00dev->eeprom[word] = cpu_to_le16(data);
1067 static inline u8 rt2x00_eeprom_byte(struct rt2x00_dev *rt2x00dev,
1068 const unsigned int byte)
1070 return *(((u8 *)rt2x00dev->eeprom) + byte);
1076 static inline void rt2x00_set_chip(struct rt2x00_dev *rt2x00dev,
1077 const u16 rt, const u16 rf, const u16 rev)
1079 rt2x00dev->chip.rt = rt;
1080 rt2x00dev->chip.rf = rf;
1081 rt2x00dev->chip.rev = rev;
1083 rt2x00_info(rt2x00dev, "Chipset detected - rt: %04x, rf: %04x, rev: %04x\n",
1084 rt2x00dev->chip.rt, rt2x00dev->chip.rf,
1085 rt2x00dev->chip.rev);
1088 static inline void rt2x00_set_rt(struct rt2x00_dev *rt2x00dev,
1089 const u16 rt, const u16 rev)
1091 rt2x00dev->chip.rt = rt;
1092 rt2x00dev->chip.rev = rev;
1094 rt2x00_info(rt2x00dev, "RT chipset %04x, rev %04x detected\n",
1095 rt2x00dev->chip.rt, rt2x00dev->chip.rev);
1098 static inline void rt2x00_set_rf(struct rt2x00_dev *rt2x00dev, const u16 rf)
1100 rt2x00dev->chip.rf = rf;
1102 rt2x00_info(rt2x00dev, "RF chipset %04x detected\n",
1103 rt2x00dev->chip.rf);
1106 static inline bool rt2x00_rt(struct rt2x00_dev *rt2x00dev, const u16 rt)
1108 return (rt2x00dev->chip.rt == rt);
1111 static inline bool rt2x00_rf(struct rt2x00_dev *rt2x00dev, const u16 rf)
1113 return (rt2x00dev->chip.rf == rf);
1116 static inline u16 rt2x00_rev(struct rt2x00_dev *rt2x00dev)
1118 return rt2x00dev->chip.rev;
1121 static inline bool rt2x00_rt_rev(struct rt2x00_dev *rt2x00dev,
1122 const u16 rt, const u16 rev)
1124 return (rt2x00_rt(rt2x00dev, rt) && rt2x00_rev(rt2x00dev) == rev);
1127 static inline bool rt2x00_rt_rev_lt(struct rt2x00_dev *rt2x00dev,
1128 const u16 rt, const u16 rev)
1130 return (rt2x00_rt(rt2x00dev, rt) && rt2x00_rev(rt2x00dev) < rev);
1133 static inline bool rt2x00_rt_rev_gte(struct rt2x00_dev *rt2x00dev,
1134 const u16 rt, const u16 rev)
1136 return (rt2x00_rt(rt2x00dev, rt) && rt2x00_rev(rt2x00dev) >= rev);
1139 static inline void rt2x00_set_chip_intf(struct rt2x00_dev *rt2x00dev,
1140 enum rt2x00_chip_intf intf)
1142 rt2x00dev->chip.intf = intf;
1145 static inline bool rt2x00_intf(struct rt2x00_dev *rt2x00dev,
1146 enum rt2x00_chip_intf intf)
1148 return (rt2x00dev->chip.intf == intf);
1151 static inline bool rt2x00_is_pci(struct rt2x00_dev *rt2x00dev)
1153 return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCI) ||
1154 rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCIE);
1157 static inline bool rt2x00_is_pcie(struct rt2x00_dev *rt2x00dev)
1159 return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCIE);
1162 static inline bool rt2x00_is_usb(struct rt2x00_dev *rt2x00dev)
1164 return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_USB);
1167 static inline bool rt2x00_is_soc(struct rt2x00_dev *rt2x00dev)
1169 return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_SOC);
1172 /* Helpers for capability flags */
1175 rt2x00_has_cap_flag(struct rt2x00_dev *rt2x00dev,
1176 enum rt2x00_capability_flags cap_flag)
1178 return test_bit(cap_flag, &rt2x00dev->cap_flags);
1182 rt2x00_has_cap_hw_crypto(struct rt2x00_dev *rt2x00dev)
1184 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_HW_CRYPTO);
1188 rt2x00_has_cap_power_limit(struct rt2x00_dev *rt2x00dev)
1190 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_POWER_LIMIT);
1194 rt2x00_has_cap_control_filters(struct rt2x00_dev *rt2x00dev)
1196 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_CONTROL_FILTERS);
1200 rt2x00_has_cap_control_filter_pspoll(struct rt2x00_dev *rt2x00dev)
1202 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_CONTROL_FILTER_PSPOLL);
1206 rt2x00_has_cap_pre_tbtt_interrupt(struct rt2x00_dev *rt2x00dev)
1208 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_PRE_TBTT_INTERRUPT);
1212 rt2x00_has_cap_link_tuning(struct rt2x00_dev *rt2x00dev)
1214 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_LINK_TUNING);
1218 rt2x00_has_cap_frame_type(struct rt2x00_dev *rt2x00dev)
1220 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_FRAME_TYPE);
1224 rt2x00_has_cap_rf_sequence(struct rt2x00_dev *rt2x00dev)
1226 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_RF_SEQUENCE);
1230 rt2x00_has_cap_external_lna_a(struct rt2x00_dev *rt2x00dev)
1232 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_EXTERNAL_LNA_A);
1236 rt2x00_has_cap_external_lna_bg(struct rt2x00_dev *rt2x00dev)
1238 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_EXTERNAL_LNA_BG);
1242 rt2x00_has_cap_double_antenna(struct rt2x00_dev *rt2x00dev)
1244 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_DOUBLE_ANTENNA);
1248 rt2x00_has_cap_bt_coexist(struct rt2x00_dev *rt2x00dev)
1250 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_BT_COEXIST);
1254 rt2x00_has_cap_vco_recalibration(struct rt2x00_dev *rt2x00dev)
1256 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_VCO_RECALIBRATION);
1260 * rt2x00queue_map_txskb - Map a skb into DMA for TX purposes.
1261 * @entry: Pointer to &struct queue_entry
1263 * Returns -ENOMEM if mapping fail, 0 otherwise.
1265 int rt2x00queue_map_txskb(struct queue_entry *entry);
1268 * rt2x00queue_unmap_skb - Unmap a skb from DMA.
1269 * @entry: Pointer to &struct queue_entry
1271 void rt2x00queue_unmap_skb(struct queue_entry *entry);
1274 * rt2x00queue_get_tx_queue - Convert tx queue index to queue pointer
1275 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1276 * @queue: rt2x00 queue index (see &enum data_queue_qid).
1278 * Returns NULL for non tx queues.
1280 static inline struct data_queue *
1281 rt2x00queue_get_tx_queue(struct rt2x00_dev *rt2x00dev,
1282 const enum data_queue_qid queue)
1284 if (queue < rt2x00dev->ops->tx_queues && rt2x00dev->tx)
1285 return &rt2x00dev->tx[queue];
1287 if (queue == QID_ATIM)
1288 return rt2x00dev->atim;
1294 * rt2x00queue_get_entry - Get queue entry where the given index points to.
1295 * @queue: Pointer to &struct data_queue from where we obtain the entry.
1296 * @index: Index identifier for obtaining the correct index.
1298 struct queue_entry *rt2x00queue_get_entry(struct data_queue *queue,
1299 enum queue_index index);
1302 * rt2x00queue_pause_queue - Pause a data queue
1303 * @queue: Pointer to &struct data_queue.
1305 * This function will pause the data queue locally, preventing
1306 * new frames to be added to the queue (while the hardware is
1307 * still allowed to run).
1309 void rt2x00queue_pause_queue(struct data_queue *queue);
1312 * rt2x00queue_unpause_queue - unpause a data queue
1313 * @queue: Pointer to &struct data_queue.
1315 * This function will unpause the data queue locally, allowing
1316 * new frames to be added to the queue again.
1318 void rt2x00queue_unpause_queue(struct data_queue *queue);
1321 * rt2x00queue_start_queue - Start a data queue
1322 * @queue: Pointer to &struct data_queue.
1324 * This function will start handling all pending frames in the queue.
1326 void rt2x00queue_start_queue(struct data_queue *queue);
1329 * rt2x00queue_stop_queue - Halt a data queue
1330 * @queue: Pointer to &struct data_queue.
1332 * This function will stop all pending frames in the queue.
1334 void rt2x00queue_stop_queue(struct data_queue *queue);
1337 * rt2x00queue_flush_queue - Flush a data queue
1338 * @queue: Pointer to &struct data_queue.
1339 * @drop: True to drop all pending frames.
1341 * This function will flush the queue. After this call
1342 * the queue is guaranteed to be empty.
1344 void rt2x00queue_flush_queue(struct data_queue *queue, bool drop);
1347 * rt2x00queue_start_queues - Start all data queues
1348 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1350 * This function will loop through all available queues to start them
1352 void rt2x00queue_start_queues(struct rt2x00_dev *rt2x00dev);
1355 * rt2x00queue_stop_queues - Halt all data queues
1356 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1358 * This function will loop through all available queues to stop
1359 * any pending frames.
1361 void rt2x00queue_stop_queues(struct rt2x00_dev *rt2x00dev);
1364 * rt2x00queue_flush_queues - Flush all data queues
1365 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1366 * @drop: True to drop all pending frames.
1368 * This function will loop through all available queues to flush
1369 * any pending frames.
1371 void rt2x00queue_flush_queues(struct rt2x00_dev *rt2x00dev, bool drop);
1377 * rt2x00debug_dump_frame - Dump a frame to userspace through debugfs.
1378 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1379 * @type: The type of frame that is being dumped.
1380 * @skb: The skb containing the frame to be dumped.
1382 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
1383 void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
1384 enum rt2x00_dump_type type, struct sk_buff *skb);
1386 static inline void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
1387 enum rt2x00_dump_type type,
1388 struct sk_buff *skb)
1391 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
1394 * Utility functions.
1396 u32 rt2x00lib_get_bssidx(struct rt2x00_dev *rt2x00dev,
1397 struct ieee80211_vif *vif);
1400 * Interrupt context handlers.
1402 void rt2x00lib_beacondone(struct rt2x00_dev *rt2x00dev);
1403 void rt2x00lib_pretbtt(struct rt2x00_dev *rt2x00dev);
1404 void rt2x00lib_dmastart(struct queue_entry *entry);
1405 void rt2x00lib_dmadone(struct queue_entry *entry);
1406 void rt2x00lib_txdone(struct queue_entry *entry,
1407 struct txdone_entry_desc *txdesc);
1408 void rt2x00lib_txdone_noinfo(struct queue_entry *entry, u32 status);
1409 void rt2x00lib_rxdone(struct queue_entry *entry, gfp_t gfp);
1412 * mac80211 handlers.
1414 void rt2x00mac_tx(struct ieee80211_hw *hw,
1415 struct ieee80211_tx_control *control,
1416 struct sk_buff *skb);
1417 int rt2x00mac_start(struct ieee80211_hw *hw);
1418 void rt2x00mac_stop(struct ieee80211_hw *hw);
1419 int rt2x00mac_add_interface(struct ieee80211_hw *hw,
1420 struct ieee80211_vif *vif);
1421 void rt2x00mac_remove_interface(struct ieee80211_hw *hw,
1422 struct ieee80211_vif *vif);
1423 int rt2x00mac_config(struct ieee80211_hw *hw, u32 changed);
1424 void rt2x00mac_configure_filter(struct ieee80211_hw *hw,
1425 unsigned int changed_flags,
1426 unsigned int *total_flags,
1428 int rt2x00mac_set_tim(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1430 #ifdef CONFIG_RT2X00_LIB_CRYPTO
1431 int rt2x00mac_set_key(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1432 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
1433 struct ieee80211_key_conf *key);
1435 #define rt2x00mac_set_key NULL
1436 #endif /* CONFIG_RT2X00_LIB_CRYPTO */
1437 int rt2x00mac_sta_add(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1438 struct ieee80211_sta *sta);
1439 int rt2x00mac_sta_remove(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1440 struct ieee80211_sta *sta);
1441 void rt2x00mac_sw_scan_start(struct ieee80211_hw *hw);
1442 void rt2x00mac_sw_scan_complete(struct ieee80211_hw *hw);
1443 int rt2x00mac_get_stats(struct ieee80211_hw *hw,
1444 struct ieee80211_low_level_stats *stats);
1445 void rt2x00mac_bss_info_changed(struct ieee80211_hw *hw,
1446 struct ieee80211_vif *vif,
1447 struct ieee80211_bss_conf *bss_conf,
1449 int rt2x00mac_conf_tx(struct ieee80211_hw *hw,
1450 struct ieee80211_vif *vif, u16 queue,
1451 const struct ieee80211_tx_queue_params *params);
1452 void rt2x00mac_rfkill_poll(struct ieee80211_hw *hw);
1453 void rt2x00mac_flush(struct ieee80211_hw *hw, u32 queues, bool drop);
1454 int rt2x00mac_set_antenna(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
1455 int rt2x00mac_get_antenna(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
1456 void rt2x00mac_get_ringparam(struct ieee80211_hw *hw,
1457 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
1458 bool rt2x00mac_tx_frames_pending(struct ieee80211_hw *hw);
1461 * Driver allocation handlers.
1463 int rt2x00lib_probe_dev(struct rt2x00_dev *rt2x00dev);
1464 void rt2x00lib_remove_dev(struct rt2x00_dev *rt2x00dev);
1466 int rt2x00lib_suspend(struct rt2x00_dev *rt2x00dev, pm_message_t state);
1467 int rt2x00lib_resume(struct rt2x00_dev *rt2x00dev);
1468 #endif /* CONFIG_PM */
1470 #endif /* RT2X00_H */