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  * @ht: Driver HT Capabilities (See &ieee80211_sta_ht_cap).
 370  */
 371 struct hw_mode_spec {
 372         unsigned int supported_bands;
 373 #define SUPPORT_BAND_2GHZ       0x00000001
 374 #define SUPPORT_BAND_5GHZ       0x00000002
 375
 376         unsigned int supported_rates;
 377 #define SUPPORT_RATE_CCK        0x00000001
 378 #define SUPPORT_RATE_OFDM       0x00000002
 379
 380         unsigned int num_channels;
 381         const struct rf_channel *channels;
 382         const struct channel_info *channels_info;
 383
 384         struct ieee80211_sta_ht_cap ht;
 385 };
 386
 387 /*
 388  * Configuration structure wrapper around the
 389  * mac80211 configuration structure.
 390  * When mac80211 configures the driver, rt2x00lib
 391  * can precalculate values which are equal for all
 392  * rt2x00 drivers. Those values can be stored in here.
 393  */
 394 struct rt2x00lib_conf {
 395         struct ieee80211_conf *conf;
 396
 397         struct rf_channel rf;
 398         struct channel_info channel;
 399 };
 400
 401 /*
 402  * Configuration structure for erp settings.
 403  */
 404 struct rt2x00lib_erp {
 405         int short_preamble;
 406         int cts_protection;
 407
 408         int ack_timeout;
 409         int ack_consume_time;
 410
 411         u32 basic_rates;
 412
 413         int slot_time;
 414
 415         short sifs;
 416         short pifs;
 417         short difs;
 418         short eifs;
 419 };
 420
 421 /*
 422  * Configuration structure for hardware encryption.
 423  */
 424 struct rt2x00lib_crypto {
 425         enum cipher cipher;
 426
 427         enum set_key_cmd cmd;
 428         const u8 *address;
 429
 430         u32 bssidx;
 431         u32 aid;
 432
 433         u8 key[16];
 434         u8 tx_mic[8];
 435         u8 rx_mic[8];
 436 };
 437
 438 /*
 439  * Configuration structure wrapper around the
 440  * rt2x00 interface configuration handler.
 441  */
 442 struct rt2x00intf_conf {
 443         /*
 444          * Interface type
 445          */
 446         enum nl80211_iftype type;
 447
 448         /*
 449          * TSF sync value, this is dependant on the operation type.
 450          */
 451         enum tsf_sync sync;
 452
 453         /*
 454          * The MAC and BSSID addressess are simple array of bytes,
 455          * these arrays are little endian, so when sending the addressess
 456          * to the drivers, copy the it into a endian-signed variable.
 457          *
 458          * Note that all devices (except rt2500usb) have 32 bits
 459          * register word sizes. This means that whatever variable we
 460          * pass _must_ be a multiple of 32 bits. Otherwise the device
 461          * might not accept what we are sending to it.
 462          * This will also make it easier for the driver to write
 463          * the data to the device.
 464          */
 465         __le32 mac[2];
 466         __le32 bssid[2];
 467 };
 468
 469 /*
 470  * rt2x00lib callback functions.
 471  */
 472 struct rt2x00lib_ops {
 473         /*
 474          * Interrupt handlers.
 475          */
 476         irq_handler_t irq_handler;
 477
 478         /*
 479          * Device init handlers.
 480          */
 481         int (*probe_hw) (struct rt2x00_dev *rt2x00dev);
 482         char *(*get_firmware_name) (struct rt2x00_dev *rt2x00dev);
 483         int (*check_firmware) (struct rt2x00_dev *rt2x00dev,
 484                                const u8 *data, const size_t len);
 485         int (*load_firmware) (struct rt2x00_dev *rt2x00dev,
 486                               const u8 *data, const size_t len);
 487
 488         /*
 489          * Device initialization/deinitialization handlers.
 490          */
 491         int (*initialize) (struct rt2x00_dev *rt2x00dev);
 492         void (*uninitialize) (struct rt2x00_dev *rt2x00dev);
 493
 494         /*
 495          * queue initialization handlers
 496          */
 497         bool (*get_entry_state) (struct queue_entry *entry);
 498         void (*clear_entry) (struct queue_entry *entry);
 499
 500         /*
 501          * Radio control handlers.
 502          */
 503         int (*set_device_state) (struct rt2x00_dev *rt2x00dev,
 504                                  enum dev_state state);
 505         int (*rfkill_poll) (struct rt2x00_dev *rt2x00dev);
 506         void (*link_stats) (struct rt2x00_dev *rt2x00dev,
 507                             struct link_qual *qual);
 508         void (*reset_tuner) (struct rt2x00_dev *rt2x00dev,
 509                              struct link_qual *qual);
 510         void (*link_tuner) (struct rt2x00_dev *rt2x00dev,
 511                             struct link_qual *qual, const u32 count);
 512
 513         /*
 514          * TX control handlers
 515          */
 516         void (*write_tx_desc) (struct rt2x00_dev *rt2x00dev,
 517                                struct sk_buff *skb,
 518                                struct txentry_desc *txdesc);
 519         int (*write_tx_data) (struct queue_entry *entry);
 520         void (*write_beacon) (struct queue_entry *entry);
 521         int (*get_tx_data_len) (struct queue_entry *entry);
 522         void (*kick_tx_queue) (struct rt2x00_dev *rt2x00dev,
 523                                const enum data_queue_qid queue);
 524         void (*kill_tx_queue) (struct rt2x00_dev *rt2x00dev,
 525                                const enum data_queue_qid queue);
 526
 527         /*
 528          * RX control handlers
 529          */
 530         void (*fill_rxdone) (struct queue_entry *entry,
 531                              struct rxdone_entry_desc *rxdesc);
 532
 533         /*
 534          * Configuration handlers.
 535          */
 536         int (*config_shared_key) (struct rt2x00_dev *rt2x00dev,
 537                                   struct rt2x00lib_crypto *crypto,
 538                                   struct ieee80211_key_conf *key);
 539         int (*config_pairwise_key) (struct rt2x00_dev *rt2x00dev,
 540                                     struct rt2x00lib_crypto *crypto,
 541                                     struct ieee80211_key_conf *key);
 542         void (*config_filter) (struct rt2x00_dev *rt2x00dev,
 543                                const unsigned int filter_flags);
 544         void (*config_intf) (struct rt2x00_dev *rt2x00dev,
 545                              struct rt2x00_intf *intf,
 546                              struct rt2x00intf_conf *conf,
 547                              const unsigned int flags);
 548 #define CONFIG_UPDATE_TYPE              ( 1 << 1 )
 549 #define CONFIG_UPDATE_MAC               ( 1 << 2 )
 550 #define CONFIG_UPDATE_BSSID             ( 1 << 3 )
 551
 552         void (*config_erp) (struct rt2x00_dev *rt2x00dev,
 553                             struct rt2x00lib_erp *erp);
 554         void (*config_ant) (struct rt2x00_dev *rt2x00dev,
 555                             struct antenna_setup *ant);
 556         void (*config) (struct rt2x00_dev *rt2x00dev,
 557                         struct rt2x00lib_conf *libconf,
 558                         const unsigned int changed_flags);
 559 };
 560
 561 /*
 562  * rt2x00 driver callback operation structure.
 563  */
 564 struct rt2x00_ops {
 565         const char *name;
 566         const unsigned int max_sta_intf;
 567         const unsigned int max_ap_intf;
 568         const unsigned int eeprom_size;
 569         const unsigned int rf_size;
 570         const unsigned int tx_queues;
 571         const struct data_queue_desc *rx;
 572         const struct data_queue_desc *tx;
 573         const struct data_queue_desc *bcn;
 574         const struct data_queue_desc *atim;
 575         const struct rt2x00lib_ops *lib;
 576         const struct ieee80211_ops *hw;
 577 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
 578         const struct rt2x00debug *debugfs;
 579 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
 580 };
 581
 582 /*
 583  * rt2x00 device flags
 584  */
 585 enum rt2x00_flags {
 586         /*
 587          * Device state flags
 588          */
 589         DEVICE_STATE_PRESENT,
 590         DEVICE_STATE_REGISTERED_HW,
 591         DEVICE_STATE_INITIALIZED,
 592         DEVICE_STATE_STARTED,
 593         DEVICE_STATE_ENABLED_RADIO,
 594         DEVICE_STATE_DISABLED_RADIO_HW,
 595
 596         /*
 597          * Driver requirements
 598          */
 599         DRIVER_REQUIRE_FIRMWARE,
 600         DRIVER_REQUIRE_BEACON_GUARD,
 601         DRIVER_REQUIRE_ATIM_QUEUE,
 602         DRIVER_REQUIRE_SCHEDULED,
 603         DRIVER_REQUIRE_DMA,
 604         DRIVER_REQUIRE_COPY_IV,
 605         DRIVER_REQUIRE_L2PAD,
 606
 607         /*
 608          * Driver features
 609          */
 610         CONFIG_SUPPORT_HW_BUTTON,
 611         CONFIG_SUPPORT_HW_CRYPTO,
 612
 613         /*
 614          * Driver configuration
 615          */
 616         CONFIG_FRAME_TYPE,
 617         CONFIG_RF_SEQUENCE,
 618         CONFIG_EXTERNAL_LNA_A,
 619         CONFIG_EXTERNAL_LNA_BG,
 620         CONFIG_DOUBLE_ANTENNA,
 621         CONFIG_DISABLE_LINK_TUNING,
 622         CONFIG_CHANNEL_HT40,
 623 };
 624
 625 /*
 626  * rt2x00 device structure.
 627  */
 628 struct rt2x00_dev {
 629         /*
 630          * Device structure.
 631          * The structure stored in here depends on the
 632          * system bus (PCI or USB).
 633          * When accessing this variable, the rt2x00dev_{pci,usb}
 634          * macro's should be used for correct typecasting.
 635          */
 636         struct device *dev;
 637
 638         /*
 639          * Callback functions.
 640          */
 641         const struct rt2x00_ops *ops;
 642
 643         /*
 644          * IEEE80211 control structure.
 645          */
 646         struct ieee80211_hw *hw;
 647         struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
 648         enum ieee80211_band curr_band;
 649
 650         /*
 651          * rfkill structure for RF state switching support.
 652          * This will only be compiled in when required.
 653          */
 654 #ifdef CONFIG_RT2X00_LIB_RFKILL
 655         unsigned long rfkill_state;
 656 #define RFKILL_STATE_ALLOCATED          1
 657 #define RFKILL_STATE_REGISTERED         2
 658 #define RFKILL_STATE_BLOCKED            3
 659         struct input_polled_dev *rfkill_poll_dev;
 660 #endif /* CONFIG_RT2X00_LIB_RFKILL */
 661
 662         /*
 663          * If enabled, the debugfs interface structures
 664          * required for deregistration of debugfs.
 665          */
 666 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
 667         struct rt2x00debug_intf *debugfs_intf;
 668 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
 669
 670         /*
 671          * LED structure for changing the LED status
 672          * by mac8011 or the kernel.
 673          */
 674 #ifdef CONFIG_RT2X00_LIB_LEDS
 675         struct rt2x00_led led_radio;
 676         struct rt2x00_led led_assoc;
 677         struct rt2x00_led led_qual;
 678         u16 led_mcu_reg;
 679 #endif /* CONFIG_RT2X00_LIB_LEDS */
 680
 681         /*
 682          * Device flags.
 683          * In these flags the current status and some
 684          * of the device capabilities are stored.
 685          */
 686         unsigned long flags;
 687
 688         /*
 689          * Device information, Bus IRQ and name (PCI, SoC)
 690          */
 691         int irq;
 692         const char *name;
 693
 694         /*
 695          * Chipset identification.
 696          */
 697         struct rt2x00_chip chip;
 698
 699         /*
 700          * hw capability specifications.
 701          */
 702         struct hw_mode_spec spec;
 703
 704         /*
 705          * This is the default TX/RX antenna setup as indicated
 706          * by the device's EEPROM.
 707          */
 708         struct antenna_setup default_ant;
 709
 710         /*
 711          * Register pointers
 712          * csr.base: CSR base register address. (PCI)
 713          * csr.cache: CSR cache for usb_control_msg. (USB)
 714          */
 715         union csr {
 716                 void __iomem *base;
 717                 void *cache;
 718         } csr;
 719
 720         /*
 721          * Mutex to protect register accesses.
 722          * For PCI and USB devices it protects against concurrent indirect
 723          * register access (BBP, RF, MCU) since accessing those
 724          * registers require multiple calls to the CSR registers.
 725          * For USB devices it also protects the csr_cache since that
 726          * field is used for normal CSR access and it cannot support
 727          * multiple callers simultaneously.
 728          */
 729         struct mutex csr_mutex;
 730
 731         /*
 732          * Current packet filter configuration for the device.
 733          * This contains all currently active FIF_* flags send
 734          * to us by mac80211 during configure_filter().
 735          */
 736         unsigned int packet_filter;
 737
 738         /*
 739          * Interface details:
 740          *  - Open ap interface count.
 741          *  - Open sta interface count.
 742          *  - Association count.
 743          */
 744         unsigned int intf_ap_count;
 745         unsigned int intf_sta_count;
 746         unsigned int intf_associated;
 747
 748         /*
 749          * Link quality
 750          */
 751         struct link link;
 752
 753         /*
 754          * EEPROM data.
 755          */
 756         __le16 *eeprom;
 757
 758         /*
 759          * Active RF register values.
 760          * These are stored here so we don't need
 761          * to read the rf registers and can directly
 762          * use this value instead.
 763          * This field should be accessed by using
 764          * rt2x00_rf_read() and rt2x00_rf_write().
 765          */
 766         u32 *rf;
 767
 768         /*
 769          * LNA gain
 770          */
 771         short lna_gain;
 772
 773         /*
 774          * Current TX power value.
 775          */
 776         u16 tx_power;
 777
 778         /*
 779          * Current retry values.
 780          */
 781         u8 short_retry;
 782         u8 long_retry;
 783
 784         /*
 785          * Rssi <-> Dbm offset
 786          */
 787         u8 rssi_offset;
 788
 789         /*
 790          * Frequency offset (for rt61pci & rt73usb).
 791          */
 792         u8 freq_offset;
 793
 794         /*
 795          * Calibration information (for rt2800usb & rt2800pci).
 796          * [0] -> BW20
 797          * [1] -> BW40
 798          */
 799         u8 calibration[2];
 800
 801         /*
 802          * Low level statistics which will have
 803          * to be kept up to date while device is running.
 804          */
 805         struct ieee80211_low_level_stats low_level_stats;
 806
 807         /*
 808          * RX configuration information.
 809          */
 810         struct ieee80211_rx_status rx_status;
 811
 812         /*
 813          * Scheduled work.
 814          * NOTE: intf_work will use ieee80211_iterate_active_interfaces()
 815          * which means it cannot be placed on the hw->workqueue
 816          * due to RTNL locking requirements.
 817          */
 818         struct work_struct intf_work;
 819         struct work_struct filter_work;
 820
 821         /*
 822          * Data queue arrays for RX, TX and Beacon.
 823          * The Beacon array also contains the Atim queue
 824          * if that is supported by the device.
 825          */
 826         unsigned int data_queues;
 827         struct data_queue *rx;
 828         struct data_queue *tx;
 829         struct data_queue *bcn;
 830
 831         /*
 832          * Firmware image.
 833          */
 834         const struct firmware *fw;
 835 };
 836
 837 /*
 838  * Generic RF access.
 839  * The RF is being accessed by word index.
 840  */
 841 static inline void rt2x00_rf_read(struct rt2x00_dev *rt2x00dev,
 842                                   const unsigned int word, u32 *data)
 843 {
 844         *data = rt2x00dev->rf[word];
 845 }
 846
 847 static inline void rt2x00_rf_write(struct rt2x00_dev *rt2x00dev,
 848                                    const unsigned int word, u32 data)
 849 {
 850         rt2x00dev->rf[word] = data;
 851 }
 852
 853 /*
 854  *  Generic EEPROM access.
 855  * The EEPROM is being accessed by word index.
 856  */
 857 static inline void *rt2x00_eeprom_addr(struct rt2x00_dev *rt2x00dev,
 858                                        const unsigned int word)
 859 {
 860         return (void *)&rt2x00dev->eeprom[word];
 861 }
 862
 863 static inline void rt2x00_eeprom_read(struct rt2x00_dev *rt2x00dev,
 864                                       const unsigned int word, u16 *data)
 865 {
 866         *data = le16_to_cpu(rt2x00dev->eeprom[word]);
 867 }
 868
 869 static inline void rt2x00_eeprom_write(struct rt2x00_dev *rt2x00dev,
 870                                        const unsigned int word, u16 data)
 871 {
 872         rt2x00dev->eeprom[word] = cpu_to_le16(data);
 873 }
 874
 875 /*
 876  * Chipset handlers
 877  */
 878 static inline void rt2x00_set_chip(struct rt2x00_dev *rt2x00dev,
 879                                    const u16 rt, const u16 rf, const u32 rev)
 880 {
 881         INFO(rt2x00dev,
 882              "Chipset detected - rt: %04x, rf: %04x, rev: %08x.\n",
 883              rt, rf, rev);
 884
 885         rt2x00dev->chip.rt = rt;
 886         rt2x00dev->chip.rf = rf;
 887         rt2x00dev->chip.rev = rev;
 888 }
 889
 890 static inline void rt2x00_set_chip_rt(struct rt2x00_dev *rt2x00dev,
 891                                       const u16 rt)
 892 {
 893         rt2x00dev->chip.rt = rt;
 894 }
 895
 896 static inline void rt2x00_set_chip_rf(struct rt2x00_dev *rt2x00dev,
 897                                       const u16 rf, const u32 rev)
 898 {
 899         rt2x00_set_chip(rt2x00dev, rt2x00dev->chip.rt, rf, rev);
 900 }
 901
 902 static inline char rt2x00_rt(const struct rt2x00_chip *chipset, const u16 chip)
 903 {
 904         return (chipset->rt == chip);
 905 }
 906
 907 static inline char rt2x00_rf(const struct rt2x00_chip *chipset, const u16 chip)
 908 {
 909         return (chipset->rf == chip);
 910 }
 911
 912 static inline u32 rt2x00_rev(const struct rt2x00_chip *chipset)
 913 {
 914         return chipset->rev;
 915 }
 916
 917 static inline u16 rt2x00_check_rev(const struct rt2x00_chip *chipset,
 918                                    const u32 rev)
 919 {
 920         return (((chipset->rev & 0xffff0) == rev) &&
 921                 !!(chipset->rev & 0x0000f));
 922 }
 923
 924 /**
 925  * rt2x00queue_map_txskb - Map a skb into DMA for TX purposes.
 926  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 927  * @skb: The skb to map.
 928  */
 929 void rt2x00queue_map_txskb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb);
 930
 931 /**
 932  * rt2x00queue_get_queue - Convert queue index to queue pointer
 933  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 934  * @queue: rt2x00 queue index (see &enum data_queue_qid).
 935  */
 936 struct data_queue *rt2x00queue_get_queue(struct rt2x00_dev *rt2x00dev,
 937                                          const enum data_queue_qid queue);
 938
 939 /**
 940  * rt2x00queue_get_entry - Get queue entry where the given index points to.
 941  * @queue: Pointer to &struct data_queue from where we obtain the entry.
 942  * @index: Index identifier for obtaining the correct index.
 943  */
 944 struct queue_entry *rt2x00queue_get_entry(struct data_queue *queue,
 945                                           enum queue_index index);
 946
 947 /*
 948  * Interrupt context handlers.
 949  */
 950 void rt2x00lib_beacondone(struct rt2x00_dev *rt2x00dev);
 951 void rt2x00lib_txdone(struct queue_entry *entry,
 952                       struct txdone_entry_desc *txdesc);
 953 void rt2x00lib_rxdone(struct rt2x00_dev *rt2x00dev,
 954                       struct queue_entry *entry);
 955
 956 /*
 957  * mac80211 handlers.
 958  */
 959 int rt2x00mac_tx(struct ieee80211_hw *hw, struct sk_buff *skb);
 960 int rt2x00mac_start(struct ieee80211_hw *hw);
 961 void rt2x00mac_stop(struct ieee80211_hw *hw);
 962 int rt2x00mac_add_interface(struct ieee80211_hw *hw,
 963                             struct ieee80211_if_init_conf *conf);
 964 void rt2x00mac_remove_interface(struct ieee80211_hw *hw,
 965                                 struct ieee80211_if_init_conf *conf);
 966 int rt2x00mac_config(struct ieee80211_hw *hw, u32 changed);
 967 void rt2x00mac_configure_filter(struct ieee80211_hw *hw,
 968                                 unsigned int changed_flags,
 969                                 unsigned int *total_flags,
 970                                 int mc_count, struct dev_addr_list *mc_list);
 971 #ifdef CONFIG_RT2X00_LIB_CRYPTO
 972 int rt2x00mac_set_key(struct ieee80211_hw *hw, enum set_key_cmd cmd,
 973                       struct ieee80211_vif *vif, struct ieee80211_sta *sta,
 974                       struct ieee80211_key_conf *key);
 975 #else
 976 #define rt2x00mac_set_key       NULL
 977 #endif /* CONFIG_RT2X00_LIB_CRYPTO */
 978 int rt2x00mac_get_stats(struct ieee80211_hw *hw,
 979                         struct ieee80211_low_level_stats *stats);
 980 int rt2x00mac_get_tx_stats(struct ieee80211_hw *hw,
 981                            struct ieee80211_tx_queue_stats *stats);
 982 void rt2x00mac_bss_info_changed(struct ieee80211_hw *hw,
 983                                 struct ieee80211_vif *vif,
 984                                 struct ieee80211_bss_conf *bss_conf,
 985                                 u32 changes);
 986 int rt2x00mac_conf_tx(struct ieee80211_hw *hw, u16 queue,
 987                       const struct ieee80211_tx_queue_params *params);
 988
 989 /*
 990  * Driver allocation handlers.
 991  */
 992 int rt2x00lib_probe_dev(struct rt2x00_dev *rt2x00dev);
 993 void rt2x00lib_remove_dev(struct rt2x00_dev *rt2x00dev);
 994 #ifdef CONFIG_PM
 995 int rt2x00lib_suspend(struct rt2x00_dev *rt2x00dev, pm_message_t state);
 996 int rt2x00lib_resume(struct rt2x00_dev *rt2x00dev);
 997 #endif /* CONFIG_PM */
 998
 999 #endif /* RT2X00_H */