Commit | Line | Data |
---|---|---|
95ea3627 | 1 | /* |
9c9a0d14 GW |
2 | Copyright (C) 2004 - 2009 Ivo van Doorn <IvDoorn@gmail.com> |
3 | Copyright (C) 2004 - 2009 Gertjan van Wingerde <gwingerde@gmail.com> | |
95ea3627 ID |
4 | <http://rt2x00.serialmonkey.com> |
5 | ||
6 | This program is free software; you can redistribute it and/or modify | |
7 | it under the terms of the GNU General Public License as published by | |
8 | the Free Software Foundation; either version 2 of the License, or | |
9 | (at your option) any later version. | |
10 | ||
11 | This program is distributed in the hope that it will be useful, | |
12 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | GNU General Public License for more details. | |
15 | ||
16 | You should have received a copy of the GNU General Public License | |
17 | along with this program; if not, write to the | |
18 | Free Software Foundation, Inc., | |
19 | 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. | |
20 | */ | |
21 | ||
22 | /* | |
23 | Module: rt2x00lib | |
24 | Abstract: Data structures and definitions for the rt2x00lib module. | |
25 | */ | |
26 | ||
27 | #ifndef RT2X00LIB_H | |
28 | #define RT2X00LIB_H | |
29 | ||
30 | /* | |
31 | * Interval defines | |
32 | */ | |
c965c74b | 33 | #define WATCHDOG_INTERVAL round_jiffies_relative(HZ) |
206eade5 | 34 | #define LINK_TUNE_INTERVAL round_jiffies_relative(HZ) |
95ea3627 | 35 | |
70e2fed4 ID |
36 | /* |
37 | * rt2x00_rate: Per rate device information | |
38 | */ | |
39 | struct rt2x00_rate { | |
40 | unsigned short flags; | |
31562e80 ID |
41 | #define DEV_RATE_CCK 0x0001 |
42 | #define DEV_RATE_OFDM 0x0002 | |
43 | #define DEV_RATE_SHORT_PREAMBLE 0x0004 | |
70e2fed4 ID |
44 | |
45 | unsigned short bitrate; /* In 100kbit/s */ | |
70e2fed4 | 46 | unsigned short ratemask; |
70e2fed4 ID |
47 | |
48 | unsigned short plcp; | |
35f00cfc | 49 | unsigned short mcs; |
70e2fed4 ID |
50 | }; |
51 | ||
52 | extern const struct rt2x00_rate rt2x00_supported_rates[12]; | |
53 | ||
70e2fed4 ID |
54 | static inline const struct rt2x00_rate *rt2x00_get_rate(const u16 hw_value) |
55 | { | |
56 | return &rt2x00_supported_rates[hw_value & 0xff]; | |
57 | } | |
58 | ||
35f00cfc | 59 | #define RATE_MCS(__mode, __mcs) \ |
5f181dc1 | 60 | ((((__mode) & 0x00ff) << 8) | ((__mcs) & 0x00ff)) |
35f00cfc ID |
61 | |
62 | static inline int rt2x00_get_rate_mcs(const u16 mcs_value) | |
63 | { | |
64 | return (mcs_value & 0x00ff); | |
65 | } | |
66 | ||
95ea3627 ID |
67 | /* |
68 | * Radio control handlers. | |
69 | */ | |
70 | int rt2x00lib_enable_radio(struct rt2x00_dev *rt2x00dev); | |
71 | void rt2x00lib_disable_radio(struct rt2x00_dev *rt2x00dev); | |
95ea3627 ID |
72 | |
73 | /* | |
74 | * Initialization handlers. | |
75 | */ | |
e37ea213 ID |
76 | int rt2x00lib_start(struct rt2x00_dev *rt2x00dev); |
77 | void rt2x00lib_stop(struct rt2x00_dev *rt2x00dev); | |
95ea3627 ID |
78 | |
79 | /* | |
80 | * Configuration handlers. | |
81 | */ | |
6bb40dd1 ID |
82 | void rt2x00lib_config_intf(struct rt2x00_dev *rt2x00dev, |
83 | struct rt2x00_intf *intf, | |
05c914fe | 84 | enum nl80211_iftype type, |
5f936f11 | 85 | const u8 *mac, const u8 *bssid); |
72810379 ID |
86 | void rt2x00lib_config_erp(struct rt2x00_dev *rt2x00dev, |
87 | struct rt2x00_intf *intf, | |
02044643 HS |
88 | struct ieee80211_bss_conf *conf, |
89 | u32 changed); | |
69f81a2c | 90 | void rt2x00lib_config_antenna(struct rt2x00_dev *rt2x00dev, |
eb87eaac | 91 | struct antenna_setup ant); |
066cb637 | 92 | void rt2x00lib_config(struct rt2x00_dev *rt2x00dev, |
e4ea1c40 ID |
93 | struct ieee80211_conf *conf, |
94 | const unsigned int changed_flags); | |
95ea3627 | 95 | |
d74f5ba4 ID |
96 | /** |
97 | * DOC: Queue handlers | |
98 | */ | |
99 | ||
100 | /** | |
101 | * rt2x00queue_alloc_rxskb - allocate a skb for RX purposes. | |
fa69560f | 102 | * @entry: The entry for which the skb will be applicable. |
d74f5ba4 | 103 | */ |
fa69560f | 104 | struct sk_buff *rt2x00queue_alloc_rxskb(struct queue_entry *entry); |
d74f5ba4 | 105 | |
d74f5ba4 ID |
106 | /** |
107 | * rt2x00queue_free_skb - free a skb | |
fa69560f | 108 | * @entry: The entry for which the skb will be applicable. |
d74f5ba4 | 109 | */ |
fa69560f | 110 | void rt2x00queue_free_skb(struct queue_entry *entry); |
d74f5ba4 | 111 | |
9f166171 | 112 | /** |
daee6c09 ID |
113 | * rt2x00queue_align_frame - Align 802.11 frame to 4-byte boundary |
114 | * @skb: The skb to align | |
115 | * | |
116 | * Align the start of the 802.11 frame to a 4-byte boundary, this could | |
117 | * mean the payload is not aligned properly though. | |
118 | */ | |
119 | void rt2x00queue_align_frame(struct sk_buff *skb); | |
120 | ||
121 | /** | |
122 | * rt2x00queue_align_payload - Align 802.11 payload to 4-byte boundary | |
123 | * @skb: The skb to align | |
124 | * @header_length: Length of 802.11 header | |
125 | * | |
126 | * Align the 802.11 payload to a 4-byte boundary, this could | |
127 | * mean the header is not aligned properly though. | |
128 | */ | |
129 | void rt2x00queue_align_payload(struct sk_buff *skb, unsigned int header_length); | |
130 | ||
131 | /** | |
132 | * rt2x00queue_insert_l2pad - Align 802.11 header & payload to 4-byte boundary | |
133 | * @skb: The skb to align | |
134 | * @header_length: Length of 802.11 header | |
135 | * | |
136 | * Apply L2 padding to align both header and payload to 4-byte boundary | |
137 | */ | |
138 | void rt2x00queue_insert_l2pad(struct sk_buff *skb, unsigned int header_length); | |
139 | ||
140 | /** | |
141 | * rt2x00queue_insert_l2pad - Remove L2 padding from 802.11 frame | |
9f166171 | 142 | * @skb: The skb to align |
9f166171 ID |
143 | * @header_length: Length of 802.11 header |
144 | * | |
daee6c09 ID |
145 | * Remove L2 padding used to align both header and payload to 4-byte boundary, |
146 | * by removing the L2 padding the header will no longer be 4-byte aligned. | |
9f166171 | 147 | */ |
daee6c09 | 148 | void rt2x00queue_remove_l2pad(struct sk_buff *skb, unsigned int header_length); |
9f166171 | 149 | |
d74f5ba4 ID |
150 | /** |
151 | * rt2x00queue_write_tx_frame - Write TX frame to hardware | |
152 | * @queue: Queue over which the frame should be send | |
153 | * @skb: The skb to send | |
7351c6bd | 154 | * @local: frame is not from mac80211 |
181d6902 | 155 | */ |
7351c6bd JB |
156 | int rt2x00queue_write_tx_frame(struct data_queue *queue, struct sk_buff *skb, |
157 | bool local); | |
d74f5ba4 | 158 | |
bd88a781 ID |
159 | /** |
160 | * rt2x00queue_update_beacon - Send new beacon from mac80211 to hardware | |
161 | * @rt2x00dev: Pointer to &struct rt2x00_dev. | |
162 | * @vif: Interface for which the beacon should be updated. | |
a2c9b652 | 163 | * @enable_beacon: Enable beaconing |
bd88a781 ID |
164 | */ |
165 | int rt2x00queue_update_beacon(struct rt2x00_dev *rt2x00dev, | |
a2c9b652 ID |
166 | struct ieee80211_vif *vif, |
167 | const bool enable_beacon); | |
bd88a781 | 168 | |
d74f5ba4 ID |
169 | /** |
170 | * rt2x00queue_index_inc - Index incrementation function | |
171 | * @queue: Queue (&struct data_queue) to perform the action on. | |
172 | * @index: Index type (&enum queue_index) to perform the action on. | |
173 | * | |
174 | * This function will increase the requested index on the queue, | |
175 | * it will grab the appropriate locks and handle queue overflow events by | |
176 | * resetting the index to the start of the queue. | |
177 | */ | |
178 | void rt2x00queue_index_inc(struct data_queue *queue, enum queue_index index); | |
179 | ||
798b7adb ID |
180 | /** |
181 | * rt2x00queue_init_queues - Initialize all data queues | |
182 | * @rt2x00dev: Pointer to &struct rt2x00_dev. | |
183 | * | |
184 | * This function will loop through all available queues to clear all | |
185 | * index numbers and set the queue entry to the correct initialization | |
186 | * state. | |
187 | */ | |
188 | void rt2x00queue_init_queues(struct rt2x00_dev *rt2x00dev); | |
189 | ||
181d6902 ID |
190 | int rt2x00queue_initialize(struct rt2x00_dev *rt2x00dev); |
191 | void rt2x00queue_uninitialize(struct rt2x00_dev *rt2x00dev); | |
192 | int rt2x00queue_allocate(struct rt2x00_dev *rt2x00dev); | |
193 | void rt2x00queue_free(struct rt2x00_dev *rt2x00dev); | |
194 | ||
84e3196f ID |
195 | /** |
196 | * rt2x00link_update_stats - Update link statistics from RX frame | |
197 | * @rt2x00dev: Pointer to &struct rt2x00_dev. | |
198 | * @skb: Received frame | |
199 | * @rxdesc: Received frame descriptor | |
200 | * | |
201 | * Update link statistics based on the information from the | |
202 | * received frame descriptor. | |
203 | */ | |
204 | void rt2x00link_update_stats(struct rt2x00_dev *rt2x00dev, | |
205 | struct sk_buff *skb, | |
206 | struct rxdone_entry_desc *rxdesc); | |
207 | ||
84e3196f ID |
208 | /** |
209 | * rt2x00link_start_tuner - Start periodic link tuner work | |
210 | * @rt2x00dev: Pointer to &struct rt2x00_dev. | |
211 | * | |
212 | * This start the link tuner periodic work, this work will | |
213 | * be executed periodically until &rt2x00link_stop_tuner has | |
214 | * been called. | |
215 | */ | |
216 | void rt2x00link_start_tuner(struct rt2x00_dev *rt2x00dev); | |
217 | ||
218 | /** | |
219 | * rt2x00link_stop_tuner - Stop periodic link tuner work | |
220 | * @rt2x00dev: Pointer to &struct rt2x00_dev. | |
221 | * | |
222 | * After this function completed the link tuner will not | |
223 | * be running until &rt2x00link_start_tuner is called. | |
224 | */ | |
225 | void rt2x00link_stop_tuner(struct rt2x00_dev *rt2x00dev); | |
226 | ||
227 | /** | |
228 | * rt2x00link_reset_tuner - Reset periodic link tuner work | |
229 | * @rt2x00dev: Pointer to &struct rt2x00_dev. | |
230 | * @antenna: Should the antenna tuning also be reset | |
231 | * | |
232 | * The VGC limit configured in the hardware will be reset to 0 | |
233 | * which forces the driver to rediscover the correct value for | |
234 | * the current association. This is needed when configuration | |
235 | * options have changed which could drastically change the | |
236 | * SNR level or link quality (i.e. changing the antenna setting). | |
237 | * | |
238 | * Resetting the link tuner will also cause the periodic work counter | |
239 | * to be reset. Any driver which has a fixed limit on the number | |
240 | * of rounds the link tuner is supposed to work will accept the | |
241 | * tuner actions again if this limit was previously reached. | |
242 | * | |
243 | * If @antenna is set to true a the software antenna diversity | |
244 | * tuning will also be reset. | |
245 | */ | |
246 | void rt2x00link_reset_tuner(struct rt2x00_dev *rt2x00dev, bool antenna); | |
247 | ||
248 | /** | |
c965c74b | 249 | * rt2x00link_start_watchdog - Start periodic watchdog monitoring |
84e3196f ID |
250 | * @rt2x00dev: Pointer to &struct rt2x00_dev. |
251 | * | |
c965c74b ID |
252 | * This start the watchdog periodic work, this work will |
253 | *be executed periodically until &rt2x00link_stop_watchdog has | |
254 | * been called. | |
255 | */ | |
256 | void rt2x00link_start_watchdog(struct rt2x00_dev *rt2x00dev); | |
257 | ||
258 | /** | |
259 | * rt2x00link_stop_watchdog - Stop periodic watchdog monitoring | |
260 | * @rt2x00dev: Pointer to &struct rt2x00_dev. | |
261 | * | |
262 | * After this function completed the watchdog monitoring will not | |
263 | * be running until &rt2x00link_start_watchdog is called. | |
264 | */ | |
265 | void rt2x00link_stop_watchdog(struct rt2x00_dev *rt2x00dev); | |
266 | ||
267 | /** | |
268 | * rt2x00link_register - Initialize link tuning & watchdog functionality | |
269 | * @rt2x00dev: Pointer to &struct rt2x00_dev. | |
270 | * | |
271 | * Initialize work structure and all link tuning and watchdog related | |
272 | * parameters. This will not start the periodic work itself. | |
84e3196f ID |
273 | */ |
274 | void rt2x00link_register(struct rt2x00_dev *rt2x00dev); | |
275 | ||
95ea3627 ID |
276 | /* |
277 | * Firmware handlers. | |
278 | */ | |
279 | #ifdef CONFIG_RT2X00_LIB_FIRMWARE | |
280 | int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev); | |
281 | void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev); | |
282 | #else | |
283 | static inline int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev) | |
284 | { | |
285 | return 0; | |
286 | } | |
287 | static inline void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev) | |
288 | { | |
289 | } | |
290 | #endif /* CONFIG_RT2X00_LIB_FIRMWARE */ | |
291 | ||
292 | /* | |
293 | * Debugfs handlers. | |
294 | */ | |
295 | #ifdef CONFIG_RT2X00_LIB_DEBUGFS | |
296 | void rt2x00debug_register(struct rt2x00_dev *rt2x00dev); | |
297 | void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev); | |
2bb057d0 | 298 | void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev, |
84e3196f | 299 | struct rxdone_entry_desc *rxdesc); |
95ea3627 ID |
300 | #else |
301 | static inline void rt2x00debug_register(struct rt2x00_dev *rt2x00dev) | |
302 | { | |
303 | } | |
304 | ||
305 | static inline void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev) | |
306 | { | |
307 | } | |
4d8dd66c | 308 | |
2bb057d0 | 309 | static inline void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev, |
84e3196f | 310 | struct rxdone_entry_desc *rxdesc) |
2bb057d0 ID |
311 | { |
312 | } | |
95ea3627 ID |
313 | #endif /* CONFIG_RT2X00_LIB_DEBUGFS */ |
314 | ||
2bb057d0 ID |
315 | /* |
316 | * Crypto handlers. | |
317 | */ | |
318 | #ifdef CONFIG_RT2X00_LIB_CRYPTO | |
319 | enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key); | |
9c3444d3 ID |
320 | void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry, |
321 | struct txentry_desc *txdesc); | |
7b40982e ID |
322 | unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev, |
323 | struct sk_buff *skb); | |
9eb4e21e ID |
324 | void rt2x00crypto_tx_copy_iv(struct sk_buff *skb, |
325 | struct txentry_desc *txdesc); | |
326 | void rt2x00crypto_tx_remove_iv(struct sk_buff *skb, | |
327 | struct txentry_desc *txdesc); | |
9f166171 | 328 | void rt2x00crypto_tx_insert_iv(struct sk_buff *skb, unsigned int header_length); |
daee6c09 | 329 | void rt2x00crypto_rx_insert_iv(struct sk_buff *skb, |
2bb057d0 ID |
330 | unsigned int header_length, |
331 | struct rxdone_entry_desc *rxdesc); | |
332 | #else | |
333 | static inline enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key) | |
334 | { | |
335 | return CIPHER_NONE; | |
336 | } | |
337 | ||
9c3444d3 ID |
338 | static inline void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry, |
339 | struct txentry_desc *txdesc) | |
340 | { | |
341 | } | |
342 | ||
7b40982e ID |
343 | static inline unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev, |
344 | struct sk_buff *skb) | |
2bb057d0 ID |
345 | { |
346 | return 0; | |
347 | } | |
348 | ||
dddfb478 | 349 | static inline void rt2x00crypto_tx_copy_iv(struct sk_buff *skb, |
9eb4e21e | 350 | struct txentry_desc *txdesc) |
dddfb478 ID |
351 | { |
352 | } | |
353 | ||
2bb057d0 | 354 | static inline void rt2x00crypto_tx_remove_iv(struct sk_buff *skb, |
9eb4e21e | 355 | struct txentry_desc *txdesc) |
2bb057d0 ID |
356 | { |
357 | } | |
358 | ||
9f166171 ID |
359 | static inline void rt2x00crypto_tx_insert_iv(struct sk_buff *skb, |
360 | unsigned int header_length) | |
2bb057d0 ID |
361 | { |
362 | } | |
363 | ||
fe247563 | 364 | static inline void rt2x00crypto_rx_insert_iv(struct sk_buff *skb, |
2bb057d0 ID |
365 | unsigned int header_length, |
366 | struct rxdone_entry_desc *rxdesc) | |
367 | { | |
368 | } | |
9c3444d3 | 369 | #endif /* CONFIG_RT2X00_LIB_CRYPTO */ |
2bb057d0 | 370 | |
35f00cfc ID |
371 | /* |
372 | * HT handlers. | |
373 | */ | |
374 | #ifdef CONFIG_RT2X00_LIB_HT | |
375 | void rt2x00ht_create_tx_descriptor(struct queue_entry *entry, | |
376 | struct txentry_desc *txdesc, | |
377 | const struct rt2x00_rate *hwrate); | |
06443e46 GW |
378 | |
379 | u16 rt2x00ht_center_channel(struct rt2x00_dev *rt2x00dev, | |
380 | struct ieee80211_conf *conf); | |
35f00cfc ID |
381 | #else |
382 | static inline void rt2x00ht_create_tx_descriptor(struct queue_entry *entry, | |
383 | struct txentry_desc *txdesc, | |
384 | const struct rt2x00_rate *hwrate) | |
385 | { | |
386 | } | |
06443e46 GW |
387 | |
388 | static inline u16 rt2x00ht_center_channel(struct rt2x00_dev *rt2x00dev, | |
389 | struct ieee80211_conf *conf) | |
390 | { | |
391 | return conf->channel->hw_value; | |
392 | } | |
35f00cfc ID |
393 | #endif /* CONFIG_RT2X00_LIB_HT */ |
394 | ||
95ea3627 ID |
395 | /* |
396 | * RFkill handlers. | |
397 | */ | |
1682fe6d | 398 | static inline void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev) |
95ea3627 | 399 | { |
e47a5cdd ID |
400 | if (test_bit(CONFIG_SUPPORT_HW_BUTTON, &rt2x00dev->flags)) |
401 | wiphy_rfkill_start_polling(rt2x00dev->hw->wiphy); | |
95ea3627 ID |
402 | } |
403 | ||
404 | static inline void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev) | |
405 | { | |
e47a5cdd ID |
406 | if (test_bit(CONFIG_SUPPORT_HW_BUTTON, &rt2x00dev->flags)) |
407 | wiphy_rfkill_stop_polling(rt2x00dev->hw->wiphy); | |
95ea3627 ID |
408 | } |
409 | ||
a9450b70 ID |
410 | /* |
411 | * LED handlers | |
412 | */ | |
413 | #ifdef CONFIG_RT2X00_LIB_LEDS | |
414 | void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev, int rssi); | |
61c2b682 | 415 | void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev, bool enabled); |
a2e1d52a ID |
416 | void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev, bool enabled); |
417 | void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev, bool enabled); | |
72fa559b | 418 | void rt2x00leds_register(struct rt2x00_dev *rt2x00dev); |
a9450b70 ID |
419 | void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev); |
420 | void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev); | |
421 | void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev); | |
422 | #else | |
423 | static inline void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev, | |
424 | int rssi) | |
425 | { | |
426 | } | |
427 | ||
61c2b682 ID |
428 | static inline void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev, |
429 | bool enabled) | |
430 | { | |
431 | } | |
432 | ||
a2e1d52a ID |
433 | static inline void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev, |
434 | bool enabled) | |
435 | { | |
436 | } | |
437 | ||
438 | static inline void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev, | |
439 | bool enabled) | |
440 | { | |
441 | } | |
442 | ||
72fa559b | 443 | static inline void rt2x00leds_register(struct rt2x00_dev *rt2x00dev) |
a9450b70 | 444 | { |
a9450b70 ID |
445 | } |
446 | ||
447 | static inline void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev) | |
448 | { | |
449 | } | |
450 | ||
451 | static inline void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev) | |
452 | { | |
453 | } | |
454 | ||
455 | static inline void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev) | |
456 | { | |
457 | } | |
458 | #endif /* CONFIG_RT2X00_LIB_LEDS */ | |
459 | ||
95ea3627 | 460 | #endif /* RT2X00LIB_H */ |