drivers/net/wireless/rt2x00/rt2x00lib.h

   1 /*
   2         Copyright (C) 2004 - 2009 Ivo van Doorn <IvDoorn@gmail.com>
   3         Copyright (C) 2004 - 2009 Gertjan van Wingerde <gwingerde@gmail.com>
   4         <http://rt2x00.serialmonkey.com>
   5
   6         This program is free software; you can redistribute it and/or modify
   7         it under the terms of the GNU General Public License as published by
   8         the Free Software Foundation; either version 2 of the License, or
   9         (at your option) any later version.
  10
  11         This program is distributed in the hope that it will be useful,
  12         but WITHOUT ANY WARRANTY; without even the implied warranty of
  13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14         GNU General Public License for more details.
  15
  16         You should have received a copy of the GNU General Public License
  17         along with this program; if not, write to the
  18         Free Software Foundation, Inc.,
  19         59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  20  */
  21
  22 /*
  23         Module: rt2x00lib
  24         Abstract: Data structures and definitions for the rt2x00lib module.
  25  */
  26
  27 #ifndef RT2X00LIB_H
  28 #define RT2X00LIB_H
  29
  30 #include "rt2x00dump.h"
  31
  32 /*
  33  * Interval defines
  34  */
  35 #define LINK_TUNE_INTERVAL      round_jiffies_relative(HZ)
  36
  37 /*
  38  * rt2x00_rate: Per rate device information
  39  */
  40 struct rt2x00_rate {
  41         unsigned short flags;
  42 #define DEV_RATE_CCK                    0x0001
  43 #define DEV_RATE_OFDM                   0x0002
  44 #define DEV_RATE_SHORT_PREAMBLE         0x0004
  45
  46         unsigned short bitrate; /* In 100kbit/s */
  47         unsigned short ratemask;
  48
  49         unsigned short plcp;
  50         unsigned short mcs;
  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 #define RATE_MCS(__mode, __mcs) \
  61         ( (((__mode) & 0x00ff) << 8) | ((__mcs) & 0x00ff) )
  62
  63 static inline int rt2x00_get_rate_mcs(const u16 mcs_value)
  64 {
  65         return (mcs_value & 0x00ff);
  66 }
  67
  68 /*
  69  * Radio control handlers.
  70  */
  71 int rt2x00lib_enable_radio(struct rt2x00_dev *rt2x00dev);
  72 void rt2x00lib_disable_radio(struct rt2x00_dev *rt2x00dev);
  73 void rt2x00lib_toggle_rx(struct rt2x00_dev *rt2x00dev, enum dev_state state);
  74
  75 /*
  76  * Initialization handlers.
  77  */
  78 int rt2x00lib_start(struct rt2x00_dev *rt2x00dev);
  79 void rt2x00lib_stop(struct rt2x00_dev *rt2x00dev);
  80
  81 /*
  82  * Configuration handlers.
  83  */
  84 void rt2x00lib_config_intf(struct rt2x00_dev *rt2x00dev,
  85                            struct rt2x00_intf *intf,
  86                            enum nl80211_iftype type,
  87                            const u8 *mac, const u8 *bssid);
  88 void rt2x00lib_config_erp(struct rt2x00_dev *rt2x00dev,
  89                           struct rt2x00_intf *intf,
  90                           struct ieee80211_bss_conf *conf);
  91 void rt2x00lib_config_antenna(struct rt2x00_dev *rt2x00dev,
  92                               struct antenna_setup ant);
  93 void rt2x00lib_config(struct rt2x00_dev *rt2x00dev,
  94                       struct ieee80211_conf *conf,
  95                       const unsigned int changed_flags);
  96
  97 /**
  98  * DOC: Queue handlers
  99  */
 100
 101 /**
 102  * rt2x00queue_alloc_rxskb - allocate a skb for RX purposes.
 103  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 104  * @queue: The queue for which the skb will be applicable.
 105  */
 106 struct sk_buff *rt2x00queue_alloc_rxskb(struct rt2x00_dev *rt2x00dev,
 107                                         struct queue_entry *entry);
 108
 109 /**
 110  * rt2x00queue_unmap_skb - Unmap a skb from DMA.
 111  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 112  * @skb: The skb to unmap.
 113  */
 114 void rt2x00queue_unmap_skb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb);
 115
 116 /**
 117  * rt2x00queue_free_skb - free a skb
 118  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 119  * @skb: The skb to free.
 120  */
 121 void rt2x00queue_free_skb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb);
 122
 123 /**
 124  * rt2x00queue_align_frame - Align 802.11 frame to 4-byte boundary
 125  * @skb: The skb to align
 126  *
 127  * Align the start of the 802.11 frame to a 4-byte boundary, this could
 128  * mean the payload is not aligned properly though.
 129  */
 130 void rt2x00queue_align_frame(struct sk_buff *skb);
 131
 132 /**
 133  * rt2x00queue_align_payload - Align 802.11 payload to 4-byte boundary
 134  * @skb: The skb to align
 135  * @header_length: Length of 802.11 header
 136  *
 137  * Align the 802.11 payload to a 4-byte boundary, this could
 138  * mean the header is not aligned properly though.
 139  */
 140 void rt2x00queue_align_payload(struct sk_buff *skb, unsigned int header_length);
 141
 142 /**
 143  * rt2x00queue_insert_l2pad - Align 802.11 header & payload to 4-byte boundary
 144  * @skb: The skb to align
 145  * @header_length: Length of 802.11 header
 146  *
 147  * Apply L2 padding to align both header and payload to 4-byte boundary
 148  */
 149 void rt2x00queue_insert_l2pad(struct sk_buff *skb, unsigned int header_length);
 150
 151 /**
 152  * rt2x00queue_insert_l2pad - Remove L2 padding from 802.11 frame
 153  * @skb: The skb to align
 154  * @header_length: Length of 802.11 header
 155  *
 156  * Remove L2 padding used to align both header and payload to 4-byte boundary,
 157  * by removing the L2 padding the header will no longer be 4-byte aligned.
 158  */
 159 void rt2x00queue_remove_l2pad(struct sk_buff *skb, unsigned int header_length);
 160
 161 /**
 162  * rt2x00queue_write_tx_frame - Write TX frame to hardware
 163  * @queue: Queue over which the frame should be send
 164  * @skb: The skb to send
 165  */
 166 int rt2x00queue_write_tx_frame(struct data_queue *queue, struct sk_buff *skb);
 167
 168 /**
 169  * rt2x00queue_update_beacon - Send new beacon from mac80211 to hardware
 170  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 171  * @vif: Interface for which the beacon should be updated.
 172  * @enable_beacon: Enable beaconing
 173  */
 174 int rt2x00queue_update_beacon(struct rt2x00_dev *rt2x00dev,
 175                               struct ieee80211_vif *vif,
 176                               const bool enable_beacon);
 177
 178 /**
 179  * rt2x00queue_index_inc - Index incrementation function
 180  * @queue: Queue (&struct data_queue) to perform the action on.
 181  * @index: Index type (&enum queue_index) to perform the action on.
 182  *
 183  * This function will increase the requested index on the queue,
 184  * it will grab the appropriate locks and handle queue overflow events by
 185  * resetting the index to the start of the queue.
 186  */
 187 void rt2x00queue_index_inc(struct data_queue *queue, enum queue_index index);
 188
 189 /**
 190  * rt2x00queue_stop_queues - Halt all data queues
 191  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 192  *
 193  * This function will loop through all available queues to stop
 194  * any pending outgoing frames.
 195  */
 196 void rt2x00queue_stop_queues(struct rt2x00_dev *rt2x00dev);
 197
 198 /**
 199  * rt2x00queue_init_queues - Initialize all data queues
 200  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 201  *
 202  * This function will loop through all available queues to clear all
 203  * index numbers and set the queue entry to the correct initialization
 204  * state.
 205  */
 206 void rt2x00queue_init_queues(struct rt2x00_dev *rt2x00dev);
 207
 208 int rt2x00queue_initialize(struct rt2x00_dev *rt2x00dev);
 209 void rt2x00queue_uninitialize(struct rt2x00_dev *rt2x00dev);
 210 int rt2x00queue_allocate(struct rt2x00_dev *rt2x00dev);
 211 void rt2x00queue_free(struct rt2x00_dev *rt2x00dev);
 212
 213 /**
 214  * rt2x00link_update_stats - Update link statistics from RX frame
 215  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 216  * @skb: Received frame
 217  * @rxdesc: Received frame descriptor
 218  *
 219  * Update link statistics based on the information from the
 220  * received frame descriptor.
 221  */
 222 void rt2x00link_update_stats(struct rt2x00_dev *rt2x00dev,
 223                              struct sk_buff *skb,
 224                              struct rxdone_entry_desc *rxdesc);
 225
 226 /**
 227  * rt2x00link_start_tuner - Start periodic link tuner work
 228  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 229  *
 230  * This start the link tuner periodic work, this work will
 231  * be executed periodically until &rt2x00link_stop_tuner has
 232  * been called.
 233  */
 234 void rt2x00link_start_tuner(struct rt2x00_dev *rt2x00dev);
 235
 236 /**
 237  * rt2x00link_stop_tuner - Stop periodic link tuner work
 238  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 239  *
 240  * After this function completed the link tuner will not
 241  * be running until &rt2x00link_start_tuner is called.
 242  */
 243 void rt2x00link_stop_tuner(struct rt2x00_dev *rt2x00dev);
 244
 245 /**
 246  * rt2x00link_reset_tuner - Reset periodic link tuner work
 247  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 248  * @antenna: Should the antenna tuning also be reset
 249  *
 250  * The VGC limit configured in the hardware will be reset to 0
 251  * which forces the driver to rediscover the correct value for
 252  * the current association. This is needed when configuration
 253  * options have changed which could drastically change the
 254  * SNR level or link quality (i.e. changing the antenna setting).
 255  *
 256  * Resetting the link tuner will also cause the periodic work counter
 257  * to be reset. Any driver which has a fixed limit on the number
 258  * of rounds the link tuner is supposed to work will accept the
 259  * tuner actions again if this limit was previously reached.
 260  *
 261  * If @antenna is set to true a the software antenna diversity
 262  * tuning will also be reset.
 263  */
 264 void rt2x00link_reset_tuner(struct rt2x00_dev *rt2x00dev, bool antenna);
 265
 266 /**
 267  * rt2x00link_register - Initialize link tuning functionality
 268  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 269  *
 270  * Initialize work structure and all link tuning related
 271  * parameters. This will not start the link tuning process itself.
 272  */
 273 void rt2x00link_register(struct rt2x00_dev *rt2x00dev);
 274
 275 /*
 276  * Firmware handlers.
 277  */
 278 #ifdef CONFIG_RT2X00_LIB_FIRMWARE
 279 int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev);
 280 void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev);
 281 #else
 282 static inline int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev)
 283 {
 284         return 0;
 285 }
 286 static inline void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev)
 287 {
 288 }
 289 #endif /* CONFIG_RT2X00_LIB_FIRMWARE */
 290
 291 /*
 292  * Debugfs handlers.
 293  */
 294 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
 295 void rt2x00debug_register(struct rt2x00_dev *rt2x00dev);
 296 void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev);
 297 void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
 298                             enum rt2x00_dump_type type, struct sk_buff *skb);
 299 void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
 300                                struct rxdone_entry_desc *rxdesc);
 301 #else
 302 static inline void rt2x00debug_register(struct rt2x00_dev *rt2x00dev)
 303 {
 304 }
 305
 306 static inline void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev)
 307 {
 308 }
 309
 310 static inline void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
 311                                           enum rt2x00_dump_type type,
 312                                           struct sk_buff *skb)
 313 {
 314 }
 315
 316 static inline void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
 317                                              struct rxdone_entry_desc *rxdesc)
 318 {
 319 }
 320 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
 321
 322 /*
 323  * Crypto handlers.
 324  */
 325 #ifdef CONFIG_RT2X00_LIB_CRYPTO
 326 enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key);
 327 void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry,
 328                                        struct txentry_desc *txdesc);
 329 unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev,
 330                                       struct sk_buff *skb);
 331 void rt2x00crypto_tx_copy_iv(struct sk_buff *skb,
 332                              struct txentry_desc *txdesc);
 333 void rt2x00crypto_tx_remove_iv(struct sk_buff *skb,
 334                                struct txentry_desc *txdesc);
 335 void rt2x00crypto_tx_insert_iv(struct sk_buff *skb, unsigned int header_length);
 336 void rt2x00crypto_rx_insert_iv(struct sk_buff *skb,
 337                                unsigned int header_length,
 338                                struct rxdone_entry_desc *rxdesc);
 339 #else
 340 static inline enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key)
 341 {
 342         return CIPHER_NONE;
 343 }
 344
 345 static inline void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry,
 346                                                      struct txentry_desc *txdesc)
 347 {
 348 }
 349
 350 static inline unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev,
 351                                                     struct sk_buff *skb)
 352 {
 353         return 0;
 354 }
 355
 356 static inline void rt2x00crypto_tx_copy_iv(struct sk_buff *skb,
 357                                            struct txentry_desc *txdesc)
 358 {
 359 }
 360
 361 static inline void rt2x00crypto_tx_remove_iv(struct sk_buff *skb,
 362                                              struct txentry_desc *txdesc)
 363 {
 364 }
 365
 366 static inline void rt2x00crypto_tx_insert_iv(struct sk_buff *skb,
 367                                              unsigned int header_length)
 368 {
 369 }
 370
 371 static inline void rt2x00crypto_rx_insert_iv(struct sk_buff *skb,
 372                                              unsigned int header_length,
 373                                              struct rxdone_entry_desc *rxdesc)
 374 {
 375 }
 376 #endif /* CONFIG_RT2X00_LIB_CRYPTO */
 377
 378 /*
 379  * HT handlers.
 380  */
 381 #ifdef CONFIG_RT2X00_LIB_HT
 382 void rt2x00ht_create_tx_descriptor(struct queue_entry *entry,
 383                                    struct txentry_desc *txdesc,
 384                                    const struct rt2x00_rate *hwrate);
 385 #else
 386 static inline void rt2x00ht_create_tx_descriptor(struct queue_entry *entry,
 387                                                  struct txentry_desc *txdesc,
 388                                                  const struct rt2x00_rate *hwrate)
 389 {
 390 }
 391 #endif /* CONFIG_RT2X00_LIB_HT */
 392
 393 /*
 394  * RFkill handlers.
 395  */
 396 static inline void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev)
 397 {
 398         if (test_bit(CONFIG_SUPPORT_HW_BUTTON, &rt2x00dev->flags))
 399                 wiphy_rfkill_start_polling(rt2x00dev->hw->wiphy);
 400 }
 401
 402 static inline void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev)
 403 {
 404         if (test_bit(CONFIG_SUPPORT_HW_BUTTON, &rt2x00dev->flags))
 405                 wiphy_rfkill_stop_polling(rt2x00dev->hw->wiphy);
 406 }
 407
 408 /*
 409  * LED handlers
 410  */
 411 #ifdef CONFIG_RT2X00_LIB_LEDS
 412 void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev, int rssi);
 413 void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev, bool enabled);
 414 void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev, bool enabled);
 415 void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev, bool enabled);
 416 void rt2x00leds_register(struct rt2x00_dev *rt2x00dev);
 417 void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev);
 418 void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev);
 419 void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev);
 420 #else
 421 static inline void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev,
 422                                           int rssi)
 423 {
 424 }
 425
 426 static inline void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev,
 427                                           bool enabled)
 428 {
 429 }
 430
 431 static inline void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev,
 432                                         bool enabled)
 433 {
 434 }
 435
 436 static inline void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev,
 437                                         bool enabled)
 438 {
 439 }
 440
 441 static inline void rt2x00leds_register(struct rt2x00_dev *rt2x00dev)
 442 {
 443 }
 444
 445 static inline void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev)
 446 {
 447 }
 448
 449 static inline void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev)
 450 {
 451 }
 452
 453 static inline void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev)
 454 {
 455 }
 456 #endif /* CONFIG_RT2X00_LIB_LEDS */
 457
 458 #endif /* RT2X00LIB_H */