Commit | Line | Data |
---|---|---|
95ea3627 | 1 | /* |
4e54c711 | 2 | Copyright (C) 2004 - 2009 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> |
cca3e998 | 36 | #include <linux/input-polldev.h> |
95ea3627 ID |
37 | |
38 | #include <net/mac80211.h> | |
39 | ||
40 | #include "rt2x00debug.h" | |
a9450b70 | 41 | #include "rt2x00leds.h" |
95ea3627 | 42 | #include "rt2x00reg.h" |
181d6902 | 43 | #include "rt2x00queue.h" |
95ea3627 ID |
44 | |
45 | /* | |
46 | * Module information. | |
95ea3627 | 47 | */ |
754be309 | 48 | #define DRV_VERSION "2.3.0" |
95ea3627 ID |
49 | #define DRV_PROJECT "http://rt2x00.serialmonkey.com" |
50 | ||
51 | /* | |
52 | * Debug definitions. | |
53 | * Debug output has to be enabled during compile time. | |
54 | */ | |
55 | #define DEBUG_PRINTK_MSG(__dev, __kernlvl, __lvl, __msg, __args...) \ | |
56 | printk(__kernlvl "%s -> %s: %s - " __msg, \ | |
c94c93da | 57 | wiphy_name((__dev)->hw->wiphy), __func__, __lvl, ##__args) |
95ea3627 ID |
58 | |
59 | #define DEBUG_PRINTK_PROBE(__kernlvl, __lvl, __msg, __args...) \ | |
60 | printk(__kernlvl "%s -> %s: %s - " __msg, \ | |
c94c93da | 61 | KBUILD_MODNAME, __func__, __lvl, ##__args) |
95ea3627 ID |
62 | |
63 | #ifdef CONFIG_RT2X00_DEBUG | |
64 | #define DEBUG_PRINTK(__dev, __kernlvl, __lvl, __msg, __args...) \ | |
65 | DEBUG_PRINTK_MSG(__dev, __kernlvl, __lvl, __msg, ##__args); | |
66 | #else | |
67 | #define DEBUG_PRINTK(__dev, __kernlvl, __lvl, __msg, __args...) \ | |
68 | do { } while (0) | |
69 | #endif /* CONFIG_RT2X00_DEBUG */ | |
70 | ||
71 | /* | |
72 | * Various debug levels. | |
73 | * The debug levels PANIC and ERROR both indicate serious problems, | |
74 | * for this reason they should never be ignored. | |
75 | * The special ERROR_PROBE message is for messages that are generated | |
76 | * when the rt2x00_dev is not yet initialized. | |
77 | */ | |
78 | #define PANIC(__dev, __msg, __args...) \ | |
79 | DEBUG_PRINTK_MSG(__dev, KERN_CRIT, "Panic", __msg, ##__args) | |
80 | #define ERROR(__dev, __msg, __args...) \ | |
81 | DEBUG_PRINTK_MSG(__dev, KERN_ERR, "Error", __msg, ##__args) | |
82 | #define ERROR_PROBE(__msg, __args...) \ | |
83 | DEBUG_PRINTK_PROBE(KERN_ERR, "Error", __msg, ##__args) | |
84 | #define WARNING(__dev, __msg, __args...) \ | |
85 | DEBUG_PRINTK(__dev, KERN_WARNING, "Warning", __msg, ##__args) | |
86 | #define NOTICE(__dev, __msg, __args...) \ | |
87 | DEBUG_PRINTK(__dev, KERN_NOTICE, "Notice", __msg, ##__args) | |
88 | #define INFO(__dev, __msg, __args...) \ | |
89 | DEBUG_PRINTK(__dev, KERN_INFO, "Info", __msg, ##__args) | |
90 | #define DEBUG(__dev, __msg, __args...) \ | |
91 | DEBUG_PRINTK(__dev, KERN_DEBUG, "Debug", __msg, ##__args) | |
92 | #define EEPROM(__dev, __msg, __args...) \ | |
93 | DEBUG_PRINTK(__dev, KERN_DEBUG, "EEPROM recovery", __msg, ##__args) | |
94 | ||
bad13639 ID |
95 | /* |
96 | * Duration calculations | |
97 | * The rate variable passed is: 100kbs. | |
98 | * To convert from bytes to bits we multiply size with 8, | |
99 | * then the size is multiplied with 10 to make the | |
100 | * real rate -> rate argument correction. | |
101 | */ | |
102 | #define GET_DURATION(__size, __rate) (((__size) * 8 * 10) / (__rate)) | |
103 | #define GET_DURATION_RES(__size, __rate)(((__size) * 8 * 10) % (__rate)) | |
104 | ||
95ea3627 ID |
105 | /* |
106 | * Standard timing and size defines. | |
107 | * These values should follow the ieee80211 specifications. | |
108 | */ | |
109 | #define ACK_SIZE 14 | |
110 | #define IEEE80211_HEADER 24 | |
111 | #define PLCP 48 | |
112 | #define BEACON 100 | |
113 | #define PREAMBLE 144 | |
114 | #define SHORT_PREAMBLE 72 | |
115 | #define SLOT_TIME 20 | |
116 | #define SHORT_SLOT_TIME 9 | |
117 | #define SIFS 10 | |
118 | #define PIFS ( SIFS + SLOT_TIME ) | |
119 | #define SHORT_PIFS ( SIFS + SHORT_SLOT_TIME ) | |
120 | #define DIFS ( PIFS + SLOT_TIME ) | |
121 | #define SHORT_DIFS ( SHORT_PIFS + SHORT_SLOT_TIME ) | |
f2fdbc48 | 122 | #define EIFS ( SIFS + DIFS + \ |
bad13639 | 123 | GET_DURATION(IEEE80211_HEADER + ACK_SIZE, 10) ) |
f2fdbc48 | 124 | #define SHORT_EIFS ( SIFS + SHORT_DIFS + \ |
bad13639 | 125 | GET_DURATION(IEEE80211_HEADER + ACK_SIZE, 10) ) |
95ea3627 | 126 | |
95ea3627 ID |
127 | /* |
128 | * Chipset identification | |
129 | * The chipset on the device is composed of a RT and RF chip. | |
130 | * The chipset combination is important for determining device capabilities. | |
131 | */ | |
132 | struct rt2x00_chip { | |
133 | u16 rt; | |
134 | #define RT2460 0x0101 | |
135 | #define RT2560 0x0201 | |
136 | #define RT2570 0x1201 | |
12dadb90 ID |
137 | #define RT2561s 0x0301 /* Turbo */ |
138 | #define RT2561 0x0302 | |
95ea3627 ID |
139 | #define RT2661 0x0401 |
140 | #define RT2571 0x1300 | |
141 | ||
142 | u16 rf; | |
143 | u32 rev; | |
144 | }; | |
145 | ||
146 | /* | |
147 | * RF register values that belong to a particular channel. | |
148 | */ | |
149 | struct rf_channel { | |
150 | int channel; | |
151 | u32 rf1; | |
152 | u32 rf2; | |
153 | u32 rf3; | |
154 | u32 rf4; | |
155 | }; | |
156 | ||
8c5e7a5f ID |
157 | /* |
158 | * Channel information structure | |
159 | */ | |
160 | struct channel_info { | |
161 | unsigned int flags; | |
162 | #define GEOGRAPHY_ALLOWED 0x00000001 | |
163 | ||
164 | short tx_power1; | |
165 | short tx_power2; | |
166 | }; | |
167 | ||
addc81bd ID |
168 | /* |
169 | * Antenna setup values. | |
170 | */ | |
171 | struct antenna_setup { | |
172 | enum antenna rx; | |
173 | enum antenna tx; | |
174 | }; | |
175 | ||
95ea3627 | 176 | /* |
ebcf26da | 177 | * Quality statistics about the currently active link. |
95ea3627 | 178 | */ |
ebcf26da | 179 | struct link_qual { |
95ea3627 | 180 | /* |
5352ff65 ID |
181 | * Statistics required for Link tuning by driver |
182 | * The rssi value is provided by rt2x00lib during the | |
183 | * link_tuner() callback function. | |
184 | * The false_cca field is filled during the link_stats() | |
185 | * callback function and could be used during the | |
186 | * link_tuner() callback function. | |
95ea3627 | 187 | */ |
5352ff65 | 188 | int rssi; |
95ea3627 ID |
189 | int false_cca; |
190 | ||
191 | /* | |
5352ff65 ID |
192 | * VGC levels |
193 | * Hardware driver will tune the VGC level during each call | |
194 | * to the link_tuner() callback function. This vgc_level is | |
195 | * is determined based on the link quality statistics like | |
196 | * average RSSI and the false CCA count. | |
95ea3627 | 197 | * |
5352ff65 ID |
198 | * In some cases the drivers need to differentiate between |
199 | * the currently "desired" VGC level and the level configured | |
200 | * in the hardware. The latter is important to reduce the | |
201 | * number of BBP register reads to reduce register access | |
202 | * overhead. For this reason we store both values here. | |
203 | */ | |
204 | u8 vgc_level; | |
205 | u8 vgc_level_reg; | |
206 | ||
207 | /* | |
208 | * Statistics required for Signal quality calculation. | |
209 | * These fields might be changed during the link_stats() | |
210 | * callback function. | |
95ea3627 | 211 | */ |
95ea3627 ID |
212 | int rx_success; |
213 | int rx_failed; | |
95ea3627 ID |
214 | int tx_success; |
215 | int tx_failed; | |
ebcf26da ID |
216 | }; |
217 | ||
69f81a2c ID |
218 | /* |
219 | * Antenna settings about the currently active link. | |
220 | */ | |
221 | struct link_ant { | |
222 | /* | |
223 | * Antenna flags | |
224 | */ | |
225 | unsigned int flags; | |
226 | #define ANTENNA_RX_DIVERSITY 0x00000001 | |
227 | #define ANTENNA_TX_DIVERSITY 0x00000002 | |
228 | #define ANTENNA_MODE_SAMPLE 0x00000004 | |
229 | ||
230 | /* | |
231 | * Currently active TX/RX antenna setup. | |
232 | * When software diversity is used, this will indicate | |
233 | * which antenna is actually used at this time. | |
234 | */ | |
235 | struct antenna_setup active; | |
236 | ||
237 | /* | |
238 | * RSSI information for the different antenna's. | |
239 | * These statistics are used to determine when | |
240 | * to switch antenna when using software diversity. | |
241 | * | |
242 | * rssi[0] -> Antenna A RSSI | |
243 | * rssi[1] -> Antenna B RSSI | |
244 | */ | |
245 | int rssi_history[2]; | |
246 | ||
247 | /* | |
248 | * Current RSSI average of the currently active antenna. | |
249 | * Similar to the avg_rssi in the link_qual structure | |
250 | * this value is updated by using the walking average. | |
251 | */ | |
252 | int rssi_ant; | |
253 | }; | |
254 | ||
ebcf26da ID |
255 | /* |
256 | * To optimize the quality of the link we need to store | |
257 | * the quality of received frames and periodically | |
258 | * optimize the link. | |
259 | */ | |
260 | struct link { | |
261 | /* | |
262 | * Link tuner counter | |
263 | * The number of times the link has been tuned | |
264 | * since the radio has been switched on. | |
265 | */ | |
266 | u32 count; | |
267 | ||
268 | /* | |
269 | * Quality measurement values. | |
270 | */ | |
271 | struct link_qual qual; | |
272 | ||
addc81bd | 273 | /* |
69f81a2c | 274 | * TX/RX antenna setup. |
addc81bd | 275 | */ |
69f81a2c | 276 | struct link_ant ant; |
addc81bd | 277 | |
ebcf26da | 278 | /* |
5352ff65 | 279 | * Currently active average RSSI value |
ebcf26da | 280 | */ |
5352ff65 | 281 | int avg_rssi; |
eb20b4e8 ID |
282 | |
283 | /* | |
5352ff65 ID |
284 | * Currently precalculated percentages of successful |
285 | * TX and RX frames. | |
eb20b4e8 | 286 | */ |
5352ff65 ID |
287 | int rx_percentage; |
288 | int tx_percentage; | |
95ea3627 ID |
289 | |
290 | /* | |
291 | * Work structure for scheduling periodic link tuning. | |
292 | */ | |
293 | struct delayed_work work; | |
294 | }; | |
295 | ||
95ea3627 ID |
296 | /* |
297 | * Interface structure | |
6bb40dd1 ID |
298 | * Per interface configuration details, this structure |
299 | * is allocated as the private data for ieee80211_vif. | |
95ea3627 | 300 | */ |
6bb40dd1 | 301 | struct rt2x00_intf { |
95ea3627 | 302 | /* |
6bb40dd1 ID |
303 | * All fields within the rt2x00_intf structure |
304 | * must be protected with a spinlock. | |
95ea3627 | 305 | */ |
6bb40dd1 | 306 | spinlock_t lock; |
95ea3627 | 307 | |
95ea3627 ID |
308 | /* |
309 | * MAC of the device. | |
310 | */ | |
311 | u8 mac[ETH_ALEN]; | |
312 | ||
313 | /* | |
314 | * BBSID of the AP to associate with. | |
315 | */ | |
316 | u8 bssid[ETH_ALEN]; | |
95ea3627 | 317 | |
6bb40dd1 ID |
318 | /* |
319 | * Entry in the beacon queue which belongs to | |
320 | * this interface. Each interface has its own | |
321 | * dedicated beacon entry. | |
322 | */ | |
323 | struct queue_entry *beacon; | |
95ea3627 | 324 | |
6bb40dd1 ID |
325 | /* |
326 | * Actions that needed rescheduling. | |
327 | */ | |
328 | unsigned int delayed_flags; | |
329 | #define DELAYED_UPDATE_BEACON 0x00000001 | |
72810379 | 330 | #define DELAYED_CONFIG_ERP 0x00000002 |
a2e1d52a | 331 | #define DELAYED_LED_ASSOC 0x00000004 |
f591fa5d | 332 | |
d4764b29 ID |
333 | /* |
334 | * Software sequence counter, this is only required | |
335 | * for hardware which doesn't support hardware | |
336 | * sequence counting. | |
337 | */ | |
338 | spinlock_t seqlock; | |
f591fa5d | 339 | u16 seqno; |
6bb40dd1 ID |
340 | }; |
341 | ||
342 | static inline struct rt2x00_intf* vif_to_intf(struct ieee80211_vif *vif) | |
95ea3627 | 343 | { |
6bb40dd1 | 344 | return (struct rt2x00_intf *)vif->drv_priv; |
95ea3627 ID |
345 | } |
346 | ||
31562e80 ID |
347 | /** |
348 | * struct hw_mode_spec: Hardware specifications structure | |
349 | * | |
95ea3627 ID |
350 | * Details about the supported modes, rates and channels |
351 | * of a particular chipset. This is used by rt2x00lib | |
352 | * to build the ieee80211_hw_mode array for mac80211. | |
31562e80 ID |
353 | * |
354 | * @supported_bands: Bitmask contained the supported bands (2.4GHz, 5.2GHz). | |
355 | * @supported_rates: Rate types which are supported (CCK, OFDM). | |
356 | * @num_channels: Number of supported channels. This is used as array size | |
357 | * for @tx_power_a, @tx_power_bg and @channels. | |
9a46d44e | 358 | * @channels: Device/chipset specific channel values (See &struct rf_channel). |
8c5e7a5f | 359 | * @channels_info: Additional information for channels (See &struct channel_info). |
95ea3627 ID |
360 | */ |
361 | struct hw_mode_spec { | |
31562e80 ID |
362 | unsigned int supported_bands; |
363 | #define SUPPORT_BAND_2GHZ 0x00000001 | |
364 | #define SUPPORT_BAND_5GHZ 0x00000002 | |
365 | ||
366 | unsigned int supported_rates; | |
367 | #define SUPPORT_RATE_CCK 0x00000001 | |
368 | #define SUPPORT_RATE_OFDM 0x00000002 | |
369 | ||
370 | unsigned int num_channels; | |
371 | const struct rf_channel *channels; | |
8c5e7a5f | 372 | const struct channel_info *channels_info; |
95ea3627 ID |
373 | }; |
374 | ||
5c58ee51 ID |
375 | /* |
376 | * Configuration structure wrapper around the | |
377 | * mac80211 configuration structure. | |
378 | * When mac80211 configures the driver, rt2x00lib | |
379 | * can precalculate values which are equal for all | |
380 | * rt2x00 drivers. Those values can be stored in here. | |
381 | */ | |
382 | struct rt2x00lib_conf { | |
383 | struct ieee80211_conf *conf; | |
8c5e7a5f | 384 | |
5c58ee51 | 385 | struct rf_channel rf; |
8c5e7a5f | 386 | struct channel_info channel; |
5c58ee51 ID |
387 | }; |
388 | ||
72810379 ID |
389 | /* |
390 | * Configuration structure for erp settings. | |
391 | */ | |
392 | struct rt2x00lib_erp { | |
393 | int short_preamble; | |
e360c4cb | 394 | int cts_protection; |
72810379 ID |
395 | |
396 | int ack_timeout; | |
397 | int ack_consume_time; | |
e4ea1c40 | 398 | |
881d948c | 399 | u32 basic_rates; |
e4ea1c40 ID |
400 | |
401 | int slot_time; | |
402 | ||
403 | short sifs; | |
404 | short pifs; | |
405 | short difs; | |
406 | short eifs; | |
72810379 ID |
407 | }; |
408 | ||
2bb057d0 ID |
409 | /* |
410 | * Configuration structure for hardware encryption. | |
411 | */ | |
412 | struct rt2x00lib_crypto { | |
413 | enum cipher cipher; | |
414 | ||
415 | enum set_key_cmd cmd; | |
416 | const u8 *address; | |
417 | ||
418 | u32 bssidx; | |
419 | u32 aid; | |
420 | ||
421 | u8 key[16]; | |
422 | u8 tx_mic[8]; | |
423 | u8 rx_mic[8]; | |
424 | }; | |
425 | ||
6bb40dd1 ID |
426 | /* |
427 | * Configuration structure wrapper around the | |
428 | * rt2x00 interface configuration handler. | |
429 | */ | |
430 | struct rt2x00intf_conf { | |
431 | /* | |
432 | * Interface type | |
433 | */ | |
05c914fe | 434 | enum nl80211_iftype type; |
6bb40dd1 ID |
435 | |
436 | /* | |
437 | * TSF sync value, this is dependant on the operation type. | |
438 | */ | |
439 | enum tsf_sync sync; | |
440 | ||
441 | /* | |
442 | * The MAC and BSSID addressess are simple array of bytes, | |
443 | * these arrays are little endian, so when sending the addressess | |
444 | * to the drivers, copy the it into a endian-signed variable. | |
445 | * | |
446 | * Note that all devices (except rt2500usb) have 32 bits | |
447 | * register word sizes. This means that whatever variable we | |
448 | * pass _must_ be a multiple of 32 bits. Otherwise the device | |
449 | * might not accept what we are sending to it. | |
450 | * This will also make it easier for the driver to write | |
451 | * the data to the device. | |
452 | */ | |
453 | __le32 mac[2]; | |
454 | __le32 bssid[2]; | |
455 | }; | |
456 | ||
95ea3627 ID |
457 | /* |
458 | * rt2x00lib callback functions. | |
459 | */ | |
460 | struct rt2x00lib_ops { | |
461 | /* | |
462 | * Interrupt handlers. | |
463 | */ | |
464 | irq_handler_t irq_handler; | |
465 | ||
466 | /* | |
467 | * Device init handlers. | |
468 | */ | |
469 | int (*probe_hw) (struct rt2x00_dev *rt2x00dev); | |
470 | char *(*get_firmware_name) (struct rt2x00_dev *rt2x00dev); | |
0cbe0064 ID |
471 | int (*check_firmware) (struct rt2x00_dev *rt2x00dev, |
472 | const u8 *data, const size_t len); | |
473 | int (*load_firmware) (struct rt2x00_dev *rt2x00dev, | |
474 | const u8 *data, const size_t len); | |
95ea3627 ID |
475 | |
476 | /* | |
477 | * Device initialization/deinitialization handlers. | |
478 | */ | |
479 | int (*initialize) (struct rt2x00_dev *rt2x00dev); | |
480 | void (*uninitialize) (struct rt2x00_dev *rt2x00dev); | |
481 | ||
837e7f24 | 482 | /* |
181d6902 | 483 | * queue initialization handlers |
837e7f24 | 484 | */ |
798b7adb ID |
485 | bool (*get_entry_state) (struct queue_entry *entry); |
486 | void (*clear_entry) (struct queue_entry *entry); | |
837e7f24 | 487 | |
95ea3627 ID |
488 | /* |
489 | * Radio control handlers. | |
490 | */ | |
491 | int (*set_device_state) (struct rt2x00_dev *rt2x00dev, | |
492 | enum dev_state state); | |
493 | int (*rfkill_poll) (struct rt2x00_dev *rt2x00dev); | |
ebcf26da ID |
494 | void (*link_stats) (struct rt2x00_dev *rt2x00dev, |
495 | struct link_qual *qual); | |
5352ff65 ID |
496 | void (*reset_tuner) (struct rt2x00_dev *rt2x00dev, |
497 | struct link_qual *qual); | |
498 | void (*link_tuner) (struct rt2x00_dev *rt2x00dev, | |
499 | struct link_qual *qual, const u32 count); | |
95ea3627 ID |
500 | |
501 | /* | |
502 | * TX control handlers | |
503 | */ | |
504 | void (*write_tx_desc) (struct rt2x00_dev *rt2x00dev, | |
dd3193e1 | 505 | struct sk_buff *skb, |
61486e0f | 506 | struct txentry_desc *txdesc); |
6db3786a | 507 | int (*write_tx_data) (struct queue_entry *entry); |
bd88a781 | 508 | void (*write_beacon) (struct queue_entry *entry); |
f1ca2167 | 509 | int (*get_tx_data_len) (struct queue_entry *entry); |
95ea3627 | 510 | void (*kick_tx_queue) (struct rt2x00_dev *rt2x00dev, |
e58c6aca | 511 | const enum data_queue_qid queue); |
a2c9b652 ID |
512 | void (*kill_tx_queue) (struct rt2x00_dev *rt2x00dev, |
513 | const enum data_queue_qid queue); | |
95ea3627 ID |
514 | |
515 | /* | |
516 | * RX control handlers | |
517 | */ | |
181d6902 ID |
518 | void (*fill_rxdone) (struct queue_entry *entry, |
519 | struct rxdone_entry_desc *rxdesc); | |
95ea3627 ID |
520 | |
521 | /* | |
522 | * Configuration handlers. | |
523 | */ | |
2bb057d0 ID |
524 | int (*config_shared_key) (struct rt2x00_dev *rt2x00dev, |
525 | struct rt2x00lib_crypto *crypto, | |
526 | struct ieee80211_key_conf *key); | |
527 | int (*config_pairwise_key) (struct rt2x00_dev *rt2x00dev, | |
528 | struct rt2x00lib_crypto *crypto, | |
529 | struct ieee80211_key_conf *key); | |
3a643d24 ID |
530 | void (*config_filter) (struct rt2x00_dev *rt2x00dev, |
531 | const unsigned int filter_flags); | |
6bb40dd1 ID |
532 | void (*config_intf) (struct rt2x00_dev *rt2x00dev, |
533 | struct rt2x00_intf *intf, | |
534 | struct rt2x00intf_conf *conf, | |
535 | const unsigned int flags); | |
536 | #define CONFIG_UPDATE_TYPE ( 1 << 1 ) | |
537 | #define CONFIG_UPDATE_MAC ( 1 << 2 ) | |
538 | #define CONFIG_UPDATE_BSSID ( 1 << 3 ) | |
539 | ||
3a643d24 ID |
540 | void (*config_erp) (struct rt2x00_dev *rt2x00dev, |
541 | struct rt2x00lib_erp *erp); | |
e4ea1c40 ID |
542 | void (*config_ant) (struct rt2x00_dev *rt2x00dev, |
543 | struct antenna_setup *ant); | |
6bb40dd1 ID |
544 | void (*config) (struct rt2x00_dev *rt2x00dev, |
545 | struct rt2x00lib_conf *libconf, | |
e4ea1c40 | 546 | const unsigned int changed_flags); |
95ea3627 ID |
547 | }; |
548 | ||
549 | /* | |
550 | * rt2x00 driver callback operation structure. | |
551 | */ | |
552 | struct rt2x00_ops { | |
553 | const char *name; | |
6bb40dd1 ID |
554 | const unsigned int max_sta_intf; |
555 | const unsigned int max_ap_intf; | |
95ea3627 ID |
556 | const unsigned int eeprom_size; |
557 | const unsigned int rf_size; | |
61448f88 | 558 | const unsigned int tx_queues; |
181d6902 ID |
559 | const struct data_queue_desc *rx; |
560 | const struct data_queue_desc *tx; | |
561 | const struct data_queue_desc *bcn; | |
562 | const struct data_queue_desc *atim; | |
95ea3627 ID |
563 | const struct rt2x00lib_ops *lib; |
564 | const struct ieee80211_ops *hw; | |
565 | #ifdef CONFIG_RT2X00_LIB_DEBUGFS | |
566 | const struct rt2x00debug *debugfs; | |
567 | #endif /* CONFIG_RT2X00_LIB_DEBUGFS */ | |
568 | }; | |
569 | ||
483272f5 ID |
570 | /* |
571 | * rt2x00 device flags | |
572 | */ | |
573 | enum rt2x00_flags { | |
574 | /* | |
575 | * Device state flags | |
576 | */ | |
0262ab0d ID |
577 | DEVICE_STATE_PRESENT, |
578 | DEVICE_STATE_REGISTERED_HW, | |
579 | DEVICE_STATE_INITIALIZED, | |
580 | DEVICE_STATE_STARTED, | |
0262ab0d ID |
581 | DEVICE_STATE_ENABLED_RADIO, |
582 | DEVICE_STATE_DISABLED_RADIO_HW, | |
483272f5 ID |
583 | |
584 | /* | |
2bb057d0 | 585 | * Driver requirements |
483272f5 ID |
586 | */ |
587 | DRIVER_REQUIRE_FIRMWARE, | |
181d6902 ID |
588 | DRIVER_REQUIRE_BEACON_GUARD, |
589 | DRIVER_REQUIRE_ATIM_QUEUE, | |
3a643d24 | 590 | DRIVER_REQUIRE_SCHEDULED, |
c4da0048 | 591 | DRIVER_REQUIRE_DMA, |
3f787bd6 | 592 | DRIVER_REQUIRE_COPY_IV, |
483272f5 ID |
593 | |
594 | /* | |
2bb057d0 | 595 | * Driver features |
483272f5 ID |
596 | */ |
597 | CONFIG_SUPPORT_HW_BUTTON, | |
2bb057d0 ID |
598 | CONFIG_SUPPORT_HW_CRYPTO, |
599 | ||
600 | /* | |
601 | * Driver configuration | |
602 | */ | |
483272f5 ID |
603 | CONFIG_FRAME_TYPE, |
604 | CONFIG_RF_SEQUENCE, | |
605 | CONFIG_EXTERNAL_LNA_A, | |
606 | CONFIG_EXTERNAL_LNA_BG, | |
607 | CONFIG_DOUBLE_ANTENNA, | |
608 | CONFIG_DISABLE_LINK_TUNING, | |
609 | }; | |
610 | ||
95ea3627 ID |
611 | /* |
612 | * rt2x00 device structure. | |
613 | */ | |
614 | struct rt2x00_dev { | |
615 | /* | |
616 | * Device structure. | |
617 | * The structure stored in here depends on the | |
618 | * system bus (PCI or USB). | |
619 | * When accessing this variable, the rt2x00dev_{pci,usb} | |
620 | * macro's should be used for correct typecasting. | |
621 | */ | |
14a3bf89 | 622 | struct device *dev; |
95ea3627 ID |
623 | |
624 | /* | |
625 | * Callback functions. | |
626 | */ | |
627 | const struct rt2x00_ops *ops; | |
628 | ||
629 | /* | |
630 | * IEEE80211 control structure. | |
631 | */ | |
632 | struct ieee80211_hw *hw; | |
8318d78a JB |
633 | struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS]; |
634 | enum ieee80211_band curr_band; | |
95ea3627 ID |
635 | |
636 | /* | |
637 | * rfkill structure for RF state switching support. | |
638 | * This will only be compiled in when required. | |
639 | */ | |
640 | #ifdef CONFIG_RT2X00_LIB_RFKILL | |
3480a58a | 641 | unsigned long rfkill_state; |
1682fe6d ID |
642 | #define RFKILL_STATE_ALLOCATED 1 |
643 | #define RFKILL_STATE_REGISTERED 2 | |
cca3e998 ID |
644 | #define RFKILL_STATE_BLOCKED 3 |
645 | struct input_polled_dev *rfkill_poll_dev; | |
95ea3627 ID |
646 | #endif /* CONFIG_RT2X00_LIB_RFKILL */ |
647 | ||
648 | /* | |
649 | * If enabled, the debugfs interface structures | |
650 | * required for deregistration of debugfs. | |
651 | */ | |
652 | #ifdef CONFIG_RT2X00_LIB_DEBUGFS | |
4d8dd66c | 653 | struct rt2x00debug_intf *debugfs_intf; |
95ea3627 ID |
654 | #endif /* CONFIG_RT2X00_LIB_DEBUGFS */ |
655 | ||
a9450b70 ID |
656 | /* |
657 | * LED structure for changing the LED status | |
658 | * by mac8011 or the kernel. | |
659 | */ | |
660 | #ifdef CONFIG_RT2X00_LIB_LEDS | |
a9450b70 ID |
661 | struct rt2x00_led led_radio; |
662 | struct rt2x00_led led_assoc; | |
663 | struct rt2x00_led led_qual; | |
664 | u16 led_mcu_reg; | |
665 | #endif /* CONFIG_RT2X00_LIB_LEDS */ | |
666 | ||
95ea3627 ID |
667 | /* |
668 | * Device flags. | |
669 | * In these flags the current status and some | |
670 | * of the device capabilities are stored. | |
671 | */ | |
672 | unsigned long flags; | |
95ea3627 ID |
673 | |
674 | /* | |
675 | * Chipset identification. | |
676 | */ | |
677 | struct rt2x00_chip chip; | |
678 | ||
679 | /* | |
680 | * hw capability specifications. | |
681 | */ | |
682 | struct hw_mode_spec spec; | |
683 | ||
addc81bd ID |
684 | /* |
685 | * This is the default TX/RX antenna setup as indicated | |
6d64360a | 686 | * by the device's EEPROM. |
addc81bd ID |
687 | */ |
688 | struct antenna_setup default_ant; | |
689 | ||
95ea3627 ID |
690 | /* |
691 | * Register pointers | |
21795094 ID |
692 | * csr.base: CSR base register address. (PCI) |
693 | * csr.cache: CSR cache for usb_control_msg. (USB) | |
95ea3627 | 694 | */ |
21795094 ID |
695 | union csr { |
696 | void __iomem *base; | |
697 | void *cache; | |
698 | } csr; | |
95ea3627 | 699 | |
3d82346c | 700 | /* |
8ff48a8b ID |
701 | * Mutex to protect register accesses. |
702 | * For PCI and USB devices it protects against concurrent indirect | |
703 | * register access (BBP, RF, MCU) since accessing those | |
704 | * registers require multiple calls to the CSR registers. | |
705 | * For USB devices it also protects the csr_cache since that | |
706 | * field is used for normal CSR access and it cannot support | |
707 | * multiple callers simultaneously. | |
708 | */ | |
709 | struct mutex csr_mutex; | |
3d82346c | 710 | |
3c4f2085 ID |
711 | /* |
712 | * Current packet filter configuration for the device. | |
713 | * This contains all currently active FIF_* flags send | |
714 | * to us by mac80211 during configure_filter(). | |
715 | */ | |
716 | unsigned int packet_filter; | |
717 | ||
95ea3627 | 718 | /* |
6bb40dd1 ID |
719 | * Interface details: |
720 | * - Open ap interface count. | |
721 | * - Open sta interface count. | |
722 | * - Association count. | |
95ea3627 | 723 | */ |
6bb40dd1 ID |
724 | unsigned int intf_ap_count; |
725 | unsigned int intf_sta_count; | |
726 | unsigned int intf_associated; | |
95ea3627 ID |
727 | |
728 | /* | |
729 | * Link quality | |
730 | */ | |
731 | struct link link; | |
732 | ||
733 | /* | |
734 | * EEPROM data. | |
735 | */ | |
736 | __le16 *eeprom; | |
737 | ||
738 | /* | |
739 | * Active RF register values. | |
740 | * These are stored here so we don't need | |
741 | * to read the rf registers and can directly | |
742 | * use this value instead. | |
743 | * This field should be accessed by using | |
744 | * rt2x00_rf_read() and rt2x00_rf_write(). | |
745 | */ | |
746 | u32 *rf; | |
747 | ||
ba2ab471 ID |
748 | /* |
749 | * LNA gain | |
750 | */ | |
751 | short lna_gain; | |
752 | ||
95ea3627 ID |
753 | /* |
754 | * Current TX power value. | |
755 | */ | |
756 | u16 tx_power; | |
757 | ||
42c82857 ID |
758 | /* |
759 | * Current retry values. | |
760 | */ | |
761 | u8 short_retry; | |
762 | u8 long_retry; | |
763 | ||
95ea3627 ID |
764 | /* |
765 | * Rssi <-> Dbm offset | |
766 | */ | |
767 | u8 rssi_offset; | |
768 | ||
769 | /* | |
770 | * Frequency offset (for rt61pci & rt73usb). | |
771 | */ | |
772 | u8 freq_offset; | |
773 | ||
774 | /* | |
775 | * Low level statistics which will have | |
776 | * to be kept up to date while device is running. | |
777 | */ | |
778 | struct ieee80211_low_level_stats low_level_stats; | |
779 | ||
780 | /* | |
781 | * RX configuration information. | |
782 | */ | |
783 | struct ieee80211_rx_status rx_status; | |
784 | ||
785 | /* | |
4150c572 | 786 | * Scheduled work. |
8e260c22 ID |
787 | * NOTE: intf_work will use ieee80211_iterate_active_interfaces() |
788 | * which means it cannot be placed on the hw->workqueue | |
789 | * due to RTNL locking requirements. | |
95ea3627 | 790 | */ |
6bb40dd1 | 791 | struct work_struct intf_work; |
4150c572 | 792 | struct work_struct filter_work; |
95ea3627 ID |
793 | |
794 | /* | |
181d6902 ID |
795 | * Data queue arrays for RX, TX and Beacon. |
796 | * The Beacon array also contains the Atim queue | |
95ea3627 ID |
797 | * if that is supported by the device. |
798 | */ | |
b869767b | 799 | unsigned int data_queues; |
181d6902 ID |
800 | struct data_queue *rx; |
801 | struct data_queue *tx; | |
802 | struct data_queue *bcn; | |
95ea3627 ID |
803 | |
804 | /* | |
805 | * Firmware image. | |
806 | */ | |
807 | const struct firmware *fw; | |
808 | }; | |
809 | ||
95ea3627 ID |
810 | /* |
811 | * Generic RF access. | |
812 | * The RF is being accessed by word index. | |
813 | */ | |
0e14f6d3 | 814 | static inline void rt2x00_rf_read(struct rt2x00_dev *rt2x00dev, |
95ea3627 ID |
815 | const unsigned int word, u32 *data) |
816 | { | |
817 | *data = rt2x00dev->rf[word]; | |
818 | } | |
819 | ||
0e14f6d3 | 820 | static inline void rt2x00_rf_write(struct rt2x00_dev *rt2x00dev, |
95ea3627 ID |
821 | const unsigned int word, u32 data) |
822 | { | |
823 | rt2x00dev->rf[word] = data; | |
824 | } | |
825 | ||
826 | /* | |
827 | * Generic EEPROM access. | |
828 | * The EEPROM is being accessed by word index. | |
829 | */ | |
0e14f6d3 | 830 | static inline void *rt2x00_eeprom_addr(struct rt2x00_dev *rt2x00dev, |
95ea3627 ID |
831 | const unsigned int word) |
832 | { | |
833 | return (void *)&rt2x00dev->eeprom[word]; | |
834 | } | |
835 | ||
0e14f6d3 | 836 | static inline void rt2x00_eeprom_read(struct rt2x00_dev *rt2x00dev, |
95ea3627 ID |
837 | const unsigned int word, u16 *data) |
838 | { | |
839 | *data = le16_to_cpu(rt2x00dev->eeprom[word]); | |
840 | } | |
841 | ||
0e14f6d3 | 842 | static inline void rt2x00_eeprom_write(struct rt2x00_dev *rt2x00dev, |
95ea3627 ID |
843 | const unsigned int word, u16 data) |
844 | { | |
845 | rt2x00dev->eeprom[word] = cpu_to_le16(data); | |
846 | } | |
847 | ||
848 | /* | |
849 | * Chipset handlers | |
850 | */ | |
851 | static inline void rt2x00_set_chip(struct rt2x00_dev *rt2x00dev, | |
852 | const u16 rt, const u16 rf, const u32 rev) | |
853 | { | |
854 | INFO(rt2x00dev, | |
855 | "Chipset detected - rt: %04x, rf: %04x, rev: %08x.\n", | |
856 | rt, rf, rev); | |
857 | ||
858 | rt2x00dev->chip.rt = rt; | |
859 | rt2x00dev->chip.rf = rf; | |
860 | rt2x00dev->chip.rev = rev; | |
861 | } | |
862 | ||
863 | static inline char rt2x00_rt(const struct rt2x00_chip *chipset, const u16 chip) | |
864 | { | |
865 | return (chipset->rt == chip); | |
866 | } | |
867 | ||
868 | static inline char rt2x00_rf(const struct rt2x00_chip *chipset, const u16 chip) | |
869 | { | |
870 | return (chipset->rf == chip); | |
871 | } | |
872 | ||
6ba265e9 | 873 | static inline u32 rt2x00_rev(const struct rt2x00_chip *chipset) |
95ea3627 ID |
874 | { |
875 | return chipset->rev; | |
876 | } | |
877 | ||
755a957d ID |
878 | static inline u16 rt2x00_check_rev(const struct rt2x00_chip *chipset, |
879 | const u32 rev) | |
95ea3627 | 880 | { |
755a957d ID |
881 | return (((chipset->rev & 0xffff0) == rev) && |
882 | !!(chipset->rev & 0x0000f)); | |
95ea3627 ID |
883 | } |
884 | ||
239c249d | 885 | /** |
c4da0048 GW |
886 | * rt2x00queue_map_txskb - Map a skb into DMA for TX purposes. |
887 | * @rt2x00dev: Pointer to &struct rt2x00_dev. | |
888 | * @skb: The skb to map. | |
239c249d | 889 | */ |
c4da0048 | 890 | void rt2x00queue_map_txskb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb); |
239c249d | 891 | |
181d6902 | 892 | /** |
e58c6aca | 893 | * rt2x00queue_get_queue - Convert queue index to queue pointer |
181d6902 | 894 | * @rt2x00dev: Pointer to &struct rt2x00_dev. |
e58c6aca | 895 | * @queue: rt2x00 queue index (see &enum data_queue_qid). |
95ea3627 | 896 | */ |
181d6902 | 897 | struct data_queue *rt2x00queue_get_queue(struct rt2x00_dev *rt2x00dev, |
e58c6aca | 898 | const enum data_queue_qid queue); |
181d6902 ID |
899 | |
900 | /** | |
901 | * rt2x00queue_get_entry - Get queue entry where the given index points to. | |
9a46d44e | 902 | * @queue: Pointer to &struct data_queue from where we obtain the entry. |
181d6902 ID |
903 | * @index: Index identifier for obtaining the correct index. |
904 | */ | |
905 | struct queue_entry *rt2x00queue_get_entry(struct data_queue *queue, | |
906 | enum queue_index index); | |
907 | ||
95ea3627 ID |
908 | /* |
909 | * Interrupt context handlers. | |
910 | */ | |
911 | void rt2x00lib_beacondone(struct rt2x00_dev *rt2x00dev); | |
181d6902 ID |
912 | void rt2x00lib_txdone(struct queue_entry *entry, |
913 | struct txdone_entry_desc *txdesc); | |
c4da0048 GW |
914 | void rt2x00lib_rxdone(struct rt2x00_dev *rt2x00dev, |
915 | struct queue_entry *entry); | |
95ea3627 | 916 | |
95ea3627 ID |
917 | /* |
918 | * mac80211 handlers. | |
919 | */ | |
e039fa4a | 920 | int rt2x00mac_tx(struct ieee80211_hw *hw, struct sk_buff *skb); |
95ea3627 ID |
921 | int rt2x00mac_start(struct ieee80211_hw *hw); |
922 | void rt2x00mac_stop(struct ieee80211_hw *hw); | |
923 | int rt2x00mac_add_interface(struct ieee80211_hw *hw, | |
924 | struct ieee80211_if_init_conf *conf); | |
925 | void rt2x00mac_remove_interface(struct ieee80211_hw *hw, | |
926 | struct ieee80211_if_init_conf *conf); | |
e8975581 | 927 | int rt2x00mac_config(struct ieee80211_hw *hw, u32 changed); |
32bfd35d JB |
928 | int rt2x00mac_config_interface(struct ieee80211_hw *hw, |
929 | struct ieee80211_vif *vif, | |
95ea3627 | 930 | struct ieee80211_if_conf *conf); |
3a643d24 ID |
931 | void rt2x00mac_configure_filter(struct ieee80211_hw *hw, |
932 | unsigned int changed_flags, | |
933 | unsigned int *total_flags, | |
934 | int mc_count, struct dev_addr_list *mc_list); | |
2bb057d0 ID |
935 | #ifdef CONFIG_RT2X00_LIB_CRYPTO |
936 | int rt2x00mac_set_key(struct ieee80211_hw *hw, enum set_key_cmd cmd, | |
dc822b5d | 937 | struct ieee80211_vif *vif, struct ieee80211_sta *sta, |
2bb057d0 ID |
938 | struct ieee80211_key_conf *key); |
939 | #else | |
940 | #define rt2x00mac_set_key NULL | |
941 | #endif /* CONFIG_RT2X00_LIB_CRYPTO */ | |
95ea3627 ID |
942 | int rt2x00mac_get_stats(struct ieee80211_hw *hw, |
943 | struct ieee80211_low_level_stats *stats); | |
944 | int rt2x00mac_get_tx_stats(struct ieee80211_hw *hw, | |
945 | struct ieee80211_tx_queue_stats *stats); | |
471b3efd JB |
946 | void rt2x00mac_bss_info_changed(struct ieee80211_hw *hw, |
947 | struct ieee80211_vif *vif, | |
948 | struct ieee80211_bss_conf *bss_conf, | |
949 | u32 changes); | |
e100bb64 | 950 | int rt2x00mac_conf_tx(struct ieee80211_hw *hw, u16 queue, |
95ea3627 ID |
951 | const struct ieee80211_tx_queue_params *params); |
952 | ||
953 | /* | |
954 | * Driver allocation handlers. | |
955 | */ | |
956 | int rt2x00lib_probe_dev(struct rt2x00_dev *rt2x00dev); | |
957 | void rt2x00lib_remove_dev(struct rt2x00_dev *rt2x00dev); | |
958 | #ifdef CONFIG_PM | |
959 | int rt2x00lib_suspend(struct rt2x00_dev *rt2x00dev, pm_message_t state); | |
960 | int rt2x00lib_resume(struct rt2x00_dev *rt2x00dev); | |
961 | #endif /* CONFIG_PM */ | |
962 | ||
963 | #endif /* RT2X00_H */ |