drivers/net/wireless/rt2x00/rt2x00lib.h

   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  */
  34 #define LINK_TUNE_INTERVAL      round_jiffies_relative(HZ)
  35
  36 /*
  37  * rt2x00_rate: Per rate device information
  38  */
  39 struct rt2x00_rate {
  40         unsigned short flags;
  41 #define DEV_RATE_CCK                    0x0001
  42 #define DEV_RATE_OFDM                   0x0002
  43 #define DEV_RATE_SHORT_PREAMBLE         0x0004
  44
  45         unsigned short bitrate; /* In 100kbit/s */
  46         unsigned short ratemask;
  47
  48         unsigned short plcp;
  49         unsigned short mcs;
  50 };
  51
  52 extern const struct rt2x00_rate rt2x00_supported_rates[12];
  53
  54 static inline const struct rt2x00_rate *rt2x00_get_rate(const u16 hw_value)
  55 {
  56         return &rt2x00_supported_rates[hw_value & 0xff];
  57 }
  58
  59 #define RATE_MCS(__mode, __mcs) \
  60         ( (((__mode) & 0x00ff) << 8) | ((__mcs) & 0x00ff) )
  61
  62 static inline int rt2x00_get_rate_mcs(const u16 mcs_value)
  63 {
  64         return (mcs_value & 0x00ff);
  65 }
  66
  67 /*
  68  * Radio control handlers.
  69  */
  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);
  73
  74 /*
  75  * Initialization handlers.
  76  */
  77 int rt2x00lib_start(struct rt2x00_dev *rt2x00dev);
  78 void rt2x00lib_stop(struct rt2x00_dev *rt2x00dev);
  79
  80 /*
  81  * Configuration handlers.
  82  */
  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);
  95
  96 /**
  97  * DOC: Queue handlers
  98  */
  99
 100 /**
 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.
 104  */
 105 struct sk_buff *rt2x00queue_alloc_rxskb(struct rt2x00_dev *rt2x00dev,
 106                                         struct queue_entry *entry);
 107
 108 /**
 109  * rt2x00queue_unmap_skb - Unmap a skb from DMA.
 110  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 111  * @skb: The skb to unmap.
 112  */
 113 void rt2x00queue_unmap_skb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb);
 114
 115 /**
 116  * rt2x00queue_free_skb - free a skb
 117  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 118  * @skb: The skb to free.
 119  */
 120 void rt2x00queue_free_skb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb);
 121
 122 /**
 123  * rt2x00queue_align_frame - Align 802.11 frame to 4-byte boundary
 124  * @skb: The skb to align
 125  *
 126  * Align the start of the 802.11 frame to a 4-byte boundary, this could
 127  * mean the payload is not aligned properly though.
 128  */
 129 void rt2x00queue_align_frame(struct sk_buff *skb);
 130
 131 /**
 132  * rt2x00queue_align_payload - Align 802.11 payload to 4-byte boundary
 133  * @skb: The skb to align
 134  * @header_length: Length of 802.11 header
 135  *
 136  * Align the 802.11 payload to a 4-byte boundary, this could
 137  * mean the header is not aligned properly though.
 138  */
 139 void rt2x00queue_align_payload(struct sk_buff *skb, unsigned int header_length);
 140
 141 /**
 142  * rt2x00queue_insert_l2pad - Align 802.11 header & payload to 4-byte boundary
 143  * @skb: The skb to align
 144  * @header_length: Length of 802.11 header
 145  *
 146  * Apply L2 padding to align both header and payload to 4-byte boundary
 147  */
 148 void rt2x00queue_insert_l2pad(struct sk_buff *skb, unsigned int header_length);
 149
 150 /**
 151  * rt2x00queue_insert_l2pad - Remove L2 padding from 802.11 frame
 152  * @skb: The skb to align
 153  * @header_length: Length of 802.11 header
 154  *
 155  * Remove L2 padding used to align both header and payload to 4-byte boundary,
 156  * by removing the L2 padding the header will no longer be 4-byte aligned.
 157  */
 158 void rt2x00queue_remove_l2pad(struct sk_buff *skb, unsigned int header_length);
 159
 160 /**
 161  * rt2x00queue_write_tx_frame - Write TX frame to hardware
 162  * @queue: Queue over which the frame should be send
 163  * @skb: The skb to send
 164  */
 165 int rt2x00queue_write_tx_frame(struct data_queue *queue, struct sk_buff *skb);
 166
 167 /**
 168  * rt2x00queue_update_beacon - Send new beacon from mac80211 to hardware
 169  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 170  * @vif: Interface for which the beacon should be updated.
 171  * @enable_beacon: Enable beaconing
 172  */
 173 int rt2x00queue_update_beacon(struct rt2x00_dev *rt2x00dev,
 174                               struct ieee80211_vif *vif,
 175                               const bool enable_beacon);
 176
 177 /**
 178  * rt2x00queue_index_inc - Index incrementation function
 179  * @queue: Queue (&struct data_queue) to perform the action on.
 180  * @index: Index type (&enum queue_index) to perform the action on.
 181  *
 182  * This function will increase the requested index on the queue,
 183  * it will grab the appropriate locks and handle queue overflow events by
 184  * resetting the index to the start of the queue.
 185  */
 186 void rt2x00queue_index_inc(struct data_queue *queue, enum queue_index index);
 187
 188 /**
 189  * rt2x00queue_stop_queues - Halt all data queues
 190  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 191  *
 192  * This function will loop through all available queues to stop
 193  * any pending outgoing frames.
 194  */
 195 void rt2x00queue_stop_queues(struct rt2x00_dev *rt2x00dev);
 196
 197 /**
 198  * rt2x00queue_init_queues - Initialize all data queues
 199  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 200  *
 201  * This function will loop through all available queues to clear all
 202  * index numbers and set the queue entry to the correct initialization
 203  * state.
 204  */
 205 void rt2x00queue_init_queues(struct rt2x00_dev *rt2x00dev);
 206
 207 int rt2x00queue_initialize(struct rt2x00_dev *rt2x00dev);
 208 void rt2x00queue_uninitialize(struct rt2x00_dev *rt2x00dev);
 209 int rt2x00queue_allocate(struct rt2x00_dev *rt2x00dev);
 210 void rt2x00queue_free(struct rt2x00_dev *rt2x00dev);
 211
 212 /**
 213  * rt2x00link_update_stats - Update link statistics from RX frame
 214  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 215  * @skb: Received frame
 216  * @rxdesc: Received frame descriptor
 217  *
 218  * Update link statistics based on the information from the
 219  * received frame descriptor.
 220  */
 221 void rt2x00link_update_stats(struct rt2x00_dev *rt2x00dev,
 222                              struct sk_buff *skb,
 223                              struct rxdone_entry_desc *rxdesc);
 224
 225 /**
 226  * rt2x00link_calculate_signal - Calculate signal quality
 227  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 228  * @rssi: RX Frame RSSI
 229  *
 230  * Calculate the signal quality of a frame based on the rssi
 231  * measured during the receiving of the frame and the global
 232  * link quality statistics measured since the start of the
 233  * link tuning. The result is a value between 0 and 100 which
 234  * is an indication of the signal quality.
 235  */
 236 int rt2x00link_calculate_signal(struct rt2x00_dev *rt2x00dev, int rssi);
 237
 238 /**
 239  * rt2x00link_start_tuner - Start periodic link tuner work
 240  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 241  *
 242  * This start the link tuner periodic work, this work will
 243  * be executed periodically until &rt2x00link_stop_tuner has
 244  * been called.
 245  */
 246 void rt2x00link_start_tuner(struct rt2x00_dev *rt2x00dev);
 247
 248 /**
 249  * rt2x00link_stop_tuner - Stop periodic link tuner work
 250  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 251  *
 252  * After this function completed the link tuner will not
 253  * be running until &rt2x00link_start_tuner is called.
 254  */
 255 void rt2x00link_stop_tuner(struct rt2x00_dev *rt2x00dev);
 256
 257 /**
 258  * rt2x00link_reset_tuner - Reset periodic link tuner work
 259  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 260  * @antenna: Should the antenna tuning also be reset
 261  *
 262  * The VGC limit configured in the hardware will be reset to 0
 263  * which forces the driver to rediscover the correct value for
 264  * the current association. This is needed when configuration
 265  * options have changed which could drastically change the
 266  * SNR level or link quality (i.e. changing the antenna setting).
 267  *
 268  * Resetting the link tuner will also cause the periodic work counter
 269  * to be reset. Any driver which has a fixed limit on the number
 270  * of rounds the link tuner is supposed to work will accept the
 271  * tuner actions again if this limit was previously reached.
 272  *
 273  * If @antenna is set to true a the software antenna diversity
 274  * tuning will also be reset.
 275  */
 276 void rt2x00link_reset_tuner(struct rt2x00_dev *rt2x00dev, bool antenna);
 277
 278 /**
 279  * rt2x00link_register - Initialize link tuning functionality
 280  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 281  *
 282  * Initialize work structure and all link tuning related
 283  * parameters. This will not start the link tuning process itself.
 284  */
 285 void rt2x00link_register(struct rt2x00_dev *rt2x00dev);
 286
 287 /*
 288  * Firmware handlers.
 289  */
 290 #ifdef CONFIG_RT2X00_LIB_FIRMWARE
 291 int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev);
 292 void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev);
 293 #else
 294 static inline int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev)
 295 {
 296         return 0;
 297 }
 298 static inline void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev)
 299 {
 300 }
 301 #endif /* CONFIG_RT2X00_LIB_FIRMWARE */
 302
 303 /*
 304  * Debugfs handlers.
 305  */
 306 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
 307 void rt2x00debug_register(struct rt2x00_dev *rt2x00dev);
 308 void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev);
 309 void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
 310                             enum rt2x00_dump_type type, struct sk_buff *skb);
 311 void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
 312                                struct rxdone_entry_desc *rxdesc);
 313 #else
 314 static inline void rt2x00debug_register(struct rt2x00_dev *rt2x00dev)
 315 {
 316 }
 317
 318 static inline void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev)
 319 {
 320 }
 321
 322 static inline void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
 323                                           enum rt2x00_dump_type type,
 324                                           struct sk_buff *skb)
 325 {
 326 }
 327
 328 static inline void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
 329                                              struct rxdone_entry_desc *rxdesc)
 330 {
 331 }
 332 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
 333
 334 /*
 335  * Crypto handlers.
 336  */
 337 #ifdef CONFIG_RT2X00_LIB_CRYPTO
 338 enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key);
 339 void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry,
 340                                        struct txentry_desc *txdesc);
 341 unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev,
 342                                       struct sk_buff *skb);
 343 void rt2x00crypto_tx_copy_iv(struct sk_buff *skb,
 344                              struct txentry_desc *txdesc);
 345 void rt2x00crypto_tx_remove_iv(struct sk_buff *skb,
 346                                struct txentry_desc *txdesc);
 347 void rt2x00crypto_tx_insert_iv(struct sk_buff *skb, unsigned int header_length);
 348 void rt2x00crypto_rx_insert_iv(struct sk_buff *skb,
 349                                unsigned int header_length,
 350                                struct rxdone_entry_desc *rxdesc);
 351 #else
 352 static inline enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key)
 353 {
 354         return CIPHER_NONE;
 355 }
 356
 357 static inline void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry,
 358                                                      struct txentry_desc *txdesc)
 359 {
 360 }
 361
 362 static inline unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev,
 363                                                     struct sk_buff *skb)
 364 {
 365         return 0;
 366 }
 367
 368 static inline void rt2x00crypto_tx_copy_iv(struct sk_buff *skb,
 369                                            struct txentry_desc *txdesc)
 370 {
 371 }
 372
 373 static inline void rt2x00crypto_tx_remove_iv(struct sk_buff *skb,
 374                                              struct txentry_desc *txdesc)
 375 {
 376 }
 377
 378 static inline void rt2x00crypto_tx_insert_iv(struct sk_buff *skb,
 379                                              unsigned int header_length)
 380 {
 381 }
 382
 383 static inline void rt2x00crypto_rx_insert_iv(struct sk_buff *skb,
 384                                              unsigned int header_length,
 385                                              struct rxdone_entry_desc *rxdesc)
 386 {
 387 }
 388 #endif /* CONFIG_RT2X00_LIB_CRYPTO */
 389
 390 /*
 391  * HT handlers.
 392  */
 393 #ifdef CONFIG_RT2X00_LIB_HT
 394 void rt2x00ht_create_tx_descriptor(struct queue_entry *entry,
 395                                    struct txentry_desc *txdesc,
 396                                    const struct rt2x00_rate *hwrate);
 397 #else
 398 static inline void rt2x00ht_create_tx_descriptor(struct queue_entry *entry,
 399                                                  struct txentry_desc *txdesc,
 400                                                  const struct rt2x00_rate *hwrate)
 401 {
 402 }
 403 #endif /* CONFIG_RT2X00_LIB_HT */
 404
 405 /*
 406  * RFkill handlers.
 407  */
 408 static inline void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev)
 409 {
 410         if (test_bit(CONFIG_SUPPORT_HW_BUTTON, &rt2x00dev->flags))
 411                 wiphy_rfkill_start_polling(rt2x00dev->hw->wiphy);
 412 }
 413
 414 static inline void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev)
 415 {
 416         if (test_bit(CONFIG_SUPPORT_HW_BUTTON, &rt2x00dev->flags))
 417                 wiphy_rfkill_stop_polling(rt2x00dev->hw->wiphy);
 418 }
 419
 420 /*
 421  * LED handlers
 422  */
 423 #ifdef CONFIG_RT2X00_LIB_LEDS
 424 void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev, int rssi);
 425 void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev, bool enabled);
 426 void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev, bool enabled);
 427 void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev, bool enabled);
 428 void rt2x00leds_register(struct rt2x00_dev *rt2x00dev);
 429 void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev);
 430 void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev);
 431 void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev);
 432 #else
 433 static inline void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev,
 434                                           int rssi)
 435 {
 436 }
 437
 438 static inline void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev,
 439                                           bool enabled)
 440 {
 441 }
 442
 443 static inline void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev,
 444                                         bool enabled)
 445 {
 446 }
 447
 448 static inline void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev,
 449                                         bool enabled)
 450 {
 451 }
 452
 453 static inline void rt2x00leds_register(struct rt2x00_dev *rt2x00dev)
 454 {
 455 }
 456
 457 static inline void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev)
 458 {
 459 }
 460
 461 static inline void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev)
 462 {
 463 }
 464
 465 static inline void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev)
 466 {
 467 }
 468 #endif /* CONFIG_RT2X00_LIB_LEDS */
 469
 470 #endif /* RT2X00LIB_H */