drivers/net/wireless/rt2x00/rt2x00lib.h

   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  */
  41 struct 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
  53 extern const struct rt2x00_rate rt2x00_supported_rates[12];
  54
  55 static 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  */
  63 int rt2x00lib_enable_radio(struct rt2x00_dev *rt2x00dev);
  64 void rt2x00lib_disable_radio(struct rt2x00_dev *rt2x00dev);
  65 void rt2x00lib_toggle_rx(struct rt2x00_dev *rt2x00dev, enum dev_state state);
  66
  67 /*
  68  * Initialization handlers.
  69  */
  70 int rt2x00lib_start(struct rt2x00_dev *rt2x00dev);
  71 void rt2x00lib_stop(struct rt2x00_dev *rt2x00dev);
  72
  73 /*
  74  * Configuration handlers.
  75  */
  76 void rt2x00lib_config_intf(struct rt2x00_dev *rt2x00dev,
  77                            struct rt2x00_intf *intf,
  78                            enum nl80211_iftype type,
  79                            u8 *mac, u8 *bssid);
  80 void rt2x00lib_config_erp(struct rt2x00_dev *rt2x00dev,
  81                           struct rt2x00_intf *intf,
  82                           struct ieee80211_bss_conf *conf);
  83 void rt2x00lib_config_antenna(struct rt2x00_dev *rt2x00dev,
  84                               struct antenna_setup *ant);
  85 void 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  */
  98 struct 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  */
 106 void 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  */
 113 void 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  */
 120 int 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  */
 127 int 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  */
 139 void 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  */
 149 void rt2x00queue_init_queues(struct rt2x00_dev *rt2x00dev);
 150
 151 int rt2x00queue_initialize(struct rt2x00_dev *rt2x00dev);
 152 void rt2x00queue_uninitialize(struct rt2x00_dev *rt2x00dev);
 153 int rt2x00queue_allocate(struct rt2x00_dev *rt2x00dev);
 154 void 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  */
 165 void 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  */
 180 int 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  */
 190 void 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  */
 199 void 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  */
 220 void 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  */
 229 void rt2x00link_register(struct rt2x00_dev *rt2x00dev);
 230
 231 /*
 232  * Firmware handlers.
 233  */
 234 #ifdef CONFIG_RT2X00_LIB_FIRMWARE
 235 int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev);
 236 void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev);
 237 #else
 238 static inline int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev)
 239 {
 240         return 0;
 241 }
 242 static 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
 251 void rt2x00debug_register(struct rt2x00_dev *rt2x00dev);
 252 void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev);
 253 void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
 254                             enum rt2x00_dump_type type, struct sk_buff *skb);
 255 void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
 256                                struct rxdone_entry_desc *rxdesc);
 257 #else
 258 static inline void rt2x00debug_register(struct rt2x00_dev *rt2x00dev)
 259 {
 260 }
 261
 262 static inline void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev)
 263 {
 264 }
 265
 266 static inline void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
 267                                           enum rt2x00_dump_type type,
 268                                           struct sk_buff *skb)
 269 {
 270 }
 271
 272 static 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
 282 enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key);
 283 void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry,
 284                                        struct txentry_desc *txdesc);
 285 unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev,
 286                                       struct sk_buff *skb);
 287 void rt2x00crypto_tx_copy_iv(struct sk_buff *skb, unsigned int iv_len);
 288 void rt2x00crypto_tx_remove_iv(struct sk_buff *skb, unsigned int iv_len);
 289 void rt2x00crypto_tx_insert_iv(struct sk_buff *skb);
 290 void rt2x00crypto_rx_insert_iv(struct sk_buff *skb, unsigned int align,
 291                                unsigned int header_length,
 292                                struct rxdone_entry_desc *rxdesc);
 293 #else
 294 static inline enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key)
 295 {
 296         return CIPHER_NONE;
 297 }
 298
 299 static inline void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry,
 300                                                      struct txentry_desc *txdesc)
 301 {
 302 }
 303
 304 static inline unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev,
 305                                                     struct sk_buff *skb)
 306 {
 307         return 0;
 308 }
 309
 310 static inline void rt2x00crypto_tx_copy_iv(struct sk_buff *skb,
 311                                            unsigned int iv_len)
 312 {
 313 }
 314
 315 static inline void rt2x00crypto_tx_remove_iv(struct sk_buff *skb,
 316                                              unsigned int iv_len)
 317 {
 318 }
 319
 320 static inline void rt2x00crypto_tx_insert_iv(struct sk_buff *skb)
 321 {
 322 }
 323
 324 static inline void rt2x00crypto_rx_insert_iv(struct sk_buff *skb,
 325                                              unsigned int align,
 326                                              unsigned int header_length,
 327                                              struct rxdone_entry_desc *rxdesc)
 328 {
 329 }
 330 #endif /* CONFIG_RT2X00_LIB_CRYPTO */
 331
 332 /*
 333  * RFkill handlers.
 334  */
 335 #ifdef CONFIG_RT2X00_LIB_RFKILL
 336 void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev);
 337 void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev);
 338 void rt2x00rfkill_allocate(struct rt2x00_dev *rt2x00dev);
 339 void rt2x00rfkill_free(struct rt2x00_dev *rt2x00dev);
 340 #else
 341 static inline void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev)
 342 {
 343 }
 344
 345 static inline void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev)
 346 {
 347 }
 348
 349 static inline void rt2x00rfkill_allocate(struct rt2x00_dev *rt2x00dev)
 350 {
 351 }
 352
 353 static inline void rt2x00rfkill_free(struct rt2x00_dev *rt2x00dev)
 354 {
 355 }
 356 #endif /* CONFIG_RT2X00_LIB_RFKILL */
 357
 358 /*
 359  * LED handlers
 360  */
 361 #ifdef CONFIG_RT2X00_LIB_LEDS
 362 void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev, int rssi);
 363 void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev, bool enabled);
 364 void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev, bool enabled);
 365 void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev, bool enabled);
 366 void rt2x00leds_register(struct rt2x00_dev *rt2x00dev);
 367 void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev);
 368 void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev);
 369 void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev);
 370 #else
 371 static inline void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev,
 372                                           int rssi)
 373 {
 374 }
 375
 376 static inline void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev,
 377                                           bool enabled)
 378 {
 379 }
 380
 381 static inline void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev,
 382                                         bool enabled)
 383 {
 384 }
 385
 386 static inline void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev,
 387                                         bool enabled)
 388 {
 389 }
 390
 391 static inline void rt2x00leds_register(struct rt2x00_dev *rt2x00dev)
 392 {
 393 }
 394
 395 static inline void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev)
 396 {
 397 }
 398
 399 static inline void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev)
 400 {
 401 }
 402
 403 static inline void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev)
 404 {
 405 }
 406 #endif /* CONFIG_RT2X00_LIB_LEDS */
 407
 408 #endif /* RT2X00LIB_H */