drivers/net/wireless/rt2x00/rt2x00lib.h

   1 /*
   2         Copyright (C) 2004 - 2008 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  * Both the link tuner as the rfkill will be called once per second.
  34  */
  35 #define LINK_TUNE_INTERVAL      ( round_jiffies_relative(HZ) )
  36 #define RFKILL_POLL_INTERVAL    ( round_jiffies_relative(HZ) )
  37
  38 /*
  39  * rt2x00_rate: Per rate device information
  40  */
  41 struct rt2x00_rate {
  42         unsigned short flags;
  43 #define DEV_RATE_CCK                    0x0001
  44 #define DEV_RATE_OFDM                   0x0002
  45 #define DEV_RATE_SHORT_PREAMBLE         0x0004
  46
  47         unsigned short bitrate; /* In 100kbit/s */
  48         unsigned short ratemask;
  49
  50         unsigned short plcp;
  51 };
  52
  53 extern const struct rt2x00_rate rt2x00_supported_rates[12];
  54
  55 static inline u16 rt2x00_create_rate_hw_value(const u16 index,
  56                                               const u16 short_preamble)
  57 {
  58         return (short_preamble << 8) | (index & 0xff);
  59 }
  60
  61 static inline const struct rt2x00_rate *rt2x00_get_rate(const u16 hw_value)
  62 {
  63         return &rt2x00_supported_rates[hw_value & 0xff];
  64 }
  65
  66 static inline int rt2x00_get_rate_preamble(const u16 hw_value)
  67 {
  68         return (hw_value & 0xff00);
  69 }
  70
  71 /*
  72  * Radio control handlers.
  73  */
  74 int rt2x00lib_enable_radio(struct rt2x00_dev *rt2x00dev);
  75 void rt2x00lib_disable_radio(struct rt2x00_dev *rt2x00dev);
  76 void rt2x00lib_toggle_rx(struct rt2x00_dev *rt2x00dev, enum dev_state state);
  77 void rt2x00lib_reset_link_tuner(struct rt2x00_dev *rt2x00dev);
  78
  79 /*
  80  * Initialization handlers.
  81  */
  82 int rt2x00lib_start(struct rt2x00_dev *rt2x00dev);
  83 void rt2x00lib_stop(struct rt2x00_dev *rt2x00dev);
  84
  85 /*
  86  * Configuration handlers.
  87  */
  88 void rt2x00lib_config_intf(struct rt2x00_dev *rt2x00dev,
  89                            struct rt2x00_intf *intf,
  90                            enum nl80211_iftype type,
  91                            u8 *mac, u8 *bssid);
  92 void rt2x00lib_config_erp(struct rt2x00_dev *rt2x00dev,
  93                           struct rt2x00_intf *intf,
  94                           struct ieee80211_bss_conf *conf);
  95 void rt2x00lib_config_antenna(struct rt2x00_dev *rt2x00dev,
  96                               struct antenna_setup *ant);
  97 void rt2x00lib_config(struct rt2x00_dev *rt2x00dev,
  98                       struct ieee80211_conf *conf,
  99                       const unsigned int changed_flags);
 100
 101 /**
 102  * DOC: Queue handlers
 103  */
 104
 105 /**
 106  * rt2x00queue_alloc_rxskb - allocate a skb for RX purposes.
 107  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 108  * @queue: The queue for which the skb will be applicable.
 109  */
 110 struct sk_buff *rt2x00queue_alloc_rxskb(struct rt2x00_dev *rt2x00dev,
 111                                         struct queue_entry *entry);
 112
 113 /**
 114  * rt2x00queue_unmap_skb - Unmap a skb from DMA.
 115  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 116  * @skb: The skb to unmap.
 117  */
 118 void rt2x00queue_unmap_skb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb);
 119
 120 /**
 121  * rt2x00queue_free_skb - free a skb
 122  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 123  * @skb: The skb to free.
 124  */
 125 void rt2x00queue_free_skb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb);
 126
 127 /**
 128  * rt2x00queue_write_tx_frame - Write TX frame to hardware
 129  * @queue: Queue over which the frame should be send
 130  * @skb: The skb to send
 131  */
 132 int rt2x00queue_write_tx_frame(struct data_queue *queue, struct sk_buff *skb);
 133
 134 /**
 135  * rt2x00queue_update_beacon - Send new beacon from mac80211 to hardware
 136  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 137  * @vif: Interface for which the beacon should be updated.
 138  */
 139 int rt2x00queue_update_beacon(struct rt2x00_dev *rt2x00dev,
 140                               struct ieee80211_vif *vif);
 141
 142 /**
 143  * rt2x00queue_index_inc - Index incrementation function
 144  * @queue: Queue (&struct data_queue) to perform the action on.
 145  * @index: Index type (&enum queue_index) to perform the action on.
 146  *
 147  * This function will increase the requested index on the queue,
 148  * it will grab the appropriate locks and handle queue overflow events by
 149  * resetting the index to the start of the queue.
 150  */
 151 void rt2x00queue_index_inc(struct data_queue *queue, enum queue_index index);
 152
 153 /**
 154  * rt2x00queue_init_queues - Initialize all data queues
 155  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 156  *
 157  * This function will loop through all available queues to clear all
 158  * index numbers and set the queue entry to the correct initialization
 159  * state.
 160  */
 161 void rt2x00queue_init_queues(struct rt2x00_dev *rt2x00dev);
 162
 163 int rt2x00queue_initialize(struct rt2x00_dev *rt2x00dev);
 164 void rt2x00queue_uninitialize(struct rt2x00_dev *rt2x00dev);
 165 int rt2x00queue_allocate(struct rt2x00_dev *rt2x00dev);
 166 void rt2x00queue_free(struct rt2x00_dev *rt2x00dev);
 167
 168 /*
 169  * Firmware handlers.
 170  */
 171 #ifdef CONFIG_RT2X00_LIB_FIRMWARE
 172 int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev);
 173 void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev);
 174 #else
 175 static inline int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev)
 176 {
 177         return 0;
 178 }
 179 static inline void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev)
 180 {
 181 }
 182 #endif /* CONFIG_RT2X00_LIB_FIRMWARE */
 183
 184 /*
 185  * Debugfs handlers.
 186  */
 187 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
 188 void rt2x00debug_register(struct rt2x00_dev *rt2x00dev);
 189 void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev);
 190 void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
 191                             enum rt2x00_dump_type type, struct sk_buff *skb);
 192 void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
 193                                enum cipher cipher, enum rx_crypto status);
 194 #else
 195 static inline void rt2x00debug_register(struct rt2x00_dev *rt2x00dev)
 196 {
 197 }
 198
 199 static inline void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev)
 200 {
 201 }
 202
 203 static inline void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
 204                                           enum rt2x00_dump_type type,
 205                                           struct sk_buff *skb)
 206 {
 207 }
 208
 209 static inline void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
 210                                              enum cipher cipher,
 211                                              enum rx_crypto status)
 212 {
 213 }
 214 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
 215
 216 /*
 217  * Crypto handlers.
 218  */
 219 #ifdef CONFIG_RT2X00_LIB_CRYPTO
 220 enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key);
 221 void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry,
 222                                        struct txentry_desc *txdesc);
 223 unsigned int rt2x00crypto_tx_overhead(struct ieee80211_tx_info *tx_info);
 224 void rt2x00crypto_tx_copy_iv(struct sk_buff *skb, unsigned int iv_len);
 225 void rt2x00crypto_tx_remove_iv(struct sk_buff *skb, unsigned int iv_len);
 226 void rt2x00crypto_tx_insert_iv(struct sk_buff *skb);
 227 void rt2x00crypto_rx_insert_iv(struct sk_buff *skb, unsigned int align,
 228                                unsigned int header_length,
 229                                struct rxdone_entry_desc *rxdesc);
 230 #else
 231 static inline enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key)
 232 {
 233         return CIPHER_NONE;
 234 }
 235
 236 static inline void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry,
 237                                                      struct txentry_desc *txdesc)
 238 {
 239 }
 240
 241 static inline unsigned int rt2x00crypto_tx_overhead(struct ieee80211_tx_info *tx_info)
 242 {
 243         return 0;
 244 }
 245
 246 static inline void rt2x00crypto_tx_copy_iv(struct sk_buff *skb,
 247                                            unsigned int iv_len)
 248 {
 249 }
 250
 251 static inline void rt2x00crypto_tx_remove_iv(struct sk_buff *skb,
 252                                              unsigned int iv_len)
 253 {
 254 }
 255
 256 static inline void rt2x00crypto_tx_insert_iv(struct sk_buff *skb)
 257 {
 258 }
 259
 260 static inline void rt2x00crypto_rx_insert_iv(struct sk_buff *skb,
 261                                              unsigned int align,
 262                                              unsigned int header_length,
 263                                              struct rxdone_entry_desc *rxdesc)
 264 {
 265 }
 266 #endif /* CONFIG_RT2X00_LIB_CRYPTO */
 267
 268 /*
 269  * RFkill handlers.
 270  */
 271 #ifdef CONFIG_RT2X00_LIB_RFKILL
 272 void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev);
 273 void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev);
 274 void rt2x00rfkill_allocate(struct rt2x00_dev *rt2x00dev);
 275 void rt2x00rfkill_free(struct rt2x00_dev *rt2x00dev);
 276 #else
 277 static inline void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev)
 278 {
 279 }
 280
 281 static inline void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev)
 282 {
 283 }
 284
 285 static inline void rt2x00rfkill_allocate(struct rt2x00_dev *rt2x00dev)
 286 {
 287 }
 288
 289 static inline void rt2x00rfkill_free(struct rt2x00_dev *rt2x00dev)
 290 {
 291 }
 292 #endif /* CONFIG_RT2X00_LIB_RFKILL */
 293
 294 /*
 295  * LED handlers
 296  */
 297 #ifdef CONFIG_RT2X00_LIB_LEDS
 298 void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev, int rssi);
 299 void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev, bool enabled);
 300 void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev, bool enabled);
 301 void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev, bool enabled);
 302 void rt2x00leds_register(struct rt2x00_dev *rt2x00dev);
 303 void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev);
 304 void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev);
 305 void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev);
 306 #else
 307 static inline void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev,
 308                                           int rssi)
 309 {
 310 }
 311
 312 static inline void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev,
 313                                           bool enabled)
 314 {
 315 }
 316
 317 static inline void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev,
 318                                         bool enabled)
 319 {
 320 }
 321
 322 static inline void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev,
 323                                         bool enabled)
 324 {
 325 }
 326
 327 static inline void rt2x00leds_register(struct rt2x00_dev *rt2x00dev)
 328 {
 329 }
 330
 331 static inline void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev)
 332 {
 333 }
 334
 335 static inline void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev)
 336 {
 337 }
 338
 339 static inline void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev)
 340 {
 341 }
 342 #endif /* CONFIG_RT2X00_LIB_LEDS */
 343
 344 #endif /* RT2X00LIB_H */