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 #define DEV_RATE_BASIC                  0x0008
  47
  48         unsigned short bitrate; /* In 100kbit/s */
  49         unsigned short ratemask;
  50
  51         unsigned short plcp;
  52 };
  53
  54 extern const struct rt2x00_rate rt2x00_supported_rates[12];
  55
  56 static inline u16 rt2x00_create_rate_hw_value(const u16 index,
  57                                               const u16 short_preamble)
  58 {
  59         return (short_preamble << 8) | (index & 0xff);
  60 }
  61
  62 static inline const struct rt2x00_rate *rt2x00_get_rate(const u16 hw_value)
  63 {
  64         return &rt2x00_supported_rates[hw_value & 0xff];
  65 }
  66
  67 static inline int rt2x00_get_rate_preamble(const u16 hw_value)
  68 {
  69         return (hw_value & 0xff00);
  70 }
  71
  72 /*
  73  * Radio control handlers.
  74  */
  75 int rt2x00lib_enable_radio(struct rt2x00_dev *rt2x00dev);
  76 void rt2x00lib_disable_radio(struct rt2x00_dev *rt2x00dev);
  77 void rt2x00lib_toggle_rx(struct rt2x00_dev *rt2x00dev, enum dev_state state);
  78 void rt2x00lib_reset_link_tuner(struct rt2x00_dev *rt2x00dev);
  79
  80 /*
  81  * Initialization handlers.
  82  */
  83 int rt2x00lib_start(struct rt2x00_dev *rt2x00dev);
  84 void rt2x00lib_stop(struct rt2x00_dev *rt2x00dev);
  85
  86 /*
  87  * Configuration handlers.
  88  */
  89 void rt2x00lib_config_intf(struct rt2x00_dev *rt2x00dev,
  90                            struct rt2x00_intf *intf,
  91                            enum nl80211_iftype type,
  92                            u8 *mac, u8 *bssid);
  93 void rt2x00lib_config_erp(struct rt2x00_dev *rt2x00dev,
  94                           struct rt2x00_intf *intf,
  95                           struct ieee80211_bss_conf *conf);
  96 void rt2x00lib_config_antenna(struct rt2x00_dev *rt2x00dev,
  97                               enum antenna rx, enum antenna tx);
  98 void rt2x00lib_config(struct rt2x00_dev *rt2x00dev,
  99                       struct ieee80211_conf *conf, const int force_config);
 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 void rt2x00queue_init_rx(struct rt2x00_dev *rt2x00dev);
 154 void rt2x00queue_init_tx(struct rt2x00_dev *rt2x00dev);
 155 int rt2x00queue_initialize(struct rt2x00_dev *rt2x00dev);
 156 void rt2x00queue_uninitialize(struct rt2x00_dev *rt2x00dev);
 157 int rt2x00queue_allocate(struct rt2x00_dev *rt2x00dev);
 158 void rt2x00queue_free(struct rt2x00_dev *rt2x00dev);
 159
 160 /*
 161  * Firmware handlers.
 162  */
 163 #ifdef CONFIG_RT2X00_LIB_FIRMWARE
 164 int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev);
 165 void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev);
 166 #else
 167 static inline int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev)
 168 {
 169         return 0;
 170 }
 171 static inline void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev)
 172 {
 173 }
 174 #endif /* CONFIG_RT2X00_LIB_FIRMWARE */
 175
 176 /*
 177  * Debugfs handlers.
 178  */
 179 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
 180 void rt2x00debug_register(struct rt2x00_dev *rt2x00dev);
 181 void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev);
 182 void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
 183                             enum rt2x00_dump_type type, struct sk_buff *skb);
 184 void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
 185                                enum cipher cipher, enum rx_crypto status);
 186 #else
 187 static inline void rt2x00debug_register(struct rt2x00_dev *rt2x00dev)
 188 {
 189 }
 190
 191 static inline void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev)
 192 {
 193 }
 194
 195 static inline void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
 196                                           enum rt2x00_dump_type type,
 197                                           struct sk_buff *skb)
 198 {
 199 }
 200
 201 static inline void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
 202                                              enum cipher cipher,
 203                                              enum rx_crypto status)
 204 {
 205 }
 206 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
 207
 208 /*
 209  * Crypto handlers.
 210  */
 211 #ifdef CONFIG_RT2X00_LIB_CRYPTO
 212 enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key);
 213 unsigned int rt2x00crypto_tx_overhead(struct ieee80211_tx_info *tx_info);
 214 void rt2x00crypto_tx_remove_iv(struct sk_buff *skb, unsigned int iv_len);
 215 void rt2x00crypto_tx_insert_iv(struct sk_buff *skb);
 216 void rt2x00crypto_rx_insert_iv(struct sk_buff *skb, unsigned int align,
 217                                unsigned int header_length,
 218                                struct rxdone_entry_desc *rxdesc);
 219 #else
 220 static inline enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key)
 221 {
 222         return CIPHER_NONE;
 223 }
 224
 225 static inline unsigned int rt2x00crypto_tx_overhead(struct ieee80211_tx_info *tx_info)
 226 {
 227         return 0;
 228 }
 229
 230 static inline void rt2x00crypto_tx_remove_iv(struct sk_buff *skb,
 231                                              unsigned int iv_len)
 232 {
 233 }
 234
 235 static inline void rt2x00crypto_tx_insert_iv(struct sk_buff *skb)
 236 {
 237 }
 238
 239 static inline void rt2x00crypto_rx_insert_iv(struct sk_buff *skb,
 240                                              unsigned int align,
 241                                              unsigned int header_length,
 242                                              struct rxdone_entry_desc *rxdesc)
 243 {
 244 }
 245 #endif
 246
 247 /*
 248  * RFkill handlers.
 249  */
 250 #ifdef CONFIG_RT2X00_LIB_RFKILL
 251 void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev);
 252 void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev);
 253 void rt2x00rfkill_allocate(struct rt2x00_dev *rt2x00dev);
 254 void rt2x00rfkill_free(struct rt2x00_dev *rt2x00dev);
 255 #else
 256 static inline void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev)
 257 {
 258 }
 259
 260 static inline void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev)
 261 {
 262 }
 263
 264 static inline void rt2x00rfkill_allocate(struct rt2x00_dev *rt2x00dev)
 265 {
 266 }
 267
 268 static inline void rt2x00rfkill_free(struct rt2x00_dev *rt2x00dev)
 269 {
 270 }
 271 #endif /* CONFIG_RT2X00_LIB_RFKILL */
 272
 273 /*
 274  * LED handlers
 275  */
 276 #ifdef CONFIG_RT2X00_LIB_LEDS
 277 void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev, int rssi);
 278 void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev, bool enabled);
 279 void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev, bool enabled);
 280 void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev, bool enabled);
 281 void rt2x00leds_register(struct rt2x00_dev *rt2x00dev);
 282 void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev);
 283 void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev);
 284 void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev);
 285 #else
 286 static inline void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev,
 287                                           int rssi)
 288 {
 289 }
 290
 291 static inline void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev,
 292                                           bool enabled)
 293 {
 294 }
 295
 296 static inline void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev,
 297                                         bool enabled)
 298 {
 299 }
 300
 301 static inline void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev,
 302                                         bool enabled)
 303 {
 304 }
 305
 306 static inline void rt2x00leds_register(struct rt2x00_dev *rt2x00dev)
 307 {
 308 }
 309
 310 static inline void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev)
 311 {
 312 }
 313
 314 static inline void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev)
 315 {
 316 }
 317
 318 static inline void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev)
 319 {
 320 }
 321 #endif /* CONFIG_RT2X00_LIB_LEDS */
 322
 323 #endif /* RT2X00LIB_H */