rt2x00: Reorganize beacon handling
[kernel.git] / drivers / net / wireless / rt2x00 / rt2x00lib.h
1 /*
2         Copyright (C) 2004 - 2008 rt2x00 SourceForge Project
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
29 #include "rt2x00dump.h"
30
31 /*
32  * Interval defines
33  * Both the link tuner as the rfkill will be called once per second.
34  */
35 #define LINK_TUNE_INTERVAL      ( round_jiffies_relative(HZ) )
36 #define RFKILL_POLL_INTERVAL    ( round_jiffies_relative(HZ) )
37
38 /*
39  * rt2x00_rate: Per rate device information
40  */
41 struct rt2x00_rate {
42         unsigned short flags;
43 #define DEV_RATE_CCK                    0x0001
44 #define DEV_RATE_OFDM                   0x0002
45 #define DEV_RATE_SHORT_PREAMBLE         0x0004
46 #define DEV_RATE_BASIC                  0x0008
47
48         unsigned short bitrate; /* In 100kbit/s */
49         unsigned short ratemask;
50
51         unsigned short plcp;
52 };
53
54 extern const struct rt2x00_rate rt2x00_supported_rates[12];
55
56 static inline u16 rt2x00_create_rate_hw_value(const u16 index,
57                                               const u16 short_preamble)
58 {
59         return (short_preamble << 8) | (index & 0xff);
60 }
61
62 static inline const struct rt2x00_rate *rt2x00_get_rate(const u16 hw_value)
63 {
64         return &rt2x00_supported_rates[hw_value & 0xff];
65 }
66
67 static inline int rt2x00_get_rate_preamble(const u16 hw_value)
68 {
69         return (hw_value & 0xff00);
70 }
71
72 /*
73  * Radio control handlers.
74  */
75 int rt2x00lib_enable_radio(struct rt2x00_dev *rt2x00dev);
76 void rt2x00lib_disable_radio(struct rt2x00_dev *rt2x00dev);
77 void rt2x00lib_toggle_rx(struct rt2x00_dev *rt2x00dev, enum dev_state state);
78 void rt2x00lib_reset_link_tuner(struct rt2x00_dev *rt2x00dev);
79
80 /*
81  * Initialization handlers.
82  */
83 int rt2x00lib_start(struct rt2x00_dev *rt2x00dev);
84 void rt2x00lib_stop(struct rt2x00_dev *rt2x00dev);
85
86 /*
87  * Configuration handlers.
88  */
89 void rt2x00lib_config_intf(struct rt2x00_dev *rt2x00dev,
90                            struct rt2x00_intf *intf,
91                            enum ieee80211_if_types type,
92                            u8 *mac, u8 *bssid);
93 void rt2x00lib_config_erp(struct rt2x00_dev *rt2x00dev,
94                           struct rt2x00_intf *intf,
95                           struct ieee80211_bss_conf *conf);
96 void rt2x00lib_config_antenna(struct rt2x00_dev *rt2x00dev,
97                               enum antenna rx, enum antenna tx);
98 void rt2x00lib_config(struct rt2x00_dev *rt2x00dev,
99                       struct ieee80211_conf *conf, const int force_config);
100
101 /**
102  * DOC: Queue handlers
103  */
104
105 /**
106  * rt2x00queue_alloc_rxskb - allocate a skb for RX purposes.
107  * @rt2x00dev: Pointer to &struct rt2x00_dev.
108  * @queue: The queue for which the skb will be applicable.
109  */
110 struct sk_buff *rt2x00queue_alloc_rxskb(struct rt2x00_dev *rt2x00dev,
111                                         struct queue_entry *entry);
112
113 /**
114  * rt2x00queue_unmap_skb - Unmap a skb from DMA.
115  * @rt2x00dev: Pointer to &struct rt2x00_dev.
116  * @skb: The skb to unmap.
117  */
118 void rt2x00queue_unmap_skb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb);
119
120 /**
121  * rt2x00queue_free_skb - free a skb
122  * @rt2x00dev: Pointer to &struct rt2x00_dev.
123  * @skb: The skb to free.
124  */
125 void rt2x00queue_free_skb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb);
126
127 /**
128  * rt2x00queue_free_skb - free a skb
129  * @rt2x00dev: Pointer to &struct rt2x00_dev.
130  * @skb: The skb to free.
131  */
132 void rt2x00queue_free_skb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb);
133
134 /**
135  * rt2x00queue_write_tx_frame - Write TX frame to hardware
136  * @queue: Queue over which the frame should be send
137  * @skb: The skb to send
138  */
139 int rt2x00queue_write_tx_frame(struct data_queue *queue, struct sk_buff *skb);
140
141 /**
142  * rt2x00queue_update_beacon - Send new beacon from mac80211 to hardware
143  * @rt2x00dev: Pointer to &struct rt2x00_dev.
144  * @vif: Interface for which the beacon should be updated.
145  */
146 int rt2x00queue_update_beacon(struct rt2x00_dev *rt2x00dev,
147                               struct ieee80211_vif *vif);
148
149 /**
150  * rt2x00queue_index_inc - Index incrementation function
151  * @queue: Queue (&struct data_queue) to perform the action on.
152  * @index: Index type (&enum queue_index) to perform the action on.
153  *
154  * This function will increase the requested index on the queue,
155  * it will grab the appropriate locks and handle queue overflow events by
156  * resetting the index to the start of the queue.
157  */
158 void rt2x00queue_index_inc(struct data_queue *queue, enum queue_index index);
159
160 void rt2x00queue_init_rx(struct rt2x00_dev *rt2x00dev);
161 void rt2x00queue_init_tx(struct rt2x00_dev *rt2x00dev);
162 int rt2x00queue_initialize(struct rt2x00_dev *rt2x00dev);
163 void rt2x00queue_uninitialize(struct rt2x00_dev *rt2x00dev);
164 int rt2x00queue_allocate(struct rt2x00_dev *rt2x00dev);
165 void rt2x00queue_free(struct rt2x00_dev *rt2x00dev);
166
167 /*
168  * Firmware handlers.
169  */
170 #ifdef CONFIG_RT2X00_LIB_FIRMWARE
171 int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev);
172 void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev);
173 #else
174 static inline int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev)
175 {
176         return 0;
177 }
178 static inline void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev)
179 {
180 }
181 #endif /* CONFIG_RT2X00_LIB_FIRMWARE */
182
183 /*
184  * Debugfs handlers.
185  */
186 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
187 void rt2x00debug_register(struct rt2x00_dev *rt2x00dev);
188 void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev);
189 void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
190                             enum rt2x00_dump_type type, struct sk_buff *skb);
191 #else
192 static inline void rt2x00debug_register(struct rt2x00_dev *rt2x00dev)
193 {
194 }
195
196 static inline void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev)
197 {
198 }
199
200 static inline void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
201                                           enum rt2x00_dump_type type,
202                                           struct sk_buff *skb)
203 {
204 }
205 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
206
207 /*
208  * RFkill handlers.
209  */
210 #ifdef CONFIG_RT2X00_LIB_RFKILL
211 void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev);
212 void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev);
213 void rt2x00rfkill_allocate(struct rt2x00_dev *rt2x00dev);
214 void rt2x00rfkill_free(struct rt2x00_dev *rt2x00dev);
215 #else
216 static inline void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev)
217 {
218 }
219
220 static inline void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev)
221 {
222 }
223
224 static inline void rt2x00rfkill_allocate(struct rt2x00_dev *rt2x00dev)
225 {
226 }
227
228 static inline void rt2x00rfkill_free(struct rt2x00_dev *rt2x00dev)
229 {
230 }
231 #endif /* CONFIG_RT2X00_LIB_RFKILL */
232
233 /*
234  * LED handlers
235  */
236 #ifdef CONFIG_RT2X00_LIB_LEDS
237 void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev, int rssi);
238 void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev, bool enabled);
239 void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev, bool enabled);
240 void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev, bool enabled);
241 void rt2x00leds_register(struct rt2x00_dev *rt2x00dev);
242 void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev);
243 void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev);
244 void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev);
245 #else
246 static inline void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev,
247                                           int rssi)
248 {
249 }
250
251 static inline void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev,
252                                           bool enabled)
253 {
254 }
255
256 static inline void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev,
257                                         bool enabled)
258 {
259 }
260
261 static inline void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev,
262                                         bool enabled)
263 {
264 }
265
266 static inline void rt2x00leds_register(struct rt2x00_dev *rt2x00dev)
267 {
268 }
269
270 static inline void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev)
271 {
272 }
273
274 static inline void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev)
275 {
276 }
277
278 static inline void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev)
279 {
280 }
281 #endif /* CONFIG_RT2X00_LIB_LEDS */
282
283 #endif /* RT2X00LIB_H */