379 lines · c
1/*2 * Copyright (C) 2016 Red Hat3 *4 * Permission is hereby granted, free of charge, to any person obtaining a5 * copy of this software and associated documentation files (the "Software"),6 * to deal in the Software without restriction, including without limitation7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,8 * and/or sell copies of the Software, and to permit persons to whom the9 * Software is furnished to do so, subject to the following conditions:10 *11 * The above copyright notice and this permission notice shall be included in12 * all copies or substantial portions of the Software.13 *14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL17 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR18 * 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 OR20 * OTHER DEALINGS IN THE SOFTWARE.21 *22 * Authors:23 * Rob Clark <robdclark@gmail.com>24 */25 26#include <linux/debugfs.h>27#include <linux/dynamic_debug.h>28#include <linux/io.h>29#include <linux/moduleparam.h>30#include <linux/seq_file.h>31#include <linux/slab.h>32#include <linux/stdarg.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#else58/* 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#endif78 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 if (iterator->data)104 memcpy(iterator->data,105 str + (iterator->start - iterator->offset), copy);106 107 iterator->offset = iterator->start + copy;108 iterator->remain -= copy;109 } else {110 ssize_t pos = iterator->offset - iterator->start;111 112 len = min_t(ssize_t, strlen(str), iterator->remain);113 114 if (iterator->data)115 memcpy(iterator->data + pos, str, len);116 117 iterator->offset += len;118 iterator->remain -= len;119 }120}121EXPORT_SYMBOL(__drm_puts_coredump);122 123void __drm_printfn_coredump(struct drm_printer *p, struct va_format *vaf)124{125 struct drm_print_iterator *iterator = p->arg;126 size_t len;127 char *buf;128 129 if (!iterator->remain)130 return;131 132 /* Figure out how big the string will be */133 len = snprintf(NULL, 0, "%pV", vaf);134 135 /* This is the easiest path, we've already advanced beyond the offset */136 if (iterator->offset + len <= iterator->start) {137 iterator->offset += len;138 return;139 }140 141 /* Then check if we can directly copy into the target buffer */142 if ((iterator->offset >= iterator->start) && (len < iterator->remain)) {143 ssize_t pos = iterator->offset - iterator->start;144 145 if (iterator->data)146 snprintf(((char *) iterator->data) + pos,147 iterator->remain, "%pV", vaf);148 149 iterator->offset += len;150 iterator->remain -= len;151 152 return;153 }154 155 /*156 * Finally, hit the slow path and make a temporary string to copy over157 * using _drm_puts_coredump158 */159 buf = kmalloc(len + 1, GFP_KERNEL | __GFP_NOWARN | __GFP_NORETRY);160 if (!buf)161 return;162 163 snprintf(buf, len + 1, "%pV", vaf);164 __drm_puts_coredump(p, (const char *) buf);165 166 kfree(buf);167}168EXPORT_SYMBOL(__drm_printfn_coredump);169 170void __drm_puts_seq_file(struct drm_printer *p, const char *str)171{172 seq_puts(p->arg, str);173}174EXPORT_SYMBOL(__drm_puts_seq_file);175 176void __drm_printfn_seq_file(struct drm_printer *p, struct va_format *vaf)177{178 seq_printf(p->arg, "%pV", vaf);179}180EXPORT_SYMBOL(__drm_printfn_seq_file);181 182static void __drm_dev_vprintk(const struct device *dev, const char *level,183 const void *origin, const char *prefix,184 struct va_format *vaf)185{186 const char *prefix_pad = prefix ? " " : "";187 188 if (!prefix)189 prefix = "";190 191 if (dev) {192 if (origin)193 dev_printk(level, dev, "[" DRM_NAME ":%ps]%s%s %pV",194 origin, prefix_pad, prefix, vaf);195 else196 dev_printk(level, dev, "[" DRM_NAME "]%s%s %pV",197 prefix_pad, prefix, vaf);198 } else {199 if (origin)200 printk("%s" "[" DRM_NAME ":%ps]%s%s %pV",201 level, origin, prefix_pad, prefix, vaf);202 else203 printk("%s" "[" DRM_NAME "]%s%s %pV",204 level, prefix_pad, prefix, vaf);205 }206}207 208void __drm_printfn_info(struct drm_printer *p, struct va_format *vaf)209{210 dev_info(p->arg, "[" DRM_NAME "] %pV", vaf);211}212EXPORT_SYMBOL(__drm_printfn_info);213 214void __drm_printfn_dbg(struct drm_printer *p, struct va_format *vaf)215{216 const struct drm_device *drm = p->arg;217 const struct device *dev = drm ? drm->dev : NULL;218 enum drm_debug_category category = p->category;219 220 if (!__drm_debug_enabled(category))221 return;222 223 __drm_dev_vprintk(dev, KERN_DEBUG, p->origin, p->prefix, vaf);224}225EXPORT_SYMBOL(__drm_printfn_dbg);226 227void __drm_printfn_err(struct drm_printer *p, struct va_format *vaf)228{229 struct drm_device *drm = p->arg;230 231 if (p->prefix)232 drm_err(drm, "%s %pV", p->prefix, vaf);233 else234 drm_err(drm, "%pV", vaf);235}236EXPORT_SYMBOL(__drm_printfn_err);237 238/**239 * drm_puts - print a const string to a &drm_printer stream240 * @p: the &drm printer241 * @str: const string242 *243 * Allow &drm_printer types that have a constant string244 * option to use it.245 */246void drm_puts(struct drm_printer *p, const char *str)247{248 if (p->puts)249 p->puts(p, str);250 else251 drm_printf(p, "%s", str);252}253EXPORT_SYMBOL(drm_puts);254 255/**256 * drm_printf - print to a &drm_printer stream257 * @p: the &drm_printer258 * @f: format string259 */260void drm_printf(struct drm_printer *p, const char *f, ...)261{262 va_list args;263 264 va_start(args, f);265 drm_vprintf(p, f, &args);266 va_end(args);267}268EXPORT_SYMBOL(drm_printf);269 270/**271 * drm_print_bits - print bits to a &drm_printer stream272 *273 * Print bits (in flag fields for example) in human readable form.274 *275 * @p: the &drm_printer276 * @value: field value.277 * @bits: Array with bit names.278 * @nbits: Size of bit names array.279 */280void drm_print_bits(struct drm_printer *p, unsigned long value,281 const char * const bits[], unsigned int nbits)282{283 bool first = true;284 unsigned int i;285 286 if (WARN_ON_ONCE(nbits > BITS_PER_TYPE(value)))287 nbits = BITS_PER_TYPE(value);288 289 for_each_set_bit(i, &value, nbits) {290 if (WARN_ON_ONCE(!bits[i]))291 continue;292 drm_printf(p, "%s%s", first ? "" : ",",293 bits[i]);294 first = false;295 }296 if (first)297 drm_printf(p, "(none)");298}299EXPORT_SYMBOL(drm_print_bits);300 301void drm_dev_printk(const struct device *dev, const char *level,302 const char *format, ...)303{304 struct va_format vaf;305 va_list args;306 307 va_start(args, format);308 vaf.fmt = format;309 vaf.va = &args;310 311 __drm_dev_vprintk(dev, level, __builtin_return_address(0), NULL, &vaf);312 313 va_end(args);314}315EXPORT_SYMBOL(drm_dev_printk);316 317void __drm_dev_dbg(struct _ddebug *desc, const struct device *dev,318 enum drm_debug_category category, const char *format, ...)319{320 struct va_format vaf;321 va_list args;322 323 if (!__drm_debug_enabled(category))324 return;325 326 /* we know we are printing for either syslog, tracefs, or both */327 va_start(args, format);328 vaf.fmt = format;329 vaf.va = &args;330 331 __drm_dev_vprintk(dev, KERN_DEBUG, __builtin_return_address(0), NULL, &vaf);332 333 va_end(args);334}335EXPORT_SYMBOL(__drm_dev_dbg);336 337void __drm_err(const char *format, ...)338{339 struct va_format vaf;340 va_list args;341 342 va_start(args, format);343 vaf.fmt = format;344 vaf.va = &args;345 346 __drm_dev_vprintk(NULL, KERN_ERR, __builtin_return_address(0), "*ERROR*", &vaf);347 348 va_end(args);349}350EXPORT_SYMBOL(__drm_err);351 352/**353 * drm_print_regset32 - print the contents of registers to a354 * &drm_printer stream.355 *356 * @p: the &drm printer357 * @regset: the list of registers to print.358 *359 * Often in driver debug, it's useful to be able to either capture the360 * contents of registers in the steady state using debugfs or at361 * specific points during operation. This lets the driver have a362 * single list of registers for both.363 */364void drm_print_regset32(struct drm_printer *p, struct debugfs_regset32 *regset)365{366 int namelen = 0;367 int i;368 369 for (i = 0; i < regset->nregs; i++)370 namelen = max(namelen, (int)strlen(regset->regs[i].name));371 372 for (i = 0; i < regset->nregs; i++) {373 drm_printf(p, "%*s = 0x%08x\n",374 namelen, regset->regs[i].name,375 readl(regset->base + regset->regs[i].offset));376 }377}378EXPORT_SYMBOL(drm_print_regset32);379