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
  55 enum ar9170_bw {
  56         AR9170_BW_20,
  57         AR9170_BW_40_BELOW,
  58         AR9170_BW_40_ABOVE,
  59
  60         __AR9170_NUM_BW,
  61 };
  62
  63 static 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
  78 enum 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
  87 struct ar9170;
  88
  89 struct 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
 100 enum ar9170_device_state {
 101         AR9170_UNKNOWN_STATE,
 102         AR9170_STOPPED,
 103         AR9170_IDLE,
 104         AR9170_STARTED,
 105 };
 106
 107 struct ar9170_rxstream_mpdu_merge {
 108         struct ar9170_rx_head plcp;
 109         bool has_plcp;
 110 };
 111
 112 #define AR9170_NUM_TID  16
 113 #define WME_BA_BMP_SIZE         64
 114 #define AR9170_NUM_MAX_AGG_LEN  (2 * WME_BA_BMP_SIZE)
 115
 116 #define WME_AC_BE   2
 117 #define WME_AC_BK   3
 118 #define WME_AC_VI   1
 119 #define WME_AC_VO   0
 120
 121 #define TID_TO_WME_AC(_tid)                             \
 122         ((((_tid) == 0) || ((_tid) == 3)) ? WME_AC_BE : \
 123          (((_tid) == 1) || ((_tid) == 2)) ? WME_AC_BK : \
 124          (((_tid) == 4) || ((_tid) == 5)) ? WME_AC_VI : \
 125          WME_AC_VO)
 126
 127 #define BAW_WITHIN(_start, _bawsz, _seqno) \
 128         ((((_seqno) - (_start)) & 0xfff) < (_bawsz))
 129
 130 enum ar9170_tid_state {
 131         AR9170_TID_STATE_INVALID,
 132         AR9170_TID_STATE_SHUTDOWN,
 133         AR9170_TID_STATE_PROGRESS,
 134         AR9170_TID_STATE_COMPLETE,
 135 };
 136
 137 struct ar9170_sta_tid {
 138         struct list_head list;
 139         struct sk_buff_head queue;
 140         u8 addr[ETH_ALEN];
 141         u16 ssn;
 142         u16 tid;
 143         enum ar9170_tid_state state;
 144         bool active;
 145 };
 146
 147 struct ar9170_tx_queue_stats {
 148         unsigned int len;
 149         unsigned int limit;
 150         unsigned int count;
 151 };
 152
 153 #define AR9170_QUEUE_TIMEOUT            64
 154 #define AR9170_TX_TIMEOUT               8
 155 #define AR9170_BA_TIMEOUT               4
 156 #define AR9170_JANITOR_DELAY            128
 157 #define AR9170_TX_INVALID_RATE          0xffffffff
 158
 159 #define AR9170_NUM_TX_STATUS            128
 160 #define AR9170_NUM_TX_AGG_MAX           30
 161 #define AR9170_NUM_TX_LIMIT_HARD       AR9170_TXQ_DEPTH
 162 #define AR9170_NUM_TX_LIMIT_SOFT       (AR9170_TXQ_DEPTH - 10)
 163
 164 struct ar9170 {
 165         struct ieee80211_hw *hw;
 166         struct ath_common common;
 167         struct mutex mutex;
 168         enum ar9170_device_state state;
 169         bool registered;
 170         unsigned long bad_hw_nagger;
 171
 172         int (*open)(struct ar9170 *);
 173         void (*stop)(struct ar9170 *);
 174         int (*tx)(struct ar9170 *, struct sk_buff *);
 175         int (*exec_cmd)(struct ar9170 *, enum ar9170_cmd, u32 ,
 176                         void *, u32 , void *);
 177         void (*callback_cmd)(struct ar9170 *, u32 , void *);
 178         int (*flush)(struct ar9170 *);
 179
 180         /* interface mode settings */
 181         struct ieee80211_vif *vif;
 182
 183         /* beaconing */
 184         struct sk_buff *beacon;
 185         struct work_struct beacon_work;
 186         bool enable_beacon;
 187
 188         /* cryptographic engine */
 189         u64 usedkeys;
 190         bool rx_software_decryption;
 191         bool disable_offload;
 192
 193         /* filter settings */
 194         u64 cur_mc_hash;
 195         u32 cur_filter;
 196         unsigned int filter_state;
 197         bool sniffer_enabled;
 198
 199         /* PHY */
 200         struct ieee80211_channel *channel;
 201         int noise[4];
 202
 203         /* power calibration data */
 204         u8 power_5G_leg[4];
 205         u8 power_2G_cck[4];
 206         u8 power_2G_ofdm[4];
 207         u8 power_5G_ht20[8];
 208         u8 power_5G_ht40[8];
 209         u8 power_2G_ht20[8];
 210         u8 power_2G_ht40[8];
 211
 212         u8 phy_heavy_clip;
 213
 214 #ifdef CONFIG_AR9170_LEDS
 215         struct delayed_work led_work;
 216         struct ar9170_led leds[AR9170_NUM_LEDS];
 217 #endif /* CONFIG_AR9170_LEDS */
 218
 219         /* qos queue settings */
 220         spinlock_t tx_stats_lock;
 221         struct ar9170_tx_queue_stats tx_stats[5];
 222         struct ieee80211_tx_queue_params edcf[5];
 223
 224         spinlock_t cmdlock;
 225         __le32 cmdbuf[PAYLOAD_MAX + 1];
 226
 227         /* MAC statistics */
 228         struct ieee80211_low_level_stats stats;
 229
 230         /* EEPROM */
 231         struct ar9170_eeprom eeprom;
 232
 233         /* tx queues - as seen by hw - */
 234         struct sk_buff_head tx_pending[__AR9170_NUM_TXQ];
 235         struct sk_buff_head tx_status[__AR9170_NUM_TXQ];
 236         struct delayed_work tx_janitor;
 237         /* tx ampdu */
 238         struct sk_buff_head tx_status_ampdu;
 239         spinlock_t tx_ampdu_list_lock;
 240         struct list_head tx_ampdu_list;
 241         atomic_t tx_ampdu_pending;
 242
 243         /* rxstream mpdu merge */
 244         struct ar9170_rxstream_mpdu_merge rx_mpdu;
 245         struct sk_buff *rx_failover;
 246         int rx_failover_missing;
 247
 248         /* (cached) HW A-MPDU settings */
 249         u8 global_ampdu_density;
 250         u8 global_ampdu_factor;
 251 };
 252
 253 struct ar9170_sta_info {
 254         struct ar9170_sta_tid agg[AR9170_NUM_TID];
 255         unsigned int ampdu_max_len;
 256 };
 257
 258 struct ar9170_tx_info {
 259         unsigned long timeout;
 260 };
 261
 262 #define IS_STARTED(a)           (((struct ar9170 *)a)->state >= AR9170_STARTED)
 263 #define IS_ACCEPTING_CMD(a)     (((struct ar9170 *)a)->state >= AR9170_IDLE)
 264
 265 /* exported interface */
 266 void *ar9170_alloc(size_t priv_size);
 267 int ar9170_register(struct ar9170 *ar, struct device *pdev);
 268 void ar9170_rx(struct ar9170 *ar, struct sk_buff *skb);
 269 void ar9170_unregister(struct ar9170 *ar);
 270 void ar9170_tx_callback(struct ar9170 *ar, struct sk_buff *skb);
 271 void ar9170_handle_command_response(struct ar9170 *ar, void *buf, u32 len);
 272 int ar9170_nag_limiter(struct ar9170 *ar);
 273
 274 /* MAC */
 275 int ar9170_op_tx(struct ieee80211_hw *hw, struct sk_buff *skb);
 276 int ar9170_init_mac(struct ar9170 *ar);
 277 int ar9170_set_qos(struct ar9170 *ar);
 278 int ar9170_update_multicast(struct ar9170 *ar, const u64 mc_hast);
 279 int ar9170_update_frame_filter(struct ar9170 *ar, const u32 filter);
 280 int ar9170_set_operating_mode(struct ar9170 *ar);
 281 int ar9170_set_beacon_timers(struct ar9170 *ar);
 282 int ar9170_set_dyn_sifs_ack(struct ar9170 *ar);
 283 int ar9170_set_slot_time(struct ar9170 *ar);
 284 int ar9170_set_basic_rates(struct ar9170 *ar);
 285 int ar9170_set_hwretry_limit(struct ar9170 *ar, u32 max_retry);
 286 int ar9170_update_beacon(struct ar9170 *ar);
 287 void ar9170_new_beacon(struct work_struct *work);
 288 int ar9170_upload_key(struct ar9170 *ar, u8 id, const u8 *mac, u8 ktype,
 289                       u8 keyidx, u8 *keydata, int keylen);
 290 int ar9170_disable_key(struct ar9170 *ar, u8 id);
 291
 292 /* LEDs */
 293 #ifdef CONFIG_AR9170_LEDS
 294 int ar9170_register_leds(struct ar9170 *ar);
 295 void ar9170_unregister_leds(struct ar9170 *ar);
 296 #endif /* CONFIG_AR9170_LEDS */
 297 int ar9170_init_leds(struct ar9170 *ar);
 298 int ar9170_set_leds_state(struct ar9170 *ar, u32 led_state);
 299
 300 /* PHY / RF */
 301 int ar9170_init_phy(struct ar9170 *ar, enum ieee80211_band band);
 302 int ar9170_init_rf(struct ar9170 *ar);
 303 int ar9170_set_channel(struct ar9170 *ar, struct ieee80211_channel *channel,
 304                        enum ar9170_rf_init_mode rfi, enum ar9170_bw bw);
 305
 306 #endif /* __AR9170_H */