LXR linux/drivers/net/wireless/ath/ar9170/ar9170.h

   1/*
   2 * Atheros AR9170 driver
   3 *
   4 * Driver specific definitions
   5 *
   6 * Copyright 2008, Johannes Berg <johannes@sipsolutions.net>
   7 *
   8 * This program is free software; you can redistribute it and/or modify
   9 * it under the terms of the GNU General Public License as published by
  10 * the Free Software Foundation; either version 2 of the License, or
  11 * (at your option) any later version.
  12 *
  13 * This program is distributed in the hope that it will be useful,
  14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 * GNU General Public License for more details.
  17 *
  18 * You should have received a copy of the GNU General Public License
  19 * along with this program; see the file COPYING.  If not, see
  20 * http://www.gnu.org/licenses/.
  21 *
  22 * This file incorporates work covered by the following copyright and
  23 * permission notice:
  24 *    Copyright (c) 2007-2008 Atheros Communications, Inc.
  25 *
  26 *    Permission to use, copy, modify, and/or distribute this software for any
  27 *    purpose with or without fee is hereby granted, provided that the above
  28 *    copyright notice and this permission notice appear in all copies.
  29 *
  30 *    THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  31 *    WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  32 *    MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  33 *    ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  34 *    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  35 *    ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  36 *    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  37 */
  38#ifndef __AR9170_H
  39#define __AR9170_H
  40
  41#include <linux/completion.h>
  42#include <linux/spinlock.h>
  43#include <net/cfg80211.h>
  44#include <net/mac80211.h>
  45#ifdef CONFIG_AR9170_LEDS
  46#include <linux/leds.h>
  47#endif /* CONFIG_AR9170_LEDS */
  48#include "eeprom.h"
  49#include "hw.h"
  50
  51#include "../regd.h"
  52
  53#define PAYLOAD_MAX     (AR9170_MAX_CMD_LEN/4 - 1)
  54
  55enum ar9170_bw {
  56        AR9170_BW_20,
  57        AR9170_BW_40_BELOW,
  58        AR9170_BW_40_ABOVE,
  59
  60        __AR9170_NUM_BW,
  61};
  62
  63static inline enum ar9170_bw nl80211_to_ar9170(enum nl80211_channel_type type)
  64{
  65        switch (type) {
  66        case NL80211_CHAN_NO_HT:
  67        case NL80211_CHAN_HT20:
  68                return AR9170_BW_20;
  69        case NL80211_CHAN_HT40MINUS:
  70                return AR9170_BW_40_BELOW;
  71        case NL80211_CHAN_HT40PLUS:
  72                return AR9170_BW_40_ABOVE;
  73        default:
  74                BUG();
  75        }
  76}
  77
  78enum ar9170_rf_init_mode {
  79        AR9170_RFI_NONE,
  80        AR9170_RFI_WARM,
  81        AR9170_RFI_COLD,
  82};
  83
  84#define AR9170_MAX_RX_BUFFER_SIZE               8192
  85
  86#ifdef CONFIG_AR9170_LEDS
  87struct ar9170;
  88
  89struct ar9170_led {
  90        struct ar9170 *ar;
  91        struct led_classdev l;
  92        char name[32];
  93        unsigned int toggled;
  94        bool last_state;
  95        bool registered;
  96};
  97
  98#endif /* CONFIG_AR9170_LEDS */
  99
 100enum ar9170_device_state {
 101        AR9170_UNKNOWN_STATE,
 102        AR9170_STOPPED,
 103        AR9170_IDLE,
 104        AR9170_STARTED,
 105};
 106
 107struct ar9170_rxstream_mpdu_merge {
 108        struct ar9170_rx_head plcp;
 109        bool has_plcp;
 110};
 111
 112#define AR9170_NUM_MAX_BA_RETRY 5
 113#define AR9170_NUM_TID  16
 114#define WME_BA_BMP_SIZE         64
 115#define AR9170_NUM_MAX_AGG_LEN  (2 * WME_BA_BMP_SIZE)
 116
 117#define WME_AC_BE   2
 118#define WME_AC_BK   3
 119#define WME_AC_VI   1
 120#define WME_AC_VO   0
 121
 122#define TID_TO_WME_AC(_tid)                             \
 123        ((((_tid) == 0) || ((_tid) == 3)) ? WME_AC_BE : \
 124         (((_tid) == 1) || ((_tid) == 2)) ? WME_AC_BK : \
 125         (((_tid) == 4) || ((_tid) == 5)) ? WME_AC_VI : \
 126         WME_AC_VO)
 127
 128#define BAW_WITHIN(_start, _bawsz, _seqno) \
 129        ((((_seqno) - (_start)) & 0xfff) < (_bawsz))
 130
 131enum ar9170_tid_state {
 132        AR9170_TID_STATE_INVALID,
 133        AR9170_TID_STATE_SHUTDOWN,
 134        AR9170_TID_STATE_PROGRESS,
 135        AR9170_TID_STATE_COMPLETE,
 136};
 137
 138struct ar9170_sta_tid {
 139        struct list_head list;
 140        struct sk_buff_head queue;
 141        u8 addr[ETH_ALEN];
 142        u16 ssn;
 143        u16 tid;
 144        enum ar9170_tid_state state;
 145        bool active;
 146        u8 retry;
 147};
 148
 149#define AR9170_QUEUE_TIMEOUT            64
 150#define AR9170_TX_TIMEOUT               8
 151#define AR9170_BA_TIMEOUT               4
 152#define AR9170_JANITOR_DELAY            128
 153#define AR9170_TX_INVALID_RATE          0xffffffff
 154
 155#define AR9170_NUM_TX_STATUS            128
 156#define AR9170_NUM_TX_AGG_MAX           30
 157
 158struct ar9170 {
 159        struct ieee80211_hw *hw;
 160        struct ath_common common;
 161        struct mutex mutex;
 162        enum ar9170_device_state state;
 163        unsigned long bad_hw_nagger;
 164
 165        int (*open)(struct ar9170 *);
 166        void (*stop)(struct ar9170 *);
 167        int (*tx)(struct ar9170 *, struct sk_buff *);
 168        int (*exec_cmd)(struct ar9170 *, enum ar9170_cmd, u32 ,
 169                        void *, u32 , void *);
 170        void (*callback_cmd)(struct ar9170 *, u32 , void *);
 171        int (*flush)(struct ar9170 *);
 172
 173        /* interface mode settings */
 174        struct ieee80211_vif *vif;
 175        u8 mac_addr[ETH_ALEN];
 176        u8 bssid[ETH_ALEN];
 177
 178        /* beaconing */
 179        struct sk_buff *beacon;
 180        struct work_struct beacon_work;
 181        bool enable_beacon;
 182
 183        /* cryptographic engine */
 184        u64 usedkeys;
 185        bool rx_software_decryption;
 186        bool disable_offload;
 187
 188        /* filter settings */
 189        u64 cur_mc_hash;
 190        u32 cur_filter;
 191        unsigned int filter_state;
 192        bool sniffer_enabled;
 193
 194        /* PHY */
 195        struct ieee80211_channel *channel;
 196        int noise[4];
 197
 198        /* power calibration data */
 199        u8 power_5G_leg[4];
 200        u8 power_2G_cck[4];
 201        u8 power_2G_ofdm[4];
 202        u8 power_5G_ht20[8];
 203        u8 power_5G_ht40[8];
 204        u8 power_2G_ht20[8];
 205        u8 power_2G_ht40[8];
 206
 207#ifdef CONFIG_AR9170_LEDS
 208        struct delayed_work led_work;
 209        struct ar9170_led leds[AR9170_NUM_LEDS];
 210#endif /* CONFIG_AR9170_LEDS */
 211
 212        /* qos queue settings */
 213        spinlock_t tx_stats_lock;
 214        struct ieee80211_tx_queue_stats tx_stats[5];
 215        struct ieee80211_tx_queue_params edcf[5];
 216
 217        spinlock_t cmdlock;
 218        __le32 cmdbuf[PAYLOAD_MAX + 1];
 219
 220        /* MAC statistics */
 221        struct ieee80211_low_level_stats stats;
 222
 223        /* EEPROM */
 224        struct ar9170_eeprom eeprom;
 225
 226        /* tx queues - as seen by hw - */
 227        struct sk_buff_head tx_pending[__AR9170_NUM_TXQ];
 228        struct sk_buff_head tx_status[__AR9170_NUM_TXQ];
 229        struct delayed_work tx_janitor;
 230        /* tx ampdu */
 231        struct sk_buff_head tx_status_ampdu;
 232        spinlock_t tx_ampdu_list_lock;
 233        struct list_head tx_ampdu_list;
 234        unsigned int tx_ampdu_pending;
 235
 236        /* rxstream mpdu merge */
 237        struct ar9170_rxstream_mpdu_merge rx_mpdu;
 238        struct sk_buff *rx_failover;
 239        int rx_failover_missing;
 240
 241        /* (cached) HW A-MPDU settings */
 242        u8 global_ampdu_density;
 243        u8 global_ampdu_factor;
 244};
 245
 246struct ar9170_sta_info {
 247        struct ar9170_sta_tid agg[AR9170_NUM_TID];
 248        unsigned int ampdu_max_len;
 249};
 250
 251#define AR9170_TX_FLAG_WAIT_FOR_ACK     BIT(0)
 252#define AR9170_TX_FLAG_NO_ACK           BIT(1)
 253#define AR9170_TX_FLAG_BLOCK_ACK        BIT(2)
 254
 255struct ar9170_tx_info {
 256        unsigned long timeout;
 257        unsigned int flags;
 258};
 259
 260#define IS_STARTED(a)           (((struct ar9170 *)a)->state >= AR9170_STARTED)
 261#define IS_ACCEPTING_CMD(a)     (((struct ar9170 *)a)->state >= AR9170_IDLE)
 262
 263/* exported interface */
 264void *ar9170_alloc(size_t priv_size);
 265int ar9170_register(struct ar9170 *ar, struct device *pdev);
 266void ar9170_rx(struct ar9170 *ar, struct sk_buff *skb);
 267void ar9170_unregister(struct ar9170 *ar);
 268void ar9170_tx_callback(struct ar9170 *ar, struct sk_buff *skb);
 269void ar9170_handle_command_response(struct ar9170 *ar, void *buf, u32 len);
 270int ar9170_nag_limiter(struct ar9170 *ar);
 271
 272/* MAC */
 273int ar9170_op_tx(struct ieee80211_hw *hw, struct sk_buff *skb);
 274int ar9170_init_mac(struct ar9170 *ar);
 275int ar9170_set_qos(struct ar9170 *ar);
 276int ar9170_update_multicast(struct ar9170 *ar, const u64 mc_hast);
 277int ar9170_update_frame_filter(struct ar9170 *ar, const u32 filter);
 278int ar9170_set_operating_mode(struct ar9170 *ar);
 279int ar9170_set_beacon_timers(struct ar9170 *ar);
 280int ar9170_set_dyn_sifs_ack(struct ar9170 *ar);
 281int ar9170_set_slot_time(struct ar9170 *ar);
 282int ar9170_set_basic_rates(struct ar9170 *ar);
 283int ar9170_set_hwretry_limit(struct ar9170 *ar, u32 max_retry);
 284int ar9170_update_beacon(struct ar9170 *ar);
 285void ar9170_new_beacon(struct work_struct *work);
 286int ar9170_upload_key(struct ar9170 *ar, u8 id, const u8 *mac, u8 ktype,
 287                      u8 keyidx, u8 *keydata, int keylen);
 288int ar9170_disable_key(struct ar9170 *ar, u8 id);
 289
 290/* LEDs */
 291#ifdef CONFIG_AR9170_LEDS
 292int ar9170_register_leds(struct ar9170 *ar);
 293void ar9170_unregister_leds(struct ar9170 *ar);
 294#endif /* CONFIG_AR9170_LEDS */
 295int ar9170_init_leds(struct ar9170 *ar);
 296int ar9170_set_leds_state(struct ar9170 *ar, u32 led_state);
 297
 298/* PHY / RF */
 299int ar9170_init_phy(struct ar9170 *ar, enum ieee80211_band band);
 300int ar9170_init_rf(struct ar9170 *ar);
 301int ar9170_set_channel(struct ar9170 *ar, struct ieee80211_channel *channel,
 302                       enum ar9170_rf_init_mode rfi, enum ar9170_bw bw);
 303
 304#endif /* __AR9170_H */
 305