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>
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) )
142 * Structure for average calculation
143 * The avg field contains the actual average value,
144 * but avg_weight is internally used during calculations
145 * to prevent rounding errors.
152 enum rt2x00_chip_intf {
153 RT2X00_CHIP_INTF_PCI,
154 RT2X00_CHIP_INTF_PCIE,
155 RT2X00_CHIP_INTF_USB,
156 RT2X00_CHIP_INTF_SOC,
160 * Chipset identification
161 * The chipset on the device is composed of a RT and RF chip.
162 * The chipset combination is important for determining device capabilities.
166 #define RT2460 0x2460
167 #define RT2560 0x2560
168 #define RT2570 0x2570
169 #define RT2661 0x2661
170 #define RT2573 0x2573
171 #define RT2860 0x2860 /* 2.4GHz */
172 #define RT2872 0x2872 /* WSOC */
173 #define RT2883 0x2883 /* WSOC */
174 #define RT3070 0x3070
175 #define RT3071 0x3071
176 #define RT3090 0x3090 /* 2.4GHz PCIe */
177 #define RT3290 0x3290
178 #define RT3352 0x3352 /* WSOC */
179 #define RT3390 0x3390
180 #define RT3572 0x3572
181 #define RT3593 0x3593
182 #define RT3883 0x3883 /* WSOC */
183 #define RT5390 0x5390 /* 2.4GHz */
184 #define RT5392 0x5392 /* 2.4GHz */
185 #define RT5592 0x5592
190 enum rt2x00_chip_intf intf;
194 * RF register values that belong to a particular channel.
205 * Channel information structure
207 struct channel_info {
209 #define GEOGRAPHY_ALLOWED 0x00000001
212 short default_power1;
213 short default_power2;
217 * Antenna setup values.
219 struct antenna_setup {
227 * Quality statistics about the currently active link.
231 * Statistics required for Link tuning by driver
232 * The rssi value is provided by rt2x00lib during the
233 * link_tuner() callback function.
234 * The false_cca field is filled during the link_stats()
235 * callback function and could be used during the
236 * link_tuner() callback function.
243 * Hardware driver will tune the VGC level during each call
244 * to the link_tuner() callback function. This vgc_level is
245 * is determined based on the link quality statistics like
246 * average RSSI and the false CCA count.
248 * In some cases the drivers need to differentiate between
249 * the currently "desired" VGC level and the level configured
250 * in the hardware. The latter is important to reduce the
251 * number of BBP register reads to reduce register access
252 * overhead. For this reason we store both values here.
258 * Statistics required for Signal quality calculation.
259 * These fields might be changed during the link_stats()
269 * Antenna settings about the currently active link.
276 #define ANTENNA_RX_DIVERSITY 0x00000001
277 #define ANTENNA_TX_DIVERSITY 0x00000002
278 #define ANTENNA_MODE_SAMPLE 0x00000004
281 * Currently active TX/RX antenna setup.
282 * When software diversity is used, this will indicate
283 * which antenna is actually used at this time.
285 struct antenna_setup active;
288 * RSSI history information for the antenna.
289 * Used to determine when to switch antenna
290 * when using software diversity.
295 * Current RSSI average of the currently active antenna.
296 * Similar to the avg_rssi in the link_qual structure
297 * this value is updated by using the walking average.
299 struct avg_val rssi_ant;
303 * To optimize the quality of the link we need to store
304 * the quality of received frames and periodically
310 * The number of times the link has been tuned
311 * since the radio has been switched on.
316 * Quality measurement values.
318 struct link_qual qual;
321 * TX/RX antenna setup.
326 * Currently active average RSSI value
328 struct avg_val avg_rssi;
331 * Work structure for scheduling periodic link tuning.
333 struct delayed_work work;
336 * Work structure for scheduling periodic watchdog monitoring.
337 * This work must be scheduled on the kernel workqueue, while
338 * all other work structures must be queued on the mac80211
339 * workqueue. This guarantees that the watchdog can schedule
340 * other work structures and wait for their completion in order
341 * to bring the device/driver back into the desired state.
343 struct delayed_work watchdog_work;
346 * Work structure for scheduling periodic AGC adjustments.
348 struct delayed_work agc_work;
351 * Work structure for scheduling periodic VCO calibration.
353 struct delayed_work vco_work;
356 enum rt2x00_delayed_flags {
357 DELAYED_UPDATE_BEACON,
361 * Interface structure
362 * Per interface configuration details, this structure
363 * is allocated as the private data for ieee80211_vif.
367 * beacon->skb must be protected with the mutex.
369 struct mutex beacon_skb_mutex;
372 * Entry in the beacon queue which belongs to
373 * this interface. Each interface has its own
374 * dedicated beacon entry.
376 struct queue_entry *beacon;
380 * Actions that needed rescheduling.
382 unsigned long delayed_flags;
385 * Software sequence counter, this is only required
386 * for hardware which doesn't support hardware
392 static inline struct rt2x00_intf* vif_to_intf(struct ieee80211_vif *vif)
394 return (struct rt2x00_intf *)vif->drv_priv;
398 * struct hw_mode_spec: Hardware specifications structure
400 * Details about the supported modes, rates and channels
401 * of a particular chipset. This is used by rt2x00lib
402 * to build the ieee80211_hw_mode array for mac80211.
404 * @supported_bands: Bitmask contained the supported bands (2.4GHz, 5.2GHz).
405 * @supported_rates: Rate types which are supported (CCK, OFDM).
406 * @num_channels: Number of supported channels. This is used as array size
407 * for @tx_power_a, @tx_power_bg and @channels.
408 * @channels: Device/chipset specific channel values (See &struct rf_channel).
409 * @channels_info: Additional information for channels (See &struct channel_info).
410 * @ht: Driver HT Capabilities (See &ieee80211_sta_ht_cap).
412 struct hw_mode_spec {
413 unsigned int supported_bands;
414 #define SUPPORT_BAND_2GHZ 0x00000001
415 #define SUPPORT_BAND_5GHZ 0x00000002
417 unsigned int supported_rates;
418 #define SUPPORT_RATE_CCK 0x00000001
419 #define SUPPORT_RATE_OFDM 0x00000002
421 unsigned int num_channels;
422 const struct rf_channel *channels;
423 const struct channel_info *channels_info;
425 struct ieee80211_sta_ht_cap ht;
429 * Configuration structure wrapper around the
430 * mac80211 configuration structure.
431 * When mac80211 configures the driver, rt2x00lib
432 * can precalculate values which are equal for all
433 * rt2x00 drivers. Those values can be stored in here.
435 struct rt2x00lib_conf {
436 struct ieee80211_conf *conf;
438 struct rf_channel rf;
439 struct channel_info channel;
443 * Configuration structure for erp settings.
445 struct rt2x00lib_erp {
463 * Configuration structure for hardware encryption.
465 struct rt2x00lib_crypto {
468 enum set_key_cmd cmd;
481 * Configuration structure wrapper around the
482 * rt2x00 interface configuration handler.
484 struct rt2x00intf_conf {
488 enum nl80211_iftype type;
491 * TSF sync value, this is dependent on the operation type.
496 * The MAC and BSSID addresses are simple array of bytes,
497 * these arrays are little endian, so when sending the addresses
498 * to the drivers, copy the it into a endian-signed variable.
500 * Note that all devices (except rt2500usb) have 32 bits
501 * register word sizes. This means that whatever variable we
502 * pass _must_ be a multiple of 32 bits. Otherwise the device
503 * might not accept what we are sending to it.
504 * This will also make it easier for the driver to write
505 * the data to the device.
512 * Private structure for storing STA details
513 * wcid: Wireless Client ID
519 static inline struct rt2x00_sta* sta_to_rt2x00_sta(struct ieee80211_sta *sta)
521 return (struct rt2x00_sta *)sta->drv_priv;
525 * rt2x00lib callback functions.
527 struct rt2x00lib_ops {
529 * Interrupt handlers.
531 irq_handler_t irq_handler;
534 * TX status tasklet handler.
536 void (*txstatus_tasklet) (unsigned long data);
537 void (*pretbtt_tasklet) (unsigned long data);
538 void (*tbtt_tasklet) (unsigned long data);
539 void (*rxdone_tasklet) (unsigned long data);
540 void (*autowake_tasklet) (unsigned long data);
543 * Device init handlers.
545 int (*probe_hw) (struct rt2x00_dev *rt2x00dev);
546 char *(*get_firmware_name) (struct rt2x00_dev *rt2x00dev);
547 int (*check_firmware) (struct rt2x00_dev *rt2x00dev,
548 const u8 *data, const size_t len);
549 int (*load_firmware) (struct rt2x00_dev *rt2x00dev,
550 const u8 *data, const size_t len);
553 * Device initialization/deinitialization handlers.
555 int (*initialize) (struct rt2x00_dev *rt2x00dev);
556 void (*uninitialize) (struct rt2x00_dev *rt2x00dev);
559 * queue initialization handlers
561 bool (*get_entry_state) (struct queue_entry *entry);
562 void (*clear_entry) (struct queue_entry *entry);
565 * Radio control handlers.
567 int (*set_device_state) (struct rt2x00_dev *rt2x00dev,
568 enum dev_state state);
569 int (*rfkill_poll) (struct rt2x00_dev *rt2x00dev);
570 void (*link_stats) (struct rt2x00_dev *rt2x00dev,
571 struct link_qual *qual);
572 void (*reset_tuner) (struct rt2x00_dev *rt2x00dev,
573 struct link_qual *qual);
574 void (*link_tuner) (struct rt2x00_dev *rt2x00dev,
575 struct link_qual *qual, const u32 count);
576 void (*gain_calibration) (struct rt2x00_dev *rt2x00dev);
577 void (*vco_calibration) (struct rt2x00_dev *rt2x00dev);
580 * Data queue handlers.
582 void (*watchdog) (struct rt2x00_dev *rt2x00dev);
583 void (*start_queue) (struct data_queue *queue);
584 void (*kick_queue) (struct data_queue *queue);
585 void (*stop_queue) (struct data_queue *queue);
586 void (*flush_queue) (struct data_queue *queue, bool drop);
587 void (*tx_dma_done) (struct queue_entry *entry);
590 * TX control handlers
592 void (*write_tx_desc) (struct queue_entry *entry,
593 struct txentry_desc *txdesc);
594 void (*write_tx_data) (struct queue_entry *entry,
595 struct txentry_desc *txdesc);
596 void (*write_beacon) (struct queue_entry *entry,
597 struct txentry_desc *txdesc);
598 void (*clear_beacon) (struct queue_entry *entry);
599 int (*get_tx_data_len) (struct queue_entry *entry);
602 * RX control handlers
604 void (*fill_rxdone) (struct queue_entry *entry,
605 struct rxdone_entry_desc *rxdesc);
608 * Configuration handlers.
610 int (*config_shared_key) (struct rt2x00_dev *rt2x00dev,
611 struct rt2x00lib_crypto *crypto,
612 struct ieee80211_key_conf *key);
613 int (*config_pairwise_key) (struct rt2x00_dev *rt2x00dev,
614 struct rt2x00lib_crypto *crypto,
615 struct ieee80211_key_conf *key);
616 void (*config_filter) (struct rt2x00_dev *rt2x00dev,
617 const unsigned int filter_flags);
618 void (*config_intf) (struct rt2x00_dev *rt2x00dev,
619 struct rt2x00_intf *intf,
620 struct rt2x00intf_conf *conf,
621 const unsigned int flags);
622 #define CONFIG_UPDATE_TYPE ( 1 << 1 )
623 #define CONFIG_UPDATE_MAC ( 1 << 2 )
624 #define CONFIG_UPDATE_BSSID ( 1 << 3 )
626 void (*config_erp) (struct rt2x00_dev *rt2x00dev,
627 struct rt2x00lib_erp *erp,
629 void (*config_ant) (struct rt2x00_dev *rt2x00dev,
630 struct antenna_setup *ant);
631 void (*config) (struct rt2x00_dev *rt2x00dev,
632 struct rt2x00lib_conf *libconf,
633 const unsigned int changed_flags);
634 int (*sta_add) (struct rt2x00_dev *rt2x00dev,
635 struct ieee80211_vif *vif,
636 struct ieee80211_sta *sta);
637 int (*sta_remove) (struct rt2x00_dev *rt2x00dev,
642 * rt2x00 driver callback operation structure.
646 const unsigned int drv_data_size;
647 const unsigned int max_ap_intf;
648 const unsigned int eeprom_size;
649 const unsigned int rf_size;
650 const unsigned int tx_queues;
651 const unsigned int extra_tx_headroom;
652 const struct data_queue_desc *rx;
653 const struct data_queue_desc *tx;
654 const struct data_queue_desc *bcn;
655 const struct data_queue_desc *atim;
656 const struct rt2x00lib_ops *lib;
658 const struct ieee80211_ops *hw;
659 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
660 const struct rt2x00debug *debugfs;
661 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
667 enum rt2x00_state_flags {
671 DEVICE_STATE_PRESENT,
672 DEVICE_STATE_REGISTERED_HW,
673 DEVICE_STATE_INITIALIZED,
674 DEVICE_STATE_STARTED,
675 DEVICE_STATE_ENABLED_RADIO,
676 DEVICE_STATE_SCANNING,
679 * Driver configuration
687 * Mark we currently are sequentially reading TX_STA_FIFO register
688 * FIXME: this is for only rt2800usb, should go to private data
694 * rt2x00 capability flags
696 enum rt2x00_capability_flags {
701 REQUIRE_BEACON_GUARD,
706 REQUIRE_TXSTATUS_FIFO,
707 REQUIRE_TASKLET_CONTEXT,
711 REQUIRE_DELAYED_RFKILL,
716 CAPABILITY_HW_BUTTON,
717 CAPABILITY_HW_CRYPTO,
718 CAPABILITY_POWER_LIMIT,
719 CAPABILITY_CONTROL_FILTERS,
720 CAPABILITY_CONTROL_FILTER_PSPOLL,
721 CAPABILITY_PRE_TBTT_INTERRUPT,
722 CAPABILITY_LINK_TUNING,
723 CAPABILITY_FRAME_TYPE,
724 CAPABILITY_RF_SEQUENCE,
725 CAPABILITY_EXTERNAL_LNA_A,
726 CAPABILITY_EXTERNAL_LNA_BG,
727 CAPABILITY_DOUBLE_ANTENNA,
728 CAPABILITY_BT_COEXIST,
729 CAPABILITY_VCO_RECALIBRATION,
733 * Interface combinations
741 * rt2x00 device structure.
746 * The structure stored in here depends on the
747 * system bus (PCI or USB).
748 * When accessing this variable, the rt2x00dev_{pci,usb}
749 * macros should be used for correct typecasting.
754 * Callback functions.
756 const struct rt2x00_ops *ops;
764 * IEEE80211 control structure.
766 struct ieee80211_hw *hw;
767 struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
768 enum ieee80211_band curr_band;
772 * If enabled, the debugfs interface structures
773 * required for deregistration of debugfs.
775 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
776 struct rt2x00debug_intf *debugfs_intf;
777 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
780 * LED structure for changing the LED status
781 * by mac8011 or the kernel.
783 #ifdef CONFIG_RT2X00_LIB_LEDS
784 struct rt2x00_led led_radio;
785 struct rt2x00_led led_assoc;
786 struct rt2x00_led led_qual;
788 #endif /* CONFIG_RT2X00_LIB_LEDS */
791 * Device state flags.
792 * In these flags the current status is stored.
793 * Access to these flags should occur atomically.
798 * Device capabiltiy flags.
799 * In these flags the device/driver capabilities are stored.
800 * Access to these flags should occur non-atomically.
802 unsigned long cap_flags;
805 * Device information, Bus IRQ and name (PCI, SoC)
811 * Chipset identification.
813 struct rt2x00_chip chip;
816 * hw capability specifications.
818 struct hw_mode_spec spec;
821 * This is the default TX/RX antenna setup as indicated
822 * by the device's EEPROM.
824 struct antenna_setup default_ant;
828 * csr.base: CSR base register address. (PCI)
829 * csr.cache: CSR cache for usb_control_msg. (USB)
837 * Mutex to protect register accesses.
838 * For PCI and USB devices it protects against concurrent indirect
839 * register access (BBP, RF, MCU) since accessing those
840 * registers require multiple calls to the CSR registers.
841 * For USB devices it also protects the csr_cache since that
842 * field is used for normal CSR access and it cannot support
843 * multiple callers simultaneously.
845 struct mutex csr_mutex;
848 * Current packet filter configuration for the device.
849 * This contains all currently active FIF_* flags send
850 * to us by mac80211 during configure_filter().
852 unsigned int packet_filter;
856 * - Open ap interface count.
857 * - Open sta interface count.
858 * - Association count.
859 * - Beaconing enabled count.
861 unsigned int intf_ap_count;
862 unsigned int intf_sta_count;
863 unsigned int intf_associated;
864 unsigned int intf_beaconing;
867 * Interface combinations
869 struct ieee80211_iface_limit if_limits_ap;
870 struct ieee80211_iface_combination if_combinations[NUM_IF_COMB];
883 * Active RF register values.
884 * These are stored here so we don't need
885 * to read the rf registers and can directly
886 * use this value instead.
887 * This field should be accessed by using
888 * rt2x00_rf_read() and rt2x00_rf_write().
898 * Current TX power value.
903 * Current retry values.
909 * Rssi <-> Dbm offset
929 * Timestamp of last received beacon
931 unsigned long last_beacon;
934 * Low level statistics which will have
935 * to be kept up to date while device is running.
937 struct ieee80211_low_level_stats low_level_stats;
940 * Work queue for all work which should not be placed
941 * on the mac80211 workqueue (because of dependencies
942 * between various work structures).
944 struct workqueue_struct *workqueue;
948 * NOTE: intf_work will use ieee80211_iterate_active_interfaces()
949 * which means it cannot be placed on the hw->workqueue
950 * due to RTNL locking requirements.
952 struct work_struct intf_work;
955 * Scheduled work for TX/RX done handling (USB devices)
957 struct work_struct rxdone_work;
958 struct work_struct txdone_work;
963 struct delayed_work autowakeup_work;
964 struct work_struct sleep_work;
967 * Data queue arrays for RX, TX, Beacon and ATIM.
969 unsigned int data_queues;
970 struct data_queue *rx;
971 struct data_queue *tx;
972 struct data_queue *bcn;
973 struct data_queue *atim;
978 const struct firmware *fw;
981 * FIFO for storing tx status reports between isr and tasklet.
983 DECLARE_KFIFO_PTR(txstatus_fifo, u32);
986 * Timer to ensure tx status reports are read (rt2800usb).
988 struct hrtimer txstatus_timer;
991 * Tasklet for processing tx status reports (rt2800pci).
993 struct tasklet_struct txstatus_tasklet;
994 struct tasklet_struct pretbtt_tasklet;
995 struct tasklet_struct tbtt_tasklet;
996 struct tasklet_struct rxdone_tasklet;
997 struct tasklet_struct autowake_tasklet;
1000 * Used for VCO periodic calibration.
1005 * Protect the interrupt mask register.
1007 spinlock_t irqmask_lock;
1010 * List of BlockAckReq TX entries that need driver BlockAck processing.
1012 struct list_head bar_list;
1013 spinlock_t bar_list_lock;
1016 struct rt2x00_bar_list_entry {
1017 struct list_head list;
1018 struct rcu_head head;
1020 struct queue_entry *entry;
1023 /* Relevant parts of the IEEE80211 BAR header */
1027 __le16 start_seq_num;
1032 * Some registers require multiple attempts before success,
1033 * in those cases REGISTER_BUSY_COUNT attempts should be
1034 * taken with a REGISTER_BUSY_DELAY interval.
1036 #define REGISTER_BUSY_COUNT 100
1037 #define REGISTER_BUSY_DELAY 100
1040 * Generic RF access.
1041 * The RF is being accessed by word index.
1043 static inline void rt2x00_rf_read(struct rt2x00_dev *rt2x00dev,
1044 const unsigned int word, u32 *data)
1046 BUG_ON(word < 1 || word > rt2x00dev->ops->rf_size / sizeof(u32));
1047 *data = 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 void rt2x00_eeprom_read(struct rt2x00_dev *rt2x00dev,
1067 const unsigned int word, u16 *data)
1069 *data = 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);
1184 * rt2x00queue_map_txskb - Map a skb into DMA for TX purposes.
1185 * @entry: Pointer to &struct queue_entry
1187 * Returns -ENOMEM if mapping fail, 0 otherwise.
1189 int rt2x00queue_map_txskb(struct queue_entry *entry);
1192 * rt2x00queue_unmap_skb - Unmap a skb from DMA.
1193 * @entry: Pointer to &struct queue_entry
1195 void rt2x00queue_unmap_skb(struct queue_entry *entry);
1198 * rt2x00queue_get_tx_queue - Convert tx queue index to queue pointer
1199 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1200 * @queue: rt2x00 queue index (see &enum data_queue_qid).
1202 * Returns NULL for non tx queues.
1204 static inline struct data_queue *
1205 rt2x00queue_get_tx_queue(struct rt2x00_dev *rt2x00dev,
1206 const enum data_queue_qid queue)
1208 if (queue < rt2x00dev->ops->tx_queues && rt2x00dev->tx)
1209 return &rt2x00dev->tx[queue];
1211 if (queue == QID_ATIM)
1212 return rt2x00dev->atim;
1218 * rt2x00queue_get_entry - Get queue entry where the given index points to.
1219 * @queue: Pointer to &struct data_queue from where we obtain the entry.
1220 * @index: Index identifier for obtaining the correct index.
1222 struct queue_entry *rt2x00queue_get_entry(struct data_queue *queue,
1223 enum queue_index index);
1226 * rt2x00queue_pause_queue - Pause a data queue
1227 * @queue: Pointer to &struct data_queue.
1229 * This function will pause the data queue locally, preventing
1230 * new frames to be added to the queue (while the hardware is
1231 * still allowed to run).
1233 void rt2x00queue_pause_queue(struct data_queue *queue);
1236 * rt2x00queue_unpause_queue - unpause a data queue
1237 * @queue: Pointer to &struct data_queue.
1239 * This function will unpause the data queue locally, allowing
1240 * new frames to be added to the queue again.
1242 void rt2x00queue_unpause_queue(struct data_queue *queue);
1245 * rt2x00queue_start_queue - Start a data queue
1246 * @queue: Pointer to &struct data_queue.
1248 * This function will start handling all pending frames in the queue.
1250 void rt2x00queue_start_queue(struct data_queue *queue);
1253 * rt2x00queue_stop_queue - Halt a data queue
1254 * @queue: Pointer to &struct data_queue.
1256 * This function will stop all pending frames in the queue.
1258 void rt2x00queue_stop_queue(struct data_queue *queue);
1261 * rt2x00queue_flush_queue - Flush a data queue
1262 * @queue: Pointer to &struct data_queue.
1263 * @drop: True to drop all pending frames.
1265 * This function will flush the queue. After this call
1266 * the queue is guaranteed to be empty.
1268 void rt2x00queue_flush_queue(struct data_queue *queue, bool drop);
1271 * rt2x00queue_start_queues - Start all data queues
1272 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1274 * This function will loop through all available queues to start them
1276 void rt2x00queue_start_queues(struct rt2x00_dev *rt2x00dev);
1279 * rt2x00queue_stop_queues - Halt all data queues
1280 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1282 * This function will loop through all available queues to stop
1283 * any pending frames.
1285 void rt2x00queue_stop_queues(struct rt2x00_dev *rt2x00dev);
1288 * rt2x00queue_flush_queues - Flush all data queues
1289 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1290 * @drop: True to drop all pending frames.
1292 * This function will loop through all available queues to flush
1293 * any pending frames.
1295 void rt2x00queue_flush_queues(struct rt2x00_dev *rt2x00dev, bool drop);
1301 * rt2x00debug_dump_frame - Dump a frame to userspace through debugfs.
1302 * @rt2x00dev: Pointer to &struct rt2x00_dev.
1303 * @type: The type of frame that is being dumped.
1304 * @skb: The skb containing the frame to be dumped.
1306 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
1307 void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
1308 enum rt2x00_dump_type type, struct sk_buff *skb);
1310 static inline void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
1311 enum rt2x00_dump_type type,
1312 struct sk_buff *skb)
1315 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
1318 * Utility functions.
1320 u32 rt2x00lib_get_bssidx(struct rt2x00_dev *rt2x00dev,
1321 struct ieee80211_vif *vif);
1324 * Interrupt context handlers.
1326 void rt2x00lib_beacondone(struct rt2x00_dev *rt2x00dev);
1327 void rt2x00lib_pretbtt(struct rt2x00_dev *rt2x00dev);
1328 void rt2x00lib_dmastart(struct queue_entry *entry);
1329 void rt2x00lib_dmadone(struct queue_entry *entry);
1330 void rt2x00lib_txdone(struct queue_entry *entry,
1331 struct txdone_entry_desc *txdesc);
1332 void rt2x00lib_txdone_noinfo(struct queue_entry *entry, u32 status);
1333 void rt2x00lib_rxdone(struct queue_entry *entry, gfp_t gfp);
1336 * mac80211 handlers.
1338 void rt2x00mac_tx(struct ieee80211_hw *hw,
1339 struct ieee80211_tx_control *control,
1340 struct sk_buff *skb);
1341 int rt2x00mac_start(struct ieee80211_hw *hw);
1342 void rt2x00mac_stop(struct ieee80211_hw *hw);
1343 int rt2x00mac_add_interface(struct ieee80211_hw *hw,
1344 struct ieee80211_vif *vif);
1345 void rt2x00mac_remove_interface(struct ieee80211_hw *hw,
1346 struct ieee80211_vif *vif);
1347 int rt2x00mac_config(struct ieee80211_hw *hw, u32 changed);
1348 void rt2x00mac_configure_filter(struct ieee80211_hw *hw,
1349 unsigned int changed_flags,
1350 unsigned int *total_flags,
1352 int rt2x00mac_set_tim(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1354 #ifdef CONFIG_RT2X00_LIB_CRYPTO
1355 int rt2x00mac_set_key(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1356 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
1357 struct ieee80211_key_conf *key);
1359 #define rt2x00mac_set_key NULL
1360 #endif /* CONFIG_RT2X00_LIB_CRYPTO */
1361 int rt2x00mac_sta_add(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1362 struct ieee80211_sta *sta);
1363 int rt2x00mac_sta_remove(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1364 struct ieee80211_sta *sta);
1365 void rt2x00mac_sw_scan_start(struct ieee80211_hw *hw);
1366 void rt2x00mac_sw_scan_complete(struct ieee80211_hw *hw);
1367 int rt2x00mac_get_stats(struct ieee80211_hw *hw,
1368 struct ieee80211_low_level_stats *stats);
1369 void rt2x00mac_bss_info_changed(struct ieee80211_hw *hw,
1370 struct ieee80211_vif *vif,
1371 struct ieee80211_bss_conf *bss_conf,
1373 int rt2x00mac_conf_tx(struct ieee80211_hw *hw,
1374 struct ieee80211_vif *vif, u16 queue,
1375 const struct ieee80211_tx_queue_params *params);
1376 void rt2x00mac_rfkill_poll(struct ieee80211_hw *hw);
1377 void rt2x00mac_flush(struct ieee80211_hw *hw, u32 queues, bool drop);
1378 int rt2x00mac_set_antenna(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
1379 int rt2x00mac_get_antenna(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
1380 void rt2x00mac_get_ringparam(struct ieee80211_hw *hw,
1381 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
1382 bool rt2x00mac_tx_frames_pending(struct ieee80211_hw *hw);
1385 * Driver allocation handlers.
1387 int rt2x00lib_probe_dev(struct rt2x00_dev *rt2x00dev);
1388 void rt2x00lib_remove_dev(struct rt2x00_dev *rt2x00dev);
1390 int rt2x00lib_suspend(struct rt2x00_dev *rt2x00dev, pm_message_t state);
1391 int rt2x00lib_resume(struct rt2x00_dev *rt2x00dev);
1392 #endif /* CONFIG_PM */
1394 #endif /* RT2X00_H */