[deliverable/linux.git] / drivers / net / wireless / ath / ath.h

/*
 * Copyright (c) 2008-2009 Atheros Communications Inc.
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef ATH_H
#define ATH_H

#include <linux/etherdevice.h>
#include <linux/skbuff.h>
#include <linux/if_ether.h>
#include <linux/spinlock.h>
#include <net/mac80211.h>

/*
 * The key cache is used for h/w cipher state and also for
 * tracking station state such as the current tx antenna.
 * We also setup a mapping table between key cache slot indices
 * and station state to short-circuit node lookups on rx.
 * Different parts have different size key caches.  We handle
 * up to ATH_KEYMAX entries (could dynamically allocate state).
 */
#define	ATH_KEYMAX	        128     /* max key cache size we handle */

static const u8 ath_bcast_mac[ETH_ALEN] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff};

struct ath_ani {
	bool caldone;
	unsigned int longcal_timer;
	unsigned int shortcal_timer;
	unsigned int resetcal_timer;
	unsigned int checkani_timer;
	struct timer_list timer;
};

struct ath_cycle_counters {
	u32 cycles;
	u32 rx_busy;
	u32 rx_frame;
	u32 tx_frame;
};

enum ath_device_state {
	ATH_HW_UNAVAILABLE,
	ATH_HW_INITIALIZED,
};

enum ath_op_flags {
	ATH_OP_INVALID,
	ATH_OP_BEACONS,
	ATH_OP_ANI_RUN,
	ATH_OP_PRIM_STA_VIF,
	ATH_OP_HW_RESET,
	ATH_OP_SCANNING,
	ATH_OP_MULTI_CHANNEL,
	ATH_OP_WOW_ENABLED,
};

enum ath_bus_type {
	ATH_PCI,
	ATH_AHB,
	ATH_USB,
};

struct reg_dmn_pair_mapping {
	u16 reg_domain;
	u16 reg_5ghz_ctl;
	u16 reg_2ghz_ctl;
};

struct ath_regulatory {
	char alpha2[2];
	enum nl80211_dfs_regions region;
	u16 country_code;
	u16 max_power_level;
	u16 current_rd;
	int16_t power_limit;
	struct reg_dmn_pair_mapping *regpair;
};

enum ath_crypt_caps {
	ATH_CRYPT_CAP_CIPHER_AESCCM		= BIT(0),
	ATH_CRYPT_CAP_MIC_COMBINED		= BIT(1),
};

struct ath_keyval {
	u8 kv_type;
	u8 kv_pad;
	u16 kv_len;
	u8 kv_val[16]; /* TK */
	u8 kv_mic[8]; /* Michael MIC key */
	u8 kv_txmic[8]; /* Michael MIC TX key (used only if the hardware
			 * supports both MIC keys in the same key cache entry;
			 * in that case, kv_mic is the RX key) */
};

enum ath_cipher {
	ATH_CIPHER_WEP = 0,
	ATH_CIPHER_AES_OCB = 1,
	ATH_CIPHER_AES_CCM = 2,
	ATH_CIPHER_CKIP = 3,
	ATH_CIPHER_TKIP = 4,
	ATH_CIPHER_CLR = 5,
	ATH_CIPHER_MIC = 127
};

/**
 * struct ath_ops - Register read/write operations
 *
 * @read: Register read
 * @multi_read: Multiple register read
 * @write: Register write
 * @enable_write_buffer: Enable multiple register writes
 * @write_flush: flush buffered register writes and disable buffering
 */
struct ath_ops {
	unsigned int (*read)(void *, u32 reg_offset);
	void (*multi_read)(void *, u32 *addr, u32 *val, u16 count);
	void (*write)(void *, u32 val, u32 reg_offset);
	void (*enable_write_buffer)(void *);
	void (*write_flush) (void *);
	u32 (*rmw)(void *, u32 reg_offset, u32 set, u32 clr);
	void (*enable_rmw_buffer)(void *);
	void (*rmw_flush) (void *);

};

struct ath_common;
struct ath_bus_ops;

struct ath_ps_ops {
	void (*wakeup)(struct ath_common *common);
	void (*restore)(struct ath_common *common);
};

struct ath_common {
	void *ah;
	void *priv;
	struct ieee80211_hw *hw;
	int debug_mask;
	enum ath_device_state state;
	unsigned long op_flags;

	struct ath_ani ani;

