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,
 100                       const unsigned int changed_flags);
 101
 102 /**
 103  * DOC: Queue handlers
 104  */
 105
 106 /**
 107  * rt2x00queue_alloc_rxskb - allocate a skb for RX purposes.
 108  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 109  * @queue: The queue for which the skb will be applicable.
 110  */
 111 struct sk_buff *rt2x00queue_alloc_rxskb(struct rt2x00_dev *rt2x00dev,
 112                                         struct queue_entry *entry);
 113
 114 /**
 115  * rt2x00queue_unmap_skb - Unmap a skb from DMA.
 116  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 117  * @skb: The skb to unmap.
 118  */
 119 void rt2x00queue_unmap_skb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb);
 120
 121 /**
 122  * rt2x00queue_free_skb - free a skb
 123  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 124  * @skb: The skb to free.
 125  */
 126 void rt2x00queue_free_skb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb);
 127
 128 /**
 129  * rt2x00queue_write_tx_frame - Write TX frame to hardware
 130  * @queue: Queue over which the frame should be send
 131  * @skb: The skb to send
 132  */
 133 int rt2x00queue_write_tx_frame(struct data_queue *queue, struct sk_buff *skb);
 134
 135 /**
 136  * rt2x00queue_update_beacon - Send new beacon from mac80211 to hardware
 137  * @rt2x00dev: Pointer to &struct rt2x00_dev.
 138  * @vif: Interface for which the beacon should be updated.
 139  */
 140 int rt2x00queue_update_beacon(struct rt2x00_dev *rt2x00dev,
 141                               struct ieee80211_vif *vif);
 142
 143 /**
 144  * rt2x00queue_index_inc - Index incrementation function
 145  * @queue: Queue (&struct data_queue) to perform the action on.
 146  * @index: Index type (&enum queue_index) to perform the action on.
 147  *
 148  * This function will increase the requested index on the queue,
 149  * it will grab the appropriate locks and handle queue overflow events by
 150  * resetting the index to the start of the queue.
 151  */
 152 void rt2x00queue_index_inc(struct data_queue *queue, enum queue_index index);
 153
 154 void rt2x00queue_init_rx(struct rt2x00_dev *rt2x00dev);
 155 void rt2x00queue_init_tx(struct rt2x00_dev *rt2x00dev);
 156 int rt2x00queue_initialize(struct rt2x00_dev *rt2x00dev);
 157 void rt2x00queue_uninitialize(struct rt2x00_dev *rt2x00dev);
 158 int rt2x00queue_allocate(struct rt2x00_dev *rt2x00dev);
 159 void rt2x00queue_free(struct rt2x00_dev *rt2x00dev);
 160
 161 /*
 162  * Firmware handlers.
 163  */
 164 #ifdef CONFIG_RT2X00_LIB_FIRMWARE
 165 int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev);
 166 void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev);
 167 #else
 168 static inline int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev)
 169 {
 170         return 0;
 171 }
 172 static inline void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev)
 173 {
 174 }
 175 #endif /* CONFIG_RT2X00_LIB_FIRMWARE */
 176
 177 /*
 178  * Debugfs handlers.
 179  */
 180 #ifdef CONFIG_RT2X00_LIB_DEBUGFS
 181 void rt2x00debug_register(struct rt2x00_dev *rt2x00dev);
 182 void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev);
 183 void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
 184                             enum rt2x00_dump_type type, struct sk_buff *skb);
 185 void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
 186                                enum cipher cipher, enum rx_crypto status);
 187 #else
 188 static inline void rt2x00debug_register(struct rt2x00_dev *rt2x00dev)
 189 {
 190 }
 191
 192 static inline void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev)
 193 {
 194 }
 195
 196 static inline void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
 197                                           enum rt2x00_dump_type type,
 198                                           struct sk_buff *skb)
 199 {
 200 }
 201
 202 static inline void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
 203                                              enum cipher cipher,
 204                                              enum rx_crypto status)
 205 {
 206 }
 207 #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
 208
 209 /*
 210  * Crypto handlers.
 211  */
 212 #ifdef CONFIG_RT2X00_LIB_CRYPTO
 213 enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key);
 214 unsigned int rt2x00crypto_tx_overhead(struct ieee80211_tx_info *tx_info);
 215 void rt2x00crypto_tx_remove_iv(struct sk_buff *skb, unsigned int iv_len);
 216 void rt2x00crypto_tx_insert_iv(struct sk_buff *skb);
 217 void rt2x00crypto_rx_insert_iv(struct sk_buff *skb, unsigned int align,
 218                                unsigned int header_length,
 219                                struct rxdone_entry_desc *rxdesc);
 220 #else
 221 static inline enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key)
 222 {
 223         return CIPHER_NONE;
 224 }
 225
 226 static inline unsigned int rt2x00crypto_tx_overhead(struct ieee80211_tx_info *tx_info)
 227 {
 228         return 0;
 229 }
 230
 231 static inline void rt2x00crypto_tx_remove_iv(struct sk_buff *skb,
 232                                              unsigned int iv_len)
 233 {
 234 }
 235
 236 static inline void rt2x00crypto_tx_insert_iv(struct sk_buff *skb)
 237 {
 238 }
 239
 240 static inline void rt2x00crypto_rx_insert_iv(struct sk_buff *skb,
 241                                              unsigned int align,
 242                                              unsigned int header_length,
 243                                              struct rxdone_entry_desc *rxdesc)
 244 {
 245 }
 246 #endif
 247
 248 /*
 249  * RFkill handlers.
 250  */
 251 #ifdef CONFIG_RT2X00_LIB_RFKILL
 252 void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev);
 253 void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev);
 254 void rt2x00rfkill_allocate(struct rt2x00_dev *rt2x00dev);
 255 void rt2x00rfkill_free(struct rt2x00_dev *rt2x00dev);
 256 #else
 257 static inline void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev)
 258 {
 259 }
 260
 261 static inline void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev)
 262 {
 263 }
 264
 265 static inline void rt2x00rfkill_allocate(struct rt2x00_dev *rt2x00dev)
 266 {
 267 }
 268
 269 static inline void rt2x00rfkill_free(struct rt2x00_dev *rt2x00dev)
 270 {
 271 }
 272 #endif /* CONFIG_RT2X00_LIB_RFKILL */
 273
 274 /*
 275  * LED handlers
 276  */
 277 #ifdef CONFIG_RT2X00_LIB_LEDS
 278 void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev, int rssi);
 279 void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev, bool enabled);
 280 void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev, bool enabled);
 281 void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev, bool enabled);
 282 void rt2x00leds_register(struct rt2x00_dev *rt2x00dev);
 283 void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev);
 284 void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev);
 285 void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev);
 286 #else
 287 static inline void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev,
 288                                           int rssi)
 289 {
 290 }
 291
 292 static inline void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev,
 293                                           bool enabled)
 294 {
 295 }
 296
 297 static inline void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev,
 298                                         bool enabled)
 299 {
 300 }
 301
 302 static inline void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev,
 303                                         bool enabled)
 304 {
 305 }
 306
 307 static inline void rt2x00leds_register(struct rt2x00_dev *rt2x00dev)
 308 {
 309 }
 310
 311 static inline void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev)
 312 {
 313 }
 314
 315 static inline void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev)
 316 {
 317 }
 318
 319 static inline void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev)
 320 {
 321 }
 322 #endif /* CONFIG_RT2X00_LIB_LEDS */
 323
 324 #endif /* RT2X00LIB_H */