drivers/net/wireless/rt2x00/rt2x00.h

   1 /*
   2         Copyright (C) 2004 - 2008 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/skbuff.h>
  31 #include <linux/workqueue.h>
  32 #include <linux/firmware.h>
  33 #include <linux/mutex.h>
  34 #include <linux/etherdevice.h>
  35
  36 #include <net/mac80211.h>
  37
  38 #include "rt2x00debug.h"
  39 #include "rt2x00reg.h"
  40 #include "rt2x00queue.h"
  41
  42 /*
  43  * Module information.
  44  */
  45 #define DRV_VERSION     "2.0.14"
  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                KBUILD_MODNAME, __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  * Standard timing and size defines.
  94  * These values should follow the ieee80211 specifications.
  95  */
  96 #define ACK_SIZE                14
  97 #define IEEE80211_HEADER        24
  98 #define PLCP                    48
  99 #define BEACON                  100
 100 #define PREAMBLE                144
 101 #define SHORT_PREAMBLE          72
 102 #define SLOT_TIME               20
 103 #define SHORT_SLOT_TIME         9
 104 #define SIFS                    10
 105 #define PIFS                    ( SIFS + SLOT_TIME )
 106 #define SHORT_PIFS              ( SIFS + SHORT_SLOT_TIME )
 107 #define DIFS                    ( PIFS + SLOT_TIME )
 108 #define SHORT_DIFS              ( SHORT_PIFS + SHORT_SLOT_TIME )
 109 #define EIFS                    ( SIFS + (8 * (IEEE80211_HEADER + ACK_SIZE)) )
 110
 111 /*
 112  * IEEE802.11 header defines
 113  */
 114 static inline int is_rts_frame(u16 fc)
 115 {
 116         return (((fc & IEEE80211_FCTL_FTYPE) == IEEE80211_FTYPE_CTL) &&
 117                 ((fc & IEEE80211_FCTL_STYPE) == IEEE80211_STYPE_RTS));
 118 }
 119
 120 static inline int is_cts_frame(u16 fc)
 121 {
 122         return (((fc & IEEE80211_FCTL_FTYPE) == IEEE80211_FTYPE_CTL) &&
 123                 ((fc & IEEE80211_FCTL_STYPE) == IEEE80211_STYPE_CTS));
 124 }
 125
 126 static inline int is_probe_resp(u16 fc)
 127 {
 128         return (((fc & IEEE80211_FCTL_FTYPE) == IEEE80211_FTYPE_MGMT) &&
 129                 ((fc & IEEE80211_FCTL_STYPE) == IEEE80211_STYPE_PROBE_RESP));
 130 }
 131
 132 static inline int is_beacon(u16 fc)
 133 {
 134         return (((fc & IEEE80211_FCTL_FTYPE) == IEEE80211_FTYPE_MGMT) &&
 135                 ((fc & IEEE80211_FCTL_STYPE) == IEEE80211_STYPE_BEACON));
 136 }
 137
 138 /*
 139  * Chipset identification
 140  * The chipset on the device is composed of a RT and RF chip.
 141  * The chipset combination is important for determining device capabilities.
 142  */
 143 struct rt2x00_chip {
 144         u16 rt;
 145 #define RT2460          0x0101
 146 #define RT2560          0x0201
 147 #define RT2570          0x1201
 148 #define RT2561s         0x0301  /* Turbo */
 149 #define RT2561          0x0302
 150 #define RT2661          0x0401
 151 #define RT2571          0x1300
 152
 153         u16 rf;
 154         u32 rev;
 155 };
 156
 157 /*
 158  * RF register values that belong to a particular channel.
 159  */
 160 struct rf_channel {
 161         int channel;
 162         u32 rf1;
 163         u32 rf2;
 164         u32 rf3;
 165         u32 rf4;
 166 };
 167
 168 /*
 169  * Antenna setup values.
 170  */
 171 struct antenna_setup {
 172         enum antenna rx;
 173         enum antenna tx;
 174 };
 175
 176 /*
 177  * Quality statistics about the currently active link.
 178  */
 179 struct link_qual {
 180         /*
 181          * Statistics required for Link tuning.
 182          * For the average RSSI value we use the "Walking average" approach.
 183          * When adding RSSI to the average value the following calculation
 184          * is needed:
 185          *
 186          *        avg_rssi = ((avg_rssi * 7) + rssi) / 8;
 187          *
 188          * The advantage of this approach is that we only need 1 variable
 189          * to store the average in (No need for a count and a total).
 190          * But more importantly, normal average values will over time
 191          * move less and less towards newly added values this results
 192          * that with link tuning, the device can have a very good RSSI
 193          * for a few minutes but when the device is moved away from the AP
 194          * the average will not decrease fast enough to compensate.
 195          * The walking average compensates this and will move towards
 196          * the new values correctly allowing a effective link tuning.
 197          */
 198         int avg_rssi;
 199         int false_cca;
 200
 201         /*
 202          * Statistics required for Signal quality calculation.
 203          * For calculating the Signal quality we have to determine
 204          * the total number of success and failed RX and TX frames.
 205          * After that we also use the average RSSI value to help
 206          * determining the signal quality.
 207          * For the calculation we will use the following algorithm:
 208          *
 209          *         rssi_percentage = (avg_rssi * 100) / rssi_offset
 210          *         rx_percentage = (rx_success * 100) / rx_total
 211          *         tx_percentage = (tx_success * 100) / tx_total
 212          *         avg_signal = ((WEIGHT_RSSI * avg_rssi) +
 213          *                       (WEIGHT_TX * tx_percentage) +
 214          *                       (WEIGHT_RX * rx_percentage)) / 100
 215          *
 216          * This value should then be checked to not be greated then 100.
 217          */
 218         int rx_percentage;
 219         int rx_success;
 220         int rx_failed;
 221         int tx_percentage;
 222         int tx_success;
 223         int tx_failed;
 224 #define WEIGHT_RSSI     20
 225 #define WEIGHT_RX       40
 226 #define WEIGHT_TX       40
 227 };
 228
 229 /*
 230  * Antenna settings about the currently active link.
 231  */
 232 struct link_ant {
 233         /*
 234          * Antenna flags
 235          */
 236         unsigned int flags;
 237 #define ANTENNA_RX_DIVERSITY    0x00000001
 238 #define ANTENNA_TX_DIVERSITY    0x00000002
 239 #define ANTENNA_MODE_SAMPLE     0x00000004
 240
 241         /*
 242          * Currently active TX/RX antenna setup.
 243          * When software diversity is used, this will indicate
 244          * which antenna is actually used at this time.
 245          */
 246         struct antenna_setup active;
 247
 248         /*
 249          * RSSI information for the different antenna's.
 250          * These statistics are used to determine when
 251          * to switch antenna when using software diversity.
 252          *
 253          *        rssi[0] -> Antenna A RSSI
 254          *        rssi[1] -> Antenna B RSSI
 255          */
 256         int rssi_history[2];
 257
 258         /*
 259          * Current RSSI average of the currently active antenna.
 260          * Similar to the avg_rssi in the link_qual structure
 261          * this value is updated by using the walking average.
 262          */
 263         int rssi_ant;
 264 };
 265
 266 /*
 267  * To optimize the quality of the link we need to store
 268  * the quality of received frames and periodically
 269  * optimize the link.
 270  */
 271 struct link {
 272         /*
 273          * Link tuner counter
 274          * The number of times the link has been tuned
 275          * since the radio has been switched on.
 276          */
 277         u32 count;
 278
 279         /*
 280          * Quality measurement values.
 281          */
 282         struct link_qual qual;
 283
 284         /*
 285          * TX/RX antenna setup.
 286          */
 287         struct link_ant ant;
 288
 289         /*
 290          * Active VGC level
 291          */
 292         int vgc_level;
 293
 294         /*
 295          * Work structure for scheduling periodic link tuning.
 296          */
 297         struct delayed_work work;
 298 };
 299
 300 /*
 301  * Small helper macro to work with moving/walking averages.
 302  */
 303 #define MOVING_AVERAGE(__avg, __val, __samples) \
 304         ( (((__avg) * ((__samples) - 1)) + (__val)) / (__samples) )
 305
 306 /*
 307  * When we lack RSSI information return something less then -80 to
 308  * tell the driver to tune the device to maximum sensitivity.
 309  */
 310 #define DEFAULT_RSSI    ( -128 )
 311
 312 /*
 313  * Link quality access functions.
 314  */
 315 static inline int rt2x00_get_link_rssi(struct link *link)
 316 {
 317         if (link->qual.avg_rssi && link->qual.rx_success)
 318                 return link->qual.avg_rssi;
 319         return DEFAULT_RSSI;
 320 }
 321
 322 static inline int rt2x00_get_link_ant_rssi(struct link *link)
 323 {
 324         if (link->ant.rssi_ant && link->qual.rx_success)
 325                 return link->ant.rssi_ant;
 326         return DEFAULT_RSSI;
 327 }
 328
 329 static inline int rt2x00_get_link_ant_rssi_history(struct link *link,
 330                                                    enum antenna ant)
 331 {
 332         if (link->ant.rssi_history[ant - ANTENNA_A])
 333                 return link->ant.rssi_history[ant - ANTENNA_A];
 334         return DEFAULT_RSSI;
 335 }
 336
 337 static inline int rt2x00_update_ant_rssi(struct link *link, int rssi)
 338 {
 339         int old_rssi = link->ant.rssi_history[link->ant.active.rx - ANTENNA_A];
 340         link->ant.rssi_history[link->ant.active.rx - ANTENNA_A] = rssi;
 341         return old_rssi;
 342 }
 343
 344 /*
 345  * Interface structure
 346  * Configuration details about the current interface.
 347  */
 348 struct interface {
 349         /*
 350          * Interface identification. The value is assigned
 351          * to us by the 80211 stack, and is used to request
 352          * new beacons.
 353          */
 354         struct ieee80211_vif *id;
 355
 356         /*
 357          * Current working type (IEEE80211_IF_TYPE_*).
 358          */
 359         int type;
 360
 361         /*
 362          * MAC of the device.
 363          */
 364         u8 mac[ETH_ALEN];
 365
 366         /*
 367          * BBSID of the AP to associate with.
 368          */
 369         u8 bssid[ETH_ALEN];
 370 };
 371
 372 static inline int is_interface_present(struct interface *intf)
 373 {
 374         return !!intf->id;
 375 }
 376
 377 static inline int is_interface_type(struct interface *intf, int type)
 378 {
 379         return intf->type == type;
 380 }
 381
 382 /*
 383  * Details about the supported modes, rates and channels
 384  * of a particular chipset. This is used by rt2x00lib
 385  * to build the ieee80211_hw_mode array for mac80211.
 386  */
 387 struct hw_mode_spec {
 388         /*
 389          * Number of modes, rates and channels.
 390          */
 391         int num_modes;
 392         int num_rates;
 393         int num_channels;
 394
 395         /*
 396          * txpower values.
 397          */
 398         const u8 *tx_power_a;
 399         const u8 *tx_power_bg;
 400         u8 tx_power_default;
 401
 402         /*
 403          * Device/chipset specific value.
 404          */
 405         const struct rf_channel *channels;
 406 };
 407
 408 /*
 409  * Configuration structure wrapper around the
 410  * mac80211 configuration structure.
 411  * When mac80211 configures the driver, rt2x00lib
 412  * can precalculate values which are equal for all
 413  * rt2x00 drivers. Those values can be stored in here.
 414  */
 415 struct rt2x00lib_conf {
 416         struct ieee80211_conf *conf;
 417         struct rf_channel rf;
 418
 419         struct antenna_setup ant;
 420
 421         int phymode;
 422
 423         int basic_rates;
 424         int slot_time;
 425
 426         short sifs;
 427         short pifs;
 428         short difs;
 429         short eifs;
 430 };
 431
 432 /*
 433  * rt2x00lib callback functions.
 434  */
 435 struct rt2x00lib_ops {
 436         /*
 437          * Interrupt handlers.
 438          */
 439         irq_handler_t irq_handler;
 440
 441         /*
 442          * Device init handlers.
 443          */
 444         int (*probe_hw) (struct rt2x00_dev *rt2x00dev);
 445         char *(*get_firmware_name) (struct rt2x00_dev *rt2x00dev);
 446         int (*load_firmware) (struct rt2x00_dev *rt2x00dev, void *data,
 447                               const size_t len);
 448
 449         /*
 450          * Device initialization/deinitialization handlers.
 451          */
 452         int (*initialize) (struct rt2x00_dev *rt2x00dev);
 453         void (*uninitialize) (struct rt2x00_dev *rt2x00dev);
 454
 455         /*
 456          * queue initialization handlers
 457          */
 458         void (*init_rxentry) (struct rt2x00_dev *rt2x00dev,
 459                               struct queue_entry *entry);
 460         void (*init_txentry) (struct rt2x00_dev *rt2x00dev,
 461                               struct queue_entry *entry);
 462
 463         /*
 464          * Radio control handlers.
 465          */
 466         int (*set_device_state) (struct rt2x00_dev *rt2x00dev,
 467                                  enum dev_state state);
 468         int (*rfkill_poll) (struct rt2x00_dev *rt2x00dev);
 469         void (*link_stats) (struct rt2x00_dev *rt2x00dev,
 470                             struct link_qual *qual);
 471         void (*reset_tuner) (struct rt2x00_dev *rt2x00dev);
 472         void (*link_tuner) (struct rt2x00_dev *rt2x00dev);
 473
 474         /*
 475          * TX control handlers
 476          */
 477         void (*write_tx_desc) (struct rt2x00_dev *rt2x00dev,
 478                                struct sk_buff *skb,
 479                                struct txentry_desc *txdesc,
 480                                struct ieee80211_tx_control *control);
 481         int (*write_tx_data) (struct rt2x00_dev *rt2x00dev,
 482                               struct data_queue *queue, struct sk_buff *skb,
 483                               struct ieee80211_tx_control *control);
 484         int (*get_tx_data_len) (struct rt2x00_dev *rt2x00dev,
 485                                 struct sk_buff *skb);
 486         void (*kick_tx_queue) (struct rt2x00_dev *rt2x00dev,
 487                                unsigned int queue);
 488
 489         /*
 490          * RX control handlers
 491          */
 492         void (*fill_rxdone) (struct queue_entry *entry,
 493                              struct rxdone_entry_desc *rxdesc);
 494
 495         /*
 496          * Configuration handlers.
 497          */
 498         void (*config_mac_addr) (struct rt2x00_dev *rt2x00dev, __le32 *mac);
 499         void (*config_bssid) (struct rt2x00_dev *rt2x00dev, __le32 *bssid);
 500         void (*config_type) (struct rt2x00_dev *rt2x00dev, const int type,
 501                                                            const int tsf_sync);
 502         void (*config_preamble) (struct rt2x00_dev *rt2x00dev,
 503                                  const int short_preamble,
 504                                  const int ack_timeout,
 505                                  const int ack_consume_time);
 506         void (*config) (struct rt2x00_dev *rt2x00dev, const unsigned int flags,
 507                         struct rt2x00lib_conf *libconf);
 508 #define CONFIG_UPDATE_PHYMODE           ( 1 << 1 )
 509 #define CONFIG_UPDATE_CHANNEL           ( 1 << 2 )
 510 #define CONFIG_UPDATE_TXPOWER           ( 1 << 3 )
 511 #define CONFIG_UPDATE_ANTENNA           ( 1 << 4 )
 512 #define CONFIG_UPDATE_SLOT_TIME         ( 1 << 5 )
 513 #define CONFIG_UPDATE_BEACON_INT        ( 1 << 6 )
 514 #define CONFIG_UPDATE_ALL               0xffff
 515 };
 516
 517 /*
 518  * rt2x00 driver callback operation structure.
 519  */
 520 struct rt2x00_ops {
 521         const char *name;
 522         const unsigned int eeprom_size;
 523         const unsigned int rf_size;
 524         const struct data_queue_desc *rx;
 525         const struct data_queue_desc *tx;
 526         const struct data_queue_desc *bcn;
 527         const struct data_queue_desc *atim;
 528         const struct rt2x00lib_ops *lib;
 529         const struct ieee80211_ops *hw;
 530 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
 531         const struct rt2x00debug *debugfs;
 532 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
 533 };
 534
 535 /*
 536  * rt2x00 device flags
 537  */
 538 enum rt2x00_flags {
 539         /*
 540          * Device state flags
 541          */
 542         DEVICE_PRESENT,
 543         DEVICE_REGISTERED_HW,
 544         DEVICE_INITIALIZED,
 545         DEVICE_STARTED,
 546         DEVICE_STARTED_SUSPEND,
 547         DEVICE_ENABLED_RADIO,
 548         DEVICE_DISABLED_RADIO_HW,
 549
 550         /*
 551          * Driver features
 552          */
 553         DRIVER_REQUIRE_FIRMWARE,
 554         DRIVER_REQUIRE_FIRMWARE_CRC_ITU_T,
 555         DRIVER_REQUIRE_FIRMWARE_CCITT,
 556         DRIVER_REQUIRE_BEACON_GUARD,
 557         DRIVER_REQUIRE_ATIM_QUEUE,
 558
 559         /*
 560          * Driver configuration
 561          */
 562         CONFIG_SUPPORT_HW_BUTTON,
 563         CONFIG_FRAME_TYPE,
 564         CONFIG_RF_SEQUENCE,
 565         CONFIG_EXTERNAL_LNA_A,
 566         CONFIG_EXTERNAL_LNA_BG,
 567         CONFIG_DOUBLE_ANTENNA,
 568         CONFIG_DISABLE_LINK_TUNING,
 569         CONFIG_SHORT_PREAMBLE,
 570 };
 571
 572 /*
 573  * rt2x00 device structure.
 574  */
 575 struct rt2x00_dev {
 576         /*
 577          * Device structure.
 578          * The structure stored in here depends on the
 579          * system bus (PCI or USB).
 580          * When accessing this variable, the rt2x00dev_{pci,usb}
 581          * macro's should be used for correct typecasting.
 582          */
 583         void *dev;
 584 #define rt2x00dev_pci(__dev)    ( (struct pci_dev *)(__dev)->dev )
 585 #define rt2x00dev_usb(__dev)    ( (struct usb_interface *)(__dev)->dev )
 586 #define rt2x00dev_usb_dev(__dev)\
 587         ( (struct usb_device *)interface_to_usbdev(rt2x00dev_usb(__dev)) )
 588
 589         /*
 590          * Callback functions.
 591          */
 592         const struct rt2x00_ops *ops;
 593
 594         /*
 595          * IEEE80211 control structure.
 596          */
 597         struct ieee80211_hw *hw;
 598         struct ieee80211_hw_mode *hwmodes;
 599         unsigned int curr_hwmode;
 600 #define HWMODE_B        0
 601 #define HWMODE_G        1
 602 #define HWMODE_A        2
 603
 604         /*
 605          * rfkill structure for RF state switching support.
 606          * This will only be compiled in when required.
 607          */
 608 #ifdef CONFIG_RT2X00_LIB_RFKILL
 609         struct rfkill *rfkill;
 610         struct input_polled_dev *poll_dev;
 611 #endif /* CONFIG_RT2X00_LIB_RFKILL */
 612
 613         /*
 614          * If enabled, the debugfs interface structures
 615          * required for deregistration of debugfs.
 616          */
 617 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
 618         struct rt2x00debug_intf *debugfs_intf;
 619 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
 620
 621         /*
 622          * Device flags.
 623          * In these flags the current status and some
 624          * of the device capabilities are stored.
 625          */
 626         unsigned long flags;
 627
 628         /*
 629          * Chipset identification.
 630          */
 631         struct rt2x00_chip chip;
 632
 633         /*
 634          * hw capability specifications.
 635          */
 636         struct hw_mode_spec spec;
 637
 638         /*
 639          * This is the default TX/RX antenna setup as indicated
 640          * by the device's EEPROM. When mac80211 sets its
 641          * antenna value to 0 we should be using these values.
 642          */
 643         struct antenna_setup default_ant;
 644
 645         /*
 646          * Register pointers
 647          * csr_addr: Base register address. (PCI)
 648          * csr_cache: CSR cache for usb_control_msg. (USB)
 649          */
 650         void __iomem *csr_addr;
 651         void *csr_cache;
 652
 653         /*
 654          * Mutex to protect register accesses on USB devices.
 655          * There are 2 reasons this is needed, one is to ensure
 656          * use of the csr_cache (for USB devices) by one thread
 657          * isn't corrupted by another thread trying to access it.
 658          * The other is that access to BBP and RF registers
 659          * require multiple BUS transactions and if another thread
 660          * attempted to access one of those registers at the same
 661          * time one of the writes could silently fail.
 662          */
 663         struct mutex usb_cache_mutex;
 664
 665         /*
 666          * Current packet filter configuration for the device.
 667          * This contains all currently active FIF_* flags send
 668          * to us by mac80211 during configure_filter().
 669          */
 670         unsigned int packet_filter;
 671
 672         /*
 673          * Interface configuration.
 674          */
 675         struct interface interface;
 676
 677         /*
 678          * Link quality
 679          */
 680         struct link link;
 681
 682         /*
 683          * EEPROM data.
 684          */
 685         __le16 *eeprom;
 686
 687         /*
 688          * Active RF register values.
 689          * These are stored here so we don't need
 690          * to read the rf registers and can directly
 691          * use this value instead.
 692          * This field should be accessed by using
 693          * rt2x00_rf_read() and rt2x00_rf_write().
 694          */
 695         u32 *rf;
 696
 697         /*
 698          * USB Max frame size (for rt2500usb & rt73usb).
 699          */
 700         u16 usb_maxpacket;
 701
 702         /*
 703          * Current TX power value.
 704          */
 705         u16 tx_power;
 706
 707         /*
 708          * LED register (for rt61pci & rt73usb).
 709          */
 710         u16 led_reg;
 711
 712         /*
 713          * Led mode (LED_MODE_*)
 714          */
 715         u8 led_mode;
 716
 717         /*
 718          * Rssi <-> Dbm offset
 719          */
 720         u8 rssi_offset;
 721
 722         /*
 723          * Frequency offset (for rt61pci & rt73usb).
 724          */
 725         u8 freq_offset;
 726
 727         /*
 728          * Low level statistics which will have
 729          * to be kept up to date while device is running.
 730          */
 731         struct ieee80211_low_level_stats low_level_stats;
 732
 733         /*
 734          * RX configuration information.
 735          */
 736         struct ieee80211_rx_status rx_status;
 737
 738         /*
 739          * Scheduled work.
 740          */
 741         struct work_struct beacon_work;
 742         struct work_struct filter_work;
 743         struct work_struct config_work;
 744
 745         /*
 746          * Data queue arrays for RX, TX and Beacon.
 747          * The Beacon array also contains the Atim queue
 748          * if that is supported by the device.
 749          */
 750         int data_queues;
 751         struct data_queue *rx;
 752         struct data_queue *tx;
 753         struct data_queue *bcn;
 754
 755         /*
 756          * Firmware image.
 757          */
 758         const struct firmware *fw;
 759 };
 760
 761 /*
 762  * Generic RF access.
 763  * The RF is being accessed by word index.
 764  */
 765 static inline void rt2x00_rf_read(struct rt2x00_dev *rt2x00dev,
 766                                   const unsigned int word, u32 *data)
 767 {
 768         *data = rt2x00dev->rf[word];
 769 }
 770
 771 static inline void rt2x00_rf_write(struct rt2x00_dev *rt2x00dev,
 772                                    const unsigned int word, u32 data)
 773 {
 774         rt2x00dev->rf[word] = data;
 775 }
 776
 777 /*
 778  *  Generic EEPROM access.
 779  * The EEPROM is being accessed by word index.
 780  */
 781 static inline void *rt2x00_eeprom_addr(struct rt2x00_dev *rt2x00dev,
 782                                        const unsigned int word)
 783 {
 784         return (void *)&rt2x00dev->eeprom[word];
 785 }
 786
 787 static inline void rt2x00_eeprom_read(struct rt2x00_dev *rt2x00dev,
 788                                       const unsigned int word, u16 *data)
 789 {
 790         *data = le16_to_cpu(rt2x00dev->eeprom[word]);
 791 }
 792
 793 static inline void rt2x00_eeprom_write(struct rt2x00_dev *rt2x00dev,
 794                                        const unsigned int word, u16 data)
 795 {
 796         rt2x00dev->eeprom[word] = cpu_to_le16(data);
 797 }
 798
 799 /*
 800  * Chipset handlers
 801  */
 802 static inline void rt2x00_set_chip(struct rt2x00_dev *rt2x00dev,
 803                                    const u16 rt, const u16 rf, const u32 rev)
 804 {
 805         INFO(rt2x00dev,
 806              "Chipset detected - rt: %04x, rf: %04x, rev: %08x.\n",
 807              rt, rf, rev);
 808
 809         rt2x00dev->chip.rt = rt;
 810         rt2x00dev->chip.rf = rf;
 811         rt2x00dev->chip.rev = rev;
 812 }
 813
 814 static inline char rt2x00_rt(const struct rt2x00_chip *chipset, const u16 chip)
 815 {
 816         return (chipset->rt == chip);
 817 }
 818
 819 static inline char rt2x00_rf(const struct rt2x00_chip *chipset, const u16 chip)
 820 {
 821         return (chipset->rf == chip);
 822 }
 823
 824 static inline u16 rt2x00_rev(const struct rt2x00_chip *chipset)
 825 {
 826         return chipset->rev;
 827 }
 828
 829 static inline u16 rt2x00_check_rev(const struct rt2x00_chip *chipset,
 830                                    const u32 rev)
 831 {
 832         return (((chipset->rev & 0xffff0) == rev) &&
 833                 !!(chipset->rev & 0x0000f));
 834 }
 835
 836 /*
 837  * Duration calculations
 838  * The rate variable passed is: 100kbs.
 839  * To convert from bytes to bits we multiply size with 8,
 840  * then the size is multiplied with 10 to make the
 841  * real rate -> rate argument correction.
 842  */
 843 static inline u16 get_duration(const unsigned int size, const u8 rate)
 844 {
 845         return ((size * 8 * 10) / rate);
 846 }
 847
 848 static inline u16 get_duration_res(const unsigned int size, const u8 rate)
 849 {
 850         return ((size * 8 * 10) % rate);
 851 }
 852
 853 /**
 854  * rt2x00queue_get_queue - Convert mac80211 queue index to rt2x00 queue
 855  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 856  * @queue: mac80211 queue index (see &enum ieee80211_tx_queue).
 857  */
 858 struct data_queue *rt2x00queue_get_queue(struct rt2x00_dev *rt2x00dev,
 859                                          const enum ieee80211_tx_queue queue);
 860
 861 /**
 862  * rt2x00queue_get_entry - Get queue entry where the given index points to.
 863  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 864  * @index: Index identifier for obtaining the correct index.
 865  */
 866 struct queue_entry *rt2x00queue_get_entry(struct data_queue *queue,
 867                                           enum queue_index index);
 868
 869 /**
 870  * rt2x00queue_index_inc - Index incrementation function
 871  * @queue: Queue (&struct data_queue) to perform the action on.
 872  * @action: Index type (&enum queue_index) to perform the action on.
 873  *
 874  * This function will increase the requested index on the queue,
 875  * it will grab the appropriate locks and handle queue overflow events by
 876  * resetting the index to the start of the queue.
 877  */
 878 void rt2x00queue_index_inc(struct data_queue *queue, enum queue_index index);
 879
 880
 881 /*
 882  * Interrupt context handlers.
 883  */
 884 void rt2x00lib_beacondone(struct rt2x00_dev *rt2x00dev);
 885 void rt2x00lib_txdone(struct queue_entry *entry,
 886                       struct txdone_entry_desc *txdesc);
 887 void rt2x00lib_rxdone(struct queue_entry *entry,
 888                       struct rxdone_entry_desc *rxdesc);
 889
 890 /*
 891  * TX descriptor initializer
 892  */
 893 void rt2x00lib_write_tx_desc(struct rt2x00_dev *rt2x00dev,
 894                              struct sk_buff *skb,
 895                              struct ieee80211_tx_control *control);
 896
 897 /*
 898  * mac80211 handlers.
 899  */
 900 int rt2x00mac_tx(struct ieee80211_hw *hw, struct sk_buff *skb,
 901                  struct ieee80211_tx_control *control);
 902 int rt2x00mac_start(struct ieee80211_hw *hw);
 903 void rt2x00mac_stop(struct ieee80211_hw *hw);
 904 int rt2x00mac_add_interface(struct ieee80211_hw *hw,
 905                             struct ieee80211_if_init_conf *conf);
 906 void rt2x00mac_remove_interface(struct ieee80211_hw *hw,
 907                                 struct ieee80211_if_init_conf *conf);
 908 int rt2x00mac_config(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
 909 int rt2x00mac_config_interface(struct ieee80211_hw *hw,
 910                                struct ieee80211_vif *vif,
 911                                struct ieee80211_if_conf *conf);
 912 int rt2x00mac_get_stats(struct ieee80211_hw *hw,
 913                         struct ieee80211_low_level_stats *stats);
 914 int rt2x00mac_get_tx_stats(struct ieee80211_hw *hw,
 915                            struct ieee80211_tx_queue_stats *stats);
 916 void rt2x00mac_bss_info_changed(struct ieee80211_hw *hw,
 917                                 struct ieee80211_vif *vif,
 918                                 struct ieee80211_bss_conf *bss_conf,
 919                                 u32 changes);
 920 int rt2x00mac_conf_tx(struct ieee80211_hw *hw, int queue,
 921                       const struct ieee80211_tx_queue_params *params);
 922
 923 /*
 924  * Driver allocation handlers.
 925  */
 926 int rt2x00lib_probe_dev(struct rt2x00_dev *rt2x00dev);
 927 void rt2x00lib_remove_dev(struct rt2x00_dev *rt2x00dev);
 928 #ifdef CONFIG_PM
 929 int rt2x00lib_suspend(struct rt2x00_dev *rt2x00dev, pm_message_t state);
 930 int rt2x00lib_resume(struct rt2x00_dev *rt2x00dev);
 931 #endif /* CONFIG_PM */
 932
 933 #endif /* RT2X00_H */