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 
17 #ifndef BRCMFMAC_DEBUG_H
18 #define BRCMFMAC_DEBUG_H
19 
20 #include <linux/net.h>	/* net_ratelimit() */
21 
22 /* message levels */
23 #define BRCMF_TRACE_VAL		0x00000002
24 #define BRCMF_INFO_VAL		0x00000004
25 #define BRCMF_DATA_VAL		0x00000008
26 #define BRCMF_CTL_VAL		0x00000010
27 #define BRCMF_TIMER_VAL		0x00000020
28 #define BRCMF_HDRS_VAL		0x00000040
29 #define BRCMF_BYTES_VAL		0x00000080
30 #define BRCMF_INTR_VAL		0x00000100
31 #define BRCMF_GLOM_VAL		0x00000200
32 #define BRCMF_EVENT_VAL		0x00000400
33 #define BRCMF_BTA_VAL		0x00000800
34 #define BRCMF_FIL_VAL		0x00001000
35 #define BRCMF_USB_VAL		0x00002000
36 #define BRCMF_SCAN_VAL		0x00004000
37 #define BRCMF_CONN_VAL		0x00008000
38 #define BRCMF_BCDC_VAL		0x00010000
39 #define BRCMF_SDIO_VAL		0x00020000
40 #define BRCMF_MSGBUF_VAL	0x00040000
41 #define BRCMF_PCIE_VAL		0x00080000
42 #define BRCMF_FWCON_VAL		0x00100000
43 
44 /* set default print format */
45 #undef pr_fmt
46 #define pr_fmt(fmt)		KBUILD_MODNAME ": " fmt
47 
48 /* Macro for error messages. net_ratelimit() is used when driver
49  * debugging is not selected. When debugging the driver error
50  * messages are as important as other tracing or even more so.
51  */
52 #ifndef CONFIG_BRCM_TRACING
53 #ifdef CONFIG_BRCMDBG
54 #define brcmf_err(fmt, ...)	pr_err("%s: " fmt, __func__, ##__VA_ARGS__)
55 #else
56 #define brcmf_err(fmt, ...)						\
57 	do {								\
58 		if (net_ratelimit())					\
59 			pr_err("%s: " fmt, __func__, ##__VA_ARGS__);	\
60 	} while (0)
61 #endif
62 #else
63 __printf(2, 3)
64 void __brcmf_err(const char *func, const char *fmt, ...);
65 #define brcmf_err(fmt, ...) \
66 	__brcmf_err(__func__, fmt, ##__VA_ARGS__)
67 #endif
68 
69 #if defined(DEBUG) || defined(CONFIG_BRCM_TRACING)
70 __printf(3, 4)
71 void __brcmf_dbg(u32 level, const char *func, const char *fmt, ...);
72 #define brcmf_dbg(level, fmt, ...)				\
73 do {								\
74 	__brcmf_dbg(BRCMF_##level##_VAL, __func__,		\
75 		    fmt, ##__VA_ARGS__);			\
76 } while (0)
77 #define BRCMF_DATA_ON()		(brcmf_msg_level & BRCMF_DATA_VAL)
78 #define BRCMF_CTL_ON()		(brcmf_msg_level & BRCMF_CTL_VAL)
79 #define BRCMF_HDRS_ON()		(brcmf_msg_level & BRCMF_HDRS_VAL)
80 #define BRCMF_BYTES_ON()	(brcmf_msg_level & BRCMF_BYTES_VAL)
81 #define BRCMF_GLOM_ON()		(brcmf_msg_level & BRCMF_GLOM_VAL)
82 #define BRCMF_EVENT_ON()	(brcmf_msg_level & BRCMF_EVENT_VAL)
83 #define BRCMF_FIL_ON()		(brcmf_msg_level & BRCMF_FIL_VAL)
84 #define BRCMF_FWCON_ON()	(brcmf_msg_level & BRCMF_FWCON_VAL)
85 
86 #else /* defined(DEBUG) || defined(CONFIG_BRCM_TRACING) */
87 
88 #define brcmf_dbg(level, fmt, ...) no_printk(fmt, ##__VA_ARGS__)
89 
90 #define BRCMF_DATA_ON()		0
91 #define BRCMF_CTL_ON()		0
92 #define BRCMF_HDRS_ON()		0
93 #define BRCMF_BYTES_ON()	0
94 #define BRCMF_GLOM_ON()		0
95 #define BRCMF_EVENT_ON()	0
96 #define BRCMF_FIL_ON()		0
97 #define BRCMF_FWCON_ON()	0
98 
99 #endif /* defined(DEBUG) || defined(CONFIG_BRCM_TRACING) */
100 
101 #define brcmf_dbg_hex_dump(test, data, len, fmt, ...)			\
102 do {									\
103 	trace_brcmf_hexdump((void *)data, len);				\
104 	if (test)							\
105 		brcmu_dbg_hex_dump(data, len, fmt, ##__VA_ARGS__);	\
106 } while (0)
107 
108 extern int brcmf_msg_level;
109 
110 struct brcmf_pub;
111 #ifdef DEBUG
112 void brcmf_debugfs_init(void);
113 void brcmf_debugfs_exit(void);
114 int brcmf_debug_attach(struct brcmf_pub *drvr);
115 void brcmf_debug_detach(struct brcmf_pub *drvr);
116 struct dentry *brcmf_debugfs_get_devdir(struct brcmf_pub *drvr);
117 int brcmf_debugfs_add_entry(struct brcmf_pub *drvr, const char *fn,
118 			    int (*read_fn)(struct seq_file *seq, void *data));
119 #else
120 static inline void brcmf_debugfs_init(void)
121 {
122 }
123 static inline void brcmf_debugfs_exit(void)
124 {
125 }
126 static inline int brcmf_debug_attach(struct brcmf_pub *drvr)
127 {
128 	return 0;
129 }
130 static inline void brcmf_debug_detach(struct brcmf_pub *drvr)
131 {
132 }
133 static inline
134 int brcmf_debugfs_add_entry(struct brcmf_pub *drvr, const char *fn,
135 			    int (*read_fn)(struct seq_file *seq, void *data))
136 {
137 	return 0;
138 }
139 #endif
140 
141 #endif /* BRCMFMAC_DEBUG_H */
142