drivers/gpu/drm/drm_debugfs.c

   1 /*
   2  * Created: Sun Dec 21 13:08:50 2008 by bgamari@gmail.com
   3  *
   4  * Copyright 2008 Ben Gamari <bgamari@gmail.com>
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice (including the next
  14  * paragraph) shall be included in all copies or substantial portions of the
  15  * Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  21  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  22  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  23  * OTHER DEALINGS IN THE SOFTWARE.
  24  */
  25
  26 #include <linux/debugfs.h>
  27 #include <linux/export.h>
  28 #include <linux/seq_file.h>
  29 #include <linux/slab.h>
  30 #include <linux/uaccess.h>
  31
  32 #include <drm/drm_atomic.h>
  33 #include <drm/drm_auth.h>
  34 #include <drm/drm_bridge.h>
  35 #include <drm/drm_client.h>
  36 #include <drm/drm_debugfs.h>
  37 #include <drm/drm_device.h>
  38 #include <drm/drm_drv.h>
  39 #include <drm/drm_edid.h>
  40 #include <drm/drm_file.h>
  41 #include <drm/drm_gem.h>
  42 #include <drm/drm_managed.h>
  43 #include <drm/drm_gpuvm.h>
  44
  45 #include "drm_crtc_internal.h"
  46 #include "drm_internal.h"
  47
  48 /***************************************************
  49  * Initialization, etc.
  50  **************************************************/
  51
  52 static int drm_name_info(struct seq_file *m, void *data)
  53 {
  54         struct drm_debugfs_entry *entry = m->private;
  55         struct drm_device *dev = entry->dev;
  56         struct drm_master *master;
  57
  58         mutex_lock(&dev->master_mutex);
  59         master = dev->master;
  60         seq_printf(m, "%s", dev->driver->name);
  61         if (dev->dev)
  62                 seq_printf(m, " dev=%s", dev_name(dev->dev));
  63         if (master && master->unique)
  64                 seq_printf(m, " master=%s", master->unique);
  65         if (dev->unique)
  66                 seq_printf(m, " unique=%s", dev->unique);
  67         seq_printf(m, "\n");
  68         mutex_unlock(&dev->master_mutex);
  69
  70         return 0;
  71 }
  72
  73 static int drm_clients_info(struct seq_file *m, void *data)
  74 {
  75         struct drm_debugfs_entry *entry = m->private;
  76         struct drm_device *dev = entry->dev;
  77         struct drm_file *priv;
  78         kuid_t uid;
  79
  80         seq_printf(m,
  81                    "%20s %5s %3s master a %5s %10s\n",
  82                    "command",
  83                    "tgid",
  84                    "dev",
  85                    "uid",
  86                    "magic");
  87
  88         /* dev->filelist is sorted youngest first, but we want to present
  89          * oldest first (i.e. kernel, servers, clients), so walk backwardss.
  90          */
  91         mutex_lock(&dev->filelist_mutex);
  92         list_for_each_entry_reverse(priv, &dev->filelist, lhead) {
  93                 bool is_current_master = drm_is_current_master(priv);
  94                 struct task_struct *task;
  95                 struct pid *pid;
  96
  97                 rcu_read_lock(); /* Locks priv->pid and pid_task()->comm! */
  98                 pid = rcu_dereference(priv->pid);
  99                 task = pid_task(pid, PIDTYPE_TGID);
 100                 uid = task ? __task_cred(task)->euid : GLOBAL_ROOT_UID;
 101                 seq_printf(m, "%20s %5d %3d   %c    %c %5d %10u\n",
 102                            task ? task->comm : "<unknown>",
 103                            pid_vnr(pid),
 104                            priv->minor->index,
 105                            is_current_master ? 'y' : 'n',
 106                            priv->authenticated ? 'y' : 'n',
 107                            from_kuid_munged(seq_user_ns(m), uid),
 108                            priv->magic);
 109                 rcu_read_unlock();
 110         }
 111         mutex_unlock(&dev->filelist_mutex);
 112         return 0;
 113 }
 114
 115 static int drm_gem_one_name_info(int id, void *ptr, void *data)
 116 {
 117         struct drm_gem_object *obj = ptr;
 118         struct seq_file *m = data;
 119
 120         seq_printf(m, "%6d %8zd %7d %8d\n",
 121                    obj->name, obj->size,
 122                    obj->handle_count,
 123                    kref_read(&obj->refcount));
 124         return 0;
 125 }
 126
 127 static int drm_gem_name_info(struct seq_file *m, void *data)
 128 {
 129         struct drm_debugfs_entry *entry = m->private;
 130         struct drm_device *dev = entry->dev;
 131
 132         seq_printf(m, "  name     size handles refcount\n");
 133
 134         mutex_lock(&dev->object_name_lock);
 135         idr_for_each(&dev->object_name_idr, drm_gem_one_name_info, m);
 136         mutex_unlock(&dev->object_name_lock);
 137
 138         return 0;
 139 }
 140
 141 static const struct drm_debugfs_info drm_debugfs_list[] = {
 142         {"name", drm_name_info, 0},
 143         {"clients", drm_clients_info, 0},
 144         {"gem_names", drm_gem_name_info, DRIVER_GEM},
 145 };
 146 #define DRM_DEBUGFS_ENTRIES ARRAY_SIZE(drm_debugfs_list)
 147
 148
 149 static int drm_debugfs_open(struct inode *inode, struct file *file)
 150 {
 151         struct drm_info_node *node = inode->i_private;
 152
 153         if (!device_is_registered(node->minor->kdev))
 154                 return -ENODEV;
 155
 156         return single_open(file, node->info_ent->show, node);
 157 }
 158
 159 static int drm_debugfs_entry_open(struct inode *inode, struct file *file)
 160 {
 161         struct drm_debugfs_entry *entry = inode->i_private;
 162         struct drm_debugfs_info *node = &entry->file;
 163         struct drm_minor *minor = entry->dev->primary ?: entry->dev->accel;
 164
 165         if (!device_is_registered(minor->kdev))
 166                 return -ENODEV;
 167
 168         return single_open(file, node->show, entry);
 169 }
 170
 171 static const struct file_operations drm_debugfs_entry_fops = {
 172         .owner = THIS_MODULE,
 173         .open = drm_debugfs_entry_open,
 174         .read = seq_read,
 175         .llseek = seq_lseek,
 176         .release = single_release,
 177 };
 178
 179 static const struct file_operations drm_debugfs_fops = {
 180         .owner = THIS_MODULE,
 181         .open = drm_debugfs_open,
 182         .read = seq_read,
 183         .llseek = seq_lseek,
 184         .release = single_release,
 185 };
 186
 187 /**
 188  * drm_debugfs_gpuva_info - dump the given DRM GPU VA space
 189  * @m: pointer to the &seq_file to write
 190  * @gpuvm: the &drm_gpuvm representing the GPU VA space
 191  *
 192  * Dumps the GPU VA mappings of a given DRM GPU VA manager.
 193  *
 194  * For each DRM GPU VA space drivers should call this function from their
 195  * &drm_info_list's show callback.
 196  *
 197  * Returns: 0 on success, -ENODEV if the &gpuvm is not initialized
 198  */
 199 int drm_debugfs_gpuva_info(struct seq_file *m,
 200                            struct drm_gpuvm *gpuvm)
 201 {
 202         struct drm_gpuva *va, *kva = &gpuvm->kernel_alloc_node;
 203
 204         if (!gpuvm->name)
 205                 return -ENODEV;
 206
 207         seq_printf(m, "DRM GPU VA space (%s) [0x%016llx;0x%016llx]\n",
 208                    gpuvm->name, gpuvm->mm_start, gpuvm->mm_start + gpuvm->mm_range);
 209         seq_printf(m, "Kernel reserved node [0x%016llx;0x%016llx]\n",
 210                    kva->va.addr, kva->va.addr + kva->va.range);
 211         seq_puts(m, "\n");
 212         seq_puts(m, " VAs | start              | range              | end                | object             | object offset\n");
 213         seq_puts(m, "-------------------------------------------------------------------------------------------------------------\n");
 214         drm_gpuvm_for_each_va(va, gpuvm) {
 215                 if (unlikely(va == kva))
 216                         continue;
 217
 218                 seq_printf(m, "     | 0x%016llx | 0x%016llx | 0x%016llx | 0x%016llx | 0x%016llx\n",
 219                            va->va.addr, va->va.range, va->va.addr + va->va.range,
 220                            (u64)(uintptr_t)va->gem.obj, va->gem.offset);
 221         }
 222
 223         return 0;
 224 }
 225 EXPORT_SYMBOL(drm_debugfs_gpuva_info);
 226
 227 /**
 228  * drm_debugfs_create_files - Initialize a given set of debugfs files for DRM
 229  *                      minor
 230  * @files: The array of files to create
 231  * @count: The number of files given
 232  * @root: DRI debugfs dir entry.
 233  * @minor: device minor number
 234  *
 235  * Create a given set of debugfs files represented by an array of
 236  * &struct drm_info_list in the given root directory. These files will be removed
 237  * automatically on drm_debugfs_dev_fini().
 238  */
 239 void drm_debugfs_create_files(const struct drm_info_list *files, int count,
 240                               struct dentry *root, struct drm_minor *minor)
 241 {
 242         struct drm_device *dev = minor->dev;
 243         struct drm_info_node *tmp;
 244         int i;
 245
 246         for (i = 0; i < count; i++) {
 247                 u32 features = files[i].driver_features;
 248
 249                 if (features && !drm_core_check_all_features(dev, features))
 250                         continue;
 251
 252                 tmp = drmm_kzalloc(dev, sizeof(*tmp), GFP_KERNEL);
 253                 if (tmp == NULL)
 254                         continue;
 255
 256                 tmp->minor = minor;
 257                 tmp->dent = debugfs_create_file(files[i].name,
 258                                                 0444, root, tmp,
 259                                                 &drm_debugfs_fops);
 260                 tmp->info_ent = &files[i];
 261         }
 262 }
 263 EXPORT_SYMBOL(drm_debugfs_create_files);
 264
 265 int drm_debugfs_remove_files(const struct drm_info_list *files, int count,
 266                              struct dentry *root, struct drm_minor *minor)
 267 {
 268         int i;
 269
 270         for (i = 0; i < count; i++) {
 271                 struct dentry *dent = debugfs_lookup(files[i].name, root);
 272
 273                 if (!dent)
 274                         continue;
 275
 276                 drmm_kfree(minor->dev, d_inode(dent)->i_private);
 277                 debugfs_remove(dent);
 278         }
 279         return 0;
 280 }
 281 EXPORT_SYMBOL(drm_debugfs_remove_files);
 282
 283 /**
 284  * drm_debugfs_dev_init - create debugfs directory for the device
 285  * @dev: the device which we want to create the directory for
 286  * @root: the parent directory depending on the device type
 287  *
 288  * Creates the debugfs directory for the device under the given root directory.
 289  */
 290 void drm_debugfs_dev_init(struct drm_device *dev, struct dentry *root)
 291 {
 292         dev->debugfs_root = debugfs_create_dir(dev->unique, root);
 293 }
 294
 295 /**
 296  * drm_debugfs_dev_fini - cleanup debugfs directory
 297  * @dev: the device to cleanup the debugfs stuff
 298  *
 299  * Remove the debugfs directory, might be called multiple times.
 300  */
 301 void drm_debugfs_dev_fini(struct drm_device *dev)
 302 {
 303         debugfs_remove_recursive(dev->debugfs_root);
 304         dev->debugfs_root = NULL;
 305 }
 306
 307 void drm_debugfs_dev_register(struct drm_device *dev)
 308 {
 309         drm_debugfs_add_files(dev, drm_debugfs_list, DRM_DEBUGFS_ENTRIES);
 310
 311         if (drm_core_check_feature(dev, DRIVER_MODESET)) {
 312                 drm_framebuffer_debugfs_init(dev);
 313                 drm_client_debugfs_init(dev);
 314         }
 315         if (drm_drv_uses_atomic_modeset(dev))
 316                 drm_atomic_debugfs_init(dev);
 317 }
 318
 319 int drm_debugfs_register(struct drm_minor *minor, int minor_id,
 320                          struct dentry *root)
 321 {
 322         struct drm_device *dev = minor->dev;
 323         char name[64];
 324
 325         sprintf(name, "%d", minor_id);
 326         minor->debugfs_symlink = debugfs_create_symlink(name, root,
 327                                                         dev->unique);
 328
 329         /* TODO: Only for compatibility with drivers */
 330         minor->debugfs_root = dev->debugfs_root;
 331
 332         if (dev->driver->debugfs_init && dev->render != minor)
 333                 dev->driver->debugfs_init(minor);
 334
 335         return 0;
 336 }
 337
 338 void drm_debugfs_unregister(struct drm_minor *minor)
 339 {
 340         debugfs_remove(minor->debugfs_symlink);
 341         minor->debugfs_symlink = NULL;
 342 }
 343
 344 /**
 345  * drm_debugfs_add_file - Add a given file to the DRM device debugfs file list
 346  * @dev: drm device for the ioctl
 347  * @name: debugfs file name
 348  * @show: show callback
 349  * @data: driver-private data, should not be device-specific
 350  *
 351  * Add a given file entry to the DRM device debugfs file list to be created on
 352  * drm_debugfs_init.
 353  */
 354 void drm_debugfs_add_file(struct drm_device *dev, const char *name,
 355                           int (*show)(struct seq_file*, void*), void *data)
 356 {
 357         struct drm_debugfs_entry *entry = drmm_kzalloc(dev, sizeof(*entry), GFP_KERNEL);
 358
 359         if (!entry)
 360                 return;
 361
 362         entry->file.name = name;
 363         entry->file.show = show;
 364         entry->file.data = data;
 365         entry->dev = dev;
 366
 367         debugfs_create_file(name, 0444, dev->debugfs_root, entry,
 368                             &drm_debugfs_entry_fops);
 369 }
 370 EXPORT_SYMBOL(drm_debugfs_add_file);
 371
 372 /**
 373  * drm_debugfs_add_files - Add an array of files to the DRM device debugfs file list
 374  * @dev: drm device for the ioctl
 375  * @files: The array of files to create
 376  * @count: The number of files given
 377  *
 378  * Add a given set of debugfs files represented by an array of
 379  * &struct drm_debugfs_info in the DRM device debugfs file list.
 380  */
 381 void drm_debugfs_add_files(struct drm_device *dev, const struct drm_debugfs_info *files, int count)
 382 {
 383         int i;
 384
 385         for (i = 0; i < count; i++)
 386                 drm_debugfs_add_file(dev, files[i].name, files[i].show, files[i].data);
 387 }
 388 EXPORT_SYMBOL(drm_debugfs_add_files);
 389
 390 static int connector_show(struct seq_file *m, void *data)
 391 {
 392         struct drm_connector *connector = m->private;
 393
 394         seq_printf(m, "%s\n", drm_get_connector_force_name(connector->force));
 395
 396         return 0;
 397 }
 398
 399 static int connector_open(struct inode *inode, struct file *file)
 400 {
 401         struct drm_connector *dev = inode->i_private;
 402
 403         return single_open(file, connector_show, dev);
 404 }
 405
 406 static ssize_t connector_write(struct file *file, const char __user *ubuf,
 407                                size_t len, loff_t *offp)
 408 {
 409         struct seq_file *m = file->private_data;
 410         struct drm_connector *connector = m->private;
 411         char buf[12];
 412
 413         if (len > sizeof(buf) - 1)
 414                 return -EINVAL;
 415
 416         if (copy_from_user(buf, ubuf, len))
 417                 return -EFAULT;
 418
 419         buf[len] = '\0';
 420
 421         if (sysfs_streq(buf, "on"))
 422                 connector->force = DRM_FORCE_ON;
 423         else if (sysfs_streq(buf, "digital"))
 424                 connector->force = DRM_FORCE_ON_DIGITAL;
 425         else if (sysfs_streq(buf, "off"))
 426                 connector->force = DRM_FORCE_OFF;
 427         else if (sysfs_streq(buf, "unspecified"))
 428                 connector->force = DRM_FORCE_UNSPECIFIED;
 429         else
 430                 return -EINVAL;
 431
 432         return len;
 433 }
 434
 435 static int edid_show(struct seq_file *m, void *data)
 436 {
 437         return drm_edid_override_show(m->private, m);
 438 }
 439
 440 static int edid_open(struct inode *inode, struct file *file)
 441 {
 442         struct drm_connector *dev = inode->i_private;
 443
 444         return single_open(file, edid_show, dev);
 445 }
 446
 447 static ssize_t edid_write(struct file *file, const char __user *ubuf,
 448                           size_t len, loff_t *offp)
 449 {
 450         struct seq_file *m = file->private_data;
 451         struct drm_connector *connector = m->private;
 452         char *buf;
 453         int ret;
 454
 455         buf = memdup_user(ubuf, len);
 456         if (IS_ERR(buf))
 457                 return PTR_ERR(buf);
 458
 459         if (len == 5 && !strncmp(buf, "reset", 5))
 460                 ret = drm_edid_override_reset(connector);
 461         else
 462                 ret = drm_edid_override_set(connector, buf, len);
 463
 464         kfree(buf);
 465
 466         return ret ? ret : len;
 467 }
 468
 469 /*
 470  * Returns the min and max vrr vfreq through the connector's debugfs file.
 471  * Example usage: cat /sys/kernel/debug/dri/0/DP-1/vrr_range
 472  */
 473 static int vrr_range_show(struct seq_file *m, void *data)
 474 {
 475         struct drm_connector *connector = m->private;
 476
 477         if (connector->status != connector_status_connected)
 478                 return -ENODEV;
 479
 480         seq_printf(m, "Min: %u\n", connector->display_info.monitor_range.min_vfreq);
 481         seq_printf(m, "Max: %u\n", connector->display_info.monitor_range.max_vfreq);
 482
 483         return 0;
 484 }
 485 DEFINE_SHOW_ATTRIBUTE(vrr_range);
 486
 487 /*
 488  * Returns Connector's max supported bpc through debugfs file.
 489  * Example usage: cat /sys/kernel/debug/dri/0/DP-1/output_bpc
 490  */
 491 static int output_bpc_show(struct seq_file *m, void *data)
 492 {
 493         struct drm_connector *connector = m->private;
 494
 495         if (connector->status != connector_status_connected)
 496                 return -ENODEV;
 497
 498         seq_printf(m, "Maximum: %u\n", connector->display_info.bpc);
 499
 500         return 0;
 501 }
 502 DEFINE_SHOW_ATTRIBUTE(output_bpc);
 503
 504 static const struct file_operations drm_edid_fops = {
 505         .owner = THIS_MODULE,
 506         .open = edid_open,
 507         .read = seq_read,
 508         .llseek = seq_lseek,
 509         .release = single_release,
 510         .write = edid_write
 511 };
 512
 513
 514 static const struct file_operations drm_connector_fops = {
 515         .owner = THIS_MODULE,
 516         .open = connector_open,
 517         .read = seq_read,
 518         .llseek = seq_lseek,
 519         .release = single_release,
 520         .write = connector_write
 521 };
 522
 523 void drm_debugfs_connector_add(struct drm_connector *connector)
 524 {
 525         struct drm_device *dev = connector->dev;
 526         struct dentry *root;
 527
 528         if (!dev->debugfs_root)
 529                 return;
 530
 531         root = debugfs_create_dir(connector->name, dev->debugfs_root);
 532         connector->debugfs_entry = root;
 533
 534         /* force */
 535         debugfs_create_file("force", 0644, root, connector,
 536                             &drm_connector_fops);
 537
 538         /* edid */
 539         debugfs_create_file("edid_override", 0644, root, connector,
 540                             &drm_edid_fops);
 541
 542         /* vrr range */
 543         debugfs_create_file("vrr_range", 0444, root, connector,
 544                             &vrr_range_fops);
 545
 546         /* max bpc */
 547         debugfs_create_file("output_bpc", 0444, root, connector,
 548                             &output_bpc_fops);
 549
 550         if (connector->funcs->debugfs_init)
 551                 connector->funcs->debugfs_init(connector, root);
 552 }
 553
 554 void drm_debugfs_connector_remove(struct drm_connector *connector)
 555 {
 556         if (!connector->debugfs_entry)
 557                 return;
 558
 559         debugfs_remove_recursive(connector->debugfs_entry);
 560
 561         connector->debugfs_entry = NULL;
 562 }
 563
 564 void drm_debugfs_crtc_add(struct drm_crtc *crtc)
 565 {
 566         struct drm_device *dev = crtc->dev;
 567         struct dentry *root;
 568         char *name;
 569
 570         name = kasprintf(GFP_KERNEL, "crtc-%d", crtc->index);
 571         if (!name)
 572                 return;
 573
 574         root = debugfs_create_dir(name, dev->debugfs_root);
 575         kfree(name);
 576
 577         crtc->debugfs_entry = root;
 578
 579         drm_debugfs_crtc_crc_add(crtc);
 580 }
 581
 582 void drm_debugfs_crtc_remove(struct drm_crtc *crtc)
 583 {
 584         debugfs_remove_recursive(crtc->debugfs_entry);
 585         crtc->debugfs_entry = NULL;
 586 }
 587
 588 static int bridges_show(struct seq_file *m, void *data)
 589 {
 590         struct drm_encoder *encoder = m->private;
 591         struct drm_printer p = drm_seq_file_printer(m);
 592         struct drm_bridge *bridge;
 593         unsigned int idx = 0;
 594
 595         drm_for_each_bridge_in_chain(encoder, bridge) {
 596                 drm_printf(&p, "bridge[%d]: %ps\n", idx++, bridge->funcs);
 597                 drm_printf(&p, "\ttype: [%d] %s\n",
 598                            bridge->type,
 599                            drm_get_connector_type_name(bridge->type));
 600 #ifdef CONFIG_OF
 601                 if (bridge->of_node)
 602                         drm_printf(&p, "\tOF: %pOFfc\n", bridge->of_node);
 603 #endif
 604                 drm_printf(&p, "\tops: [0x%x]", bridge->ops);
 605                 if (bridge->ops & DRM_BRIDGE_OP_DETECT)
 606                         drm_puts(&p, " detect");
 607                 if (bridge->ops & DRM_BRIDGE_OP_EDID)
 608                         drm_puts(&p, " edid");
 609                 if (bridge->ops & DRM_BRIDGE_OP_HPD)
 610                         drm_puts(&p, " hpd");
 611                 if (bridge->ops & DRM_BRIDGE_OP_MODES)
 612                         drm_puts(&p, " modes");
 613                 drm_puts(&p, "\n");
 614         }
 615
 616         return 0;
 617 }
 618 DEFINE_SHOW_ATTRIBUTE(bridges);
 619
 620 void drm_debugfs_encoder_add(struct drm_encoder *encoder)
 621 {
 622         struct drm_minor *minor = encoder->dev->primary;
 623         struct dentry *root;
 624         char *name;
 625
 626         name = kasprintf(GFP_KERNEL, "encoder-%d", encoder->index);
 627         if (!name)
 628                 return;
 629
 630         root = debugfs_create_dir(name, minor->debugfs_root);
 631         kfree(name);
 632
 633         encoder->debugfs_entry = root;
 634
 635         /* bridges list */
 636         debugfs_create_file("bridges", 0444, root, encoder,
 637                             &bridges_fops);
 638
 639         if (encoder->funcs && encoder->funcs->debugfs_init)
 640                 encoder->funcs->debugfs_init(encoder, root);
 641 }
 642
 643 void drm_debugfs_encoder_remove(struct drm_encoder *encoder)
 644 {
 645         debugfs_remove_recursive(encoder->debugfs_entry);
 646         encoder->debugfs_entry = NULL;
 647 }