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