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