| 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/etherdevice.h> |
| 21 |
#include <linux/skbuff.h> |
| 22 |
#include <linux/if_ether.h> |
| 23 |
#include <linux/spinlock.h> |
| 24 |
#include <net/mac80211.h> |
| 25 |
|
| 26 |
/* |
| 27 |
* The key cache is used for h/w cipher state and also for |
| 28 |
* tracking station state such as the current tx antenna. |
| 29 |
* We also setup a mapping table between key cache slot indices |
| 30 |
* and station state to short-circuit node lookups on rx. |
| 31 |
* Different parts have different size key caches. We handle |
| 32 |
* up to ATH_KEYMAX entries (could dynamically allocate state). |
| 33 |
*/ |
| 34 |
#define ATH_KEYMAX 128 /* max key cache size we handle */ |
| 35 |
|
| 36 |
struct ath_ani { |
| 37 |
bool caldone; |
| 38 |
unsigned int longcal_timer; |
| 39 |
unsigned int shortcal_timer; |
| 40 |
unsigned int resetcal_timer; |
| 41 |
unsigned int checkani_timer; |
| 42 |
struct timer_list timer; |
| 43 |
}; |
| 44 |
|
| 45 |
struct ath_cycle_counters { |
| 46 |
u32 cycles; |
| 47 |
u32 rx_busy; |
| 48 |
u32 rx_frame; |
| 49 |
u32 tx_frame; |
| 50 |
}; |
| 51 |
|
| 52 |
enum ath_device_state { |
| 53 |
ATH_HW_UNAVAILABLE, |
| 54 |
ATH_HW_INITIALIZED, |
| 55 |
}; |
| 56 |
|
| 57 |
enum ath_op_flags { |
| 58 |
ATH_OP_INVALID, |
| 59 |
ATH_OP_BEACONS, |
| 60 |
ATH_OP_ANI_RUN, |
| 61 |
ATH_OP_PRIM_STA_VIF, |
| 62 |
ATH_OP_HW_RESET, |
| 63 |
ATH_OP_SCANNING, |
| 64 |
ATH_OP_MULTI_CHANNEL, |
| 65 |
ATH_OP_WOW_ENABLED, |
| 66 |
}; |
| 67 |
|
| 68 |
enum ath_bus_type { |
| 69 |
ATH_PCI, |
| 70 |
ATH_AHB, |
| 71 |
ATH_USB, |
| 72 |
}; |
| 73 |
|
| 74 |
struct reg_dmn_pair_mapping { |
| 75 |
u16 reg_domain; |
| 76 |
u16 reg_5ghz_ctl; |
| 77 |
u16 reg_2ghz_ctl; |
| 78 |
}; |
| 79 |
|
| 80 |
struct ath_regulatory { |
| 81 |
char alpha2[2]; |
| 82 |
enum nl80211_dfs_regions region; |
| 83 |
u16 country_code; |
| 84 |
u16 max_power_level; |
| 85 |
u16 current_rd; |
| 86 |
int16_t power_limit; |
| 87 |
struct reg_dmn_pair_mapping *regpair; |
| 88 |
}; |
| 89 |
|
| 90 |
enum ath_crypt_caps { |
| 91 |
ATH_CRYPT_CAP_CIPHER_AESCCM = BIT(0), |
| 92 |
ATH_CRYPT_CAP_MIC_COMBINED = BIT(1), |
| 93 |
}; |
| 94 |
|
| 95 |
struct ath_keyval { |
| 96 |
u8 kv_type; |
| 97 |
u8 kv_pad; |
| 98 |
u16 kv_len; |
| 99 |
struct_group(kv_values, |
| 100 |
u8 kv_val[16]; /* TK */ |
| 101 |
u8 kv_mic[8]; /* Michael MIC key */ |
| 102 |
u8 kv_txmic[8]; /* Michael MIC TX key (used only if the hardware |
| 103 |
* supports both MIC keys in the same key cache entry; |
| 104 |
* in that case, kv_mic is the RX key) */ |
| 105 |
); |
| 106 |
}; |
| 107 |
|
| 108 |
enum ath_cipher { |
| 109 |
ATH_CIPHER_WEP = 0, |
| 110 |
ATH_CIPHER_AES_OCB = 1, |
| 111 |
ATH_CIPHER_AES_CCM = 2, |
| 112 |
ATH_CIPHER_CKIP = 3, |
| 113 |
ATH_CIPHER_TKIP = 4, |
| 114 |
ATH_CIPHER_CLR = 5, |
| 115 |
ATH_CIPHER_MIC = 127 |
| 116 |
}; |
| 117 |
|
| 118 |
/** |
| 119 |
* struct ath_ops - Register read/write operations |
| 120 |
* |
| 121 |
* @read: Register read |
| 122 |
* @multi_read: Multiple register read |
| 123 |
* @write: Register write |
| 124 |
* @enable_write_buffer: Enable multiple register writes |
| 125 |
* @write_flush: flush buffered register writes and disable buffering |
| 126 |
*/ |
| 127 |
struct ath_ops { |
| 128 |
unsigned int (*read)(void *, u32 reg_offset); |
| 129 |
void (*multi_read)(void *, u32 *addr, u32 *val, u16 count); |
| 130 |
void (*write)(void *, u32 val, u32 reg_offset); |
| 131 |
void (*enable_write_buffer)(void *); |
| 132 |
void (*write_flush) (void *); |
| 133 |
u32 (*rmw)(void *, u32 reg_offset, u32 set, u32 clr); |
| 134 |
void (*enable_rmw_buffer)(void *); |
| 135 |
void (*rmw_flush) (void *); |
| 136 |
|
| 137 |
}; |
| 138 |
|
| 139 |
struct ath_common; |
| 140 |
struct ath_bus_ops; |
| 141 |
|
| 142 |
struct ath_ps_ops { |
| 143 |
void (*wakeup)(struct ath_common *common); |
| 144 |
void (*restore)(struct ath_common *common); |
| 145 |
}; |
| 146 |
|
| 147 |
struct ath_common { |
| 148 |
void *ah; |
| 149 |
void *priv; |
| 150 |
struct ieee80211_hw *hw; |
| 151 |
int debug_mask; |
| 152 |
enum ath_device_state state; |
| 153 |
unsigned long op_flags; |
| 154 |
|
| 155 |
struct ath_ani ani; |
| 156 |
|
| 157 |
u16 cachelsz; |
| 158 |
u16 curaid; |
| 159 |
u8 macaddr[ETH_ALEN]; |
| 160 |
u8 curbssid[ETH_ALEN] __aligned(2); |
| 161 |
u8 bssidmask[ETH_ALEN]; |
| 162 |
|
| 163 |
u32 rx_bufsize; |
| 164 |
|
| 165 |
u32 keymax; |
| 166 |
DECLARE_BITMAP(keymap, ATH_KEYMAX); |
| 167 |
DECLARE_BITMAP(tkip_keymap, ATH_KEYMAX); |
| 168 |
DECLARE_BITMAP(ccmp_keymap, ATH_KEYMAX); |
| 169 |
enum ath_crypt_caps crypt_caps; |
| 170 |
|
| 171 |
unsigned int clockrate; |
| 172 |
|
| 173 |
spinlock_t cc_lock; |
| 174 |
struct_group(cc, |
| 175 |
struct ath_cycle_counters cc_ani; |
| 176 |
struct ath_cycle_counters cc_survey; |
| 177 |
); |
| 178 |
|
| 179 |
struct ath_regulatory regulatory; |
| 180 |
struct ath_regulatory reg_world_copy; |
| 181 |
const struct ath_ops *ops; |
| 182 |
const struct ath_bus_ops *bus_ops; |
| 183 |
const struct ath_ps_ops *ps_ops; |
| 184 |
|
| 185 |
bool btcoex_enabled; |
| 186 |
bool disable_ani; |
| 187 |
bool bt_ant_diversity; |
| 188 |
|
| 189 |
int last_rssi; |
| 190 |
struct ieee80211_supported_band sbands[NUM_NL80211_BANDS]; |
| 191 |
}; |
| 192 |
|
| 193 |
static inline const struct ath_ps_ops *ath_ps_ops(struct ath_common *common) |
| 194 |
{ |
| 195 |
return common->ps_ops; |
| 196 |
} |
| 197 |
|
| 198 |
struct sk_buff *ath_rxbuf_alloc(struct ath_common *common, |
| 199 |
u32 len, |
| 200 |
gfp_t gfp_mask); |
| 201 |
bool ath_is_mybeacon(struct ath_common *common, struct ieee80211_hdr *hdr); |
| 202 |
|
| 203 |
void ath_hw_setbssidmask(struct ath_common *common); |
| 204 |
void ath_key_delete(struct ath_common *common, u8 hw_key_idx); |
| 205 |
int ath_key_config(struct ath_common *common, |
| 206 |
struct ieee80211_vif *vif, |
| 207 |
struct ieee80211_sta *sta, |
| 208 |
struct ieee80211_key_conf *key); |
| 209 |
bool ath_hw_keyreset(struct ath_common *common, u16 entry); |
| 210 |
bool ath_hw_keysetmac(struct ath_common *common, u16 entry, const u8 *mac); |
| 211 |
void ath_hw_cycle_counters_update(struct ath_common *common); |
| 212 |
int32_t ath_hw_get_listen_time(struct ath_common *common); |
| 213 |
|
| 214 |
__printf(3, 4) |
| 215 |
void ath_printk(const char *level, const struct ath_common *common, |
| 216 |
const char *fmt, ...); |
| 217 |
|
| 218 |
#define ath_emerg(common, fmt, ...) \ |
| 219 |
ath_printk(KERN_EMERG, common, fmt, ##__VA_ARGS__) |
| 220 |
#define ath_alert(common, fmt, ...) \ |
| 221 |
ath_printk(KERN_ALERT, common, fmt, ##__VA_ARGS__) |
| 222 |
#define ath_crit(common, fmt, ...) \ |
| 223 |
ath_printk(KERN_CRIT, common, fmt, ##__VA_ARGS__) |
| 224 |
#define ath_err(common, fmt, ...) \ |
| 225 |
ath_printk(KERN_ERR, common, fmt, ##__VA_ARGS__) |
| 226 |
#define ath_warn(common, fmt, ...) \ |
| 227 |
ath_printk(KERN_WARNING, common, fmt, ##__VA_ARGS__) |
| 228 |
#define ath_notice(common, fmt, ...) \ |
| 229 |
ath_printk(KERN_NOTICE, common, fmt, ##__VA_ARGS__) |
| 230 |
#define ath_info(common, fmt, ...) \ |
| 231 |
ath_printk(KERN_INFO, common, fmt, ##__VA_ARGS__) |
| 232 |
|
| 233 |
/** |
| 234 |
* enum ath_debug_level - atheros wireless debug level |
| 235 |
* |
| 236 |
* @ATH_DBG_RESET: reset processing |
| 237 |
* @ATH_DBG_QUEUE: hardware queue management |
| 238 |
* @ATH_DBG_EEPROM: eeprom processing |
| 239 |
* @ATH_DBG_CALIBRATE: periodic calibration |
| 240 |
* @ATH_DBG_INTERRUPT: interrupt processing |
| 241 |
* @ATH_DBG_REGULATORY: regulatory processing |
| 242 |
* @ATH_DBG_ANI: adaptive noise immunitive processing |
| 243 |
* @ATH_DBG_XMIT: basic xmit operation |
| 244 |
* @ATH_DBG_BEACON: beacon handling |
| 245 |
* @ATH_DBG_CONFIG: configuration of the hardware |
| 246 |
* @ATH_DBG_FATAL: fatal errors, this is the default, DBG_DEFAULT |
| 247 |
* @ATH_DBG_PS: power save processing |
| 248 |
* @ATH_DBG_HWTIMER: hardware timer handling |
| 249 |
* @ATH_DBG_BTCOEX: bluetooth coexistance |
| 250 |
* @ATH_DBG_BSTUCK: stuck beacons |
| 251 |
* @ATH_DBG_MCI: Message Coexistence Interface, a private protocol |
| 252 |
* used exclusively for WLAN-BT coexistence starting from |
| 253 |
* AR9462. |
| 254 |
* @ATH_DBG_DFS: radar datection |
| 255 |
* @ATH_DBG_WOW: Wake on Wireless |
| 256 |
* @ATH_DBG_DYNACK: dynack handling |
| 257 |
* @ATH_DBG_SPECTRAL_SCAN: FFT spectral scan |
| 258 |
* @ATH_DBG_ANY: enable all debugging |
| 259 |
* |
| 260 |
* The debug level is used to control the amount and type of debugging output |
| 261 |
* we want to see. Each driver has its own method for enabling debugging and |
| 262 |
* modifying debug level states -- but this is typically done through a |
| 263 |
* module parameter 'debug' along with a respective 'debug' debugfs file |
| 264 |
* entry. |
| 265 |
*/ |
| 266 |
enum ATH_DEBUG { |
| 267 |
ATH_DBG_RESET = 0x00000001, |
| 268 |
ATH_DBG_QUEUE = 0x00000002, |
| 269 |
ATH_DBG_EEPROM = 0x00000004, |
| 270 |
ATH_DBG_CALIBRATE = 0x00000008, |
| 271 |
ATH_DBG_INTERRUPT = 0x00000010, |
| 272 |
ATH_DBG_REGULATORY = 0x00000020, |
| 273 |
ATH_DBG_ANI = 0x00000040, |
| 274 |
ATH_DBG_XMIT = 0x00000080, |
| 275 |
ATH_DBG_BEACON = 0x00000100, |
| 276 |
ATH_DBG_CONFIG = 0x00000200, |
| 277 |
ATH_DBG_FATAL = 0x00000400, |
| 278 |
ATH_DBG_PS = 0x00000800, |
| 279 |
ATH_DBG_BTCOEX = 0x00001000, |
| 280 |
ATH_DBG_WMI = 0x00002000, |
| 281 |
ATH_DBG_BSTUCK = 0x00004000, |
| 282 |
ATH_DBG_MCI = 0x00008000, |
| 283 |
ATH_DBG_DFS = 0x00010000, |
| 284 |
ATH_DBG_WOW = 0x00020000, |
| 285 |
ATH_DBG_CHAN_CTX = 0x00040000, |
| 286 |
ATH_DBG_DYNACK = 0x00080000, |
| 287 |
ATH_DBG_SPECTRAL_SCAN = 0x00100000, |
| 288 |
ATH_DBG_ANY = 0xffffffff |
| 289 |
}; |
| 290 |
|
| 291 |
#define ATH_DBG_DEFAULT (ATH_DBG_FATAL) |
| 292 |
#define ATH_DBG_MAX_LEN 512 |
| 293 |
|
| 294 |
#ifdef CONFIG_ATH_DEBUG |
| 295 |
|
| 296 |
#define ath_dbg(common, dbg_mask, fmt, ...) \ |
| 297 |
do { \ |
| 298 |
if ((common)->debug_mask & ATH_DBG_##dbg_mask) \ |
| 299 |
ath_printk(KERN_DEBUG, common, fmt, ##__VA_ARGS__); \ |
| 300 |
} while (0) |
| 301 |
|
| 302 |
#define ATH_DBG_WARN(foo, arg...) WARN(foo, arg) |
| 303 |
#define ATH_DBG_WARN_ON_ONCE(foo) WARN_ON_ONCE(foo) |
| 304 |
|
| 305 |
#else |
| 306 |
|
| 307 |
static inline __attribute__ ((format (printf, 3, 4))) |
| 308 |
void _ath_dbg(struct ath_common *common, enum ATH_DEBUG dbg_mask, |
| 309 |
const char *fmt, ...) |
| 310 |
{ |
| 311 |
} |
| 312 |
#define ath_dbg(common, dbg_mask, fmt, ...) \ |
| 313 |
_ath_dbg(common, ATH_DBG_##dbg_mask, fmt, ##__VA_ARGS__) |
| 314 |
|
| 315 |
#define ATH_DBG_WARN(foo, arg...) do {} while (0) |
| 316 |
#define ATH_DBG_WARN_ON_ONCE(foo) ({ \ |
| 317 |
int __ret_warn_once = !!(foo); \ |
| 318 |
unlikely(__ret_warn_once); \ |
| 319 |
}) |
| 320 |
|
| 321 |
#endif /* CONFIG_ATH_DEBUG */ |
| 322 |
|
| 323 |
/** Returns string describing opmode, or NULL if unknown mode. */ |
| 324 |
#ifdef CONFIG_ATH_DEBUG |
| 325 |
const char *ath_opmode_to_string(enum nl80211_iftype opmode); |
| 326 |
#else |
| 327 |
static inline const char *ath_opmode_to_string(enum nl80211_iftype opmode) |
| 328 |
{ |
| 329 |
return "UNKNOWN"; |
| 330 |
} |
| 331 |
#endif |
| 332 |
|
| 333 |
extern const char *ath_bus_type_strings[]; |
| 334 |
static inline const char *ath_bus_type_to_string(enum ath_bus_type bustype) |
| 335 |
{ |
| 336 |
return ath_bus_type_strings[bustype]; |
| 337 |
} |
| 338 |
|
| 339 |
#endif /* ATH_H */ |