drivers/net/wireless/rt2x00/rt2x00.h

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