rt2x00lib.h

Go to the documentation of this file.

/*
    Copyright (C) 2004 - 2009 Ivo van Doorn <[email protected]>
    Copyright (C) 2004 - 2009 Gertjan van Wingerde <[email protected]>
    <http://rt2x00.serialmonkey.com>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the
    Free Software Foundation, Inc.,
    59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

/*
    Module: rt2x00lib
    Abstract: Data structures and definitions for the rt2x00lib module.
 */

#ifndef RT2X00LIB_H
#define RT2X00LIB_H

/*
 * Interval defines
 */
#define WATCHDOG_INTERVAL   round_jiffies_relative(HZ)
#define LINK_TUNE_INTERVAL  round_jiffies_relative(HZ)
#define AGC_INTERVAL        round_jiffies_relative(4 * HZ)
#define VCO_INTERVAL        round_jiffies_relative(10 * HZ) /* 10 sec */

/*
 * rt2x00_rate: Per rate device information
 */
struct rt2x00_rate {
    unsigned short flags;
#define DEV_RATE_CCK            0x0001
#define DEV_RATE_OFDM           0x0002
#define DEV_RATE_SHORT_PREAMBLE     0x0004

    unsigned short bitrate; /* In 100kbit/s */
    unsigned short ratemask;

    unsigned short plcp;
    unsigned short mcs;
};

extern const struct rt2x00_rate rt2x00_supported_rates[12];

static inline const struct rt2x00_rate *rt2x00_get_rate(const u16 hw_value)
{
    return &rt2x00_supported_rates[hw_value & 0xff];
}

#define RATE_MCS(__mode, __mcs) \
    ((((__mode) & 0x00ff) << 8) | ((__mcs) & 0x00ff))

static inline int rt2x00_get_rate_mcs(const u16 mcs_value)
{
    return (mcs_value & 0x00ff);
}

/*
 * Radio control handlers.
 */
int rt2x00lib_enable_radio(struct rt2x00_dev *rt2x00dev);
void rt2x00lib_disable_radio(struct rt2x00_dev *rt2x00dev);

/*
 * Initialization handlers.
 */
int rt2x00lib_start(struct rt2x00_dev *rt2x00dev);
void rt2x00lib_stop(struct rt2x00_dev *rt2x00dev);

/*
 * Configuration handlers.
 */
void rt2x00lib_config_intf(struct rt2x00_dev *rt2x00dev,
               struct rt2x00_intf *intf,
               enum nl80211_iftype type,
               const u8 *mac, const u8 *bssid);
void rt2x00lib_config_erp(struct rt2x00_dev *rt2x00dev,
              struct rt2x00_intf *intf,
              struct ieee80211_bss_conf *conf,
              u32 changed);
void rt2x00lib_config_antenna(struct rt2x00_dev *rt2x00dev,
                  struct antenna_setup ant);
void rt2x00lib_config(struct rt2x00_dev *rt2x00dev,
              struct ieee80211_conf *conf,
              const unsigned int changed_flags);

struct sk_buff *rt2x00queue_alloc_rxskb(struct queue_entry *entry, gfp_t gfp);

void rt2x00queue_free_skb(struct queue_entry *entry);

void rt2x00queue_align_frame(struct sk_buff *skb);

void rt2x00queue_insert_l2pad(struct sk_buff *skb, unsigned int header_length);

void rt2x00queue_remove_l2pad(struct sk_buff *skb, unsigned int header_length);

int rt2x00queue_write_tx_frame(struct data_queue *queue, struct sk_buff *skb,
                   bool local);

int rt2x00queue_update_beacon(struct rt2x00_dev *rt2x00dev,
                  struct ieee80211_vif *vif);

int rt2x00queue_update_beacon_locked(struct rt2x00_dev *rt2x00dev,
                     struct ieee80211_vif *vif);

int rt2x00queue_clear_beacon(struct rt2x00_dev *rt2x00dev,
                 struct ieee80211_vif *vif);

void rt2x00queue_index_inc(struct queue_entry *entry, enum queue_index index);

void rt2x00queue_init_queues(struct rt2x00_dev *rt2x00dev);

int rt2x00queue_initialize(struct rt2x00_dev *rt2x00dev);
void rt2x00queue_uninitialize(struct rt2x00_dev *rt2x00dev);
int rt2x00queue_allocate(struct rt2x00_dev *rt2x00dev);
void rt2x00queue_free(struct rt2x00_dev *rt2x00dev);

void rt2x00link_update_stats(struct rt2x00_dev *rt2x00dev,
                 struct sk_buff *skb,
                 struct rxdone_entry_desc *rxdesc);

void rt2x00link_start_tuner(struct rt2x00_dev *rt2x00dev);

void rt2x00link_stop_tuner(struct rt2x00_dev *rt2x00dev);

