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>
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.
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.
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.
24 Abstract: Data structures and definitions for the rt2x00lib module.
33 #define WATCHDOG_INTERVAL round_jiffies_relative(HZ)
34 #define LINK_TUNE_INTERVAL round_jiffies_relative(HZ)
37 * rt2x00_rate: Per rate device information
41 #define DEV_RATE_CCK 0x0001
42 #define DEV_RATE_OFDM 0x0002
43 #define DEV_RATE_SHORT_PREAMBLE 0x0004
45 unsigned short bitrate
; /* In 100kbit/s */
46 unsigned short ratemask
;
52 extern const struct rt2x00_rate rt2x00_supported_rates
[12];
54 static inline const struct rt2x00_rate
*rt2x00_get_rate(const u16 hw_value
)
56 return &rt2x00_supported_rates
[hw_value
& 0xff];
59 #define RATE_MCS(__mode, __mcs) \
60 ( (((__mode) & 0x00ff) << 8) | ((__mcs) & 0x00ff) )
62 static inline int rt2x00_get_rate_mcs(const u16 mcs_value
)
64 return (mcs_value
& 0x00ff);
68 * Radio control handlers.
70 int rt2x00lib_enable_radio(struct rt2x00_dev
*rt2x00dev
);
71 void rt2x00lib_disable_radio(struct rt2x00_dev
*rt2x00dev
);
72 void rt2x00lib_toggle_rx(struct rt2x00_dev
*rt2x00dev
, enum dev_state state
);
75 * Initialization handlers.
77 int rt2x00lib_start(struct rt2x00_dev
*rt2x00dev
);
78 void rt2x00lib_stop(struct rt2x00_dev
*rt2x00dev
);
81 * Configuration handlers.
83 void rt2x00lib_config_intf(struct rt2x00_dev
*rt2x00dev
,
84 struct rt2x00_intf
*intf
,
85 enum nl80211_iftype type
,
86 const u8
*mac
, const u8
*bssid
);
87 void rt2x00lib_config_erp(struct rt2x00_dev
*rt2x00dev
,
88 struct rt2x00_intf
*intf
,
89 struct ieee80211_bss_conf
*conf
);
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
);
101 * rt2x00queue_alloc_rxskb - allocate a skb for RX purposes.
102 * @rt2x00dev: Pointer to &struct rt2x00_dev.
103 * @queue: The queue for which the skb will be applicable.
105 struct sk_buff
*rt2x00queue_alloc_rxskb(struct rt2x00_dev
*rt2x00dev
,
106 struct queue_entry
*entry
);
109 * rt2x00queue_free_skb - free a skb
110 * @rt2x00dev: Pointer to &struct rt2x00_dev.
111 * @skb: The skb to free.
113 void rt2x00queue_free_skb(struct rt2x00_dev
*rt2x00dev
, struct sk_buff
*skb
);
116 * rt2x00queue_align_frame - Align 802.11 frame to 4-byte boundary
117 * @skb: The skb to align
119 * Align the start of the 802.11 frame to a 4-byte boundary, this could
120 * mean the payload is not aligned properly though.
122 void rt2x00queue_align_frame(struct sk_buff
*skb
);
125 * rt2x00queue_align_payload - Align 802.11 payload to 4-byte boundary
126 * @skb: The skb to align
127 * @header_length: Length of 802.11 header
129 * Align the 802.11 payload to a 4-byte boundary, this could
130 * mean the header is not aligned properly though.
132 void rt2x00queue_align_payload(struct sk_buff
*skb
, unsigned int header_length
);
135 * rt2x00queue_insert_l2pad - Align 802.11 header & payload to 4-byte boundary
136 * @skb: The skb to align
137 * @header_length: Length of 802.11 header
139 * Apply L2 padding to align both header and payload to 4-byte boundary
141 void rt2x00queue_insert_l2pad(struct sk_buff
*skb
, unsigned int header_length
);
144 * rt2x00queue_insert_l2pad - Remove L2 padding from 802.11 frame
145 * @skb: The skb to align
146 * @header_length: Length of 802.11 header
148 * Remove L2 padding used to align both header and payload to 4-byte boundary,
149 * by removing the L2 padding the header will no longer be 4-byte aligned.
151 void rt2x00queue_remove_l2pad(struct sk_buff
*skb
, unsigned int header_length
);
154 * rt2x00queue_write_tx_frame - Write TX frame to hardware
155 * @queue: Queue over which the frame should be send
156 * @skb: The skb to send
157 * @local: frame is not from mac80211
159 int rt2x00queue_write_tx_frame(struct data_queue
*queue
, struct sk_buff
*skb
,
163 * rt2x00queue_update_beacon - Send new beacon from mac80211 to hardware
164 * @rt2x00dev: Pointer to &struct rt2x00_dev.
165 * @vif: Interface for which the beacon should be updated.
166 * @enable_beacon: Enable beaconing
168 int rt2x00queue_update_beacon(struct rt2x00_dev
*rt2x00dev
,
169 struct ieee80211_vif
*vif
,
170 const bool enable_beacon
);
173 * rt2x00queue_index_inc - Index incrementation function
174 * @queue: Queue (&struct data_queue) to perform the action on.
175 * @index: Index type (&enum queue_index) to perform the action on.
177 * This function will increase the requested index on the queue,
178 * it will grab the appropriate locks and handle queue overflow events by
179 * resetting the index to the start of the queue.
181 void rt2x00queue_index_inc(struct data_queue
*queue
, enum queue_index index
);
184 * rt2x00queue_stop_queues - Halt all data queues
185 * @rt2x00dev: Pointer to &struct rt2x00_dev.
187 * This function will loop through all available queues to stop
188 * any pending outgoing frames.
190 void rt2x00queue_stop_queues(struct rt2x00_dev
*rt2x00dev
);
193 * rt2x00queue_init_queues - Initialize all data queues
194 * @rt2x00dev: Pointer to &struct rt2x00_dev.
196 * This function will loop through all available queues to clear all
197 * index numbers and set the queue entry to the correct initialization
200 void rt2x00queue_init_queues(struct rt2x00_dev
*rt2x00dev
);
202 int rt2x00queue_initialize(struct rt2x00_dev
*rt2x00dev
);
203 void rt2x00queue_uninitialize(struct rt2x00_dev
*rt2x00dev
);
204 int rt2x00queue_allocate(struct rt2x00_dev
*rt2x00dev
);
205 void rt2x00queue_free(struct rt2x00_dev
*rt2x00dev
);
208 * rt2x00link_update_stats - Update link statistics from RX frame
209 * @rt2x00dev: Pointer to &struct rt2x00_dev.
210 * @skb: Received frame
211 * @rxdesc: Received frame descriptor
213 * Update link statistics based on the information from the
214 * received frame descriptor.
216 void rt2x00link_update_stats(struct rt2x00_dev
*rt2x00dev
,
218 struct rxdone_entry_desc
*rxdesc
);
221 * rt2x00link_start_tuner - Start periodic link tuner work
222 * @rt2x00dev: Pointer to &struct rt2x00_dev.
224 * This start the link tuner periodic work, this work will
225 * be executed periodically until &rt2x00link_stop_tuner has
228 void rt2x00link_start_tuner(struct rt2x00_dev
*rt2x00dev
);
231 * rt2x00link_stop_tuner - Stop periodic link tuner work
232 * @rt2x00dev: Pointer to &struct rt2x00_dev.
234 * After this function completed the link tuner will not
235 * be running until &rt2x00link_start_tuner is called.
237 void rt2x00link_stop_tuner(struct rt2x00_dev
*rt2x00dev
);
240 * rt2x00link_reset_tuner - Reset periodic link tuner work
241 * @rt2x00dev: Pointer to &struct rt2x00_dev.
242 * @antenna: Should the antenna tuning also be reset
244 * The VGC limit configured in the hardware will be reset to 0
245 * which forces the driver to rediscover the correct value for
246 * the current association. This is needed when configuration
247 * options have changed which could drastically change the
248 * SNR level or link quality (i.e. changing the antenna setting).
250 * Resetting the link tuner will also cause the periodic work counter
251 * to be reset. Any driver which has a fixed limit on the number
252 * of rounds the link tuner is supposed to work will accept the
253 * tuner actions again if this limit was previously reached.
255 * If @antenna is set to true a the software antenna diversity
256 * tuning will also be reset.
258 void rt2x00link_reset_tuner(struct rt2x00_dev
*rt2x00dev
, bool antenna
);
261 * rt2x00link_start_watchdog - Start periodic watchdog monitoring
262 * @rt2x00dev: Pointer to &struct rt2x00_dev.
264 * This start the watchdog periodic work, this work will
265 *be executed periodically until &rt2x00link_stop_watchdog has
268 void rt2x00link_start_watchdog(struct rt2x00_dev
*rt2x00dev
);
271 * rt2x00link_stop_watchdog - Stop periodic watchdog monitoring
272 * @rt2x00dev: Pointer to &struct rt2x00_dev.
274 * After this function completed the watchdog monitoring will not
275 * be running until &rt2x00link_start_watchdog is called.
277 void rt2x00link_stop_watchdog(struct rt2x00_dev
*rt2x00dev
);
280 * rt2x00link_register - Initialize link tuning & watchdog functionality
281 * @rt2x00dev: Pointer to &struct rt2x00_dev.
283 * Initialize work structure and all link tuning and watchdog related
284 * parameters. This will not start the periodic work itself.
286 void rt2x00link_register(struct rt2x00_dev
*rt2x00dev
);
291 #ifdef CONFIG_RT2X00_LIB_FIRMWARE
292 int rt2x00lib_load_firmware(struct rt2x00_dev
*rt2x00dev
);
293 void rt2x00lib_free_firmware(struct rt2x00_dev
*rt2x00dev
);
295 static inline int rt2x00lib_load_firmware(struct rt2x00_dev
*rt2x00dev
)
299 static inline void rt2x00lib_free_firmware(struct rt2x00_dev
*rt2x00dev
)
302 #endif /* CONFIG_RT2X00_LIB_FIRMWARE */
307 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
308 void rt2x00debug_register(struct rt2x00_dev
*rt2x00dev
);
309 void rt2x00debug_deregister(struct rt2x00_dev
*rt2x00dev
);
310 void rt2x00debug_update_crypto(struct rt2x00_dev
*rt2x00dev
,
311 struct rxdone_entry_desc
*rxdesc
);
313 static inline void rt2x00debug_register(struct rt2x00_dev
*rt2x00dev
)
317 static inline void rt2x00debug_deregister(struct rt2x00_dev
*rt2x00dev
)
321 static inline void rt2x00debug_update_crypto(struct rt2x00_dev
*rt2x00dev
,
322 struct rxdone_entry_desc
*rxdesc
)
325 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
330 #ifdef CONFIG_RT2X00_LIB_CRYPTO
331 enum cipher
rt2x00crypto_key_to_cipher(struct ieee80211_key_conf
*key
);
332 void rt2x00crypto_create_tx_descriptor(struct queue_entry
*entry
,
333 struct txentry_desc
*txdesc
);
334 unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev
*rt2x00dev
,
335 struct sk_buff
*skb
);
336 void rt2x00crypto_tx_copy_iv(struct sk_buff
*skb
,
337 struct txentry_desc
*txdesc
);
338 void rt2x00crypto_tx_remove_iv(struct sk_buff
*skb
,
339 struct txentry_desc
*txdesc
);
340 void rt2x00crypto_tx_insert_iv(struct sk_buff
*skb
, unsigned int header_length
);
341 void rt2x00crypto_rx_insert_iv(struct sk_buff
*skb
,
342 unsigned int header_length
,
343 struct rxdone_entry_desc
*rxdesc
);
345 static inline enum cipher
rt2x00crypto_key_to_cipher(struct ieee80211_key_conf
*key
)
350 static inline void rt2x00crypto_create_tx_descriptor(struct queue_entry
*entry
,
351 struct txentry_desc
*txdesc
)
355 static inline unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev
*rt2x00dev
,
361 static inline void rt2x00crypto_tx_copy_iv(struct sk_buff
*skb
,
362 struct txentry_desc
*txdesc
)
366 static inline void rt2x00crypto_tx_remove_iv(struct sk_buff
*skb
,
367 struct txentry_desc
*txdesc
)
371 static inline void rt2x00crypto_tx_insert_iv(struct sk_buff
*skb
,
372 unsigned int header_length
)
376 static inline void rt2x00crypto_rx_insert_iv(struct sk_buff
*skb
,
377 unsigned int header_length
,
378 struct rxdone_entry_desc
*rxdesc
)
381 #endif /* CONFIG_RT2X00_LIB_CRYPTO */
386 #ifdef CONFIG_RT2X00_LIB_HT
387 void rt2x00ht_create_tx_descriptor(struct queue_entry
*entry
,
388 struct txentry_desc
*txdesc
,
389 const struct rt2x00_rate
*hwrate
);
391 u16
rt2x00ht_center_channel(struct rt2x00_dev
*rt2x00dev
,
392 struct ieee80211_conf
*conf
);
394 static inline void rt2x00ht_create_tx_descriptor(struct queue_entry
*entry
,
395 struct txentry_desc
*txdesc
,
396 const struct rt2x00_rate
*hwrate
)
400 static inline u16
rt2x00ht_center_channel(struct rt2x00_dev
*rt2x00dev
,
401 struct ieee80211_conf
*conf
)
403 return conf
->channel
->hw_value
;
405 #endif /* CONFIG_RT2X00_LIB_HT */
410 static inline void rt2x00rfkill_register(struct rt2x00_dev
*rt2x00dev
)
412 if (test_bit(CONFIG_SUPPORT_HW_BUTTON
, &rt2x00dev
->flags
))
413 wiphy_rfkill_start_polling(rt2x00dev
->hw
->wiphy
);
416 static inline void rt2x00rfkill_unregister(struct rt2x00_dev
*rt2x00dev
)
418 if (test_bit(CONFIG_SUPPORT_HW_BUTTON
, &rt2x00dev
->flags
))
419 wiphy_rfkill_stop_polling(rt2x00dev
->hw
->wiphy
);
425 #ifdef CONFIG_RT2X00_LIB_LEDS
426 void rt2x00leds_led_quality(struct rt2x00_dev
*rt2x00dev
, int rssi
);
427 void rt2x00led_led_activity(struct rt2x00_dev
*rt2x00dev
, bool enabled
);
428 void rt2x00leds_led_assoc(struct rt2x00_dev
*rt2x00dev
, bool enabled
);
429 void rt2x00leds_led_radio(struct rt2x00_dev
*rt2x00dev
, bool enabled
);
430 void rt2x00leds_register(struct rt2x00_dev
*rt2x00dev
);
431 void rt2x00leds_unregister(struct rt2x00_dev
*rt2x00dev
);
432 void rt2x00leds_suspend(struct rt2x00_dev
*rt2x00dev
);
433 void rt2x00leds_resume(struct rt2x00_dev
*rt2x00dev
);
435 static inline void rt2x00leds_led_quality(struct rt2x00_dev
*rt2x00dev
,
440 static inline void rt2x00led_led_activity(struct rt2x00_dev
*rt2x00dev
,
445 static inline void rt2x00leds_led_assoc(struct rt2x00_dev
*rt2x00dev
,
450 static inline void rt2x00leds_led_radio(struct rt2x00_dev
*rt2x00dev
,
455 static inline void rt2x00leds_register(struct rt2x00_dev
*rt2x00dev
)
459 static inline void rt2x00leds_unregister(struct rt2x00_dev
*rt2x00dev
)
463 static inline void rt2x00leds_suspend(struct rt2x00_dev
*rt2x00dev
)
467 static inline void rt2x00leds_resume(struct rt2x00_dev
*rt2x00dev
)
470 #endif /* CONFIG_RT2X00_LIB_LEDS */
472 #endif /* RT2X00LIB_H */