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