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