Merge branch 'x86-debug-for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git...
[deliverable/linux.git] / drivers / net / wireless / ath / ath.h
CommitLineData
d15dd3e5
LR
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>
bcd8f54a 21#include <linux/if_ether.h>
b5bfc568 22#include <linux/spinlock.h>
b002a4a9 23#include <net/mac80211.h>
d15dd3e5 24
7e86c104
LR
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
17753748
LR
35static const u8 ath_bcast_mac[ETH_ALEN] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
36
3d536acf
LR
37struct ath_ani {
38 bool caldone;
3d536acf
LR
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
b5bfc568
FF
46struct ath_cycle_counters {
47 u32 cycles;
48 u32 rx_busy;
49 u32 rx_frame;
50 u32 tx_frame;
51};
52
211f5859
LR
53enum ath_device_state {
54 ATH_HW_UNAVAILABLE,
55 ATH_HW_INITIALIZED,
56};
57
497ad9ad
S
58enum ath_bus_type {
59 ATH_PCI,
60 ATH_AHB,
61 ATH_USB,
62};
63
608b88cb
LR
64struct reg_dmn_pair_mapping {
65 u16 regDmnEnum;
66 u16 reg_5ghz_ctl;
67 u16 reg_2ghz_ctl;
68};
69
70struct ath_regulatory {
71 char alpha2[2];
72 u16 country_code;
73 u16 max_power_level;
608b88cb 74 u16 current_rd;
608b88cb
LR
75 int16_t power_limit;
76 struct reg_dmn_pair_mapping *regpair;
77};
78
34a13051 79enum ath_crypt_caps {
ce2220d1
BR
80 ATH_CRYPT_CAP_CIPHER_AESCCM = BIT(0),
81 ATH_CRYPT_CAP_MIC_COMBINED = BIT(1),
34a13051
BR
82};
83
1bba5b73
BR
84struct 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
95enum 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
50f56316
S
105/**
106 * struct ath_ops - Register read/write operations
107 *
108 * @read: Register read
09a525d3 109 * @multi_read: Multiple register read
50f56316
S
110 * @write: Register write
111 * @enable_write_buffer: Enable multiple register writes
435c1610 112 * @write_flush: flush buffered register writes and disable buffering
50f56316 113 */
9e4bffd2
LR
114struct ath_ops {
115 unsigned int (*read)(void *, u32 reg_offset);
09a525d3 116 void (*multi_read)(void *, u32 *addr, u32 *val, u16 count);
50f56316
S
117 void (*write)(void *, u32 val, u32 reg_offset);
118 void (*enable_write_buffer)(void *);
50f56316 119 void (*write_flush) (void *);
845e03c9 120 u32 (*rmw)(void *, u32 reg_offset, u32 set, u32 clr);
9e4bffd2
LR
121};
122
5bb12791 123struct ath_common;
0cb9e06b 124struct ath_bus_ops;
5bb12791 125
d15dd3e5 126struct ath_common {
13b81559 127 void *ah;
bc974f4a 128 void *priv;
b002a4a9 129 struct ieee80211_hw *hw;
c46917bb 130 int debug_mask;
211f5859 131 enum ath_device_state state;
c46917bb 132
3d536acf
LR
133 struct ath_ani ani;
134
d15dd3e5 135 u16 cachelsz;
1510718d
LR
136 u16 curaid;
137 u8 macaddr[ETH_ALEN];
138 u8 curbssid[ETH_ALEN];
139 u8 bssidmask[ETH_ALEN];
c46917bb 140
cc861f74
LR
141 u32 rx_bufsize;
142
7e86c104
LR
143 u32 keymax;
144 DECLARE_BITMAP(keymap, ATH_KEYMAX);
56363dde 145 DECLARE_BITMAP(tkip_keymap, ATH_KEYMAX);
bed3d9c0 146 DECLARE_BITMAP(ccmp_keymap, ATH_KEYMAX);
34a13051 147 enum ath_crypt_caps crypt_caps;
7e86c104 148
dfdac8ac
FF
149 unsigned int clockrate;
150
b5bfc568
FF
151 spinlock_t cc_lock;
152 struct ath_cycle_counters cc_ani;
153 struct ath_cycle_counters cc_survey;
154
608b88cb 155 struct ath_regulatory regulatory;
de1c732b 156 struct ath_regulatory reg_world_copy;
9adca126 157 const struct ath_ops *ops;
5bb12791 158 const struct ath_bus_ops *bus_ops;
8f5dcb1c
VT
159
160 bool btcoex_enabled;
05c0be2f 161 bool disable_ani;
d15dd3e5
LR
162};
163
164struct sk_buff *ath_rxbuf_alloc(struct ath_common *common,
165 u32 len,
166 gfp_t gfp_mask);
167
13b81559 168void ath_hw_setbssidmask(struct ath_common *common);
1bba5b73
BR
169void ath_key_delete(struct ath_common *common, struct ieee80211_key_conf *key);
170int ath_key_config(struct ath_common *common,
171 struct ieee80211_vif *vif,
172 struct ieee80211_sta *sta,
173 struct ieee80211_key_conf *key);
174bool ath_hw_keyreset(struct ath_common *common, u16 entry);
b5bfc568
FF
175void ath_hw_cycle_counters_update(struct ath_common *common);
176int32_t ath_hw_get_listen_time(struct ath_common *common);
13b81559 177
98b36a02
BG
178__printf(3, 4)
179void ath_printk(const char *level, const struct ath_common *common,
180 const char *fmt, ...);
21a99f93
JP
181
182#define ath_emerg(common, fmt, ...) \
98b36a02 183 ath_printk(KERN_EMERG, common, fmt, ##__VA_ARGS__)
21a99f93 184#define ath_alert(common, fmt, ...) \
98b36a02 185 ath_printk(KERN_ALERT, common, fmt, ##__VA_ARGS__)
21a99f93 186#define ath_crit(common, fmt, ...) \
98b36a02 187 ath_printk(KERN_CRIT, common, fmt, ##__VA_ARGS__)
21a99f93 188#define ath_err(common, fmt, ...) \
98b36a02 189 ath_printk(KERN_ERR, common, fmt, ##__VA_ARGS__)
21a99f93 190#define ath_warn(common, fmt, ...) \
98b36a02 191 ath_printk(KERN_WARNING, common, fmt, ##__VA_ARGS__)
21a99f93 192#define ath_notice(common, fmt, ...) \
98b36a02 193 ath_printk(KERN_NOTICE, common, fmt, ##__VA_ARGS__)
21a99f93 194#define ath_info(common, fmt, ...) \
98b36a02 195 ath_printk(KERN_INFO, common, fmt, ##__VA_ARGS__)
21a99f93
JP
196
197/**
198 * enum ath_debug_level - atheros wireless debug level
199 *
200 * @ATH_DBG_RESET: reset processing
201 * @ATH_DBG_QUEUE: hardware queue management
202 * @ATH_DBG_EEPROM: eeprom processing
203 * @ATH_DBG_CALIBRATE: periodic calibration
204 * @ATH_DBG_INTERRUPT: interrupt processing
205 * @ATH_DBG_REGULATORY: regulatory processing
206 * @ATH_DBG_ANI: adaptive noise immunitive processing
207 * @ATH_DBG_XMIT: basic xmit operation
208 * @ATH_DBG_BEACON: beacon handling
209 * @ATH_DBG_CONFIG: configuration of the hardware
210 * @ATH_DBG_FATAL: fatal errors, this is the default, DBG_DEFAULT
211 * @ATH_DBG_PS: power save processing
212 * @ATH_DBG_HWTIMER: hardware timer handling
213 * @ATH_DBG_BTCOEX: bluetooth coexistance
214 * @ATH_DBG_BSTUCK: stuck beacons
55e435de
LR
215 * @ATH_DBG_MCI: Message Coexistence Interface, a private protocol
216 * used exclusively for WLAN-BT coexistence starting from
217 * AR9462.
9b203c8f 218 * @ATH_DBG_DFS: radar datection
21a99f93
JP
219 * @ATH_DBG_ANY: enable all debugging
220 *
221 * The debug level is used to control the amount and type of debugging output
222 * we want to see. Each driver has its own method for enabling debugging and
223 * modifying debug level states -- but this is typically done through a
224 * module parameter 'debug' along with a respective 'debug' debugfs file
225 * entry.
226 */
227enum ATH_DEBUG {
228 ATH_DBG_RESET = 0x00000001,
229 ATH_DBG_QUEUE = 0x00000002,
230 ATH_DBG_EEPROM = 0x00000004,
231 ATH_DBG_CALIBRATE = 0x00000008,
232 ATH_DBG_INTERRUPT = 0x00000010,
233 ATH_DBG_REGULATORY = 0x00000020,
234 ATH_DBG_ANI = 0x00000040,
235 ATH_DBG_XMIT = 0x00000080,
236 ATH_DBG_BEACON = 0x00000100,
237 ATH_DBG_CONFIG = 0x00000200,
238 ATH_DBG_FATAL = 0x00000400,
239 ATH_DBG_PS = 0x00000800,
240 ATH_DBG_HWTIMER = 0x00001000,
241 ATH_DBG_BTCOEX = 0x00002000,
242 ATH_DBG_WMI = 0x00004000,
243 ATH_DBG_BSTUCK = 0x00008000,
7dc181c2 244 ATH_DBG_MCI = 0x00010000,
9b203c8f 245 ATH_DBG_DFS = 0x00020000,
21a99f93
JP
246 ATH_DBG_ANY = 0xffffffff
247};
248
249#define ATH_DBG_DEFAULT (ATH_DBG_FATAL)
250
251#ifdef CONFIG_ATH_DEBUG
252
7b8112d6
JP
253#define ath_dbg(common, dbg_mask, fmt, ...) \
254do { \
d2182b69 255 if ((common)->debug_mask & ATH_DBG_##dbg_mask) \
98b36a02 256 ath_printk(KERN_DEBUG, common, fmt, ##__VA_ARGS__); \
7b8112d6
JP
257} while (0)
258
21a99f93 259#define ATH_DBG_WARN(foo, arg...) WARN(foo, arg)
d7fd1b50 260#define ATH_DBG_WARN_ON_ONCE(foo) WARN_ON_ONCE(foo)
21a99f93
JP
261
262#else
263
b9075fa9 264static inline __attribute__ ((format (printf, 3, 4)))
d2182b69 265void _ath_dbg(struct ath_common *common, enum ATH_DEBUG dbg_mask,
7b8112d6 266 const char *fmt, ...)
21a99f93 267{
21a99f93 268}
d2182b69
JP
269#define ath_dbg(common, dbg_mask, fmt, ...) \
270 _ath_dbg(common, ATH_DBG_##dbg_mask, fmt, ##__VA_ARGS__)
271
21a99f93 272#define ATH_DBG_WARN(foo, arg...) do {} while (0)
b7613370
JL
273#define ATH_DBG_WARN_ON_ONCE(foo) ({ \
274 int __ret_warn_once = !!(foo); \
275 unlikely(__ret_warn_once); \
276})
21a99f93
JP
277
278#endif /* CONFIG_ATH_DEBUG */
279
280/** Returns string describing opmode, or NULL if unknown mode. */
281#ifdef CONFIG_ATH_DEBUG
282const char *ath_opmode_to_string(enum nl80211_iftype opmode);
283#else
284static inline const char *ath_opmode_to_string(enum nl80211_iftype opmode)
285{
286 return "UNKNOWN";
287}
288#endif
289
d15dd3e5 290#endif /* ATH_H */
This page took 0.63597 seconds and 5 git commands to generate.