Branch data Line data Source code
1 : : /*
2 : : * Copyright (C) 2016 Red Hat
3 : : *
4 : : * Permission is hereby granted, free of charge, to any person obtaining a
5 : : * copy of this software and associated documentation files (the "Software"),
6 : : * to deal in the Software without restriction, including without limitation
7 : : * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 : : * and/or sell copies of the Software, and to permit persons to whom the
9 : : * Software is furnished to do so, subject to the following conditions:
10 : : *
11 : : * The above copyright notice and this permission notice shall be included in
12 : : * all copies or substantial portions of the Software.
13 : : *
14 : : * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 : : * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 : : * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17 : : * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 : : * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 : : * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 : : * OTHER DEALINGS IN THE SOFTWARE.
21 : : *
22 : : * Authors:
23 : : * Rob Clark <robdclark@gmail.com>
24 : : */
25 : :
26 : : #define DEBUG /* for pr_debug() */
27 : :
28 : : #include <stdarg.h>
29 : :
30 : : #include <linux/io.h>
31 : : #include <linux/moduleparam.h>
32 : : #include <linux/seq_file.h>
33 : : #include <linux/slab.h>
34 : :
35 : : #include <drm/drm.h>
36 : : #include <drm/drm_drv.h>
37 : : #include <drm/drm_print.h>
38 : :
39 : : /*
40 : : * __drm_debug: Enable debug output.
41 : : * Bitmask of DRM_UT_x. See include/drm/drm_print.h for details.
42 : : */
43 : : unsigned int __drm_debug;
44 : : EXPORT_SYMBOL(__drm_debug);
45 : :
46 : : MODULE_PARM_DESC(debug, "Enable debug output, where each bit enables a debug category.\n"
47 : : "\t\tBit 0 (0x01) will enable CORE messages (drm core code)\n"
48 : : "\t\tBit 1 (0x02) will enable DRIVER messages (drm controller code)\n"
49 : : "\t\tBit 2 (0x04) will enable KMS messages (modesetting code)\n"
50 : : "\t\tBit 3 (0x08) will enable PRIME messages (prime code)\n"
51 : : "\t\tBit 4 (0x10) will enable ATOMIC messages (atomic code)\n"
52 : : "\t\tBit 5 (0x20) will enable VBL messages (vblank code)\n"
53 : : "\t\tBit 7 (0x80) will enable LEASE messages (leasing code)\n"
54 : : "\t\tBit 8 (0x100) will enable DP messages (displayport code)");
55 : : module_param_named(debug, __drm_debug, int, 0600);
56 : :
57 : 0 : void __drm_puts_coredump(struct drm_printer *p, const char *str)
58 : : {
59 : 0 : struct drm_print_iterator *iterator = p->arg;
60 : 0 : ssize_t len;
61 : :
62 [ # # ]: 0 : if (!iterator->remain)
63 : : return;
64 : :
65 [ # # ]: 0 : if (iterator->offset < iterator->start) {
66 : 0 : ssize_t copy;
67 : :
68 : 0 : len = strlen(str);
69 : :
70 [ # # ]: 0 : if (iterator->offset + len <= iterator->start) {
71 : 0 : iterator->offset += len;
72 : 0 : return;
73 : : }
74 : :
75 : 0 : copy = len - (iterator->start - iterator->offset);
76 : :
77 : 0 : if (copy > iterator->remain)
78 : : copy = iterator->remain;
79 : :
80 : : /* Copy out the bit of the string that we need */
81 : 0 : memcpy(iterator->data,
82 : 0 : str + (iterator->start - iterator->offset), copy);
83 : :
84 : 0 : iterator->offset = iterator->start + copy;
85 : 0 : iterator->remain -= copy;
86 : : } else {
87 : 0 : ssize_t pos = iterator->offset - iterator->start;
88 : :
89 : 0 : len = min_t(ssize_t, strlen(str), iterator->remain);
90 : :
91 : 0 : memcpy(iterator->data + pos, str, len);
92 : :
93 : 0 : iterator->offset += len;
94 : 0 : iterator->remain -= len;
95 : : }
96 : : }
97 : : EXPORT_SYMBOL(__drm_puts_coredump);
98 : :
99 : 0 : void __drm_printfn_coredump(struct drm_printer *p, struct va_format *vaf)
100 : : {
101 : 0 : struct drm_print_iterator *iterator = p->arg;
102 : 0 : size_t len;
103 : 0 : char *buf;
104 : :
105 [ # # ]: 0 : if (!iterator->remain)
106 : : return;
107 : :
108 : : /* Figure out how big the string will be */
109 : 0 : len = snprintf(NULL, 0, "%pV", vaf);
110 : :
111 : : /* This is the easiest path, we've already advanced beyond the offset */
112 [ # # ]: 0 : if (iterator->offset + len <= iterator->start) {
113 : 0 : iterator->offset += len;
114 : 0 : return;
115 : : }
116 : :
117 : : /* Then check if we can directly copy into the target buffer */
118 [ # # # # ]: 0 : if ((iterator->offset >= iterator->start) && (len < iterator->remain)) {
119 : 0 : ssize_t pos = iterator->offset - iterator->start;
120 : :
121 : 0 : snprintf(((char *) iterator->data) + pos,
122 : : iterator->remain, "%pV", vaf);
123 : :
124 : 0 : iterator->offset += len;
125 : 0 : iterator->remain -= len;
126 : :
127 : 0 : return;
128 : : }
129 : :
130 : : /*
131 : : * Finally, hit the slow path and make a temporary string to copy over
132 : : * using _drm_puts_coredump
133 : : */
134 [ # # ]: 0 : buf = kmalloc(len + 1, GFP_KERNEL | __GFP_NOWARN | __GFP_NORETRY);
135 [ # # ]: 0 : if (!buf)
136 : : return;
137 : :
138 : 0 : snprintf(buf, len + 1, "%pV", vaf);
139 : 0 : __drm_puts_coredump(p, (const char *) buf);
140 : :
141 : 0 : kfree(buf);
142 : : }
143 : : EXPORT_SYMBOL(__drm_printfn_coredump);
144 : :
145 : 0 : void __drm_puts_seq_file(struct drm_printer *p, const char *str)
146 : : {
147 : 0 : seq_puts(p->arg, str);
148 : 0 : }
149 : : EXPORT_SYMBOL(__drm_puts_seq_file);
150 : :
151 : 0 : void __drm_printfn_seq_file(struct drm_printer *p, struct va_format *vaf)
152 : : {
153 : 0 : seq_printf(p->arg, "%pV", vaf);
154 : 0 : }
155 : : EXPORT_SYMBOL(__drm_printfn_seq_file);
156 : :
157 : 0 : void __drm_printfn_info(struct drm_printer *p, struct va_format *vaf)
158 : : {
159 : 0 : dev_info(p->arg, "[" DRM_NAME "] %pV", vaf);
160 : 0 : }
161 : : EXPORT_SYMBOL(__drm_printfn_info);
162 : :
163 : 0 : void __drm_printfn_debug(struct drm_printer *p, struct va_format *vaf)
164 : : {
165 : 0 : pr_debug("%s %pV", p->prefix, vaf);
166 : 0 : }
167 : : EXPORT_SYMBOL(__drm_printfn_debug);
168 : :
169 : 0 : void __drm_printfn_err(struct drm_printer *p, struct va_format *vaf)
170 : : {
171 : 0 : pr_err("*ERROR* %s %pV", p->prefix, vaf);
172 : 0 : }
173 : : EXPORT_SYMBOL(__drm_printfn_err);
174 : :
175 : : /**
176 : : * drm_puts - print a const string to a &drm_printer stream
177 : : * @p: the &drm printer
178 : : * @str: const string
179 : : *
180 : : * Allow &drm_printer types that have a constant string
181 : : * option to use it.
182 : : */
183 : 0 : void drm_puts(struct drm_printer *p, const char *str)
184 : : {
185 [ # # ]: 0 : if (p->puts)
186 : 0 : p->puts(p, str);
187 : : else
188 : 0 : drm_printf(p, "%s", str);
189 : 0 : }
190 : : EXPORT_SYMBOL(drm_puts);
191 : :
192 : : /**
193 : : * drm_printf - print to a &drm_printer stream
194 : : * @p: the &drm_printer
195 : : * @f: format string
196 : : */
197 : 0 : void drm_printf(struct drm_printer *p, const char *f, ...)
198 : : {
199 : 0 : va_list args;
200 : :
201 : 0 : va_start(args, f);
202 : 0 : drm_vprintf(p, f, &args);
203 : 0 : va_end(args);
204 : 0 : }
205 : : EXPORT_SYMBOL(drm_printf);
206 : :
207 : : /**
208 : : * drm_print_bits - print bits to a &drm_printer stream
209 : : *
210 : : * Print bits (in flag fields for example) in human readable form.
211 : : *
212 : : * @p: the &drm_printer
213 : : * @value: field value.
214 : : * @bits: Array with bit names.
215 : : * @nbits: Size of bit names array.
216 : : */
217 : 0 : void drm_print_bits(struct drm_printer *p, unsigned long value,
218 : : const char * const bits[], unsigned int nbits)
219 : : {
220 : 0 : bool first = true;
221 : 0 : unsigned int i;
222 : :
223 [ # # # # ]: 0 : if (WARN_ON_ONCE(nbits > BITS_PER_TYPE(value)))
224 : 0 : nbits = BITS_PER_TYPE(value);
225 : :
226 [ # # ]: 0 : for_each_set_bit(i, &value, nbits) {
227 [ # # # # ]: 0 : if (WARN_ON_ONCE(!bits[i]))
228 : 0 : continue;
229 [ # # ]: 0 : drm_printf(p, "%s%s", first ? "" : ",",
230 : : bits[i]);
231 : 0 : first = false;
232 : : }
233 [ # # ]: 0 : if (first)
234 : 0 : drm_printf(p, "(none)");
235 : 0 : }
236 : : EXPORT_SYMBOL(drm_print_bits);
237 : :
238 : 0 : void drm_dev_printk(const struct device *dev, const char *level,
239 : : const char *format, ...)
240 : : {
241 : 0 : struct va_format vaf;
242 : 0 : va_list args;
243 : :
244 : 0 : va_start(args, format);
245 : 0 : vaf.fmt = format;
246 : 0 : vaf.va = &args;
247 : :
248 [ # # ]: 0 : if (dev)
249 : 0 : dev_printk(level, dev, "[" DRM_NAME ":%ps] %pV",
250 : : __builtin_return_address(0), &vaf);
251 : : else
252 : 0 : printk("%s" "[" DRM_NAME ":%ps] %pV",
253 : : level, __builtin_return_address(0), &vaf);
254 : :
255 : 0 : va_end(args);
256 : 0 : }
257 : : EXPORT_SYMBOL(drm_dev_printk);
258 : :
259 : 0 : void drm_dev_dbg(const struct device *dev, enum drm_debug_category category,
260 : : const char *format, ...)
261 : : {
262 : 0 : struct va_format vaf;
263 : 0 : va_list args;
264 : :
265 [ # # ]: 0 : if (!drm_debug_enabled(category))
266 : 0 : return;
267 : :
268 : 0 : va_start(args, format);
269 : 0 : vaf.fmt = format;
270 : 0 : vaf.va = &args;
271 : :
272 [ # # ]: 0 : if (dev)
273 : 0 : dev_printk(KERN_DEBUG, dev, "[" DRM_NAME ":%ps] %pV",
274 : : __builtin_return_address(0), &vaf);
275 : : else
276 : 0 : printk(KERN_DEBUG "[" DRM_NAME ":%ps] %pV",
277 : : __builtin_return_address(0), &vaf);
278 : :
279 : 0 : va_end(args);
280 : : }
281 : : EXPORT_SYMBOL(drm_dev_dbg);
282 : :
283 : 11 : void __drm_dbg(enum drm_debug_category category, const char *format, ...)
284 : : {
285 : 11 : struct va_format vaf;
286 : 11 : va_list args;
287 : :
288 [ + - ]: 11 : if (!drm_debug_enabled(category))
289 : 11 : return;
290 : :
291 : 0 : va_start(args, format);
292 : 0 : vaf.fmt = format;
293 : 0 : vaf.va = &args;
294 : :
295 : 0 : printk(KERN_DEBUG "[" DRM_NAME ":%ps] %pV",
296 : : __builtin_return_address(0), &vaf);
297 : :
298 : 0 : va_end(args);
299 : : }
300 : : EXPORT_SYMBOL(__drm_dbg);
301 : :
302 : 0 : void __drm_err(const char *format, ...)
303 : : {
304 : 0 : struct va_format vaf;
305 : 0 : va_list args;
306 : :
307 : 0 : va_start(args, format);
308 : 0 : vaf.fmt = format;
309 : 0 : vaf.va = &args;
310 : :
311 : 0 : printk(KERN_ERR "[" DRM_NAME ":%ps] *ERROR* %pV",
312 : : __builtin_return_address(0), &vaf);
313 : :
314 : 0 : va_end(args);
315 : 0 : }
316 : : EXPORT_SYMBOL(__drm_err);
317 : :
318 : : /**
319 : : * drm_print_regset32 - print the contents of registers to a
320 : : * &drm_printer stream.
321 : : *
322 : : * @p: the &drm printer
323 : : * @regset: the list of registers to print.
324 : : *
325 : : * Often in driver debug, it's useful to be able to either capture the
326 : : * contents of registers in the steady state using debugfs or at
327 : : * specific points during operation. This lets the driver have a
328 : : * single list of registers for both.
329 : : */
330 : 0 : void drm_print_regset32(struct drm_printer *p, struct debugfs_regset32 *regset)
331 : : {
332 : 0 : int namelen = 0;
333 : 0 : int i;
334 : :
335 [ # # ]: 0 : for (i = 0; i < regset->nregs; i++)
336 : 0 : namelen = max(namelen, (int)strlen(regset->regs[i].name));
337 : :
338 [ # # ]: 0 : for (i = 0; i < regset->nregs; i++) {
339 : 0 : drm_printf(p, "%*s = 0x%08x\n",
340 : 0 : namelen, regset->regs[i].name,
341 : 0 : readl(regset->base + regset->regs[i].offset));
342 : : }
343 : 0 : }
344 : : EXPORT_SYMBOL(drm_print_regset32);
|
