2 Copyright (C) 2004 - 2007 rt2x00 SourceForge Project
3 <http://rt2x00.serialmonkey.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the
17 Free Software Foundation, Inc.,
18 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 Abstract: rt2x00 global information.
29 #include <linux/bitops.h>
30 #include <linux/prefetch.h>
31 #include <linux/skbuff.h>
32 #include <linux/workqueue.h>
33 #include <linux/firmware.h>
35 #include <net/mac80211.h>
37 #include "rt2x00debug.h"
38 #include "rt2x00reg.h"
39 #include "rt2x00ring.h"
43 * DRV_NAME should be set within the individual module source files.
45 #define DRV_VERSION "2.0.10"
46 #define DRV_PROJECT "http://rt2x00.serialmonkey.com"
50 * Debug output has to be enabled during compile time.
52 #define DEBUG_PRINTK_MSG(__dev, __kernlvl, __lvl, __msg, __args...) \
53 printk(__kernlvl "%s -> %s: %s - " __msg, \
54 wiphy_name((__dev)->hw->wiphy), __FUNCTION__, __lvl, ##__args)
56 #define DEBUG_PRINTK_PROBE(__kernlvl, __lvl, __msg, __args...) \
57 printk(__kernlvl "%s -> %s: %s - " __msg, \
58 DRV_NAME, __FUNCTION__, __lvl, ##__args)
60 #ifdef CONFIG_RT2X00_DEBUG
61 #define DEBUG_PRINTK(__dev, __kernlvl, __lvl, __msg, __args...) \
62 DEBUG_PRINTK_MSG(__dev, __kernlvl, __lvl, __msg, ##__args);
64 #define DEBUG_PRINTK(__dev, __kernlvl, __lvl, __msg, __args...) \
66 #endif /* CONFIG_RT2X00_DEBUG */
69 * Various debug levels.
70 * The debug levels PANIC and ERROR both indicate serious problems,
71 * for this reason they should never be ignored.
72 * The special ERROR_PROBE message is for messages that are generated
73 * when the rt2x00_dev is not yet initialized.
75 #define PANIC(__dev, __msg, __args...) \
76 DEBUG_PRINTK_MSG(__dev, KERN_CRIT, "Panic", __msg, ##__args)
77 #define ERROR(__dev, __msg, __args...) \
78 DEBUG_PRINTK_MSG(__dev, KERN_ERR, "Error", __msg, ##__args)
79 #define ERROR_PROBE(__msg, __args...) \
80 DEBUG_PRINTK_PROBE(KERN_ERR, "Error", __msg, ##__args)
81 #define WARNING(__dev, __msg, __args...) \
82 DEBUG_PRINTK(__dev, KERN_WARNING, "Warning", __msg, ##__args)
83 #define NOTICE(__dev, __msg, __args...) \
84 DEBUG_PRINTK(__dev, KERN_NOTICE, "Notice", __msg, ##__args)
85 #define INFO(__dev, __msg, __args...) \
86 DEBUG_PRINTK(__dev, KERN_INFO, "Info", __msg, ##__args)
87 #define DEBUG(__dev, __msg, __args...) \
88 DEBUG_PRINTK(__dev, KERN_DEBUG, "Debug", __msg, ##__args)
89 #define EEPROM(__dev, __msg, __args...) \
90 DEBUG_PRINTK(__dev, KERN_DEBUG, "EEPROM recovery", __msg, ##__args)
94 * Ralink PCI devices demand the Frame size to be a multiple of 128 bytes.
95 * DATA_FRAME_SIZE is used for TX, RX, ATIM and PRIO rings.
96 * MGMT_FRAME_SIZE is used for the BEACON ring.
98 #define DATA_FRAME_SIZE 2432
99 #define MGMT_FRAME_SIZE 256
102 * Number of entries in a packet ring.
103 * PCI devices only need 1 Beacon entry,
104 * but USB devices require a second because they
105 * have to send a Guardian byte first.
107 #define RX_ENTRIES 12
108 #define TX_ENTRIES 12
109 #define ATIM_ENTRIES 1
110 #define BEACON_ENTRIES 2
113 * Standard timing and size defines.
114 * These values should follow the ieee80211 specifications.
117 #define IEEE80211_HEADER 24
121 #define SHORT_PREAMBLE 72
123 #define SHORT_SLOT_TIME 9
125 #define PIFS ( SIFS + SLOT_TIME )
126 #define SHORT_PIFS ( SIFS + SHORT_SLOT_TIME )
127 #define DIFS ( PIFS + SLOT_TIME )
128 #define SHORT_DIFS ( SHORT_PIFS + SHORT_SLOT_TIME )
129 #define EIFS ( SIFS + (8 * (IEEE80211_HEADER + ACK_SIZE)) )
132 * IEEE802.11 header defines
134 static inline int is_rts_frame(u16 fc)
136 return !!(((fc & IEEE80211_FCTL_FTYPE) == IEEE80211_FTYPE_CTL) &&
137 ((fc & IEEE80211_FCTL_STYPE) == IEEE80211_STYPE_RTS));
140 static inline int is_cts_frame(u16 fc)
142 return !!(((fc & IEEE80211_FCTL_FTYPE) == IEEE80211_FTYPE_CTL) &&
143 ((fc & IEEE80211_FCTL_STYPE) == IEEE80211_STYPE_CTS));
146 static inline int is_probe_resp(u16 fc)
148 return !!(((fc & IEEE80211_FCTL_FTYPE) == IEEE80211_FTYPE_MGMT) &&
149 ((fc & IEEE80211_FCTL_STYPE) == IEEE80211_STYPE_PROBE_RESP));
153 * Chipset identification
154 * The chipset on the device is composed of a RT and RF chip.
155 * The chipset combination is important for determining device capabilities.
159 #define RT2460 0x0101
160 #define RT2560 0x0201
161 #define RT2570 0x1201
162 #define RT2561s 0x0301 /* Turbo */
163 #define RT2561 0x0302
164 #define RT2661 0x0401
165 #define RT2571 0x1300
172 * RF register values that belong to a particular channel.
183 * Antenna setup values.
185 struct antenna_setup {
191 * Quality statistics about the currently active link.
195 * Statistics required for Link tuning.
196 * For the average RSSI value we use the "Walking average" approach.
197 * When adding RSSI to the average value the following calculation
200 * avg_rssi = ((avg_rssi * 7) + rssi) / 8;
202 * The advantage of this approach is that we only need 1 variable
203 * to store the average in (No need for a count and a total).
204 * But more importantly, normal average values will over time
205 * move less and less towards newly added values this results
206 * that with link tuning, the device can have a very good RSSI
207 * for a few minutes but when the device is moved away from the AP
208 * the average will not decrease fast enough to compensate.
209 * The walking average compensates this and will move towards
210 * the new values correctly allowing a effective link tuning.
216 * Statistics required for Signal quality calculation.
217 * For calculating the Signal quality we have to determine
218 * the total number of success and failed RX and TX frames.
219 * After that we also use the average RSSI value to help
220 * determining the signal quality.
221 * For the calculation we will use the following algorithm:
223 * rssi_percentage = (avg_rssi * 100) / rssi_offset
224 * rx_percentage = (rx_success * 100) / rx_total
225 * tx_percentage = (tx_success * 100) / tx_total
226 * avg_signal = ((WEIGHT_RSSI * avg_rssi) +
227 * (WEIGHT_TX * tx_percentage) +
228 * (WEIGHT_RX * rx_percentage)) / 100
230 * This value should then be checked to not be greated then 100.
238 #define WEIGHT_RSSI 20
244 * To optimize the quality of the link we need to store
245 * the quality of received frames and periodically
251 * The number of times the link has been tuned
252 * since the radio has been switched on.
257 * Quality measurement values.
259 struct link_qual qual;
262 * Currently active TX/RX antenna setup.
263 * When software diversity is used, this will indicate
264 * which antenna is actually used at this time.
266 struct antenna_setup active_ant;
274 * Work structure for scheduling periodic link tuning.
276 struct delayed_work work;
280 * Clear all counters inside the link structure.
282 static inline void rt2x00_clear_link(struct link *link)
285 memset(&link->qual, 0, sizeof(link->qual));
286 link->qual.rx_percentage = 50;
287 link->qual.tx_percentage = 50;
291 * Update the rssi using the walking average approach.
293 static inline void rt2x00_update_link_rssi(struct link *link, int rssi)
295 if (!link->qual.avg_rssi)
296 link->qual.avg_rssi = rssi;
298 link->qual.avg_rssi = ((link->qual.avg_rssi * 7) + rssi) / 8;
302 * When the avg_rssi is unset or no frames have been received),
303 * we need to return the default value which needs to be less
304 * than -80 so the device will select the maximum sensitivity.
306 static inline int rt2x00_get_link_rssi(struct link *link)
308 if (link->qual.avg_rssi && link->qual.rx_success)
309 return link->qual.avg_rssi;
314 * Interface structure
315 * Configuration details about the current interface.
319 * Interface identification. The value is assigned
320 * to us by the 80211 stack, and is used to request
326 * Current working type (IEEE80211_IF_TYPE_*).
327 * When set to INVALID_INTERFACE, no interface is configured.
330 #define INVALID_INTERFACE IEEE80211_IF_TYPE_INVALID
338 * BBSID of the AP to associate with.
343 * Store the packet filter mode for the current interface.
348 static inline int is_interface_present(struct interface *intf)
353 static inline int is_interface_type(struct interface *intf, int type)
355 return intf->type == type;
359 * Details about the supported modes, rates and channels
360 * of a particular chipset. This is used by rt2x00lib
361 * to build the ieee80211_hw_mode array for mac80211.
363 struct hw_mode_spec {
365 * Number of modes, rates and channels.
374 const u8 *tx_power_a;
375 const u8 *tx_power_bg;
379 * Device/chipset specific value.
381 const struct rf_channel *channels;
385 * Configuration structure wrapper around the
386 * mac80211 configuration structure.
387 * When mac80211 configures the driver, rt2x00lib
388 * can precalculate values which are equal for all
389 * rt2x00 drivers. Those values can be stored in here.
391 struct rt2x00lib_conf {
392 struct ieee80211_conf *conf;
393 struct rf_channel rf;
395 struct antenna_setup ant;
409 * rt2x00lib callback functions.
411 struct rt2x00lib_ops {
413 * Interrupt handlers.
415 irq_handler_t irq_handler;
418 * Device init handlers.
420 int (*probe_hw) (struct rt2x00_dev *rt2x00dev);
421 char *(*get_firmware_name) (struct rt2x00_dev *rt2x00dev);
422 int (*load_firmware) (struct rt2x00_dev *rt2x00dev, void *data,
426 * Device initialization/deinitialization handlers.
428 int (*initialize) (struct rt2x00_dev *rt2x00dev);
429 void (*uninitialize) (struct rt2x00_dev *rt2x00dev);
432 * Radio control handlers.
434 int (*set_device_state) (struct rt2x00_dev *rt2x00dev,
435 enum dev_state state);
436 int (*rfkill_poll) (struct rt2x00_dev *rt2x00dev);
437 void (*link_stats) (struct rt2x00_dev *rt2x00dev,
438 struct link_qual *qual);
439 void (*reset_tuner) (struct rt2x00_dev *rt2x00dev);
440 void (*link_tuner) (struct rt2x00_dev *rt2x00dev);
443 * TX control handlers
445 void (*write_tx_desc) (struct rt2x00_dev *rt2x00dev,
446 struct data_desc *txd,
447 struct txdata_entry_desc *desc,
448 struct ieee80211_hdr *ieee80211hdr,
450 struct ieee80211_tx_control *control);
451 int (*write_tx_data) (struct rt2x00_dev *rt2x00dev,
452 struct data_ring *ring, struct sk_buff *skb,
453 struct ieee80211_tx_control *control);
454 int (*get_tx_data_len) (struct rt2x00_dev *rt2x00dev,
455 struct sk_buff *skb);
456 void (*kick_tx_queue) (struct rt2x00_dev *rt2x00dev,
460 * RX control handlers
462 void (*fill_rxdone) (struct data_entry *entry,
463 struct rxdata_entry_desc *desc);
466 * Configuration handlers.
468 void (*config_mac_addr) (struct rt2x00_dev *rt2x00dev, __le32 *mac);
469 void (*config_bssid) (struct rt2x00_dev *rt2x00dev, __le32 *bssid);
470 void (*config_type) (struct rt2x00_dev *rt2x00dev, const int type,
472 void (*config_preamble) (struct rt2x00_dev *rt2x00dev,
473 const int short_preamble,
474 const int ack_timeout,
475 const int ack_consume_time);
476 void (*config) (struct rt2x00_dev *rt2x00dev, const unsigned int flags,
477 struct rt2x00lib_conf *libconf);
478 #define CONFIG_UPDATE_PHYMODE ( 1 << 1 )
479 #define CONFIG_UPDATE_CHANNEL ( 1 << 2 )
480 #define CONFIG_UPDATE_TXPOWER ( 1 << 3 )
481 #define CONFIG_UPDATE_ANTENNA ( 1 << 4 )
482 #define CONFIG_UPDATE_SLOT_TIME ( 1 << 5 )
483 #define CONFIG_UPDATE_BEACON_INT ( 1 << 6 )
484 #define CONFIG_UPDATE_ALL 0xffff
488 * rt2x00 driver callback operation structure.
492 const unsigned int rxd_size;
493 const unsigned int txd_size;
494 const unsigned int eeprom_size;
495 const unsigned int rf_size;
496 const struct rt2x00lib_ops *lib;
497 const struct ieee80211_ops *hw;
498 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
499 const struct rt2x00debug *debugfs;
500 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
504 * rt2x00 device flags
511 DEVICE_REGISTERED_HW,
514 DEVICE_STARTED_SUSPEND,
515 DEVICE_ENABLED_RADIO,
516 DEVICE_DISABLED_RADIO_HW,
521 DRIVER_REQUIRE_FIRMWARE,
522 DRIVER_REQUIRE_BEACON_RING,
525 * Driver configuration
527 CONFIG_SUPPORT_HW_BUTTON,
530 CONFIG_EXTERNAL_LNA_A,
531 CONFIG_EXTERNAL_LNA_BG,
532 CONFIG_DOUBLE_ANTENNA,
533 CONFIG_DISABLE_LINK_TUNING,
534 CONFIG_SHORT_PREAMBLE,
538 * rt2x00 device structure.
543 * The structure stored in here depends on the
544 * system bus (PCI or USB).
545 * When accessing this variable, the rt2x00dev_{pci,usb}
546 * macro's should be used for correct typecasting.
549 #define rt2x00dev_pci(__dev) ( (struct pci_dev*)(__dev)->dev )
550 #define rt2x00dev_usb(__dev) ( (struct usb_interface*)(__dev)->dev )
553 * Callback functions.
555 const struct rt2x00_ops *ops;
558 * IEEE80211 control structure.
560 struct ieee80211_hw *hw;
561 struct ieee80211_hw_mode *hwmodes;
562 unsigned int curr_hwmode;
568 * rfkill structure for RF state switching support.
569 * This will only be compiled in when required.
571 #ifdef CONFIG_RT2X00_LIB_RFKILL
572 struct rfkill *rfkill;
573 struct input_polled_dev *poll_dev;
574 #endif /* CONFIG_RT2X00_LIB_RFKILL */
577 * If enabled, the debugfs interface structures
578 * required for deregistration of debugfs.
580 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
581 const struct rt2x00debug_intf *debugfs_intf;
582 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
586 * In these flags the current status and some
587 * of the device capabilities are stored.
592 * Chipset identification.
594 struct rt2x00_chip chip;
597 * hw capability specifications.
599 struct hw_mode_spec spec;
602 * This is the default TX/RX antenna setup as indicated
603 * by the device's EEPROM. When mac80211 sets its
604 * antenna value to 0 we should be using these values.
606 struct antenna_setup default_ant;
610 * csr_addr: Base register address. (PCI)
611 * csr_cache: CSR cache for usb_control_msg. (USB)
613 void __iomem *csr_addr;
617 * Interface configuration.
619 struct interface interface;
632 * Active RF register values.
633 * These are stored here so we don't need
634 * to read the rf registers and can directly
635 * use this value instead.
636 * This field should be accessed by using
637 * rt2x00_rf_read() and rt2x00_rf_write().
642 * USB Max frame size (for rt2500usb & rt73usb).
647 * Current TX power value.
652 * LED register (for rt61pci & rt73usb).
657 * Led mode (LED_MODE_*)
662 * Rssi <-> Dbm offset
667 * Frequency offset (for rt61pci & rt73usb).
672 * Low level statistics which will have
673 * to be kept up to date while device is running.
675 struct ieee80211_low_level_stats low_level_stats;
678 * RX configuration information.
680 struct ieee80211_rx_status rx_status;
685 struct work_struct beacon_work;
686 struct work_struct filter_work;
687 struct work_struct config_work;
690 * Data ring arrays for RX, TX and Beacon.
691 * The Beacon array also contains the Atim ring
692 * if that is supported by the device.
695 struct data_ring *rx;
696 struct data_ring *tx;
697 struct data_ring *bcn;
702 const struct firmware *fw;
706 * For-each loop for the ring array.
707 * All rings have been allocated as a single array,
708 * this means we can create a very simply loop macro
709 * that is capable of looping through all rings.
710 * ring_end(), txring_end() and ring_loop() are helper macro's which
711 * should not be used directly. Instead the following should be used:
712 * ring_for_each() - Loops through all rings (RX, TX, Beacon & Atim)
713 * txring_for_each() - Loops through TX data rings (TX only)
714 * txringall_for_each() - Loops through all TX rings (TX, Beacon & Atim)
716 #define ring_end(__dev) \
717 &(__dev)->rx[(__dev)->data_rings]
719 #define txring_end(__dev) \
720 &(__dev)->tx[(__dev)->hw->queues]
722 #define ring_loop(__entry, __start, __end) \
723 for ((__entry) = (__start); \
724 prefetch(&(__entry)[1]), (__entry) != (__end); \
725 (__entry) = &(__entry)[1])
727 #define ring_for_each(__dev, __entry) \
728 ring_loop(__entry, (__dev)->rx, ring_end(__dev))
730 #define txring_for_each(__dev, __entry) \
731 ring_loop(__entry, (__dev)->tx, txring_end(__dev))
733 #define txringall_for_each(__dev, __entry) \
734 ring_loop(__entry, (__dev)->tx, ring_end(__dev))
738 * The RF is being accessed by word index.
740 static inline void rt2x00_rf_read(const struct rt2x00_dev *rt2x00dev,
741 const unsigned int word, u32 *data)
743 *data = rt2x00dev->rf[word];
746 static inline void rt2x00_rf_write(const struct rt2x00_dev *rt2x00dev,
747 const unsigned int word, u32 data)
749 rt2x00dev->rf[word] = data;
753 * Generic EEPROM access.
754 * The EEPROM is being accessed by word index.
756 static inline void *rt2x00_eeprom_addr(const struct rt2x00_dev *rt2x00dev,
757 const unsigned int word)
759 return (void *)&rt2x00dev->eeprom[word];
762 static inline void rt2x00_eeprom_read(const struct rt2x00_dev *rt2x00dev,
763 const unsigned int word, u16 *data)
765 *data = le16_to_cpu(rt2x00dev->eeprom[word]);
768 static inline void rt2x00_eeprom_write(const struct rt2x00_dev *rt2x00dev,
769 const unsigned int word, u16 data)
771 rt2x00dev->eeprom[word] = cpu_to_le16(data);
777 static inline void rt2x00_set_chip(struct rt2x00_dev *rt2x00dev,
778 const u16 rt, const u16 rf, const u32 rev)
781 "Chipset detected - rt: %04x, rf: %04x, rev: %08x.\n",
784 rt2x00dev->chip.rt = rt;
785 rt2x00dev->chip.rf = rf;
786 rt2x00dev->chip.rev = rev;
789 static inline char rt2x00_rt(const struct rt2x00_chip *chipset, const u16 chip)
791 return (chipset->rt == chip);
794 static inline char rt2x00_rf(const struct rt2x00_chip *chipset, const u16 chip)
796 return (chipset->rf == chip);
799 static inline u16 rt2x00_rev(const struct rt2x00_chip *chipset)
804 static inline u16 rt2x00_check_rev(const struct rt2x00_chip *chipset,
807 return (((chipset->rev & 0xffff0) == rev) &&
808 !!(chipset->rev & 0x0000f));
812 * Duration calculations
813 * The rate variable passed is: 100kbs.
814 * To convert from bytes to bits we multiply size with 8,
815 * then the size is multiplied with 10 to make the
816 * real rate -> rate argument correction.
818 static inline u16 get_duration(const unsigned int size, const u8 rate)
820 return ((size * 8 * 10) / rate);
823 static inline u16 get_duration_res(const unsigned int size, const u8 rate)
825 return ((size * 8 * 10) % rate);
831 struct data_ring *rt2x00lib_get_ring(struct rt2x00_dev *rt2x00dev,
832 const unsigned int queue);
835 * Interrupt context handlers.
837 void rt2x00lib_beacondone(struct rt2x00_dev *rt2x00dev);
838 void rt2x00lib_txdone(struct data_entry *entry,
839 const int status, const int retry);
840 void rt2x00lib_rxdone(struct data_entry *entry, struct sk_buff *skb,
841 struct rxdata_entry_desc *desc);
844 * TX descriptor initializer
846 void rt2x00lib_write_tx_desc(struct rt2x00_dev *rt2x00dev,
847 struct data_desc *txd,
848 struct ieee80211_hdr *ieee80211hdr,
850 struct ieee80211_tx_control *control);
855 int rt2x00mac_tx(struct ieee80211_hw *hw, struct sk_buff *skb,
856 struct ieee80211_tx_control *control);
857 int rt2x00mac_start(struct ieee80211_hw *hw);
858 void rt2x00mac_stop(struct ieee80211_hw *hw);
859 int rt2x00mac_add_interface(struct ieee80211_hw *hw,
860 struct ieee80211_if_init_conf *conf);
861 void rt2x00mac_remove_interface(struct ieee80211_hw *hw,
862 struct ieee80211_if_init_conf *conf);
863 int rt2x00mac_config(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
864 int rt2x00mac_config_interface(struct ieee80211_hw *hw, int if_id,
865 struct ieee80211_if_conf *conf);
866 int rt2x00mac_get_stats(struct ieee80211_hw *hw,
867 struct ieee80211_low_level_stats *stats);
868 int rt2x00mac_get_tx_stats(struct ieee80211_hw *hw,
869 struct ieee80211_tx_queue_stats *stats);
870 void rt2x00mac_erp_ie_changed(struct ieee80211_hw *hw, u8 changes,
871 int cts_protection, int preamble);
872 int rt2x00mac_conf_tx(struct ieee80211_hw *hw, int queue,
873 const struct ieee80211_tx_queue_params *params);
876 * Driver allocation handlers.
878 int rt2x00lib_probe_dev(struct rt2x00_dev *rt2x00dev);
879 void rt2x00lib_remove_dev(struct rt2x00_dev *rt2x00dev);
881 int rt2x00lib_suspend(struct rt2x00_dev *rt2x00dev, pm_message_t state);
882 int rt2x00lib_resume(struct rt2x00_dev *rt2x00dev);
883 #endif /* CONFIG_PM */
885 #endif /* RT2X00_H */