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