rt2x00.h revision ec9c498991880b387e4783a6eb071ed8d01e45a3
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/interrupt.h> 33#include <linux/skbuff.h> 34#include <linux/workqueue.h> 35#include <linux/firmware.h> 36#include <linux/leds.h> 37#include <linux/mutex.h> 38#include <linux/etherdevice.h> 39#include <linux/input-polldev.h> 40#include <linux/kfifo.h> 41#include <linux/hrtimer.h> 42 43#include <net/mac80211.h> 44 45#include "rt2x00debug.h" 46#include "rt2x00dump.h" 47#include "rt2x00leds.h" 48#include "rt2x00reg.h" 49#include "rt2x00queue.h" 50 51/* 52 * Module information. 53 */ 54#define DRV_VERSION "2.3.0" 55#define DRV_PROJECT "http://rt2x00.serialmonkey.com" 56 57/* Debug definitions. 58 * Debug output has to be enabled during compile time. 59 */ 60#ifdef CONFIG_RT2X00_DEBUG 61#define DEBUG 62#endif /* CONFIG_RT2X00_DEBUG */ 63 64/* Utility printing macros 65 * rt2x00_probe_err is for messages when rt2x00_dev is uninitialized 66 */ 67#define rt2x00_probe_err(fmt, ...) \ 68 printk(KERN_ERR KBUILD_MODNAME ": %s: Error - " fmt, \ 69 __func__, ##__VA_ARGS__) 70#define rt2x00_err(dev, fmt, ...) \ 71 wiphy_err((dev)->hw->wiphy, "%s: Error - " fmt, \ 72 __func__, ##__VA_ARGS__) 73#define rt2x00_warn(dev, fmt, ...) \ 74 wiphy_warn((dev)->hw->wiphy, "%s: Warning - " fmt, \ 75 __func__, ##__VA_ARGS__) 76#define rt2x00_info(dev, fmt, ...) \ 77 wiphy_info((dev)->hw->wiphy, "%s: Info - " fmt, \ 78 __func__, ##__VA_ARGS__) 79 80/* Various debug levels */ 81#define rt2x00_dbg(dev, fmt, ...) \ 82 wiphy_dbg((dev)->hw->wiphy, "%s: Debug - " fmt, \ 83 __func__, ##__VA_ARGS__) 84#define rt2x00_eeprom_dbg(dev, fmt, ...) \ 85 wiphy_dbg((dev)->hw->wiphy, "%s: EEPROM recovery - " fmt, \ 86 __func__, ##__VA_ARGS__) 87 88/* 89 * Duration calculations 90 * The rate variable passed is: 100kbs. 91 * To convert from bytes to bits we multiply size with 8, 92 * then the size is multiplied with 10 to make the 93 * real rate -> rate argument correction. 94 */ 95#define GET_DURATION(__size, __rate) (((__size) * 8 * 10) / (__rate)) 96#define GET_DURATION_RES(__size, __rate)(((__size) * 8 * 10) % (__rate)) 97 98/* 99 * Determine the number of L2 padding bytes required between the header and 100 * the payload. 101 */ 102#define L2PAD_SIZE(__hdrlen) (-(__hdrlen) & 3) 103 104/* 105 * Determine the alignment requirement, 106 * to make sure the 802.11 payload is padded to a 4-byte boundrary 107 * we must determine the address of the payload and calculate the 108 * amount of bytes needed to move the data. 109 */ 110#define ALIGN_SIZE(__skb, __header) \ 111 ( ((unsigned long)((__skb)->data + (__header))) & 3 ) 112 113/* 114 * Constants for extra TX headroom for alignment purposes. 115 */ 116#define RT2X00_ALIGN_SIZE 4 /* Only whole frame needs alignment */ 117#define RT2X00_L2PAD_SIZE 8 /* Both header & payload need alignment */ 118 119/* 120 * Standard timing and size defines. 121 * These values should follow the ieee80211 specifications. 122 */ 123#define ACK_SIZE 14 124#define IEEE80211_HEADER 24 125#define PLCP 48 126#define BEACON 100 127#define PREAMBLE 144 128#define SHORT_PREAMBLE 72 129#define SLOT_TIME 20 130#define SHORT_SLOT_TIME 9 131#define SIFS 10 132#define PIFS ( SIFS + SLOT_TIME ) 133#define SHORT_PIFS ( SIFS + SHORT_SLOT_TIME ) 134#define DIFS ( PIFS + SLOT_TIME ) 135#define SHORT_DIFS ( SHORT_PIFS + SHORT_SLOT_TIME ) 136#define EIFS ( SIFS + DIFS + \ 137 GET_DURATION(IEEE80211_HEADER + ACK_SIZE, 10) ) 138#define SHORT_EIFS ( SIFS + SHORT_DIFS + \ 139 GET_DURATION(IEEE80211_HEADER + ACK_SIZE, 10) ) 140 141/* 142 * Structure for average calculation 143 * The avg field contains the actual average value, 144 * but avg_weight is internally used during calculations 145 * to prevent rounding errors. 146 */ 147struct avg_val { 148 int avg; 149 int avg_weight; 150}; 151 152enum rt2x00_chip_intf { 153 RT2X00_CHIP_INTF_PCI, 154 RT2X00_CHIP_INTF_PCIE, 155 RT2X00_CHIP_INTF_USB, 156 RT2X00_CHIP_INTF_SOC, 157}; 158 159/* 160 * Chipset identification 161 * The chipset on the device is composed of a RT and RF chip. 162 * The chipset combination is important for determining device capabilities. 163 */ 164struct rt2x00_chip { 165 u16 rt; 166#define RT2460 0x2460 167#define RT2560 0x2560 168#define RT2570 0x2570 169#define RT2661 0x2661 170#define RT2573 0x2573 171#define RT2860 0x2860 /* 2.4GHz */ 172#define RT2872 0x2872 /* WSOC */ 173#define RT2883 0x2883 /* WSOC */ 174#define RT3070 0x3070 175#define RT3071 0x3071 176#define RT3090 0x3090 /* 2.4GHz PCIe */ 177#define RT3290 0x3290 178#define RT3352 0x3352 /* WSOC */ 179#define RT3390 0x3390 180#define RT3572 0x3572 181#define RT3593 0x3593 182#define RT3883 0x3883 /* WSOC */ 183#define RT5390 0x5390 /* 2.4GHz */ 184#define RT5392 0x5392 /* 2.4GHz */ 185#define RT5592 0x5592 186 187 u16 rf; 188 u16 rev; 189 190 enum rt2x00_chip_intf intf; 191}; 192 193/* 194 * RF register values that belong to a particular channel. 195 */ 196struct rf_channel { 197 int channel; 198 u32 rf1; 199 u32 rf2; 200 u32 rf3; 201 u32 rf4; 202}; 203 204/* 205 * Channel information structure 206 */ 207struct channel_info { 208 unsigned int flags; 209#define GEOGRAPHY_ALLOWED 0x00000001 210 211 short max_power; 212 short default_power1; 213 short default_power2; 214}; 215 216/* 217 * Antenna setup values. 218 */ 219struct antenna_setup { 220 enum antenna rx; 221 enum antenna tx; 222 u8 rx_chain_num; 223 u8 tx_chain_num; 224}; 225 226/* 227 * Quality statistics about the currently active link. 228 */ 229struct link_qual { 230 /* 231 * Statistics required for Link tuning by driver 232 * The rssi value is provided by rt2x00lib during the 233 * link_tuner() callback function. 234 * The false_cca field is filled during the link_stats() 235 * callback function and could be used during the 236 * link_tuner() callback function. 237 */ 238 int rssi; 239 int false_cca; 240 241 /* 242 * VGC levels 243 * Hardware driver will tune the VGC level during each call 244 * to the link_tuner() callback function. This vgc_level is 245 * is determined based on the link quality statistics like 246 * average RSSI and the false CCA count. 247 * 248 * In some cases the drivers need to differentiate between 249 * the currently "desired" VGC level and the level configured 250 * in the hardware. The latter is important to reduce the 251 * number of BBP register reads to reduce register access 252 * overhead. For this reason we store both values here. 253 */ 254 u8 vgc_level; 255 u8 vgc_level_reg; 256 257 /* 258 * Statistics required for Signal quality calculation. 259 * These fields might be changed during the link_stats() 260 * callback function. 261 */ 262 int rx_success; 263 int rx_failed; 264 int tx_success; 265 int tx_failed; 266}; 267 268/* 269 * Antenna settings about the currently active link. 270 */ 271struct link_ant { 272 /* 273 * Antenna flags 274 */ 275 unsigned int flags; 276#define ANTENNA_RX_DIVERSITY 0x00000001 277#define ANTENNA_TX_DIVERSITY 0x00000002 278#define ANTENNA_MODE_SAMPLE 0x00000004 279 280 /* 281 * Currently active TX/RX antenna setup. 282 * When software diversity is used, this will indicate 283 * which antenna is actually used at this time. 284 */ 285 struct antenna_setup active; 286 287 /* 288 * RSSI history information for the antenna. 289 * Used to determine when to switch antenna 290 * when using software diversity. 291 */ 292 int rssi_history; 293 294 /* 295 * Current RSSI average of the currently active antenna. 296 * Similar to the avg_rssi in the link_qual structure 297 * this value is updated by using the walking average. 298 */ 299 struct avg_val rssi_ant; 300}; 301 302/* 303 * To optimize the quality of the link we need to store 304 * the quality of received frames and periodically 305 * optimize the link. 306 */ 307struct link { 308 /* 309 * Link tuner counter 310 * The number of times the link has been tuned 311 * since the radio has been switched on. 312 */ 313 u32 count; 314 315 /* 316 * Quality measurement values. 317 */ 318 struct link_qual qual; 319 320 /* 321 * TX/RX antenna setup. 322 */ 323 struct link_ant ant; 324 325 /* 326 * Currently active average RSSI value 327 */ 328 struct avg_val avg_rssi; 329 330 /* 331 * Work structure for scheduling periodic link tuning. 332 */ 333 struct delayed_work work; 334 335 /* 336 * Work structure for scheduling periodic watchdog monitoring. 337 * This work must be scheduled on the kernel workqueue, while 338 * all other work structures must be queued on the mac80211 339 * workqueue. This guarantees that the watchdog can schedule 340 * other work structures and wait for their completion in order 341 * to bring the device/driver back into the desired state. 342 */ 343 struct delayed_work watchdog_work; 344 345 /* 346 * Work structure for scheduling periodic AGC adjustments. 347 */ 348 struct delayed_work agc_work; 349 350 /* 351 * Work structure for scheduling periodic VCO calibration. 352 */ 353 struct delayed_work vco_work; 354}; 355 356enum rt2x00_delayed_flags { 357 DELAYED_UPDATE_BEACON, 358}; 359 360/* 361 * Interface structure 362 * Per interface configuration details, this structure 363 * is allocated as the private data for ieee80211_vif. 364 */ 365struct rt2x00_intf { 366 /* 367 * beacon->skb must be protected with the mutex. 368 */ 369 struct mutex beacon_skb_mutex; 370 371 /* 372 * Entry in the beacon queue which belongs to 373 * this interface. Each interface has its own 374 * dedicated beacon entry. 375 */ 376 struct queue_entry *beacon; 377 bool enable_beacon; 378 379 /* 380 * Actions that needed rescheduling. 381 */ 382 unsigned long delayed_flags; 383 384 /* 385 * Software sequence counter, this is only required 386 * for hardware which doesn't support hardware 387 * sequence counting. 388 */ 389 atomic_t seqno; 390}; 391 392static 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 */ 412struct 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 */ 435struct 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 */ 445struct 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 u16 ht_opmode; 460}; 461 462/* 463 * Configuration structure for hardware encryption. 464 */ 465struct rt2x00lib_crypto { 466 enum cipher cipher; 467 468 enum set_key_cmd cmd; 469 const u8 *address; 470 471 u32 bssidx; 472 473 u8 key[16]; 474 u8 tx_mic[8]; 475 u8 rx_mic[8]; 476 477 int wcid; 478}; 479 480/* 481 * Configuration structure wrapper around the 482 * rt2x00 interface configuration handler. 483 */ 484struct rt2x00intf_conf { 485 /* 486 * Interface type 487 */ 488 enum nl80211_iftype type; 489 490 /* 491 * TSF sync value, this is dependent on the operation type. 492 */ 493 enum tsf_sync sync; 494 495 /* 496 * The MAC and BSSID addresses are simple array of bytes, 497 * these arrays are little endian, so when sending the addresses 498 * to the drivers, copy the it into a endian-signed variable. 499 * 500 * Note that all devices (except rt2500usb) have 32 bits 501 * register word sizes. This means that whatever variable we 502 * pass _must_ be a multiple of 32 bits. Otherwise the device 503 * might not accept what we are sending to it. 504 * This will also make it easier for the driver to write 505 * the data to the device. 506 */ 507 __le32 mac[2]; 508 __le32 bssid[2]; 509}; 510 511/* 512 * Private structure for storing STA details 513 * wcid: Wireless Client ID 514 */ 515struct rt2x00_sta { 516 int wcid; 517}; 518 519static inline struct rt2x00_sta* sta_to_rt2x00_sta(struct ieee80211_sta *sta) 520{ 521 return (struct rt2x00_sta *)sta->drv_priv; 522} 523 524/* 525 * rt2x00lib callback functions. 526 */ 527struct rt2x00lib_ops { 528 /* 529 * Interrupt handlers. 530 */ 531 irq_handler_t irq_handler; 532 533 /* 534 * TX status tasklet handler. 535 */ 536 void (*txstatus_tasklet) (unsigned long data); 537 void (*pretbtt_tasklet) (unsigned long data); 538 void (*tbtt_tasklet) (unsigned long data); 539 void (*rxdone_tasklet) (unsigned long data); 540 void (*autowake_tasklet) (unsigned long data); 541 542 /* 543 * Device init handlers. 544 */ 545 int (*probe_hw) (struct rt2x00_dev *rt2x00dev); 546 char *(*get_firmware_name) (struct rt2x00_dev *rt2x00dev); 547 int (*check_firmware) (struct rt2x00_dev *rt2x00dev, 548 const u8 *data, const size_t len); 549 int (*load_firmware) (struct rt2x00_dev *rt2x00dev, 550 const u8 *data, const size_t len); 551 552 /* 553 * Device initialization/deinitialization handlers. 554 */ 555 int (*initialize) (struct rt2x00_dev *rt2x00dev); 556 void (*uninitialize) (struct rt2x00_dev *rt2x00dev); 557 558 /* 559 * queue initialization handlers 560 */ 561 bool (*get_entry_state) (struct queue_entry *entry); 562 void (*clear_entry) (struct queue_entry *entry); 563 564 /* 565 * Radio control handlers. 566 */ 567 int (*set_device_state) (struct rt2x00_dev *rt2x00dev, 568 enum dev_state state); 569 int (*rfkill_poll) (struct rt2x00_dev *rt2x00dev); 570 void (*link_stats) (struct rt2x00_dev *rt2x00dev, 571 struct link_qual *qual); 572 void (*reset_tuner) (struct rt2x00_dev *rt2x00dev, 573 struct link_qual *qual); 574 void (*link_tuner) (struct rt2x00_dev *rt2x00dev, 575 struct link_qual *qual, const u32 count); 576 void (*gain_calibration) (struct rt2x00_dev *rt2x00dev); 577 void (*vco_calibration) (struct rt2x00_dev *rt2x00dev); 578 579 /* 580 * Data queue handlers. 581 */ 582 void (*watchdog) (struct rt2x00_dev *rt2x00dev); 583 void (*start_queue) (struct data_queue *queue); 584 void (*kick_queue) (struct data_queue *queue); 585 void (*stop_queue) (struct data_queue *queue); 586 void (*flush_queue) (struct data_queue *queue, bool drop); 587 void (*tx_dma_done) (struct queue_entry *entry); 588 589 /* 590 * TX control handlers 591 */ 592 void (*write_tx_desc) (struct queue_entry *entry, 593 struct txentry_desc *txdesc); 594 void (*write_tx_data) (struct queue_entry *entry, 595 struct txentry_desc *txdesc); 596 void (*write_beacon) (struct queue_entry *entry, 597 struct txentry_desc *txdesc); 598 void (*clear_beacon) (struct queue_entry *entry); 599 int (*get_tx_data_len) (struct queue_entry *entry); 600 601 /* 602 * RX control handlers 603 */ 604 void (*fill_rxdone) (struct queue_entry *entry, 605 struct rxdone_entry_desc *rxdesc); 606 607 /* 608 * Configuration handlers. 609 */ 610 int (*config_shared_key) (struct rt2x00_dev *rt2x00dev, 611 struct rt2x00lib_crypto *crypto, 612 struct ieee80211_key_conf *key); 613 int (*config_pairwise_key) (struct rt2x00_dev *rt2x00dev, 614 struct rt2x00lib_crypto *crypto, 615 struct ieee80211_key_conf *key); 616 void (*config_filter) (struct rt2x00_dev *rt2x00dev, 617 const unsigned int filter_flags); 618 void (*config_intf) (struct rt2x00_dev *rt2x00dev, 619 struct rt2x00_intf *intf, 620 struct rt2x00intf_conf *conf, 621 const unsigned int flags); 622#define CONFIG_UPDATE_TYPE ( 1 << 1 ) 623#define CONFIG_UPDATE_MAC ( 1 << 2 ) 624#define CONFIG_UPDATE_BSSID ( 1 << 3 ) 625 626 void (*config_erp) (struct rt2x00_dev *rt2x00dev, 627 struct rt2x00lib_erp *erp, 628 u32 changed); 629 void (*config_ant) (struct rt2x00_dev *rt2x00dev, 630 struct antenna_setup *ant); 631 void (*config) (struct rt2x00_dev *rt2x00dev, 632 struct rt2x00lib_conf *libconf, 633 const unsigned int changed_flags); 634 int (*sta_add) (struct rt2x00_dev *rt2x00dev, 635 struct ieee80211_vif *vif, 636 struct ieee80211_sta *sta); 637 int (*sta_remove) (struct rt2x00_dev *rt2x00dev, 638 int wcid); 639}; 640 641/* 642 * rt2x00 driver callback operation structure. 643 */ 644struct rt2x00_ops { 645 const char *name; 646 const unsigned int drv_data_size; 647 const unsigned int max_ap_intf; 648 const unsigned int eeprom_size; 649 const unsigned int rf_size; 650 const unsigned int tx_queues; 651 const unsigned int extra_tx_headroom; 652 const struct data_queue_desc *rx; 653 const struct data_queue_desc *tx; 654 const struct data_queue_desc *bcn; 655 const struct data_queue_desc *atim; 656 const struct rt2x00lib_ops *lib; 657 const void *drv; 658 const struct ieee80211_ops *hw; 659#ifdef CONFIG_RT2X00_LIB_DEBUGFS 660 const struct rt2x00debug *debugfs; 661#endif /* CONFIG_RT2X00_LIB_DEBUGFS */ 662}; 663 664/* 665 * rt2x00 state flags 666 */ 667enum rt2x00_state_flags { 668 /* 669 * Device flags 670 */ 671 DEVICE_STATE_PRESENT, 672 DEVICE_STATE_REGISTERED_HW, 673 DEVICE_STATE_INITIALIZED, 674 DEVICE_STATE_STARTED, 675 DEVICE_STATE_ENABLED_RADIO, 676 DEVICE_STATE_SCANNING, 677 678 /* 679 * Driver configuration 680 */ 681 CONFIG_CHANNEL_HT40, 682 CONFIG_POWERSAVING, 683 CONFIG_HT_DISABLED, 684 CONFIG_QOS_DISABLED, 685 686 /* 687 * Mark we currently are sequentially reading TX_STA_FIFO register 688 * FIXME: this is for only rt2800usb, should go to private data 689 */ 690 TX_STATUS_READING, 691}; 692 693/* 694 * rt2x00 capability flags 695 */ 696enum rt2x00_capability_flags { 697 /* 698 * Requirements 699 */ 700 REQUIRE_FIRMWARE, 701 REQUIRE_BEACON_GUARD, 702 REQUIRE_ATIM_QUEUE, 703 REQUIRE_DMA, 704 REQUIRE_COPY_IV, 705 REQUIRE_L2PAD, 706 REQUIRE_TXSTATUS_FIFO, 707 REQUIRE_TASKLET_CONTEXT, 708 REQUIRE_SW_SEQNO, 709 REQUIRE_HT_TX_DESC, 710 REQUIRE_PS_AUTOWAKE, 711 712 /* 713 * Capabilities 714 */ 715 CAPABILITY_HW_BUTTON, 716 CAPABILITY_HW_CRYPTO, 717 CAPABILITY_POWER_LIMIT, 718 CAPABILITY_CONTROL_FILTERS, 719 CAPABILITY_CONTROL_FILTER_PSPOLL, 720 CAPABILITY_PRE_TBTT_INTERRUPT, 721 CAPABILITY_LINK_TUNING, 722 CAPABILITY_FRAME_TYPE, 723 CAPABILITY_RF_SEQUENCE, 724 CAPABILITY_EXTERNAL_LNA_A, 725 CAPABILITY_EXTERNAL_LNA_BG, 726 CAPABILITY_DOUBLE_ANTENNA, 727 CAPABILITY_BT_COEXIST, 728 CAPABILITY_VCO_RECALIBRATION, 729}; 730 731/* 732 * Interface combinations 733 */ 734enum { 735 IF_COMB_AP = 0, 736 NUM_IF_COMB, 737}; 738 739/* 740 * rt2x00 device structure. 741 */ 742struct rt2x00_dev { 743 /* 744 * Device structure. 745 * The structure stored in here depends on the 746 * system bus (PCI or USB). 747 * When accessing this variable, the rt2x00dev_{pci,usb} 748 * macros should be used for correct typecasting. 749 */ 750 struct device *dev; 751 752 /* 753 * Callback functions. 754 */ 755 const struct rt2x00_ops *ops; 756 757 /* 758 * Driver data. 759 */ 760 void *drv_data; 761 762 /* 763 * IEEE80211 control structure. 764 */ 765 struct ieee80211_hw *hw; 766 struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS]; 767 enum ieee80211_band curr_band; 768 int curr_freq; 769 770 /* 771 * If enabled, the debugfs interface structures 772 * required for deregistration of debugfs. 773 */ 774#ifdef CONFIG_RT2X00_LIB_DEBUGFS 775 struct rt2x00debug_intf *debugfs_intf; 776#endif /* CONFIG_RT2X00_LIB_DEBUGFS */ 777 778 /* 779 * LED structure for changing the LED status 780 * by mac8011 or the kernel. 781 */ 782#ifdef CONFIG_RT2X00_LIB_LEDS 783 struct rt2x00_led led_radio; 784 struct rt2x00_led led_assoc; 785 struct rt2x00_led led_qual; 786 u16 led_mcu_reg; 787#endif /* CONFIG_RT2X00_LIB_LEDS */ 788 789 /* 790 * Device state flags. 791 * In these flags the current status is stored. 792 * Access to these flags should occur atomically. 793 */ 794 unsigned long flags; 795 796 /* 797 * Device capabiltiy flags. 798 * In these flags the device/driver capabilities are stored. 799 * Access to these flags should occur non-atomically. 800 */ 801 unsigned long cap_flags; 802 803 /* 804 * Device information, Bus IRQ and name (PCI, SoC) 805 */ 806 int irq; 807 const char *name; 808 809 /* 810 * Chipset identification. 811 */ 812 struct rt2x00_chip chip; 813 814 /* 815 * hw capability specifications. 816 */ 817 struct hw_mode_spec spec; 818 819 /* 820 * This is the default TX/RX antenna setup as indicated 821 * by the device's EEPROM. 822 */ 823 struct antenna_setup default_ant; 824 825 /* 826 * Register pointers 827 * csr.base: CSR base register address. (PCI) 828 * csr.cache: CSR cache for usb_control_msg. (USB) 829 */ 830 union csr { 831 void __iomem *base; 832 void *cache; 833 } csr; 834 835 /* 836 * Mutex to protect register accesses. 837 * For PCI and USB devices it protects against concurrent indirect 838 * register access (BBP, RF, MCU) since accessing those 839 * registers require multiple calls to the CSR registers. 840 * For USB devices it also protects the csr_cache since that 841 * field is used for normal CSR access and it cannot support 842 * multiple callers simultaneously. 843 */ 844 struct mutex csr_mutex; 845 846 /* 847 * Current packet filter configuration for the device. 848 * This contains all currently active FIF_* flags send 849 * to us by mac80211 during configure_filter(). 850 */ 851 unsigned int packet_filter; 852 853 /* 854 * Interface details: 855 * - Open ap interface count. 856 * - Open sta interface count. 857 * - Association count. 858 * - Beaconing enabled count. 859 */ 860 unsigned int intf_ap_count; 861 unsigned int intf_sta_count; 862 unsigned int intf_associated; 863 unsigned int intf_beaconing; 864 865 /* 866 * Interface combinations 867 */ 868 struct ieee80211_iface_limit if_limits_ap; 869 struct ieee80211_iface_combination if_combinations[NUM_IF_COMB]; 870 871 /* 872 * Link quality 873 */ 874 struct link link; 875 876 /* 877 * EEPROM data. 878 */ 879 __le16 *eeprom; 880 881 /* 882 * Active RF register values. 883 * These are stored here so we don't need 884 * to read the rf registers and can directly 885 * use this value instead. 886 * This field should be accessed by using 887 * rt2x00_rf_read() and rt2x00_rf_write(). 888 */ 889 u32 *rf; 890 891 /* 892 * LNA gain 893 */ 894 short lna_gain; 895 896 /* 897 * Current TX power value. 898 */ 899 u16 tx_power; 900 901 /* 902 * Current retry values. 903 */ 904 u8 short_retry; 905 u8 long_retry; 906 907 /* 908 * Rssi <-> Dbm offset 909 */ 910 u8 rssi_offset; 911 912 /* 913 * Frequency offset. 914 */ 915 u8 freq_offset; 916 917 /* 918 * Association id. 919 */ 920 u16 aid; 921 922 /* 923 * Beacon interval. 924 */ 925 u16 beacon_int; 926 927 /** 928 * Timestamp of last received beacon 929 */ 930 unsigned long last_beacon; 931 932 /* 933 * Low level statistics which will have 934 * to be kept up to date while device is running. 935 */ 936 struct ieee80211_low_level_stats low_level_stats; 937 938 /** 939 * Work queue for all work which should not be placed 940 * on the mac80211 workqueue (because of dependencies 941 * between various work structures). 942 */ 943 struct workqueue_struct *workqueue; 944 945 /* 946 * Scheduled work. 947 * NOTE: intf_work will use ieee80211_iterate_active_interfaces() 948 * which means it cannot be placed on the hw->workqueue 949 * due to RTNL locking requirements. 950 */ 951 struct work_struct intf_work; 952 953 /** 954 * Scheduled work for TX/RX done handling (USB devices) 955 */ 956 struct work_struct rxdone_work; 957 struct work_struct txdone_work; 958 959 /* 960 * Powersaving work 961 */ 962 struct delayed_work autowakeup_work; 963 struct work_struct sleep_work; 964 965 /* 966 * Data queue arrays for RX, TX, Beacon and ATIM. 967 */ 968 unsigned int data_queues; 969 struct data_queue *rx; 970 struct data_queue *tx; 971 struct data_queue *bcn; 972 struct data_queue *atim; 973 974 /* 975 * Firmware image. 976 */ 977 const struct firmware *fw; 978 979 /* 980 * FIFO for storing tx status reports between isr and tasklet. 981 */ 982 DECLARE_KFIFO_PTR(txstatus_fifo, u32); 983 984 /* 985 * Timer to ensure tx status reports are read (rt2800usb). 986 */ 987 struct hrtimer txstatus_timer; 988 989 /* 990 * Tasklet for processing tx status reports (rt2800pci). 991 */ 992 struct tasklet_struct txstatus_tasklet; 993 struct tasklet_struct pretbtt_tasklet; 994 struct tasklet_struct tbtt_tasklet; 995 struct tasklet_struct rxdone_tasklet; 996 struct tasklet_struct autowake_tasklet; 997 998 /* 999 * Used for VCO periodic calibration. 1000 */ 1001 int rf_channel; 1002 1003 /* 1004 * Protect the interrupt mask register. 1005 */ 1006 spinlock_t irqmask_lock; 1007 1008 /* 1009 * List of BlockAckReq TX entries that need driver BlockAck processing. 1010 */ 1011 struct list_head bar_list; 1012 spinlock_t bar_list_lock; 1013}; 1014 1015struct rt2x00_bar_list_entry { 1016 struct list_head list; 1017 struct rcu_head head; 1018 1019 struct queue_entry *entry; 1020 int block_acked; 1021 1022 /* Relevant parts of the IEEE80211 BAR header */ 1023 __u8 ra[6]; 1024 __u8 ta[6]; 1025 __le16 control; 1026 __le16 start_seq_num; 1027}; 1028 1029/* 1030 * Register defines. 1031 * Some registers require multiple attempts before success, 1032 * in those cases REGISTER_BUSY_COUNT attempts should be 1033 * taken with a REGISTER_BUSY_DELAY interval. 1034 */ 1035#define REGISTER_BUSY_COUNT 100 1036#define REGISTER_BUSY_DELAY 100 1037 1038/* 1039 * Generic RF access. 1040 * The RF is being accessed by word index. 1041 */ 1042static inline void rt2x00_rf_read(struct rt2x00_dev *rt2x00dev, 1043 const unsigned int word, u32 *data) 1044{ 1045 BUG_ON(word < 1 || word > rt2x00dev->ops->rf_size / sizeof(u32)); 1046 *data = rt2x00dev->rf[word - 1]; 1047} 1048 1049static inline void rt2x00_rf_write(struct rt2x00_dev *rt2x00dev, 1050 const unsigned int word, u32 data) 1051{ 1052 BUG_ON(word < 1 || word > rt2x00dev->ops->rf_size / sizeof(u32)); 1053 rt2x00dev->rf[word - 1] = data; 1054} 1055 1056/* 1057 * Generic EEPROM access. The EEPROM is being accessed by word or byte index. 1058 */ 1059static inline void *rt2x00_eeprom_addr(struct rt2x00_dev *rt2x00dev, 1060 const unsigned int word) 1061{ 1062 return (void *)&rt2x00dev->eeprom[word]; 1063} 1064 1065static inline void rt2x00_eeprom_read(struct rt2x00_dev *rt2x00dev, 1066 const unsigned int word, u16 *data) 1067{ 1068 *data = le16_to_cpu(rt2x00dev->eeprom[word]); 1069} 1070 1071static inline void rt2x00_eeprom_write(struct rt2x00_dev *rt2x00dev, 1072 const unsigned int word, u16 data) 1073{ 1074 rt2x00dev->eeprom[word] = cpu_to_le16(data); 1075} 1076 1077static inline u8 rt2x00_eeprom_byte(struct rt2x00_dev *rt2x00dev, 1078 const unsigned int byte) 1079{ 1080 return *(((u8 *)rt2x00dev->eeprom) + byte); 1081} 1082 1083/* 1084 * Chipset handlers 1085 */ 1086static inline void rt2x00_set_chip(struct rt2x00_dev *rt2x00dev, 1087 const u16 rt, const u16 rf, const u16 rev) 1088{ 1089 rt2x00dev->chip.rt = rt; 1090 rt2x00dev->chip.rf = rf; 1091 rt2x00dev->chip.rev = rev; 1092 1093 rt2x00_info(rt2x00dev, "Chipset detected - rt: %04x, rf: %04x, rev: %04x\n", 1094 rt2x00dev->chip.rt, rt2x00dev->chip.rf, 1095 rt2x00dev->chip.rev); 1096} 1097 1098static inline void rt2x00_set_rt(struct rt2x00_dev *rt2x00dev, 1099 const u16 rt, const u16 rev) 1100{ 1101 rt2x00dev->chip.rt = rt; 1102 rt2x00dev->chip.rev = rev; 1103 1104 rt2x00_info(rt2x00dev, "RT chipset %04x, rev %04x detected\n", 1105 rt2x00dev->chip.rt, rt2x00dev->chip.rev); 1106} 1107 1108static inline void rt2x00_set_rf(struct rt2x00_dev *rt2x00dev, const u16 rf) 1109{ 1110 rt2x00dev->chip.rf = rf; 1111 1112 rt2x00_info(rt2x00dev, "RF chipset %04x detected\n", 1113 rt2x00dev->chip.rf); 1114} 1115 1116static inline bool rt2x00_rt(struct rt2x00_dev *rt2x00dev, const u16 rt) 1117{ 1118 return (rt2x00dev->chip.rt == rt); 1119} 1120 1121static inline bool rt2x00_rf(struct rt2x00_dev *rt2x00dev, const u16 rf) 1122{ 1123 return (rt2x00dev->chip.rf == rf); 1124} 1125 1126static inline u16 rt2x00_rev(struct rt2x00_dev *rt2x00dev) 1127{ 1128 return rt2x00dev->chip.rev; 1129} 1130 1131static inline bool rt2x00_rt_rev(struct rt2x00_dev *rt2x00dev, 1132 const u16 rt, const u16 rev) 1133{ 1134 return (rt2x00_rt(rt2x00dev, rt) && rt2x00_rev(rt2x00dev) == rev); 1135} 1136 1137static inline bool rt2x00_rt_rev_lt(struct rt2x00_dev *rt2x00dev, 1138 const u16 rt, const u16 rev) 1139{ 1140 return (rt2x00_rt(rt2x00dev, rt) && rt2x00_rev(rt2x00dev) < rev); 1141} 1142 1143static inline bool rt2x00_rt_rev_gte(struct rt2x00_dev *rt2x00dev, 1144 const u16 rt, const u16 rev) 1145{ 1146 return (rt2x00_rt(rt2x00dev, rt) && rt2x00_rev(rt2x00dev) >= rev); 1147} 1148 1149static inline void rt2x00_set_chip_intf(struct rt2x00_dev *rt2x00dev, 1150 enum rt2x00_chip_intf intf) 1151{ 1152 rt2x00dev->chip.intf = intf; 1153} 1154 1155static inline bool rt2x00_intf(struct rt2x00_dev *rt2x00dev, 1156 enum rt2x00_chip_intf intf) 1157{ 1158 return (rt2x00dev->chip.intf == intf); 1159} 1160 1161static inline bool rt2x00_is_pci(struct rt2x00_dev *rt2x00dev) 1162{ 1163 return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCI) || 1164 rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCIE); 1165} 1166 1167static inline bool rt2x00_is_pcie(struct rt2x00_dev *rt2x00dev) 1168{ 1169 return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCIE); 1170} 1171 1172static inline bool rt2x00_is_usb(struct rt2x00_dev *rt2x00dev) 1173{ 1174 return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_USB); 1175} 1176 1177static inline bool rt2x00_is_soc(struct rt2x00_dev *rt2x00dev) 1178{ 1179 return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_SOC); 1180} 1181 1182/** 1183 * rt2x00queue_map_txskb - Map a skb into DMA for TX purposes. 1184 * @entry: Pointer to &struct queue_entry 1185 * 1186 * Returns -ENOMEM if mapping fail, 0 otherwise. 1187 */ 1188int rt2x00queue_map_txskb(struct queue_entry *entry); 1189 1190/** 1191 * rt2x00queue_unmap_skb - Unmap a skb from DMA. 1192 * @entry: Pointer to &struct queue_entry 1193 */ 1194void rt2x00queue_unmap_skb(struct queue_entry *entry); 1195 1196/** 1197 * rt2x00queue_get_tx_queue - Convert tx queue index to queue pointer 1198 * @rt2x00dev: Pointer to &struct rt2x00_dev. 1199 * @queue: rt2x00 queue index (see &enum data_queue_qid). 1200 * 1201 * Returns NULL for non tx queues. 1202 */ 1203static inline struct data_queue * 1204rt2x00queue_get_tx_queue(struct rt2x00_dev *rt2x00dev, 1205 const enum data_queue_qid queue) 1206{ 1207 if (queue < rt2x00dev->ops->tx_queues && rt2x00dev->tx) 1208 return &rt2x00dev->tx[queue]; 1209 1210 if (queue == QID_ATIM) 1211 return rt2x00dev->atim; 1212 1213 return NULL; 1214} 1215 1216/** 1217 * rt2x00queue_get_entry - Get queue entry where the given index points to. 1218 * @queue: Pointer to &struct data_queue from where we obtain the entry. 1219 * @index: Index identifier for obtaining the correct index. 1220 */ 1221struct queue_entry *rt2x00queue_get_entry(struct data_queue *queue, 1222 enum queue_index index); 1223 1224/** 1225 * rt2x00queue_pause_queue - Pause a data queue 1226 * @queue: Pointer to &struct data_queue. 1227 * 1228 * This function will pause the data queue locally, preventing 1229 * new frames to be added to the queue (while the hardware is 1230 * still allowed to run). 1231 */ 1232void rt2x00queue_pause_queue(struct data_queue *queue); 1233 1234/** 1235 * rt2x00queue_unpause_queue - unpause a data queue 1236 * @queue: Pointer to &struct data_queue. 1237 * 1238 * This function will unpause the data queue locally, allowing 1239 * new frames to be added to the queue again. 1240 */ 1241void rt2x00queue_unpause_queue(struct data_queue *queue); 1242 1243/** 1244 * rt2x00queue_start_queue - Start a data queue 1245 * @queue: Pointer to &struct data_queue. 1246 * 1247 * This function will start handling all pending frames in the queue. 1248 */ 1249void rt2x00queue_start_queue(struct data_queue *queue); 1250 1251/** 1252 * rt2x00queue_stop_queue - Halt a data queue 1253 * @queue: Pointer to &struct data_queue. 1254 * 1255 * This function will stop all pending frames in the queue. 1256 */ 1257void rt2x00queue_stop_queue(struct data_queue *queue); 1258 1259/** 1260 * rt2x00queue_flush_queue - Flush a data queue 1261 * @queue: Pointer to &struct data_queue. 1262 * @drop: True to drop all pending frames. 1263 * 1264 * This function will flush the queue. After this call 1265 * the queue is guaranteed to be empty. 1266 */ 1267void rt2x00queue_flush_queue(struct data_queue *queue, bool drop); 1268 1269/** 1270 * rt2x00queue_start_queues - Start all data queues 1271 * @rt2x00dev: Pointer to &struct rt2x00_dev. 1272 * 1273 * This function will loop through all available queues to start them 1274 */ 1275void rt2x00queue_start_queues(struct rt2x00_dev *rt2x00dev); 1276 1277/** 1278 * rt2x00queue_stop_queues - Halt all data queues 1279 * @rt2x00dev: Pointer to &struct rt2x00_dev. 1280 * 1281 * This function will loop through all available queues to stop 1282 * any pending frames. 1283 */ 1284void rt2x00queue_stop_queues(struct rt2x00_dev *rt2x00dev); 1285 1286/** 1287 * rt2x00queue_flush_queues - Flush all data queues 1288 * @rt2x00dev: Pointer to &struct rt2x00_dev. 1289 * @drop: True to drop all pending frames. 1290 * 1291 * This function will loop through all available queues to flush 1292 * any pending frames. 1293 */ 1294void rt2x00queue_flush_queues(struct rt2x00_dev *rt2x00dev, bool drop); 1295 1296/* 1297 * Debugfs handlers. 1298 */ 1299/** 1300 * rt2x00debug_dump_frame - Dump a frame to userspace through debugfs. 1301 * @rt2x00dev: Pointer to &struct rt2x00_dev. 1302 * @type: The type of frame that is being dumped. 1303 * @skb: The skb containing the frame to be dumped. 1304 */ 1305#ifdef CONFIG_RT2X00_LIB_DEBUGFS 1306void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev, 1307 enum rt2x00_dump_type type, struct sk_buff *skb); 1308#else 1309static inline void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev, 1310 enum rt2x00_dump_type type, 1311 struct sk_buff *skb) 1312{ 1313} 1314#endif /* CONFIG_RT2X00_LIB_DEBUGFS */ 1315 1316/* 1317 * Utility functions. 1318 */ 1319u32 rt2x00lib_get_bssidx(struct rt2x00_dev *rt2x00dev, 1320 struct ieee80211_vif *vif); 1321 1322/* 1323 * Interrupt context handlers. 1324 */ 1325void rt2x00lib_beacondone(struct rt2x00_dev *rt2x00dev); 1326void rt2x00lib_pretbtt(struct rt2x00_dev *rt2x00dev); 1327void rt2x00lib_dmastart(struct queue_entry *entry); 1328void rt2x00lib_dmadone(struct queue_entry *entry); 1329void rt2x00lib_txdone(struct queue_entry *entry, 1330 struct txdone_entry_desc *txdesc); 1331void rt2x00lib_txdone_noinfo(struct queue_entry *entry, u32 status); 1332void rt2x00lib_rxdone(struct queue_entry *entry, gfp_t gfp); 1333 1334/* 1335 * mac80211 handlers. 1336 */ 1337void rt2x00mac_tx(struct ieee80211_hw *hw, 1338 struct ieee80211_tx_control *control, 1339 struct sk_buff *skb); 1340int rt2x00mac_start(struct ieee80211_hw *hw); 1341void rt2x00mac_stop(struct ieee80211_hw *hw); 1342int rt2x00mac_add_interface(struct ieee80211_hw *hw, 1343 struct ieee80211_vif *vif); 1344void rt2x00mac_remove_interface(struct ieee80211_hw *hw, 1345 struct ieee80211_vif *vif); 1346int rt2x00mac_config(struct ieee80211_hw *hw, u32 changed); 1347void rt2x00mac_configure_filter(struct ieee80211_hw *hw, 1348 unsigned int changed_flags, 1349 unsigned int *total_flags, 1350 u64 multicast); 1351int rt2x00mac_set_tim(struct ieee80211_hw *hw, struct ieee80211_sta *sta, 1352 bool set); 1353#ifdef CONFIG_RT2X00_LIB_CRYPTO 1354int rt2x00mac_set_key(struct ieee80211_hw *hw, enum set_key_cmd cmd, 1355 struct ieee80211_vif *vif, struct ieee80211_sta *sta, 1356 struct ieee80211_key_conf *key); 1357#else 1358#define rt2x00mac_set_key NULL 1359#endif /* CONFIG_RT2X00_LIB_CRYPTO */ 1360int rt2x00mac_sta_add(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 1361 struct ieee80211_sta *sta); 1362int rt2x00mac_sta_remove(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 1363 struct ieee80211_sta *sta); 1364void rt2x00mac_sw_scan_start(struct ieee80211_hw *hw); 1365void rt2x00mac_sw_scan_complete(struct ieee80211_hw *hw); 1366int rt2x00mac_get_stats(struct ieee80211_hw *hw, 1367 struct ieee80211_low_level_stats *stats); 1368void rt2x00mac_bss_info_changed(struct ieee80211_hw *hw, 1369 struct ieee80211_vif *vif, 1370 struct ieee80211_bss_conf *bss_conf, 1371 u32 changes); 1372int rt2x00mac_conf_tx(struct ieee80211_hw *hw, 1373 struct ieee80211_vif *vif, u16 queue, 1374 const struct ieee80211_tx_queue_params *params); 1375void rt2x00mac_rfkill_poll(struct ieee80211_hw *hw); 1376void rt2x00mac_flush(struct ieee80211_hw *hw, u32 queues, bool drop); 1377int rt2x00mac_set_antenna(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant); 1378int rt2x00mac_get_antenna(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant); 1379void rt2x00mac_get_ringparam(struct ieee80211_hw *hw, 1380 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max); 1381bool rt2x00mac_tx_frames_pending(struct ieee80211_hw *hw); 1382 1383/* 1384 * Driver allocation handlers. 1385 */ 1386int rt2x00lib_probe_dev(struct rt2x00_dev *rt2x00dev); 1387void rt2x00lib_remove_dev(struct rt2x00_dev *rt2x00dev); 1388#ifdef CONFIG_PM 1389int rt2x00lib_suspend(struct rt2x00_dev *rt2x00dev, pm_message_t state); 1390int rt2x00lib_resume(struct rt2x00_dev *rt2x00dev); 1391#endif /* CONFIG_PM */ 1392 1393#endif /* RT2X00_H */ 1394