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