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
 232         if (!minor->debugfs_root)
 233                 return 0;
 234
 235         if (dev->driver->debugfs_cleanup)
 236                 dev->driver->debugfs_cleanup(minor);
 237
 238         drm_debugfs_remove_files(drm_debugfs_list, DRM_DEBUGFS_ENTRIES, minor);
 239
 240         debugfs_remove(minor->debugfs_root);
 241         minor->debugfs_root = NULL;
 242
 243         return 0;
 244 }
 245
 246 static int connector_show(struct seq_file *m, void *data)
 247 {
 248         struct drm_connector *connector = m->private;
 249         const char *status;
 250
 251         switch (connector->force) {
 252         case DRM_FORCE_ON:
 253                 status = "on\n";
 254                 break;
 255
 256         case DRM_FORCE_ON_DIGITAL:
 257                 status = "digital\n";
 258                 break;
 259
 260         case DRM_FORCE_OFF:
 261                 status = "off\n";
 262                 break;
 263
 264         case DRM_FORCE_UNSPECIFIED:
 265                 status = "unspecified\n";
 266                 break;
 267
 268         default:
 269                 return 0;
 270         }
 271
 272         seq_puts(m, status);
 273
 274         return 0;
 275 }
 276
 277 static int connector_open(struct inode *inode, struct file *file)
 278 {
 279         struct drm_connector *dev = inode->i_private;
 280
 281         return single_open(file, connector_show, dev);
 282 }
 283
 284 static ssize_t connector_write(struct file *file, const char __user *ubuf,
 285                                size_t len, loff_t *offp)
 286 {
 287         struct seq_file *m = file->private_data;
 288         struct drm_connector *connector = m->private;
 289         char buf[12];
 290
 291         if (len > sizeof(buf) - 1)
 292                 return -EINVAL;
 293
 294         if (copy_from_user(buf, ubuf, len))
 295                 return -EFAULT;
 296
 297         buf[len] = '\0';
 298
 299         if (!strcmp(buf, "on"))
 300                 connector->force = DRM_FORCE_ON;
 301         else if (!strcmp(buf, "digital"))
 302                 connector->force = DRM_FORCE_ON_DIGITAL;
 303         else if (!strcmp(buf, "off"))
 304                 connector->force = DRM_FORCE_OFF;
 305         else if (!strcmp(buf, "unspecified"))
 306                 connector->force = DRM_FORCE_UNSPECIFIED;
 307         else
 308                 return -EINVAL;
 309
 310         return len;
 311 }
 312
 313 static int edid_show(struct seq_file *m, void *data)
 314 {
 315         struct drm_connector *connector = m->private;
 316         struct drm_property_blob *edid = connector->edid_blob_ptr;
 317
 318         if (connector->override_edid && edid)
 319                 seq_write(m, edid->data, edid->length);
 320
 321         return 0;
 322 }
 323
 324 static int edid_open(struct inode *inode, struct file *file)
 325 {
 326         struct drm_connector *dev = inode->i_private;
 327
 328         return single_open(file, edid_show, dev);
 329 }
 330
 331 static ssize_t edid_write(struct file *file, const char __user *ubuf,
 332                           size_t len, loff_t *offp)
 333 {
 334         struct seq_file *m = file->private_data;
 335         struct drm_connector *connector = m->private;
 336         char *buf;
 337         struct edid *edid;
 338         int ret;
 339
 340         buf = memdup_user(ubuf, len);
 341         if (IS_ERR(buf))
 342                 return PTR_ERR(buf);
 343
 344         edid = (struct edid *) buf;
 345
 346         if (len == 5 && !strncmp(buf, "reset", 5)) {
 347                 connector->override_edid = false;
 348                 ret = drm_mode_connector_update_edid_property(connector, NULL);
 349         } else if (len < EDID_LENGTH ||
 350                    EDID_LENGTH * (1 + edid->extensions) > len)
 351                 ret = -EINVAL;
 352         else {
 353                 connector->override_edid = false;
 354                 ret = drm_mode_connector_update_edid_property(connector, edid);
 355                 if (!ret)
 356                         connector->override_edid = true;
 357         }
 358
 359         kfree(buf);
 360
 361         return (ret) ? ret : len;
 362 }
 363
 364 static const struct file_operations drm_edid_fops = {
 365         .owner = THIS_MODULE,
 366         .open = edid_open,
 367         .read = seq_read,
 368         .llseek = seq_lseek,
 369         .release = single_release,
 370         .write = edid_write
 371 };
 372
 373
 374 static const struct file_operations drm_connector_fops = {
 375         .owner = THIS_MODULE,
 376         .open = connector_open,
 377         .read = seq_read,
 378         .llseek = seq_lseek,
 379         .release = single_release,
 380         .write = connector_write
 381 };
 382
 383 int drm_debugfs_connector_add(struct drm_connector *connector)
 384 {
 385         struct drm_minor *minor = connector->dev->primary;
 386         struct dentry *root, *ent;
 387
 388         if (!minor->debugfs_root)
 389                 return -1;
 390
 391         root = debugfs_create_dir(connector->name, minor->debugfs_root);
 392         if (!root)
 393                 return -ENOMEM;
 394
 395         connector->debugfs_entry = root;
 396
 397         /* force */
 398         ent = debugfs_create_file("force", S_IRUGO | S_IWUSR, root, connector,
 399                                   &drm_connector_fops);
 400         if (!ent)
 401                 goto error;
 402
 403         /* edid */
 404         ent = debugfs_create_file("edid_override", S_IRUGO | S_IWUSR, root,
 405                                   connector, &drm_edid_fops);
 406         if (!ent)
 407                 goto error;
 408
 409         return 0;
 410
 411 error:
 412         debugfs_remove_recursive(connector->debugfs_entry);
 413         connector->debugfs_entry = NULL;
 414         return -ENOMEM;
 415 }
 416
 417 void drm_debugfs_connector_remove(struct drm_connector *connector)
 418 {
 419         if (!connector->debugfs_entry)
 420                 return;
 421
 422         debugfs_remove_recursive(connector->debugfs_entry);
 423
 424         connector->debugfs_entry = NULL;
 425 }
 426
 427 int drm_debugfs_crtc_add(struct drm_crtc *crtc)
 428 {
 429         struct drm_minor *minor = crtc->dev->primary;
 430         struct dentry *root;
 431         char *name;
 432
 433         name = kasprintf(GFP_KERNEL, "crtc-%d", crtc->index);
 434         if (!name)
 435                 return -ENOMEM;
 436
 437         root = debugfs_create_dir(name, minor->debugfs_root);
 438         kfree(name);
 439         if (!root)
 440                 return -ENOMEM;
 441
 442         crtc->debugfs_entry = root;
 443
 444         if (drm_debugfs_crtc_crc_add(crtc))
 445                 goto error;
 446
 447         return 0;
 448
 449 error:
 450         drm_debugfs_crtc_remove(crtc);
 451         return -ENOMEM;
 452 }
 453
 454 void drm_debugfs_crtc_remove(struct drm_crtc *crtc)
 455 {
 456         debugfs_remove_recursive(crtc->debugfs_entry);
 457         crtc->debugfs_entry = NULL;
 458 }
 459
 460 #endif /* CONFIG_DEBUG_FS */