drivers/gpu/drm/drm_print.c

   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 <[email protected]>
  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  */
  42 unsigned long __drm_debug;
  43 EXPORT_SYMBOL(__drm_debug);
  44
  45 MODULE_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)
  56 module_param_named(debug, __drm_debug, ulong, 0600);
  57 #else
  58 /* classnames must match vals of enum drm_debug_category */
  59 DECLARE_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
  71 static struct ddebug_class_param drm_debug_bitmap = {
  72         .bits = &__drm_debug,
  73         .flags = "p",
  74         .map = &drm_debug_classes,
  75 };
  76 module_param_cb(debug, &param_ops_dyndbg_classes, &drm_debug_bitmap, 0600);
  77 #endif
  78
  79 void __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 }
 119 EXPORT_SYMBOL(__drm_puts_coredump);
 120
 121 void __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 }
 165 EXPORT_SYMBOL(__drm_printfn_coredump);
 166
 167 void __drm_puts_seq_file(struct drm_printer *p, const char *str)
 168 {
 169         seq_puts(p->arg, str);
 170 }
 171 EXPORT_SYMBOL(__drm_puts_seq_file);
 172
 173 void __drm_printfn_seq_file(struct drm_printer *p, struct va_format *vaf)
 174 {
 175         seq_printf(p->arg, "%pV", vaf);
 176 }
 177 EXPORT_SYMBOL(__drm_printfn_seq_file);
 178
 179 static void __drm_dev_vprintk(const struct device *dev, const char *level,
 180                               const void *origin, const char *prefix,
 181                               struct va_format *vaf)
 182 {
 183         const char *prefix_pad = prefix ? " " : "";
 184
 185         if (!prefix)
 186                 prefix = "";
 187
 188         if (dev) {
 189                 if (origin)
 190                         dev_printk(level, dev, "[" DRM_NAME ":%ps]%s%s %pV",
 191                                    origin, prefix_pad, prefix, vaf);
 192                 else
 193                         dev_printk(level, dev, "[" DRM_NAME "]%s%s %pV",
 194                                    prefix_pad, prefix, vaf);
 195         } else {
 196                 if (origin)
 197                         printk("%s" "[" DRM_NAME ":%ps]%s%s %pV",
 198                                level, origin, prefix_pad, prefix, vaf);
 199                 else
 200                         printk("%s" "[" DRM_NAME "]%s%s %pV",
 201                                level, prefix_pad, prefix, vaf);
 202         }
 203 }
 204
 205 void __drm_printfn_info(struct drm_printer *p, struct va_format *vaf)
 206 {
 207         dev_info(p->arg, "[" DRM_NAME "] %pV", vaf);
 208 }
 209 EXPORT_SYMBOL(__drm_printfn_info);
 210
 211 void __drm_printfn_dbg(struct drm_printer *p, struct va_format *vaf)
 212 {
 213         const struct drm_device *drm = p->arg;
 214         const struct device *dev = drm ? drm->dev : NULL;
 215         enum drm_debug_category category = p->category;
 216
 217         if (!__drm_debug_enabled(category))
 218                 return;
 219
 220         __drm_dev_vprintk(dev, KERN_DEBUG, p->origin, p->prefix, vaf);
 221 }
 222 EXPORT_SYMBOL(__drm_printfn_dbg);
 223
 224 void __drm_printfn_err(struct drm_printer *p, struct va_format *vaf)
 225 {
 226         struct drm_device *drm = p->arg;
 227
 228         if (p->prefix)
 229                 drm_err(drm, "%s %pV", p->prefix, vaf);
 230         else
 231                 drm_err(drm, "%pV", vaf);
 232 }
 233 EXPORT_SYMBOL(__drm_printfn_err);
 234
 235 /**
 236  * drm_puts - print a const string to a &drm_printer stream
 237  * @p: the &drm printer
 238  * @str: const string
 239  *
 240  * Allow &drm_printer types that have a constant string
 241  * option to use it.
 242  */
 243 void drm_puts(struct drm_printer *p, const char *str)
 244 {
 245         if (p->puts)
 246                 p->puts(p, str);
 247         else
 248                 drm_printf(p, "%s", str);
 249 }
 250 EXPORT_SYMBOL(drm_puts);
 251
 252 /**
 253  * drm_printf - print to a &drm_printer stream
 254  * @p: the &drm_printer
 255  * @f: format string
 256  */
 257 void drm_printf(struct drm_printer *p, const char *f, ...)
 258 {
 259         va_list args;
 260
 261         va_start(args, f);
 262         drm_vprintf(p, f, &args);
 263         va_end(args);
 264 }
 265 EXPORT_SYMBOL(drm_printf);
 266
 267 /**
 268  * drm_print_bits - print bits to a &drm_printer stream
 269  *
 270  * Print bits (in flag fields for example) in human readable form.
 271  *
 272  * @p: the &drm_printer
 273  * @value: field value.
 274  * @bits: Array with bit names.
 275  * @nbits: Size of bit names array.
 276  */
 277 void drm_print_bits(struct drm_printer *p, unsigned long value,
 278                     const char * const bits[], unsigned int nbits)
 279 {
 280         bool first = true;
 281         unsigned int i;
 282
 283         if (WARN_ON_ONCE(nbits > BITS_PER_TYPE(value)))
 284                 nbits = BITS_PER_TYPE(value);
 285
 286         for_each_set_bit(i, &value, nbits) {
 287                 if (WARN_ON_ONCE(!bits[i]))
 288                         continue;
 289                 drm_printf(p, "%s%s", first ? "" : ",",
 290                            bits[i]);
 291                 first = false;
 292         }
 293         if (first)
 294                 drm_printf(p, "(none)");
 295 }
 296 EXPORT_SYMBOL(drm_print_bits);
 297
 298 void drm_dev_printk(const struct device *dev, const char *level,
 299                     const char *format, ...)
 300 {
 301         struct va_format vaf;
 302         va_list args;
 303
 304         va_start(args, format);
 305         vaf.fmt = format;
 306         vaf.va = &args;
 307
 308         __drm_dev_vprintk(dev, level, __builtin_return_address(0), NULL, &vaf);
 309
 310         va_end(args);
 311 }
 312 EXPORT_SYMBOL(drm_dev_printk);
 313
 314 void __drm_dev_dbg(struct _ddebug *desc, const struct device *dev,
 315                    enum drm_debug_category category, const char *format, ...)
 316 {
 317         struct va_format vaf;
 318         va_list args;
 319
 320         if (!__drm_debug_enabled(category))
 321                 return;
 322
 323         /* we know we are printing for either syslog, tracefs, or both */
 324         va_start(args, format);
 325         vaf.fmt = format;
 326         vaf.va = &args;
 327
 328         __drm_dev_vprintk(dev, KERN_DEBUG, __builtin_return_address(0), NULL, &vaf);
 329
 330         va_end(args);
 331 }
 332 EXPORT_SYMBOL(__drm_dev_dbg);
 333
 334 void __drm_err(const char *format, ...)
 335 {
 336         struct va_format vaf;
 337         va_list args;
 338
 339         va_start(args, format);
 340         vaf.fmt = format;
 341         vaf.va = &args;
 342
 343         __drm_dev_vprintk(NULL, KERN_ERR, __builtin_return_address(0), "*ERROR*", &vaf);
 344
 345         va_end(args);
 346 }
 347 EXPORT_SYMBOL(__drm_err);
 348
 349 /**
 350  * drm_print_regset32 - print the contents of registers to a
 351  * &drm_printer stream.
 352  *
 353  * @p: the &drm printer
 354  * @regset: the list of registers to print.
 355  *
 356  * Often in driver debug, it's useful to be able to either capture the
 357  * contents of registers in the steady state using debugfs or at
 358  * specific points during operation.  This lets the driver have a
 359  * single list of registers for both.
 360  */
 361 void drm_print_regset32(struct drm_printer *p, struct debugfs_regset32 *regset)
 362 {
 363         int namelen = 0;
 364         int i;
 365
 366         for (i = 0; i < regset->nregs; i++)
 367                 namelen = max(namelen, (int)strlen(regset->regs[i].name));
 368
 369         for (i = 0; i < regset->nregs; i++) {
 370                 drm_printf(p, "%*s = 0x%08x\n",
 371                            namelen, regset->regs[i].name,
 372                            readl(regset->base + regset->regs[i].offset));
 373         }
 374 }
 375 EXPORT_SYMBOL(drm_print_regset32);