rt2x00.h revision 705802bf56b1b7a64e543805ba196a6e1fb80ec6
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 void (*queue_init)(struct data_queue *queue); 653 const struct rt2x00lib_ops *lib; 654 const void *drv; 655 const struct ieee80211_ops *hw; 656#ifdef CONFIG_RT2X00_LIB_DEBUGFS 657 const struct rt2x00debug *debugfs; 658#endif /* CONFIG_RT2X00_LIB_DEBUGFS */ 659}; 660 661/* 662 * rt2x00 state flags 663 */ 664enum rt2x00_state_flags { 665 /* 666 * Device flags 667 */ 668 DEVICE_STATE_PRESENT, 669 DEVICE_STATE_REGISTERED_HW, 670 DEVICE_STATE_INITIALIZED, 671 DEVICE_STATE_STARTED, 672 DEVICE_STATE_ENABLED_RADIO, 673 DEVICE_STATE_SCANNING, 674 675 /* 676 * Driver configuration 677 */ 678 CONFIG_CHANNEL_HT40, 679 CONFIG_POWERSAVING, 680 CONFIG_HT_DISABLED, 681 CONFIG_QOS_DISABLED, 682 683 /* 684 * Mark we currently are sequentially reading TX_STA_FIFO register 685 * FIXME: this is for only rt2800usb, should go to private data 686 */ 687 TX_STATUS_READING, 688}; 689 690/* 691 * rt2x00 capability flags 692 */ 693enum rt2x00_capability_flags { 694 /* 695 * Requirements 696 */ 697 REQUIRE_FIRMWARE, 698 REQUIRE_BEACON_GUARD, 699 REQUIRE_ATIM_QUEUE, 700 REQUIRE_DMA, 701 REQUIRE_COPY_IV, 702 REQUIRE_L2PAD, 703 REQUIRE_TXSTATUS_FIFO, 704 REQUIRE_TASKLET_CONTEXT, 705 REQUIRE_SW_SEQNO, 706 REQUIRE_HT_TX_DESC, 707 REQUIRE_PS_AUTOWAKE, 708 709 /* 710 * Capabilities 711 */ 712 CAPABILITY_HW_BUTTON, 713 CAPABILITY_HW_CRYPTO, 714 CAPABILITY_POWER_LIMIT, 715 CAPABILITY_CONTROL_FILTERS, 716 CAPABILITY_CONTROL_FILTER_PSPOLL, 717 CAPABILITY_PRE_TBTT_INTERRUPT, 718 CAPABILITY_LINK_TUNING, 719 CAPABILITY_FRAME_TYPE, 720 CAPABILITY_RF_SEQUENCE, 721 CAPABILITY_EXTERNAL_LNA_A, 722 CAPABILITY_EXTERNAL_LNA_BG, 723 CAPABILITY_DOUBLE_ANTENNA, 724 CAPABILITY_BT_COEXIST, 725 CAPABILITY_VCO_RECALIBRATION, 726}; 727 728/* 729 * Interface combinations 730 */ 731enum { 732 IF_COMB_AP = 0, 733 NUM_IF_COMB, 734}; 735 736/* 737 * rt2x00 device structure. 738 */ 739struct rt2x00_dev { 740 /* 741 * Device structure. 742 * The structure stored in here depends on the 743 * system bus (PCI or USB). 744 * When accessing this variable, the rt2x00dev_{pci,usb} 745 * macros should be used for correct typecasting. 746 */ 747 struct device *dev; 748 749 /* 750 * Callback functions. 751 */ 752 const struct rt2x00_ops *ops; 753 754 /* 755 * Driver data. 756 */ 757 void *drv_data; 758 759 /* 760 * IEEE80211 control structure. 761 */ 762 struct ieee80211_hw *hw; 763 struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS]; 764 enum ieee80211_band curr_band; 765 int curr_freq; 766 767 /* 768 * If enabled, the debugfs interface structures 769 * required for deregistration of debugfs. 770 */ 771#ifdef CONFIG_RT2X00_LIB_DEBUGFS 772 struct rt2x00debug_intf *debugfs_intf; 773#endif /* CONFIG_RT2X00_LIB_DEBUGFS */ 774 775 /* 776 * LED structure for changing the LED status 777 * by mac8011 or the kernel. 778 */ 779#ifdef CONFIG_RT2X00_LIB_LEDS 780 struct rt2x00_led led_radio; 781 struct rt2x00_led led_assoc; 782 struct rt2x00_led led_qual; 783 u16 led_mcu_reg; 784#endif /* CONFIG_RT2X00_LIB_LEDS */ 785 786 /* 787 * Device state flags. 788 * In these flags the current status is stored. 789 * Access to these flags should occur atomically. 790 */ 791 unsigned long flags; 792 793 /* 794 * Device capabiltiy flags. 795 * In these flags the device/driver capabilities are stored. 796 * Access to these flags should occur non-atomically. 797 */ 798 unsigned long cap_flags; 799 800 /* 801 * Device information, Bus IRQ and name (PCI, SoC) 802 */ 803 int irq; 804 const char *name; 805 806 /* 807 * Chipset identification. 808 */ 809 struct rt2x00_chip chip; 810 811 /* 812 * hw capability specifications. 813 */ 814 struct hw_mode_spec spec; 815 816 /* 817 * This is the default TX/RX antenna setup as indicated 818 * by the device's EEPROM. 819 */ 820 struct antenna_setup default_ant; 821 822 /* 823 * Register pointers 824 * csr.base: CSR base register address. (PCI) 825 * csr.cache: CSR cache for usb_control_msg. (USB) 826 */ 827 union csr { 828 void __iomem *base; 829 void *cache; 830 } csr; 831 832 /* 833 * Mutex to protect register accesses. 834 * For PCI and USB devices it protects against concurrent indirect 835 * register access (BBP, RF, MCU) since accessing those 836 * registers require multiple calls to the CSR registers. 837 * For USB devices it also protects the csr_cache since that 838 * field is used for normal CSR access and it cannot support 839 * multiple callers simultaneously. 840 */ 841 struct mutex csr_mutex; 842 843 /* 844 * Current packet filter configuration for the device. 845 * This contains all currently active FIF_* flags send 846 * to us by mac80211 during configure_filter(). 847 */ 848 unsigned int packet_filter; 849 850 /* 851 * Interface details: 852 * - Open ap interface count. 853 * - Open sta interface count. 854 * - Association count. 855 * - Beaconing enabled count. 856 */ 857 unsigned int intf_ap_count; 858 unsigned int intf_sta_count; 859 unsigned int intf_associated; 860 unsigned int intf_beaconing; 861 862 /* 863 * Interface combinations 864 */ 865 struct ieee80211_iface_limit if_limits_ap; 866 struct ieee80211_iface_combination if_combinations[NUM_IF_COMB]; 867 868 /* 869 * Link quality 870 */ 871 struct link link; 872 873 /* 874 * EEPROM data. 875 */ 876 __le16 *eeprom; 877 878 /* 879 * Active RF register values. 880 * These are stored here so we don't need 881 * to read the rf registers and can directly 882 * use this value instead. 883 * This field should be accessed by using 884 * rt2x00_rf_read() and rt2x00_rf_write(). 885 */ 886 u32 *rf; 887 888 /* 889 * LNA gain 890 */ 891 short lna_gain; 892 893 /* 894 * Current TX power value. 895 */ 896 u16 tx_power; 897 898 /* 899 * Current retry values. 900 */ 901 u8 short_retry; 902 u8 long_retry; 903 904 /* 905 * Rssi <-> Dbm offset 906 */ 907 u8 rssi_offset; 908 909 /* 910 * Frequency offset. 911 */ 912 u8 freq_offset; 913 914 /* 915 * Association id. 916 */ 917 u16 aid; 918 919 /* 920 * Beacon interval. 921 */ 922 u16 beacon_int; 923 924 /** 925 * Timestamp of last received beacon 926 */ 927 unsigned long last_beacon; 928 929 /* 930 * Low level statistics which will have 931 * to be kept up to date while device is running. 932 */ 933 struct ieee80211_low_level_stats low_level_stats; 934 935 /** 936 * Work queue for all work which should not be placed 937 * on the mac80211 workqueue (because of dependencies 938 * between various work structures). 939 */ 940 struct workqueue_struct *workqueue; 941 942 /* 943 * Scheduled work. 944 * NOTE: intf_work will use ieee80211_iterate_active_interfaces() 945 * which means it cannot be placed on the hw->workqueue 946 * due to RTNL locking requirements. 947 */ 948 struct work_struct intf_work; 949 950 /** 951 * Scheduled work for TX/RX done handling (USB devices) 952 */ 953 struct work_struct rxdone_work; 954 struct work_struct txdone_work; 955 956 /* 957 * Powersaving work 958 */ 959 struct delayed_work autowakeup_work; 960 struct work_struct sleep_work; 961 962 /* 963 * Data queue arrays for RX, TX, Beacon and ATIM. 964 */ 965 unsigned int data_queues; 966 struct data_queue *rx; 967 struct data_queue *tx; 968 struct data_queue *bcn; 969 struct data_queue *atim; 970 971 /* 972 * Firmware image. 973 */ 974 const struct firmware *fw; 975 976 /* 977 * FIFO for storing tx status reports between isr and tasklet. 978 */ 979 DECLARE_KFIFO_PTR(txstatus_fifo, u32); 980 981 /* 982 * Timer to ensure tx status reports are read (rt2800usb). 983 */ 984 struct hrtimer txstatus_timer; 985 986 /* 987 * Tasklet for processing tx status reports (rt2800pci). 988 */ 989 struct tasklet_struct txstatus_tasklet; 990 struct tasklet_struct pretbtt_tasklet; 991 struct tasklet_struct tbtt_tasklet; 992 struct tasklet_struct rxdone_tasklet; 993 struct tasklet_struct autowake_tasklet; 994 995 /* 996 * Used for VCO periodic calibration. 997 */ 998 int rf_channel; 999 1000 /* 1001 * Protect the interrupt mask register. 1002 */ 1003 spinlock_t irqmask_lock; 1004 1005 /* 1006 * List of BlockAckReq TX entries that need driver BlockAck processing. 1007 */ 1008 struct list_head bar_list; 1009 spinlock_t bar_list_lock; 1010}; 1011 1012struct rt2x00_bar_list_entry { 1013 struct list_head list; 1014 struct rcu_head head; 1015 1016 struct queue_entry *entry; 1017 int block_acked; 1018 1019 /* Relevant parts of the IEEE80211 BAR header */ 1020 __u8 ra[6]; 1021 __u8 ta[6]; 1022 __le16 control; 1023 __le16 start_seq_num; 1024}; 1025 1026/* 1027 * Register defines. 1028 * Some registers require multiple attempts before success, 1029 * in those cases REGISTER_BUSY_COUNT attempts should be 1030 * taken with a REGISTER_BUSY_DELAY interval. 1031 */ 1032#define REGISTER_BUSY_COUNT 100 1033#define REGISTER_BUSY_DELAY 100 1034 1035/* 1036 * Generic RF access. 1037 * The RF is being accessed by word index. 1038 */ 1039static inline void rt2x00_rf_read(struct rt2x00_dev *rt2x00dev, 1040 const unsigned int word, u32 *data) 1041{ 1042 BUG_ON(word < 1 || word > rt2x00dev->ops->rf_size / sizeof(u32)); 1043 *data = rt2x00dev->rf[word - 1]; 1044} 1045 1046static inline void rt2x00_rf_write(struct rt2x00_dev *rt2x00dev, 1047 const unsigned int word, u32 data) 1048{ 1049 BUG_ON(word < 1 || word > rt2x00dev->ops->rf_size / sizeof(u32)); 1050 rt2x00dev->rf[word - 1] = data; 1051} 1052 1053/* 1054 * Generic EEPROM access. The EEPROM is being accessed by word or byte index. 1055 */ 1056static inline void *rt2x00_eeprom_addr(struct rt2x00_dev *rt2x00dev, 1057 const unsigned int word) 1058{ 1059 return (void *)&rt2x00dev->eeprom[word]; 1060} 1061 1062static inline void rt2x00_eeprom_read(struct rt2x00_dev *rt2x00dev, 1063 const unsigned int word, u16 *data) 1064{ 1065 *data = le16_to_cpu(rt2x00dev->eeprom[word]); 1066} 1067 1068static inline void rt2x00_eeprom_write(struct rt2x00_dev *rt2x00dev, 1069 const unsigned int word, u16 data) 1070{ 1071 rt2x00dev->eeprom[word] = cpu_to_le16(data); 1072} 1073 1074static inline u8 rt2x00_eeprom_byte(struct rt2x00_dev *rt2x00dev, 1075 const unsigned int byte) 1076{ 1077 return *(((u8 *)rt2x00dev->eeprom) + byte); 1078} 1079 1080/* 1081 * Chipset handlers 1082 */ 1083static inline void rt2x00_set_chip(struct rt2x00_dev *rt2x00dev, 1084 const u16 rt, const u16 rf, const u16 rev) 1085{ 1086 rt2x00dev->chip.rt = rt; 1087 rt2x00dev->chip.rf = rf; 1088 rt2x00dev->chip.rev = rev; 1089 1090 rt2x00_info(rt2x00dev, "Chipset detected - rt: %04x, rf: %04x, rev: %04x\n", 1091 rt2x00dev->chip.rt, rt2x00dev->chip.rf, 1092 rt2x00dev->chip.rev); 1093} 1094 1095static inline void rt2x00_set_rt(struct rt2x00_dev *rt2x00dev, 1096 const u16 rt, const u16 rev) 1097{ 1098 rt2x00dev->chip.rt = rt; 1099 rt2x00dev->chip.rev = rev; 1100 1101 rt2x00_info(rt2x00dev, "RT chipset %04x, rev %04x detected\n", 1102 rt2x00dev->chip.rt, rt2x00dev->chip.rev); 1103} 1104 1105static inline void rt2x00_set_rf(struct rt2x00_dev *rt2x00dev, const u16 rf) 1106{ 1107 rt2x00dev->chip.rf = rf; 1108 1109 rt2x00_info(rt2x00dev, "RF chipset %04x detected\n", 1110 rt2x00dev->chip.rf); 1111} 1112 1113static inline bool rt2x00_rt(struct rt2x00_dev *rt2x00dev, const u16 rt) 1114{ 1115 return (rt2x00dev->chip.rt == rt); 1116} 1117 1118static inline bool rt2x00_rf(struct rt2x00_dev *rt2x00dev, const u16 rf) 1119{ 1120 return (rt2x00dev->chip.rf == rf); 1121} 1122 1123static inline u16 rt2x00_rev(struct rt2x00_dev *rt2x00dev) 1124{ 1125 return rt2x00dev->chip.rev; 1126} 1127 1128static inline bool rt2x00_rt_rev(struct rt2x00_dev *rt2x00dev, 1129 const u16 rt, const u16 rev) 1130{ 1131 return (rt2x00_rt(rt2x00dev, rt) && rt2x00_rev(rt2x00dev) == rev); 1132} 1133 1134static inline bool rt2x00_rt_rev_lt(struct rt2x00_dev *rt2x00dev, 1135 const u16 rt, const u16 rev) 1136{ 1137 return (rt2x00_rt(rt2x00dev, rt) && rt2x00_rev(rt2x00dev) < rev); 1138} 1139 1140static inline bool rt2x00_rt_rev_gte(struct rt2x00_dev *rt2x00dev, 1141 const u16 rt, const u16 rev) 1142{ 1143 return (rt2x00_rt(rt2x00dev, rt) && rt2x00_rev(rt2x00dev) >= rev); 1144} 1145 1146static inline void rt2x00_set_chip_intf(struct rt2x00_dev *rt2x00dev, 1147 enum rt2x00_chip_intf intf) 1148{ 1149 rt2x00dev->chip.intf = intf; 1150} 1151 1152static inline bool rt2x00_intf(struct rt2x00_dev *rt2x00dev, 1153 enum rt2x00_chip_intf intf) 1154{ 1155 return (rt2x00dev->chip.intf == intf); 1156} 1157 1158static inline bool rt2x00_is_pci(struct rt2x00_dev *rt2x00dev) 1159{ 1160 return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCI) || 1161 rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCIE); 1162} 1163 1164static inline bool rt2x00_is_pcie(struct rt2x00_dev *rt2x00dev) 1165{ 1166 return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_PCIE); 1167} 1168 1169static inline bool rt2x00_is_usb(struct rt2x00_dev *rt2x00dev) 1170{ 1171 return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_USB); 1172} 1173 1174static inline bool rt2x00_is_soc(struct rt2x00_dev *rt2x00dev) 1175{ 1176 return rt2x00_intf(rt2x00dev, RT2X00_CHIP_INTF_SOC); 1177} 1178 1179/** 1180 * rt2x00queue_map_txskb - Map a skb into DMA for TX purposes. 1181 * @entry: Pointer to &struct queue_entry 1182 * 1183 * Returns -ENOMEM if mapping fail, 0 otherwise. 1184 */ 1185int rt2x00queue_map_txskb(struct queue_entry *entry); 1186 1187/** 1188 * rt2x00queue_unmap_skb - Unmap a skb from DMA. 1189 * @entry: Pointer to &struct queue_entry 1190 */ 1191void rt2x00queue_unmap_skb(struct queue_entry *entry); 1192 1193/** 1194 * rt2x00queue_get_tx_queue - Convert tx queue index to queue pointer 1195 * @rt2x00dev: Pointer to &struct rt2x00_dev. 1196 * @queue: rt2x00 queue index (see &enum data_queue_qid). 1197 * 1198 * Returns NULL for non tx queues. 1199 */ 1200static inline struct data_queue * 1201rt2x00queue_get_tx_queue(struct rt2x00_dev *rt2x00dev, 1202 const enum data_queue_qid queue) 1203{ 1204 if (queue < rt2x00dev->ops->tx_queues && rt2x00dev->tx) 1205 return &rt2x00dev->tx[queue]; 1206 1207 if (queue == QID_ATIM) 1208 return rt2x00dev->atim; 1209 1210 return NULL; 1211} 1212 1213/** 1214 * rt2x00queue_get_entry - Get queue entry where the given index points to. 1215 * @queue: Pointer to &struct data_queue from where we obtain the entry. 1216 * @index: Index identifier for obtaining the correct index. 1217 */ 1218struct queue_entry *rt2x00queue_get_entry(struct data_queue *queue, 1219 enum queue_index index); 1220 1221/** 1222 * rt2x00queue_pause_queue - Pause a data queue 1223 * @queue: Pointer to &struct data_queue. 1224 * 1225 * This function will pause the data queue locally, preventing 1226 * new frames to be added to the queue (while the hardware is 1227 * still allowed to run). 1228 */ 1229void rt2x00queue_pause_queue(struct data_queue *queue); 1230 1231/** 1232 * rt2x00queue_unpause_queue - unpause a data queue 1233 * @queue: Pointer to &struct data_queue. 1234 * 1235 * This function will unpause the data queue locally, allowing 1236 * new frames to be added to the queue again. 1237 */ 1238void rt2x00queue_unpause_queue(struct data_queue *queue); 1239 1240/** 1241 * rt2x00queue_start_queue - Start a data queue 1242 * @queue: Pointer to &struct data_queue. 1243 * 1244 * This function will start handling all pending frames in the queue. 1245 */ 1246void rt2x00queue_start_queue(struct data_queue *queue); 1247 1248/** 1249 * rt2x00queue_stop_queue - Halt a data queue 1250 * @queue: Pointer to &struct data_queue. 1251 * 1252 * This function will stop all pending frames in the queue. 1253 */ 1254void rt2x00queue_stop_queue(struct data_queue *queue); 1255 1256/** 1257 * rt2x00queue_flush_queue - Flush a data queue 1258 * @queue: Pointer to &struct data_queue. 1259 * @drop: True to drop all pending frames. 1260 * 1261 * This function will flush the queue. After this call 1262 * the queue is guaranteed to be empty. 1263 */ 1264void rt2x00queue_flush_queue(struct data_queue *queue, bool drop); 1265 1266/** 1267 * rt2x00queue_start_queues - Start all data queues 1268 * @rt2x00dev: Pointer to &struct rt2x00_dev. 1269 * 1270 * This function will loop through all available queues to start them 1271 */ 1272void rt2x00queue_start_queues(struct rt2x00_dev *rt2x00dev); 1273 1274/** 1275 * rt2x00queue_stop_queues - Halt all data queues 1276 * @rt2x00dev: Pointer to &struct rt2x00_dev. 1277 * 1278 * This function will loop through all available queues to stop 1279 * any pending frames. 1280 */ 1281void rt2x00queue_stop_queues(struct rt2x00_dev *rt2x00dev); 1282 1283/** 1284 * rt2x00queue_flush_queues - Flush all data queues 1285 * @rt2x00dev: Pointer to &struct rt2x00_dev. 1286 * @drop: True to drop all pending frames. 1287 * 1288 * This function will loop through all available queues to flush 1289 * any pending frames. 1290 */ 1291void rt2x00queue_flush_queues(struct rt2x00_dev *rt2x00dev, bool drop); 1292 1293/* 1294 * Debugfs handlers. 1295 */ 1296/** 1297 * rt2x00debug_dump_frame - Dump a frame to userspace through debugfs. 1298 * @rt2x00dev: Pointer to &struct rt2x00_dev. 1299 * @type: The type of frame that is being dumped. 1300 * @skb: The skb containing the frame to be dumped. 1301 */ 1302#ifdef CONFIG_RT2X00_LIB_DEBUGFS 1303void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev, 1304 enum rt2x00_dump_type type, struct sk_buff *skb); 1305#else 1306static inline void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev, 1307 enum rt2x00_dump_type type, 1308 struct sk_buff *skb) 1309{ 1310} 1311#endif /* CONFIG_RT2X00_LIB_DEBUGFS */ 1312 1313/* 1314 * Utility functions. 1315 */ 1316u32 rt2x00lib_get_bssidx(struct rt2x00_dev *rt2x00dev, 1317 struct ieee80211_vif *vif); 1318 1319/* 1320 * Interrupt context handlers. 1321 */ 1322void rt2x00lib_beacondone(struct rt2x00_dev *rt2x00dev); 1323void rt2x00lib_pretbtt(struct rt2x00_dev *rt2x00dev); 1324void rt2x00lib_dmastart(struct queue_entry *entry); 1325void rt2x00lib_dmadone(struct queue_entry *entry); 1326void rt2x00lib_txdone(struct queue_entry *entry, 1327 struct txdone_entry_desc *txdesc); 1328void rt2x00lib_txdone_noinfo(struct queue_entry *entry, u32 status); 1329void rt2x00lib_rxdone(struct queue_entry *entry, gfp_t gfp); 1330 1331/* 1332 * mac80211 handlers. 1333 */ 1334void rt2x00mac_tx(struct ieee80211_hw *hw, 1335 struct ieee80211_tx_control *control, 1336 struct sk_buff *skb); 1337int rt2x00mac_start(struct ieee80211_hw *hw); 1338void rt2x00mac_stop(struct ieee80211_hw *hw); 1339int rt2x00mac_add_interface(struct ieee80211_hw *hw, 1340 struct ieee80211_vif *vif); 1341void rt2x00mac_remove_interface(struct ieee80211_hw *hw, 1342 struct ieee80211_vif *vif); 1343int rt2x00mac_config(struct ieee80211_hw *hw, u32 changed); 1344void rt2x00mac_configure_filter(struct ieee80211_hw *hw, 1345 unsigned int changed_flags, 1346 unsigned int *total_flags, 1347 u64 multicast); 1348int rt2x00mac_set_tim(struct ieee80211_hw *hw, struct ieee80211_sta *sta, 1349 bool set); 1350#ifdef CONFIG_RT2X00_LIB_CRYPTO 1351int rt2x00mac_set_key(struct ieee80211_hw *hw, enum set_key_cmd cmd, 1352 struct ieee80211_vif *vif, struct ieee80211_sta *sta, 1353 struct ieee80211_key_conf *key); 1354#else 1355#define rt2x00mac_set_key NULL 1356#endif /* CONFIG_RT2X00_LIB_CRYPTO */ 1357int rt2x00mac_sta_add(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 1358 struct ieee80211_sta *sta); 1359int rt2x00mac_sta_remove(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 1360 struct ieee80211_sta *sta); 1361void rt2x00mac_sw_scan_start(struct ieee80211_hw *hw); 1362void rt2x00mac_sw_scan_complete(struct ieee80211_hw *hw); 1363int rt2x00mac_get_stats(struct ieee80211_hw *hw, 1364 struct ieee80211_low_level_stats *stats); 1365void rt2x00mac_bss_info_changed(struct ieee80211_hw *hw, 1366 struct ieee80211_vif *vif, 1367 struct ieee80211_bss_conf *bss_conf, 1368 u32 changes); 1369int rt2x00mac_conf_tx(struct ieee80211_hw *hw, 1370 struct ieee80211_vif *vif, u16 queue, 1371 const struct ieee80211_tx_queue_params *params); 1372void rt2x00mac_rfkill_poll(struct ieee80211_hw *hw); 1373void rt2x00mac_flush(struct ieee80211_hw *hw, u32 queues, bool drop); 1374int rt2x00mac_set_antenna(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant); 1375int rt2x00mac_get_antenna(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant); 1376void rt2x00mac_get_ringparam(struct ieee80211_hw *hw, 1377 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max); 1378bool rt2x00mac_tx_frames_pending(struct ieee80211_hw *hw); 1379 1380/* 1381 * Driver allocation handlers. 1382 */ 1383int rt2x00lib_probe_dev(struct rt2x00_dev *rt2x00dev); 1384void rt2x00lib_remove_dev(struct rt2x00_dev *rt2x00dev); 1385#ifdef CONFIG_PM 1386int rt2x00lib_suspend(struct rt2x00_dev *rt2x00dev, pm_message_t state); 1387int rt2x00lib_resume(struct rt2x00_dev *rt2x00dev); 1388#endif /* CONFIG_PM */ 1389 1390#endif /* RT2X00_H */ 1391