drivers/net/wireless/rt2x00/rt2x00.h

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