drivers/net/wireless/rt2x00/rt2x00.h

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