[linux-2.6-block.git] / drivers / net / wireless / brcm80211 / brcmfmac / debug.h

/*
 * Copyright (c) 2010 Broadcom Corporation
 *
 * 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 BRCMFMAC_DEBUG_H
#define BRCMFMAC_DEBUG_H

/* message levels */
#define BRCMF_TRACE_VAL		0x00000002
#define BRCMF_INFO_VAL		0x00000004
#define BRCMF_DATA_VAL		0x00000008
#define BRCMF_CTL_VAL		0x00000010
#define BRCMF_TIMER_VAL		0x00000020
#define BRCMF_HDRS_VAL		0x00000040
#define BRCMF_BYTES_VAL		0x00000080
#define BRCMF_INTR_VAL		0x00000100
#define BRCMF_GLOM_VAL		0x00000200
#define BRCMF_EVENT_VAL		0x00000400
#define BRCMF_BTA_VAL		0x00000800
#define BRCMF_FIL_VAL		0x00001000
#define BRCMF_USB_VAL		0x00002000
#define BRCMF_SCAN_VAL		0x00004000
#define BRCMF_CONN_VAL		0x00008000
#define BRCMF_BCDC_VAL		0x00010000
#define BRCMF_SDIO_VAL		0x00020000
#define BRCMF_MSGBUF_VAL	0x00040000
#define BRCMF_PCIE_VAL		0x00080000
#define BRCMF_FWCON_VAL		0x00100000

/* set default print format */
#undef pr_fmt
#define pr_fmt(fmt)		KBUILD_MODNAME ": " fmt

/* Macro for error messages. net_ratelimit() is used when driver
 * debugging is not selected. When debugging the driver error
 * messages are as important as other tracing or even more so.
 */
