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: rt2x00lib | |
23 | Abstract: Data structures and definitions for the rt2x00lib module. | |
24 | */ | |
25 | ||
26 | #ifndef RT2X00LIB_H | |
27 | #define RT2X00LIB_H | |
28 | ||
5a6e5999 ID |
29 | #include "rt2x00dump.h" |
30 | ||
95ea3627 ID |
31 | /* |
32 | * Interval defines | |
81873e9c | 33 | * Both the link tuner as the rfkill will be called once per second. |
95ea3627 | 34 | */ |
b239bd75 | 35 | #define LINK_TUNE_INTERVAL ( round_jiffies_relative(HZ) ) |
50db7875 | 36 | #define RFKILL_POLL_INTERVAL ( round_jiffies_relative(HZ) ) |
95ea3627 | 37 | |
70e2fed4 ID |
38 | /* |
39 | * rt2x00_rate: Per rate device information | |
40 | */ | |
41 | struct rt2x00_rate { | |
42 | unsigned short flags; | |
31562e80 ID |
43 | #define DEV_RATE_CCK 0x0001 |
44 | #define DEV_RATE_OFDM 0x0002 | |
45 | #define DEV_RATE_SHORT_PREAMBLE 0x0004 | |
70e2fed4 ID |
46 | |
47 | unsigned short bitrate; /* In 100kbit/s */ | |
70e2fed4 | 48 | unsigned short ratemask; |
70e2fed4 ID |
49 | |
50 | unsigned short plcp; | |
51 | }; | |
52 | ||
53 | extern const struct rt2x00_rate rt2x00_supported_rates[12]; | |
54 | ||
70e2fed4 ID |
55 | static inline const struct rt2x00_rate *rt2x00_get_rate(const u16 hw_value) |
56 | { | |
57 | return &rt2x00_supported_rates[hw_value & 0xff]; | |
58 | } | |
59 | ||
95ea3627 ID |
60 | /* |
61 | * Radio control handlers. | |
62 | */ | |
63 | int rt2x00lib_enable_radio(struct rt2x00_dev *rt2x00dev); | |
64 | void rt2x00lib_disable_radio(struct rt2x00_dev *rt2x00dev); | |
5cbf830e | 65 | void rt2x00lib_toggle_rx(struct rt2x00_dev *rt2x00dev, enum dev_state state); |
95ea3627 ID |
66 | |
67 | /* | |
68 | * Initialization handlers. | |
69 | */ | |
e37ea213 ID |
70 | int rt2x00lib_start(struct rt2x00_dev *rt2x00dev); |
71 | void rt2x00lib_stop(struct rt2x00_dev *rt2x00dev); | |
95ea3627 ID |
72 | |
73 | /* | |
74 | * Configuration handlers. | |
75 | */ | |
6bb40dd1 ID |
76 | void rt2x00lib_config_intf(struct rt2x00_dev *rt2x00dev, |
77 | struct rt2x00_intf *intf, | |
05c914fe | 78 | enum nl80211_iftype type, |
6bb40dd1 | 79 | u8 *mac, u8 *bssid); |
72810379 ID |
80 | void rt2x00lib_config_erp(struct rt2x00_dev *rt2x00dev, |
81 | struct rt2x00_intf *intf, | |
82 | struct ieee80211_bss_conf *conf); | |
69f81a2c | 83 | void rt2x00lib_config_antenna(struct rt2x00_dev *rt2x00dev, |
6d64360a | 84 | struct antenna_setup *ant); |
066cb637 | 85 | void rt2x00lib_config(struct rt2x00_dev *rt2x00dev, |
e4ea1c40 ID |
86 | struct ieee80211_conf *conf, |
87 | const unsigned int changed_flags); | |
95ea3627 | 88 | |
d74f5ba4 ID |
89 | /** |
90 | * DOC: Queue handlers | |
91 | */ | |
92 | ||
93 | /** | |
94 | * rt2x00queue_alloc_rxskb - allocate a skb for RX purposes. | |
95 | * @rt2x00dev: Pointer to &struct rt2x00_dev. | |
96 | * @queue: The queue for which the skb will be applicable. | |
97 | */ | |
98 | struct sk_buff *rt2x00queue_alloc_rxskb(struct rt2x00_dev *rt2x00dev, | |
99 | struct queue_entry *entry); | |
100 | ||
101 | /** | |
102 | * rt2x00queue_unmap_skb - Unmap a skb from DMA. | |
103 | * @rt2x00dev: Pointer to &struct rt2x00_dev. | |
104 | * @skb: The skb to unmap. | |
105 | */ | |
106 | void rt2x00queue_unmap_skb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb); | |
107 | ||
108 | /** | |
109 | * rt2x00queue_free_skb - free a skb | |
110 | * @rt2x00dev: Pointer to &struct rt2x00_dev. | |
111 | * @skb: The skb to free. | |
112 | */ | |
113 | void rt2x00queue_free_skb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb); | |
114 | ||
d74f5ba4 ID |
115 | /** |
116 | * rt2x00queue_write_tx_frame - Write TX frame to hardware | |
117 | * @queue: Queue over which the frame should be send | |
118 | * @skb: The skb to send | |
181d6902 | 119 | */ |
6db3786a | 120 | int rt2x00queue_write_tx_frame(struct data_queue *queue, struct sk_buff *skb); |
d74f5ba4 | 121 | |
bd88a781 ID |
122 | /** |
123 | * rt2x00queue_update_beacon - Send new beacon from mac80211 to hardware | |
124 | * @rt2x00dev: Pointer to &struct rt2x00_dev. | |
125 | * @vif: Interface for which the beacon should be updated. | |
126 | */ | |
127 | int rt2x00queue_update_beacon(struct rt2x00_dev *rt2x00dev, | |
128 | struct ieee80211_vif *vif); | |
129 | ||
d74f5ba4 ID |
130 | /** |
131 | * rt2x00queue_index_inc - Index incrementation function | |
132 | * @queue: Queue (&struct data_queue) to perform the action on. | |
133 | * @index: Index type (&enum queue_index) to perform the action on. | |
134 | * | |
135 | * This function will increase the requested index on the queue, | |
136 | * it will grab the appropriate locks and handle queue overflow events by | |
137 | * resetting the index to the start of the queue. | |
138 | */ | |
139 | void rt2x00queue_index_inc(struct data_queue *queue, enum queue_index index); | |
140 | ||
798b7adb ID |
141 | /** |
142 | * rt2x00queue_init_queues - Initialize all data queues | |
143 | * @rt2x00dev: Pointer to &struct rt2x00_dev. | |
144 | * | |
145 | * This function will loop through all available queues to clear all | |
146 | * index numbers and set the queue entry to the correct initialization | |
147 | * state. | |
148 | */ | |
149 | void rt2x00queue_init_queues(struct rt2x00_dev *rt2x00dev); | |
150 | ||
181d6902 ID |
151 | int rt2x00queue_initialize(struct rt2x00_dev *rt2x00dev); |
152 | void rt2x00queue_uninitialize(struct rt2x00_dev *rt2x00dev); | |
153 | int rt2x00queue_allocate(struct rt2x00_dev *rt2x00dev); | |
154 | void rt2x00queue_free(struct rt2x00_dev *rt2x00dev); | |
155 | ||
84e3196f ID |
156 | /** |
157 | * rt2x00link_update_stats - Update link statistics from RX frame | |
158 | * @rt2x00dev: Pointer to &struct rt2x00_dev. | |
159 | * @skb: Received frame | |
160 | * @rxdesc: Received frame descriptor | |
161 | * | |
162 | * Update link statistics based on the information from the | |
163 | * received frame descriptor. | |
164 | */ | |
165 | void rt2x00link_update_stats(struct rt2x00_dev *rt2x00dev, | |
166 | struct sk_buff *skb, | |
167 | struct rxdone_entry_desc *rxdesc); | |
168 | ||
169 | /** | |
170 | * rt2x00link_calculate_signal - Calculate signal quality | |
171 | * @rt2x00dev: Pointer to &struct rt2x00_dev. | |
172 | * @rssi: RX Frame RSSI | |
173 | * | |
174 | * Calculate the signal quality of a frame based on the rssi | |
175 | * measured during the receiving of the frame and the global | |
176 | * link quality statistics measured since the start of the | |
177 | * link tuning. The result is a value between 0 and 100 which | |
178 | * is an indication of the signal quality. | |
179 | */ | |
180 | int rt2x00link_calculate_signal(struct rt2x00_dev *rt2x00dev, int rssi); | |
181 | ||
182 | /** | |
183 | * rt2x00link_start_tuner - Start periodic link tuner work | |
184 | * @rt2x00dev: Pointer to &struct rt2x00_dev. | |
185 | * | |
186 | * This start the link tuner periodic work, this work will | |
187 | * be executed periodically until &rt2x00link_stop_tuner has | |
188 | * been called. | |
189 | */ | |
190 | void rt2x00link_start_tuner(struct rt2x00_dev *rt2x00dev); | |
191 | ||
192 | /** | |
193 | * rt2x00link_stop_tuner - Stop periodic link tuner work | |
194 | * @rt2x00dev: Pointer to &struct rt2x00_dev. | |
195 | * | |
196 | * After this function completed the link tuner will not | |
197 | * be running until &rt2x00link_start_tuner is called. | |
198 | */ | |
199 | void rt2x00link_stop_tuner(struct rt2x00_dev *rt2x00dev); | |
200 | ||
201 | /** | |
202 | * rt2x00link_reset_tuner - Reset periodic link tuner work | |
203 | * @rt2x00dev: Pointer to &struct rt2x00_dev. | |
204 | * @antenna: Should the antenna tuning also be reset | |
205 | * | |
206 | * The VGC limit configured in the hardware will be reset to 0 | |
207 | * which forces the driver to rediscover the correct value for | |
208 | * the current association. This is needed when configuration | |
209 | * options have changed which could drastically change the | |
210 | * SNR level or link quality (i.e. changing the antenna setting). | |
211 | * | |
212 | * Resetting the link tuner will also cause the periodic work counter | |
213 | * to be reset. Any driver which has a fixed limit on the number | |
214 | * of rounds the link tuner is supposed to work will accept the | |
215 | * tuner actions again if this limit was previously reached. | |
216 | * | |
217 | * If @antenna is set to true a the software antenna diversity | |
218 | * tuning will also be reset. | |
219 | */ | |
220 | void rt2x00link_reset_tuner(struct rt2x00_dev *rt2x00dev, bool antenna); | |
221 | ||
222 | /** | |
223 | * rt2x00link_register - Initialize link tuning functionality | |
224 | * @rt2x00dev: Pointer to &struct rt2x00_dev. | |
225 | * | |
226 | * Initialize work structure and all link tuning related | |
227 | * paramters. This will not start the link tuning process itself. | |
228 | */ | |
229 | void rt2x00link_register(struct rt2x00_dev *rt2x00dev); | |
230 | ||
95ea3627 ID |
231 | /* |
232 | * Firmware handlers. | |
233 | */ | |
234 | #ifdef CONFIG_RT2X00_LIB_FIRMWARE | |
235 | int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev); | |
236 | void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev); | |
237 | #else | |
238 | static inline int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev) | |
239 | { | |
240 | return 0; | |
241 | } | |
242 | static inline void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev) | |
243 | { | |
244 | } | |
245 | #endif /* CONFIG_RT2X00_LIB_FIRMWARE */ | |
246 | ||
247 | /* | |
248 | * Debugfs handlers. | |
249 | */ | |
250 | #ifdef CONFIG_RT2X00_LIB_DEBUGFS | |
251 | void rt2x00debug_register(struct rt2x00_dev *rt2x00dev); | |
252 | void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev); | |
5a6e5999 ID |
253 | void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev, |
254 | enum rt2x00_dump_type type, struct sk_buff *skb); | |
2bb057d0 | 255 | void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev, |
84e3196f | 256 | struct rxdone_entry_desc *rxdesc); |
95ea3627 ID |
257 | #else |
258 | static inline void rt2x00debug_register(struct rt2x00_dev *rt2x00dev) | |
259 | { | |
260 | } | |
261 | ||
262 | static inline void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev) | |
263 | { | |
264 | } | |
4d8dd66c ID |
265 | |
266 | static inline void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev, | |
5a6e5999 | 267 | enum rt2x00_dump_type type, |
2b1ea591 | 268 | struct sk_buff *skb) |
4d8dd66c ID |
269 | { |
270 | } | |
2bb057d0 ID |
271 | |
272 | static inline void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev, | |
84e3196f | 273 | struct rxdone_entry_desc *rxdesc) |
2bb057d0 ID |
274 | { |
275 | } | |
95ea3627 ID |
276 | #endif /* CONFIG_RT2X00_LIB_DEBUGFS */ |
277 | ||
2bb057d0 ID |
278 | /* |
279 | * Crypto handlers. | |
280 | */ | |
281 | #ifdef CONFIG_RT2X00_LIB_CRYPTO | |
282 | enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key); | |
9c3444d3 ID |
283 | void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry, |
284 | struct txentry_desc *txdesc); | |
2bb057d0 | 285 | unsigned int rt2x00crypto_tx_overhead(struct ieee80211_tx_info *tx_info); |
dddfb478 | 286 | void rt2x00crypto_tx_copy_iv(struct sk_buff *skb, unsigned int iv_len); |
2bb057d0 ID |
287 | void rt2x00crypto_tx_remove_iv(struct sk_buff *skb, unsigned int iv_len); |
288 | void rt2x00crypto_tx_insert_iv(struct sk_buff *skb); | |
289 | void rt2x00crypto_rx_insert_iv(struct sk_buff *skb, unsigned int align, | |
290 | unsigned int header_length, | |
291 | struct rxdone_entry_desc *rxdesc); | |
292 | #else | |
293 | static inline enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key) | |
294 | { | |
295 | return CIPHER_NONE; | |
296 | } | |
297 | ||
9c3444d3 ID |
298 | static inline void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry, |
299 | struct txentry_desc *txdesc) | |
300 | { | |
301 | } | |
302 | ||
2bb057d0 ID |
303 | static inline unsigned int rt2x00crypto_tx_overhead(struct ieee80211_tx_info *tx_info) |
304 | { | |
305 | return 0; | |
306 | } | |
307 | ||
dddfb478 ID |
308 | static inline void rt2x00crypto_tx_copy_iv(struct sk_buff *skb, |
309 | unsigned int iv_len) | |
310 | { | |
311 | } | |
312 | ||
2bb057d0 ID |
313 | static inline void rt2x00crypto_tx_remove_iv(struct sk_buff *skb, |
314 | unsigned int iv_len) | |
315 | { | |
316 | } | |
317 | ||
318 | static inline void rt2x00crypto_tx_insert_iv(struct sk_buff *skb) | |
319 | { | |
320 | } | |
321 | ||
322 | static inline void rt2x00crypto_rx_insert_iv(struct sk_buff *skb, | |
323 | unsigned int align, | |
324 | unsigned int header_length, | |
325 | struct rxdone_entry_desc *rxdesc) | |
326 | { | |
327 | } | |
9c3444d3 | 328 | #endif /* CONFIG_RT2X00_LIB_CRYPTO */ |
2bb057d0 | 329 | |
95ea3627 ID |
330 | /* |
331 | * RFkill handlers. | |
332 | */ | |
333 | #ifdef CONFIG_RT2X00_LIB_RFKILL | |
1682fe6d | 334 | void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev); |
95ea3627 | 335 | void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev); |
1682fe6d | 336 | void rt2x00rfkill_allocate(struct rt2x00_dev *rt2x00dev); |
95ea3627 ID |
337 | void rt2x00rfkill_free(struct rt2x00_dev *rt2x00dev); |
338 | #else | |
1682fe6d | 339 | static inline void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev) |
95ea3627 | 340 | { |
95ea3627 ID |
341 | } |
342 | ||
343 | static inline void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev) | |
344 | { | |
345 | } | |
346 | ||
1682fe6d | 347 | static inline void rt2x00rfkill_allocate(struct rt2x00_dev *rt2x00dev) |
95ea3627 | 348 | { |
95ea3627 ID |
349 | } |
350 | ||
351 | static inline void rt2x00rfkill_free(struct rt2x00_dev *rt2x00dev) | |
352 | { | |
353 | } | |
354 | #endif /* CONFIG_RT2X00_LIB_RFKILL */ | |
355 | ||
a9450b70 ID |
356 | /* |
357 | * LED handlers | |
358 | */ | |
359 | #ifdef CONFIG_RT2X00_LIB_LEDS | |
360 | void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev, int rssi); | |
61c2b682 | 361 | void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev, bool enabled); |
a2e1d52a ID |
362 | void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev, bool enabled); |
363 | void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev, bool enabled); | |
72fa559b | 364 | void rt2x00leds_register(struct rt2x00_dev *rt2x00dev); |
a9450b70 ID |
365 | void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev); |
366 | void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev); | |
367 | void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev); | |
368 | #else | |
369 | static inline void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev, | |
370 | int rssi) | |
371 | { | |
372 | } | |
373 | ||
61c2b682 ID |
374 | static inline void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev, |
375 | bool enabled) | |
376 | { | |
377 | } | |
378 | ||
a2e1d52a ID |
379 | static inline void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev, |
380 | bool enabled) | |
381 | { | |
382 | } | |
383 | ||
384 | static inline void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev, | |
385 | bool enabled) | |
386 | { | |
387 | } | |
388 | ||
72fa559b | 389 | static inline void rt2x00leds_register(struct rt2x00_dev *rt2x00dev) |
a9450b70 | 390 | { |
a9450b70 ID |
391 | } |
392 | ||
393 | static inline void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev) | |
394 | { | |
395 | } | |
396 | ||
397 | static inline void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev) | |
398 | { | |
399 | } | |
400 | ||
401 | static inline void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev) | |
402 | { | |
403 | } | |
404 | #endif /* CONFIG_RT2X00_LIB_LEDS */ | |
405 | ||
95ea3627 | 406 | #endif /* RT2X00LIB_H */ |