void rt2x00link_reset_tuner(struct rt2x00_dev *rt2x00dev, bool antenna);

void rt2x00link_start_watchdog(struct rt2x00_dev *rt2x00dev);

void rt2x00link_stop_watchdog(struct rt2x00_dev *rt2x00dev);

void rt2x00link_start_agc(struct rt2x00_dev *rt2x00dev);

void rt2x00link_start_vcocal(struct rt2x00_dev *rt2x00dev);

void rt2x00link_stop_agc(struct rt2x00_dev *rt2x00dev);

void rt2x00link_stop_vcocal(struct rt2x00_dev *rt2x00dev);

void rt2x00link_register(struct rt2x00_dev *rt2x00dev);

/*
 * Firmware handlers.
 */
#ifdef CONFIG_RT2X00_LIB_FIRMWARE
int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev);
void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev);
#else
static inline int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev)
{
    return 0;
}
static inline void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev)
{
}
#endif /* CONFIG_RT2X00_LIB_FIRMWARE */

/*
 * Debugfs handlers.
 */
#ifdef CONFIG_RT2X00_LIB_DEBUGFS
void rt2x00debug_register(struct rt2x00_dev *rt2x00dev);
void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev);
void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
                   struct rxdone_entry_desc *rxdesc);
#else
static inline void rt2x00debug_register(struct rt2x00_dev *rt2x00dev)
{
}

static inline void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev)
{
}

static inline void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
                         struct rxdone_entry_desc *rxdesc)
{
}
#endif /* CONFIG_RT2X00_LIB_DEBUGFS */

/*
 * Crypto handlers.
 */
#ifdef CONFIG_RT2X00_LIB_CRYPTO
enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key);
void rt2x00crypto_create_tx_descriptor(struct rt2x00_dev *rt2x00dev,
                       struct sk_buff *skb,
                       struct txentry_desc *txdesc);
unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev,
                      struct sk_buff *skb);
void rt2x00crypto_tx_copy_iv(struct sk_buff *skb,
                 struct txentry_desc *txdesc);
void rt2x00crypto_tx_remove_iv(struct sk_buff *skb,
                   struct txentry_desc *txdesc);
void rt2x00crypto_tx_insert_iv(struct sk_buff *skb, unsigned int header_length);
void rt2x00crypto_rx_insert_iv(struct sk_buff *skb,
                   unsigned int header_length,
                   struct rxdone_entry_desc *rxdesc);
#else
static inline enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key)
{
    return CIPHER_NONE;
}

static inline void rt2x00crypto_create_tx_descriptor(struct rt2x00_dev *rt2x00dev,
                             struct sk_buff *skb,
                             struct txentry_desc *txdesc)
{
}

static inline unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev,
                            struct sk_buff *skb)
{
    return 0;
}

static inline void rt2x00crypto_tx_copy_iv(struct sk_buff *skb,
                       struct txentry_desc *txdesc)
{
}

static inline void rt2x00crypto_tx_remove_iv(struct sk_buff *skb,
                         struct txentry_desc *txdesc)
{
}

static inline void rt2x00crypto_tx_insert_iv(struct sk_buff *skb,
                         unsigned int header_length)
{
}

static inline void rt2x00crypto_rx_insert_iv(struct sk_buff *skb,
                         unsigned int header_length,
                         struct rxdone_entry_desc *rxdesc)
{
}
#endif /* CONFIG_RT2X00_LIB_CRYPTO */

/*
 * RFkill handlers.
 */
static inline void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev)
{
    if (test_bit(CAPABILITY_HW_BUTTON, &rt2x00dev->cap_flags))
        wiphy_rfkill_start_polling(rt2x00dev->hw->wiphy);
}

static inline void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev)
{
    if (test_bit(CAPABILITY_HW_BUTTON, &rt2x00dev->cap_flags))
        wiphy_rfkill_stop_polling(rt2x00dev->hw->wiphy);
}

/*
 * LED handlers
 */
#ifdef CONFIG_RT2X00_LIB_LEDS
void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev, int rssi);
void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev, bool enabled);
void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev, bool enabled);
void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev, bool enabled);
void rt2x00leds_register(struct rt2x00_dev *rt2x00dev);
void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev);
void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev);
void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev);
#else
static inline void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev,
                      int rssi)
{
}

static inline void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev,
                      bool enabled)
{
}

static inline void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev,
                    bool enabled)
{
}

static inline void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev,
                    bool enabled)
{
}

static inline void rt2x00leds_register(struct rt2x00_dev *rt2x00dev)
{
}

static inline void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev)
{
}

static inline void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev)
{
}

static inline void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev)
{
}
#endif /* CONFIG_RT2X00_LIB_LEDS */

#endif /* RT2X00LIB_H */