#ifndef CONFIG_BRCM_TRACING
#ifdef CONFIG_BRCMDBG
#define brcmf_err(fmt, ...)	pr_err("%s: " fmt, __func__, ##__VA_ARGS__)
#else
#define brcmf_err(fmt, ...)						\
	do {								\
		if (net_ratelimit())					\
			pr_err("%s: " fmt, __func__, ##__VA_ARGS__);	\
	} while (0)
#endif
#else
__printf(2, 3)
void __brcmf_err(const char *func, const char *fmt, ...);
#define brcmf_err(fmt, ...) \
	__brcmf_err(__func__, fmt, ##__VA_ARGS__)
#endif

#if defined(DEBUG) || defined(CONFIG_BRCM_TRACING)
__printf(3, 4)
void __brcmf_dbg(u32 level, const char *func, const char *fmt, ...);
#define brcmf_dbg(level, fmt, ...)				\
do {								\
	__brcmf_dbg(BRCMF_##level##_VAL, __func__,		\
		    fmt, ##__VA_ARGS__);			\
} while (0)
#define BRCMF_DATA_ON()		(brcmf_msg_level & BRCMF_DATA_VAL)
#define BRCMF_CTL_ON()		(brcmf_msg_level & BRCMF_CTL_VAL)
#define BRCMF_HDRS_ON()		(brcmf_msg_level & BRCMF_HDRS_VAL)
#define BRCMF_BYTES_ON()	(brcmf_msg_level & BRCMF_BYTES_VAL)
#define BRCMF_GLOM_ON()		(brcmf_msg_level & BRCMF_GLOM_VAL)
#define BRCMF_EVENT_ON()	(brcmf_msg_level & BRCMF_EVENT_VAL)
#define BRCMF_FIL_ON()		(brcmf_msg_level & BRCMF_FIL_VAL)
#define BRCMF_FWCON_ON()	(brcmf_msg_level & BRCMF_FWCON_VAL)

#else /* defined(DEBUG) || defined(CONFIG_BRCM_TRACING) */

#define brcmf_dbg(level, fmt, ...) no_printk(fmt, ##__VA_ARGS__)

#define BRCMF_DATA_ON()		0
#define BRCMF_CTL_ON()		0
#define BRCMF_HDRS_ON()		0
#define BRCMF_BYTES_ON()	0
#define BRCMF_GLOM_ON()		0
#define BRCMF_EVENT_ON()	0
#define BRCMF_FIL_ON()		0
#define BRCMF_FWCON_ON()	0

#endif /* defined(DEBUG) || defined(CONFIG_BRCM_TRACING) */

#define brcmf_dbg_hex_dump(test, data, len, fmt, ...)			\
do {									\
	trace_brcmf_hexdump((void *)data, len);				\
	if (test)							\
		brcmu_dbg_hex_dump(data, len, fmt, ##__VA_ARGS__);	\
} while (0)

extern int brcmf_msg_level;

struct brcmf_pub;
#ifdef DEBUG
void brcmf_debugfs_init(void);
void brcmf_debugfs_exit(void);
int brcmf_debug_attach(struct brcmf_pub *drvr);
void brcmf_debug_detach(struct brcmf_pub *drvr);
struct dentry *brcmf_debugfs_get_devdir(struct brcmf_pub *drvr);
int brcmf_debugfs_add_entry(struct brcmf_pub *drvr, const char *fn,
			    int (*read_fn)(struct seq_file *seq, void *data));
#else
static inline void brcmf_debugfs_init(void)
{
}
static inline void brcmf_debugfs_exit(void)
{
}
static inline int brcmf_debug_attach(struct brcmf_pub *drvr)
{
	return 0;
}
static inline void brcmf_debug_detach(struct brcmf_pub *drvr)
{
}
static inline
int brcmf_debugfs_add_entry(struct brcmf_pub *drvr, const char *fn,
			    int (*read_fn)(struct seq_file *seq, void *data))
{
	return 0;
}
#endif

#endif /* BRCMFMAC_DEBUG_H */
Commit	Line	Data
5b435de0 AS	1	/*
	2	* Copyright (c) 2010 Broadcom Corporation
	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 ANY
	11	* SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
	12	* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
	13	* OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
	14	* CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
	15	*/
	16
a8e8ed34 HM	17	#ifndef BRCMFMAC_DEBUG_H
a8e8ed34 HM	18	#define BRCMFMAC_DEBUG_H
5b435de0	19
8763349b	20	/* message levels */
9a1bb602 HM	21	#define BRCMF_TRACE_VAL 0x00000002
	22	#define BRCMF_INFO_VAL 0x00000004
	23	#define BRCMF_DATA_VAL 0x00000008
	24	#define BRCMF_CTL_VAL 0x00000010
	25	#define BRCMF_TIMER_VAL 0x00000020
	26	#define BRCMF_HDRS_VAL 0x00000040
	27	#define BRCMF_BYTES_VAL 0x00000080
	28	#define BRCMF_INTR_VAL 0x00000100
	29	#define BRCMF_GLOM_VAL 0x00000200
	30	#define BRCMF_EVENT_VAL 0x00000400
	31	#define BRCMF_BTA_VAL 0x00000800
	32	#define BRCMF_FIL_VAL 0x00001000
	33	#define BRCMF_USB_VAL 0x00002000
	34	#define BRCMF_SCAN_VAL 0x00004000
	35	#define BRCMF_CONN_VAL 0x00008000
	36	#define BRCMF_BCDC_VAL 0x00010000
	37	#define BRCMF_SDIO_VAL 0x00020000
	38	#define BRCMF_MSGBUF_VAL 0x00040000
9e37f045	39	#define BRCMF_PCIE_VAL 0x00080000
9d6c1dc4	40	#define BRCMF_FWCON_VAL 0x00100000
8763349b	41
79d7c4e8 AS	42	/* set default print format */
	43	#undef pr_fmt
	44	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
	45
5e8149f5 AS	46	/* Macro for error messages. net_ratelimit() is used when driver
	47	* debugging is not selected. When debugging the driver error
	48	* messages are as important as other tracing or even more so.
	49	*/
e5483576	50	#ifndef CONFIG_BRCM_TRACING
5e8149f5 AS	51	#ifdef CONFIG_BRCMDBG
	52	#define brcmf_err(fmt, ...) pr_err("%s: " fmt, __func__, ##__VA_ARGS__)
	53	#else
	54	#define brcmf_err(fmt, ...) \
	55	do { \
	56	if (net_ratelimit()) \
	57	pr_err("%s: " fmt, __func__, ##__VA_ARGS__); \
	58	} while (0)
	59	#endif
e5483576 AS	60	#else
	61	__printf(2, 3)
	62	void __brcmf_err(const char func, const char fmt, ...);
	63	#define brcmf_err(fmt, ...) \
	64	__brcmf_err(__func__, fmt, ##__VA_ARGS__)
	65	#endif
5e8149f5	66
e5483576 AS	67	#if defined(DEBUG) \|\| defined(CONFIG_BRCM_TRACING)
	68	__printf(3, 4)
	69	void __brcmf_dbg(u32 level, const char func, const char fmt, ...);
5e8149f5 AS	70	#define brcmf_dbg(level, fmt, ...) \
5e8149f5 AS	71	do { \
e5483576 AS	72	__brcmf_dbg(BRCMF_##level##_VAL, __func__, \
e5483576 AS	73	fmt, ##__VA_ARGS__); \
5b435de0	74	} while (0)
5b435de0 AS	75	#define BRCMF_DATA_ON() (brcmf_msg_level & BRCMF_DATA_VAL)
	76	#define BRCMF_CTL_ON() (brcmf_msg_level & BRCMF_CTL_VAL)
	77	#define BRCMF_HDRS_ON() (brcmf_msg_level & BRCMF_HDRS_VAL)
	78	#define BRCMF_BYTES_ON() (brcmf_msg_level & BRCMF_BYTES_VAL)
	79	#define BRCMF_GLOM_ON() (brcmf_msg_level & BRCMF_GLOM_VAL)
30c52bcf	80	#define BRCMF_EVENT_ON() (brcmf_msg_level & BRCMF_EVENT_VAL)
81f5dcb8	81	#define BRCMF_FIL_ON() (brcmf_msg_level & BRCMF_FIL_VAL)
9d6c1dc4	82	#define BRCMF_FWCON_ON() (brcmf_msg_level & BRCMF_FWCON_VAL)
5b435de0	83
e5483576	84	#else /* defined(DEBUG) \|\| defined(CONFIG_BRCM_TRACING) */
5b435de0 AS	85
	86	#define brcmf_dbg(level, fmt, ...) no_printk(fmt, ##__VA_ARGS__)
	87
	88	#define BRCMF_DATA_ON() 0
	89	#define BRCMF_CTL_ON() 0
	90	#define BRCMF_HDRS_ON() 0
	91	#define BRCMF_BYTES_ON() 0
	92	#define BRCMF_GLOM_ON() 0
30c52bcf	93	#define BRCMF_EVENT_ON() 0
81f5dcb8	94	#define BRCMF_FIL_ON() 0
9d6c1dc4	95	#define BRCMF_FWCON_ON() 0
5b435de0	96
e5483576	97	#endif /* defined(DEBUG) \|\| defined(CONFIG_BRCM_TRACING) */
5b435de0	98
1e023829 JP	99	#define brcmf_dbg_hex_dump(test, data, len, fmt, ...) \
1e023829 JP	100	do { \
40c1c249	101	trace_brcmf_hexdump((void *)data, len); \
1e023829 JP	102	if (test) \
	103	brcmu_dbg_hex_dump(data, len, fmt, ##__VA_ARGS__); \
	104	} while (0)
	105
5b435de0 AS	106	extern int brcmf_msg_level;
5b435de0 AS	107
d319a7cf AS	108	struct brcmf_pub;
	109	#ifdef DEBUG
	110	void brcmf_debugfs_init(void);
	111	void brcmf_debugfs_exit(void);
ff4445a8 AS	112	int brcmf_debug_attach(struct brcmf_pub *drvr);
ff4445a8 AS	113	void brcmf_debug_detach(struct brcmf_pub *drvr);
d319a7cf	114	struct dentry brcmf_debugfs_get_devdir(struct brcmf_pub drvr);
82d957e0 AS	115	int brcmf_debugfs_add_entry(struct brcmf_pub drvr, const char fn,
82d957e0 AS	116	int (read_fn)(struct seq_file seq, void *data));
d319a7cf AS	117	#else
	118	static inline void brcmf_debugfs_init(void)
	119	{
	120	}
	121	static inline void brcmf_debugfs_exit(void)
	122	{
	123	}
ff4445a8	124	static inline int brcmf_debug_attach(struct brcmf_pub *drvr)
d319a7cf AS	125	{
	126	return 0;
	127	}
ff4445a8	128	static inline void brcmf_debug_detach(struct brcmf_pub *drvr)
d319a7cf AS	129	{
d319a7cf AS	130	}
82d957e0 AS	131	static inline
	132	int brcmf_debugfs_add_entry(struct brcmf_pub drvr, const char fn,
	133	int (read_fn)(struct seq_file seq, void *data))
349e7104	134	{
82d957e0	135	return 0;
349e7104	136	}
d319a7cf AS	137	#endif
d319a7cf AS	138
a8e8ed34	139	#endif /* BRCMFMAC_DEBUG_H */