rt2x00lib.h revision 98a1708de1bfa5fe1c490febba850d6043d3c7fa
1/* 2 Copyright (C) 2004 - 2009 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 ( 1000 ) 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 const u8 *mac, const 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 * @enable_beacon: Enable beaconing 127 */ 128int rt2x00queue_update_beacon(struct rt2x00_dev *rt2x00dev, 129 struct ieee80211_vif *vif, 130 const bool enable_beacon); 131 132/** 133 * rt2x00queue_index_inc - Index incrementation function 134 * @queue: Queue (&struct data_queue) to perform the action on. 135 * @index: Index type (&enum queue_index) to perform the action on. 136 * 137 * This function will increase the requested index on the queue, 138 * it will grab the appropriate locks and handle queue overflow events by 139 * resetting the index to the start of the queue. 140 */ 141void rt2x00queue_index_inc(struct data_queue *queue, enum queue_index index); 142 143/** 144 * rt2x00queue_stop_queues - Halt all data queues 145 * @rt2x00dev: Pointer to &struct rt2x00_dev. 146 * 147 * This function will loop through all available queues to stop 148 * any pending outgoing frames. 149 */ 150void rt2x00queue_stop_queues(struct rt2x00_dev *rt2x00dev); 151 152/** 153 * rt2x00queue_init_queues - Initialize all data queues 154 * @rt2x00dev: Pointer to &struct rt2x00_dev. 155 * 156 * This function will loop through all available queues to clear all 157 * index numbers and set the queue entry to the correct initialization 158 * state. 159 */ 160void rt2x00queue_init_queues(struct rt2x00_dev *rt2x00dev); 161 162int rt2x00queue_initialize(struct rt2x00_dev *rt2x00dev); 163void rt2x00queue_uninitialize(struct rt2x00_dev *rt2x00dev); 164int rt2x00queue_allocate(struct rt2x00_dev *rt2x00dev); 165void rt2x00queue_free(struct rt2x00_dev *rt2x00dev); 166 167/** 168 * rt2x00link_update_stats - Update link statistics from RX frame 169 * @rt2x00dev: Pointer to &struct rt2x00_dev. 170 * @skb: Received frame 171 * @rxdesc: Received frame descriptor 172 * 173 * Update link statistics based on the information from the 174 * received frame descriptor. 175 */ 176void rt2x00link_update_stats(struct rt2x00_dev *rt2x00dev, 177 struct sk_buff *skb, 178 struct rxdone_entry_desc *rxdesc); 179 180/** 181 * rt2x00link_calculate_signal - Calculate signal quality 182 * @rt2x00dev: Pointer to &struct rt2x00_dev. 183 * @rssi: RX Frame RSSI 184 * 185 * Calculate the signal quality of a frame based on the rssi 186 * measured during the receiving of the frame and the global 187 * link quality statistics measured since the start of the 188 * link tuning. The result is a value between 0 and 100 which 189 * is an indication of the signal quality. 190 */ 191int rt2x00link_calculate_signal(struct rt2x00_dev *rt2x00dev, int rssi); 192 193/** 194 * rt2x00link_start_tuner - Start periodic link tuner work 195 * @rt2x00dev: Pointer to &struct rt2x00_dev. 196 * 197 * This start the link tuner periodic work, this work will 198 * be executed periodically until &rt2x00link_stop_tuner has 199 * been called. 200 */ 201void rt2x00link_start_tuner(struct rt2x00_dev *rt2x00dev); 202 203/** 204 * rt2x00link_stop_tuner - Stop periodic link tuner work 205 * @rt2x00dev: Pointer to &struct rt2x00_dev. 206 * 207 * After this function completed the link tuner will not 208 * be running until &rt2x00link_start_tuner is called. 209 */ 210void rt2x00link_stop_tuner(struct rt2x00_dev *rt2x00dev); 211 212/** 213 * rt2x00link_reset_tuner - Reset periodic link tuner work 214 * @rt2x00dev: Pointer to &struct rt2x00_dev. 215 * @antenna: Should the antenna tuning also be reset 216 * 217 * The VGC limit configured in the hardware will be reset to 0 218 * which forces the driver to rediscover the correct value for 219 * the current association. This is needed when configuration 220 * options have changed which could drastically change the 221 * SNR level or link quality (i.e. changing the antenna setting). 222 * 223 * Resetting the link tuner will also cause the periodic work counter 224 * to be reset. Any driver which has a fixed limit on the number 225 * of rounds the link tuner is supposed to work will accept the 226 * tuner actions again if this limit was previously reached. 227 * 228 * If @antenna is set to true a the software antenna diversity 229 * tuning will also be reset. 230 */ 231void rt2x00link_reset_tuner(struct rt2x00_dev *rt2x00dev, bool antenna); 232 233/** 234 * rt2x00link_register - Initialize link tuning functionality 235 * @rt2x00dev: Pointer to &struct rt2x00_dev. 236 * 237 * Initialize work structure and all link tuning related 238 * parameters. This will not start the link tuning process itself. 239 */ 240void rt2x00link_register(struct rt2x00_dev *rt2x00dev); 241 242/* 243 * Firmware handlers. 244 */ 245#ifdef CONFIG_RT2X00_LIB_FIRMWARE 246int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev); 247void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev); 248#else 249static inline int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev) 250{ 251 return 0; 252} 253static inline void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev) 254{ 255} 256#endif /* CONFIG_RT2X00_LIB_FIRMWARE */ 257 258/* 259 * Debugfs handlers. 260 */ 261#ifdef CONFIG_RT2X00_LIB_DEBUGFS 262void rt2x00debug_register(struct rt2x00_dev *rt2x00dev); 263void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev); 264void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev, 265 enum rt2x00_dump_type type, struct sk_buff *skb); 266void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev, 267 struct rxdone_entry_desc *rxdesc); 268#else 269static inline void rt2x00debug_register(struct rt2x00_dev *rt2x00dev) 270{ 271} 272 273static inline void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev) 274{ 275} 276 277static inline void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev, 278 enum rt2x00_dump_type type, 279 struct sk_buff *skb) 280{ 281} 282 283static inline void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev, 284 struct rxdone_entry_desc *rxdesc) 285{ 286} 287#endif /* CONFIG_RT2X00_LIB_DEBUGFS */ 288 289/* 290 * Crypto handlers. 291 */ 292#ifdef CONFIG_RT2X00_LIB_CRYPTO 293enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key); 294void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry, 295 struct txentry_desc *txdesc); 296unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev, 297 struct sk_buff *skb); 298void rt2x00crypto_tx_copy_iv(struct sk_buff *skb, unsigned int iv_len); 299void rt2x00crypto_tx_remove_iv(struct sk_buff *skb, unsigned int iv_len); 300void rt2x00crypto_tx_insert_iv(struct sk_buff *skb); 301void rt2x00crypto_rx_insert_iv(struct sk_buff *skb, unsigned int align, 302 unsigned int header_length, 303 struct rxdone_entry_desc *rxdesc); 304#else 305static inline enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key) 306{ 307 return CIPHER_NONE; 308} 309 310static inline void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry, 311 struct txentry_desc *txdesc) 312{ 313} 314 315static inline unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev, 316 struct sk_buff *skb) 317{ 318 return 0; 319} 320 321static inline void rt2x00crypto_tx_copy_iv(struct sk_buff *skb, 322 unsigned int iv_len) 323{ 324} 325 326static inline void rt2x00crypto_tx_remove_iv(struct sk_buff *skb, 327 unsigned int iv_len) 328{ 329} 330 331static inline void rt2x00crypto_tx_insert_iv(struct sk_buff *skb) 332{ 333} 334 335static inline void rt2x00crypto_rx_insert_iv(struct sk_buff *skb, 336 unsigned int align, 337 unsigned int header_length, 338 struct rxdone_entry_desc *rxdesc) 339{ 340} 341#endif /* CONFIG_RT2X00_LIB_CRYPTO */ 342 343/* 344 * RFkill handlers. 345 */ 346#ifdef CONFIG_RT2X00_LIB_RFKILL 347void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev); 348void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev); 349void rt2x00rfkill_allocate(struct rt2x00_dev *rt2x00dev); 350void rt2x00rfkill_free(struct rt2x00_dev *rt2x00dev); 351#else 352static inline void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev) 353{ 354} 355 356static inline void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev) 357{ 358} 359 360static inline void rt2x00rfkill_allocate(struct rt2x00_dev *rt2x00dev) 361{ 362} 363 364static inline void rt2x00rfkill_free(struct rt2x00_dev *rt2x00dev) 365{ 366} 367#endif /* CONFIG_RT2X00_LIB_RFKILL */ 368 369/* 370 * LED handlers 371 */ 372#ifdef CONFIG_RT2X00_LIB_LEDS 373void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev, int rssi); 374void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev, bool enabled); 375void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev, bool enabled); 376void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev, bool enabled); 377void rt2x00leds_register(struct rt2x00_dev *rt2x00dev); 378void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev); 379void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev); 380void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev); 381#else 382static inline void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev, 383 int rssi) 384{ 385} 386 387static inline void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev, 388 bool enabled) 389{ 390} 391 392static inline void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev, 393 bool enabled) 394{ 395} 396 397static inline void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev, 398 bool enabled) 399{ 400} 401 402static inline void rt2x00leds_register(struct rt2x00_dev *rt2x00dev) 403{ 404} 405 406static inline void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev) 407{ 408} 409 410static inline void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev) 411{ 412} 413 414static inline void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev) 415{ 416} 417#endif /* CONFIG_RT2X00_LIB_LEDS */ 418 419#endif /* RT2X00LIB_H */ 420