1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /******************************************************************************
3  *
4  * Copyright(c) 2003 - 2014 Intel Corporation. All rights reserved.
5  * Copyright(c) 2018 - 2021 Intel Corporation
6  *
7  * Portions of this file are derived from the ipw3945 project.
8  *****************************************************************************/
9 
10 #ifndef __iwl_debug_h__
11 #define __iwl_debug_h__
12 
13 #include "iwl-modparams.h"
14 
15 
16 static inline bool iwl_have_debug_level(u32 level)
17 {
18 #ifdef CONFIG_IWLWIFI_DEBUG
19 	return iwlwifi_mod_params.debug_level & level;
20 #else
21 	return false;
22 #endif
23 }
24 
25 enum iwl_err_mode {
26 	IWL_ERR_MODE_REGULAR,
27 	IWL_ERR_MODE_RFKILL,
28 	IWL_ERR_MODE_TRACE_ONLY,
29 	IWL_ERR_MODE_RATELIMIT,
30 };
31 
32 struct device;
33 void __iwl_err(struct device *dev, enum iwl_err_mode mode, const char *fmt, ...)
34 	__printf(3, 4);
35 void __iwl_warn(struct device *dev, const char *fmt, ...) __printf(2, 3);
36 void __iwl_info(struct device *dev, const char *fmt, ...) __printf(2, 3);
37 void __iwl_crit(struct device *dev, const char *fmt, ...) __printf(2, 3);
38 
39 /* not all compilers can evaluate strlen() at compile time, so use sizeof() */
40 #define CHECK_FOR_NEWLINE(f) BUILD_BUG_ON(f[sizeof(f) - 2] != '\n')
41 
42 /* No matter what is m (priv, bus, trans), this will work */
43 #define __IWL_ERR_DEV(d, mode, f, a...)					\
44 	do {								\
45 		CHECK_FOR_NEWLINE(f);					\
46 		__iwl_err((d), mode, f, ## a);				\
47 	} while (0)
48 #define IWL_ERR_DEV(d, f, a...)						\
49 	__IWL_ERR_DEV(d, IWL_ERR_MODE_REGULAR, f, ## a)
50 #define IWL_ERR(m, f, a...)						\
51 	IWL_ERR_DEV((m)->dev, f, ## a)
52 #define IWL_ERR_LIMIT(m, f, a...)					\
53 	__IWL_ERR_DEV((m)->dev, IWL_ERR_MODE_RATELIMIT, f, ## a)
54 #define IWL_WARN(m, f, a...)						\
55 	do {								\
56 		CHECK_FOR_NEWLINE(f);					\
57 		__iwl_warn((m)->dev, f, ## a);				\
58 	} while (0)
59 #define IWL_INFO(m, f, a...)						\
60 	do {								\
61 		CHECK_FOR_NEWLINE(f);					\
62 		__iwl_info((m)->dev, f, ## a);				\
63 	} while (0)
64 #define IWL_CRIT(m, f, a...)						\
65 	do {								\
66 		CHECK_FOR_NEWLINE(f);					\
67 		__iwl_crit((m)->dev, f, ## a);				\
68 	} while (0)
69 
70 #if defined(CONFIG_IWLWIFI_DEBUG) || defined(CONFIG_IWLWIFI_DEVICE_TRACING)
71 void __iwl_dbg(struct device *dev,
72 	       u32 level, bool limit, const char *function,
73 	       const char *fmt, ...) __printf(5, 6);
74 #else
75 __printf(5, 6) static inline void
76 __iwl_dbg(struct device *dev,
77 	  u32 level, bool limit, const char *function,
78 	  const char *fmt, ...)
79 {}
80 #endif
81 
82 #define iwl_print_hex_error(m, p, len)					\
83 do {									\
84 	print_hex_dump(KERN_ERR, "iwl data: ",				\
85 		       DUMP_PREFIX_OFFSET, 16, 1, p, len, 1);		\
86 } while (0)
87 
88 #define __IWL_DEBUG_DEV(dev, level, limit, fmt, args...)		\
89 	do {								\
90 		CHECK_FOR_NEWLINE(fmt);					\
91 		__iwl_dbg(dev, level, limit, __func__, fmt, ##args);	\
92 	} while (0)
93 #define IWL_DEBUG(m, level, fmt, args...)				\
94 	__IWL_DEBUG_DEV((m)->dev, level, false, fmt, ##args)
95 #define IWL_DEBUG_DEV(dev, level, fmt, args...)				\
96 	__IWL_DEBUG_DEV(dev, level, false, fmt, ##args)
97 #define IWL_DEBUG_LIMIT(m, level, fmt, args...)				\
98 	__IWL_DEBUG_DEV((m)->dev, level, true, fmt, ##args)
99 
100 #ifdef CONFIG_IWLWIFI_DEBUG
101 #define iwl_print_hex_dump(m, level, p, len)				\
102 do {                                            			\
103 	if (iwl_have_debug_level(level))				\
104 		print_hex_dump(KERN_DEBUG, "iwl data: ",		\
105 			       DUMP_PREFIX_OFFSET, 16, 1, p, len, 1);	\
106 } while (0)
107 #else
108 #define iwl_print_hex_dump(m, level, p, len)
109 #endif				/* CONFIG_IWLWIFI_DEBUG */
110 
111 /*
112  * To use the debug system:
113  *
114  * If you are defining a new debug classification, simply add it to the #define
115  * list here in the form of
116  *
117  * #define IWL_DL_xxxx VALUE
118  *
119  * where xxxx should be the name of the classification (for example, WEP).
120  *
121  * You then need to either add a IWL_xxxx_DEBUG() macro definition for your
122  * classification, or use IWL_DEBUG(IWL_DL_xxxx, ...) whenever you want
123  * to send output to that classification.
124  *
125  * The active debug levels can be accessed via files
126  *
127  *	/sys/module/iwlwifi/parameters/debug
128  * when CONFIG_IWLWIFI_DEBUG=y.
129  *
130  *	/sys/kernel/debug/phy0/iwlwifi/debug/debug_level
131  * when CONFIG_IWLWIFI_DEBUGFS=y.
132  *
133  */
134 
135 /* 0x0000000F - 0x00000001 */
136 #define IWL_DL_INFO		0x00000001
137 #define IWL_DL_MAC80211		0x00000002
138 #define IWL_DL_HCMD		0x00000004
139 #define IWL_DL_TDLS		0x00000008
140 /* 0x000000F0 - 0x00000010 */
141 #define IWL_DL_QUOTA		0x00000010
142 #define IWL_DL_TE		0x00000020
143 #define IWL_DL_EEPROM		0x00000040
144 #define IWL_DL_RADIO		0x00000080
145 /* 0x00000F00 - 0x00000100 */
146 #define IWL_DL_POWER		0x00000100
147 #define IWL_DL_TEMP		0x00000200
148 #define IWL_DL_WOWLAN		0x00000400
149 #define IWL_DL_SCAN		0x00000800
150 /* 0x0000F000 - 0x00001000 */
151 #define IWL_DL_ASSOC		0x00001000
152 #define IWL_DL_DROP		0x00002000
153 #define IWL_DL_LAR		0x00004000
154 #define IWL_DL_COEX		0x00008000
155 /* 0x000F0000 - 0x00010000 */
156 #define IWL_DL_FW		0x00010000
157 #define IWL_DL_RF_KILL		0x00020000
158 #define IWL_DL_TPT		0x00040000
159 /* 0x00F00000 - 0x00100000 */
160 #define IWL_DL_RATE		0x00100000
161 #define IWL_DL_CALIB		0x00200000
162 #define IWL_DL_WEP		0x00400000
163 #define IWL_DL_TX		0x00800000
164 /* 0x0F000000 - 0x01000000 */
165 #define IWL_DL_RX		0x01000000
166 #define IWL_DL_ISR		0x02000000
167 #define IWL_DL_HT		0x04000000
168 #define IWL_DL_EXTERNAL		0x08000000
169 /* 0xF0000000 - 0x10000000 */
170 #define IWL_DL_11H		0x10000000
171 #define IWL_DL_STATS		0x20000000
172 #define IWL_DL_TX_REPLY		0x40000000
173 #define IWL_DL_TX_QUEUES	0x80000000
174 
175 #define IWL_DEBUG_INFO(p, f, a...)	IWL_DEBUG(p, IWL_DL_INFO, f, ## a)
176 #define IWL_DEBUG_TDLS(p, f, a...)	IWL_DEBUG(p, IWL_DL_TDLS, f, ## a)
177 #define IWL_DEBUG_MAC80211(p, f, a...)	IWL_DEBUG(p, IWL_DL_MAC80211, f, ## a)
178 #define IWL_DEBUG_EXTERNAL(p, f, a...)	IWL_DEBUG(p, IWL_DL_EXTERNAL, f, ## a)
179 #define IWL_DEBUG_TEMP(p, f, a...)	IWL_DEBUG(p, IWL_DL_TEMP, f, ## a)
180 #define IWL_DEBUG_SCAN(p, f, a...)	IWL_DEBUG(p, IWL_DL_SCAN, f, ## a)
181 #define IWL_DEBUG_RX(p, f, a...)	IWL_DEBUG(p, IWL_DL_RX, f, ## a)
182 #define IWL_DEBUG_TX(p, f, a...)	IWL_DEBUG(p, IWL_DL_TX, f, ## a)
183 #define IWL_DEBUG_ISR(p, f, a...)	IWL_DEBUG(p, IWL_DL_ISR, f, ## a)
184 #define IWL_DEBUG_WEP(p, f, a...)	IWL_DEBUG(p, IWL_DL_WEP, f, ## a)
185 #define IWL_DEBUG_HC(p, f, a...)	IWL_DEBUG(p, IWL_DL_HCMD, f, ## a)
186 #define IWL_DEBUG_QUOTA(p, f, a...)	IWL_DEBUG(p, IWL_DL_QUOTA, f, ## a)
187 #define IWL_DEBUG_TE(p, f, a...)	IWL_DEBUG(p, IWL_DL_TE, f, ## a)
188 #define IWL_DEBUG_EEPROM(d, f, a...)	IWL_DEBUG_DEV(d, IWL_DL_EEPROM, f, ## a)
189 #define IWL_DEBUG_CALIB(p, f, a...)	IWL_DEBUG(p, IWL_DL_CALIB, f, ## a)
190 #define IWL_DEBUG_FW(p, f, a...)	IWL_DEBUG(p, IWL_DL_FW, f, ## a)
191 #define IWL_DEBUG_RF_KILL(p, f, a...)	IWL_DEBUG(p, IWL_DL_RF_KILL, f, ## a)
192 #define IWL_DEBUG_DROP(p, f, a...)	IWL_DEBUG(p, IWL_DL_DROP, f, ## a)
193 #define IWL_DEBUG_DROP_LIMIT(p, f, a...)	\
194 		IWL_DEBUG_LIMIT(p, IWL_DL_DROP, f, ## a)
195 #define IWL_DEBUG_COEX(p, f, a...)	IWL_DEBUG(p, IWL_DL_COEX, f, ## a)
196 #define IWL_DEBUG_RATE(p, f, a...)	IWL_DEBUG(p, IWL_DL_RATE, f, ## a)
197 #define IWL_DEBUG_RATE_LIMIT(p, f, a...)	\
198 		IWL_DEBUG_LIMIT(p, IWL_DL_RATE, f, ## a)
199 #define IWL_DEBUG_ASSOC(p, f, a...)	\
200 		IWL_DEBUG(p, IWL_DL_ASSOC | IWL_DL_INFO, f, ## a)
201 #define IWL_DEBUG_ASSOC_LIMIT(p, f, a...)	\
202 		IWL_DEBUG_LIMIT(p, IWL_DL_ASSOC | IWL_DL_INFO, f, ## a)
203 #define IWL_DEBUG_HT(p, f, a...)	IWL_DEBUG(p, IWL_DL_HT, f, ## a)
204 #define IWL_DEBUG_STATS(p, f, a...)	IWL_DEBUG(p, IWL_DL_STATS, f, ## a)
205 #define IWL_DEBUG_STATS_LIMIT(p, f, a...)	\
206 		IWL_DEBUG_LIMIT(p, IWL_DL_STATS, f, ## a)
207 #define IWL_DEBUG_TX_REPLY(p, f, a...)	IWL_DEBUG(p, IWL_DL_TX_REPLY, f, ## a)
208 #define IWL_DEBUG_TX_QUEUES(p, f, a...)	IWL_DEBUG(p, IWL_DL_TX_QUEUES, f, ## a)
209 #define IWL_DEBUG_RADIO(p, f, a...)	IWL_DEBUG(p, IWL_DL_RADIO, f, ## a)
210 #define IWL_DEBUG_DEV_RADIO(p, f, a...)	IWL_DEBUG_DEV(p, IWL_DL_RADIO, f, ## a)
211 #define IWL_DEBUG_POWER(p, f, a...)	IWL_DEBUG(p, IWL_DL_POWER, f, ## a)
212 #define IWL_DEBUG_11H(p, f, a...)	IWL_DEBUG(p, IWL_DL_11H, f, ## a)
213 #define IWL_DEBUG_TPT(p, f, a...)	IWL_DEBUG(p, IWL_DL_TPT, f, ## a)
214 #define IWL_DEBUG_WOWLAN(p, f, a...)	IWL_DEBUG(p, IWL_DL_WOWLAN, f, ## a)
215 #define IWL_DEBUG_LAR(p, f, a...)	IWL_DEBUG(p, IWL_DL_LAR, f, ## a)
216 #define IWL_DEBUG_FW_INFO(p, f, a...)		\
217 		IWL_DEBUG(p, IWL_DL_INFO | IWL_DL_FW, f, ## a)
218 
219 #endif
220