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