rt2x00: Refactor beacon code to make use of start- and stop_queue
[linux-2.6.git] / drivers / net / wireless / rt2x00 / rt2x00lib.h
1 /*
2         Copyright (C) 2004 - 2009 Ivo van Doorn <IvDoorn@gmail.com>
3         Copyright (C) 2004 - 2009 Gertjan van Wingerde <gwingerde@gmail.com>
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  */
33 #define WATCHDOG_INTERVAL       round_jiffies_relative(HZ)
34 #define LINK_TUNE_INTERVAL      round_jiffies_relative(HZ)
35
36 /*
37  * rt2x00_rate: Per rate device information
38  */
39 struct rt2x00_rate {
40         unsigned short flags;
41 #define DEV_RATE_CCK                    0x0001
42 #define DEV_RATE_OFDM                   0x0002
43 #define DEV_RATE_SHORT_PREAMBLE         0x0004
44
45         unsigned short bitrate; /* In 100kbit/s */
46         unsigned short ratemask;
47
48         unsigned short plcp;
49         unsigned short mcs;
50 };
51
52 extern const struct rt2x00_rate rt2x00_supported_rates[12];
53
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
59 #define RATE_MCS(__mode, __mcs) \
60         ((((__mode) & 0x00ff) << 8) | ((__mcs) & 0x00ff))
61
62 static inline int rt2x00_get_rate_mcs(const u16 mcs_value)
63 {
64         return (mcs_value & 0x00ff);
65 }
66
67 /*
68  * Radio control handlers.
69  */
70 int rt2x00lib_enable_radio(struct rt2x00_dev *rt2x00dev);
71 void rt2x00lib_disable_radio(struct rt2x00_dev *rt2x00dev);
72
73 /*
74  * Initialization handlers.
75  */
76 int rt2x00lib_start(struct rt2x00_dev *rt2x00dev);
77 void rt2x00lib_stop(struct rt2x00_dev *rt2x00dev);
78
79 /*
80  * Configuration handlers.
81  */
82 void rt2x00lib_config_intf(struct rt2x00_dev *rt2x00dev,
83                            struct rt2x00_intf *intf,
84                            enum nl80211_iftype type,
85                            const u8 *mac, const u8 *bssid);
86 void rt2x00lib_config_erp(struct rt2x00_dev *rt2x00dev,
87                           struct rt2x00_intf *intf,
88                           struct ieee80211_bss_conf *conf,
89                           u32 changed);
90 void rt2x00lib_config_antenna(struct rt2x00_dev *rt2x00dev,
91                               struct antenna_setup ant);
92 void rt2x00lib_config(struct rt2x00_dev *rt2x00dev,
93                       struct ieee80211_conf *conf,
94                       const unsigned int changed_flags);
95
96 /**
97  * DOC: Queue handlers
98  */
99
100 /**
101  * rt2x00queue_alloc_rxskb - allocate a skb for RX purposes.
102  * @entry: The entry for which the skb will be applicable.
103  */
104 struct sk_buff *rt2x00queue_alloc_rxskb(struct queue_entry *entry);
105
106 /**
107  * rt2x00queue_free_skb - free a skb
108  * @entry: The entry for which the skb will be applicable.
109  */
110 void rt2x00queue_free_skb(struct queue_entry *entry);
111
112 /**
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
142  * @skb: The skb to align
143  * @header_length: Length of 802.11 header
144  *
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.
147  */
148 void rt2x00queue_remove_l2pad(struct sk_buff *skb, unsigned int header_length);
149
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
154  * @local: frame is not from mac80211
155  */
156 int rt2x00queue_write_tx_frame(struct data_queue *queue, struct sk_buff *skb,
157                                bool local);
158
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.
163  */
164 int rt2x00queue_update_beacon(struct rt2x00_dev *rt2x00dev,
165                               struct ieee80211_vif *vif);
166
167 /**
168  * rt2x00queue_clear_beacon - Clear beacon in hardware
169  * @rt2x00dev: Pointer to &struct rt2x00_dev.
170  * @vif: Interface for which the beacon should be updated.
171  */
172 int rt2x00queue_clear_beacon(struct rt2x00_dev *rt2x00dev,
173                              struct ieee80211_vif *vif);
174
175 /**
176  * rt2x00queue_index_inc - Index incrementation function
177  * @queue: Queue (&struct data_queue) to perform the action on.
178  * @index: Index type (&enum queue_index) to perform the action on.
179  *
180  * This function will increase the requested index on the queue,
181  * it will grab the appropriate locks and handle queue overflow events by
182  * resetting the index to the start of the queue.
183  */
184 void rt2x00queue_index_inc(struct data_queue *queue, enum queue_index index);
185
186 /**
187  * rt2x00queue_init_queues - Initialize all data queues
188  * @rt2x00dev: Pointer to &struct rt2x00_dev.
189  *
190  * This function will loop through all available queues to clear all
191  * index numbers and set the queue entry to the correct initialization
192  * state.
193  */
194 void rt2x00queue_init_queues(struct rt2x00_dev *rt2x00dev);
195
196 int rt2x00queue_initialize(struct rt2x00_dev *rt2x00dev);
197 void rt2x00queue_uninitialize(struct rt2x00_dev *rt2x00dev);
198 int rt2x00queue_allocate(struct rt2x00_dev *rt2x00dev);
199 void rt2x00queue_free(struct rt2x00_dev *rt2x00dev);
200
201 /**
202  * rt2x00link_update_stats - Update link statistics from RX frame
203  * @rt2x00dev: Pointer to &struct rt2x00_dev.
204  * @skb: Received frame
205  * @rxdesc: Received frame descriptor
206  *
207  * Update link statistics based on the information from the
208  * received frame descriptor.
209  */
210 void rt2x00link_update_stats(struct rt2x00_dev *rt2x00dev,
211                              struct sk_buff *skb,
212                              struct rxdone_entry_desc *rxdesc);
213
214 /**
215  * rt2x00link_start_tuner - Start periodic link tuner work
216  * @rt2x00dev: Pointer to &struct rt2x00_dev.
217  *
218  * This start the link tuner periodic work, this work will
219  * be executed periodically until &rt2x00link_stop_tuner has
220  * been called.
221  */
222 void rt2x00link_start_tuner(struct rt2x00_dev *rt2x00dev);
223
224 /**
225  * rt2x00link_stop_tuner - Stop periodic link tuner work
226  * @rt2x00dev: Pointer to &struct rt2x00_dev.
227  *
228  * After this function completed the link tuner will not
229  * be running until &rt2x00link_start_tuner is called.
230  */
231 void rt2x00link_stop_tuner(struct rt2x00_dev *rt2x00dev);
232
233 /**
234  * rt2x00link_reset_tuner - Reset periodic link tuner work
235  * @rt2x00dev: Pointer to &struct rt2x00_dev.
236  * @antenna: Should the antenna tuning also be reset
237  *
238  * The VGC limit configured in the hardware will be reset to 0
239  * which forces the driver to rediscover the correct value for
240  * the current association. This is needed when configuration
241  * options have changed which could drastically change the
242  * SNR level or link quality (i.e. changing the antenna setting).
243  *
244  * Resetting the link tuner will also cause the periodic work counter
245  * to be reset. Any driver which has a fixed limit on the number
246  * of rounds the link tuner is supposed to work will accept the
247  * tuner actions again if this limit was previously reached.
248  *
249  * If @antenna is set to true a the software antenna diversity
250  * tuning will also be reset.
251  */
252 void rt2x00link_reset_tuner(struct rt2x00_dev *rt2x00dev, bool antenna);
253
254 /**
255  * rt2x00link_start_watchdog - Start periodic watchdog monitoring
256  * @rt2x00dev: Pointer to &struct rt2x00_dev.
257  *
258  * This start the watchdog periodic work, this work will
259  *be executed periodically until &rt2x00link_stop_watchdog has
260  * been called.
261  */
262 void rt2x00link_start_watchdog(struct rt2x00_dev *rt2x00dev);
263
264 /**
265  * rt2x00link_stop_watchdog - Stop periodic watchdog monitoring
266  * @rt2x00dev: Pointer to &struct rt2x00_dev.
267  *
268  * After this function completed the watchdog monitoring will not
269  * be running until &rt2x00link_start_watchdog is called.
270  */
271 void rt2x00link_stop_watchdog(struct rt2x00_dev *rt2x00dev);
272
273 /**
274  * rt2x00link_register - Initialize link tuning & watchdog functionality
275  * @rt2x00dev: Pointer to &struct rt2x00_dev.
276  *
277  * Initialize work structure and all link tuning and watchdog related
278  * parameters. This will not start the periodic work itself.
279  */
280 void rt2x00link_register(struct rt2x00_dev *rt2x00dev);
281
282 /*
283  * Firmware handlers.
284  */
285 #ifdef CONFIG_RT2X00_LIB_FIRMWARE
286 int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev);
287 void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev);
288 #else
289 static inline int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev)
290 {
291         return 0;
292 }
293 static inline void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev)
294 {
295 }
296 #endif /* CONFIG_RT2X00_LIB_FIRMWARE */
297
298 /*
299  * Debugfs handlers.
300  */
301 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
302 void rt2x00debug_register(struct rt2x00_dev *rt2x00dev);
303 void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev);
304 void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
305                                struct rxdone_entry_desc *rxdesc);
306 #else
307 static inline void rt2x00debug_register(struct rt2x00_dev *rt2x00dev)
308 {
309 }
310
311 static inline void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev)
312 {
313 }
314
315 static inline void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
316                                              struct rxdone_entry_desc *rxdesc)
317 {
318 }
319 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
320
321 /*
322  * Crypto handlers.
323  */
324 #ifdef CONFIG_RT2X00_LIB_CRYPTO
325 enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key);
326 void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry,
327                                        struct txentry_desc *txdesc);
328 unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev,
329                                       struct sk_buff *skb);
330 void rt2x00crypto_tx_copy_iv(struct sk_buff *skb,
331                              struct txentry_desc *txdesc);
332 void rt2x00crypto_tx_remove_iv(struct sk_buff *skb,
333                                struct txentry_desc *txdesc);
334 void rt2x00crypto_tx_insert_iv(struct sk_buff *skb, unsigned int header_length);
335 void rt2x00crypto_rx_insert_iv(struct sk_buff *skb,
336                                unsigned int header_length,
337                                struct rxdone_entry_desc *rxdesc);
338 #else
339 static inline enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key)
340 {
341         return CIPHER_NONE;
342 }
343
344 static inline void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry,
345                                                      struct txentry_desc *txdesc)
346 {
347 }
348
349 static inline unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev,
350                                                     struct sk_buff *skb)
351 {
352         return 0;
353 }
354
355 static inline void rt2x00crypto_tx_copy_iv(struct sk_buff *skb,
356                                            struct txentry_desc *txdesc)
357 {
358 }
359
360 static inline void rt2x00crypto_tx_remove_iv(struct sk_buff *skb,
361                                              struct txentry_desc *txdesc)
362 {
363 }
364
365 static inline void rt2x00crypto_tx_insert_iv(struct sk_buff *skb,
366                                              unsigned int header_length)
367 {
368 }
369
370 static inline void rt2x00crypto_rx_insert_iv(struct sk_buff *skb,
371                                              unsigned int header_length,
372                                              struct rxdone_entry_desc *rxdesc)
373 {
374 }
375 #endif /* CONFIG_RT2X00_LIB_CRYPTO */
376
377 /*
378  * HT handlers.
379  */
380 #ifdef CONFIG_RT2X00_LIB_HT
381 void rt2x00ht_create_tx_descriptor(struct queue_entry *entry,
382                                    struct txentry_desc *txdesc,
383                                    const struct rt2x00_rate *hwrate);
384
385 u16 rt2x00ht_center_channel(struct rt2x00_dev *rt2x00dev,
386                             struct ieee80211_conf *conf);
387 #else
388 static inline void rt2x00ht_create_tx_descriptor(struct queue_entry *entry,
389                                                  struct txentry_desc *txdesc,
390                                                  const struct rt2x00_rate *hwrate)
391 {
392 }
393
394 static inline u16 rt2x00ht_center_channel(struct rt2x00_dev *rt2x00dev,
395                                           struct ieee80211_conf *conf)
396 {
397         return conf->channel->hw_value;
398 }
399 #endif /* CONFIG_RT2X00_LIB_HT */
400
401 /*
402  * RFkill handlers.
403  */
404 static inline void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev)
405 {
406         if (test_bit(CONFIG_SUPPORT_HW_BUTTON, &rt2x00dev->flags))
407                 wiphy_rfkill_start_polling(rt2x00dev->hw->wiphy);
408 }
409
410 static inline void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev)
411 {
412         if (test_bit(CONFIG_SUPPORT_HW_BUTTON, &rt2x00dev->flags))
413                 wiphy_rfkill_stop_polling(rt2x00dev->hw->wiphy);
414 }
415
416 /*
417  * LED handlers
418  */
419 #ifdef CONFIG_RT2X00_LIB_LEDS
420 void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev, int rssi);
421 void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev, bool enabled);
422 void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev, bool enabled);
423 void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev, bool enabled);
424 void rt2x00leds_register(struct rt2x00_dev *rt2x00dev);
425 void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev);
426 void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev);
427 void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev);
428 #else
429 static inline void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev,
430                                           int rssi)
431 {
432 }
433
434 static inline void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev,
435                                           bool enabled)
436 {
437 }
438
439 static inline void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev,
440                                         bool enabled)
441 {
442 }
443
444 static inline void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev,
445                                         bool enabled)
446 {
447 }
448
449 static inline void rt2x00leds_register(struct rt2x00_dev *rt2x00dev)
450 {
451 }
452
453 static inline void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev)
454 {
455 }
456
457 static inline void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev)
458 {
459 }
460
461 static inline void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev)
462 {
463 }
464 #endif /* CONFIG_RT2X00_LIB_LEDS */
465
466 #endif /* RT2X00LIB_H */