xref: /linux/drivers/net/wireless/broadcom/brcm80211/brcmfmac/debug.h (revision 4b132aacb0768ac1e652cf517097ea6f237214b9)
1 // SPDX-License-Identifier: ISC
2 /*
3  * Copyright (c) 2010 Broadcom Corporation
4  */
5 
6 #ifndef BRCMFMAC_DEBUG_H
7 #define BRCMFMAC_DEBUG_H
8 
9 #include <linux/net.h>	/* net_ratelimit() */
10 
11 /* message levels */
12 #define BRCMF_TRACE_VAL		0x00000002
13 #define BRCMF_INFO_VAL		0x00000004
14 #define BRCMF_DATA_VAL		0x00000008
15 #define BRCMF_CTL_VAL		0x00000010
16 #define BRCMF_TIMER_VAL		0x00000020
17 #define BRCMF_HDRS_VAL		0x00000040
18 #define BRCMF_BYTES_VAL		0x00000080
19 #define BRCMF_INTR_VAL		0x00000100
20 #define BRCMF_GLOM_VAL		0x00000200
21 #define BRCMF_EVENT_VAL		0x00000400
22 #define BRCMF_BTA_VAL		0x00000800
23 #define BRCMF_FIL_VAL		0x00001000
24 #define BRCMF_USB_VAL		0x00002000
25 #define BRCMF_SCAN_VAL		0x00004000
26 #define BRCMF_CONN_VAL		0x00008000
27 #define BRCMF_BCDC_VAL		0x00010000
28 #define BRCMF_SDIO_VAL		0x00020000
29 #define BRCMF_MSGBUF_VAL	0x00040000
30 #define BRCMF_PCIE_VAL		0x00080000
31 #define BRCMF_FWCON_VAL		0x00100000
32 
33 /* set default print format */
34 #undef pr_fmt
35 #define pr_fmt(fmt)		KBUILD_MODNAME ": " fmt
36 
37 struct brcmf_bus;
38 
39 __printf(3, 4)
40 void __brcmf_err(struct brcmf_bus *bus, const char *func, const char *fmt, ...);
41 /* Macro for error messages. When debugging / tracing the driver all error
42  * messages are important to us.
43  */
44 #ifndef brcmf_err
45 #define brcmf_err(fmt, ...)						\
46 	do {								\
47 		if (IS_ENABLED(CONFIG_BRCMDBG) ||			\
48 		    IS_ENABLED(CONFIG_BRCM_TRACING) ||			\
49 		    net_ratelimit())					\
50 			__brcmf_err(NULL, __func__, fmt, ##__VA_ARGS__);\
51 	} while (0)
52 #endif
53 
54 #define bphy_err(drvr, fmt, ...)					\
55 	do {								\
56 		if (IS_ENABLED(CONFIG_BRCMDBG) ||			\
57 		    IS_ENABLED(CONFIG_BRCM_TRACING) ||			\
58 		    net_ratelimit())					\
59 			wiphy_err((drvr)->wiphy, "%s: " fmt, __func__,	\
60 				  ##__VA_ARGS__);			\
61 	} while (0)
62 
63 #define bphy_info_once(drvr, fmt, ...)					\
64 	wiphy_info_once((drvr)->wiphy, "%s: " fmt, __func__,		\
65 			##__VA_ARGS__)
66 
67 #if defined(DEBUG) || defined(CONFIG_BRCM_TRACING)
68 
69 /* For debug/tracing purposes treat info messages as errors */
70 #define brcmf_info brcmf_err
71 
72 __printf(3, 4)
73 void __brcmf_dbg(u32 level, const char *func, const char *fmt, ...);
74 #define brcmf_dbg(level, fmt, ...)				\
75 do {								\
76 	__brcmf_dbg(BRCMF_##level##_VAL, __func__,		\
77 		    fmt, ##__VA_ARGS__);			\
78 } while (0)
79 #define BRCMF_DATA_ON()		(brcmf_msg_level & BRCMF_DATA_VAL)
80 #define BRCMF_CTL_ON()		(brcmf_msg_level & BRCMF_CTL_VAL)
81 #define BRCMF_HDRS_ON()		(brcmf_msg_level & BRCMF_HDRS_VAL)
82 #define BRCMF_BYTES_ON()	(brcmf_msg_level & BRCMF_BYTES_VAL)
83 #define BRCMF_GLOM_ON()		(brcmf_msg_level & BRCMF_GLOM_VAL)
84 #define BRCMF_EVENT_ON()	(brcmf_msg_level & BRCMF_EVENT_VAL)
85 #define BRCMF_FIL_ON()		(brcmf_msg_level & BRCMF_FIL_VAL)
86 #define BRCMF_FWCON_ON()	(brcmf_msg_level & BRCMF_FWCON_VAL)
87 #define BRCMF_SCAN_ON()		(brcmf_msg_level & BRCMF_SCAN_VAL)
88 
89 #else /* defined(DEBUG) || defined(CONFIG_BRCM_TRACING) */
90 
91 #define brcmf_info(fmt, ...)						\
92 	do {								\
93 		pr_info("%s: " fmt, __func__, ##__VA_ARGS__);		\
94 	} while (0)
95 
96 #define brcmf_dbg(level, fmt, ...) no_printk(fmt, ##__VA_ARGS__)
97 
98 #define BRCMF_DATA_ON()		0
99 #define BRCMF_CTL_ON()		0
100 #define BRCMF_HDRS_ON()		0
101 #define BRCMF_BYTES_ON()	0
102 #define BRCMF_GLOM_ON()		0
103 #define BRCMF_EVENT_ON()	0
104 #define BRCMF_FIL_ON()		0
105 #define BRCMF_FWCON_ON()	0
106 #define BRCMF_SCAN_ON()		0
107 
108 #endif /* defined(DEBUG) || defined(CONFIG_BRCM_TRACING) */
109 
110 #define brcmf_dbg_hex_dump(test, data, len, fmt, ...)			\
111 do {									\
112 	trace_brcmf_hexdump((void *)data, len);				\
113 	if (test)							\
114 		brcmu_dbg_hex_dump(data, len, fmt, ##__VA_ARGS__);	\
115 } while (0)
116 
117 extern int brcmf_msg_level;
118 
119 struct brcmf_pub;
120 #ifdef DEBUG
121 struct dentry *brcmf_debugfs_get_devdir(struct brcmf_pub *drvr);
122 void brcmf_debugfs_add_entry(struct brcmf_pub *drvr, const char *fn,
123 			     int (*read_fn)(struct seq_file *seq, void *data));
124 int brcmf_debug_create_memdump(struct brcmf_bus *bus, const void *data,
125 			       size_t len);
126 #else
127 static inline struct dentry *brcmf_debugfs_get_devdir(struct brcmf_pub *drvr)
128 {
129 	return ERR_PTR(-ENOENT);
130 }
131 static inline
132 void brcmf_debugfs_add_entry(struct brcmf_pub *drvr, const char *fn,
133 			     int (*read_fn)(struct seq_file *seq, void *data))
134 { }
135 static inline
136 int brcmf_debug_create_memdump(struct brcmf_bus *bus, const void *data,
137 			       size_t len)
138 {
139 	return 0;
140 }
141 #endif
142 
143 #endif /* BRCMFMAC_DEBUG_H */
144