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