Commit | Line | Data |
---|---|---|
95ea3627 | 1 | /* |
811aa9ca | 2 | Copyright (C) 2004 - 2008 rt2x00 SourceForge Project |
95ea3627 ID |
3 | <http://rt2x00.serialmonkey.com> |
4 | ||
5 | This program is free software; you can redistribute it and/or modify | |
6 | it under the terms of the GNU General Public License as published by | |
7 | the Free Software Foundation; either version 2 of the License, or | |
8 | (at your option) any later version. | |
9 | ||
10 | This program is distributed in the hope that it will be useful, | |
11 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
13 | GNU General Public License for more details. | |
14 | ||
15 | You should have received a copy of the GNU General Public License | |
16 | along with this program; if not, write to the | |
17 | Free Software Foundation, Inc., | |
18 | 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. | |
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> | |
95ea3627 ID |
30 | #include <linux/skbuff.h> |
31 | #include <linux/workqueue.h> | |
32 | #include <linux/firmware.h> | |
a9450b70 | 33 | #include <linux/leds.h> |
3d82346c | 34 | #include <linux/mutex.h> |
61af43c5 | 35 | #include <linux/etherdevice.h> |
95ea3627 ID |
36 | |
37 | #include <net/mac80211.h> | |
38 | ||
39 | #include "rt2x00debug.h" | |
a9450b70 | 40 | #include "rt2x00leds.h" |
95ea3627 | 41 | #include "rt2x00reg.h" |
181d6902 | 42 | #include "rt2x00queue.h" |
95ea3627 ID |
43 | |
44 | /* | |
45 | * Module information. | |
95ea3627 | 46 | */ |
f9d1cf53 | 47 | #define DRV_VERSION "2.1.6" |
95ea3627 ID |
48 | #define DRV_PROJECT "http://rt2x00.serialmonkey.com" |
49 | ||
50 | /* | |
51 | * Debug definitions. | |
52 | * Debug output has to be enabled during compile time. | |
53 | */ | |
54 | #define DEBUG_PRINTK_MSG(__dev, __kernlvl, __lvl, __msg, __args...) \ | |
55 | printk(__kernlvl "%s -> %s: %s - " __msg, \ | |
56 | wiphy_name((__dev)->hw->wiphy), __FUNCTION__, __lvl, ##__args) | |
57 | ||
58 | #define DEBUG_PRINTK_PROBE(__kernlvl, __lvl, __msg, __args...) \ | |
59 | printk(__kernlvl "%s -> %s: %s - " __msg, \ | |
2360157c | 60 | KBUILD_MODNAME, __FUNCTION__, __lvl, ##__args) |
95ea3627 ID |
61 | |
62 | #ifdef CONFIG_RT2X00_DEBUG | |
63 | #define DEBUG_PRINTK(__dev, __kernlvl, __lvl, __msg, __args...) \ | |
64 | DEBUG_PRINTK_MSG(__dev, __kernlvl, __lvl, __msg, ##__args); | |
65 | #else | |
66 | #define DEBUG_PRINTK(__dev, __kernlvl, __lvl, __msg, __args...) \ | |
67 | do { } while (0) | |
68 | #endif /* CONFIG_RT2X00_DEBUG */ | |
69 | ||
70 | /* | |
71 | * Various debug levels. | |
72 | * The debug levels PANIC and ERROR both indicate serious problems, | |
73 | * for this reason they should never be ignored. | |
74 | * The special ERROR_PROBE message is for messages that are generated | |
75 | * when the rt2x00_dev is not yet initialized. | |
76 | */ | |
77 | #define PANIC(__dev, __msg, __args...) \ | |
78 | DEBUG_PRINTK_MSG(__dev, KERN_CRIT, "Panic", __msg, ##__args) | |
79 | #define ERROR(__dev, __msg, __args...) \ | |
80 | DEBUG_PRINTK_MSG(__dev, KERN_ERR, "Error", __msg, ##__args) | |
81 | #define ERROR_PROBE(__msg, __args...) \ | |
82 | DEBUG_PRINTK_PROBE(KERN_ERR, "Error", __msg, ##__args) | |
83 | #define WARNING(__dev, __msg, __args...) \ | |
84 | DEBUG_PRINTK(__dev, KERN_WARNING, "Warning", __msg, ##__args) | |
85 | #define NOTICE(__dev, __msg, __args...) \ | |
86 | DEBUG_PRINTK(__dev, KERN_NOTICE, "Notice", __msg, ##__args) | |
87 | #define INFO(__dev, __msg, __args...) \ | |
88 | DEBUG_PRINTK(__dev, KERN_INFO, "Info", __msg, ##__args) | |
89 | #define DEBUG(__dev, __msg, __args...) \ | |
90 | DEBUG_PRINTK(__dev, KERN_DEBUG, "Debug", __msg, ##__args) | |
91 | #define EEPROM(__dev, __msg, __args...) \ | |
92 | DEBUG_PRINTK(__dev, KERN_DEBUG, "EEPROM recovery", __msg, ##__args) | |
93 | ||
95ea3627 ID |
94 | /* |
95 | * Standard timing and size defines. | |
96 | * These values should follow the ieee80211 specifications. | |
97 | */ | |
98 | #define ACK_SIZE 14 | |
99 | #define IEEE80211_HEADER 24 | |
100 | #define PLCP 48 | |
101 | #define BEACON 100 | |
102 | #define PREAMBLE 144 | |
103 | #define SHORT_PREAMBLE 72 | |
104 | #define SLOT_TIME 20 | |
105 | #define SHORT_SLOT_TIME 9 | |
106 | #define SIFS 10 | |
107 | #define PIFS ( SIFS + SLOT_TIME ) | |
108 | #define SHORT_PIFS ( SIFS + SHORT_SLOT_TIME ) | |
109 | #define DIFS ( PIFS + SLOT_TIME ) | |
110 | #define SHORT_DIFS ( SHORT_PIFS + SHORT_SLOT_TIME ) | |
111 | #define EIFS ( SIFS + (8 * (IEEE80211_HEADER + ACK_SIZE)) ) | |
112 | ||
113 | /* | |
114 | * IEEE802.11 header defines | |
115 | */ | |
116 | static inline int is_rts_frame(u16 fc) | |
117 | { | |
ddc827f9 ID |
118 | return (((fc & IEEE80211_FCTL_FTYPE) == IEEE80211_FTYPE_CTL) && |
119 | ((fc & IEEE80211_FCTL_STYPE) == IEEE80211_STYPE_RTS)); | |
95ea3627 ID |
120 | } |
121 | ||
122 | static inline int is_cts_frame(u16 fc) | |
123 | { | |
ddc827f9 ID |
124 | return (((fc & IEEE80211_FCTL_FTYPE) == IEEE80211_FTYPE_CTL) && |
125 | ((fc & IEEE80211_FCTL_STYPE) == IEEE80211_STYPE_CTS)); | |
95ea3627 ID |
126 | } |
127 | ||
128 | static inline int is_probe_resp(u16 fc) | |
129 | { | |
ddc827f9 ID |
130 | return (((fc & IEEE80211_FCTL_FTYPE) == IEEE80211_FTYPE_MGMT) && |
131 | ((fc & IEEE80211_FCTL_STYPE) == IEEE80211_STYPE_PROBE_RESP)); | |
95ea3627 ID |
132 | } |
133 | ||
61af43c5 MN |
134 | static inline int is_beacon(u16 fc) |
135 | { | |
136 | return (((fc & IEEE80211_FCTL_FTYPE) == IEEE80211_FTYPE_MGMT) && | |
137 | ((fc & IEEE80211_FCTL_STYPE) == IEEE80211_STYPE_BEACON)); | |
138 | } | |
139 | ||
95ea3627 ID |
140 | /* |
141 | * Chipset identification | |
142 | * The chipset on the device is composed of a RT and RF chip. | |
143 | * The chipset combination is important for determining device capabilities. | |
144 | */ | |
145 | struct rt2x00_chip { | |
146 | u16 rt; | |
147 | #define RT2460 0x0101 | |
148 | #define RT2560 0x0201 | |
149 | #define RT2570 0x1201 | |
12dadb90 ID |
150 | #define RT2561s 0x0301 /* Turbo */ |
151 | #define RT2561 0x0302 | |
95ea3627 ID |
152 | #define RT2661 0x0401 |
153 | #define RT2571 0x1300 | |
154 | ||
155 | u16 rf; | |
156 | u32 rev; | |
157 | }; | |
158 | ||
159 | /* | |
160 | * RF register values that belong to a particular channel. | |
161 | */ | |
162 | struct rf_channel { | |
163 | int channel; | |
164 | u32 rf1; | |
165 | u32 rf2; | |
166 | u32 rf3; | |
167 | u32 rf4; | |
168 | }; | |
169 | ||
addc81bd ID |
170 | /* |
171 | * Antenna setup values. | |
172 | */ | |
173 | struct antenna_setup { | |
174 | enum antenna rx; | |
175 | enum antenna tx; | |
176 | }; | |
177 | ||
95ea3627 | 178 | /* |
ebcf26da | 179 | * Quality statistics about the currently active link. |
95ea3627 | 180 | */ |
ebcf26da | 181 | struct link_qual { |
95ea3627 ID |
182 | /* |
183 | * Statistics required for Link tuning. | |
184 | * For the average RSSI value we use the "Walking average" approach. | |
185 | * When adding RSSI to the average value the following calculation | |
186 | * is needed: | |
187 | * | |
188 | * avg_rssi = ((avg_rssi * 7) + rssi) / 8; | |
189 | * | |
190 | * The advantage of this approach is that we only need 1 variable | |
191 | * to store the average in (No need for a count and a total). | |
192 | * But more importantly, normal average values will over time | |
193 | * move less and less towards newly added values this results | |
194 | * that with link tuning, the device can have a very good RSSI | |
195 | * for a few minutes but when the device is moved away from the AP | |
196 | * the average will not decrease fast enough to compensate. | |
197 | * The walking average compensates this and will move towards | |
198 | * the new values correctly allowing a effective link tuning. | |
199 | */ | |
200 | int avg_rssi; | |
95ea3627 ID |
201 | int false_cca; |
202 | ||
203 | /* | |
204 | * Statistics required for Signal quality calculation. | |
205 | * For calculating the Signal quality we have to determine | |
206 | * the total number of success and failed RX and TX frames. | |
207 | * After that we also use the average RSSI value to help | |
208 | * determining the signal quality. | |
209 | * For the calculation we will use the following algorithm: | |
210 | * | |
211 | * rssi_percentage = (avg_rssi * 100) / rssi_offset | |
212 | * rx_percentage = (rx_success * 100) / rx_total | |
213 | * tx_percentage = (tx_success * 100) / tx_total | |
214 | * avg_signal = ((WEIGHT_RSSI * avg_rssi) + | |
215 | * (WEIGHT_TX * tx_percentage) + | |
216 | * (WEIGHT_RX * rx_percentage)) / 100 | |
217 | * | |
218 | * This value should then be checked to not be greated then 100. | |
219 | */ | |
220 | int rx_percentage; | |
221 | int rx_success; | |
222 | int rx_failed; | |
223 | int tx_percentage; | |
224 | int tx_success; | |
225 | int tx_failed; | |
226 | #define WEIGHT_RSSI 20 | |
227 | #define WEIGHT_RX 40 | |
228 | #define WEIGHT_TX 40 | |
ebcf26da ID |
229 | }; |
230 | ||
69f81a2c ID |
231 | /* |
232 | * Antenna settings about the currently active link. | |
233 | */ | |
234 | struct link_ant { | |
235 | /* | |
236 | * Antenna flags | |
237 | */ | |
238 | unsigned int flags; | |
239 | #define ANTENNA_RX_DIVERSITY 0x00000001 | |
240 | #define ANTENNA_TX_DIVERSITY 0x00000002 | |
241 | #define ANTENNA_MODE_SAMPLE 0x00000004 | |
242 | ||
243 | /* | |
244 | * Currently active TX/RX antenna setup. | |
245 | * When software diversity is used, this will indicate | |
246 | * which antenna is actually used at this time. | |
247 | */ | |
248 | struct antenna_setup active; | |
249 | ||
250 | /* | |
251 | * RSSI information for the different antenna's. | |
252 | * These statistics are used to determine when | |
253 | * to switch antenna when using software diversity. | |
254 | * | |
255 | * rssi[0] -> Antenna A RSSI | |
256 | * rssi[1] -> Antenna B RSSI | |
257 | */ | |
258 | int rssi_history[2]; | |
259 | ||
260 | /* | |
261 | * Current RSSI average of the currently active antenna. | |
262 | * Similar to the avg_rssi in the link_qual structure | |
263 | * this value is updated by using the walking average. | |
264 | */ | |
265 | int rssi_ant; | |
266 | }; | |
267 | ||
ebcf26da ID |
268 | /* |
269 | * To optimize the quality of the link we need to store | |
270 | * the quality of received frames and periodically | |
271 | * optimize the link. | |
272 | */ | |
273 | struct link { | |
274 | /* | |
275 | * Link tuner counter | |
276 | * The number of times the link has been tuned | |
277 | * since the radio has been switched on. | |
278 | */ | |
279 | u32 count; | |
280 | ||
281 | /* | |
282 | * Quality measurement values. | |
283 | */ | |
284 | struct link_qual qual; | |
285 | ||
addc81bd | 286 | /* |
69f81a2c | 287 | * TX/RX antenna setup. |
addc81bd | 288 | */ |
69f81a2c | 289 | struct link_ant ant; |
addc81bd | 290 | |
ebcf26da ID |
291 | /* |
292 | * Active VGC level | |
293 | */ | |
294 | int vgc_level; | |
95ea3627 ID |
295 | |
296 | /* | |
297 | * Work structure for scheduling periodic link tuning. | |
298 | */ | |
299 | struct delayed_work work; | |
300 | }; | |
301 | ||
95ea3627 | 302 | /* |
69f81a2c | 303 | * Small helper macro to work with moving/walking averages. |
95ea3627 | 304 | */ |
69f81a2c ID |
305 | #define MOVING_AVERAGE(__avg, __val, __samples) \ |
306 | ( (((__avg) * ((__samples) - 1)) + (__val)) / (__samples) ) | |
307 | ||
308 | /* | |
309 | * When we lack RSSI information return something less then -80 to | |
310 | * tell the driver to tune the device to maximum sensitivity. | |
311 | */ | |
312 | #define DEFAULT_RSSI ( -128 ) | |
95ea3627 ID |
313 | |
314 | /* | |
69f81a2c | 315 | * Link quality access functions. |
95ea3627 ID |
316 | */ |
317 | static inline int rt2x00_get_link_rssi(struct link *link) | |
318 | { | |
ebcf26da ID |
319 | if (link->qual.avg_rssi && link->qual.rx_success) |
320 | return link->qual.avg_rssi; | |
69f81a2c ID |
321 | return DEFAULT_RSSI; |
322 | } | |
323 | ||
324 | static inline int rt2x00_get_link_ant_rssi(struct link *link) | |
325 | { | |
326 | if (link->ant.rssi_ant && link->qual.rx_success) | |
327 | return link->ant.rssi_ant; | |
328 | return DEFAULT_RSSI; | |
329 | } | |
330 | ||
331 | static inline int rt2x00_get_link_ant_rssi_history(struct link *link, | |
332 | enum antenna ant) | |
333 | { | |
334 | if (link->ant.rssi_history[ant - ANTENNA_A]) | |
335 | return link->ant.rssi_history[ant - ANTENNA_A]; | |
336 | return DEFAULT_RSSI; | |
337 | } | |
338 | ||
339 | static inline int rt2x00_update_ant_rssi(struct link *link, int rssi) | |
340 | { | |
341 | int old_rssi = link->ant.rssi_history[link->ant.active.rx - ANTENNA_A]; | |
342 | link->ant.rssi_history[link->ant.active.rx - ANTENNA_A] = rssi; | |
343 | return old_rssi; | |
95ea3627 ID |
344 | } |
345 | ||
346 | /* | |
347 | * Interface structure | |
6bb40dd1 ID |
348 | * Per interface configuration details, this structure |
349 | * is allocated as the private data for ieee80211_vif. | |
95ea3627 | 350 | */ |
6bb40dd1 | 351 | struct rt2x00_intf { |
95ea3627 | 352 | /* |
6bb40dd1 ID |
353 | * All fields within the rt2x00_intf structure |
354 | * must be protected with a spinlock. | |
95ea3627 | 355 | */ |
6bb40dd1 | 356 | spinlock_t lock; |
95ea3627 ID |
357 | |
358 | /* | |
6bb40dd1 ID |
359 | * BSS configuration. Copied from the structure |
360 | * passed to us through the bss_info_changed() | |
361 | * callback funtion. | |
95ea3627 | 362 | */ |
6bb40dd1 | 363 | struct ieee80211_bss_conf conf; |
95ea3627 ID |
364 | |
365 | /* | |
366 | * MAC of the device. | |
367 | */ | |
368 | u8 mac[ETH_ALEN]; | |
369 | ||
370 | /* | |
371 | * BBSID of the AP to associate with. | |
372 | */ | |
373 | u8 bssid[ETH_ALEN]; | |
95ea3627 | 374 | |
6bb40dd1 ID |
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; | |
95ea3627 | 381 | |
6bb40dd1 ID |
382 | /* |
383 | * Actions that needed rescheduling. | |
384 | */ | |
385 | unsigned int delayed_flags; | |
386 | #define DELAYED_UPDATE_BEACON 0x00000001 | |
72810379 | 387 | #define DELAYED_CONFIG_ERP 0x00000002 |
a2e1d52a | 388 | #define DELAYED_LED_ASSOC 0x00000004 |
6bb40dd1 ID |
389 | }; |
390 | ||
391 | static inline struct rt2x00_intf* vif_to_intf(struct ieee80211_vif *vif) | |
95ea3627 | 392 | { |
6bb40dd1 | 393 | return (struct rt2x00_intf *)vif->drv_priv; |
95ea3627 ID |
394 | } |
395 | ||
31562e80 ID |
396 | /** |
397 | * struct hw_mode_spec: Hardware specifications structure | |
398 | * | |
95ea3627 ID |
399 | * Details about the supported modes, rates and channels |
400 | * of a particular chipset. This is used by rt2x00lib | |
401 | * to build the ieee80211_hw_mode array for mac80211. | |
31562e80 ID |
402 | * |
403 | * @supported_bands: Bitmask contained the supported bands (2.4GHz, 5.2GHz). | |
404 | * @supported_rates: Rate types which are supported (CCK, OFDM). | |
405 | * @num_channels: Number of supported channels. This is used as array size | |
406 | * for @tx_power_a, @tx_power_bg and @channels. | |
9a46d44e | 407 | * @channels: Device/chipset specific channel values (See &struct rf_channel). |
31562e80 ID |
408 | * @tx_power_a: TX power values for all 5.2GHz channels (may be NULL). |
409 | * @tx_power_bg: TX power values for all 2.4GHz channels (may be NULL). | |
410 | * @tx_power_default: Default TX power value to use when either | |
411 | * @tx_power_a or @tx_power_bg is missing. | |
95ea3627 ID |
412 | */ |
413 | struct hw_mode_spec { | |
31562e80 ID |
414 | unsigned int supported_bands; |
415 | #define SUPPORT_BAND_2GHZ 0x00000001 | |
416 | #define SUPPORT_BAND_5GHZ 0x00000002 | |
417 | ||
418 | unsigned int supported_rates; | |
419 | #define SUPPORT_RATE_CCK 0x00000001 | |
420 | #define SUPPORT_RATE_OFDM 0x00000002 | |
421 | ||
422 | unsigned int num_channels; | |
423 | const struct rf_channel *channels; | |
95ea3627 | 424 | |
95ea3627 ID |
425 | const u8 *tx_power_a; |
426 | const u8 *tx_power_bg; | |
427 | u8 tx_power_default; | |
95ea3627 ID |
428 | }; |
429 | ||
5c58ee51 ID |
430 | /* |
431 | * Configuration structure wrapper around the | |
432 | * mac80211 configuration structure. | |
433 | * When mac80211 configures the driver, rt2x00lib | |
434 | * can precalculate values which are equal for all | |
435 | * rt2x00 drivers. Those values can be stored in here. | |
436 | */ | |
437 | struct rt2x00lib_conf { | |
438 | struct ieee80211_conf *conf; | |
439 | struct rf_channel rf; | |
440 | ||
addc81bd ID |
441 | struct antenna_setup ant; |
442 | ||
f5507ce9 | 443 | enum ieee80211_band band; |
5c58ee51 | 444 | |
aa776721 ID |
445 | u32 basic_rates; |
446 | u32 slot_time; | |
5c58ee51 ID |
447 | |
448 | short sifs; | |
449 | short pifs; | |
450 | short difs; | |
451 | short eifs; | |
452 | }; | |
453 | ||
72810379 ID |
454 | /* |
455 | * Configuration structure for erp settings. | |
456 | */ | |
457 | struct rt2x00lib_erp { | |
458 | int short_preamble; | |
459 | ||
460 | int ack_timeout; | |
461 | int ack_consume_time; | |
462 | }; | |
463 | ||
6bb40dd1 ID |
464 | /* |
465 | * Configuration structure wrapper around the | |
466 | * rt2x00 interface configuration handler. | |
467 | */ | |
468 | struct rt2x00intf_conf { | |
469 | /* | |
470 | * Interface type | |
471 | */ | |
472 | enum ieee80211_if_types type; | |
473 | ||
474 | /* | |
475 | * TSF sync value, this is dependant on the operation type. | |
476 | */ | |
477 | enum tsf_sync sync; | |
478 | ||
479 | /* | |
480 | * The MAC and BSSID addressess are simple array of bytes, | |
481 | * these arrays are little endian, so when sending the addressess | |
482 | * to the drivers, copy the it into a endian-signed variable. | |
483 | * | |
484 | * Note that all devices (except rt2500usb) have 32 bits | |
485 | * register word sizes. This means that whatever variable we | |
486 | * pass _must_ be a multiple of 32 bits. Otherwise the device | |
487 | * might not accept what we are sending to it. | |
488 | * This will also make it easier for the driver to write | |
489 | * the data to the device. | |
490 | */ | |
491 | __le32 mac[2]; | |
492 | __le32 bssid[2]; | |
493 | }; | |
494 | ||
95ea3627 ID |
495 | /* |
496 | * rt2x00lib callback functions. | |
497 | */ | |
498 | struct rt2x00lib_ops { | |
499 | /* | |
500 | * Interrupt handlers. | |
501 | */ | |
502 | irq_handler_t irq_handler; | |
503 | ||
504 | /* | |
505 | * Device init handlers. | |
506 | */ | |
507 | int (*probe_hw) (struct rt2x00_dev *rt2x00dev); | |
508 | char *(*get_firmware_name) (struct rt2x00_dev *rt2x00dev); | |
a7f3a06c | 509 | u16 (*get_firmware_crc) (void *data, const size_t len); |
95ea3627 ID |
510 | int (*load_firmware) (struct rt2x00_dev *rt2x00dev, void *data, |
511 | const size_t len); | |
512 | ||
513 | /* | |
514 | * Device initialization/deinitialization handlers. | |
515 | */ | |
516 | int (*initialize) (struct rt2x00_dev *rt2x00dev); | |
517 | void (*uninitialize) (struct rt2x00_dev *rt2x00dev); | |
518 | ||
837e7f24 | 519 | /* |
181d6902 | 520 | * queue initialization handlers |
837e7f24 ID |
521 | */ |
522 | void (*init_rxentry) (struct rt2x00_dev *rt2x00dev, | |
181d6902 | 523 | struct queue_entry *entry); |
837e7f24 | 524 | void (*init_txentry) (struct rt2x00_dev *rt2x00dev, |
181d6902 | 525 | struct queue_entry *entry); |
837e7f24 | 526 | |
95ea3627 ID |
527 | /* |
528 | * Radio control handlers. | |
529 | */ | |
530 | int (*set_device_state) (struct rt2x00_dev *rt2x00dev, | |
531 | enum dev_state state); | |
532 | int (*rfkill_poll) (struct rt2x00_dev *rt2x00dev); | |
ebcf26da ID |
533 | void (*link_stats) (struct rt2x00_dev *rt2x00dev, |
534 | struct link_qual *qual); | |
95ea3627 ID |
535 | void (*reset_tuner) (struct rt2x00_dev *rt2x00dev); |
536 | void (*link_tuner) (struct rt2x00_dev *rt2x00dev); | |
537 | ||
538 | /* | |
539 | * TX control handlers | |
540 | */ | |
541 | void (*write_tx_desc) (struct rt2x00_dev *rt2x00dev, | |
dd3193e1 | 542 | struct sk_buff *skb, |
61486e0f | 543 | struct txentry_desc *txdesc); |
95ea3627 | 544 | int (*write_tx_data) (struct rt2x00_dev *rt2x00dev, |
e039fa4a | 545 | struct data_queue *queue, struct sk_buff *skb); |
b242e891 | 546 | int (*get_tx_data_len) (struct rt2x00_dev *rt2x00dev, |
dd9fa2d2 | 547 | struct sk_buff *skb); |
95ea3627 | 548 | void (*kick_tx_queue) (struct rt2x00_dev *rt2x00dev, |
e58c6aca | 549 | const enum data_queue_qid queue); |
95ea3627 ID |
550 | |
551 | /* | |
552 | * RX control handlers | |
553 | */ | |
181d6902 ID |
554 | void (*fill_rxdone) (struct queue_entry *entry, |
555 | struct rxdone_entry_desc *rxdesc); | |
95ea3627 ID |
556 | |
557 | /* | |
558 | * Configuration handlers. | |
559 | */ | |
3a643d24 ID |
560 | void (*config_filter) (struct rt2x00_dev *rt2x00dev, |
561 | const unsigned int filter_flags); | |
6bb40dd1 ID |
562 | void (*config_intf) (struct rt2x00_dev *rt2x00dev, |
563 | struct rt2x00_intf *intf, | |
564 | struct rt2x00intf_conf *conf, | |
565 | const unsigned int flags); | |
566 | #define CONFIG_UPDATE_TYPE ( 1 << 1 ) | |
567 | #define CONFIG_UPDATE_MAC ( 1 << 2 ) | |
568 | #define CONFIG_UPDATE_BSSID ( 1 << 3 ) | |
569 | ||
3a643d24 ID |
570 | void (*config_erp) (struct rt2x00_dev *rt2x00dev, |
571 | struct rt2x00lib_erp *erp); | |
6bb40dd1 ID |
572 | void (*config) (struct rt2x00_dev *rt2x00dev, |
573 | struct rt2x00lib_conf *libconf, | |
574 | const unsigned int flags); | |
95ea3627 ID |
575 | #define CONFIG_UPDATE_PHYMODE ( 1 << 1 ) |
576 | #define CONFIG_UPDATE_CHANNEL ( 1 << 2 ) | |
577 | #define CONFIG_UPDATE_TXPOWER ( 1 << 3 ) | |
578 | #define CONFIG_UPDATE_ANTENNA ( 1 << 4 ) | |
579 | #define CONFIG_UPDATE_SLOT_TIME ( 1 << 5 ) | |
580 | #define CONFIG_UPDATE_BEACON_INT ( 1 << 6 ) | |
581 | #define CONFIG_UPDATE_ALL 0xffff | |
582 | }; | |
583 | ||
584 | /* | |
585 | * rt2x00 driver callback operation structure. | |
586 | */ | |
587 | struct rt2x00_ops { | |
588 | const char *name; | |
6bb40dd1 ID |
589 | const unsigned int max_sta_intf; |
590 | const unsigned int max_ap_intf; | |
95ea3627 ID |
591 | const unsigned int eeprom_size; |
592 | const unsigned int rf_size; | |
61448f88 | 593 | const unsigned int tx_queues; |
181d6902 ID |
594 | const struct data_queue_desc *rx; |
595 | const struct data_queue_desc *tx; | |
596 | const struct data_queue_desc *bcn; | |
597 | const struct data_queue_desc *atim; | |
95ea3627 ID |
598 | const struct rt2x00lib_ops *lib; |
599 | const struct ieee80211_ops *hw; | |
600 | #ifdef CONFIG_RT2X00_LIB_DEBUGFS | |
601 | const struct rt2x00debug *debugfs; | |
602 | #endif /* CONFIG_RT2X00_LIB_DEBUGFS */ | |
603 | }; | |
604 | ||
483272f5 ID |
605 | /* |
606 | * rt2x00 device flags | |
607 | */ | |
608 | enum rt2x00_flags { | |
609 | /* | |
610 | * Device state flags | |
611 | */ | |
612 | DEVICE_PRESENT, | |
613 | DEVICE_REGISTERED_HW, | |
614 | DEVICE_INITIALIZED, | |
615 | DEVICE_STARTED, | |
616 | DEVICE_STARTED_SUSPEND, | |
617 | DEVICE_ENABLED_RADIO, | |
81873e9c | 618 | DEVICE_DISABLED_RADIO_HW, |
483272f5 ID |
619 | |
620 | /* | |
621 | * Driver features | |
622 | */ | |
623 | DRIVER_REQUIRE_FIRMWARE, | |
181d6902 ID |
624 | DRIVER_REQUIRE_BEACON_GUARD, |
625 | DRIVER_REQUIRE_ATIM_QUEUE, | |
3a643d24 | 626 | DRIVER_REQUIRE_SCHEDULED, |
483272f5 ID |
627 | |
628 | /* | |
629 | * Driver configuration | |
630 | */ | |
631 | CONFIG_SUPPORT_HW_BUTTON, | |
632 | CONFIG_FRAME_TYPE, | |
633 | CONFIG_RF_SEQUENCE, | |
634 | CONFIG_EXTERNAL_LNA_A, | |
635 | CONFIG_EXTERNAL_LNA_BG, | |
636 | CONFIG_DOUBLE_ANTENNA, | |
637 | CONFIG_DISABLE_LINK_TUNING, | |
638 | }; | |
639 | ||
95ea3627 ID |
640 | /* |
641 | * rt2x00 device structure. | |
642 | */ | |
643 | struct rt2x00_dev { | |
644 | /* | |
645 | * Device structure. | |
646 | * The structure stored in here depends on the | |
647 | * system bus (PCI or USB). | |
648 | * When accessing this variable, the rt2x00dev_{pci,usb} | |
649 | * macro's should be used for correct typecasting. | |
650 | */ | |
651 | void *dev; | |
181d6902 ID |
652 | #define rt2x00dev_pci(__dev) ( (struct pci_dev *)(__dev)->dev ) |
653 | #define rt2x00dev_usb(__dev) ( (struct usb_interface *)(__dev)->dev ) | |
654 | #define rt2x00dev_usb_dev(__dev)\ | |
655 | ( (struct usb_device *)interface_to_usbdev(rt2x00dev_usb(__dev)) ) | |
95ea3627 ID |
656 | |
657 | /* | |
658 | * Callback functions. | |
659 | */ | |
660 | const struct rt2x00_ops *ops; | |
661 | ||
662 | /* | |
663 | * IEEE80211 control structure. | |
664 | */ | |
665 | struct ieee80211_hw *hw; | |
8318d78a JB |
666 | struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS]; |
667 | enum ieee80211_band curr_band; | |
95ea3627 ID |
668 | |
669 | /* | |
670 | * rfkill structure for RF state switching support. | |
671 | * This will only be compiled in when required. | |
672 | */ | |
673 | #ifdef CONFIG_RT2X00_LIB_RFKILL | |
3480a58a | 674 | unsigned long rfkill_state; |
1682fe6d ID |
675 | #define RFKILL_STATE_ALLOCATED 1 |
676 | #define RFKILL_STATE_REGISTERED 2 | |
95ea3627 ID |
677 | struct rfkill *rfkill; |
678 | struct input_polled_dev *poll_dev; | |
679 | #endif /* CONFIG_RT2X00_LIB_RFKILL */ | |
680 | ||
681 | /* | |
682 | * If enabled, the debugfs interface structures | |
683 | * required for deregistration of debugfs. | |
684 | */ | |
685 | #ifdef CONFIG_RT2X00_LIB_DEBUGFS | |
4d8dd66c | 686 | struct rt2x00debug_intf *debugfs_intf; |
95ea3627 ID |
687 | #endif /* CONFIG_RT2X00_LIB_DEBUGFS */ |
688 | ||
a9450b70 ID |
689 | /* |
690 | * LED structure for changing the LED status | |
691 | * by mac8011 or the kernel. | |
692 | */ | |
693 | #ifdef CONFIG_RT2X00_LIB_LEDS | |
a9450b70 ID |
694 | struct rt2x00_led led_radio; |
695 | struct rt2x00_led led_assoc; | |
696 | struct rt2x00_led led_qual; | |
697 | u16 led_mcu_reg; | |
698 | #endif /* CONFIG_RT2X00_LIB_LEDS */ | |
699 | ||
95ea3627 ID |
700 | /* |
701 | * Device flags. | |
702 | * In these flags the current status and some | |
703 | * of the device capabilities are stored. | |
704 | */ | |
705 | unsigned long flags; | |
95ea3627 ID |
706 | |
707 | /* | |
708 | * Chipset identification. | |
709 | */ | |
710 | struct rt2x00_chip chip; | |
711 | ||
712 | /* | |
713 | * hw capability specifications. | |
714 | */ | |
715 | struct hw_mode_spec spec; | |
716 | ||
addc81bd ID |
717 | /* |
718 | * This is the default TX/RX antenna setup as indicated | |
719 | * by the device's EEPROM. When mac80211 sets its | |
720 | * antenna value to 0 we should be using these values. | |
721 | */ | |
722 | struct antenna_setup default_ant; | |
723 | ||
95ea3627 ID |
724 | /* |
725 | * Register pointers | |
21795094 ID |
726 | * csr.base: CSR base register address. (PCI) |
727 | * csr.cache: CSR cache for usb_control_msg. (USB) | |
95ea3627 | 728 | */ |
21795094 ID |
729 | union csr { |
730 | void __iomem *base; | |
731 | void *cache; | |
732 | } csr; | |
95ea3627 | 733 | |
3d82346c AB |
734 | /* |
735 | * Mutex to protect register accesses on USB devices. | |
736 | * There are 2 reasons this is needed, one is to ensure | |
737 | * use of the csr_cache (for USB devices) by one thread | |
738 | * isn't corrupted by another thread trying to access it. | |
739 | * The other is that access to BBP and RF registers | |
740 | * require multiple BUS transactions and if another thread | |
741 | * attempted to access one of those registers at the same | |
742 | * time one of the writes could silently fail. | |
743 | */ | |
744 | struct mutex usb_cache_mutex; | |
745 | ||
3c4f2085 ID |
746 | /* |
747 | * Current packet filter configuration for the device. | |
748 | * This contains all currently active FIF_* flags send | |
749 | * to us by mac80211 during configure_filter(). | |
750 | */ | |
751 | unsigned int packet_filter; | |
752 | ||
95ea3627 | 753 | /* |
6bb40dd1 ID |
754 | * Interface details: |
755 | * - Open ap interface count. | |
756 | * - Open sta interface count. | |
757 | * - Association count. | |
95ea3627 | 758 | */ |
6bb40dd1 ID |
759 | unsigned int intf_ap_count; |
760 | unsigned int intf_sta_count; | |
761 | unsigned int intf_associated; | |
95ea3627 ID |
762 | |
763 | /* | |
764 | * Link quality | |
765 | */ | |
766 | struct link link; | |
767 | ||
768 | /* | |
769 | * EEPROM data. | |
770 | */ | |
771 | __le16 *eeprom; | |
772 | ||
773 | /* | |
774 | * Active RF register values. | |
775 | * These are stored here so we don't need | |
776 | * to read the rf registers and can directly | |
777 | * use this value instead. | |
778 | * This field should be accessed by using | |
779 | * rt2x00_rf_read() and rt2x00_rf_write(). | |
780 | */ | |
781 | u32 *rf; | |
782 | ||
b242e891 ID |
783 | /* |
784 | * USB Max frame size (for rt2500usb & rt73usb). | |
785 | */ | |
786 | u16 usb_maxpacket; | |
787 | ||
95ea3627 ID |
788 | /* |
789 | * Current TX power value. | |
790 | */ | |
791 | u16 tx_power; | |
792 | ||
95ea3627 ID |
793 | /* |
794 | * Rssi <-> Dbm offset | |
795 | */ | |
796 | u8 rssi_offset; | |
797 | ||
798 | /* | |
799 | * Frequency offset (for rt61pci & rt73usb). | |
800 | */ | |
801 | u8 freq_offset; | |
802 | ||
803 | /* | |
804 | * Low level statistics which will have | |
805 | * to be kept up to date while device is running. | |
806 | */ | |
807 | struct ieee80211_low_level_stats low_level_stats; | |
808 | ||
809 | /* | |
810 | * RX configuration information. | |
811 | */ | |
812 | struct ieee80211_rx_status rx_status; | |
813 | ||
814 | /* | |
4150c572 | 815 | * Scheduled work. |
95ea3627 | 816 | */ |
6bb40dd1 | 817 | struct work_struct intf_work; |
4150c572 | 818 | struct work_struct filter_work; |
95ea3627 ID |
819 | |
820 | /* | |
181d6902 ID |
821 | * Data queue arrays for RX, TX and Beacon. |
822 | * The Beacon array also contains the Atim queue | |
95ea3627 ID |
823 | * if that is supported by the device. |
824 | */ | |
181d6902 ID |
825 | int data_queues; |
826 | struct data_queue *rx; | |
827 | struct data_queue *tx; | |
828 | struct data_queue *bcn; | |
95ea3627 ID |
829 | |
830 | /* | |
831 | * Firmware image. | |
832 | */ | |
833 | const struct firmware *fw; | |
834 | }; | |
835 | ||
95ea3627 ID |
836 | /* |
837 | * Generic RF access. | |
838 | * The RF is being accessed by word index. | |
839 | */ | |
0e14f6d3 | 840 | static inline void rt2x00_rf_read(struct rt2x00_dev *rt2x00dev, |
95ea3627 ID |
841 | const unsigned int word, u32 *data) |
842 | { | |
843 | *data = rt2x00dev->rf[word]; | |
844 | } | |
845 | ||
0e14f6d3 | 846 | static inline void rt2x00_rf_write(struct rt2x00_dev *rt2x00dev, |
95ea3627 ID |
847 | const unsigned int word, u32 data) |
848 | { | |
849 | rt2x00dev->rf[word] = data; | |
850 | } | |
851 | ||
852 | /* | |
853 | * Generic EEPROM access. | |
854 | * The EEPROM is being accessed by word index. | |
855 | */ | |
0e14f6d3 | 856 | static inline void *rt2x00_eeprom_addr(struct rt2x00_dev *rt2x00dev, |
95ea3627 ID |
857 | const unsigned int word) |
858 | { | |
859 | return (void *)&rt2x00dev->eeprom[word]; | |
860 | } | |
861 | ||
0e14f6d3 | 862 | static inline void rt2x00_eeprom_read(struct rt2x00_dev *rt2x00dev, |
95ea3627 ID |
863 | const unsigned int word, u16 *data) |
864 | { | |
865 | *data = le16_to_cpu(rt2x00dev->eeprom[word]); | |
866 | } | |
867 | ||
0e14f6d3 | 868 | static inline void rt2x00_eeprom_write(struct rt2x00_dev *rt2x00dev, |
95ea3627 ID |
869 | const unsigned int word, u16 data) |
870 | { | |
871 | rt2x00dev->eeprom[word] = cpu_to_le16(data); | |
872 | } | |
873 | ||
874 | /* | |
875 | * Chipset handlers | |
876 | */ | |
877 | static inline void rt2x00_set_chip(struct rt2x00_dev *rt2x00dev, | |
878 | const u16 rt, const u16 rf, const u32 rev) | |
879 | { | |
880 | INFO(rt2x00dev, | |
881 | "Chipset detected - rt: %04x, rf: %04x, rev: %08x.\n", | |
882 | rt, rf, rev); | |
883 | ||
884 | rt2x00dev->chip.rt = rt; | |
885 | rt2x00dev->chip.rf = rf; | |
886 | rt2x00dev->chip.rev = rev; | |
887 | } | |
888 | ||
889 | static inline char rt2x00_rt(const struct rt2x00_chip *chipset, const u16 chip) | |
890 | { | |
891 | return (chipset->rt == chip); | |
892 | } | |
893 | ||
894 | static inline char rt2x00_rf(const struct rt2x00_chip *chipset, const u16 chip) | |
895 | { | |
896 | return (chipset->rf == chip); | |
897 | } | |
898 | ||
755a957d | 899 | static inline u16 rt2x00_rev(const struct rt2x00_chip *chipset) |
95ea3627 ID |
900 | { |
901 | return chipset->rev; | |
902 | } | |
903 | ||
755a957d ID |
904 | static inline u16 rt2x00_check_rev(const struct rt2x00_chip *chipset, |
905 | const u32 rev) | |
95ea3627 | 906 | { |
755a957d ID |
907 | return (((chipset->rev & 0xffff0) == rev) && |
908 | !!(chipset->rev & 0x0000f)); | |
95ea3627 ID |
909 | } |
910 | ||
911 | /* | |
912 | * Duration calculations | |
913 | * The rate variable passed is: 100kbs. | |
914 | * To convert from bytes to bits we multiply size with 8, | |
915 | * then the size is multiplied with 10 to make the | |
916 | * real rate -> rate argument correction. | |
917 | */ | |
918 | static inline u16 get_duration(const unsigned int size, const u8 rate) | |
919 | { | |
920 | return ((size * 8 * 10) / rate); | |
921 | } | |
922 | ||
923 | static inline u16 get_duration_res(const unsigned int size, const u8 rate) | |
924 | { | |
925 | return ((size * 8 * 10) % rate); | |
926 | } | |
927 | ||
7050ec82 ID |
928 | /** |
929 | * rt2x00queue_create_tx_descriptor - Create TX descriptor from mac80211 input | |
930 | * @entry: The entry which will be used to transfer the TX frame. | |
931 | * @txdesc: rt2x00 TX descriptor which will be initialized by this function. | |
7050ec82 ID |
932 | * |
933 | * This function will initialize the &struct txentry_desc based on information | |
934 | * from mac80211. This descriptor can then be used by rt2x00lib and the drivers | |
935 | * to correctly initialize the hardware descriptor. | |
936 | * Note that before calling this function the skb->cb array must be untouched | |
937 | * by rt2x00lib. Only after this function completes will it be save to | |
938 | * overwrite the skb->cb information. | |
939 | * The reason for this is that mac80211 writes its own tx information into | |
940 | * the skb->cb array, and this function will use that information to initialize | |
941 | * the &struct txentry_desc structure. | |
942 | */ | |
943 | void rt2x00queue_create_tx_descriptor(struct queue_entry *entry, | |
e039fa4a | 944 | struct txentry_desc *txdesc); |
7050ec82 ID |
945 | |
946 | /** | |
947 | * rt2x00queue_write_tx_descriptor - Write TX descriptor to hardware | |
948 | * @entry: The entry which will be used to transfer the TX frame. | |
949 | * @txdesc: TX descriptor which will be used to write hardware descriptor | |
950 | * | |
951 | * This function will write a TX descriptor initialized by | |
952 | * &rt2x00queue_create_tx_descriptor to the hardware. After this call | |
953 | * has completed the frame is now owned by the hardware, the hardware | |
954 | * queue will have automatically be kicked unless this frame was generated | |
955 | * by rt2x00lib, in which case the frame is "special" and must be kicked | |
956 | * by the caller. | |
957 | */ | |
958 | void rt2x00queue_write_tx_descriptor(struct queue_entry *entry, | |
959 | struct txentry_desc *txdesc); | |
960 | ||
181d6902 | 961 | /** |
e58c6aca | 962 | * rt2x00queue_get_queue - Convert queue index to queue pointer |
181d6902 | 963 | * @rt2x00dev: Pointer to &struct rt2x00_dev. |
e58c6aca | 964 | * @queue: rt2x00 queue index (see &enum data_queue_qid). |
95ea3627 | 965 | */ |
181d6902 | 966 | struct data_queue *rt2x00queue_get_queue(struct rt2x00_dev *rt2x00dev, |
e58c6aca | 967 | const enum data_queue_qid queue); |
181d6902 ID |
968 | |
969 | /** | |
970 | * rt2x00queue_get_entry - Get queue entry where the given index points to. | |
9a46d44e | 971 | * @queue: Pointer to &struct data_queue from where we obtain the entry. |
181d6902 ID |
972 | * @index: Index identifier for obtaining the correct index. |
973 | */ | |
974 | struct queue_entry *rt2x00queue_get_entry(struct data_queue *queue, | |
975 | enum queue_index index); | |
976 | ||
977 | /** | |
978 | * rt2x00queue_index_inc - Index incrementation function | |
979 | * @queue: Queue (&struct data_queue) to perform the action on. | |
9a46d44e | 980 | * @index: Index type (&enum queue_index) to perform the action on. |
181d6902 ID |
981 | * |
982 | * This function will increase the requested index on the queue, | |
983 | * it will grab the appropriate locks and handle queue overflow events by | |
984 | * resetting the index to the start of the queue. | |
985 | */ | |
986 | void rt2x00queue_index_inc(struct data_queue *queue, enum queue_index index); | |
987 | ||
95ea3627 ID |
988 | |
989 | /* | |
990 | * Interrupt context handlers. | |
991 | */ | |
992 | void rt2x00lib_beacondone(struct rt2x00_dev *rt2x00dev); | |
181d6902 ID |
993 | void rt2x00lib_txdone(struct queue_entry *entry, |
994 | struct txdone_entry_desc *txdesc); | |
995 | void rt2x00lib_rxdone(struct queue_entry *entry, | |
996 | struct rxdone_entry_desc *rxdesc); | |
95ea3627 | 997 | |
95ea3627 ID |
998 | /* |
999 | * mac80211 handlers. | |
1000 | */ | |
e039fa4a | 1001 | int rt2x00mac_tx(struct ieee80211_hw *hw, struct sk_buff *skb); |
95ea3627 ID |
1002 | int rt2x00mac_start(struct ieee80211_hw *hw); |
1003 | void rt2x00mac_stop(struct ieee80211_hw *hw); | |
1004 | int rt2x00mac_add_interface(struct ieee80211_hw *hw, | |
1005 | struct ieee80211_if_init_conf *conf); | |
1006 | void rt2x00mac_remove_interface(struct ieee80211_hw *hw, | |
1007 | struct ieee80211_if_init_conf *conf); | |
1008 | int rt2x00mac_config(struct ieee80211_hw *hw, struct ieee80211_conf *conf); | |
32bfd35d JB |
1009 | int rt2x00mac_config_interface(struct ieee80211_hw *hw, |
1010 | struct ieee80211_vif *vif, | |
95ea3627 | 1011 | struct ieee80211_if_conf *conf); |
3a643d24 ID |
1012 | void rt2x00mac_configure_filter(struct ieee80211_hw *hw, |
1013 | unsigned int changed_flags, | |
1014 | unsigned int *total_flags, | |
1015 | int mc_count, struct dev_addr_list *mc_list); | |
95ea3627 ID |
1016 | int rt2x00mac_get_stats(struct ieee80211_hw *hw, |
1017 | struct ieee80211_low_level_stats *stats); | |
1018 | int rt2x00mac_get_tx_stats(struct ieee80211_hw *hw, | |
1019 | struct ieee80211_tx_queue_stats *stats); | |
471b3efd JB |
1020 | void rt2x00mac_bss_info_changed(struct ieee80211_hw *hw, |
1021 | struct ieee80211_vif *vif, | |
1022 | struct ieee80211_bss_conf *bss_conf, | |
1023 | u32 changes); | |
e100bb64 | 1024 | int rt2x00mac_conf_tx(struct ieee80211_hw *hw, u16 queue, |
95ea3627 ID |
1025 | const struct ieee80211_tx_queue_params *params); |
1026 | ||
1027 | /* | |
1028 | * Driver allocation handlers. | |
1029 | */ | |
1030 | int rt2x00lib_probe_dev(struct rt2x00_dev *rt2x00dev); | |
1031 | void rt2x00lib_remove_dev(struct rt2x00_dev *rt2x00dev); | |
1032 | #ifdef CONFIG_PM | |
1033 | int rt2x00lib_suspend(struct rt2x00_dev *rt2x00dev, pm_message_t state); | |
1034 | int rt2x00lib_resume(struct rt2x00_dev *rt2x00dev); | |
1035 | #endif /* CONFIG_PM */ | |
1036 | ||
1037 | #endif /* RT2X00_H */ |