Linux Audio

Check our new training course

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