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