drivers/net/wireless/rt2x00/rt2x00.h

   1 /*
   2         Copyright (C) 2004 - 2007 rt2x00 SourceForge Project
   3         <http://rt2x00.serialmonkey.com>
   4
   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.
   9
  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.
  14
  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.
  19  */
  20
  21 /*
  22         Module: rt2x00
  23         Abstract: rt2x00 global information.
  24  */
  25
  26 #ifndef RT2X00_H
  27 #define RT2X00_H
  28
  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>
  34
  35 #include <net/mac80211.h>
  36
  37 #include "rt2x00debug.h"
  38 #include "rt2x00reg.h"
  39 #include "rt2x00ring.h"
  40
  41 /*
  42  * Module information.
  43  * DRV_NAME should be set within the individual module source files.
  44  */
  45 #define DRV_VERSION     "2.0.10"
  46 #define DRV_PROJECT     "http://rt2x00.serialmonkey.com"
  47
  48 /*
  49  * Debug definitions.
  50  * Debug output has to be enabled during compile time.
  51  */
  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)
  55
  56 #define DEBUG_PRINTK_PROBE(__kernlvl, __lvl, __msg, __args...)  \
  57         printk(__kernlvl "%s -> %s: %s - " __msg,               \
  58                DRV_NAME, __FUNCTION__, __lvl, ##__args)
  59
  60 #ifdef CONFIG_RT2X00_DEBUG
  61 #define DEBUG_PRINTK(__dev, __kernlvl, __lvl, __msg, __args...) \
  62         DEBUG_PRINTK_MSG(__dev, __kernlvl, __lvl, __msg, ##__args);
  63 #else
  64 #define DEBUG_PRINTK(__dev, __kernlvl, __lvl, __msg, __args...) \
  65         do { } while (0)
  66 #endif /* CONFIG_RT2X00_DEBUG */
  67
  68 /*
  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.
  74  */
  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)
  91
  92 /*
  93  * Ring sizes.
  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.
  97  */
  98 #define DATA_FRAME_SIZE 2432
  99 #define MGMT_FRAME_SIZE 256
 100
 101 /*
 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.
 106  */
 107 #define RX_ENTRIES      12
 108 #define TX_ENTRIES      12
 109 #define ATIM_ENTRIES    1
 110 #define BEACON_ENTRIES  2
 111
 112 /*
 113  * Standard timing and size defines.
 114  * These values should follow the ieee80211 specifications.
 115  */
 116 #define ACK_SIZE                14
 117 #define IEEE80211_HEADER        24
 118 #define PLCP                    48
 119 #define BEACON                  100
 120 #define PREAMBLE                144
 121 #define SHORT_PREAMBLE          72
 122 #define SLOT_TIME               20
 123 #define SHORT_SLOT_TIME         9
 124 #define SIFS                    10
 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)) )
 130
 131 /*
 132  * IEEE802.11 header defines
 133  */
 134 static inline int is_rts_frame(u16 fc)
 135 {
 136         return !!(((fc & IEEE80211_FCTL_FTYPE) == IEEE80211_FTYPE_CTL) &&
 137                   ((fc & IEEE80211_FCTL_STYPE) == IEEE80211_STYPE_RTS));
 138 }
 139
 140 static inline int is_cts_frame(u16 fc)
 141 {
 142         return !!(((fc & IEEE80211_FCTL_FTYPE) == IEEE80211_FTYPE_CTL) &&
 143                   ((fc & IEEE80211_FCTL_STYPE) == IEEE80211_STYPE_CTS));
 144 }
 145
 146 static inline int is_probe_resp(u16 fc)
 147 {
 148         return !!(((fc & IEEE80211_FCTL_FTYPE) == IEEE80211_FTYPE_MGMT) &&
 149                   ((fc & IEEE80211_FCTL_STYPE) == IEEE80211_STYPE_PROBE_RESP));
 150 }
 151
 152 /*
 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.
 156  */
 157 struct rt2x00_chip {
 158         u16 rt;
 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
 166
 167         u16 rf;
 168         u32 rev;
 169 };
 170
 171 /*
 172  * RF register values that belong to a particular channel.
 173  */
 174 struct rf_channel {
 175         int channel;
 176         u32 rf1;
 177         u32 rf2;
 178         u32 rf3;
 179         u32 rf4;
 180 };
 181
 182 /*
 183  * Antenna setup values.
 184  */
 185 struct antenna_setup {
 186         enum antenna rx;
 187         enum antenna tx;
 188 };
 189
 190 /*
 191  * Quality statistics about the currently active link.
 192  */
 193 struct link_qual {
 194         /*
 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
 198          * is needed:
 199          *
 200          *        avg_rssi = ((avg_rssi * 7) + rssi) / 8;
 201          *
 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.
 211          */
 212         int avg_rssi;
 213         int false_cca;
 214
 215         /*
 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:
 222          *
 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
 229          *
 230          * This value should then be checked to not be greated then 100.
 231          */
 232         int rx_percentage;
 233         int rx_success;
 234         int rx_failed;
 235         int tx_percentage;
 236         int tx_success;
 237         int tx_failed;
 238 #define WEIGHT_RSSI     20
 239 #define WEIGHT_RX       40
 240 #define WEIGHT_TX       40
 241 };
 242
 243 /*
 244  * To optimize the quality of the link we need to store
 245  * the quality of received frames and periodically
 246  * optimize the link.
 247  */
 248 struct link {
 249         /*
 250          * Link tuner counter
 251          * The number of times the link has been tuned
 252          * since the radio has been switched on.
 253          */
 254         u32 count;
 255
 256         /*
 257          * Quality measurement values.
 258          */
 259         struct link_qual qual;
 260
 261         /*
 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.
 265          */
 266         struct antenna_setup active_ant;
 267
 268         /*
 269          * Active VGC level
 270          */
 271         int vgc_level;
 272
 273         /*
 274          * Work structure for scheduling periodic link tuning.
 275          */
 276         struct delayed_work work;
 277 };
 278
 279 /*
 280  * Clear all counters inside the link structure.
 281  */
 282 static inline void rt2x00_clear_link(struct link *link)
 283 {
 284         link->count = 0;
 285         memset(&link->qual, 0, sizeof(link->qual));
 286         link->qual.rx_percentage = 50;
 287         link->qual.tx_percentage = 50;
 288 }
 289
 290 /*
 291  * Update the rssi using the walking average approach.
 292  */
 293 static inline void rt2x00_update_link_rssi(struct link *link, int rssi)
 294 {
 295         if (!link->qual.avg_rssi)
 296                 link->qual.avg_rssi = rssi;
 297         else
 298                 link->qual.avg_rssi = ((link->qual.avg_rssi * 7) + rssi) / 8;
 299 }
 300
 301 /*
 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.
 305  */
 306 static inline int rt2x00_get_link_rssi(struct link *link)
 307 {
 308         if (link->qual.avg_rssi && link->qual.rx_success)
 309                 return link->qual.avg_rssi;
 310         return -128;
 311 }
 312
 313 /*
 314  * Interface structure
 315  * Configuration details about the current interface.
 316  */
 317 struct interface {
 318         /*
 319          * Interface identification. The value is assigned
 320          * to us by the 80211 stack, and is used to request
 321          * new beacons.
 322          */
 323         int id;
 324
 325         /*
 326          * Current working type (IEEE80211_IF_TYPE_*).
 327          * When set to INVALID_INTERFACE, no interface is configured.
 328          */
 329         int type;
 330 #define INVALID_INTERFACE       IEEE80211_IF_TYPE_INVALID
 331
 332         /*
 333          * MAC of the device.
 334          */
 335         u8 mac[ETH_ALEN];
 336
 337         /*
 338          * BBSID of the AP to associate with.
 339          */
 340         u8 bssid[ETH_ALEN];
 341
 342         /*
 343          * Store the packet filter mode for the current interface.
 344          */
 345         unsigned int filter;
 346 };
 347
 348 static inline int is_interface_present(struct interface *intf)
 349 {
 350         return !!intf->id;
 351 }
 352
 353 static inline int is_interface_type(struct interface *intf, int type)
 354 {
 355         return intf->type == type;
 356 }
 357
 358 /*
 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.
 362  */
 363 struct hw_mode_spec {
 364         /*
 365          * Number of modes, rates and channels.
 366          */
 367         int num_modes;
 368         int num_rates;
 369         int num_channels;
 370
 371         /*
 372          * txpower values.
 373          */
 374         const u8 *tx_power_a;
 375         const u8 *tx_power_bg;
 376         u8 tx_power_default;
 377
 378         /*
 379          * Device/chipset specific value.
 380          */
 381         const struct rf_channel *channels;
 382 };
 383
 384 /*
 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.
 390  */
 391 struct rt2x00lib_conf {
 392         struct ieee80211_conf *conf;
 393         struct rf_channel rf;
 394
 395         struct antenna_setup ant;
 396
 397         int phymode;
 398
 399         int basic_rates;
 400         int slot_time;
 401
 402         short sifs;
 403         short pifs;
 404         short difs;
 405         short eifs;
 406 };
 407
 408 /*
 409  * rt2x00lib callback functions.
 410  */
 411 struct rt2x00lib_ops {
 412         /*
 413          * Interrupt handlers.
 414          */
 415         irq_handler_t irq_handler;
 416
 417         /*
 418          * Device init handlers.
 419          */
 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,
 423                               const size_t len);
 424
 425         /*
 426          * Device initialization/deinitialization handlers.
 427          */
 428         int (*initialize) (struct rt2x00_dev *rt2x00dev);
 429         void (*uninitialize) (struct rt2x00_dev *rt2x00dev);
 430
 431         /*
 432          * Radio control handlers.
 433          */
 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);
 441
 442         /*
 443          * TX control handlers
 444          */
 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,
 449                                unsigned int length,
 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,
 457                                unsigned int queue);
 458
 459         /*
 460          * RX control handlers
 461          */
 462         void (*fill_rxdone) (struct data_entry *entry,
 463                              struct rxdata_entry_desc *desc);
 464
 465         /*
 466          * Configuration handlers.
 467          */
 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,
 471                                                            const int tsf_sync);
 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
 485 };
 486
 487 /*
 488  * rt2x00 driver callback operation structure.
 489  */
 490 struct rt2x00_ops {
 491         const char *name;
 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 */
 501 };
 502
 503 /*
 504  * rt2x00 device flags
 505  */
 506 enum rt2x00_flags {
 507         /*
 508          * Device state flags
 509          */
 510         DEVICE_PRESENT,
 511         DEVICE_REGISTERED_HW,
 512         DEVICE_INITIALIZED,
 513         DEVICE_STARTED,
 514         DEVICE_STARTED_SUSPEND,
 515         DEVICE_ENABLED_RADIO,
 516         DEVICE_DISABLED_RADIO_HW,
 517
 518         /*
 519          * Driver features
 520          */
 521         DRIVER_REQUIRE_FIRMWARE,
 522         DRIVER_REQUIRE_BEACON_RING,
 523
 524         /*
 525          * Driver configuration
 526          */
 527         CONFIG_SUPPORT_HW_BUTTON,
 528         CONFIG_FRAME_TYPE,
 529         CONFIG_RF_SEQUENCE,
 530         CONFIG_EXTERNAL_LNA_A,
 531         CONFIG_EXTERNAL_LNA_BG,
 532         CONFIG_DOUBLE_ANTENNA,
 533         CONFIG_DISABLE_LINK_TUNING,
 534         CONFIG_SHORT_PREAMBLE,
 535 };
 536
 537 /*
 538  * rt2x00 device structure.
 539  */
 540 struct rt2x00_dev {
 541         /*
 542          * 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.
 547          */
 548         void *dev;
 549 #define rt2x00dev_pci(__dev)    ( (struct pci_dev*)(__dev)->dev )
 550 #define rt2x00dev_usb(__dev)    ( (struct usb_interface*)(__dev)->dev )
 551
 552         /*
 553          * Callback functions.
 554          */
 555         const struct rt2x00_ops *ops;
 556
 557         /*
 558          * IEEE80211 control structure.
 559          */
 560         struct ieee80211_hw *hw;
 561         struct ieee80211_hw_mode *hwmodes;
 562         unsigned int curr_hwmode;
 563 #define HWMODE_B        0
 564 #define HWMODE_G        1
 565 #define HWMODE_A        2
 566
 567         /*
 568          * rfkill structure for RF state switching support.
 569          * This will only be compiled in when required.
 570          */
 571 #ifdef CONFIG_RT2X00_LIB_RFKILL
 572         struct rfkill *rfkill;
 573         struct input_polled_dev *poll_dev;
 574 #endif /* CONFIG_RT2X00_LIB_RFKILL */
 575
 576         /*
 577          * If enabled, the debugfs interface structures
 578          * required for deregistration of debugfs.
 579          */
 580 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
 581         const struct rt2x00debug_intf *debugfs_intf;
 582 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
 583
 584         /*
 585          * Device flags.
 586          * In these flags the current status and some
 587          * of the device capabilities are stored.
 588          */
 589         unsigned long flags;
 590
 591         /*
 592          * Chipset identification.
 593          */
 594         struct rt2x00_chip chip;
 595
 596         /*
 597          * hw capability specifications.
 598          */
 599         struct hw_mode_spec spec;
 600
 601         /*
 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.
 605          */
 606         struct antenna_setup default_ant;
 607
 608         /*
 609          * Register pointers
 610          * csr_addr: Base register address. (PCI)
 611          * csr_cache: CSR cache for usb_control_msg. (USB)
 612          */
 613         void __iomem *csr_addr;
 614         void *csr_cache;
 615
 616         /*
 617          * Interface configuration.
 618          */
 619         struct interface interface;
 620
 621         /*
 622          * Link quality
 623          */
 624         struct link link;
 625
 626         /*
 627          * EEPROM data.
 628          */
 629         __le16 *eeprom;
 630
 631         /*
 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().
 638          */
 639         u32 *rf;
 640
 641         /*
 642          * USB Max frame size (for rt2500usb & rt73usb).
 643          */
 644         u16 usb_maxpacket;
 645
 646         /*
 647          * Current TX power value.
 648          */
 649         u16 tx_power;
 650
 651         /*
 652          * LED register (for rt61pci & rt73usb).
 653          */
 654         u16 led_reg;
 655
 656         /*
 657          * Led mode (LED_MODE_*)
 658          */
 659         u8 led_mode;
 660
 661         /*
 662          * Rssi <-> Dbm offset
 663          */
 664         u8 rssi_offset;
 665
 666         /*
 667          * Frequency offset (for rt61pci & rt73usb).
 668          */
 669         u8 freq_offset;
 670
 671         /*
 672          * Low level statistics which will have
 673          * to be kept up to date while device is running.
 674          */
 675         struct ieee80211_low_level_stats low_level_stats;
 676
 677         /*
 678          * RX configuration information.
 679          */
 680         struct ieee80211_rx_status rx_status;
 681
 682         /*
 683          * Scheduled work.
 684          */
 685         struct work_struct beacon_work;
 686         struct work_struct filter_work;
 687         struct work_struct config_work;
 688
 689         /*
 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.
 693          */
 694         int data_rings;
 695         struct data_ring *rx;
 696         struct data_ring *tx;
 697         struct data_ring *bcn;
 698
 699         /*
 700          * Firmware image.
 701          */
 702         const struct firmware *fw;
 703 };
 704
 705 /*
 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)
 715  */
 716 #define ring_end(__dev) \
 717         &(__dev)->rx[(__dev)->data_rings]
 718
 719 #define txring_end(__dev) \
 720         &(__dev)->tx[(__dev)->hw->queues]
 721
 722 #define ring_loop(__entry, __start, __end)                      \
 723         for ((__entry) = (__start);                             \
 724              prefetch(&(__entry)[1]), (__entry) != (__end);     \
 725              (__entry) = &(__entry)[1])
 726
 727 #define ring_for_each(__dev, __entry) \
 728         ring_loop(__entry, (__dev)->rx, ring_end(__dev))
 729
 730 #define txring_for_each(__dev, __entry) \
 731         ring_loop(__entry, (__dev)->tx, txring_end(__dev))
 732
 733 #define txringall_for_each(__dev, __entry) \
 734         ring_loop(__entry, (__dev)->tx, ring_end(__dev))
 735
 736 /*
 737  * Generic RF access.
 738  * The RF is being accessed by word index.
 739  */
 740 static inline void rt2x00_rf_read(const struct rt2x00_dev *rt2x00dev,
 741                                   const unsigned int word, u32 *data)
 742 {
 743         *data = rt2x00dev->rf[word];
 744 }
 745
 746 static inline void rt2x00_rf_write(const struct rt2x00_dev *rt2x00dev,
 747                                    const unsigned int word, u32 data)
 748 {
 749         rt2x00dev->rf[word] = data;
 750 }
 751
 752 /*
 753  *  Generic EEPROM access.
 754  * The EEPROM is being accessed by word index.
 755  */
 756 static inline void *rt2x00_eeprom_addr(const struct rt2x00_dev *rt2x00dev,
 757                                        const unsigned int word)
 758 {
 759         return (void *)&rt2x00dev->eeprom[word];
 760 }
 761
 762 static inline void rt2x00_eeprom_read(const struct rt2x00_dev *rt2x00dev,
 763                                       const unsigned int word, u16 *data)
 764 {
 765         *data = le16_to_cpu(rt2x00dev->eeprom[word]);
 766 }
 767
 768 static inline void rt2x00_eeprom_write(const struct rt2x00_dev *rt2x00dev,
 769                                        const unsigned int word, u16 data)
 770 {
 771         rt2x00dev->eeprom[word] = cpu_to_le16(data);
 772 }
 773
 774 /*
 775  * Chipset handlers
 776  */
 777 static inline void rt2x00_set_chip(struct rt2x00_dev *rt2x00dev,
 778                                    const u16 rt, const u16 rf, const u32 rev)
 779 {
 780         INFO(rt2x00dev,
 781              "Chipset detected - rt: %04x, rf: %04x, rev: %08x.\n",
 782              rt, rf, rev);
 783
 784         rt2x00dev->chip.rt = rt;
 785         rt2x00dev->chip.rf = rf;
 786         rt2x00dev->chip.rev = rev;
 787 }
 788
 789 static inline char rt2x00_rt(const struct rt2x00_chip *chipset, const u16 chip)
 790 {
 791         return (chipset->rt == chip);
 792 }
 793
 794 static inline char rt2x00_rf(const struct rt2x00_chip *chipset, const u16 chip)
 795 {
 796         return (chipset->rf == chip);
 797 }
 798
 799 static inline u16 rt2x00_rev(const struct rt2x00_chip *chipset)
 800 {
 801         return chipset->rev;
 802 }
 803
 804 static inline u16 rt2x00_check_rev(const struct rt2x00_chip *chipset,
 805                                    const u32 rev)
 806 {
 807         return (((chipset->rev & 0xffff0) == rev) &&
 808                 !!(chipset->rev & 0x0000f));
 809 }
 810
 811 /*
 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.
 817  */
 818 static inline u16 get_duration(const unsigned int size, const u8 rate)
 819 {
 820         return ((size * 8 * 10) / rate);
 821 }
 822
 823 static inline u16 get_duration_res(const unsigned int size, const u8 rate)
 824 {
 825         return ((size * 8 * 10) % rate);
 826 }
 827
 828 /*
 829  * Library functions.
 830  */
 831 struct data_ring *rt2x00lib_get_ring(struct rt2x00_dev *rt2x00dev,
 832                                      const unsigned int queue);
 833
 834 /*
 835  * Interrupt context handlers.
 836  */
 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);
 842
 843 /*
 844  * TX descriptor initializer
 845  */
 846 void rt2x00lib_write_tx_desc(struct rt2x00_dev *rt2x00dev,
 847                              struct data_desc *txd,
 848                              struct ieee80211_hdr *ieee80211hdr,
 849                              unsigned int length,
 850                              struct ieee80211_tx_control *control);
 851
 852 /*
 853  * mac80211 handlers.
 854  */
 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);
 874
 875 /*
 876  * Driver allocation handlers.
 877  */
 878 int rt2x00lib_probe_dev(struct rt2x00_dev *rt2x00dev);
 879 void rt2x00lib_remove_dev(struct rt2x00_dev *rt2x00dev);
 880 #ifdef CONFIG_PM
 881 int rt2x00lib_suspend(struct rt2x00_dev *rt2x00dev, pm_message_t state);
 882 int rt2x00lib_resume(struct rt2x00_dev *rt2x00dev);
 883 #endif /* CONFIG_PM */
 884
 885 #endif /* RT2X00_H */