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 void rt2x00_reset_link_ant_rssi(struct link *link)
 332 {
 333         link->ant.rssi_ant = 0;
 334 }
 335
 336 static inline int rt2x00_get_link_ant_rssi_history(struct link *link,
 337                                                    enum antenna ant)
 338 {
 339         if (link->ant.rssi_history[ant - ANTENNA_A])
 340                 return link->ant.rssi_history[ant - ANTENNA_A];
 341         return DEFAULT_RSSI;
 342 }
 343
 344 static inline int rt2x00_update_ant_rssi(struct link *link, int rssi)
 345 {
 346         int old_rssi = link->ant.rssi_history[link->ant.active.rx - ANTENNA_A];
 347         link->ant.rssi_history[link->ant.active.rx - ANTENNA_A] = rssi;
 348         return old_rssi;
 349 }
 350
 351 /*
 352  * Interface structure
 353  * Per interface configuration details, this structure
 354  * is allocated as the private data for ieee80211_vif.
 355  */
 356 struct rt2x00_intf {
 357         /*
 358          * All fields within the rt2x00_intf structure
 359          * must be protected with a spinlock.
 360          */
 361         spinlock_t lock;
 362
 363         /*
 364          * BSS configuration. Copied from the structure
 365          * passed to us through the bss_info_changed()
 366          * callback funtion.
 367          */
 368         struct ieee80211_bss_conf conf;
 369
 370         /*
 371          * MAC of the device.
 372          */
 373         u8 mac[ETH_ALEN];
 374
 375         /*
 376          * BBSID of the AP to associate with.
 377          */
 378         u8 bssid[ETH_ALEN];
 379
 380         /*
 381          * Entry in the beacon queue which belongs to
 382          * this interface. Each interface has its own
 383          * dedicated beacon entry.
 384          */
 385         struct queue_entry *beacon;
 386
 387         /*
 388          * Actions that needed rescheduling.
 389          */
 390         unsigned int delayed_flags;
 391 #define DELAYED_UPDATE_BEACON           0x00000001
 392 #define DELAYED_CONFIG_ERP              0x00000002
 393 #define DELAYED_LED_ASSOC               0x00000004
 394 };
 395
 396 static inline struct rt2x00_intf* vif_to_intf(struct ieee80211_vif *vif)
 397 {
 398         return (struct rt2x00_intf *)vif->drv_priv;
 399 }
 400
 401 /**
 402  * struct hw_mode_spec: Hardware specifications structure
 403  *
 404  * Details about the supported modes, rates and channels
 405  * of a particular chipset. This is used by rt2x00lib
 406  * to build the ieee80211_hw_mode array for mac80211.
 407  *
 408  * @supported_bands: Bitmask contained the supported bands (2.4GHz, 5.2GHz).
 409  * @supported_rates: Rate types which are supported (CCK, OFDM).
 410  * @num_channels: Number of supported channels. This is used as array size
 411  *      for @tx_power_a, @tx_power_bg and @channels.
 412  * channels: Device/chipset specific channel values (See &struct rf_channel).
 413  * @tx_power_a: TX power values for all 5.2GHz channels (may be NULL).
 414  * @tx_power_bg: TX power values for all 2.4GHz channels (may be NULL).
 415  * @tx_power_default: Default TX power value to use when either
 416  *      @tx_power_a or @tx_power_bg is missing.
 417  */
 418 struct hw_mode_spec {
 419         unsigned int supported_bands;
 420 #define SUPPORT_BAND_2GHZ       0x00000001
 421 #define SUPPORT_BAND_5GHZ       0x00000002
 422
 423         unsigned int supported_rates;
 424 #define SUPPORT_RATE_CCK        0x00000001
 425 #define SUPPORT_RATE_OFDM       0x00000002
 426
 427         unsigned int num_channels;
 428         const struct rf_channel *channels;
 429
 430         const u8 *tx_power_a;
 431         const u8 *tx_power_bg;
 432         u8 tx_power_default;
 433 };
 434
 435 /*
 436  * Configuration structure wrapper around the
 437  * mac80211 configuration structure.
 438  * When mac80211 configures the driver, rt2x00lib
 439  * can precalculate values which are equal for all
 440  * rt2x00 drivers. Those values can be stored in here.
 441  */
 442 struct rt2x00lib_conf {
 443         struct ieee80211_conf *conf;
 444         struct rf_channel rf;
 445
 446         struct antenna_setup ant;
 447
 448         enum ieee80211_band band;
 449
 450         u32 basic_rates;
 451         u32 slot_time;
 452
 453         short sifs;
 454         short pifs;
 455         short difs;
 456         short eifs;
 457 };
 458
 459 /*
 460  * Configuration structure for erp settings.
 461  */
 462 struct rt2x00lib_erp {
 463         int short_preamble;
 464
 465         int ack_timeout;
 466         int ack_consume_time;
 467 };
 468
 469 /*
 470  * Configuration structure wrapper around the
 471  * rt2x00 interface configuration handler.
 472  */
 473 struct rt2x00intf_conf {
 474         /*
 475          * Interface type
 476          */
 477         enum ieee80211_if_types type;
 478
 479         /*
 480          * TSF sync value, this is dependant on the operation type.
 481          */
 482         enum tsf_sync sync;
 483
 484         /*
 485          * The MAC and BSSID addressess are simple array of bytes,
 486          * these arrays are little endian, so when sending the addressess
 487          * to the drivers, copy the it into a endian-signed variable.
 488          *
 489          * Note that all devices (except rt2500usb) have 32 bits
 490          * register word sizes. This means that whatever variable we
 491          * pass _must_ be a multiple of 32 bits. Otherwise the device
 492          * might not accept what we are sending to it.
 493          * This will also make it easier for the driver to write
 494          * the data to the device.
 495          */
 496         __le32 mac[2];
 497         __le32 bssid[2];
 498 };
 499
 500 /*
 501  * rt2x00lib callback functions.
 502  */
 503 struct rt2x00lib_ops {
 504         /*
 505          * Interrupt handlers.
 506          */
 507         irq_handler_t irq_handler;
 508
 509         /*
 510          * Device init handlers.
 511          */
 512         int (*probe_hw) (struct rt2x00_dev *rt2x00dev);
 513         char *(*get_firmware_name) (struct rt2x00_dev *rt2x00dev);
 514         u16 (*get_firmware_crc) (const void *data, const size_t len);
 515         int (*load_firmware) (struct rt2x00_dev *rt2x00dev, const void *data,
 516                               const size_t len);
 517
 518         /*
 519          * Device initialization/deinitialization handlers.
 520          */
 521         int (*initialize) (struct rt2x00_dev *rt2x00dev);
 522         void (*uninitialize) (struct rt2x00_dev *rt2x00dev);
 523
 524         /*
 525          * queue initialization handlers
 526          */
 527         void (*init_rxentry) (struct rt2x00_dev *rt2x00dev,
 528                               struct queue_entry *entry);
 529         void (*init_txentry) (struct rt2x00_dev *rt2x00dev,
 530                               struct queue_entry *entry);
 531
 532         /*
 533          * Radio control handlers.
 534          */
 535         int (*set_device_state) (struct rt2x00_dev *rt2x00dev,
 536                                  enum dev_state state);
 537         int (*rfkill_poll) (struct rt2x00_dev *rt2x00dev);
 538         void (*link_stats) (struct rt2x00_dev *rt2x00dev,
 539                             struct link_qual *qual);
 540         void (*reset_tuner) (struct rt2x00_dev *rt2x00dev);
 541         void (*link_tuner) (struct rt2x00_dev *rt2x00dev);
 542
 543         /*
 544          * TX control handlers
 545          */
 546         void (*write_tx_desc) (struct rt2x00_dev *rt2x00dev,
 547                                struct sk_buff *skb,
 548                                struct txentry_desc *txdesc,
 549                                struct ieee80211_tx_control *control);
 550         int (*write_tx_data) (struct rt2x00_dev *rt2x00dev,
 551                               struct data_queue *queue, struct sk_buff *skb,
 552                               struct ieee80211_tx_control *control);
 553         int (*get_tx_data_len) (struct rt2x00_dev *rt2x00dev,
 554                                 struct sk_buff *skb);
 555         void (*kick_tx_queue) (struct rt2x00_dev *rt2x00dev,
 556                                const unsigned int queue);
 557
 558         /*
 559          * RX control handlers
 560          */
 561         void (*fill_rxdone) (struct queue_entry *entry,
 562                              struct rxdone_entry_desc *rxdesc);
 563
 564         /*
 565          * Configuration handlers.
 566          */
 567         void (*config_filter) (struct rt2x00_dev *rt2x00dev,
 568                                const unsigned int filter_flags);
 569         void (*config_intf) (struct rt2x00_dev *rt2x00dev,
 570                              struct rt2x00_intf *intf,
 571                              struct rt2x00intf_conf *conf,
 572                              const unsigned int flags);
 573 #define CONFIG_UPDATE_TYPE              ( 1 << 1 )
 574 #define CONFIG_UPDATE_MAC               ( 1 << 2 )
 575 #define CONFIG_UPDATE_BSSID             ( 1 << 3 )
 576
 577         void (*config_erp) (struct rt2x00_dev *rt2x00dev,
 578                             struct rt2x00lib_erp *erp);
 579         void (*config) (struct rt2x00_dev *rt2x00dev,
 580                         struct rt2x00lib_conf *libconf,
 581                         const unsigned int flags);
 582 #define CONFIG_UPDATE_PHYMODE           ( 1 << 1 )
 583 #define CONFIG_UPDATE_CHANNEL           ( 1 << 2 )
 584 #define CONFIG_UPDATE_TXPOWER           ( 1 << 3 )
 585 #define CONFIG_UPDATE_ANTENNA           ( 1 << 4 )
 586 #define CONFIG_UPDATE_SLOT_TIME         ( 1 << 5 )
 587 #define CONFIG_UPDATE_BEACON_INT        ( 1 << 6 )
 588 #define CONFIG_UPDATE_ALL               0xffff
 589 };
 590
 591 /*
 592  * rt2x00 driver callback operation structure.
 593  */
 594 struct rt2x00_ops {
 595         const char *name;
 596         const unsigned int max_sta_intf;
 597         const unsigned int max_ap_intf;
 598         const unsigned int eeprom_size;
 599         const unsigned int rf_size;
 600         const struct data_queue_desc *rx;
 601         const struct data_queue_desc *tx;
 602         const struct data_queue_desc *bcn;
 603         const struct data_queue_desc *atim;
 604         const struct rt2x00lib_ops *lib;
 605         const struct ieee80211_ops *hw;
 606 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
 607         const struct rt2x00debug *debugfs;
 608 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
 609 };
 610
 611 /*
 612  * rt2x00 device flags
 613  */
 614 enum rt2x00_flags {
 615         /*
 616          * Device state flags
 617          */
 618         DEVICE_PRESENT,
 619         DEVICE_REGISTERED_HW,
 620         DEVICE_INITIALIZED,
 621         DEVICE_STARTED,
 622         DEVICE_STARTED_SUSPEND,
 623         DEVICE_ENABLED_RADIO,
 624         DEVICE_DISABLED_RADIO_HW,
 625
 626         /*
 627          * Driver features
 628          */
 629         DRIVER_SUPPORT_MIXED_INTERFACES,
 630         DRIVER_REQUIRE_FIRMWARE,
 631         DRIVER_REQUIRE_BEACON_GUARD,
 632         DRIVER_REQUIRE_ATIM_QUEUE,
 633         DRIVER_REQUIRE_SCHEDULED,
 634
 635         /*
 636          * Driver configuration
 637          */
 638         CONFIG_SUPPORT_HW_BUTTON,
 639         CONFIG_FRAME_TYPE,
 640         CONFIG_RF_SEQUENCE,
 641         CONFIG_EXTERNAL_LNA_A,
 642         CONFIG_EXTERNAL_LNA_BG,
 643         CONFIG_DOUBLE_ANTENNA,
 644         CONFIG_DISABLE_LINK_TUNING,
 645 };
 646
 647 /*
 648  * rt2x00 device structure.
 649  */
 650 struct rt2x00_dev {
 651         /*
 652          * Device structure.
 653          * The structure stored in here depends on the
 654          * system bus (PCI or USB).
 655          * When accessing this variable, the rt2x00dev_{pci,usb}
 656          * macro's should be used for correct typecasting.
 657          */
 658         void *dev;
 659 #define rt2x00dev_pci(__dev)    ( (struct pci_dev *)(__dev)->dev )
 660 #define rt2x00dev_usb(__dev)    ( (struct usb_interface *)(__dev)->dev )
 661 #define rt2x00dev_usb_dev(__dev)\
 662         ( (struct usb_device *)interface_to_usbdev(rt2x00dev_usb(__dev)) )
 663
 664         /*
 665          * Callback functions.
 666          */
 667         const struct rt2x00_ops *ops;
 668
 669         /*
 670          * IEEE80211 control structure.
 671          */
 672         struct ieee80211_hw *hw;
 673         struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
 674         enum ieee80211_band curr_band;
 675
 676         /*
 677          * rfkill structure for RF state switching support.
 678          * This will only be compiled in when required.
 679          */
 680 #ifdef CONFIG_RT2X00_LIB_RFKILL
 681         unsigned long rfkill_state;
 682 #define RFKILL_STATE_ALLOCATED          1
 683 #define RFKILL_STATE_REGISTERED         2
 684         struct rfkill *rfkill;
 685         struct input_polled_dev *poll_dev;
 686 #endif /* CONFIG_RT2X00_LIB_RFKILL */
 687
 688         /*
 689          * If enabled, the debugfs interface structures
 690          * required for deregistration of debugfs.
 691          */
 692 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
 693         struct rt2x00debug_intf *debugfs_intf;
 694 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
 695
 696         /*
 697          * LED structure for changing the LED status
 698          * by mac8011 or the kernel.
 699          */
 700 #ifdef CONFIG_RT2X00_LIB_LEDS
 701         struct rt2x00_led led_radio;
 702         struct rt2x00_led led_assoc;
 703         struct rt2x00_led led_qual;
 704         u16 led_mcu_reg;
 705 #endif /* CONFIG_RT2X00_LIB_LEDS */
 706
 707         /*
 708          * Device flags.
 709          * In these flags the current status and some
 710          * of the device capabilities are stored.
 711          */
 712         unsigned long flags;
 713
 714         /*
 715          * Chipset identification.
 716          */
 717         struct rt2x00_chip chip;
 718
 719         /*
 720          * hw capability specifications.
 721          */
 722         struct hw_mode_spec spec;
 723
 724         /*
 725          * This is the default TX/RX antenna setup as indicated
 726          * by the device's EEPROM. When mac80211 sets its
 727          * antenna value to 0 we should be using these values.
 728          */
 729         struct antenna_setup default_ant;
 730
 731         /*
 732          * Register pointers
 733          * csr.base: CSR base register address. (PCI)
 734          * csr.cache: CSR cache for usb_control_msg. (USB)
 735          */
 736         union csr {
 737                 void __iomem *base;
 738                 void *cache;
 739         } csr;
 740
 741         /*
 742          * Mutex to protect register accesses on USB devices.
 743          * There are 2 reasons this is needed, one is to ensure
 744          * use of the csr_cache (for USB devices) by one thread
 745          * isn't corrupted by another thread trying to access it.
 746          * The other is that access to BBP and RF registers
 747          * require multiple BUS transactions and if another thread
 748          * attempted to access one of those registers at the same
 749          * time one of the writes could silently fail.
 750          */
 751         struct mutex usb_cache_mutex;
 752
 753         /*
 754          * Current packet filter configuration for the device.
 755          * This contains all currently active FIF_* flags send
 756          * to us by mac80211 during configure_filter().
 757          */
 758         unsigned int packet_filter;
 759
 760         /*
 761          * Interface details:
 762          *  - Open ap interface count.
 763          *  - Open sta interface count.
 764          *  - Association count.
 765          */
 766         unsigned int intf_ap_count;
 767         unsigned int intf_sta_count;
 768         unsigned int intf_associated;
 769
 770         /*
 771          * Link quality
 772          */
 773         struct link link;
 774
 775         /*
 776          * EEPROM data.
 777          */
 778         __le16 *eeprom;
 779
 780         /*
 781          * Active RF register values.
 782          * These are stored here so we don't need
 783          * to read the rf registers and can directly
 784          * use this value instead.
 785          * This field should be accessed by using
 786          * rt2x00_rf_read() and rt2x00_rf_write().
 787          */
 788         u32 *rf;
 789
 790         /*
 791          * USB Max frame size (for rt2500usb & rt73usb).
 792          */
 793         u16 usb_maxpacket;
 794
 795         /*
 796          * Current TX power value.
 797          */
 798         u16 tx_power;
 799
 800         /*
 801          * Rssi <-> Dbm offset
 802          */
 803         u8 rssi_offset;
 804
 805         /*
 806          * Frequency offset (for rt61pci & rt73usb).
 807          */
 808         u8 freq_offset;
 809
 810         /*
 811          * Low level statistics which will have
 812          * to be kept up to date while device is running.
 813          */
 814         struct ieee80211_low_level_stats low_level_stats;
 815
 816         /*
 817          * RX configuration information.
 818          */
 819         struct ieee80211_rx_status rx_status;
 820
 821         /*
 822          * Scheduled work.
 823          */
 824         struct workqueue_struct *workqueue;
 825         struct work_struct intf_work;
 826         struct work_struct filter_work;
 827
 828         /*
 829          * Data queue arrays for RX, TX and Beacon.
 830          * The Beacon array also contains the Atim queue
 831          * if that is supported by the device.
 832          */
 833         int data_queues;
 834         struct data_queue *rx;
 835         struct data_queue *tx;
 836         struct data_queue *bcn;
 837
 838         /*
 839          * Firmware image.
 840          */
 841         const struct firmware *fw;
 842 };
 843
 844 /*
 845  * Generic RF access.
 846  * The RF is being accessed by word index.
 847  */
 848 static inline void rt2x00_rf_read(struct rt2x00_dev *rt2x00dev,
 849                                   const unsigned int word, u32 *data)
 850 {
 851         *data = rt2x00dev->rf[word];
 852 }
 853
 854 static inline void rt2x00_rf_write(struct rt2x00_dev *rt2x00dev,
 855                                    const unsigned int word, u32 data)
 856 {
 857         rt2x00dev->rf[word] = data;
 858 }
 859
 860 /*
 861  *  Generic EEPROM access.
 862  * The EEPROM is being accessed by word index.
 863  */
 864 static inline void *rt2x00_eeprom_addr(struct rt2x00_dev *rt2x00dev,
 865                                        const unsigned int word)
 866 {
 867         return (void *)&rt2x00dev->eeprom[word];
 868 }
 869
 870 static inline void rt2x00_eeprom_read(struct rt2x00_dev *rt2x00dev,
 871                                       const unsigned int word, u16 *data)
 872 {
 873         *data = le16_to_cpu(rt2x00dev->eeprom[word]);
 874 }
 875
 876 static inline void rt2x00_eeprom_write(struct rt2x00_dev *rt2x00dev,
 877                                        const unsigned int word, u16 data)
 878 {
 879         rt2x00dev->eeprom[word] = cpu_to_le16(data);
 880 }
 881
 882 /*
 883  * Chipset handlers
 884  */
 885 static inline void rt2x00_set_chip(struct rt2x00_dev *rt2x00dev,
 886                                    const u16 rt, const u16 rf, const u32 rev)
 887 {
 888         INFO(rt2x00dev,
 889              "Chipset detected - rt: %04x, rf: %04x, rev: %08x.\n",
 890              rt, rf, rev);
 891
 892         rt2x00dev->chip.rt = rt;
 893         rt2x00dev->chip.rf = rf;
 894         rt2x00dev->chip.rev = rev;
 895 }
 896
 897 static inline char rt2x00_rt(const struct rt2x00_chip *chipset, const u16 chip)
 898 {
 899         return (chipset->rt == chip);
 900 }
 901
 902 static inline char rt2x00_rf(const struct rt2x00_chip *chipset, const u16 chip)
 903 {
 904         return (chipset->rf == chip);
 905 }
 906
 907 static inline u16 rt2x00_rev(const struct rt2x00_chip *chipset)
 908 {
 909         return chipset->rev;
 910 }
 911
 912 static inline u16 rt2x00_check_rev(const struct rt2x00_chip *chipset,
 913                                    const u32 rev)
 914 {
 915         return (((chipset->rev & 0xffff0) == rev) &&
 916                 !!(chipset->rev & 0x0000f));
 917 }
 918
 919 /*
 920  * Duration calculations
 921  * The rate variable passed is: 100kbs.
 922  * To convert from bytes to bits we multiply size with 8,
 923  * then the size is multiplied with 10 to make the
 924  * real rate -> rate argument correction.
 925  */
 926 static inline u16 get_duration(const unsigned int size, const u8 rate)
 927 {
 928         return ((size * 8 * 10) / rate);
 929 }
 930
 931 static inline u16 get_duration_res(const unsigned int size, const u8 rate)
 932 {
 933         return ((size * 8 * 10) % rate);
 934 }
 935
 936 /**
 937  * rt2x00queue_get_queue - Convert mac80211 queue index to rt2x00 queue
 938  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 939  * @queue: mac80211/rt2x00 queue index
 940  *      (see &enum ieee80211_tx_queue and &enum rt2x00_bcn_queue).
 941  */
 942 struct data_queue *rt2x00queue_get_queue(struct rt2x00_dev *rt2x00dev,
 943                                          const unsigned int queue);
 944
 945 /**
 946  * rt2x00queue_get_entry - Get queue entry where the given index points to.
 947  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 948  * @index: Index identifier for obtaining the correct index.
 949  */
 950 struct queue_entry *rt2x00queue_get_entry(struct data_queue *queue,
 951                                           enum queue_index index);
 952
 953 /**
 954  * rt2x00queue_index_inc - Index incrementation function
 955  * @queue: Queue (&struct data_queue) to perform the action on.
 956  * @action: Index type (&enum queue_index) to perform the action on.
 957  *
 958  * This function will increase the requested index on the queue,
 959  * it will grab the appropriate locks and handle queue overflow events by
 960  * resetting the index to the start of the queue.
 961  */
 962 void rt2x00queue_index_inc(struct data_queue *queue, enum queue_index index);
 963
 964
 965 /*
 966  * Interrupt context handlers.
 967  */
 968 void rt2x00lib_beacondone(struct rt2x00_dev *rt2x00dev);
 969 void rt2x00lib_txdone(struct queue_entry *entry,
 970                       struct txdone_entry_desc *txdesc);
 971 void rt2x00lib_rxdone(struct queue_entry *entry,
 972                       struct rxdone_entry_desc *rxdesc);
 973
 974 /*
 975  * TX descriptor initializer
 976  */
 977 void rt2x00lib_write_tx_desc(struct rt2x00_dev *rt2x00dev,
 978                              struct sk_buff *skb,
 979                              struct ieee80211_tx_control *control);
 980
 981 /*
 982  * mac80211 handlers.
 983  */
 984 int rt2x00mac_tx(struct ieee80211_hw *hw, struct sk_buff *skb,
 985                  struct ieee80211_tx_control *control);
 986 int rt2x00mac_start(struct ieee80211_hw *hw);
 987 void rt2x00mac_stop(struct ieee80211_hw *hw);
 988 int rt2x00mac_add_interface(struct ieee80211_hw *hw,
 989                             struct ieee80211_if_init_conf *conf);
 990 void rt2x00mac_remove_interface(struct ieee80211_hw *hw,
 991                                 struct ieee80211_if_init_conf *conf);
 992 int rt2x00mac_config(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
 993 int rt2x00mac_config_interface(struct ieee80211_hw *hw,
 994                                struct ieee80211_vif *vif,
 995                                struct ieee80211_if_conf *conf);
 996 void rt2x00mac_configure_filter(struct ieee80211_hw *hw,
 997                                 unsigned int changed_flags,
 998                                 unsigned int *total_flags,
 999                                 int mc_count, struct dev_addr_list *mc_list);
1000 int rt2x00mac_get_stats(struct ieee80211_hw *hw,
1001                         struct ieee80211_low_level_stats *stats);
1002 int rt2x00mac_get_tx_stats(struct ieee80211_hw *hw,
1003                            struct ieee80211_tx_queue_stats *stats);
1004 void rt2x00mac_bss_info_changed(struct ieee80211_hw *hw,
1005                                 struct ieee80211_vif *vif,
1006                                 struct ieee80211_bss_conf *bss_conf,
1007                                 u32 changes);
1008 int rt2x00mac_conf_tx(struct ieee80211_hw *hw, int queue,
1009                       const struct ieee80211_tx_queue_params *params);
1010
1011 /*
1012  * Driver allocation handlers.
1013  */
1014 int rt2x00lib_probe_dev(struct rt2x00_dev *rt2x00dev);
1015 void rt2x00lib_remove_dev(struct rt2x00_dev *rt2x00dev);
1016 #ifdef CONFIG_PM
1017 int rt2x00lib_suspend(struct rt2x00_dev *rt2x00dev, pm_message_t state);
1018 int rt2x00lib_resume(struct rt2x00_dev *rt2x00dev);
1019 #endif /* CONFIG_PM */
1020
1021 #endif /* RT2X00_H */