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