1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 Copyright (C) 2010 Willow Garage <http://www.willowgarage.com>
4 Copyright (C) 2004 - 2010 Ivo van Doorn <IvDoorn@gmail.com>
5 Copyright (C) 2004 - 2009 Gertjan van Wingerde <gwingerde@gmail.com>
6 <http://rt2x00.serialmonkey.com>
12 Abstract: rt2x00 global information.
18 #include <linux/bitops.h>
19 #include <linux/interrupt.h>
20 #include <linux/skbuff.h>
21 #include <linux/workqueue.h>
22 #include <linux/firmware.h>
23 #include <linux/leds.h>
24 #include <linux/mutex.h>
25 #include <linux/etherdevice.h>
26 #include <linux/input-polldev.h>
27 #include <linux/kfifo.h>
28 #include <linux/hrtimer.h>
29 #include <linux/average.h>
30 #include <linux/usb.h>
31 #include <linux/clk.h>
33 #include <net/mac80211.h>
35 #include "rt2x00debug.h"
36 #include "rt2x00dump.h"
37 #include "rt2x00leds.h"
38 #include "rt2x00reg.h"
39 #include "rt2x00queue.h"
44 #define DRV_VERSION "2.3.0"
45 #define DRV_PROJECT "http://rt2x00.serialmonkey.com"
48 * Debug output has to be enabled during compile time.
50 #ifdef CONFIG_RT2X00_DEBUG
52 #endif /* CONFIG_RT2X00_DEBUG */
54 /* Utility printing macros
55 * rt2x00_probe_err is for messages when rt2x00_dev is uninitialized
57 #define rt2x00_probe_err(fmt, ...) \
58 printk(KERN_ERR KBUILD_MODNAME ": %s: Error - " fmt, \
59 __func__, ##__VA_ARGS__)
60 #define rt2x00_err(dev, fmt, ...) \
61 wiphy_err_ratelimited((dev)->hw->wiphy, "%s: Error - " fmt, \
62 __func__, ##__VA_ARGS__)
63 #define rt2x00_warn(dev, fmt, ...) \
64 wiphy_warn_ratelimited((dev)->hw->wiphy, "%s: Warning - " fmt, \
65 __func__, ##__VA_ARGS__)
66 #define rt2x00_info(dev, fmt, ...) \
67 wiphy_info((dev)->hw->wiphy, "%s: Info - " fmt, \
68 __func__, ##__VA_ARGS__)
70 /* Various debug levels */
71 #define rt2x00_dbg(dev, fmt, ...) \
72 wiphy_dbg((dev)->hw->wiphy, "%s: Debug - " fmt, \
73 __func__, ##__VA_ARGS__)
74 #define rt2x00_eeprom_dbg(dev, fmt, ...) \
75 wiphy_dbg((dev)->hw->wiphy, "%s: EEPROM recovery - " fmt, \
76 __func__, ##__VA_ARGS__)
79 * Duration calculations
80 * The rate variable passed is: 100kbs.
81 * To convert from bytes to bits we multiply size with 8,
82 * then the size is multiplied with 10 to make the
83 * real rate -> rate argument correction.
85 #define GET_DURATION(__size, __rate) (((__size) * 8 * 10) / (__rate))
86 #define GET_DURATION_RES(__size, __rate)(((__size) * 8 * 10) % (__rate))
89 * Determine the number of L2 padding bytes required between the header and
92 #define L2PAD_SIZE(__hdrlen) (-(__hdrlen) & 3)
95 * Determine the alignment requirement,
96 * to make sure the 802.11 payload is padded to a 4-byte boundrary
97 * we must determine the address of the payload and calculate the
98 * amount of bytes needed to move the data.
100 #define ALIGN_SIZE(__skb, __header) \
101 (((unsigned long)((__skb)->data + (__header))) & 3)
104 * Constants for extra TX headroom for alignment purposes.
106 #define RT2X00_ALIGN_SIZE 4 /* Only whole frame needs alignment */
107 #define RT2X00_L2PAD_SIZE 8 /* Both header & payload need alignment */
110 * Standard timing and size defines.
111 * These values should follow the ieee80211 specifications.
114 #define IEEE80211_HEADER 24
118 #define SHORT_PREAMBLE 72
120 #define SHORT_SLOT_TIME 9
122 #define PIFS (SIFS + SLOT_TIME)
123 #define SHORT_PIFS (SIFS + SHORT_SLOT_TIME)
124 #define DIFS (PIFS + SLOT_TIME)
125 #define SHORT_DIFS (SHORT_PIFS + SHORT_SLOT_TIME)
126 #define EIFS (SIFS + DIFS + \
127 GET_DURATION(IEEE80211_HEADER + ACK_SIZE, 10))
128 #define SHORT_EIFS (SIFS + SHORT_DIFS + \
129 GET_DURATION(IEEE80211_HEADER + ACK_SIZE, 10))
131 enum rt2x00_chip_intf {
132 RT2X00_CHIP_INTF_PCI,
133 RT2X00_CHIP_INTF_PCIE,
134 RT2X00_CHIP_INTF_USB,
135 RT2X00_CHIP_INTF_SOC,
139 * Chipset identification
140 * The chipset on the device is composed of a RT and RF chip.
141 * The chipset combination is important for determining device capabilities.
145 #define RT2460 0x2460
146 #define RT2560 0x2560
147 #define RT2570 0x2570
148 #define RT2661 0x2661
149 #define RT2573 0x2573
150 #define RT2860 0x2860 /* 2.4GHz */
151 #define RT2872 0x2872 /* WSOC */
152 #define RT2883 0x2883 /* WSOC */
153 #define RT3070 0x3070
154 #define RT3071 0x3071
155 #define RT3090 0x3090 /* 2.4GHz PCIe */
156 #define RT3290 0x3290
157 #define RT3352 0x3352 /* WSOC */
158 #define RT3390 0x3390
159 #define RT3572 0x3572
160 #define RT3593 0x3593
161 #define RT3883 0x3883 /* WSOC */
162 #define RT5350 0x5350 /* WSOC 2.4GHz */
163 #define RT5390 0x5390 /* 2.4GHz */
164 #define RT5392 0x5392 /* 2.4GHz */
165 #define RT5592 0x5592
166 #define RT6352 0x6352 /* WSOC 2.4GHz */
171 enum rt2x00_chip_intf intf;
175 * RF register values that belong to a particular channel.
186 * Channel information structure
188 struct channel_info {
190 #define GEOGRAPHY_ALLOWED 0x00000001
193 short default_power1;
194 short default_power2;
195 short default_power3;
199 * Antenna setup values.
201 struct antenna_setup {
209 * Quality statistics about the currently active link.
213 * Statistics required for Link tuning by driver
214 * The rssi value is provided by rt2x00lib during the
215 * link_tuner() callback function.
216 * The false_cca field is filled during the link_stats()
217 * callback function and could be used during the
218 * link_tuner() callback function.
225 * Hardware driver will tune the VGC level during each call
226 * to the link_tuner() callback function. This vgc_level is
227 * is determined based on the link quality statistics like
228 * average RSSI and the false CCA count.
230 * In some cases the drivers need to differentiate between
231 * the currently "desired" VGC level and the level configured
232 * in the hardware. The latter is important to reduce the
233 * number of BBP register reads to reduce register access
234 * overhead. For this reason we store both values here.
240 * Statistics required for Signal quality calculation.
241 * These fields might be changed during the link_stats()
250 DECLARE_EWMA(rssi, 10, 8)
253 * Antenna settings about the currently active link.
260 #define ANTENNA_RX_DIVERSITY 0x00000001
261 #define ANTENNA_TX_DIVERSITY 0x00000002
262 #define ANTENNA_MODE_SAMPLE 0x00000004
265 * Currently active TX/RX antenna setup.
266 * When software diversity is used, this will indicate
267 * which antenna is actually used at this time.
269 struct antenna_setup active;
272 * RSSI history information for the antenna.
273 * Used to determine when to switch antenna
274 * when using software diversity.
279 * Current RSSI average of the currently active antenna.
280 * Similar to the avg_rssi in the link_qual structure
281 * this value is updated by using the walking average.
283 struct ewma_rssi rssi_ant;
287 * To optimize the quality of the link we need to store
288 * the quality of received frames and periodically
294 * The number of times the link has been tuned
295 * since the radio has been switched on.
300 * Quality measurement values.
302 struct link_qual qual;
305 * TX/RX antenna setup.
310 * Currently active average RSSI value
312 struct ewma_rssi avg_rssi;
315 * Work structure for scheduling periodic link tuning.
317 struct delayed_work work;
320 * Work structure for scheduling periodic watchdog monitoring.
321 * This work must be scheduled on the kernel workqueue, while
322 * all other work structures must be queued on the mac80211
323 * workqueue. This guarantees that the watchdog can schedule
324 * other work structures and wait for their completion in order
325 * to bring the device/driver back into the desired state.
327 struct delayed_work watchdog_work;
328 unsigned int watchdog_interval;
331 * Work structure for scheduling periodic AGC adjustments.
333 struct delayed_work agc_work;
336 * Work structure for scheduling periodic VCO calibration.
338 struct delayed_work vco_work;
341 enum rt2x00_delayed_flags {
342 DELAYED_UPDATE_BEACON,
346 * Interface structure
347 * Per interface configuration details, this structure
348 * is allocated as the private data for ieee80211_vif.
352 * beacon->skb must be protected with the mutex.
354 struct mutex beacon_skb_mutex;
357 * Entry in the beacon queue which belongs to
358 * this interface. Each interface has its own
359 * dedicated beacon entry.
361 struct queue_entry *beacon;
365 * Actions that needed rescheduling.
367 unsigned long delayed_flags;
370 * Software sequence counter, this is only required
371 * for hardware which doesn't support hardware
377 static inline struct rt2x00_intf* vif_to_intf(struct ieee80211_vif *vif)
379 return (struct rt2x00_intf *)vif->drv_priv;
383 * struct hw_mode_spec: Hardware specifications structure
385 * Details about the supported modes, rates and channels
386 * of a particular chipset. This is used by rt2x00lib
387 * to build the ieee80211_hw_mode array for mac80211.
389 * @supported_bands: Bitmask contained the supported bands (2.4GHz, 5.2GHz).
390 * @supported_rates: Rate types which are supported (CCK, OFDM).
391 * @num_channels: Number of supported channels. This is used as array size
392 * for @tx_power_a, @tx_power_bg and @channels.
393 * @channels: Device/chipset specific channel values (See &struct rf_channel).
394 * @channels_info: Additional information for channels (See &struct channel_info).
395 * @ht: Driver HT Capabilities (See &ieee80211_sta_ht_cap).
397 struct hw_mode_spec {
398 unsigned int supported_bands;
399 #define SUPPORT_BAND_2GHZ 0x00000001
400 #define SUPPORT_BAND_5GHZ 0x00000002
402 unsigned int supported_rates;
403 #define SUPPORT_RATE_CCK 0x00000001
404 #define SUPPORT_RATE_OFDM 0x00000002
406 unsigned int num_channels;
407 const struct rf_channel *channels;
408 const struct channel_info *channels_info;
410 struct ieee80211_sta_ht_cap ht;
414 * Configuration structure wrapper around the
415 * mac80211 configuration structure.
416 * When mac80211 configures the driver, rt2x00lib
417 * can precalculate values which are equal for all
418 * rt2x00 drivers. Those values can be stored in here.
420 struct rt2x00lib_conf {
421 struct ieee80211_conf *conf;
423 struct rf_channel rf;
424 struct channel_info channel;
428 * Configuration structure for erp settings.
430 struct rt2x00lib_erp {
448 * Configuration structure for hardware encryption.
450 struct rt2x00lib_crypto {
453 enum set_key_cmd cmd;
466 * Configuration structure wrapper around the
467 * rt2x00 interface configuration handler.
469 struct rt2x00intf_conf {
473 enum nl80211_iftype type;
476 * TSF sync value, this is dependent on the operation type.
481 * The MAC and BSSID addresses are simple array of bytes,
482 * these arrays are little endian, so when sending the addresses
483 * to the drivers, copy the it into a endian-signed variable.
485 * Note that all devices (except rt2500usb) have 32 bits
486 * register word sizes. This means that whatever variable we
487 * pass _must_ be a multiple of 32 bits. Otherwise the device
488 * might not accept what we are sending to it.
489 * This will also make it easier for the driver to write
490 * the data to the device.
497 * Private structure for storing STA details
498 * wcid: Wireless Client ID
504 static inline struct rt2x00_sta* sta_to_rt2x00_sta(struct ieee80211_sta *sta)
506 return (struct rt2x00_sta *)sta->drv_priv;
510 * rt2x00lib callback functions.
512 struct rt2x00lib_ops {
514 * Interrupt handlers.
516 irq_handler_t irq_handler;
519 * TX status tasklet handler.
521 void (*txstatus_tasklet) (unsigned long data);
522 void (*pretbtt_tasklet) (unsigned long data);
523 void (*tbtt_tasklet) (unsigned long data);
524 void (*rxdone_tasklet) (unsigned long data);
525 void (*autowake_tasklet) (unsigned long data);
528 * Device init handlers.
530 int (*probe_hw) (struct rt2x00_dev *rt2x00dev);
531 char *(*get_firmware_name) (struct rt2x00_dev *rt2x00dev);
532 int (*check_firmware) (struct rt2x00_dev *rt2x00dev,
533 const u8 *data, const size_t len);
534 int (*load_firmware) (struct rt2x00_dev *rt2x00dev,
535 const u8 *data, const size_t len);
538 * Device initialization/deinitialization handlers.
540 int (*initialize) (struct rt2x00_dev *rt2x00dev);
541 void (*uninitialize) (struct rt2x00_dev *rt2x00dev);
544 * queue initialization handlers
546 bool (*get_entry_state) (struct queue_entry *entry);
547 void (*clear_entry) (struct queue_entry *entry);
550 * Radio control handlers.
552 int (*set_device_state) (struct rt2x00_dev *rt2x00dev,
553 enum dev_state state);
554 int (*rfkill_poll) (struct rt2x00_dev *rt2x00dev);
555 void (*link_stats) (struct rt2x00_dev *rt2x00dev,
556 struct link_qual *qual);
557 void (*reset_tuner) (struct rt2x00_dev *rt2x00dev,
558 struct link_qual *qual);
559 void (*link_tuner) (struct rt2x00_dev *rt2x00dev,
560 struct link_qual *qual, const u32 count);
561 void (*gain_calibration) (struct rt2x00_dev *rt2x00dev);
562 void (*vco_calibration) (struct rt2x00_dev *rt2x00dev);
565 * Data queue handlers.
567 void (*watchdog) (struct rt2x00_dev *rt2x00dev);
568 void (*start_queue) (struct data_queue *queue);
569 void (*kick_queue) (struct data_queue *queue);
570 void (*stop_queue) (struct data_queue *queue);
571 void (*flush_queue) (struct data_queue *queue, bool drop);
572 void (*tx_dma_done) (struct queue_entry *entry);
575 * TX control handlers
577 void (*write_tx_desc) (struct queue_entry *entry,
578 struct txentry_desc *txdesc);
579 void (*write_tx_data) (struct queue_entry *entry,
580 struct txentry_desc *txdesc);
581 void (*write_beacon) (struct queue_entry *entry,
582 struct txentry_desc *txdesc);
583 void (*clear_beacon) (struct queue_entry *entry);
584 int (*get_tx_data_len) (struct queue_entry *entry);
587 * RX control handlers
589 void (*fill_rxdone) (struct queue_entry *entry,
590 struct rxdone_entry_desc *rxdesc);
593 * Configuration handlers.
595 int (*config_shared_key) (struct rt2x00_dev *rt2x00dev,
596 struct rt2x00lib_crypto *crypto,
597 struct ieee80211_key_conf *key);
598 int (*config_pairwise_key) (struct rt2x00_dev *rt2x00dev,
599 struct rt2x00lib_crypto *crypto,
600 struct ieee80211_key_conf *key);
601 void (*config_filter) (struct rt2x00_dev *rt2x00dev,
602 const unsigned int filter_flags);
603 void (*config_intf) (struct rt2x00_dev *rt2x00dev,
604 struct rt2x00_intf *intf,
605 struct rt2x00intf_conf *conf,
606 const unsigned int flags);
607 #define CONFIG_UPDATE_TYPE ( 1 << 1 )
608 #define CONFIG_UPDATE_MAC ( 1 << 2 )
609 #define CONFIG_UPDATE_BSSID ( 1 << 3 )
611 void (*config_erp) (struct rt2x00_dev *rt2x00dev,
612 struct rt2x00lib_erp *erp,
614 void (*config_ant) (struct rt2x00_dev *rt2x00dev,
615 struct antenna_setup *ant);
616 void (*config) (struct rt2x00_dev *rt2x00dev,
617 struct rt2x00lib_conf *libconf,
618 const unsigned int changed_flags);
619 int (*sta_add) (struct rt2x00_dev *rt2x00dev,
620 struct ieee80211_vif *vif,
621 struct ieee80211_sta *sta);
622 int (*sta_remove) (struct rt2x00_dev *rt2x00dev,
623 struct ieee80211_sta *sta);
627 * rt2x00 driver callback operation structure.
631 const unsigned int drv_data_size;
632 const unsigned int max_ap_intf;
633 const unsigned int eeprom_size;
634 const unsigned int rf_size;
635 const unsigned int tx_queues;
636 void (*queue_init)(struct data_queue *queue);
637 const struct rt2x00lib_ops *lib;
639 const struct ieee80211_ops *hw;
640 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
641 const struct rt2x00debug *debugfs;
642 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
648 enum rt2x00_state_flags {
652 DEVICE_STATE_PRESENT,
653 DEVICE_STATE_REGISTERED_HW,
654 DEVICE_STATE_INITIALIZED,
655 DEVICE_STATE_STARTED,
656 DEVICE_STATE_ENABLED_RADIO,
657 DEVICE_STATE_SCANNING,
658 DEVICE_STATE_FLUSHING,
661 * Driver configuration
669 * Mark we currently are sequentially reading TX_STA_FIFO register
670 * FIXME: this is for only rt2800usb, should go to private data
676 * rt2x00 capability flags
678 enum rt2x00_capability_flags {
683 REQUIRE_BEACON_GUARD,
688 REQUIRE_TXSTATUS_FIFO,
689 REQUIRE_TASKLET_CONTEXT,
693 REQUIRE_DELAYED_RFKILL,
698 CAPABILITY_HW_BUTTON,
699 CAPABILITY_HW_CRYPTO,
700 CAPABILITY_POWER_LIMIT,
701 CAPABILITY_CONTROL_FILTERS,
702 CAPABILITY_CONTROL_FILTER_PSPOLL,
703 CAPABILITY_PRE_TBTT_INTERRUPT,
704 CAPABILITY_LINK_TUNING,
705 CAPABILITY_FRAME_TYPE,
706 CAPABILITY_RF_SEQUENCE,
707 CAPABILITY_EXTERNAL_LNA_A,
708 CAPABILITY_EXTERNAL_LNA_BG,
709 CAPABILITY_DOUBLE_ANTENNA,
710 CAPABILITY_BT_COEXIST,
711 CAPABILITY_VCO_RECALIBRATION,
712 CAPABILITY_EXTERNAL_PA_TX0,
713 CAPABILITY_EXTERNAL_PA_TX1,
717 * Interface combinations
725 * rt2x00 device structure.
730 * The structure stored in here depends on the
731 * system bus (PCI or USB).
732 * When accessing this variable, the rt2x00dev_{pci,usb}
733 * macros should be used for correct typecasting.
738 * Callback functions.
740 const struct rt2x00_ops *ops;
748 * IEEE80211 control structure.
750 struct ieee80211_hw *hw;
751 struct ieee80211_supported_band bands[NUM_NL80211_BANDS];
752 enum nl80211_band curr_band;
756 * If enabled, the debugfs interface structures
757 * required for deregistration of debugfs.
759 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
760 struct rt2x00debug_intf *debugfs_intf;
761 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
764 * LED structure for changing the LED status
765 * by mac8011 or the kernel.
767 #ifdef CONFIG_RT2X00_LIB_LEDS
768 struct rt2x00_led led_radio;
769 struct rt2x00_led led_assoc;
770 struct rt2x00_led led_qual;
772 #endif /* CONFIG_RT2X00_LIB_LEDS */
775 * Device state flags.
776 * In these flags the current status is stored.
777 * Access to these flags should occur atomically.
782 * Device capabiltiy flags.
783 * In these flags the device/driver capabilities are stored.
784 * Access to these flags should occur non-atomically.
786 unsigned long cap_flags;
789 * Device information, Bus IRQ and name (PCI, SoC)
795 * Chipset identification.
797 struct rt2x00_chip chip;
800 * hw capability specifications.
802 struct hw_mode_spec spec;
805 * This is the default TX/RX antenna setup as indicated
806 * by the device's EEPROM.
808 struct antenna_setup default_ant;
812 * csr.base: CSR base register address. (PCI)
813 * csr.cache: CSR cache for usb_control_msg. (USB)
821 * Mutex to protect register accesses.
822 * For PCI and USB devices it protects against concurrent indirect
823 * register access (BBP, RF, MCU) since accessing those
824 * registers require multiple calls to the CSR registers.
825 * For USB devices it also protects the csr_cache since that
826 * field is used for normal CSR access and it cannot support
827 * multiple callers simultaneously.
829 struct mutex csr_mutex;
832 * Mutex to synchronize config and link tuner.
834 struct mutex conf_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;
1007 unsigned int num_proto_errs;
1009 /* Clock for System On Chip devices. */
1013 struct rt2x00_bar_list_entry {
1014 struct list_head list;
1015 struct rcu_head head;
1017 struct queue_entry *entry;
1020 /* Relevant parts of the IEEE80211 BAR header */
1024 __le16 start_seq_num;
1029 * Some registers require multiple attempts before success,
1030 * in those cases REGISTER_BUSY_COUNT attempts should be
1031 * taken with a REGISTER_BUSY_DELAY interval. Due to USB
1032 * bus delays, we do not have to loop so many times to wait
1033 * for valid register value on that bus.
1035 #define REGISTER_BUSY_COUNT 100
1036 #define REGISTER_USB_BUSY_COUNT 20
1037 #define REGISTER_BUSY_DELAY 100
1040 * Generic RF access.
1041 * The RF is being accessed by word index.
1043 static inline u32 rt2x00_rf_read(struct rt2x00_dev *rt2x00dev,
1044 const unsigned int word)
1046 BUG_ON(word < 1 || word > rt2x00dev->ops->rf_size / sizeof(u32));
1047 return rt2x00dev->rf[word - 1];
1050 static inline void rt2x00_rf_write(struct rt2x00_dev *rt2x00dev,
1051 const unsigned int word, u32 data)
1053 BUG_ON(word < 1 || word > rt2x00dev->ops->rf_size / sizeof(u32));
1054 rt2x00dev->rf[word - 1] = data;
1058 * Generic EEPROM access. The EEPROM is being accessed by word or byte index.
1060 static inline void *rt2x00_eeprom_addr(struct rt2x00_dev *rt2x00dev,
1061 const unsigned int word)
1063 return (void *)&rt2x00dev->eeprom[word];
1066 static inline u16 rt2x00_eeprom_read(struct rt2x00_dev *rt2x00dev,
1067 const unsigned int word)
1069 return le16_to_cpu(rt2x00dev->eeprom[word]);
1072 static inline void rt2x00_eeprom_write(struct rt2x00_dev *rt2x00dev,
1073 const unsigned int word, u16 data)
1075 rt2x00dev->eeprom[word] = cpu_to_le16(data);
1078 static inline u8 rt2x00_eeprom_byte(struct rt2x00_dev *rt2x00dev,
1079 const unsigned int byte)
1081 return *(((u8 *)rt2x00dev->eeprom) + byte);
1087 static inline void rt2x00_set_chip(struct rt2x00_dev *rt2x00dev,
1088 const u16 rt, const u16 rf, const u16 rev)
1090 rt2x00dev->chip.rt = rt;
1091 rt2x00dev->chip.rf = rf;
1092 rt2x00dev->chip.rev = rev;
1094 rt2x00_info(rt2x00dev, "Chipset detected - rt: %04x, rf: %04x, rev: %04x\n",
1095 rt2x00dev->chip.rt, rt2x00dev->chip.rf,
1096 rt2x00dev->chip.rev);
1099 static inline void rt2x00_set_rt(struct rt2x00_dev *rt2x00dev,
1100 const u16 rt, const u16 rev)
1102 rt2x00dev->chip.rt = rt;
1103 rt2x00dev->chip.rev = rev;
1105 rt2x00_info(rt2x00dev, "RT chipset %04x, rev %04x detected\n",
1106 rt2x00dev->chip.rt, rt2x00dev->chip.rev);
1109 static inline void rt2x00_set_rf(struct rt2x00_dev *rt2x00dev, const u16 rf)
1111 rt2x00dev->chip.rf = rf;
1113 rt2x00_info(rt2x00dev, "RF chipset %04x detected\n",
1114 rt2x00dev->chip.rf);
1117 static inline bool rt2x00_rt(struct rt2x00_dev *rt2x00dev, const u16 rt)
1119 return (rt2x00dev->chip.rt == rt);
1122 static inline bool rt2x00_rf(struct rt2x00_dev *rt2x00dev, const u16 rf)
1124 return (rt2x00dev->chip.rf == rf);
1127 static inline u16 rt2x00_rev(struct rt2x00_dev *rt2x00dev)
1129 return rt2x00dev->chip.rev;
1132 static inline bool rt2x00_rt_rev(struct rt2x00_dev *rt2x00dev,
1133 const u16 rt, const u16 rev)
1135 return (rt2x00_rt(rt2x00dev, rt) && rt2x00_rev(rt2x00dev) == rev);
1138 static inline bool rt2x00_rt_rev_lt(struct rt2x00_dev *rt2x00dev,
1139 const u16 rt, const u16 rev)
1141 return (rt2x00_rt(rt2x00dev, rt) && rt2x00_rev(rt2x00dev) < rev);
1144 static inline bool rt2x00_rt_rev_gte(struct rt2x00_dev *rt2x00dev,
1145 const u16 rt, const u16 rev)
1147 return (rt2x00_rt(rt2x00dev, rt) && rt2x00_rev(rt2x00dev) >= rev);
1150 static inline void rt2x00_set_chip_intf(struct rt2x00_dev *rt2x00dev,
1151 enum rt2x00_chip_intf intf)
1153 rt2x00dev->chip.intf = intf;
1156 static inline bool rt2x00_intf(struct rt2x00_dev *rt2x00dev,
1157 enum rt2x00_chip_intf intf)
1159 return (rt2x00dev->chip.intf == intf);
1162 static inline bool rt2x00_is_pci(struct rt2x00_dev *rt2x00dev)
1164 return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCI) ||
1165 rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCIE);
1168 static inline bool rt2x00_is_pcie(struct rt2x00_dev *rt2x00dev)
1170 return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCIE);
1173 static inline bool rt2x00_is_usb(struct rt2x00_dev *rt2x00dev)
1175 return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_USB);
1178 static inline bool rt2x00_is_soc(struct rt2x00_dev *rt2x00dev)
1180 return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_SOC);
1183 /* Helpers for capability flags */
1186 rt2x00_has_cap_flag(struct rt2x00_dev *rt2x00dev,
1187 enum rt2x00_capability_flags cap_flag)
1189 return test_bit(cap_flag, &rt2x00dev->cap_flags);
1193 rt2x00_has_cap_hw_crypto(struct rt2x00_dev *rt2x00dev)
1195 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_HW_CRYPTO);
1199 rt2x00_has_cap_power_limit(struct rt2x00_dev *rt2x00dev)
1201 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_POWER_LIMIT);
1205 rt2x00_has_cap_control_filters(struct rt2x00_dev *rt2x00dev)
1207 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_CONTROL_FILTERS);
1211 rt2x00_has_cap_control_filter_pspoll(struct rt2x00_dev *rt2x00dev)
1213 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_CONTROL_FILTER_PSPOLL);
1217 rt2x00_has_cap_pre_tbtt_interrupt(struct rt2x00_dev *rt2x00dev)
1219 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_PRE_TBTT_INTERRUPT);
1223 rt2x00_has_cap_link_tuning(struct rt2x00_dev *rt2x00dev)
1225 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_LINK_TUNING);
1229 rt2x00_has_cap_frame_type(struct rt2x00_dev *rt2x00dev)
1231 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_FRAME_TYPE);
1235 rt2x00_has_cap_rf_sequence(struct rt2x00_dev *rt2x00dev)
1237 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_RF_SEQUENCE);
1241 rt2x00_has_cap_external_lna_a(struct rt2x00_dev *rt2x00dev)
1243 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_EXTERNAL_LNA_A);
1247 rt2x00_has_cap_external_lna_bg(struct rt2x00_dev *rt2x00dev)
1249 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_EXTERNAL_LNA_BG);
1253 rt2x00_has_cap_double_antenna(struct rt2x00_dev *rt2x00dev)
1255 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_DOUBLE_ANTENNA);
1259 rt2x00_has_cap_bt_coexist(struct rt2x00_dev *rt2x00dev)
1261 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_BT_COEXIST);
1265 rt2x00_has_cap_vco_recalibration(struct rt2x00_dev *rt2x00dev)
1267 return rt2x00_has_cap_flag(rt2x00dev, CAPABILITY_VCO_RECALIBRATION);
1271 * rt2x00queue_map_txskb - Map a skb into DMA for TX purposes.
1272 * @entry: Pointer to &struct queue_entry
1274 * Returns -ENOMEM if mapping fail, 0 otherwise.
1276 int rt2x00queue_map_txskb(struct queue_entry *entry);
1279 * rt2x00queue_unmap_skb - Unmap a skb from DMA.
1280 * @entry: Pointer to &struct queue_entry
1282 void rt2x00queue_unmap_skb(struct queue_entry *entry);
1285 * rt2x00queue_get_tx_queue - Convert tx queue index to queue pointer
1286 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1287 * @queue: rt2x00 queue index (see &enum data_queue_qid).
1289 * Returns NULL for non tx queues.
1291 static inline struct data_queue *
1292 rt2x00queue_get_tx_queue(struct rt2x00_dev *rt2x00dev,
1293 const enum data_queue_qid queue)
1295 if (queue < rt2x00dev->ops->tx_queues && rt2x00dev->tx)
1296 return &rt2x00dev->tx[queue];
1298 if (queue == QID_ATIM)
1299 return rt2x00dev->atim;
1305 * rt2x00queue_get_entry - Get queue entry where the given index points to.
1306 * @queue: Pointer to &struct data_queue from where we obtain the entry.
1307 * @index: Index identifier for obtaining the correct index.
1309 struct queue_entry *rt2x00queue_get_entry(struct data_queue *queue,
1310 enum queue_index index);
1313 * rt2x00queue_pause_queue - Pause a data queue
1314 * @queue: Pointer to &struct data_queue.
1316 * This function will pause the data queue locally, preventing
1317 * new frames to be added to the queue (while the hardware is
1318 * still allowed to run).
1320 void rt2x00queue_pause_queue(struct data_queue *queue);
1323 * rt2x00queue_unpause_queue - unpause a data queue
1324 * @queue: Pointer to &struct data_queue.
1326 * This function will unpause the data queue locally, allowing
1327 * new frames to be added to the queue again.
1329 void rt2x00queue_unpause_queue(struct data_queue *queue);
1332 * rt2x00queue_start_queue - Start a data queue
1333 * @queue: Pointer to &struct data_queue.
1335 * This function will start handling all pending frames in the queue.
1337 void rt2x00queue_start_queue(struct data_queue *queue);
1340 * rt2x00queue_stop_queue - Halt a data queue
1341 * @queue: Pointer to &struct data_queue.
1343 * This function will stop all pending frames in the queue.
1345 void rt2x00queue_stop_queue(struct data_queue *queue);
1348 * rt2x00queue_flush_queue - Flush a data queue
1349 * @queue: Pointer to &struct data_queue.
1350 * @drop: True to drop all pending frames.
1352 * This function will flush the queue. After this call
1353 * the queue is guaranteed to be empty.
1355 void rt2x00queue_flush_queue(struct data_queue *queue, bool drop);
1358 * rt2x00queue_start_queues - Start all data queues
1359 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1361 * This function will loop through all available queues to start them
1363 void rt2x00queue_start_queues(struct rt2x00_dev *rt2x00dev);
1366 * rt2x00queue_stop_queues - Halt all data queues
1367 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1369 * This function will loop through all available queues to stop
1370 * any pending frames.
1372 void rt2x00queue_stop_queues(struct rt2x00_dev *rt2x00dev);
1375 * rt2x00queue_flush_queues - Flush all data queues
1376 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1377 * @drop: True to drop all pending frames.
1379 * This function will loop through all available queues to flush
1380 * any pending frames.
1382 void rt2x00queue_flush_queues(struct rt2x00_dev *rt2x00dev, bool drop);
1388 * rt2x00debug_dump_frame - Dump a frame to userspace through debugfs.
1389 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1390 * @type: The type of frame that is being dumped.
1391 * @entry: The queue entry containing the frame to be dumped.
1393 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
1394 void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
1395 enum rt2x00_dump_type type, struct queue_entry *entry);
1397 static inline void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
1398 enum rt2x00_dump_type type,
1399 struct queue_entry *entry)
1402 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
1405 * Utility functions.
1407 u32 rt2x00lib_get_bssidx(struct rt2x00_dev *rt2x00dev,
1408 struct ieee80211_vif *vif);
1409 void rt2x00lib_set_mac_address(struct rt2x00_dev *rt2x00dev, u8 *eeprom_mac_addr);
1412 * Interrupt context handlers.
1414 void rt2x00lib_beacondone(struct rt2x00_dev *rt2x00dev);
1415 void rt2x00lib_pretbtt(struct rt2x00_dev *rt2x00dev);
1416 void rt2x00lib_dmastart(struct queue_entry *entry);
1417 void rt2x00lib_dmadone(struct queue_entry *entry);
1418 void rt2x00lib_txdone(struct queue_entry *entry,
1419 struct txdone_entry_desc *txdesc);
1420 void rt2x00lib_txdone_nomatch(struct queue_entry *entry,
1421 struct txdone_entry_desc *txdesc);
1422 void rt2x00lib_txdone_noinfo(struct queue_entry *entry, u32 status);
1423 void rt2x00lib_rxdone(struct queue_entry *entry, gfp_t gfp);
1426 * mac80211 handlers.
1428 void rt2x00mac_tx(struct ieee80211_hw *hw,
1429 struct ieee80211_tx_control *control,
1430 struct sk_buff *skb);
1431 int rt2x00mac_start(struct ieee80211_hw *hw);
1432 void rt2x00mac_stop(struct ieee80211_hw *hw);
1433 int rt2x00mac_add_interface(struct ieee80211_hw *hw,
1434 struct ieee80211_vif *vif);
1435 void rt2x00mac_remove_interface(struct ieee80211_hw *hw,
1436 struct ieee80211_vif *vif);
1437 int rt2x00mac_config(struct ieee80211_hw *hw, u32 changed);
1438 void rt2x00mac_configure_filter(struct ieee80211_hw *hw,
1439 unsigned int changed_flags,
1440 unsigned int *total_flags,
1442 int rt2x00mac_set_tim(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1444 #ifdef CONFIG_RT2X00_LIB_CRYPTO
1445 int rt2x00mac_set_key(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1446 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
1447 struct ieee80211_key_conf *key);
1449 #define rt2x00mac_set_key NULL
1450 #endif /* CONFIG_RT2X00_LIB_CRYPTO */
1451 void rt2x00mac_sw_scan_start(struct ieee80211_hw *hw,
1452 struct ieee80211_vif *vif,
1453 const u8 *mac_addr);
1454 void rt2x00mac_sw_scan_complete(struct ieee80211_hw *hw,
1455 struct ieee80211_vif *vif);
1456 int rt2x00mac_get_stats(struct ieee80211_hw *hw,
1457 struct ieee80211_low_level_stats *stats);
1458 void rt2x00mac_bss_info_changed(struct ieee80211_hw *hw,
1459 struct ieee80211_vif *vif,
1460 struct ieee80211_bss_conf *bss_conf,
1462 int rt2x00mac_conf_tx(struct ieee80211_hw *hw,
1463 struct ieee80211_vif *vif, u16 queue,
1464 const struct ieee80211_tx_queue_params *params);
1465 void rt2x00mac_rfkill_poll(struct ieee80211_hw *hw);
1466 void rt2x00mac_flush(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1467 u32 queues, bool drop);
1468 int rt2x00mac_set_antenna(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
1469 int rt2x00mac_get_antenna(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
1470 void rt2x00mac_get_ringparam(struct ieee80211_hw *hw,
1471 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
1472 bool rt2x00mac_tx_frames_pending(struct ieee80211_hw *hw);
1475 * Driver allocation handlers.
1477 int rt2x00lib_probe_dev(struct rt2x00_dev *rt2x00dev);
1478 void rt2x00lib_remove_dev(struct rt2x00_dev *rt2x00dev);
1480 int rt2x00lib_suspend(struct rt2x00_dev *rt2x00dev, pm_message_t state);
1481 int rt2x00lib_resume(struct rt2x00_dev *rt2x00dev);
1482 #endif /* CONFIG_PM */
1484 #endif /* RT2X00_H */