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.9"
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 * To optimize the quality of the link we need to store
184 * the quality of received frames and periodically
190 * The number of times the link has been tuned
191 * since the radio has been switched on.
196 * Statistics required for Link tuning.
197 * For the average RSSI value we use the "Walking average" approach.
198 * When adding RSSI to the average value the following calculation
201 * avg_rssi = ((avg_rssi * 7) + rssi) / 8;
203 * The advantage of this approach is that we only need 1 variable
204 * to store the average in (No need for a count and a total).
205 * But more importantly, normal average values will over time
206 * move less and less towards newly added values this results
207 * that with link tuning, the device can have a very good RSSI
208 * for a few minutes but when the device is moved away from the AP
209 * the average will not decrease fast enough to compensate.
210 * The walking average compensates this and will move towards
211 * the new values correctly allowing a effective link tuning.
218 * Statistics required for Signal quality calculation.
219 * For calculating the Signal quality we have to determine
220 * the total number of success and failed RX and TX frames.
221 * After that we also use the average RSSI value to help
222 * determining the signal quality.
223 * For the calculation we will use the following algorithm:
225 * rssi_percentage = (avg_rssi * 100) / rssi_offset
226 * rx_percentage = (rx_success * 100) / rx_total
227 * tx_percentage = (tx_success * 100) / tx_total
228 * avg_signal = ((WEIGHT_RSSI * avg_rssi) +
229 * (WEIGHT_TX * tx_percentage) +
230 * (WEIGHT_RX * rx_percentage)) / 100
232 * This value should then be checked to not be greated then 100.
240 #define WEIGHT_RSSI 20
245 * Work structure for scheduling periodic link tuning.
247 struct delayed_work work
;
251 * Clear all counters inside the link structure.
252 * This can be easiest achieved by memsetting everything
253 * except for the work structure at the end.
255 static inline void rt2x00_clear_link(struct link
*link
)
257 memset(link
, 0x00, sizeof(*link
) - sizeof(link
->work
));
258 link
->rx_percentage
= 50;
259 link
->tx_percentage
= 50;
263 * Update the rssi using the walking average approach.
265 static inline void rt2x00_update_link_rssi(struct link
*link
, int rssi
)
268 link
->avg_rssi
= rssi
;
270 link
->avg_rssi
= ((link
->avg_rssi
* 7) + rssi
) / 8;
274 * When the avg_rssi is unset or no frames have been received),
275 * we need to return the default value which needs to be less
276 * than -80 so the device will select the maximum sensitivity.
278 static inline int rt2x00_get_link_rssi(struct link
*link
)
280 return (link
->avg_rssi
&& link
->rx_success
) ? link
->avg_rssi
: -128;
284 * Interface structure
285 * Configuration details about the current interface.
289 * Interface identification. The value is assigned
290 * to us by the 80211 stack, and is used to request
296 * Current working type (IEEE80211_IF_TYPE_*).
297 * When set to INVALID_INTERFACE, no interface is configured.
300 #define INVALID_INTERFACE IEEE80211_IF_TYPE_INVALID
308 * BBSID of the AP to associate with.
313 * Store the packet filter mode for the current interface.
318 static inline int is_interface_present(struct interface
*intf
)
323 static inline int is_interface_type(struct interface
*intf
, int type
)
325 return intf
->type
== type
;
329 * Details about the supported modes, rates and channels
330 * of a particular chipset. This is used by rt2x00lib
331 * to build the ieee80211_hw_mode array for mac80211.
333 struct hw_mode_spec
{
335 * Number of modes, rates and channels.
344 const u8
*tx_power_a
;
345 const u8
*tx_power_bg
;
349 * Device/chipset specific value.
351 const struct rf_channel
*channels
;
355 * rt2x00lib callback functions.
357 struct rt2x00lib_ops
{
359 * Interrupt handlers.
361 irq_handler_t irq_handler
;
364 * Device init handlers.
366 int (*probe_hw
) (struct rt2x00_dev
*rt2x00dev
);
367 char *(*get_firmware_name
) (struct rt2x00_dev
*rt2x00dev
);
368 int (*load_firmware
) (struct rt2x00_dev
*rt2x00dev
, void *data
,
372 * Device initialization/deinitialization handlers.
374 int (*initialize
) (struct rt2x00_dev
*rt2x00dev
);
375 void (*uninitialize
) (struct rt2x00_dev
*rt2x00dev
);
378 * Radio control handlers.
380 int (*set_device_state
) (struct rt2x00_dev
*rt2x00dev
,
381 enum dev_state state
);
382 int (*rfkill_poll
) (struct rt2x00_dev
*rt2x00dev
);
383 void (*link_stats
) (struct rt2x00_dev
*rt2x00dev
);
384 void (*reset_tuner
) (struct rt2x00_dev
*rt2x00dev
);
385 void (*link_tuner
) (struct rt2x00_dev
*rt2x00dev
);
388 * TX control handlers
390 void (*write_tx_desc
) (struct rt2x00_dev
*rt2x00dev
,
391 struct data_desc
*txd
,
392 struct txdata_entry_desc
*desc
,
393 struct ieee80211_hdr
*ieee80211hdr
,
395 struct ieee80211_tx_control
*control
);
396 int (*write_tx_data
) (struct rt2x00_dev
*rt2x00dev
,
397 struct data_ring
*ring
, struct sk_buff
*skb
,
398 struct ieee80211_tx_control
*control
);
399 void (*kick_tx_queue
) (struct rt2x00_dev
*rt2x00dev
,
403 * RX control handlers
405 void (*fill_rxdone
) (struct data_entry
*entry
,
406 struct rxdata_entry_desc
*desc
);
409 * Configuration handlers.
411 void (*config_mac_addr
) (struct rt2x00_dev
*rt2x00dev
, __le32
*mac
);
412 void (*config_bssid
) (struct rt2x00_dev
*rt2x00dev
, __le32
*bssid
);
413 void (*config_packet_filter
) (struct rt2x00_dev
*rt2x00dev
,
414 const unsigned int filter
);
415 void (*config_type
) (struct rt2x00_dev
*rt2x00dev
, const int type
);
416 void (*config
) (struct rt2x00_dev
*rt2x00dev
, const unsigned int flags
,
417 struct ieee80211_conf
*conf
);
418 #define CONFIG_UPDATE_PHYMODE ( 1 << 1 )
419 #define CONFIG_UPDATE_CHANNEL ( 1 << 2 )
420 #define CONFIG_UPDATE_TXPOWER ( 1 << 3 )
421 #define CONFIG_UPDATE_ANTENNA ( 1 << 4 )
422 #define CONFIG_UPDATE_SLOT_TIME ( 1 << 5 )
423 #define CONFIG_UPDATE_BEACON_INT ( 1 << 6 )
424 #define CONFIG_UPDATE_ALL 0xffff
428 * rt2x00 driver callback operation structure.
432 const unsigned int rxd_size
;
433 const unsigned int txd_size
;
434 const unsigned int eeprom_size
;
435 const unsigned int rf_size
;
436 const struct rt2x00lib_ops
*lib
;
437 const struct ieee80211_ops
*hw
;
438 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
439 const struct rt2x00debug
*debugfs
;
440 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
444 * rt2x00 device flags
451 DEVICE_REGISTERED_HW
,
454 DEVICE_STARTED_SUSPEND
,
455 DEVICE_ENABLED_RADIO
,
456 DEVICE_ENABLED_RADIO_HW
,
461 DRIVER_REQUIRE_FIRMWARE
,
462 DRIVER_REQUIRE_BEACON_RING
,
465 * Driver configuration
467 CONFIG_SUPPORT_HW_BUTTON
,
470 CONFIG_EXTERNAL_LNA_A
,
471 CONFIG_EXTERNAL_LNA_BG
,
472 CONFIG_DOUBLE_ANTENNA
,
473 CONFIG_DISABLE_LINK_TUNING
,
477 * rt2x00 device structure.
482 * The structure stored in here depends on the
483 * system bus (PCI or USB).
484 * When accessing this variable, the rt2x00dev_{pci,usb}
485 * macro's should be used for correct typecasting.
488 #define rt2x00dev_pci(__dev) ( (struct pci_dev*)(__dev)->dev )
489 #define rt2x00dev_usb(__dev) ( (struct usb_interface*)(__dev)->dev )
492 * Callback functions.
494 const struct rt2x00_ops
*ops
;
497 * IEEE80211 control structure.
499 struct ieee80211_hw
*hw
;
500 struct ieee80211_hw_mode
*hwmodes
;
501 unsigned int curr_hwmode
;
507 * rfkill structure for RF state switching support.
508 * This will only be compiled in when required.
510 #ifdef CONFIG_RT2X00_LIB_RFKILL
511 struct rfkill
*rfkill
;
512 struct input_polled_dev
*poll_dev
;
513 #endif /* CONFIG_RT2X00_LIB_RFKILL */
516 * If enabled, the debugfs interface structures
517 * required for deregistration of debugfs.
519 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
520 const struct rt2x00debug_intf
*debugfs_intf
;
521 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
525 * In these flags the current status and some
526 * of the device capabilities are stored.
531 * Chipset identification.
533 struct rt2x00_chip chip
;
536 * hw capability specifications.
538 struct hw_mode_spec spec
;
542 * csr_addr: Base register address. (PCI)
543 * csr_cache: CSR cache for usb_control_msg. (USB)
545 void __iomem
*csr_addr
;
549 * Interface configuration.
551 struct interface interface
;
564 * Active RF register values.
565 * These are stored here so we don't need
566 * to read the rf registers and can directly
567 * use this value instead.
568 * This field should be accessed by using
569 * rt2x00_rf_read() and rt2x00_rf_write().
574 * Current TX power value.
579 * LED register (for rt61pci & rt73usb).
584 * Led mode (LED_MODE_*)
589 * Rssi <-> Dbm offset
594 * Frequency offset (for rt61pci & rt73usb).
599 * Low level statistics which will have
600 * to be kept up to date while device is running.
602 struct ieee80211_low_level_stats low_level_stats
;
605 * RX configuration information.
607 struct ieee80211_rx_status rx_status
;
612 struct work_struct beacon_work
;
613 struct work_struct filter_work
;
616 * Data ring arrays for RX, TX and Beacon.
617 * The Beacon array also contains the Atim ring
618 * if that is supported by the device.
621 struct data_ring
*rx
;
622 struct data_ring
*tx
;
623 struct data_ring
*bcn
;
628 const struct firmware
*fw
;
632 * For-each loop for the ring array.
633 * All rings have been allocated as a single array,
634 * this means we can create a very simply loop macro
635 * that is capable of looping through all rings.
636 * ring_end(), txring_end() and ring_loop() are helper macro's which
637 * should not be used directly. Instead the following should be used:
638 * ring_for_each() - Loops through all rings (RX, TX, Beacon & Atim)
639 * txring_for_each() - Loops through TX data rings (TX only)
640 * txringall_for_each() - Loops through all TX rings (TX, Beacon & Atim)
642 #define ring_end(__dev) \
643 &(__dev)->rx[(__dev)->data_rings]
645 #define txring_end(__dev) \
646 &(__dev)->tx[(__dev)->hw->queues]
648 #define ring_loop(__entry, __start, __end) \
649 for ((__entry) = (__start); \
650 prefetch(&(__entry)[1]), (__entry) != (__end); \
651 (__entry) = &(__entry)[1])
653 #define ring_for_each(__dev, __entry) \
654 ring_loop(__entry, (__dev)->rx, ring_end(__dev))
656 #define txring_for_each(__dev, __entry) \
657 ring_loop(__entry, (__dev)->tx, txring_end(__dev))
659 #define txringall_for_each(__dev, __entry) \
660 ring_loop(__entry, (__dev)->tx, ring_end(__dev))
664 * The RF is being accessed by word index.
666 static inline void rt2x00_rf_read(const struct rt2x00_dev
*rt2x00dev
,
667 const unsigned int word
, u32
*data
)
669 *data
= rt2x00dev
->rf
[word
];
672 static inline void rt2x00_rf_write(const struct rt2x00_dev
*rt2x00dev
,
673 const unsigned int word
, u32 data
)
675 rt2x00dev
->rf
[word
] = data
;
679 * Generic EEPROM access.
680 * The EEPROM is being accessed by word index.
682 static inline void *rt2x00_eeprom_addr(const struct rt2x00_dev
*rt2x00dev
,
683 const unsigned int word
)
685 return (void *)&rt2x00dev
->eeprom
[word
];
688 static inline void rt2x00_eeprom_read(const struct rt2x00_dev
*rt2x00dev
,
689 const unsigned int word
, u16
*data
)
691 *data
= le16_to_cpu(rt2x00dev
->eeprom
[word
]);
694 static inline void rt2x00_eeprom_write(const struct rt2x00_dev
*rt2x00dev
,
695 const unsigned int word
, u16 data
)
697 rt2x00dev
->eeprom
[word
] = cpu_to_le16(data
);
703 static inline void rt2x00_set_chip(struct rt2x00_dev
*rt2x00dev
,
704 const u16 rt
, const u16 rf
, const u32 rev
)
707 "Chipset detected - rt: %04x, rf: %04x, rev: %08x.\n",
710 rt2x00dev
->chip
.rt
= rt
;
711 rt2x00dev
->chip
.rf
= rf
;
712 rt2x00dev
->chip
.rev
= rev
;
715 static inline char rt2x00_rt(const struct rt2x00_chip
*chipset
, const u16 chip
)
717 return (chipset
->rt
== chip
);
720 static inline char rt2x00_rf(const struct rt2x00_chip
*chipset
, const u16 chip
)
722 return (chipset
->rf
== chip
);
725 static inline u16
rt2x00_get_rev(const struct rt2x00_chip
*chipset
)
730 static inline u16
rt2x00_rev(const struct rt2x00_chip
*chipset
, const u32 mask
)
732 return chipset
->rev
& mask
;
736 * Duration calculations
737 * The rate variable passed is: 100kbs.
738 * To convert from bytes to bits we multiply size with 8,
739 * then the size is multiplied with 10 to make the
740 * real rate -> rate argument correction.
742 static inline u16
get_duration(const unsigned int size
, const u8 rate
)
744 return ((size
* 8 * 10) / rate
);
747 static inline u16
get_duration_res(const unsigned int size
, const u8 rate
)
749 return ((size
* 8 * 10) % rate
);
755 struct data_ring
*rt2x00lib_get_ring(struct rt2x00_dev
*rt2x00dev
,
756 const unsigned int queue
);
759 * Interrupt context handlers.
761 void rt2x00lib_beacondone(struct rt2x00_dev
*rt2x00dev
);
762 void rt2x00lib_txdone(struct data_entry
*entry
,
763 const int status
, const int retry
);
764 void rt2x00lib_rxdone(struct data_entry
*entry
, struct sk_buff
*skb
,
765 struct rxdata_entry_desc
*desc
);
768 * TX descriptor initializer
770 void rt2x00lib_write_tx_desc(struct rt2x00_dev
*rt2x00dev
,
771 struct data_desc
*txd
,
772 struct ieee80211_hdr
*ieee80211hdr
,
774 struct ieee80211_tx_control
*control
);
779 int rt2x00mac_tx(struct ieee80211_hw
*hw
, struct sk_buff
*skb
,
780 struct ieee80211_tx_control
*control
);
781 int rt2x00mac_start(struct ieee80211_hw
*hw
);
782 void rt2x00mac_stop(struct ieee80211_hw
*hw
);
783 int rt2x00mac_add_interface(struct ieee80211_hw
*hw
,
784 struct ieee80211_if_init_conf
*conf
);
785 void rt2x00mac_remove_interface(struct ieee80211_hw
*hw
,
786 struct ieee80211_if_init_conf
*conf
);
787 int rt2x00mac_config(struct ieee80211_hw
*hw
, struct ieee80211_conf
*conf
);
788 int rt2x00mac_config_interface(struct ieee80211_hw
*hw
, int if_id
,
789 struct ieee80211_if_conf
*conf
);
790 int rt2x00mac_get_stats(struct ieee80211_hw
*hw
,
791 struct ieee80211_low_level_stats
*stats
);
792 int rt2x00mac_get_tx_stats(struct ieee80211_hw
*hw
,
793 struct ieee80211_tx_queue_stats
*stats
);
794 int rt2x00mac_conf_tx(struct ieee80211_hw
*hw
, int queue
,
795 const struct ieee80211_tx_queue_params
*params
);
798 * Driver allocation handlers.
800 int rt2x00lib_probe_dev(struct rt2x00_dev
*rt2x00dev
);
801 void rt2x00lib_remove_dev(struct rt2x00_dev
*rt2x00dev
);
803 int rt2x00lib_suspend(struct rt2x00_dev
*rt2x00dev
, pm_message_t state
);
804 int rt2x00lib_resume(struct rt2x00_dev
*rt2x00dev
);
805 #endif /* CONFIG_PM */
807 #endif /* RT2X00_H */