rt2x00.h 24.8 KB
Newer Older
1
/*
2
	Copyright (C) 2004 - 2008 rt2x00 SourceForge Project
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
	<http://rt2x00.serialmonkey.com>

	This program is free software; you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation; either version 2 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program; if not, write to the
	Free Software Foundation, Inc.,
	59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

/*
	Module: rt2x00
	Abstract: rt2x00 global information.
 */

#ifndef RT2X00_H
#define RT2X00_H

#include <linux/bitops.h>
#include <linux/skbuff.h>
#include <linux/workqueue.h>
#include <linux/firmware.h>
33
#include <linux/leds.h>
34
#include <linux/mutex.h>
35
#include <linux/etherdevice.h>
36 37 38 39

#include <net/mac80211.h>

#include "rt2x00debug.h"
40
#include "rt2x00leds.h"
41
#include "rt2x00reg.h"
42
#include "rt2x00queue.h"
43 44 45 46

/*
 * Module information.
 */
Ivo van Doorn's avatar
Ivo van Doorn committed
47
#define DRV_VERSION	"2.2.3"
48 49 50 51 52 53 54 55
#define DRV_PROJECT	"http://rt2x00.serialmonkey.com"

/*
 * Debug definitions.
 * Debug output has to be enabled during compile time.
 */
