drivers/gpu/drm/drm_debugfs.c

   1 /**
   2  * \file drm_debugfs.c
   3  * debugfs support for DRM
   4  *
   5  * \author Ben Gamari <bgamari@gmail.com>
   6  */
   7
   8 /*
   9  * Created: Sun Dec 21 13:08:50 2008 by bgamari@gmail.com
  10  *
  11  * Copyright 2008 Ben Gamari <bgamari@gmail.com>
  12  *
  13  * Permission is hereby granted, free of charge, to any person obtaining a
  14  * copy of this software and associated documentation files (the "Software"),
  15  * to deal in the Software without restriction, including without limitation
  16  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  17  * and/or sell copies of the Software, and to permit persons to whom the
  18  * Software is furnished to do so, subject to the following conditions:
  19  *
  20  * The above copyright notice and this permission notice (including the next
  21  * paragraph) shall be included in all copies or substantial portions of the
  22  * Software.
  23  *
  24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  25  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  26  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  27  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  28  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  29  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  30  * OTHER DEALINGS IN THE SOFTWARE.
  31  */
  32
  33 #include <linux/debugfs.h>
  34 #include <linux/seq_file.h>
  35 #include <linux/slab.h>
  36 #include <linux/export.h>
  37 #include <drm/drmP.h>
  38 #include <drm/drm_edid.h>
  39 #include <drm/drm_atomic.h>
  40 #include "drm_internal.h"
  41
  42 #if defined(CONFIG_DEBUG_FS)
  43
  44 /***************************************************
  45  * Initialization, etc.
  46  **************************************************/
  47
  48 static const struct drm_info_list drm_debugfs_list[] = {
  49         {"name", drm_name_info, 0},
  50         {"clients", drm_clients_info, 0},
  51         {"gem_names", drm_gem_name_info, DRIVER_GEM},
  52 };
  53 #define DRM_DEBUGFS_ENTRIES ARRAY_SIZE(drm_debugfs_list)
  54
  55
  56 static int drm_debugfs_open(struct inode *inode, struct file *file)
  57 {
  58         struct drm_info_node *node = inode->i_private;
  59
  60         return single_open(file, node->info_ent->show, node);
  61 }
  62
  63
  64 static const struct file_operations drm_debugfs_fops = {
  65         .owner = THIS_MODULE,
  66         .open = drm_debugfs_open,
  67         .read = seq_read,
  68         .llseek = seq_lseek,
  69         .release = single_release,
  70 };
  71
  72
  73 /**
  74  * Initialize a given set of debugfs files for a device
  75  *
  76  * \param files The array of files to create
  77  * \param count The number of files given
  78  * \param root DRI debugfs dir entry.
  79  * \param minor device minor number
  80  * \return Zero on success, non-zero on failure
  81  *
  82  * Create a given set of debugfs files represented by an array of
  83  * gdm_debugfs_lists in the given root directory.
  84  */
  85 int drm_debugfs_create_files(const struct drm_info_list *files, int count,
  86                              struct dentry *root, struct drm_minor *minor)
  87 {
  88         struct drm_device *dev = minor->dev;
  89         struct dentry *ent;
  90         struct drm_info_node *tmp;
  91         int i, ret;
  92
  93         for (i = 0; i < count; i++) {
  94                 u32 features = files[i].driver_features;
  95
  96                 if (features != 0 &&
  97                     (dev->driver->driver_features & features) != features)
  98                         continue;
  99
 100                 tmp = kmalloc(sizeof(struct drm_info_node), GFP_KERNEL);
 101                 if (tmp == NULL) {
 102                         ret = -1;
 103                         goto fail;
 104                 }
 105                 ent = debugfs_create_file(files[i].name, S_IFREG | S_IRUGO,
 106                                           root, tmp, &drm_debugfs_fops);
 107                 if (!ent) {
 108                         DRM_ERROR("Cannot create /sys/kernel/debug/dri/%pd/%s\n",
 109                                   root, files[i].name);
 110                         kfree(tmp);
 111                         ret = -1;
 112                         goto fail;
 113                 }
 114
 115                 tmp->minor = minor;
 116                 tmp->dent = ent;
 117                 tmp->info_ent = &files[i];
 118
 119                 mutex_lock(&minor->debugfs_lock);
 120                 list_add(&tmp->list, &minor->debugfs_list);
 121                 mutex_unlock(&minor->debugfs_lock);
 122         }
 123         return 0;
 124
 125 fail:
 126         drm_debugfs_remove_files(files, count, minor);
 127         return ret;
 128 }
 129 EXPORT_SYMBOL(drm_debugfs_create_files);
 130
 131 /**
 132  * Initialize the DRI debugfs filesystem for a device
 133  *
 134  * \param dev DRM device
 135  * \param minor device minor number
 136  * \param root DRI debugfs dir entry.
 137  *
 138  * Create the DRI debugfs root entry "/sys/kernel/debug/dri", the device debugfs root entry
 139  * "/sys/kernel/debug/dri/%minor%/", and each entry in debugfs_list as
 140  * "/sys/kernel/debug/dri/%minor%/%name%".
 141  */
 142 int drm_debugfs_init(struct drm_minor *minor, int minor_id,
 143                      struct dentry *root)
 144 {
 145         struct drm_device *dev = minor->dev;
 146         char name[64];
 147         int ret;
 148
 149         INIT_LIST_HEAD(&minor->debugfs_list);
 150         mutex_init(&minor->debugfs_lock);
 151         sprintf(name, "%d", minor_id);
 152         minor->debugfs_root = debugfs_create_dir(name, root);
 153         if (!minor->debugfs_root) {
 154                 DRM_ERROR("Cannot create /sys/kernel/debug/dri/%s\n", name);
 155                 return -1;
 156         }
 157
 158         ret = drm_debugfs_create_files(drm_debugfs_list, DRM_DEBUGFS_ENTRIES,
 159                                        minor->debugfs_root, minor);
 160         if (ret) {
 161                 debugfs_remove(minor->debugfs_root);
 162                 minor->debugfs_root = NULL;
 163                 DRM_ERROR("Failed to create core drm debugfs files\n");
 164                 return ret;
 165         }
 166
 167         if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
 168                 ret = drm_atomic_debugfs_init(minor);
 169                 if (ret) {
 170                         DRM_ERROR("Failed to create atomic debugfs files\n");
 171                         return ret;
 172                 }
 173         }
 174
 175         if (dev->driver->debugfs_init) {
 176                 ret = dev->driver->debugfs_init(minor);
 177                 if (ret) {
 178                         DRM_ERROR("DRM: Driver failed to initialize "
 179                                   "/sys/kernel/debug/dri.\n");
 180                         return ret;
 181                 }
 182         }
 183         return 0;
 184 }
 185
 186
 187 /**
 188  * Remove a list of debugfs files
 189  *
 190  * \param files The list of files
 191  * \param count The number of files
 192  * \param minor The minor of which we should remove the files
 193  * \return always zero.
 194  *
 195  * Remove all debugfs entries created by debugfs_init().
 196  */
 197 int drm_debugfs_remove_files(const struct drm_info_list *files, int count,
 198                              struct drm_minor *minor)
 199 {
 200         struct list_head *pos, *q;
 201         struct drm_info_node *tmp;
 202         int i;
 203
 204         mutex_lock(&minor->debugfs_lock);
 205         for (i = 0; i < count; i++) {
 206                 list_for_each_safe(pos, q, &minor->debugfs_list) {
 207                         tmp = list_entry(pos, struct drm_info_node, list);
 208                         if (tmp->info_ent == &files[i]) {
 209                                 debugfs_remove(tmp->dent);
 210                                 list_del(pos);
 211                                 kfree(tmp);
 212                         }
 213                 }
 214         }
 215         mutex_unlock(&minor->debugfs_lock);
 216         return 0;
 217 }
 218 EXPORT_SYMBOL(drm_debugfs_remove_files);
 219
 220 /**
 221  * Cleanup the debugfs filesystem resources.
 222  *
 223  * \param minor device minor number.
 224  * \return always zero.
 225  *
 226  * Remove all debugfs entries created by debugfs_init().
 227  */
 228 int drm_debugfs_cleanup(struct drm_minor *minor)
 229 {
 230         struct drm_device *dev = minor->dev;
 231         int ret;
 232
 233         if (!minor->debugfs_root)
 234                 return 0;
 235
 236         if (dev->driver->debugfs_cleanup)
 237                 dev->driver->debugfs_cleanup(minor);
 238
 239         if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
 240                 ret = drm_atomic_debugfs_cleanup(minor);
 241                 if (ret) {
 242                         DRM_ERROR("DRM: Failed to remove atomic debugfs entries\n");
 243                         return ret;
 244                 }
 245         }
 246
 247         drm_debugfs_remove_files(drm_debugfs_list, DRM_DEBUGFS_ENTRIES, minor);
 248
 249         debugfs_remove(minor->debugfs_root);
 250         minor->debugfs_root = NULL;
 251
 252         return 0;
 253 }
 254
 255 static int connector_show(struct seq_file *m, void *data)
 256 {
 257         struct drm_connector *connector = m->private;
 258         const char *status;
 259
 260         switch (connector->force) {
 261         case DRM_FORCE_ON:
 262                 status = "on\n";
 263                 break;
 264
 265         case DRM_FORCE_ON_DIGITAL:
 266                 status = "digital\n";
 267                 break;
 268
 269         case DRM_FORCE_OFF:
 270                 status = "off\n";
 271                 break;
 272
 273         case DRM_FORCE_UNSPECIFIED:
 274                 status = "unspecified\n";
 275                 break;
 276
 277         default:
 278                 return 0;
 279         }
 280
 281         seq_puts(m, status);
 282
 283         return 0;
 284 }
 285
 286 static int connector_open(struct inode *inode, struct file *file)
 287 {
 288         struct drm_connector *dev = inode->i_private;
 289
 290         return single_open(file, connector_show, dev);
 291 }
 292
 293 static ssize_t connector_write(struct file *file, const char __user *ubuf,
 294                                size_t len, loff_t *offp)
 295 {
 296         struct seq_file *m = file->private_data;
 297         struct drm_connector *connector = m->private;
 298         char buf[12];
 299
 300         if (len > sizeof(buf) - 1)
 301                 return -EINVAL;
 302
 303         if (copy_from_user(buf, ubuf, len))
 304                 return -EFAULT;
 305
 306         buf[len] = '\0';
 307
 308         if (!strcmp(buf, "on"))
 309                 connector->force = DRM_FORCE_ON;
 310         else if (!strcmp(buf, "digital"))
 311                 connector->force = DRM_FORCE_ON_DIGITAL;
 312         else if (!strcmp(buf, "off"))
 313                 connector->force = DRM_FORCE_OFF;
 314         else if (!strcmp(buf, "unspecified"))
 315                 connector->force = DRM_FORCE_UNSPECIFIED;
 316         else
 317                 return -EINVAL;
 318
 319         return len;
 320 }
 321
 322 static int edid_show(struct seq_file *m, void *data)
 323 {
 324         struct drm_connector *connector = m->private;
 325         struct drm_property_blob *edid = connector->edid_blob_ptr;
 326
 327         if (connector->override_edid && edid)
 328                 seq_write(m, edid->data, edid->length);
 329
 330         return 0;
 331 }
 332
 333 static int edid_open(struct inode *inode, struct file *file)
 334 {
 335         struct drm_connector *dev = inode->i_private;
 336
 337         return single_open(file, edid_show, dev);
 338 }
 339
 340 static ssize_t edid_write(struct file *file, const char __user *ubuf,
 341                           size_t len, loff_t *offp)
 342 {
 343         struct seq_file *m = file->private_data;
 344         struct drm_connector *connector = m->private;
 345         char *buf;
 346         struct edid *edid;
 347         int ret;
 348
 349         buf = memdup_user(ubuf, len);
 350         if (IS_ERR(buf))
 351                 return PTR_ERR(buf);
 352
 353         edid = (struct edid *) buf;
 354
 355         if (len == 5 && !strncmp(buf, "reset", 5)) {
 356                 connector->override_edid = false;
 357                 ret = drm_mode_connector_update_edid_property(connector, NULL);
 358         } else if (len < EDID_LENGTH ||
 359                    EDID_LENGTH * (1 + edid->extensions) > len)
 360                 ret = -EINVAL;
 361         else {
 362                 connector->override_edid = false;
 363                 ret = drm_mode_connector_update_edid_property(connector, edid);
 364                 if (!ret)
 365                         connector->override_edid = true;
 366         }
 367
 368         kfree(buf);
 369
 370         return (ret) ? ret : len;
 371 }
 372
 373 static const struct file_operations drm_edid_fops = {
 374         .owner = THIS_MODULE,
 375         .open = edid_open,
 376         .read = seq_read,
 377         .llseek = seq_lseek,
 378         .release = single_release,
 379         .write = edid_write
 380 };
 381
 382
 383 static const struct file_operations drm_connector_fops = {
 384         .owner = THIS_MODULE,
 385         .open = connector_open,
 386         .read = seq_read,
 387         .llseek = seq_lseek,
 388         .release = single_release,
 389         .write = connector_write
 390 };
 391
 392 int drm_debugfs_connector_add(struct drm_connector *connector)
 393 {
 394         struct drm_minor *minor = connector->dev->primary;
 395         struct dentry *root, *ent;
 396
 397         if (!minor->debugfs_root)
 398                 return -1;
 399
 400         root = debugfs_create_dir(connector->name, minor->debugfs_root);
 401         if (!root)
 402                 return -ENOMEM;
 403
 404         connector->debugfs_entry = root;
 405
 406         /* force */
 407         ent = debugfs_create_file("force", S_IRUGO | S_IWUSR, root, connector,
 408                                   &drm_connector_fops);
 409         if (!ent)
 410                 goto error;
 411
 412         /* edid */
 413         ent = debugfs_create_file("edid_override", S_IRUGO | S_IWUSR, root,
 414                                   connector, &drm_edid_fops);
 415         if (!ent)
 416                 goto error;
 417
 418         return 0;
 419
 420 error:
 421         debugfs_remove_recursive(connector->debugfs_entry);
 422         connector->debugfs_entry = NULL;
 423         return -ENOMEM;
 424 }
 425
 426 void drm_debugfs_connector_remove(struct drm_connector *connector)
 427 {
 428         if (!connector->debugfs_entry)
 429                 return;
 430
 431         debugfs_remove_recursive(connector->debugfs_entry);
 432
 433         connector->debugfs_entry = NULL;
 434 }
 435
 436 int drm_debugfs_crtc_add(struct drm_crtc *crtc)
 437 {
 438         struct drm_minor *minor = crtc->dev->primary;
 439         struct dentry *root;
 440         char *name;
 441
 442         name = kasprintf(GFP_KERNEL, "crtc-%d", crtc->index);
 443         if (!name)
 444                 return -ENOMEM;
 445
 446         root = debugfs_create_dir(name, minor->debugfs_root);
 447         kfree(name);
 448         if (!root)
 449                 return -ENOMEM;
 450
 451         crtc->debugfs_entry = root;
 452
 453         if (drm_debugfs_crtc_crc_add(crtc))
 454                 goto error;
 455
 456         return 0;
 457
 458 error:
 459         drm_debugfs_crtc_remove(crtc);
 460         return -ENOMEM;
 461 }
 462
 463 void drm_debugfs_crtc_remove(struct drm_crtc *crtc)
 464 {
 465         debugfs_remove_recursive(crtc->debugfs_entry);
 466         crtc->debugfs_entry = NULL;
 467 }
 468
 469 #endif /* CONFIG_DEBUG_FS */