	u16 cachelsz;
	u16 curaid;
	u8 macaddr[ETH_ALEN];
	u8 curbssid[ETH_ALEN] __aligned(2);
	u8 bssidmask[ETH_ALEN];

	u32 rx_bufsize;

	u32 keymax;
	DECLARE_BITMAP(keymap, ATH_KEYMAX);
	DECLARE_BITMAP(tkip_keymap, ATH_KEYMAX);
	DECLARE_BITMAP(ccmp_keymap, ATH_KEYMAX);
	enum ath_crypt_caps crypt_caps;

	unsigned int clockrate;

	spinlock_t cc_lock;
	struct ath_cycle_counters cc_ani;
	struct ath_cycle_counters cc_survey;

	struct ath_regulatory regulatory;
	struct ath_regulatory reg_world_copy;
	const struct ath_ops *ops;
	const struct ath_bus_ops *bus_ops;
	const struct ath_ps_ops *ps_ops;

	bool btcoex_enabled;
	bool disable_ani;
	bool bt_ant_diversity;

	int last_rssi;
	struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
};

static inline const struct ath_ps_ops *ath_ps_ops(struct ath_common *common)
{
	return common->ps_ops;
}

struct sk_buff *ath_rxbuf_alloc(struct ath_common *common,
				u32 len,
				gfp_t gfp_mask);
bool ath_is_mybeacon(struct ath_common *common, struct ieee80211_hdr *hdr);

void ath_hw_setbssidmask(struct ath_common *common);
void ath_key_delete(struct ath_common *common, struct ieee80211_key_conf *key);
int ath_key_config(struct ath_common *common,
			  struct ieee80211_vif *vif,
			  struct ieee80211_sta *sta,
			  struct ieee80211_key_conf *key);
bool ath_hw_keyreset(struct ath_common *common, u16 entry);
void ath_hw_cycle_counters_update(struct ath_common *common);
int32_t ath_hw_get_listen_time(struct ath_common *common);

__printf(3, 4)
void ath_printk(const char *level, const struct ath_common *common,
		const char *fmt, ...);