#define DEBUG_PRINTK_MSG(__dev, __kernlvl, __lvl, __msg, __args...)	\
	printk(__kernlvl "%s -> %s: %s - " __msg,			\
56
	       wiphy_name((__dev)->hw->wiphy), __func__, __lvl, ##__args)
57 58 59

#define DEBUG_PRINTK_PROBE(__kernlvl, __lvl, __msg, __args...)	\
	printk(__kernlvl "%s -> %s: %s - " __msg,		\
60
	       KBUILD_MODNAME, __func__, __lvl, ##__args)
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93

#ifdef CONFIG_RT2X00_DEBUG
#define DEBUG_PRINTK(__dev, __kernlvl, __lvl, __msg, __args...)	\
	DEBUG_PRINTK_MSG(__dev, __kernlvl, __lvl, __msg, ##__args);
#else
#define DEBUG_PRINTK(__dev, __kernlvl, __lvl, __msg, __args...)	\
	do { } while (0)
#endif /* CONFIG_RT2X00_DEBUG */

/*
 * Various debug levels.
 * The debug levels PANIC and ERROR both indicate serious problems,
 * for this reason they should never be ignored.
 * The special ERROR_PROBE message is for messages that are generated
 * when the rt2x00_dev is not yet initialized.
 */
#define PANIC(__dev, __msg, __args...) \
	DEBUG_PRINTK_MSG(__dev, KERN_CRIT, "Panic", __msg, ##__args)
#define ERROR(__dev, __msg, __args...)	\
	DEBUG_PRINTK_MSG(__dev, KERN_ERR, "Error", __msg, ##__args)
#define ERROR_PROBE(__msg, __args...) \
	DEBUG_PRINTK_PROBE(KERN_ERR, "Error", __msg, ##__args)
#define WARNING(__dev, __msg, __args...) \
	DEBUG_PRINTK(__dev, KERN_WARNING, "Warning", __msg, ##__args)
#define NOTICE(__dev, __msg, __args...) \
	DEBUG_PRINTK(__dev, KERN_NOTICE, "Notice", __msg, ##__args)
#define INFO(__dev, __msg, __args...) \
	DEBUG_PRINTK(__dev, KERN_INFO, "Info", __msg, ##__args)
#define DEBUG(__dev, __msg, __args...) \
	DEBUG_PRINTK(__dev, KERN_DEBUG, "Debug", __msg, ##__args)
#define EEPROM(__dev, __msg, __args...) \
	DEBUG_PRINTK(__dev, KERN_DEBUG, "EEPROM recovery", __msg, ##__args)

94 95 96 97 98 99 100 101 102 103
/*
 * Duration calculations
 * The rate variable passed is: 100kbs.
 * To convert from bytes to bits we multiply size with 8,
 * then the size is multiplied with 10 to make the
 * real rate -> rate argument correction.
 */
#define GET_DURATION(__size, __rate)	(((__size) * 8 * 10) / (__rate))
#define GET_DURATION_RES(__size, __rate)(((__size) * 8 * 10) % (__rate))

104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
/*
 * Standard timing and size defines.
 * These values should follow the ieee80211 specifications.
 */
#define ACK_SIZE		14
#define IEEE80211_HEADER	24
#define PLCP			48
#define BEACON			100
#define PREAMBLE		144
#define SHORT_PREAMBLE		72
#define SLOT_TIME		20
#define SHORT_SLOT_TIME		9
#define SIFS			10
#define PIFS			( SIFS + SLOT_TIME )
#define SHORT_PIFS		( SIFS + SHORT_SLOT_TIME )
#define DIFS			( PIFS + SLOT_TIME )
#define SHORT_DIFS		( SHORT_PIFS + SHORT_SLOT_TIME )
Ivo van Doorn's avatar
Ivo van Doorn committed
121
#define EIFS			( SIFS + DIFS + \
122
				  GET_DURATION(IEEE80211_HEADER + ACK_SIZE, 10) )
Ivo van Doorn's avatar
Ivo van Doorn committed
123
#define SHORT_EIFS		( SIFS + SHORT_DIFS + \
124
				  GET_DURATION(IEEE80211_HEADER + ACK_SIZE, 10) )
125 126 127 128 129 130 131 132 133 134 135

/*
 * Chipset identification
 * The chipset on the device is composed of a RT and RF chip.
 * The chipset combination is important for determining device capabilities.
 */
struct rt2x00_chip {
	u16 rt;
#define RT2460		0x0101
#define RT2560		0x0201
#define RT2570		0x1201
136 137
#define RT2561s		0x0301	/* Turbo */
#define RT2561		0x0302
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
#define RT2661		0x0401
#define RT2571		0x1300

	u16 rf;
	u32 rev;
};

/*
 * RF register values that belong to a particular channel.
 */
struct rf_channel {
	int channel;
	u32 rf1;
	u32 rf2;
	u32 rf3;
	u32 rf4;
};

156 157 158 159 160 161 162 163 164 165 166
/*
 * Channel information structure
 */
struct channel_info {
	unsigned int flags;
#define GEOGRAPHY_ALLOWED	0x00000001

	short tx_power1;
	short tx_power2;
};

167 168 169 170 171 172 173 174
/*
 * Antenna setup values.
 */
struct antenna_setup {
	enum antenna rx;
	enum antenna tx;
};

175
/*
176
 * Quality statistics about the currently active link.
177
 */
178
struct link_qual {
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
	/*
	 * Statistics required for Link tuning.
	 * For the average RSSI value we use the "Walking average" approach.
	 * When adding RSSI to the average value the following calculation
	 * is needed:
	 *
	 *        avg_rssi = ((avg_rssi * 7) + rssi) / 8;
	 *
	 * The advantage of this approach is that we only need 1 variable
	 * to store the average in (No need for a count and a total).
	 * But more importantly, normal average values will over time
	 * move less and less towards newly added values this results
	 * that with link tuning, the device can have a very good RSSI
	 * for a few minutes but when the device is moved away from the AP
	 * the average will not decrease fast enough to compensate.
	 * The walking average compensates this and will move towards
	 * the new values correctly allowing a effective link tuning.
	 */
	int avg_rssi;
	int false_cca;

	/*
	 * Statistics required for Signal quality calculation.
	 * For calculating the Signal quality we have to determine
	 * the total number of success and failed RX and TX frames.
	 * After that we also use the average RSSI value to help
	 * determining the signal quality.
	 * For the calculation we will use the following algorithm:
	 *
	 *         rssi_percentage = (avg_rssi * 100) / rssi_offset
	 *         rx_percentage = (rx_success * 100) / rx_total
	 *         tx_percentage = (tx_success * 100) / tx_total
	 *         avg_signal = ((WEIGHT_RSSI * avg_rssi) +
	 *                       (WEIGHT_TX * tx_percentage) +
	 *                       (WEIGHT_RX * rx_percentage)) / 100
	 *
215
	 * This value should then be checked to not be greater then 100.
216 217 218 219 220 221 222 223 224 225
	 */
	int rx_percentage;
	int rx_success;
	int rx_failed;
	int tx_percentage;
	int tx_success;
	int tx_failed;
#define WEIGHT_RSSI	20
#define WEIGHT_RX	40
#define WEIGHT_TX	40
226 227
};

228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
/*
 * Antenna settings about the currently active link.
 */
struct link_ant {
	/*
	 * Antenna flags
	 */
	unsigned int flags;
#define ANTENNA_RX_DIVERSITY	0x00000001
#define ANTENNA_TX_DIVERSITY	0x00000002
#define ANTENNA_MODE_SAMPLE	0x00000004

	/*
	 * Currently active TX/RX antenna setup.
	 * When software diversity is used, this will indicate
	 * which antenna is actually used at this time.
	 */
	struct antenna_setup active;

	/*
	 * RSSI information for the different antenna's.
	 * These statistics are used to determine when
	 * to switch antenna when using software diversity.
	 *
	 *        rssi[0] -> Antenna A RSSI
	 *        rssi[1] -> Antenna B RSSI
	 */
	int rssi_history[2];

	/*
	 * Current RSSI average of the currently active antenna.
	 * Similar to the avg_rssi in the link_qual structure
	 * this value is updated by using the walking average.
	 */
	int rssi_ant;
};

265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
/*
 * To optimize the quality of the link we need to store
 * the quality of received frames and periodically
 * optimize the link.
 */
struct link {
	/*
	 * Link tuner counter
	 * The number of times the link has been tuned
	 * since the radio has been switched on.
	 */
	u32 count;

	/*
	 * Quality measurement values.
	 */
	struct link_qual qual;

283
	/*
284
	 * TX/RX antenna setup.
285
	 */
286
	struct link_ant ant;
287

288
	/*
289
	 * Active VGC level (for false cca tuning)
290
	 */
291 292 293 294 295 296
	u8 vgc_level;

	/*
	 * VGC level as configured in register
	 */
	u8 vgc_level_reg;
297 298 299 300 301 302 303 304

	/*
	 * Work structure for scheduling periodic link tuning.
	 */
	struct delayed_work work;
};

/*
305
 * Small helper macro to work with moving/walking averages.
306
 */
307 308 309 310 311 312 313 314
#define MOVING_AVERAGE(__avg, __val, __samples) \
	( (((__avg) * ((__samples) - 1)) + (__val)) / (__samples) )

/*
 * When we lack RSSI information return something less then -80 to
 * tell the driver to tune the device to maximum sensitivity.
 */
#define DEFAULT_RSSI	( -128 )
315 316

/*
317
 * Link quality access functions.
318 319 320
 */
static inline int rt2x00_get_link_rssi(struct link *link)
{
321 322
	if (link->qual.avg_rssi && link->qual.rx_success)
		return link->qual.avg_rssi;
323 324 325
	return DEFAULT_RSSI;
}

326 327
/*
 * Interface structure
328 329
 * Per interface configuration details, this structure
 * is allocated as the private data for ieee80211_vif.
330
 */
331
struct rt2x00_intf {
332
	/*
333 334
	 * All fields within the rt2x00_intf structure
	 * must be protected with a spinlock.
335
	 */
336
	spinlock_t lock;
337 338 339 340 341 342 343 344 345 346 347

	/*
	 * MAC of the device.
	 */
	u8 mac[ETH_ALEN];

	/*
	 * BBSID of the AP to associate with.
	 */
	u8 bssid[ETH_ALEN];

348 349 350 351 352 353
	/*
	 * Entry in the beacon queue which belongs to
	 * this interface. Each interface has its own
	 * dedicated beacon entry.
	 */
	struct queue_entry *beacon;
354

355 356 357 358 359
	/*
	 * Actions that needed rescheduling.
	 */
	unsigned int delayed_flags;
#define DELAYED_UPDATE_BEACON		0x00000001
360
#define DELAYED_CONFIG_ERP		0x00000002
361
#define DELAYED_LED_ASSOC		0x00000004
362

363 364 365 366 367 368
	/*
	 * Software sequence counter, this is only required
	 * for hardware which doesn't support hardware
	 * sequence counting.
	 */
	spinlock_t seqlock;
369
	u16 seqno;
370 371 372
};

static inline struct rt2x00_intf* vif_to_intf(struct ieee80211_vif *vif)
373
{
374
	return (struct rt2x00_intf *)vif->drv_priv;
375 376
}

377 378 379
/**
 * struct hw_mode_spec: Hardware specifications structure
 *
380 381 382
 * Details about the supported modes, rates and channels
 * of a particular chipset. This is used by rt2x00lib
 * to build the ieee80211_hw_mode array for mac80211.
383 384 385 386 387
 *
 * @supported_bands: Bitmask contained the supported bands (2.4GHz, 5.2GHz).
 * @supported_rates: Rate types which are supported (CCK, OFDM).
 * @num_channels: Number of supported channels. This is used as array size
 *	for @tx_power_a, @tx_power_bg and @channels.
Ivo van Doorn's avatar
Ivo van Doorn committed
388
 * @channels: Device/chipset specific channel values (See &struct rf_channel).
389
 * @channels_info: Additional information for channels (See &struct channel_info).
390 391
 */
struct hw_mode_spec {
392 393 394 395 396 397 398 399 400 401
	unsigned int supported_bands;
#define SUPPORT_BAND_2GHZ	0x00000001
#define SUPPORT_BAND_5GHZ	0x00000002

	unsigned int supported_rates;
#define SUPPORT_RATE_CCK	0x00000001
#define SUPPORT_RATE_OFDM	0x00000002

	unsigned int num_channels;
	const struct rf_channel *channels;
402
	const struct channel_info *channels_info;
403 404
};

405 406 407 408 409 410 411 412 413
/*
 * Configuration structure wrapper around the
 * mac80211 configuration structure.
 * When mac80211 configures the driver, rt2x00lib
 * can precalculate values which are equal for all
 * rt2x00 drivers. Those values can be stored in here.
 */
struct rt2x00lib_conf {
	struct ieee80211_conf *conf;
414

415
	struct rf_channel rf;
416
	struct channel_info channel;
417 418
};

419 420 421 422 423
/*
 * Configuration structure for erp settings.
 */
struct rt2x00lib_erp {
	int short_preamble;
424
	int cts_protection;
425 426 427

	int ack_timeout;
	int ack_consume_time;
428 429 430 431 432 433 434 435 436

	u64 basic_rates;

	int slot_time;

	short sifs;
	short pifs;
	short difs;
	short eifs;
437 438
};

439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
/*
 * Configuration structure for hardware encryption.
 */
struct rt2x00lib_crypto {
	enum cipher cipher;

	enum set_key_cmd cmd;
	const u8 *address;

	u32 bssidx;
	u32 aid;

	u8 key[16];
	u8 tx_mic[8];
	u8 rx_mic[8];
};

456 457 458 459 460 461 462 463
/*
 * Configuration structure wrapper around the
 * rt2x00 interface configuration handler.
 */
struct rt2x00intf_conf {
	/*
	 * Interface type
	 */
464
	enum nl80211_iftype type;
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486

	/*
	 * TSF sync value, this is dependant on the operation type.
	 */
	enum tsf_sync sync;

	/*
	 * The MAC and BSSID addressess are simple array of bytes,
	 * these arrays are little endian, so when sending the addressess
	 * to the drivers, copy the it into a endian-signed variable.
	 *
	 * Note that all devices (except rt2500usb) have 32 bits
	 * register word sizes. This means that whatever variable we
	 * pass _must_ be a multiple of 32 bits. Otherwise the device
	 * might not accept what we are sending to it.
	 * This will also make it easier for the driver to write
	 * the data to the device.
	 */
	__le32 mac[2];
	__le32 bssid[2];
};

487 488 489 490 491 492 493 494 495 496 497 498 499 500
/*
 * rt2x00lib callback functions.
 */
struct rt2x00lib_ops {
	/*
	 * Interrupt handlers.
	 */
	irq_handler_t irq_handler;

	/*
	 * Device init handlers.
	 */
	int (*probe_hw) (struct rt2x00_dev *rt2x00dev);
	char *(*get_firmware_name) (struct rt2x00_dev *rt2x00dev);
501 502
	u16 (*get_firmware_crc) (const void *data, const size_t len);
	int (*load_firmware) (struct rt2x00_dev *rt2x00dev, const void *data,
503 504 505 506 507 508 509 510
			      const size_t len);

	/*
	 * Device initialization/deinitialization handlers.
	 */
	int (*initialize) (struct rt2x00_dev *rt2x00dev);
	void (*uninitialize) (struct rt2x00_dev *rt2x00dev);

511
	/*
512
	 * queue initialization handlers
513
	 */
514 515
	bool (*get_entry_state) (struct queue_entry *entry);
	void (*clear_entry) (struct queue_entry *entry);
516

517 518 519 520 521 522
	/*
	 * Radio control handlers.
	 */
	int (*set_device_state) (struct rt2x00_dev *rt2x00dev,
				 enum dev_state state);
	int (*rfkill_poll) (struct rt2x00_dev *rt2x00dev);
523 524
	void (*link_stats) (struct rt2x00_dev *rt2x00dev,
			    struct link_qual *qual);
525 526 527 528 529 530 531
	void (*reset_tuner) (struct rt2x00_dev *rt2x00dev);
	void (*link_tuner) (struct rt2x00_dev *rt2x00dev);

	/*
	 * TX control handlers
	 */
	void (*write_tx_desc) (struct rt2x00_dev *rt2x00dev,
532
			       struct sk_buff *skb,
533
			       struct txentry_desc *txdesc);
534
	int (*write_tx_data) (struct queue_entry *entry);
535
	void (*write_beacon) (struct queue_entry *entry);
536
	int (*get_tx_data_len) (struct queue_entry *entry);
537
	void (*kick_tx_queue) (struct rt2x00_dev *rt2x00dev,
538
			       const enum data_queue_qid queue);
539 540 541 542

	/*
	 * RX control handlers
	 */
543 544
	void (*fill_rxdone) (struct queue_entry *entry,
			     struct rxdone_entry_desc *rxdesc);
545 546 547 548

	/*
	 * Configuration handlers.
	 */
549 550 551 552 553 554
	int (*config_shared_key) (struct rt2x00_dev *rt2x00dev,
				  struct rt2x00lib_crypto *crypto,
				  struct ieee80211_key_conf *key);
	int (*config_pairwise_key) (struct rt2x00_dev *rt2x00dev,
				    struct rt2x00lib_crypto *crypto,
				    struct ieee80211_key_conf *key);
Ivo van Doorn's avatar
Ivo van Doorn committed
555 556
	void (*config_filter) (struct rt2x00_dev *rt2x00dev,
			       const unsigned int filter_flags);
557 558 559 560 561 562 563 564
	void (*config_intf) (struct rt2x00_dev *rt2x00dev,
			     struct rt2x00_intf *intf,
			     struct rt2x00intf_conf *conf,
			     const unsigned int flags);
#define CONFIG_UPDATE_TYPE		( 1 << 1 )
#define CONFIG_UPDATE_MAC		( 1 << 2 )
#define CONFIG_UPDATE_BSSID		( 1 << 3 )

Ivo van Doorn's avatar
Ivo van Doorn committed
565 566
	void (*config_erp) (struct rt2x00_dev *rt2x00dev,
			    struct rt2x00lib_erp *erp);
567 568
	void (*config_ant) (struct rt2x00_dev *rt2x00dev,
			    struct antenna_setup *ant);
569 570
	void (*config) (struct rt2x00_dev *rt2x00dev,
			struct rt2x00lib_conf *libconf,
571
			const unsigned int changed_flags);
572 573 574 575 576 577 578
};

/*
 * rt2x00 driver callback operation structure.
 */
struct rt2x00_ops {
	const char *name;
579 580
	const unsigned int max_sta_intf;
	const unsigned int max_ap_intf;
581 582
	const unsigned int eeprom_size;
	const unsigned int rf_size;
583
	const unsigned int tx_queues;
584 585 586 587
	const struct data_queue_desc *rx;
	const struct data_queue_desc *tx;
	const struct data_queue_desc *bcn;
	const struct data_queue_desc *atim;
588 589 590 591 592 593 594
	const struct rt2x00lib_ops *lib;
	const struct ieee80211_ops *hw;
#ifdef CONFIG_RT2X00_LIB_DEBUGFS
	const struct rt2x00debug *debugfs;
#endif /* CONFIG_RT2X00_LIB_DEBUGFS */
};

595 596 597 598 599 600 601
/*
 * rt2x00 device flags
 */
enum rt2x00_flags {
	/*
	 * Device state flags
	 */
602 603 604 605 606 607 608
	DEVICE_STATE_PRESENT,
	DEVICE_STATE_REGISTERED_HW,
	DEVICE_STATE_INITIALIZED,
	DEVICE_STATE_STARTED,
	DEVICE_STATE_STARTED_SUSPEND,
	DEVICE_STATE_ENABLED_RADIO,
	DEVICE_STATE_DISABLED_RADIO_HW,
609 610

	/*
611
	 * Driver requirements
612 613
	 */
	DRIVER_REQUIRE_FIRMWARE,
614 615
	DRIVER_REQUIRE_BEACON_GUARD,
	DRIVER_REQUIRE_ATIM_QUEUE,
Ivo van Doorn's avatar
Ivo van Doorn committed
616
	DRIVER_REQUIRE_SCHEDULED,
617
	DRIVER_REQUIRE_DMA,
618 619

	/*
620
	 * Driver features
621 622
	 */
	CONFIG_SUPPORT_HW_BUTTON,
623 624 625 626 627
	CONFIG_SUPPORT_HW_CRYPTO,

	/*
	 * Driver configuration
	 */
628 629 630 631 632 633
	CONFIG_FRAME_TYPE,
	CONFIG_RF_SEQUENCE,
	CONFIG_EXTERNAL_LNA_A,
	CONFIG_EXTERNAL_LNA_BG,
	CONFIG_DOUBLE_ANTENNA,
	CONFIG_DISABLE_LINK_TUNING,
634
	CONFIG_CRYPTO_COPY_IV,
635 636
};

637 638 639 640 641 642 643 644 645 646 647
/*
 * rt2x00 device structure.
 */
struct rt2x00_dev {
	/*
	 * Device structure.
	 * The structure stored in here depends on the
	 * system bus (PCI or USB).
	 * When accessing this variable, the rt2x00dev_{pci,usb}
	 * macro's should be used for correct typecasting.
	 */
648
	struct device *dev;
649 650 651 652 653 654 655 656 657 658

	/*
	 * Callback functions.
	 */
	const struct rt2x00_ops *ops;

	/*
	 * IEEE80211 control structure.
	 */
	struct ieee80211_hw *hw;
659 660
	struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
	enum ieee80211_band curr_band;
661 662 663 664 665 666

	/*
	 * rfkill structure for RF state switching support.
	 * This will only be compiled in when required.
	 */
#ifdef CONFIG_RT2X00_LIB_RFKILL
667
	unsigned long rfkill_state;
668 669
#define RFKILL_STATE_ALLOCATED		1
#define RFKILL_STATE_REGISTERED		2
670
	struct rfkill *rfkill;
671
	struct delayed_work rfkill_work;
672 673 674 675 676 677 678
#endif /* CONFIG_RT2X00_LIB_RFKILL */

	/*
	 * If enabled, the debugfs interface structures
	 * required for deregistration of debugfs.
	 */
#ifdef CONFIG_RT2X00_LIB_DEBUGFS
679
	struct rt2x00debug_intf *debugfs_intf;
680 681
#endif /* CONFIG_RT2X00_LIB_DEBUGFS */

682 683 684 685 686 687 688 689 690 691 692
	/*
	 * LED structure for changing the LED status
	 * by mac8011 or the kernel.
	 */
#ifdef CONFIG_RT2X00_LIB_LEDS
	struct rt2x00_led led_radio;
	struct rt2x00_led led_assoc;
	struct rt2x00_led led_qual;
	u16 led_mcu_reg;
#endif /* CONFIG_RT2X00_LIB_LEDS */

693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
	/*
	 * Device flags.
	 * In these flags the current status and some
	 * of the device capabilities are stored.
	 */
	unsigned long flags;

	/*
	 * Chipset identification.
	 */
	struct rt2x00_chip chip;

	/*
	 * hw capability specifications.
	 */
	struct hw_mode_spec spec;

710 711
	/*
	 * This is the default TX/RX antenna setup as indicated
712
	 * by the device's EEPROM.
713 714 715
	 */
	struct antenna_setup default_ant;

716 717
	/*
	 * Register pointers
718 719
	 * csr.base: CSR base register address. (PCI)
	 * csr.cache: CSR cache for usb_control_msg. (USB)
720
	 */
721 722 723 724
	union csr {
		void __iomem *base;
		void *cache;
	} csr;
725

726
	/*
727 728 729 730 731 732 733 734 735
	 * Mutex to protect register accesses.
	 * For PCI and USB devices it protects against concurrent indirect
	 * register access (BBP, RF, MCU) since accessing those
	 * registers require multiple calls to the CSR registers.
	 * For USB devices it also protects the csr_cache since that
	 * field is used for normal CSR access and it cannot support
	 * multiple callers simultaneously.
	 */
	struct mutex csr_mutex;
736

737 738 739 740 741 742 743
	/*
	 * Current packet filter configuration for the device.
	 * This contains all currently active FIF_* flags send
	 * to us by mac80211 during configure_filter().
	 */
	unsigned int packet_filter;

744
	/*
745 746 747 748
	 * Interface details:
	 *  - Open ap interface count.
	 *  - Open sta interface count.
	 *  - Association count.
749
	 */
750 751 752
	unsigned int intf_ap_count;
	unsigned int intf_sta_count;
	unsigned int intf_associated;
753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773

	/*
	 * Link quality
	 */
	struct link link;

	/*
	 * EEPROM data.
	 */
	__le16 *eeprom;

	/*
	 * Active RF register values.
	 * These are stored here so we don't need
	 * to read the rf registers and can directly
	 * use this value instead.
	 * This field should be accessed by using
	 * rt2x00_rf_read() and rt2x00_rf_write().
	 */
	u32 *rf;

774 775 776 777 778
	/*
	 * LNA gain
	 */
	short lna_gain;

779 780 781 782 783
	/*
	 * Current TX power value.
	 */
	u16 tx_power;

784 785 786 787 788 789
	/*
	 * Current retry values.
	 */
	u8 short_retry;
	u8 long_retry;

790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811
	/*
	 * Rssi <-> Dbm offset
	 */
	u8 rssi_offset;

	/*
	 * Frequency offset (for rt61pci & rt73usb).
	 */
	u8 freq_offset;

	/*
	 * Low level statistics which will have
	 * to be kept up to date while device is running.
	 */
	struct ieee80211_low_level_stats low_level_stats;

	/*
	 * RX configuration information.
	 */
	struct ieee80211_rx_status rx_status;

	/*
812
	 * Scheduled work.
813 814 815
	 * NOTE: intf_work will use ieee80211_iterate_active_interfaces()
	 * which means it cannot be placed on the hw->workqueue
	 * due to RTNL locking requirements.
816
	 */
817
	struct work_struct intf_work;
818
	struct work_struct filter_work;
819 820

	/*
821 822
	 * Data queue arrays for RX, TX and Beacon.
	 * The Beacon array also contains the Atim queue
823 824
	 * if that is supported by the device.
	 */
825
	unsigned int data_queues;
826 827 828
	struct data_queue *rx;
	struct data_queue *tx;
	struct data_queue *bcn;
829 830 831 832 833 834 835 836 837 838 839

	/*
	 * Firmware image.
	 */
	const struct firmware *fw;
};

/*
 * Generic RF access.
 * The RF is being accessed by word index.
 */
Adam Baker's avatar
Adam Baker committed
840
static inline void rt2x00_rf_read(struct rt2x00_dev *rt2x00dev,
841 842 843 844 845
				  const unsigned int word, u32 *data)
{
	*data = rt2x00dev->rf[word];
}

Adam Baker's avatar
Adam Baker committed
846
static inline void rt2x00_rf_write(struct rt2x00_dev *rt2x00dev,
847 848 849 850 851 852 853 854 855
				   const unsigned int word, u32 data)
{
	rt2x00dev->rf[word] = data;
}

/*
 *  Generic EEPROM access.
 * The EEPROM is being accessed by word index.
 */
Adam Baker's avatar
Adam Baker committed
856
static inline void *rt2x00_eeprom_addr(struct rt2x00_dev *rt2x00dev,
857 858 859 860 861
				       const unsigned int word)
{
	return (void *)&rt2x00dev->eeprom[word];
}

Adam Baker's avatar
Adam Baker committed
862
static inline void rt2x00_eeprom_read(struct rt2x00_dev *rt2x00dev,
863 864 865 866 867
				      const unsigned int word, u16 *data)
{
	*data = le16_to_cpu(rt2x00dev->eeprom[word]);
}

Adam Baker's avatar
Adam Baker committed
868
static inline void rt2x00_eeprom_write(struct rt2x00_dev *rt2x00dev,
869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
				       const unsigned int word, u16 data)
{
	rt2x00dev->eeprom[word] = cpu_to_le16(data);
}

/*
 * Chipset handlers
 */
static inline void rt2x00_set_chip(struct rt2x00_dev *rt2x00dev,
				   const u16 rt, const u16 rf, const u32 rev)
{
	INFO(rt2x00dev,
	     "Chipset detected - rt: %04x, rf: %04x, rev: %08x.\n",
	     rt, rf, rev);

	rt2x00dev->chip.rt = rt;
	rt2x00dev->chip.rf = rf;
	rt2x00dev->chip.rev = rev;
}

static inline char rt2x00_rt(const struct rt2x00_chip *chipset, const u16 chip)
{
	return (chipset->rt == chip);
}

static inline char rt2x00_rf(const struct rt2x00_chip *chipset, const u16 chip)
{
	return (chipset->rf == chip);
}

899
static inline u16 rt2x00_rev(const struct rt2x00_chip *chipset)
900 901 902 903
{
	return chipset->rev;
}

904 905
static inline u16 rt2x00_check_rev(const struct rt2x00_chip *chipset,
				   const u32 rev)
906
{
907 908
	return (((chipset->rev & 0xffff0) == rev) &&
		!!(chipset->rev & 0x0000f));
909 910
}

911
/**
912 913 914
 * rt2x00queue_map_txskb - Map a skb into DMA for TX purposes.
 * @rt2x00dev: Pointer to &struct rt2x00_dev.
 * @skb: The skb to map.
915
 */
916
void rt2x00queue_map_txskb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb);
917

918
/**
919
 * rt2x00queue_get_queue - Convert queue index to queue pointer
920
 * @rt2x00dev: Pointer to &struct rt2x00_dev.
921
 * @queue: rt2x00 queue index (see &enum data_queue_qid).
922
 */
923
struct data_queue *rt2x00queue_get_queue(struct rt2x00_dev *rt2x00dev,
924
					 const enum data_queue_qid queue);
925 926 927

/**
 * rt2x00queue_get_entry - Get queue entry where the given index points to.
Ivo van Doorn's avatar
Ivo van Doorn committed
928
 * @queue: Pointer to &struct data_queue from where we obtain the entry.
929 930 931 932 933
 * @index: Index identifier for obtaining the correct index.
 */
struct queue_entry *rt2x00queue_get_entry(struct data_queue *queue,
					  enum queue_index index);

934 935 936 937
/*
 * Interrupt context handlers.
 */
void rt2x00lib_beacondone(struct rt2x00_dev *rt2x00dev);
938 939
void rt2x00lib_txdone(struct queue_entry *entry,
		      struct txdone_entry_desc *txdesc);
940 941
void rt2x00lib_rxdone(struct rt2x00_dev *rt2x00dev,
		      struct queue_entry *entry);
942 943 944 945

/*
 * mac80211 handlers.
 */
946
int rt2x00mac_tx(struct ieee80211_hw *hw, struct sk_buff *skb);
947 948 949 950 951 952
int rt2x00mac_start(struct ieee80211_hw *hw);
void rt2x00mac_stop(struct ieee80211_hw *hw);
int rt2x00mac_add_interface(struct ieee80211_hw *hw,
			    struct ieee80211_if_init_conf *conf);
void rt2x00mac_remove_interface(struct ieee80211_hw *hw,
				struct ieee80211_if_init_conf *conf);
953
int rt2x00mac_config(struct ieee80211_hw *hw, u32 changed);
954 955
int rt2x00mac_config_interface(struct ieee80211_hw *hw,
			       struct ieee80211_vif *vif,
956
			       struct ieee80211_if_conf *conf);
Ivo van Doorn's avatar
Ivo van Doorn committed
957 958 959 960
void rt2x00mac_configure_filter(struct ieee80211_hw *hw,
				unsigned int changed_flags,
				unsigned int *total_flags,
				int mc_count, struct dev_addr_list *mc_list);
961 962 963 964 965 966 967
#ifdef CONFIG_RT2X00_LIB_CRYPTO
int rt2x00mac_set_key(struct ieee80211_hw *hw, enum set_key_cmd cmd,
		      const u8 *local_address, const u8 *address,
		      struct ieee80211_key_conf *key);
#else
#define rt2x00mac_set_key	NULL
#endif /* CONFIG_RT2X00_LIB_CRYPTO */
968 969 970 971
int rt2x00mac_get_stats(struct ieee80211_hw *hw,
			struct ieee80211_low_level_stats *stats);
int rt2x00mac_get_tx_stats(struct ieee80211_hw *hw,
			   struct ieee80211_tx_queue_stats *stats);
972 973 974 975
void rt2x00mac_bss_info_changed(struct ieee80211_hw *hw,
				struct ieee80211_vif *vif,
				struct ieee80211_bss_conf *bss_conf,
				u32 changes);
Johannes Berg's avatar
Johannes Berg committed
976
int rt2x00mac_conf_tx(struct ieee80211_hw *hw, u16 queue,
977 978 979 980 981 982 983 984 985 986 987 988 989
		      const struct ieee80211_tx_queue_params *params);

/*
 * Driver allocation handlers.
 */
int rt2x00lib_probe_dev(struct rt2x00_dev *rt2x00dev);
void rt2x00lib_remove_dev(struct rt2x00_dev *rt2x00dev);
#ifdef CONFIG_PM
int rt2x00lib_suspend(struct rt2x00_dev *rt2x00dev, pm_message_t state);
int rt2x00lib_resume(struct rt2x00_dev *rt2x00dev);
#endif /* CONFIG_PM */

#endif /* RT2X00_H */