Loading...
Note: File does not exist in v3.1.
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#include <linux/stdarg.h>
27
28#include <linux/io.h>
29#include <linux/moduleparam.h>
30#include <linux/seq_file.h>
31#include <linux/slab.h>
32#include <linux/dynamic_debug.h>
33
34#include <drm/drm.h>
35#include <drm/drm_drv.h>
36#include <drm/drm_print.h>
37
38/*
39 * __drm_debug: Enable debug output.
40 * Bitmask of DRM_UT_x. See include/drm/drm_print.h for details.
41 */
42unsigned long __drm_debug;
43EXPORT_SYMBOL(__drm_debug);
44
45MODULE_PARM_DESC(debug, "Enable debug output, where each bit enables a debug category.\n"
46"\t\tBit 0 (0x01) will enable CORE messages (drm core code)\n"
47"\t\tBit 1 (0x02) will enable DRIVER messages (drm controller code)\n"
48"\t\tBit 2 (0x04) will enable KMS messages (modesetting code)\n"
49"\t\tBit 3 (0x08) will enable PRIME messages (prime code)\n"
50"\t\tBit 4 (0x10) will enable ATOMIC messages (atomic code)\n"
51"\t\tBit 5 (0x20) will enable VBL messages (vblank code)\n"
52"\t\tBit 7 (0x80) will enable LEASE messages (leasing code)\n"
53"\t\tBit 8 (0x100) will enable DP messages (displayport code)");
54
55#if !defined(CONFIG_DRM_USE_DYNAMIC_DEBUG)
56module_param_named(debug, __drm_debug, ulong, 0600);
57#else
58/* classnames must match vals of enum drm_debug_category */
59DECLARE_DYNDBG_CLASSMAP(drm_debug_classes, DD_CLASS_TYPE_DISJOINT_BITS, 0,
60 "DRM_UT_CORE",
61 "DRM_UT_DRIVER",
62 "DRM_UT_KMS",
63 "DRM_UT_PRIME",
64 "DRM_UT_ATOMIC",
65 "DRM_UT_VBL",
66 "DRM_UT_STATE",
67 "DRM_UT_LEASE",
68 "DRM_UT_DP",
69 "DRM_UT_DRMRES");
70
71static struct ddebug_class_param drm_debug_bitmap = {
72 .bits = &__drm_debug,
73 .flags = "p",
74 .map = &drm_debug_classes,
75};
76module_param_cb(debug, ¶m_ops_dyndbg_classes, &drm_debug_bitmap, 0600);
77#endif
78
79void __drm_puts_coredump(struct drm_printer *p, const char *str)
80{
81 struct drm_print_iterator *iterator = p->arg;
82 ssize_t len;
83
84 if (!iterator->remain)
85 return;
86
87 if (iterator->offset < iterator->start) {
88 ssize_t copy;
89
90 len = strlen(str);
91
92 if (iterator->offset + len <= iterator->start) {
93 iterator->offset += len;
94 return;
95 }
96
97 copy = len - (iterator->start - iterator->offset);
98
99 if (copy > iterator->remain)
100 copy = iterator->remain;
101
102 /* Copy out the bit of the string that we need */
103 memcpy(iterator->data,
104 str + (iterator->start - iterator->offset), copy);
105
106 iterator->offset = iterator->start + copy;
107 iterator->remain -= copy;
108 } else {
109 ssize_t pos = iterator->offset - iterator->start;
110
111 len = min_t(ssize_t, strlen(str), iterator->remain);
112
113 memcpy(iterator->data + pos, str, len);
114
115 iterator->offset += len;
116 iterator->remain -= len;
117 }
118}
119EXPORT_SYMBOL(__drm_puts_coredump);
120
121void __drm_printfn_coredump(struct drm_printer *p, struct va_format *vaf)
122{
123 struct drm_print_iterator *iterator = p->arg;
124 size_t len;
125 char *buf;
126
127 if (!iterator->remain)
128 return;
129
130 /* Figure out how big the string will be */
131 len = snprintf(NULL, 0, "%pV", vaf);
132
133 /* This is the easiest path, we've already advanced beyond the offset */
134 if (iterator->offset + len <= iterator->start) {
135 iterator->offset += len;
136 return;
137 }
138
139 /* Then check if we can directly copy into the target buffer */
140 if ((iterator->offset >= iterator->start) && (len < iterator->remain)) {
141 ssize_t pos = iterator->offset - iterator->start;
142
143 snprintf(((char *) iterator->data) + pos,
144 iterator->remain, "%pV", vaf);
145
146 iterator->offset += len;
147 iterator->remain -= len;
148
149 return;
150 }
151
152 /*
153 * Finally, hit the slow path and make a temporary string to copy over
154 * using _drm_puts_coredump
155 */
156 buf = kmalloc(len + 1, GFP_KERNEL | __GFP_NOWARN | __GFP_NORETRY);
157 if (!buf)
158 return;
159
160 snprintf(buf, len + 1, "%pV", vaf);
161 __drm_puts_coredump(p, (const char *) buf);
162
163 kfree(buf);
164}
165EXPORT_SYMBOL(__drm_printfn_coredump);
166
167void __drm_puts_seq_file(struct drm_printer *p, const char *str)
168{
169 seq_puts(p->arg, str);
170}
171EXPORT_SYMBOL(__drm_puts_seq_file);
172
173void __drm_printfn_seq_file(struct drm_printer *p, struct va_format *vaf)
174{
175 seq_printf(p->arg, "%pV", vaf);
176}
177EXPORT_SYMBOL(__drm_printfn_seq_file);
178
179void __drm_printfn_info(struct drm_printer *p, struct va_format *vaf)
180{
181 dev_info(p->arg, "[" DRM_NAME "] %pV", vaf);
182}
183EXPORT_SYMBOL(__drm_printfn_info);
184
185void __drm_printfn_dbg(struct drm_printer *p, struct va_format *vaf)
186{
187 const struct drm_device *drm = p->arg;
188 const struct device *dev = drm ? drm->dev : NULL;
189 enum drm_debug_category category = p->category;
190 const char *prefix = p->prefix ?: "";
191 const char *prefix_pad = p->prefix ? " " : "";
192
193 if (!__drm_debug_enabled(category))
194 return;
195
196 /* Note: __builtin_return_address(0) is useless here. */
197 if (dev)
198 dev_printk(KERN_DEBUG, dev, "[" DRM_NAME "]%s%s %pV",
199 prefix_pad, prefix, vaf);
200 else
201 printk(KERN_DEBUG "[" DRM_NAME "]%s%s %pV",
202 prefix_pad, prefix, vaf);
203}
204EXPORT_SYMBOL(__drm_printfn_dbg);
205
206void __drm_printfn_err(struct drm_printer *p, struct va_format *vaf)
207{
208 struct drm_device *drm = p->arg;
209
210 if (p->prefix)
211 drm_err(drm, "%s %pV", p->prefix, vaf);
212 else
213 drm_err(drm, "%pV", vaf);
214}
215EXPORT_SYMBOL(__drm_printfn_err);
216
217/**
218 * drm_puts - print a const string to a &drm_printer stream
219 * @p: the &drm printer
220 * @str: const string
221 *
222 * Allow &drm_printer types that have a constant string
223 * option to use it.
224 */
225void drm_puts(struct drm_printer *p, const char *str)
226{
227 if (p->puts)
228 p->puts(p, str);
229 else
230 drm_printf(p, "%s", str);
231}
232EXPORT_SYMBOL(drm_puts);
233
234/**
235 * drm_printf - print to a &drm_printer stream
236 * @p: the &drm_printer
237 * @f: format string
238 */
239void drm_printf(struct drm_printer *p, const char *f, ...)
240{
241 va_list args;
242
243 va_start(args, f);
244 drm_vprintf(p, f, &args);
245 va_end(args);
246}
247EXPORT_SYMBOL(drm_printf);
248
249/**
250 * drm_print_bits - print bits to a &drm_printer stream
251 *
252 * Print bits (in flag fields for example) in human readable form.
253 *
254 * @p: the &drm_printer
255 * @value: field value.
256 * @bits: Array with bit names.
257 * @nbits: Size of bit names array.
258 */
259void drm_print_bits(struct drm_printer *p, unsigned long value,
260 const char * const bits[], unsigned int nbits)
261{
262 bool first = true;
263 unsigned int i;
264
265 if (WARN_ON_ONCE(nbits > BITS_PER_TYPE(value)))
266 nbits = BITS_PER_TYPE(value);
267
268 for_each_set_bit(i, &value, nbits) {
269 if (WARN_ON_ONCE(!bits[i]))
270 continue;
271 drm_printf(p, "%s%s", first ? "" : ",",
272 bits[i]);
273 first = false;
274 }
275 if (first)
276 drm_printf(p, "(none)");
277}
278EXPORT_SYMBOL(drm_print_bits);
279
280void drm_dev_printk(const struct device *dev, const char *level,
281 const char *format, ...)
282{
283 struct va_format vaf;
284 va_list args;
285
286 va_start(args, format);
287 vaf.fmt = format;
288 vaf.va = &args;
289
290 if (dev)
291 dev_printk(level, dev, "[" DRM_NAME ":%ps] %pV",
292 __builtin_return_address(0), &vaf);
293 else
294 printk("%s" "[" DRM_NAME ":%ps] %pV",
295 level, __builtin_return_address(0), &vaf);
296
297 va_end(args);
298}
299EXPORT_SYMBOL(drm_dev_printk);
300
301void __drm_dev_dbg(struct _ddebug *desc, const struct device *dev,
302 enum drm_debug_category category, const char *format, ...)
303{
304 struct va_format vaf;
305 va_list args;
306
307 if (!__drm_debug_enabled(category))
308 return;
309
310 /* we know we are printing for either syslog, tracefs, or both */
311 va_start(args, format);
312 vaf.fmt = format;
313 vaf.va = &args;
314
315 if (dev)
316 dev_printk(KERN_DEBUG, dev, "[" DRM_NAME ":%ps] %pV",
317 __builtin_return_address(0), &vaf);
318 else
319 printk(KERN_DEBUG "[" DRM_NAME ":%ps] %pV",
320 __builtin_return_address(0), &vaf);
321
322 va_end(args);
323}
324EXPORT_SYMBOL(__drm_dev_dbg);
325
326void ___drm_dbg(struct _ddebug *desc, enum drm_debug_category category, const char *format, ...)
327{
328 struct va_format vaf;
329 va_list args;
330
331 if (!__drm_debug_enabled(category))
332 return;
333
334 va_start(args, format);
335 vaf.fmt = format;
336 vaf.va = &args;
337
338 printk(KERN_DEBUG "[" DRM_NAME ":%ps] %pV",
339 __builtin_return_address(0), &vaf);
340
341 va_end(args);
342}
343EXPORT_SYMBOL(___drm_dbg);
344
345void __drm_err(const char *format, ...)
346{
347 struct va_format vaf;
348 va_list args;
349
350 va_start(args, format);
351 vaf.fmt = format;
352 vaf.va = &args;
353
354 printk(KERN_ERR "[" DRM_NAME ":%ps] *ERROR* %pV",
355 __builtin_return_address(0), &vaf);
356
357 va_end(args);
358}
359EXPORT_SYMBOL(__drm_err);
360
361/**
362 * drm_print_regset32 - print the contents of registers to a
363 * &drm_printer stream.
364 *
365 * @p: the &drm printer
366 * @regset: the list of registers to print.
367 *
368 * Often in driver debug, it's useful to be able to either capture the
369 * contents of registers in the steady state using debugfs or at
370 * specific points during operation. This lets the driver have a
371 * single list of registers for both.
372 */
373void drm_print_regset32(struct drm_printer *p, struct debugfs_regset32 *regset)
374{
375 int namelen = 0;
376 int i;
377
378 for (i = 0; i < regset->nregs; i++)
379 namelen = max(namelen, (int)strlen(regset->regs[i].name));
380
381 for (i = 0; i < regset->nregs; i++) {
382 drm_printf(p, "%*s = 0x%08x\n",
383 namelen, regset->regs[i].name,
384 readl(regset->base + regset->regs[i].offset));
385 }
386}
387EXPORT_SYMBOL(drm_print_regset32);