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