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