drivers/net/wireless/rt2x00/rt2x00.h

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