#define ath_emerg(common, fmt, ...)				\
	ath_printk(KERN_EMERG, common, fmt, ##__VA_ARGS__)
#define ath_alert(common, fmt, ...)				\
	ath_printk(KERN_ALERT, common, fmt, ##__VA_ARGS__)
#define ath_crit(common, fmt, ...)				\
	ath_printk(KERN_CRIT, common, fmt, ##__VA_ARGS__)
#define ath_err(common, fmt, ...)				\
	ath_printk(KERN_ERR, common, fmt, ##__VA_ARGS__)
#define ath_warn(common, fmt, ...)				\
	ath_printk(KERN_WARNING, common, fmt, ##__VA_ARGS__)
#define ath_notice(common, fmt, ...)				\
	ath_printk(KERN_NOTICE, common, fmt, ##__VA_ARGS__)
#define ath_info(common, fmt, ...)				\
	ath_printk(KERN_INFO, common, fmt, ##__VA_ARGS__)

/**
 * enum ath_debug_level - atheros wireless debug level
 *
 * @ATH_DBG_RESET: reset processing
 * @ATH_DBG_QUEUE: hardware queue management
 * @ATH_DBG_EEPROM: eeprom processing
 * @ATH_DBG_CALIBRATE: periodic calibration
 * @ATH_DBG_INTERRUPT: interrupt processing
 * @ATH_DBG_REGULATORY: regulatory processing
 * @ATH_DBG_ANI: adaptive noise immunitive processing
 * @ATH_DBG_XMIT: basic xmit operation
 * @ATH_DBG_BEACON: beacon handling
 * @ATH_DBG_CONFIG: configuration of the hardware
 * @ATH_DBG_FATAL: fatal errors, this is the default, DBG_DEFAULT
 * @ATH_DBG_PS: power save processing
 * @ATH_DBG_HWTIMER: hardware timer handling
 * @ATH_DBG_BTCOEX: bluetooth coexistance
 * @ATH_DBG_BSTUCK: stuck beacons
 * @ATH_DBG_MCI: Message Coexistence Interface, a private protocol
 *	used exclusively for WLAN-BT coexistence starting from
 *	AR9462.
 * @ATH_DBG_DFS: radar datection
 * @ATH_DBG_WOW: Wake on Wireless
 * @ATH_DBG_DYNACK: dynack handling
 * @ATH_DBG_SPECTRAL_SCAN: FFT spectral scan
 * @ATH_DBG_ANY: enable all debugging
 *
 * The debug level is used to control the amount and type of debugging output
 * we want to see. Each driver has its own method for enabling debugging and
 * modifying debug level states -- but this is typically done through a
 * module parameter 'debug' along with a respective 'debug' debugfs file
 * entry.
 */
enum ATH_DEBUG {
	ATH_DBG_RESET		= 0x00000001,
	ATH_DBG_QUEUE		= 0x00000002,
	ATH_DBG_EEPROM		= 0x00000004,
	ATH_DBG_CALIBRATE	= 0x00000008,
	ATH_DBG_INTERRUPT	= 0x00000010,
	ATH_DBG_REGULATORY	= 0x00000020,
	ATH_DBG_ANI		= 0x00000040,
	ATH_DBG_XMIT		= 0x00000080,
	ATH_DBG_BEACON		= 0x00000100,
	ATH_DBG_CONFIG		= 0x00000200,
	ATH_DBG_FATAL		= 0x00000400,
	ATH_DBG_PS		= 0x00000800,
	ATH_DBG_BTCOEX		= 0x00001000,
	ATH_DBG_WMI		= 0x00002000,
	ATH_DBG_BSTUCK		= 0x00004000,
	ATH_DBG_MCI		= 0x00008000,
	ATH_DBG_DFS		= 0x00010000,
	ATH_DBG_WOW		= 0x00020000,
	ATH_DBG_CHAN_CTX	= 0x00040000,
	ATH_DBG_DYNACK		= 0x00080000,
	ATH_DBG_SPECTRAL_SCAN	= 0x00100000,
	ATH_DBG_ANY		= 0xffffffff
};

#define ATH_DBG_DEFAULT (ATH_DBG_FATAL)
#define ATH_DBG_MAX_LEN 512

#ifdef CONFIG_ATH_DEBUG

#define ath_dbg(common, dbg_mask, fmt, ...)				\
do {									\
	if ((common)->debug_mask & ATH_DBG_##dbg_mask)			\
		ath_printk(KERN_DEBUG, common, fmt, ##__VA_ARGS__);	\
} while (0)

#define ATH_DBG_WARN(foo, arg...) WARN(foo, arg)
#define ATH_DBG_WARN_ON_ONCE(foo) WARN_ON_ONCE(foo)

#else

static inline  __attribute__ ((format (printf, 3, 4)))
void _ath_dbg(struct ath_common *common, enum ATH_DEBUG dbg_mask,
	     const char *fmt, ...)
{
}
#define ath_dbg(common, dbg_mask, fmt, ...)				\
	_ath_dbg(common, ATH_DBG_##dbg_mask, fmt, ##__VA_ARGS__)

#define ATH_DBG_WARN(foo, arg...) do {} while (0)
#define ATH_DBG_WARN_ON_ONCE(foo) ({				\
	int __ret_warn_once = !!(foo);				\
	unlikely(__ret_warn_once);				\
})

#endif /* CONFIG_ATH_DEBUG */

/** Returns string describing opmode, or NULL if unknown mode. */
#ifdef CONFIG_ATH_DEBUG
const char *ath_opmode_to_string(enum nl80211_iftype opmode);
#else
static inline const char *ath_opmode_to_string(enum nl80211_iftype opmode)
{
	return "UNKNOWN";
}
#endif

#endif /* ATH_H */
Commit	Line	Data
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
f1d267ca	20	#include <linux/etherdevice.h>
d15dd3e5	21	#include <linux/skbuff.h>
bcd8f54a	22	#include <linux/if_ether.h>
b5bfc568	23	#include <linux/spinlock.h>
b002a4a9	24	#include <net/mac80211.h>
d15dd3e5	25
7e86c104 LR	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
17753748 LR	36	static const u8 ath_bcast_mac[ETH_ALEN] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
17753748 LR	37
3d536acf LR	38	struct ath_ani {
3d536acf LR	39	bool caldone;
3d536acf LR	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;
	45	};
	46
b5bfc568 FF	47	struct ath_cycle_counters {
	48	u32 cycles;
	49	u32 rx_busy;
	50	u32 rx_frame;
	51	u32 tx_frame;
	52	};
	53
211f5859 LR	54	enum ath_device_state {
	55	ATH_HW_UNAVAILABLE,
	56	ATH_HW_INITIALIZED,
	57	};
	58
eefa01dd OR	59	enum ath_op_flags {
	60	ATH_OP_INVALID,
	61	ATH_OP_BEACONS,
	62	ATH_OP_ANI_RUN,
	63	ATH_OP_PRIM_STA_VIF,
	64	ATH_OP_HW_RESET,
	65	ATH_OP_SCANNING,
26f16c24	66	ATH_OP_MULTI_CHANNEL,
249943a2	67	ATH_OP_WOW_ENABLED,
eefa01dd OR	68	};
eefa01dd OR	69
497ad9ad S	70	enum ath_bus_type {
	71	ATH_PCI,
	72	ATH_AHB,
	73	ATH_USB,
	74	};
	75
608b88cb	76	struct reg_dmn_pair_mapping {
ef8c0017	77	u16 reg_domain;
608b88cb LR	78	u16 reg_5ghz_ctl;
	79	u16 reg_2ghz_ctl;
	80	};
	81
	82	struct ath_regulatory {
	83	char alpha2[2];
94e05900	84	enum nl80211_dfs_regions region;
608b88cb LR	85	u16 country_code;
608b88cb LR	86	u16 max_power_level;
608b88cb	87	u16 current_rd;
608b88cb LR	88	int16_t power_limit;
	89	struct reg_dmn_pair_mapping *regpair;
	90	};
	91
34a13051	92	enum ath_crypt_caps {
ce2220d1 BR	93	ATH_CRYPT_CAP_CIPHER_AESCCM = BIT(0),
ce2220d1 BR	94	ATH_CRYPT_CAP_MIC_COMBINED = BIT(1),
34a13051 BR	95	};
34a13051 BR	96
1bba5b73 BR	97	struct ath_keyval {
	98	u8 kv_type;
	99	u8 kv_pad;
	100	u16 kv_len;
	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) */
	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
50f56316 S	118	/**
	119	* struct ath_ops - Register read/write operations
	120	*
	121	* @read: Register read
09a525d3	122	* @multi_read: Multiple register read
50f56316 S	123	* @write: Register write
50f56316 S	124	* @enable_write_buffer: Enable multiple register writes
435c1610	125	* @write_flush: flush buffered register writes and disable buffering
50f56316	126	*/
9e4bffd2 LR	127	struct ath_ops {
9e4bffd2 LR	128	unsigned int (read)(void , u32 reg_offset);
09a525d3	129	void (multi_read)(void , u32 addr, u32 val, u16 count);
50f56316 S	130	void (write)(void , u32 val, u32 reg_offset);
50f56316 S	131	void (enable_write_buffer)(void );
50f56316	132	void (write_flush) (void );
845e03c9	133	u32 (rmw)(void , u32 reg_offset, u32 set, u32 clr);
8badb50c OR	134	void (enable_rmw_buffer)(void );
	135	void (rmw_flush) (void );
	136
9e4bffd2 LR	137	};
9e4bffd2 LR	138
5bb12791	139	struct ath_common;
0cb9e06b	140	struct ath_bus_ops;
5bb12791	141
0198c2e2 OR	142	struct ath_ps_ops {
	143	void (wakeup)(struct ath_common common);
	144	void (restore)(struct ath_common common);
	145	};
	146
d15dd3e5	147	struct ath_common {
13b81559	148	void *ah;
bc974f4a	149	void *priv;
b002a4a9	150	struct ieee80211_hw *hw;
c46917bb	151	int debug_mask;
211f5859	152	enum ath_device_state state;
eefa01dd	153	unsigned long op_flags;
c46917bb	154
3d536acf LR	155	struct ath_ani ani;
3d536acf LR	156
d15dd3e5	157	u16 cachelsz;
1510718d LR	158	u16 curaid;
1510718d LR	159	u8 macaddr[ETH_ALEN];
62ae1aef	160	u8 curbssid[ETH_ALEN] __aligned(2);
1510718d	161	u8 bssidmask[ETH_ALEN];
c46917bb	162
cc861f74 LR	163	u32 rx_bufsize;
cc861f74 LR	164
7e86c104 LR	165	u32 keymax;
7e86c104 LR	166	DECLARE_BITMAP(keymap, ATH_KEYMAX);
56363dde	167	DECLARE_BITMAP(tkip_keymap, ATH_KEYMAX);
bed3d9c0	168	DECLARE_BITMAP(ccmp_keymap, ATH_KEYMAX);
34a13051	169	enum ath_crypt_caps crypt_caps;
7e86c104	170
dfdac8ac FF	171	unsigned int clockrate;
dfdac8ac FF	172
b5bfc568 FF	173	spinlock_t cc_lock;
	174	struct ath_cycle_counters cc_ani;
	175	struct ath_cycle_counters cc_survey;
	176
608b88cb	177	struct ath_regulatory regulatory;
de1c732b	178	struct ath_regulatory reg_world_copy;
9adca126	179	const struct ath_ops *ops;
5bb12791	180	const struct ath_bus_ops *bus_ops;
0198c2e2	181	const struct ath_ps_ops *ps_ops;
8f5dcb1c VT	182
8f5dcb1c VT	183	bool btcoex_enabled;
05c0be2f	184	bool disable_ani;
63081305	185	bool bt_ant_diversity;
2f2cb326 OR	186
2f2cb326 OR	187	int last_rssi;
13f71050	188	struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
d15dd3e5 LR	189	};
d15dd3e5 LR	190
0198c2e2 OR	191	static inline const struct ath_ps_ops ath_ps_ops(struct ath_common common)
	192	{
	193	return common->ps_ops;
	194	}
	195
d15dd3e5 LR	196	struct sk_buff ath_rxbuf_alloc(struct ath_common common,
	197	u32 len,
	198	gfp_t gfp_mask);
f1d267ca	199	bool ath_is_mybeacon(struct ath_common common, struct ieee80211_hdr hdr);
d15dd3e5	200
13b81559	201	void ath_hw_setbssidmask(struct ath_common *common);
1bba5b73 BR	202	void ath_key_delete(struct ath_common common, struct ieee80211_key_conf key);
	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);
b5bfc568 FF	208	void ath_hw_cycle_counters_update(struct ath_common *common);
b5bfc568 FF	209	int32_t ath_hw_get_listen_time(struct ath_common *common);
13b81559	210
98b36a02 BG	211	__printf(3, 4)
	212	void ath_printk(const char level, const struct ath_common common,
	213	const char *fmt, ...);
21a99f93 JP	214
21a99f93 JP	215	#define ath_emerg(common, fmt, ...) \
98b36a02	216	ath_printk(KERN_EMERG, common, fmt, ##__VA_ARGS__)
21a99f93	217	#define ath_alert(common, fmt, ...) \
98b36a02	218	ath_printk(KERN_ALERT, common, fmt, ##__VA_ARGS__)
21a99f93	219	#define ath_crit(common, fmt, ...) \
98b36a02	220	ath_printk(KERN_CRIT, common, fmt, ##__VA_ARGS__)
21a99f93	221	#define ath_err(common, fmt, ...) \
98b36a02	222	ath_printk(KERN_ERR, common, fmt, ##__VA_ARGS__)
21a99f93	223	#define ath_warn(common, fmt, ...) \
98b36a02	224	ath_printk(KERN_WARNING, common, fmt, ##__VA_ARGS__)
21a99f93	225	#define ath_notice(common, fmt, ...) \
98b36a02	226	ath_printk(KERN_NOTICE, common, fmt, ##__VA_ARGS__)
21a99f93	227	#define ath_info(common, fmt, ...) \
98b36a02	228	ath_printk(KERN_INFO, common, fmt, ##__VA_ARGS__)
21a99f93 JP	229
	230	/**
	231	* enum ath_debug_level - atheros wireless debug level
	232	*
	233	* @ATH_DBG_RESET: reset processing
	234	* @ATH_DBG_QUEUE: hardware queue management
	235	* @ATH_DBG_EEPROM: eeprom processing
	236	* @ATH_DBG_CALIBRATE: periodic calibration
	237	* @ATH_DBG_INTERRUPT: interrupt processing
	238	* @ATH_DBG_REGULATORY: regulatory processing
	239	* @ATH_DBG_ANI: adaptive noise immunitive processing
	240	* @ATH_DBG_XMIT: basic xmit operation
	241	* @ATH_DBG_BEACON: beacon handling
	242	* @ATH_DBG_CONFIG: configuration of the hardware
	243	* @ATH_DBG_FATAL: fatal errors, this is the default, DBG_DEFAULT
	244	* @ATH_DBG_PS: power save processing
	245	* @ATH_DBG_HWTIMER: hardware timer handling
	246	* @ATH_DBG_BTCOEX: bluetooth coexistance
	247	* @ATH_DBG_BSTUCK: stuck beacons
55e435de LR	248	* @ATH_DBG_MCI: Message Coexistence Interface, a private protocol
	249	* used exclusively for WLAN-BT coexistence starting from
	250	* AR9462.
9b203c8f	251	* @ATH_DBG_DFS: radar datection
b3ba6c52	252	* @ATH_DBG_WOW: Wake on Wireless
c774d57f	253	* @ATH_DBG_DYNACK: dynack handling
04a81e18	254	* @ATH_DBG_SPECTRAL_SCAN: FFT spectral scan
21a99f93 JP	255	* @ATH_DBG_ANY: enable all debugging
	256	*
	257	* The debug level is used to control the amount and type of debugging output
	258	* we want to see. Each driver has its own method for enabling debugging and
	259	* modifying debug level states -- but this is typically done through a
	260	* module parameter 'debug' along with a respective 'debug' debugfs file
	261	* entry.
	262	*/
	263	enum ATH_DEBUG {
	264	ATH_DBG_RESET = 0x00000001,
	265	ATH_DBG_QUEUE = 0x00000002,
	266	ATH_DBG_EEPROM = 0x00000004,
	267	ATH_DBG_CALIBRATE = 0x00000008,
	268	ATH_DBG_INTERRUPT = 0x00000010,
	269	ATH_DBG_REGULATORY = 0x00000020,
	270	ATH_DBG_ANI = 0x00000040,
	271	ATH_DBG_XMIT = 0x00000080,
	272	ATH_DBG_BEACON = 0x00000100,
	273	ATH_DBG_CONFIG = 0x00000200,
	274	ATH_DBG_FATAL = 0x00000400,
	275	ATH_DBG_PS = 0x00000800,
14335310 SM	276	ATH_DBG_BTCOEX = 0x00001000,
	277	ATH_DBG_WMI = 0x00002000,
	278	ATH_DBG_BSTUCK = 0x00004000,
	279	ATH_DBG_MCI = 0x00008000,
	280	ATH_DBG_DFS = 0x00010000,
	281	ATH_DBG_WOW = 0x00020000,
27328a75	282	ATH_DBG_CHAN_CTX = 0x00040000,
c774d57f	283	ATH_DBG_DYNACK = 0x00080000,
04a81e18	284	ATH_DBG_SPECTRAL_SCAN = 0x00100000,
21a99f93 JP	285	ATH_DBG_ANY = 0xffffffff
	286	};
	287
	288	#define ATH_DBG_DEFAULT (ATH_DBG_FATAL)
e6664dff	289	#define ATH_DBG_MAX_LEN 512
21a99f93 JP	290
	291	#ifdef CONFIG_ATH_DEBUG
	292
7b8112d6 JP	293	#define ath_dbg(common, dbg_mask, fmt, ...) \
7b8112d6 JP	294	do { \
d2182b69	295	if ((common)->debug_mask & ATH_DBG_##dbg_mask) \
98b36a02	296	ath_printk(KERN_DEBUG, common, fmt, ##__VA_ARGS__); \
7b8112d6 JP	297	} while (0)
7b8112d6 JP	298
21a99f93	299	#define ATH_DBG_WARN(foo, arg...) WARN(foo, arg)
d7fd1b50	300	#define ATH_DBG_WARN_ON_ONCE(foo) WARN_ON_ONCE(foo)
21a99f93 JP	301
	302	#else
	303
b9075fa9	304	static inline __attribute__ ((format (printf, 3, 4)))
d2182b69	305	void _ath_dbg(struct ath_common *common, enum ATH_DEBUG dbg_mask,
7b8112d6	306	const char *fmt, ...)
21a99f93	307	{
21a99f93	308	}
d2182b69 JP	309	#define ath_dbg(common, dbg_mask, fmt, ...) \
	310	_ath_dbg(common, ATH_DBG_##dbg_mask, fmt, ##__VA_ARGS__)
	311
21a99f93	312	#define ATH_DBG_WARN(foo, arg...) do {} while (0)
b7613370 JL	313	#define ATH_DBG_WARN_ON_ONCE(foo) ({ \
	314	int __ret_warn_once = !!(foo); \
	315	unlikely(__ret_warn_once); \
	316	})
21a99f93 JP	317
	318	#endif /* CONFIG_ATH_DEBUG */
	319
	320	/** Returns string describing opmode, or NULL if unknown mode. */
	321	#ifdef CONFIG_ATH_DEBUG
	322	const char *ath_opmode_to_string(enum nl80211_iftype opmode);
	323	#else
	324	static inline const char *ath_opmode_to_string(enum nl80211_iftype opmode)
	325	{
	326	return "UNKNOWN";
	327	}
	328	#endif
	329
d15dd3e5	330	#endif /* ATH_H */