rt2x00lib.h revision 84e3196ff867c623056eea02c11a45e046490d89
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 */ 41struct 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 47 unsigned short bitrate; /* In 100kbit/s */ 48 unsigned short ratemask; 49 50 unsigned short plcp; 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/* 61 * Radio control handlers. 62 */ 63int rt2x00lib_enable_radio(struct rt2x00_dev *rt2x00dev); 64void rt2x00lib_disable_radio(struct rt2x00_dev *rt2x00dev); 65void rt2x00lib_toggle_rx(struct rt2x00_dev *rt2x00dev, enum dev_state state); 66 67/* 68 * Initialization handlers. 69 */ 70int rt2x00lib_start(struct rt2x00_dev *rt2x00dev); 71void rt2x00lib_stop(struct rt2x00_dev *rt2x00dev); 72 73/* 74 * Configuration handlers. 75 */ 76void rt2x00lib_config_intf(struct rt2x00_dev *rt2x00dev, 77 struct rt2x00_intf *intf, 78 enum nl80211_iftype type, 79 u8 *mac, u8 *bssid); 80void rt2x00lib_config_erp(struct rt2x00_dev *rt2x00dev, 81 struct rt2x00_intf *intf, 82 struct ieee80211_bss_conf *conf); 83void rt2x00lib_config_antenna(struct rt2x00_dev *rt2x00dev, 84 struct antenna_setup *ant); 85void rt2x00lib_config(struct rt2x00_dev *rt2x00dev, 86 struct ieee80211_conf *conf, 87 const unsigned int changed_flags); 88 89/** 90 * DOC: Queue handlers 91 */ 92 93/** 94 * rt2x00queue_alloc_rxskb - allocate a skb for RX purposes. 95 * @rt2x00dev: Pointer to &struct rt2x00_dev. 96 * @queue: The queue for which the skb will be applicable. 97 */ 98struct sk_buff *rt2x00queue_alloc_rxskb(struct rt2x00_dev *rt2x00dev, 99 struct queue_entry *entry); 100 101/** 102 * rt2x00queue_unmap_skb - Unmap a skb from DMA. 103 * @rt2x00dev: Pointer to &struct rt2x00_dev. 104 * @skb: The skb to unmap. 105 */ 106void rt2x00queue_unmap_skb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb); 107 108/** 109 * rt2x00queue_free_skb - free a skb 110 * @rt2x00dev: Pointer to &struct rt2x00_dev. 111 * @skb: The skb to free. 112 */ 113void rt2x00queue_free_skb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb); 114 115/** 116 * rt2x00queue_write_tx_frame - Write TX frame to hardware 117 * @queue: Queue over which the frame should be send 118 * @skb: The skb to send 119 */ 120int rt2x00queue_write_tx_frame(struct data_queue *queue, struct sk_buff *skb); 121 122/** 123 * rt2x00queue_update_beacon - Send new beacon from mac80211 to hardware 124 * @rt2x00dev: Pointer to &struct rt2x00_dev. 125 * @vif: Interface for which the beacon should be updated. 126 */ 127int rt2x00queue_update_beacon(struct rt2x00_dev *rt2x00dev, 128 struct ieee80211_vif *vif); 129 130/** 131 * rt2x00queue_index_inc - Index incrementation function 132 * @queue: Queue (&struct data_queue) to perform the action on. 133 * @index: Index type (&enum queue_index) to perform the action on. 134 * 135 * This function will increase the requested index on the queue, 136 * it will grab the appropriate locks and handle queue overflow events by 137 * resetting the index to the start of the queue. 138 */ 139void rt2x00queue_index_inc(struct data_queue *queue, enum queue_index index); 140 141/** 142 * rt2x00queue_init_queues - Initialize all data queues 143 * @rt2x00dev: Pointer to &struct rt2x00_dev. 144 * 145 * This function will loop through all available queues to clear all 146 * index numbers and set the queue entry to the correct initialization 147 * state. 148 */ 149void rt2x00queue_init_queues(struct rt2x00_dev *rt2x00dev); 150 151int rt2x00queue_initialize(struct rt2x00_dev *rt2x00dev); 152void rt2x00queue_uninitialize(struct rt2x00_dev *rt2x00dev); 153int rt2x00queue_allocate(struct rt2x00_dev *rt2x00dev); 154void rt2x00queue_free(struct rt2x00_dev *rt2x00dev); 155 156/** 157 * rt2x00link_update_stats - Update link statistics from RX frame 158 * @rt2x00dev: Pointer to &struct rt2x00_dev. 159 * @skb: Received frame 160 * @rxdesc: Received frame descriptor 161 * 162 * Update link statistics based on the information from the 163 * received frame descriptor. 164 */ 165void rt2x00link_update_stats(struct rt2x00_dev *rt2x00dev, 166 struct sk_buff *skb, 167 struct rxdone_entry_desc *rxdesc); 168 169/** 170 * rt2x00link_calculate_signal - Calculate signal quality 171 * @rt2x00dev: Pointer to &struct rt2x00_dev. 172 * @rssi: RX Frame RSSI 173 * 174 * Calculate the signal quality of a frame based on the rssi 175 * measured during the receiving of the frame and the global 176 * link quality statistics measured since the start of the 177 * link tuning. The result is a value between 0 and 100 which 178 * is an indication of the signal quality. 179 */ 180int rt2x00link_calculate_signal(struct rt2x00_dev *rt2x00dev, int rssi); 181 182/** 183 * rt2x00link_start_tuner - Start periodic link tuner work 184 * @rt2x00dev: Pointer to &struct rt2x00_dev. 185 * 186 * This start the link tuner periodic work, this work will 187 * be executed periodically until &rt2x00link_stop_tuner has 188 * been called. 189 */ 190void rt2x00link_start_tuner(struct rt2x00_dev *rt2x00dev); 191 192/** 193 * rt2x00link_stop_tuner - Stop periodic link tuner work 194 * @rt2x00dev: Pointer to &struct rt2x00_dev. 195 * 196 * After this function completed the link tuner will not 197 * be running until &rt2x00link_start_tuner is called. 198 */ 199void rt2x00link_stop_tuner(struct rt2x00_dev *rt2x00dev); 200 201/** 202 * rt2x00link_reset_tuner - Reset periodic link tuner work 203 * @rt2x00dev: Pointer to &struct rt2x00_dev. 204 * @antenna: Should the antenna tuning also be reset 205 * 206 * The VGC limit configured in the hardware will be reset to 0 207 * which forces the driver to rediscover the correct value for 208 * the current association. This is needed when configuration 209 * options have changed which could drastically change the 210 * SNR level or link quality (i.e. changing the antenna setting). 211 * 212 * Resetting the link tuner will also cause the periodic work counter 213 * to be reset. Any driver which has a fixed limit on the number 214 * of rounds the link tuner is supposed to work will accept the 215 * tuner actions again if this limit was previously reached. 216 * 217 * If @antenna is set to true a the software antenna diversity 218 * tuning will also be reset. 219 */ 220void rt2x00link_reset_tuner(struct rt2x00_dev *rt2x00dev, bool antenna); 221 222/** 223 * rt2x00link_register - Initialize link tuning functionality 224 * @rt2x00dev: Pointer to &struct rt2x00_dev. 225 * 226 * Initialize work structure and all link tuning related 227 * paramters. This will not start the link tuning process itself. 228 */ 229void rt2x00link_register(struct rt2x00_dev *rt2x00dev); 230 231/* 232 * Firmware handlers. 233 */ 234#ifdef CONFIG_RT2X00_LIB_FIRMWARE 235int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev); 236void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev); 237#else 238static inline int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev) 239{ 240 return 0; 241} 242static inline void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev) 243{ 244} 245#endif /* CONFIG_RT2X00_LIB_FIRMWARE */ 246 247/* 248 * Debugfs handlers. 249 */ 250#ifdef CONFIG_RT2X00_LIB_DEBUGFS 251void rt2x00debug_register(struct rt2x00_dev *rt2x00dev); 252void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev); 253void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev, 254 enum rt2x00_dump_type type, struct sk_buff *skb); 255void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev, 256 struct rxdone_entry_desc *rxdesc); 257#else 258static inline void rt2x00debug_register(struct rt2x00_dev *rt2x00dev) 259{ 260} 261 262static inline void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev) 263{ 264} 265 266static inline void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev, 267 enum rt2x00_dump_type type, 268 struct sk_buff *skb) 269{ 270} 271 272static inline void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev, 273 struct rxdone_entry_desc *rxdesc) 274{ 275} 276#endif /* CONFIG_RT2X00_LIB_DEBUGFS */ 277 278/* 279 * Crypto handlers. 280 */ 281#ifdef CONFIG_RT2X00_LIB_CRYPTO 282enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key); 283void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry, 284 struct txentry_desc *txdesc); 285unsigned int rt2x00crypto_tx_overhead(struct ieee80211_tx_info *tx_info); 286void rt2x00crypto_tx_copy_iv(struct sk_buff *skb, unsigned int iv_len); 287void rt2x00crypto_tx_remove_iv(struct sk_buff *skb, unsigned int iv_len); 288void rt2x00crypto_tx_insert_iv(struct sk_buff *skb); 289void rt2x00crypto_rx_insert_iv(struct sk_buff *skb, unsigned int align, 290 unsigned int header_length, 291 struct rxdone_entry_desc *rxdesc); 292#else 293static inline enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key) 294{ 295 return CIPHER_NONE; 296} 297 298static inline void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry, 299 struct txentry_desc *txdesc) 300{ 301} 302 303static inline unsigned int rt2x00crypto_tx_overhead(struct ieee80211_tx_info *tx_info) 304{ 305 return 0; 306} 307 308static inline void rt2x00crypto_tx_copy_iv(struct sk_buff *skb, 309 unsigned int iv_len) 310{ 311} 312 313static inline void rt2x00crypto_tx_remove_iv(struct sk_buff *skb, 314 unsigned int iv_len) 315{ 316} 317 318static inline void rt2x00crypto_tx_insert_iv(struct sk_buff *skb) 319{ 320} 321 322static inline void rt2x00crypto_rx_insert_iv(struct sk_buff *skb, 323 unsigned int align, 324 unsigned int header_length, 325 struct rxdone_entry_desc *rxdesc) 326{ 327} 328#endif /* CONFIG_RT2X00_LIB_CRYPTO */ 329 330/* 331 * RFkill handlers. 332 */ 333#ifdef CONFIG_RT2X00_LIB_RFKILL 334void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev); 335void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev); 336void rt2x00rfkill_allocate(struct rt2x00_dev *rt2x00dev); 337void rt2x00rfkill_free(struct rt2x00_dev *rt2x00dev); 338#else 339static inline void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev) 340{ 341} 342 343static inline void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev) 344{ 345} 346 347static inline void rt2x00rfkill_allocate(struct rt2x00_dev *rt2x00dev) 348{ 349} 350 351static inline void rt2x00rfkill_free(struct rt2x00_dev *rt2x00dev) 352{ 353} 354#endif /* CONFIG_RT2X00_LIB_RFKILL */ 355 356/* 357 * LED handlers 358 */ 359#ifdef CONFIG_RT2X00_LIB_LEDS 360void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev, int rssi); 361void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev, bool enabled); 362void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev, bool enabled); 363void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev, bool enabled); 364void rt2x00leds_register(struct rt2x00_dev *rt2x00dev); 365void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev); 366void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev); 367void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev); 368#else 369static inline void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev, 370 int rssi) 371{ 372} 373 374static inline void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev, 375 bool enabled) 376{ 377} 378 379static inline void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev, 380 bool enabled) 381{ 382} 383 384static inline void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev, 385 bool enabled) 386{ 387} 388 389static inline void rt2x00leds_register(struct rt2x00_dev *rt2x00dev) 390{ 391} 392 393static inline void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev) 394{ 395} 396 397static inline void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev) 398{ 399} 400 401static inline void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev) 402{ 403} 404#endif /* CONFIG_RT2X00_LIB_LEDS */ 405 406#endif /* RT2X00LIB_H */ 407