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