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