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