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