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