2 * Copyright (c) 2008-2009 Atheros Communications Inc.
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.
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.
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>
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).
34 #define ATH_KEYMAX 128 /* max key cache size we handle */
36 static const u8 ath_bcast_mac[ETH_ALEN] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
40 unsigned int longcal_timer;
41 unsigned int shortcal_timer;
42 unsigned int resetcal_timer;
43 unsigned int checkani_timer;
44 struct timer_list timer;
47 struct ath_cycle_counters {
54 enum ath_device_state {
76 struct reg_dmn_pair_mapping {
82 struct ath_regulatory {
84 enum nl80211_dfs_regions region;
89 struct reg_dmn_pair_mapping *regpair;
93 ATH_CRYPT_CAP_CIPHER_AESCCM = BIT(0),
94 ATH_CRYPT_CAP_MIC_COMBINED = BIT(1),
101 u8 kv_val[16]; /* TK */
102 u8 kv_mic[8]; /* Michael MIC key */
103 u8 kv_txmic[8]; /* Michael MIC TX key (used only if the hardware
104 * supports both MIC keys in the same key cache entry;
105 * in that case, kv_mic is the RX key) */
110 ATH_CIPHER_AES_OCB = 1,
111 ATH_CIPHER_AES_CCM = 2,
119 * struct ath_ops - Register read/write operations
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
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 *);
143 void (*wakeup)(struct ath_common *common);
144 void (*restore)(struct ath_common *common);
150 struct ieee80211_hw *hw;
152 enum ath_device_state state;
153 unsigned long op_flags;
159 u8 macaddr[ETH_ALEN];
160 u8 curbssid[ETH_ALEN] __aligned(2);
161 u8 bssidmask[ETH_ALEN];
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;
171 unsigned int clockrate;
174 struct ath_cycle_counters cc_ani;
175 struct ath_cycle_counters cc_survey;
177 struct ath_regulatory regulatory;
178 struct ath_regulatory reg_world_copy;
179 const struct ath_ops *ops;
180 const struct ath_bus_ops *bus_ops;
181 const struct ath_ps_ops *ps_ops;
185 bool bt_ant_diversity;
188 struct ieee80211_supported_band sbands[NUM_NL80211_BANDS];
191 static inline const struct ath_ps_ops *ath_ps_ops(struct ath_common *common)
193 return common->ps_ops;
196 struct sk_buff *ath_rxbuf_alloc(struct ath_common *common,
199 bool ath_is_mybeacon(struct ath_common *common, struct ieee80211_hdr *hdr);
201 void ath_hw_setbssidmask(struct ath_common *common);
202 void ath_key_delete(struct ath_common *common, u8 hw_key_idx);
203 int ath_key_config(struct ath_common *common,
204 struct ieee80211_vif *vif,
205 struct ieee80211_sta *sta,
206 struct ieee80211_key_conf *key);
207 bool ath_hw_keyreset(struct ath_common *common, u16 entry);
208 bool ath_hw_keysetmac(struct ath_common *common, u16 entry, const u8 *mac);
209 void ath_hw_cycle_counters_update(struct ath_common *common);
210 int32_t ath_hw_get_listen_time(struct ath_common *common);
213 void ath_printk(const char *level, const struct ath_common *common,
214 const char *fmt, ...);
216 #define ath_emerg(common, fmt, ...) \
217 ath_printk(KERN_EMERG, common, fmt, ##__VA_ARGS__)
218 #define ath_alert(common, fmt, ...) \
219 ath_printk(KERN_ALERT, common, fmt, ##__VA_ARGS__)
220 #define ath_crit(common, fmt, ...) \
221 ath_printk(KERN_CRIT, common, fmt, ##__VA_ARGS__)
222 #define ath_err(common, fmt, ...) \
223 ath_printk(KERN_ERR, common, fmt, ##__VA_ARGS__)
224 #define ath_warn(common, fmt, ...) \
225 ath_printk(KERN_WARNING, common, fmt, ##__VA_ARGS__)
226 #define ath_notice(common, fmt, ...) \
227 ath_printk(KERN_NOTICE, common, fmt, ##__VA_ARGS__)
228 #define ath_info(common, fmt, ...) \
229 ath_printk(KERN_INFO, common, fmt, ##__VA_ARGS__)
232 * enum ath_debug_level - atheros wireless debug level
234 * @ATH_DBG_RESET: reset processing
235 * @ATH_DBG_QUEUE: hardware queue management
236 * @ATH_DBG_EEPROM: eeprom processing
237 * @ATH_DBG_CALIBRATE: periodic calibration
238 * @ATH_DBG_INTERRUPT: interrupt processing
239 * @ATH_DBG_REGULATORY: regulatory processing
240 * @ATH_DBG_ANI: adaptive noise immunitive processing
241 * @ATH_DBG_XMIT: basic xmit operation
242 * @ATH_DBG_BEACON: beacon handling
243 * @ATH_DBG_CONFIG: configuration of the hardware
244 * @ATH_DBG_FATAL: fatal errors, this is the default, DBG_DEFAULT
245 * @ATH_DBG_PS: power save processing
246 * @ATH_DBG_HWTIMER: hardware timer handling
247 * @ATH_DBG_BTCOEX: bluetooth coexistance
248 * @ATH_DBG_BSTUCK: stuck beacons
249 * @ATH_DBG_MCI: Message Coexistence Interface, a private protocol
250 * used exclusively for WLAN-BT coexistence starting from
252 * @ATH_DBG_DFS: radar datection
253 * @ATH_DBG_WOW: Wake on Wireless
254 * @ATH_DBG_DYNACK: dynack handling
255 * @ATH_DBG_SPECTRAL_SCAN: FFT spectral scan
256 * @ATH_DBG_ANY: enable all debugging
258 * The debug level is used to control the amount and type of debugging output
259 * we want to see. Each driver has its own method for enabling debugging and
260 * modifying debug level states -- but this is typically done through a
261 * module parameter 'debug' along with a respective 'debug' debugfs file
265 ATH_DBG_RESET = 0x00000001,
266 ATH_DBG_QUEUE = 0x00000002,
267 ATH_DBG_EEPROM = 0x00000004,
268 ATH_DBG_CALIBRATE = 0x00000008,
269 ATH_DBG_INTERRUPT = 0x00000010,
270 ATH_DBG_REGULATORY = 0x00000020,
271 ATH_DBG_ANI = 0x00000040,
272 ATH_DBG_XMIT = 0x00000080,
273 ATH_DBG_BEACON = 0x00000100,
274 ATH_DBG_CONFIG = 0x00000200,
275 ATH_DBG_FATAL = 0x00000400,
276 ATH_DBG_PS = 0x00000800,
277 ATH_DBG_BTCOEX = 0x00001000,
278 ATH_DBG_WMI = 0x00002000,
279 ATH_DBG_BSTUCK = 0x00004000,
280 ATH_DBG_MCI = 0x00008000,
281 ATH_DBG_DFS = 0x00010000,
282 ATH_DBG_WOW = 0x00020000,
283 ATH_DBG_CHAN_CTX = 0x00040000,
284 ATH_DBG_DYNACK = 0x00080000,
285 ATH_DBG_SPECTRAL_SCAN = 0x00100000,
286 ATH_DBG_ANY = 0xffffffff
289 #define ATH_DBG_DEFAULT (ATH_DBG_FATAL)
290 #define ATH_DBG_MAX_LEN 512
292 #ifdef CONFIG_ATH_DEBUG
294 #define ath_dbg(common, dbg_mask, fmt, ...) \
296 if ((common)->debug_mask & ATH_DBG_##dbg_mask) \
297 ath_printk(KERN_DEBUG, common, fmt, ##__VA_ARGS__); \
300 #define ATH_DBG_WARN(foo, arg...) WARN(foo, arg)
301 #define ATH_DBG_WARN_ON_ONCE(foo) WARN_ON_ONCE(foo)
305 static inline __attribute__ ((format (printf, 3, 4)))
306 void _ath_dbg(struct ath_common *common, enum ATH_DEBUG dbg_mask,
307 const char *fmt, ...)
310 #define ath_dbg(common, dbg_mask, fmt, ...) \
311 _ath_dbg(common, ATH_DBG_##dbg_mask, fmt, ##__VA_ARGS__)
313 #define ATH_DBG_WARN(foo, arg...) do {} while (0)
314 #define ATH_DBG_WARN_ON_ONCE(foo) ({ \
315 int __ret_warn_once = !!(foo); \
316 unlikely(__ret_warn_once); \
319 #endif /* CONFIG_ATH_DEBUG */
321 /** Returns string describing opmode, or NULL if unknown mode. */
322 #ifdef CONFIG_ATH_DEBUG
323 const char *ath_opmode_to_string(enum nl80211_iftype opmode);
325 static inline const char *ath_opmode_to_string(enum nl80211_iftype opmode)