drivers/net/wireless/ath/ath.h

   1 /*
   2  * Copyright (c) 2008-2009 Atheros Communications Inc.
   3  *
   4  * Permission to use, copy, modify, and/or distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15  */
  16
  17 #ifndef ATH_H
  18 #define ATH_H
  19
  20 #include <linux/skbuff.h>
  21 #include <linux/if_ether.h>
  22 #include <linux/spinlock.h>
  23 #include <net/mac80211.h>
  24
  25 /*
  26  * The key cache is used for h/w cipher state and also for
  27  * tracking station state such as the current tx antenna.
  28  * We also setup a mapping table between key cache slot indices
  29  * and station state to short-circuit node lookups on rx.
  30  * Different parts have different size key caches.  We handle
  31  * up to ATH_KEYMAX entries (could dynamically allocate state).
  32  */
  33 #define ATH_KEYMAX              128     /* max key cache size we handle */
  34
  35 static const u8 ath_bcast_mac[ETH_ALEN] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
  36
  37 struct ath_ani {
  38         bool caldone;
  39         unsigned int longcal_timer;
  40         unsigned int shortcal_timer;
  41         unsigned int resetcal_timer;
  42         unsigned int checkani_timer;
  43         struct timer_list timer;
  44 };
  45
  46 struct ath_cycle_counters {
  47         u32 cycles;
  48         u32 rx_busy;
  49         u32 rx_frame;
  50         u32 tx_frame;
  51 };
  52
  53 enum ath_device_state {
  54         ATH_HW_UNAVAILABLE,
  55         ATH_HW_INITIALIZED,
  56 };
  57
  58 enum ath_bus_type {
  59         ATH_PCI,
  60         ATH_AHB,
  61         ATH_USB,
  62 };
  63
  64 struct reg_dmn_pair_mapping {
  65         u16 regDmnEnum;
  66         u16 reg_5ghz_ctl;
  67         u16 reg_2ghz_ctl;
  68 };
  69
  70 struct ath_regulatory {
  71         char alpha2[2];
  72         u16 country_code;
  73         u16 max_power_level;
  74         u16 current_rd;
  75         int16_t power_limit;
  76         struct reg_dmn_pair_mapping *regpair;
  77 };
  78
  79 enum ath_crypt_caps {
  80         ATH_CRYPT_CAP_CIPHER_AESCCM             = BIT(0),
  81         ATH_CRYPT_CAP_MIC_COMBINED              = BIT(1),
  82 };
  83
  84 struct ath_keyval {
  85         u8 kv_type;
  86         u8 kv_pad;
  87         u16 kv_len;
  88         u8 kv_val[16]; /* TK */
  89         u8 kv_mic[8]; /* Michael MIC key */
  90         u8 kv_txmic[8]; /* Michael MIC TX key (used only if the hardware
  91                          * supports both MIC keys in the same key cache entry;
  92                          * in that case, kv_mic is the RX key) */
  93 };
  94
  95 enum ath_cipher {
  96         ATH_CIPHER_WEP = 0,
  97         ATH_CIPHER_AES_OCB = 1,
  98         ATH_CIPHER_AES_CCM = 2,
  99         ATH_CIPHER_CKIP = 3,
 100         ATH_CIPHER_TKIP = 4,
 101         ATH_CIPHER_CLR = 5,
 102         ATH_CIPHER_MIC = 127
 103 };
 104
 105 /**
 106  * struct ath_ops - Register read/write operations
 107  *
 108  * @read: Register read
 109  * @multi_read: Multiple register read
 110  * @write: Register write
 111  * @enable_write_buffer: Enable multiple register writes
 112  * @write_flush: flush buffered register writes and disable buffering
 113  */
 114 struct ath_ops {
 115         unsigned int (*read)(void *, u32 reg_offset);
 116         void (*multi_read)(void *, u32 *addr, u32 *val, u16 count);
 117         void (*write)(void *, u32 val, u32 reg_offset);
 118         void (*enable_write_buffer)(void *);
 119         void (*write_flush) (void *);
 120         u32 (*rmw)(void *, u32 reg_offset, u32 set, u32 clr);
 121 };
 122
 123 struct ath_common;
 124 struct ath_bus_ops;
 125
 126 struct ath_common {
 127         void *ah;
 128         void *priv;
 129         struct ieee80211_hw *hw;
 130         int debug_mask;
 131         enum ath_device_state state;
 132
 133         struct ath_ani ani;
 134
 135         u16 cachelsz;
 136         u16 curaid;
 137         u8 macaddr[ETH_ALEN];
 138         u8 curbssid[ETH_ALEN];
 139         u8 bssidmask[ETH_ALEN];
 140
 141         u32 rx_bufsize;
 142
 143         u32 keymax;
 144         DECLARE_BITMAP(keymap, ATH_KEYMAX);
 145         DECLARE_BITMAP(tkip_keymap, ATH_KEYMAX);
 146         enum ath_crypt_caps crypt_caps;
 147
 148         unsigned int clockrate;
 149
 150         spinlock_t cc_lock;
 151         struct ath_cycle_counters cc_ani;
 152         struct ath_cycle_counters cc_survey;
 153
 154         struct ath_regulatory regulatory;
 155         struct ath_regulatory reg_world_copy;
 156         const struct ath_ops *ops;
 157         const struct ath_bus_ops *bus_ops;
 158
 159         bool btcoex_enabled;
 160         bool disable_ani;
 161 };
 162
 163 struct sk_buff *ath_rxbuf_alloc(struct ath_common *common,
 164                                 u32 len,
 165                                 gfp_t gfp_mask);
 166
 167 void ath_hw_setbssidmask(struct ath_common *common);
 168 void ath_key_delete(struct ath_common *common, struct ieee80211_key_conf *key);
 169 int ath_key_config(struct ath_common *common,
 170                           struct ieee80211_vif *vif,
 171                           struct ieee80211_sta *sta,
 172                           struct ieee80211_key_conf *key);
 173 bool ath_hw_keyreset(struct ath_common *common, u16 entry);
 174 void ath_hw_cycle_counters_update(struct ath_common *common);
 175 int32_t ath_hw_get_listen_time(struct ath_common *common);
 176
 177 extern __printf(2, 3) void ath_printk(const char *level, const char *fmt, ...);
 178
 179 #define _ath_printk(level, common, fmt, ...)                    \
 180 do {                                                            \
 181         __always_unused struct ath_common *unused = common;     \
 182         ath_printk(level, fmt, ##__VA_ARGS__);                  \
 183 } while (0)
 184
 185 #define ath_emerg(common, fmt, ...)                             \
 186         _ath_printk(KERN_EMERG, common, fmt, ##__VA_ARGS__)
 187 #define ath_alert(common, fmt, ...)                             \
 188         _ath_printk(KERN_ALERT, common, fmt, ##__VA_ARGS__)
 189 #define ath_crit(common, fmt, ...)                              \
 190         _ath_printk(KERN_CRIT, common, fmt, ##__VA_ARGS__)
 191 #define ath_err(common, fmt, ...)                               \
 192         _ath_printk(KERN_ERR, common, fmt, ##__VA_ARGS__)
 193 #define ath_warn(common, fmt, ...)                              \
 194         _ath_printk(KERN_WARNING, common, fmt, ##__VA_ARGS__)
 195 #define ath_notice(common, fmt, ...)                            \
 196         _ath_printk(KERN_NOTICE, common, fmt, ##__VA_ARGS__)
 197 #define ath_info(common, fmt, ...)                              \
 198         _ath_printk(KERN_INFO, common, fmt, ##__VA_ARGS__)
 199
 200 /**
 201  * enum ath_debug_level - atheros wireless debug level
 202  *
 203  * @ATH_DBG_RESET: reset processing
 204  * @ATH_DBG_QUEUE: hardware queue management
 205  * @ATH_DBG_EEPROM: eeprom processing
 206  * @ATH_DBG_CALIBRATE: periodic calibration
 207  * @ATH_DBG_INTERRUPT: interrupt processing
 208  * @ATH_DBG_REGULATORY: regulatory processing
 209  * @ATH_DBG_ANI: adaptive noise immunitive processing
 210  * @ATH_DBG_XMIT: basic xmit operation
 211  * @ATH_DBG_BEACON: beacon handling
 212  * @ATH_DBG_CONFIG: configuration of the hardware
 213  * @ATH_DBG_FATAL: fatal errors, this is the default, DBG_DEFAULT
 214  * @ATH_DBG_PS: power save processing
 215  * @ATH_DBG_HWTIMER: hardware timer handling
 216  * @ATH_DBG_BTCOEX: bluetooth coexistance
 217  * @ATH_DBG_BSTUCK: stuck beacons
 218  * @ATH_DBG_MCI: Message Coexistence Interface, a private protocol
 219  *      used exclusively for WLAN-BT coexistence starting from
 220  *      AR9462.
 221  * @ATH_DBG_DFS: radar datection
 222  * @ATH_DBG_ANY: enable all debugging
 223  *
 224  * The debug level is used to control the amount and type of debugging output
 225  * we want to see. Each driver has its own method for enabling debugging and
 226  * modifying debug level states -- but this is typically done through a
 227  * module parameter 'debug' along with a respective 'debug' debugfs file
 228  * entry.
 229  */
 230 enum ATH_DEBUG {
 231         ATH_DBG_RESET           = 0x00000001,
 232         ATH_DBG_QUEUE           = 0x00000002,
 233         ATH_DBG_EEPROM          = 0x00000004,
 234         ATH_DBG_CALIBRATE       = 0x00000008,
 235         ATH_DBG_INTERRUPT       = 0x00000010,
 236         ATH_DBG_REGULATORY      = 0x00000020,
 237         ATH_DBG_ANI             = 0x00000040,
 238         ATH_DBG_XMIT            = 0x00000080,
 239         ATH_DBG_BEACON          = 0x00000100,
 240         ATH_DBG_CONFIG          = 0x00000200,
 241         ATH_DBG_FATAL           = 0x00000400,
 242         ATH_DBG_PS              = 0x00000800,
 243         ATH_DBG_HWTIMER         = 0x00001000,
 244         ATH_DBG_BTCOEX          = 0x00002000,
 245         ATH_DBG_WMI             = 0x00004000,
 246         ATH_DBG_BSTUCK          = 0x00008000,
 247         ATH_DBG_MCI             = 0x00010000,
 248         ATH_DBG_DFS             = 0x00020000,
 249         ATH_DBG_ANY             = 0xffffffff
 250 };
 251
 252 #define ATH_DBG_DEFAULT (ATH_DBG_FATAL)
 253
 254 #ifdef CONFIG_ATH_DEBUG
 255
 256 #define ath_dbg(common, dbg_mask, fmt, ...)                             \
 257 do {                                                                    \
 258         if ((common)->debug_mask & ATH_DBG_##dbg_mask)                  \
 259                 _ath_printk(KERN_DEBUG, common, fmt, ##__VA_ARGS__);    \
 260 } while (0)
 261
 262 #define ATH_DBG_WARN(foo, arg...) WARN(foo, arg)
 263 #define ATH_DBG_WARN_ON_ONCE(foo) WARN_ON_ONCE(foo)
 264
 265 #else
 266
 267 static inline  __attribute__ ((format (printf, 3, 4)))
 268 void _ath_dbg(struct ath_common *common, enum ATH_DEBUG dbg_mask,
 269              const char *fmt, ...)
 270 {
 271 }
 272 #define ath_dbg(common, dbg_mask, fmt, ...)                             \
 273         _ath_dbg(common, ATH_DBG_##dbg_mask, fmt, ##__VA_ARGS__)
 274
 275 #define ATH_DBG_WARN(foo, arg...) do {} while (0)
 276 #define ATH_DBG_WARN_ON_ONCE(foo) ({                            \
 277         int __ret_warn_once = !!(foo);                          \
 278         unlikely(__ret_warn_once);                              \
 279 })
 280
 281 #endif /* CONFIG_ATH_DEBUG */
 282
 283 /** Returns string describing opmode, or NULL if unknown mode. */
 284 #ifdef CONFIG_ATH_DEBUG
 285 const char *ath_opmode_to_string(enum nl80211_iftype opmode);
 286 #else
 287 static inline const char *ath_opmode_to_string(enum nl80211_iftype opmode)
 288 {
 289         return "UNKNOWN";
 290 }
 291 #endif
 292
 293 #endif /* ATH_H */