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