SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/net/wireless/rt2x00/rt2x00.h

   1 /*
   2         Copyright (C) 2004 - 2009 Ivo van Doorn <IvDoorn@gmail.com>
   3         Copyright (C) 2004 - 2009 Gertjan van Wingerde <gwingerde@gmail.com>
   4         <http://rt2x00.serialmonkey.com>
   5
   6         This program is free software; you can redistribute it and/or modify
   7         it under the terms of the GNU General Public License as published by
   8         the Free Software Foundation; either version 2 of the License, or
   9         (at your option) any later version.
  10
  11         This program is distributed in the hope that it will be useful,
  12         but WITHOUT ANY WARRANTY; without even the implied warranty of
  13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14         GNU General Public License for more details.
  15
  16         You should have received a copy of the GNU General Public License
  17         along with this program; if not, write to the
  18         Free Software Foundation, Inc.,
  19         59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  20  */
  21
  22 /*
  23         Module: rt2x00
  24         Abstract: rt2x00 global information.
  25  */
  26
  27 #ifndef RT2X00_H
  28 #define RT2X00_H
  29
  30 #include <linux/bitops.h>
  31 #include <linux/skbuff.h>
  32 #include <linux/workqueue.h>
  33 #include <linux/firmware.h>
  34 #include <linux/leds.h>
  35 #include <linux/mutex.h>
  36 #include <linux/etherdevice.h>
  37 #include <linux/input-polldev.h>
  38
  39 #include <net/mac80211.h>
  40
  41 #include "rt2x00debug.h"
  42 #include "rt2x00leds.h"
  43 #include "rt2x00reg.h"
  44 #include "rt2x00queue.h"
  45
  46 /*
  47  * Module information.
  48  */
  49 #define DRV_VERSION     "2.3.0"
  50 #define DRV_PROJECT     "http://rt2x00.serialmonkey.com"
  51
  52 /*
  53  * Debug definitions.
  54  * Debug output has to be enabled during compile time.
  55  */
  56 #define DEBUG_PRINTK_MSG(__dev, __kernlvl, __lvl, __msg, __args...)     \
  57         printk(__kernlvl "%s -> %s: %s - " __msg,                       \
  58                wiphy_name((__dev)->hw->wiphy), __func__, __lvl, ##__args)
  59
  60 #define DEBUG_PRINTK_PROBE(__kernlvl, __lvl, __msg, __args...)  \
  61         printk(__kernlvl "%s -> %s: %s - " __msg,               \
  62                KBUILD_MODNAME, __func__, __lvl, ##__args)
  63
  64 #ifdef CONFIG_RT2X00_DEBUG
  65 #define DEBUG_PRINTK(__dev, __kernlvl, __lvl, __msg, __args...) \
  66         DEBUG_PRINTK_MSG(__dev, __kernlvl, __lvl, __msg, ##__args);
  67 #else
  68 #define DEBUG_PRINTK(__dev, __kernlvl, __lvl, __msg, __args...) \
  69         do { } while (0)
  70 #endif /* CONFIG_RT2X00_DEBUG */
  71
  72 /*
  73  * Various debug levels.
  74  * The debug levels PANIC and ERROR both indicate serious problems,
  75  * for this reason they should never be ignored.
  76  * The special ERROR_PROBE message is for messages that are generated
  77  * when the rt2x00_dev is not yet initialized.
  78  */
  79 #define PANIC(__dev, __msg, __args...) \
  80         DEBUG_PRINTK_MSG(__dev, KERN_CRIT, "Panic", __msg, ##__args)
  81 #define ERROR(__dev, __msg, __args...)  \
  82         DEBUG_PRINTK_MSG(__dev, KERN_ERR, "Error", __msg, ##__args)
  83 #define ERROR_PROBE(__msg, __args...) \
  84         DEBUG_PRINTK_PROBE(KERN_ERR, "Error", __msg, ##__args)
  85 #define WARNING(__dev, __msg, __args...) \
  86         DEBUG_PRINTK(__dev, KERN_WARNING, "Warning", __msg, ##__args)
  87 #define NOTICE(__dev, __msg, __args...) \
  88         DEBUG_PRINTK(__dev, KERN_NOTICE, "Notice", __msg, ##__args)
  89 #define INFO(__dev, __msg, __args...) \
  90         DEBUG_PRINTK(__dev, KERN_INFO, "Info", __msg, ##__args)
  91 #define DEBUG(__dev, __msg, __args...) \
  92         DEBUG_PRINTK(__dev, KERN_DEBUG, "Debug", __msg, ##__args)
  93 #define EEPROM(__dev, __msg, __args...) \
  94         DEBUG_PRINTK(__dev, KERN_DEBUG, "EEPROM recovery", __msg, ##__args)
  95
  96 /*
  97  * Duration calculations
  98  * The rate variable passed is: 100kbs.
  99  * To convert from bytes to bits we multiply size with 8,
 100  * then the size is multiplied with 10 to make the
 101  * real rate -> rate argument correction.
 102  */
 103 #define GET_DURATION(__size, __rate)    (((__size) * 8 * 10) / (__rate))
 104 #define GET_DURATION_RES(__size, __rate)(((__size) * 8 * 10) % (__rate))
 105
 106 /*
 107  * Determine the number of L2 padding bytes required between the header and
 108  * the payload.
 109  */
 110 #define L2PAD_SIZE(__hdrlen)    (-(__hdrlen) & 3)
 111
 112 /*
 113  * Determine the alignment requirement,
 114  * to make sure the 802.11 payload is padded to a 4-byte boundrary
 115  * we must determine the address of the payload and calculate the
 116  * amount of bytes needed to move the data.
 117  */
 118 #define ALIGN_SIZE(__skb, __header) \
 119         (  ((unsigned long)((__skb)->data + (__header))) & 3 )
 120
 121 /*
 122  * Constants for extra TX headroom for alignment purposes.
 123  */
 124 #define RT2X00_ALIGN_SIZE       4 /* Only whole frame needs alignment */
 125 #define RT2X00_L2PAD_SIZE       8 /* Both header & payload need alignment */
 126
 127 /*
 128  * Standard timing and size defines.
 129  * These values should follow the ieee80211 specifications.
 130  */
 131 #define ACK_SIZE                14
 132 #define IEEE80211_HEADER        24
 133 #define PLCP                    48
 134 #define BEACON                  100
 135 #define PREAMBLE                144
 136 #define SHORT_PREAMBLE          72
 137 #define SLOT_TIME               20
 138 #define SHORT_SLOT_TIME         9
 139 #define SIFS                    10
 140 #define PIFS                    ( SIFS + SLOT_TIME )
 141 #define SHORT_PIFS              ( SIFS + SHORT_SLOT_TIME )
 142 #define DIFS                    ( PIFS + SLOT_TIME )
 143 #define SHORT_DIFS              ( SHORT_PIFS + SHORT_SLOT_TIME )
 144 #define EIFS                    ( SIFS + DIFS + \
 145                                   GET_DURATION(IEEE80211_HEADER + ACK_SIZE, 10) )
 146 #define SHORT_EIFS              ( SIFS + SHORT_DIFS + \
 147                                   GET_DURATION(IEEE80211_HEADER + ACK_SIZE, 10) )
 148
 149 /*
 150  * Structure for average calculation
 151  * The avg field contains the actual average value,
 152  * but avg_weight is internally used during calculations
 153  * to prevent rounding errors.
 154  */
 155 struct avg_val {
 156         int avg;
 157         int avg_weight;
 158 };
 159
 160 enum rt2x00_chip_intf {
 161         RT2X00_CHIP_INTF_PCI,
 162         RT2X00_CHIP_INTF_USB,
 163 };
 164
 165 /*
 166  * Chipset identification
 167  * The chipset on the device is composed of a RT and RF chip.
 168  * The chipset combination is important for determining device capabilities.
 169  */
 170 struct rt2x00_chip {
 171         u16 rt;
 172 #define RT2460          0x0101
 173 #define RT2560          0x0201
 174 #define RT2570          0x1201
 175 #define RT2561s         0x0301  /* Turbo */
 176 #define RT2561          0x0302
 177 #define RT2661          0x0401
 178 #define RT2571          0x1300
 179 #define RT2860          0x0601  /* 2.4GHz PCI/CB */
 180 #define RT2860D         0x0681  /* 2.4GHz, 5GHz PCI/CB */
 181 #define RT2890          0x0701  /* 2.4GHz PCIe */
 182 #define RT2890D         0x0781  /* 2.4GHz, 5GHz PCIe */
 183 #define RT2880          0x2880  /* WSOC */
 184 #define RT3052          0x3052  /* WSOC */
 185 #define RT3090          0x3090  /* 2.4GHz PCIe */
 186 #define RT2870          0x1600
 187 #define RT3070          0x1800
 188
 189         u16 rf;
 190         u32 rev;
 191
 192         enum rt2x00_chip_intf intf;
 193 };
 194
 195 /*
 196  * RF register values that belong to a particular channel.
 197  */
 198 struct rf_channel {
 199         int channel;
 200         u32 rf1;
 201         u32 rf2;
 202         u32 rf3;
 203         u32 rf4;
 204 };
 205
 206 /*
 207  * Channel information structure
 208  */
 209 struct channel_info {
 210         unsigned int flags;
 211 #define GEOGRAPHY_ALLOWED       0x00000001
 212
 213         short tx_power1;
 214         short tx_power2;
 215 };
 216
 217 /*
 218  * Antenna setup values.
 219  */
 220 struct antenna_setup {
 221         enum antenna rx;
 222         enum antenna tx;
 223 };
 224
 225 /*
 226  * Quality statistics about the currently active link.
 227  */
 228 struct link_qual {
 229         /*
 230          * Statistics required for Link tuning by driver
 231          * The rssi value is provided by rt2x00lib during the
 232          * link_tuner() callback function.
 233          * The false_cca field is filled during the link_stats()
 234          * callback function and could be used during the
 235          * link_tuner() callback function.
 236          */
 237         int rssi;
 238         int false_cca;
 239
 240         /*
 241          * VGC levels
 242          * Hardware driver will tune the VGC level during each call
 243          * to the link_tuner() callback function. This vgc_level is
 244          * is determined based on the link quality statistics like
 245          * average RSSI and the false CCA count.
 246          *
 247          * In some cases the drivers need to differentiate between
 248          * the currently "desired" VGC level and the level configured
 249          * in the hardware. The latter is important to reduce the
 250          * number of BBP register reads to reduce register access
 251          * overhead. For this reason we store both values here.
 252          */
 253         u8 vgc_level;
 254         u8 vgc_level_reg;
 255
 256         /*
 257          * Statistics required for Signal quality calculation.
 258          * These fields might be changed during the link_stats()
 259          * callback function.
 260          */
 261         int rx_success;
 262         int rx_failed;
 263         int tx_success;
 264         int tx_failed;
 265 };
 266
 267 /*
 268  * Antenna settings about the currently active link.
 269  */
 270 struct link_ant {
 271         /*
 272          * Antenna flags
 273          */
 274         unsigned int flags;
 275 #define ANTENNA_RX_DIVERSITY    0x00000001
 276 #define ANTENNA_TX_DIVERSITY    0x00000002
 277 #define ANTENNA_MODE_SAMPLE     0x00000004
 278
 279         /*
 280          * Currently active TX/RX antenna setup.
 281          * When software diversity is used, this will indicate
 282          * which antenna is actually used at this time.
 283          */
 284         struct antenna_setup active;
 285
 286         /*
 287          * RSSI history information for the antenna.
 288          * Used to determine when to switch antenna
 289          * when using software diversity.
 290          */
 291         int rssi_history;
 292
 293         /*
 294          * Current RSSI average of the currently active antenna.
 295          * Similar to the avg_rssi in the link_qual structure
 296          * this value is updated by using the walking average.
 297          */
 298         struct avg_val rssi_ant;
 299 };
 300
 301 /*
 302  * To optimize the quality of the link we need to store
 303  * the quality of received frames and periodically
 304  * optimize the link.
 305  */
 306 struct link {
 307         /*
 308          * Link tuner counter
 309          * The number of times the link has been tuned
 310          * since the radio has been switched on.
 311          */
 312         u32 count;
 313
 314         /*
 315          * Quality measurement values.
 316          */
 317         struct link_qual qual;
 318
 319         /*
 320          * TX/RX antenna setup.
 321          */
 322         struct link_ant ant;
 323
 324         /*
 325          * Currently active average RSSI value
 326          */
 327         struct avg_val avg_rssi;
 328
 329         /*
 330          * Work structure for scheduling periodic link tuning.
 331          */
 332         struct delayed_work work;
 333 };
 334
 335 /*
 336  * Interface structure
 337  * Per interface configuration details, this structure
 338  * is allocated as the private data for ieee80211_vif.
 339  */
 340 struct rt2x00_intf {
 341         /*
 342          * All fields within the rt2x00_intf structure
 343          * must be protected with a spinlock.
 344          */
 345         spinlock_t lock;
 346
 347         /*
 348          * MAC of the device.
 349          */
 350         u8 mac[ETH_ALEN];
 351
 352         /*
 353          * BBSID of the AP to associate with.
 354          */
 355         u8 bssid[ETH_ALEN];
 356
 357         /*
 358          * beacon->skb must be protected with the mutex.
 359          */
 360         struct mutex beacon_skb_mutex;
 361
 362         /*
 363          * Entry in the beacon queue which belongs to
 364          * this interface. Each interface has its own
 365          * dedicated beacon entry.
 366          */
 367         struct queue_entry *beacon;
 368
 369         /*
 370          * Actions that needed rescheduling.
 371          */
 372         unsigned int delayed_flags;
 373 #define DELAYED_UPDATE_BEACON           0x00000001
 374
 375         /*
 376          * Software sequence counter, this is only required
 377          * for hardware which doesn't support hardware
 378          * sequence counting.
 379          */
 380         spinlock_t seqlock;
 381         u16 seqno;
 382 };
 383
 384 static inline struct rt2x00_intf* vif_to_intf(struct ieee80211_vif *vif)
 385 {
 386         return (struct rt2x00_intf *)vif->drv_priv;
 387 }
 388
 389 /**
 390  * struct hw_mode_spec: Hardware specifications structure
 391  *
 392  * Details about the supported modes, rates and channels
 393  * of a particular chipset. This is used by rt2x00lib
 394  * to build the ieee80211_hw_mode array for mac80211.
 395  *
 396  * @supported_bands: Bitmask contained the supported bands (2.4GHz, 5.2GHz).
 397  * @supported_rates: Rate types which are supported (CCK, OFDM).
 398  * @num_channels: Number of supported channels. This is used as array size
 399  *      for @tx_power_a, @tx_power_bg and @channels.
 400  * @channels: Device/chipset specific channel values (See &struct rf_channel).
 401  * @channels_info: Additional information for channels (See &struct channel_info).
 402  * @ht: Driver HT Capabilities (See &ieee80211_sta_ht_cap).
 403  */
 404 struct hw_mode_spec {
 405         unsigned int supported_bands;
 406 #define SUPPORT_BAND_2GHZ       0x00000001
 407 #define SUPPORT_BAND_5GHZ       0x00000002
 408
 409         unsigned int supported_rates;
 410 #define SUPPORT_RATE_CCK        0x00000001
 411 #define SUPPORT_RATE_OFDM       0x00000002
 412
 413         unsigned int num_channels;
 414         const struct rf_channel *channels;
 415         const struct channel_info *channels_info;
 416
 417         struct ieee80211_sta_ht_cap ht;
 418 };
 419
 420 /*
 421  * Configuration structure wrapper around the
 422  * mac80211 configuration structure.
 423  * When mac80211 configures the driver, rt2x00lib
 424  * can precalculate values which are equal for all
 425  * rt2x00 drivers. Those values can be stored in here.
 426  */
 427 struct rt2x00lib_conf {
 428         struct ieee80211_conf *conf;
 429
 430         struct rf_channel rf;
 431         struct channel_info channel;
 432 };
 433
 434 /*
 435  * Configuration structure for erp settings.
 436  */
 437 struct rt2x00lib_erp {
 438         int short_preamble;
 439         int cts_protection;
 440
 441         u32 basic_rates;
 442
 443         int slot_time;
 444
 445         short sifs;
 446         short pifs;
 447         short difs;
 448         short eifs;
 449
 450         u16 beacon_int;
 451 };
 452
 453 /*
 454  * Configuration structure for hardware encryption.
 455  */
 456 struct rt2x00lib_crypto {
 457         enum cipher cipher;
 458
 459         enum set_key_cmd cmd;
 460         const u8 *address;
 461
 462         u32 bssidx;
 463         u32 aid;
 464
 465         u8 key[16];
 466         u8 tx_mic[8];
 467         u8 rx_mic[8];
 468 };
 469
 470 /*
 471  * Configuration structure wrapper around the
 472  * rt2x00 interface configuration handler.
 473  */
 474 struct rt2x00intf_conf {
 475         /*
 476          * Interface type
 477          */
 478         enum nl80211_iftype type;
 479
 480         /*
 481          * TSF sync value, this is dependant on the operation type.
 482          */
 483         enum tsf_sync sync;
 484
 485         /*
 486          * The MAC and BSSID addressess are simple array of bytes,
 487          * these arrays are little endian, so when sending the addressess
 488          * to the drivers, copy the it into a endian-signed variable.
 489          *
 490          * Note that all devices (except rt2500usb) have 32 bits
 491          * register word sizes. This means that whatever variable we
 492          * pass _must_ be a multiple of 32 bits. Otherwise the device
 493          * might not accept what we are sending to it.
 494          * This will also make it easier for the driver to write
 495          * the data to the device.
 496          */
 497         __le32 mac[2];
 498         __le32 bssid[2];
 499 };
 500
 501 /*
 502  * rt2x00lib callback functions.
 503  */
 504 struct rt2x00lib_ops {
 505         /*
 506          * Interrupt handlers.
 507          */
 508         irq_handler_t irq_handler;
 509
 510         /*
 511          * Device init handlers.
 512          */
 513         int (*probe_hw) (struct rt2x00_dev *rt2x00dev);
 514         char *(*get_firmware_name) (struct rt2x00_dev *rt2x00dev);
 515         int (*check_firmware) (struct rt2x00_dev *rt2x00dev,
 516                                const u8 *data, const size_t len);
 517         int (*load_firmware) (struct rt2x00_dev *rt2x00dev,
 518                               const u8 *data, const size_t len);
 519
 520         /*
 521          * Device initialization/deinitialization handlers.
 522          */
 523         int (*initialize) (struct rt2x00_dev *rt2x00dev);
 524         void (*uninitialize) (struct rt2x00_dev *rt2x00dev);
 525
 526         /*
 527          * queue initialization handlers
 528          */
 529         bool (*get_entry_state) (struct queue_entry *entry);
 530         void (*clear_entry) (struct queue_entry *entry);
 531
 532         /*
 533          * Radio control handlers.
 534          */
 535         int (*set_device_state) (struct rt2x00_dev *rt2x00dev,
 536                                  enum dev_state state);
 537         int (*rfkill_poll) (struct rt2x00_dev *rt2x00dev);
 538         void (*link_stats) (struct rt2x00_dev *rt2x00dev,
 539                             struct link_qual *qual);
 540         void (*reset_tuner) (struct rt2x00_dev *rt2x00dev,
 541                              struct link_qual *qual);
 542         void (*link_tuner) (struct rt2x00_dev *rt2x00dev,
 543                             struct link_qual *qual, const u32 count);
 544
 545         /*
 546          * TX control handlers
 547          */
 548         void (*write_tx_desc) (struct rt2x00_dev *rt2x00dev,
 549                                struct sk_buff *skb,
 550                                struct txentry_desc *txdesc);
 551         int (*write_tx_data) (struct queue_entry *entry);
 552         void (*write_beacon) (struct queue_entry *entry);
 553         int (*get_tx_data_len) (struct queue_entry *entry);
 554         void (*kick_tx_queue) (struct rt2x00_dev *rt2x00dev,
 555                                const enum data_queue_qid queue);
 556         void (*kill_tx_queue) (struct rt2x00_dev *rt2x00dev,
 557                                const enum data_queue_qid queue);
 558
 559         /*
 560          * RX control handlers
 561          */
 562         void (*fill_rxdone) (struct queue_entry *entry,
 563                              struct rxdone_entry_desc *rxdesc);
 564
 565         /*
 566          * Configuration handlers.
 567          */
 568         int (*config_shared_key) (struct rt2x00_dev *rt2x00dev,
 569                                   struct rt2x00lib_crypto *crypto,
 570                                   struct ieee80211_key_conf *key);
 571         int (*config_pairwise_key) (struct rt2x00_dev *rt2x00dev,
 572                                     struct rt2x00lib_crypto *crypto,
 573                                     struct ieee80211_key_conf *key);
 574         void (*config_filter) (struct rt2x00_dev *rt2x00dev,
 575                                const unsigned int filter_flags);
 576         void (*config_intf) (struct rt2x00_dev *rt2x00dev,
 577                              struct rt2x00_intf *intf,
 578                              struct rt2x00intf_conf *conf,
 579                              const unsigned int flags);
 580 #define CONFIG_UPDATE_TYPE              ( 1 << 1 )
 581 #define CONFIG_UPDATE_MAC               ( 1 << 2 )
 582 #define CONFIG_UPDATE_BSSID             ( 1 << 3 )
 583
 584         void (*config_erp) (struct rt2x00_dev *rt2x00dev,
 585                             struct rt2x00lib_erp *erp);
 586         void (*config_ant) (struct rt2x00_dev *rt2x00dev,
 587                             struct antenna_setup *ant);
 588         void (*config) (struct rt2x00_dev *rt2x00dev,
 589                         struct rt2x00lib_conf *libconf,
 590                         const unsigned int changed_flags);
 591 };
 592
 593 /*
 594  * rt2x00 driver callback operation structure.
 595  */
 596 struct rt2x00_ops {
 597         const char *name;
 598         const unsigned int max_sta_intf;
 599         const unsigned int max_ap_intf;
 600         const unsigned int eeprom_size;
 601         const unsigned int rf_size;
 602         const unsigned int tx_queues;
 603         const unsigned int extra_tx_headroom;
 604         const struct data_queue_desc *rx;
 605         const struct data_queue_desc *tx;
 606         const struct data_queue_desc *bcn;
 607         const struct data_queue_desc *atim;
 608         const struct rt2x00lib_ops *lib;
 609         const struct ieee80211_ops *hw;
 610 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
 611         const struct rt2x00debug *debugfs;
 612 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
 613 };
 614
 615 /*
 616  * rt2x00 device flags
 617  */
 618 enum rt2x00_flags {
 619         /*
 620          * Device state flags
 621          */
 622         DEVICE_STATE_PRESENT,
 623         DEVICE_STATE_REGISTERED_HW,
 624         DEVICE_STATE_INITIALIZED,
 625         DEVICE_STATE_STARTED,
 626         DEVICE_STATE_ENABLED_RADIO,
 627
 628         /*
 629          * Driver requirements
 630          */
 631         DRIVER_REQUIRE_FIRMWARE,
 632         DRIVER_REQUIRE_BEACON_GUARD,
 633         DRIVER_REQUIRE_ATIM_QUEUE,
 634         DRIVER_REQUIRE_DMA,
 635         DRIVER_REQUIRE_COPY_IV,
 636         DRIVER_REQUIRE_L2PAD,
 637
 638         /*
 639          * Driver features
 640          */
 641         CONFIG_SUPPORT_HW_BUTTON,
 642         CONFIG_SUPPORT_HW_CRYPTO,
 643         DRIVER_SUPPORT_CONTROL_FILTERS,
 644         DRIVER_SUPPORT_CONTROL_FILTER_PSPOLL,
 645
 646         /*
 647          * Driver configuration
 648          */
 649         CONFIG_FRAME_TYPE,
 650         CONFIG_RF_SEQUENCE,
 651         CONFIG_EXTERNAL_LNA_A,
 652         CONFIG_EXTERNAL_LNA_BG,
 653         CONFIG_DOUBLE_ANTENNA,
 654         CONFIG_DISABLE_LINK_TUNING,
 655         CONFIG_CHANNEL_HT40,
 656 };
 657
 658 /*
 659  * rt2x00 device structure.
 660  */
 661 struct rt2x00_dev {
 662         /*
 663          * Device structure.
 664          * The structure stored in here depends on the
 665          * system bus (PCI or USB).
 666          * When accessing this variable, the rt2x00dev_{pci,usb}
 667          * macros should be used for correct typecasting.
 668          */
 669         struct device *dev;
 670
 671         /*
 672          * Callback functions.
 673          */
 674         const struct rt2x00_ops *ops;
 675
 676         /*
 677          * IEEE80211 control structure.
 678          */
 679         struct ieee80211_hw *hw;
 680         struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
 681         enum ieee80211_band curr_band;
 682
 683         /*
 684          * If enabled, the debugfs interface structures
 685          * required for deregistration of debugfs.
 686          */
 687 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
 688         struct rt2x00debug_intf *debugfs_intf;
 689 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
 690
 691         /*
 692          * LED structure for changing the LED status
 693          * by mac8011 or the kernel.
 694          */
 695 #ifdef CONFIG_RT2X00_LIB_LEDS
 696         struct rt2x00_led led_radio;
 697         struct rt2x00_led led_assoc;
 698         struct rt2x00_led led_qual;
 699         u16 led_mcu_reg;
 700 #endif /* CONFIG_RT2X00_LIB_LEDS */
 701
 702         /*
 703          * Device flags.
 704          * In these flags the current status and some
 705          * of the device capabilities are stored.
 706          */
 707         unsigned long flags;
 708
 709         /*
 710          * Device information, Bus IRQ and name (PCI, SoC)
 711          */
 712         int irq;
 713         const char *name;
 714
 715         /*
 716          * Chipset identification.
 717          */
 718         struct rt2x00_chip chip;
 719
 720         /*
 721          * hw capability specifications.
 722          */
 723         struct hw_mode_spec spec;
 724
 725         /*
 726          * This is the default TX/RX antenna setup as indicated
 727          * by the device's EEPROM.
 728          */
 729         struct antenna_setup default_ant;
 730
 731         /*
 732          * Register pointers
 733          * csr.base: CSR base register address. (PCI)
 734          * csr.cache: CSR cache for usb_control_msg. (USB)
 735          */
 736         union csr {
 737                 void __iomem *base;
 738                 void *cache;
 739         } csr;
 740
 741         /*
 742          * Mutex to protect register accesses.
 743          * For PCI and USB devices it protects against concurrent indirect
 744          * register access (BBP, RF, MCU) since accessing those
 745          * registers require multiple calls to the CSR registers.
 746          * For USB devices it also protects the csr_cache since that
 747          * field is used for normal CSR access and it cannot support
 748          * multiple callers simultaneously.
 749          */
 750         struct mutex csr_mutex;
 751
 752         /*
 753          * Current packet filter configuration for the device.
 754          * This contains all currently active FIF_* flags send
 755          * to us by mac80211 during configure_filter().
 756          */
 757         unsigned int packet_filter;
 758
 759         /*
 760          * Interface details:
 761          *  - Open ap interface count.
 762          *  - Open sta interface count.
 763          *  - Association count.
 764          */
 765         unsigned int intf_ap_count;
 766         unsigned int intf_sta_count;
 767         unsigned int intf_associated;
 768
 769         /*
 770          * Link quality
 771          */
 772         struct link link;
 773
 774         /*
 775          * EEPROM data.
 776          */
 777         __le16 *eeprom;
 778
 779         /*
 780          * Active RF register values.
 781          * These are stored here so we don't need
 782          * to read the rf registers and can directly
 783          * use this value instead.
 784          * This field should be accessed by using
 785          * rt2x00_rf_read() and rt2x00_rf_write().
 786          */
 787         u32 *rf;
 788
 789         /*
 790          * LNA gain
 791          */
 792         short lna_gain;
 793
 794         /*
 795          * Current TX power value.
 796          */
 797         u16 tx_power;
 798
 799         /*
 800          * Current retry values.
 801          */
 802         u8 short_retry;
 803         u8 long_retry;
 804
 805         /*
 806          * Rssi <-> Dbm offset
 807          */
 808         u8 rssi_offset;
 809
 810         /*
 811          * Frequency offset (for rt61pci & rt73usb).
 812          */
 813         u8 freq_offset;
 814
 815         /*
 816          * Calibration information (for rt2800usb & rt2800pci).
 817          * [0] -> BW20
 818          * [1] -> BW40
 819          */
 820         u8 calibration[2];
 821
 822         /*
 823          * Beacon interval.
 824          */
 825         u16 beacon_int;
 826
 827         /*
 828          * Low level statistics which will have
 829          * to be kept up to date while device is running.
 830          */
 831         struct ieee80211_low_level_stats low_level_stats;
 832
 833         /*
 834          * RX configuration information.
 835          */
 836         struct ieee80211_rx_status rx_status;
 837
 838         /*
 839          * Scheduled work.
 840          * NOTE: intf_work will use ieee80211_iterate_active_interfaces()
 841          * which means it cannot be placed on the hw->workqueue
 842          * due to RTNL locking requirements.
 843          */
 844         struct work_struct intf_work;
 845
 846         /*
 847          * Data queue arrays for RX, TX and Beacon.
 848          * The Beacon array also contains the Atim queue
 849          * if that is supported by the device.
 850          */
 851         unsigned int data_queues;
 852         struct data_queue *rx;
 853         struct data_queue *tx;
 854         struct data_queue *bcn;
 855
 856         /*
 857          * Firmware image.
 858          */
 859         const struct firmware *fw;
 860
 861         /*
 862          * Driver specific data.
 863          */
 864         void *priv;
 865 };
 866
 867 /*
 868  * Register defines.
 869  * Some registers require multiple attempts before success,
 870  * in those cases REGISTER_BUSY_COUNT attempts should be
 871  * taken with a REGISTER_BUSY_DELAY interval.
 872  */
 873 #define REGISTER_BUSY_COUNT     5
 874 #define REGISTER_BUSY_DELAY     100
 875
 876 /*
 877  * Generic RF access.
 878  * The RF is being accessed by word index.
 879  */
 880 static inline void rt2x00_rf_read(struct rt2x00_dev *rt2x00dev,
 881                                   const unsigned int word, u32 *data)
 882 {
 883         BUG_ON(word < 1 || word > rt2x00dev->ops->rf_size / sizeof(u32));
 884         *data = rt2x00dev->rf[word - 1];
 885 }
 886
 887 static inline void rt2x00_rf_write(struct rt2x00_dev *rt2x00dev,
 888                                    const unsigned int word, u32 data)
 889 {
 890         BUG_ON(word < 1 || word > rt2x00dev->ops->rf_size / sizeof(u32));
 891         rt2x00dev->rf[word - 1] = data;
 892 }
 893
 894 /*
 895  *  Generic EEPROM access.
 896  * The EEPROM is being accessed by word index.
 897  */
 898 static inline void *rt2x00_eeprom_addr(struct rt2x00_dev *rt2x00dev,
 899                                        const unsigned int word)
 900 {
 901         return (void *)&rt2x00dev->eeprom[word];
 902 }
 903
 904 static inline void rt2x00_eeprom_read(struct rt2x00_dev *rt2x00dev,
 905                                       const unsigned int word, u16 *data)
 906 {
 907         *data = le16_to_cpu(rt2x00dev->eeprom[word]);
 908 }
 909
 910 static inline void rt2x00_eeprom_write(struct rt2x00_dev *rt2x00dev,
 911                                        const unsigned int word, u16 data)
 912 {
 913         rt2x00dev->eeprom[word] = cpu_to_le16(data);
 914 }
 915
 916 /*
 917  * Chipset handlers
 918  */
 919 static inline void rt2x00_set_chip(struct rt2x00_dev *rt2x00dev,
 920                                    const u16 rt, const u16 rf, const u32 rev)
 921 {
 922         rt2x00dev->chip.rt = rt;
 923         rt2x00dev->chip.rf = rf;
 924         rt2x00dev->chip.rev = rev;
 925 }
 926
 927 static inline void rt2x00_set_chip_rt(struct rt2x00_dev *rt2x00dev,
 928                                       const u16 rt)
 929 {
 930         rt2x00dev->chip.rt = rt;
 931 }
 932
 933 static inline void rt2x00_set_chip_rf(struct rt2x00_dev *rt2x00dev,
 934                                       const u16 rf, const u32 rev)
 935 {
 936         rt2x00_set_chip(rt2x00dev, rt2x00dev->chip.rt, rf, rev);
 937 }
 938
 939 static inline void rt2x00_print_chip(struct rt2x00_dev *rt2x00dev)
 940 {
 941         INFO(rt2x00dev,
 942              "Chipset detected - rt: %04x, rf: %04x, rev: %08x.\n",
 943              rt2x00dev->chip.rt, rt2x00dev->chip.rf, rt2x00dev->chip.rev);
 944 }
 945
 946 static inline char rt2x00_rt(struct rt2x00_dev *rt2x00dev, const u16 rt)
 947 {
 948         return (rt2x00dev->chip.rt == rt);
 949 }
 950
 951 static inline char rt2x00_rf(struct rt2x00_dev *rt2x00dev, const u16 rf)
 952 {
 953         return (rt2x00dev->chip.rf == rf);
 954 }
 955
 956 static inline u32 rt2x00_rev(struct rt2x00_dev *rt2x00dev)
 957 {
 958         return rt2x00dev->chip.rev;
 959 }
 960
 961 static inline bool rt2x00_check_rev(struct rt2x00_dev *rt2x00dev,
 962                                     const u32 mask, const u32 rev)
 963 {
 964         return ((rt2x00dev->chip.rev & mask) == rev);
 965 }
 966
 967 static inline void rt2x00_set_chip_intf(struct rt2x00_dev *rt2x00dev,
 968                                         enum rt2x00_chip_intf intf)
 969 {
 970         rt2x00dev->chip.intf = intf;
 971 }
 972
 973 static inline bool rt2x00_intf(struct rt2x00_dev *rt2x00dev,
 974                                enum rt2x00_chip_intf intf)
 975 {
 976         return (rt2x00dev->chip.intf == intf);
 977 }
 978
 979 static inline bool rt2x00_intf_is_pci(struct rt2x00_dev *rt2x00dev)
 980 {
 981         return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCI);
 982 }
 983
 984 static inline bool rt2x00_intf_is_usb(struct rt2x00_dev *rt2x00dev)
 985 {
 986         return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_USB);
 987 }
 988
 989 /**
 990  * rt2x00queue_map_txskb - Map a skb into DMA for TX purposes.
 991  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 992  * @skb: The skb to map.
 993  */
 994 void rt2x00queue_map_txskb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb);
 995
 996 /**
 997  * rt2x00queue_get_queue - Convert queue index to queue pointer
 998  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 999  * @queue: rt2x00 queue index (see &enum data_queue_qid).
1000  */
1001 struct data_queue *rt2x00queue_get_queue(struct rt2x00_dev *rt2x00dev,
1002                                          const enum data_queue_qid queue);
1003
1004 /**
1005  * rt2x00queue_get_entry - Get queue entry where the given index points to.
1006  * @queue: Pointer to &struct data_queue from where we obtain the entry.
1007  * @index: Index identifier for obtaining the correct index.
1008  */
1009 struct queue_entry *rt2x00queue_get_entry(struct data_queue *queue,
1010                                           enum queue_index index);
1011
1012 /*
1013  * Interrupt context handlers.
1014  */
1015 void rt2x00lib_beacondone(struct rt2x00_dev *rt2x00dev);
1016 void rt2x00lib_txdone(struct queue_entry *entry,
1017                       struct txdone_entry_desc *txdesc);
1018 void rt2x00lib_rxdone(struct rt2x00_dev *rt2x00dev,
1019                       struct queue_entry *entry);
1020
1021 /*
1022  * mac80211 handlers.
1023  */
1024 int rt2x00mac_tx(struct ieee80211_hw *hw, struct sk_buff *skb);
1025 int rt2x00mac_start(struct ieee80211_hw *hw);
1026 void rt2x00mac_stop(struct ieee80211_hw *hw);
1027 int rt2x00mac_add_interface(struct ieee80211_hw *hw,
1028                             struct ieee80211_vif *vif);
1029 void rt2x00mac_remove_interface(struct ieee80211_hw *hw,
1030                                 struct ieee80211_vif *vif);
1031 int rt2x00mac_config(struct ieee80211_hw *hw, u32 changed);
1032 void rt2x00mac_configure_filter(struct ieee80211_hw *hw,
1033                                 unsigned int changed_flags,
1034                                 unsigned int *total_flags,
1035                                 u64 multicast);
1036 int rt2x00mac_set_tim(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1037                       bool set);
1038 #ifdef CONFIG_RT2X00_LIB_CRYPTO
1039 int rt2x00mac_set_key(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1040                       struct ieee80211_vif *vif, struct ieee80211_sta *sta,
1041                       struct ieee80211_key_conf *key);
1042 #else
1043 #define rt2x00mac_set_key       NULL
1044 #endif /* CONFIG_RT2X00_LIB_CRYPTO */
1045 int rt2x00mac_get_stats(struct ieee80211_hw *hw,
1046                         struct ieee80211_low_level_stats *stats);
1047 int rt2x00mac_get_tx_stats(struct ieee80211_hw *hw,
1048                            struct ieee80211_tx_queue_stats *stats);
1049 void rt2x00mac_bss_info_changed(struct ieee80211_hw *hw,
1050                                 struct ieee80211_vif *vif,
1051                                 struct ieee80211_bss_conf *bss_conf,
1052                                 u32 changes);
1053 int rt2x00mac_conf_tx(struct ieee80211_hw *hw, u16 queue,
1054                       const struct ieee80211_tx_queue_params *params);
1055 void rt2x00mac_rfkill_poll(struct ieee80211_hw *hw);
1056
1057 /*
1058  * Driver allocation handlers.
1059  */
1060 int rt2x00lib_probe_dev(struct rt2x00_dev *rt2x00dev);
1061 void rt2x00lib_remove_dev(struct rt2x00_dev *rt2x00dev);
1062 #ifdef CONFIG_PM
1063 int rt2x00lib_suspend(struct rt2x00_dev *rt2x00dev, pm_message_t state);
1064 int rt2x00lib_resume(struct rt2x00_dev *rt2x00dev);
1065 #endif /* CONFIG_PM */
1066
1067 #endif /* RT2X00_H */