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
  40 #if defined(CONFIG_DEBUG_FS)
  41
  42 /***************************************************
  43  * Initialization, etc.
  44  **************************************************/
  45
  46 static const struct drm_info_list drm_debugfs_list[] = {
  47         {"name", drm_name_info, 0},
  48         {"vm", drm_vm_info, 0},
  49         {"clients", drm_clients_info, 0},
  50         {"bufs", drm_bufs_info, 0},
  51         {"gem_names", drm_gem_name_info, DRIVER_GEM},
  52         {"vma", drm_vma_info, 0},
  53 };
  54 #define DRM_DEBUGFS_ENTRIES ARRAY_SIZE(drm_debugfs_list)
  55
  56
  57 static int drm_debugfs_open(struct inode *inode, struct file *file)
  58 {
  59         struct drm_info_node *node = inode->i_private;
  60
  61         return single_open(file, node->info_ent->show, node);
  62 }
  63
  64
  65 static const struct file_operations drm_debugfs_fops = {
  66         .owner = THIS_MODULE,
  67         .open = drm_debugfs_open,
  68         .read = seq_read,
  69         .llseek = seq_lseek,
  70         .release = single_release,
  71 };
  72
  73
  74 /**
  75  * Initialize a given set of debugfs files for a device
  76  *
  77  * \param files The array of files to create
  78  * \param count The number of files given
  79  * \param root DRI debugfs dir entry.
  80  * \param minor device minor number
  81  * \return Zero on success, non-zero on failure
  82  *
  83  * Create a given set of debugfs files represented by an array of
  84  * gdm_debugfs_lists in the given root directory.
  85  */
  86 int drm_debugfs_create_files(const struct drm_info_list *files, int count,
  87                              struct dentry *root, struct drm_minor *minor)
  88 {
  89         struct drm_device *dev = minor->dev;
  90         struct dentry *ent;
  91         struct drm_info_node *tmp;
  92         int i, ret;
  93
  94         for (i = 0; i < count; i++) {
  95                 u32 features = files[i].driver_features;
  96
  97                 if (features != 0 &&
  98                     (dev->driver->driver_features & features) != features)
  99                         continue;
 100
 101                 tmp = kmalloc(sizeof(struct drm_info_node), GFP_KERNEL);
 102                 if (tmp == NULL) {
 103                         ret = -1;
 104                         goto fail;
 105                 }
 106                 ent = debugfs_create_file(files[i].name, S_IFREG | S_IRUGO,
 107                                           root, tmp, &drm_debugfs_fops);
 108                 if (!ent) {
 109                         DRM_ERROR("Cannot create /sys/kernel/debug/dri/%s/%s\n",
 110                                   root->d_name.name, files[i].name);
 111                         kfree(tmp);
 112                         ret = -1;
 113                         goto fail;
 114                 }
 115
 116                 tmp->minor = minor;
 117                 tmp->dent = ent;
 118                 tmp->info_ent = &files[i];
 119
 120                 mutex_lock(&minor->debugfs_lock);
 121                 list_add(&tmp->list, &minor->debugfs_list);
 122                 mutex_unlock(&minor->debugfs_lock);
 123         }
 124         return 0;
 125
 126 fail:
 127         drm_debugfs_remove_files(files, count, minor);
 128         return ret;
 129 }
 130 EXPORT_SYMBOL(drm_debugfs_create_files);
 131
 132 /**
 133  * Initialize the DRI debugfs filesystem for a device
 134  *
 135  * \param dev DRM device
 136  * \param minor device minor number
 137  * \param root DRI debugfs dir entry.
 138  *
 139  * Create the DRI debugfs root entry "/sys/kernel/debug/dri", the device debugfs root entry
 140  * "/sys/kernel/debug/dri/%minor%/", and each entry in debugfs_list as
 141  * "/sys/kernel/debug/dri/%minor%/%name%".
 142  */
 143 int drm_debugfs_init(struct drm_minor *minor, int minor_id,
 144                      struct dentry *root)
 145 {
 146         struct drm_device *dev = minor->dev;
 147         char name[64];
 148         int ret;
 149
 150         INIT_LIST_HEAD(&minor->debugfs_list);
 151         mutex_init(&minor->debugfs_lock);
 152         sprintf(name, "%d", minor_id);
 153         minor->debugfs_root = debugfs_create_dir(name, root);
 154         if (!minor->debugfs_root) {
 155                 DRM_ERROR("Cannot create /sys/kernel/debug/dri/%s\n", name);
 156                 return -1;
 157         }
 158
 159         ret = drm_debugfs_create_files(drm_debugfs_list, DRM_DEBUGFS_ENTRIES,
 160                                        minor->debugfs_root, minor);
 161         if (ret) {
 162                 debugfs_remove(minor->debugfs_root);
 163                 minor->debugfs_root = NULL;
 164                 DRM_ERROR("Failed to create core drm debugfs files\n");
 165                 return ret;
 166         }
 167
 168         if (dev->driver->debugfs_init) {
 169                 ret = dev->driver->debugfs_init(minor);
 170                 if (ret) {
 171                         DRM_ERROR("DRM: Driver failed to initialize "
 172                                   "/sys/kernel/debug/dri.\n");
 173                         return ret;
 174                 }
 175         }
 176         return 0;
 177 }
 178
 179
 180 /**
 181  * Remove a list of debugfs files
 182  *
 183  * \param files The list of files
 184  * \param count The number of files
 185  * \param minor The minor of which we should remove the files
 186  * \return always zero.
 187  *
 188  * Remove all debugfs entries created by debugfs_init().
 189  */
 190 int drm_debugfs_remove_files(const struct drm_info_list *files, int count,
 191                              struct drm_minor *minor)
 192 {
 193         struct list_head *pos, *q;
 194         struct drm_info_node *tmp;
 195         int i;
 196
 197         mutex_lock(&minor->debugfs_lock);
 198         for (i = 0; i < count; i++) {
 199                 list_for_each_safe(pos, q, &minor->debugfs_list) {
 200                         tmp = list_entry(pos, struct drm_info_node, list);
 201                         if (tmp->info_ent == &files[i]) {
 202                                 debugfs_remove(tmp->dent);
 203                                 list_del(pos);
 204                                 kfree(tmp);
 205                         }
 206                 }
 207         }
 208         mutex_unlock(&minor->debugfs_lock);
 209         return 0;
 210 }
 211 EXPORT_SYMBOL(drm_debugfs_remove_files);
 212
 213 /**
 214  * Cleanup the debugfs filesystem resources.
 215  *
 216  * \param minor device minor number.
 217  * \return always zero.
 218  *
 219  * Remove all debugfs entries created by debugfs_init().
 220  */
 221 int drm_debugfs_cleanup(struct drm_minor *minor)
 222 {
 223         struct drm_device *dev = minor->dev;
 224
 225         if (!minor->debugfs_root)
 226                 return 0;
 227
 228         if (dev->driver->debugfs_cleanup)
 229                 dev->driver->debugfs_cleanup(minor);
 230
 231         drm_debugfs_remove_files(drm_debugfs_list, DRM_DEBUGFS_ENTRIES, minor);
 232
 233         debugfs_remove(minor->debugfs_root);
 234         minor->debugfs_root = NULL;
 235
 236         return 0;
 237 }
 238
 239 static int connector_show(struct seq_file *m, void *data)
 240 {
 241         struct drm_connector *connector = m->private;
 242         const char *status;
 243
 244         switch (connector->force) {
 245         case DRM_FORCE_ON:
 246                 status = "on\n";
 247                 break;
 248
 249         case DRM_FORCE_ON_DIGITAL:
 250                 status = "digital\n";
 251                 break;
 252
 253         case DRM_FORCE_OFF:
 254                 status = "off\n";
 255                 break;
 256
 257         case DRM_FORCE_UNSPECIFIED:
 258                 status = "unspecified\n";
 259                 break;
 260
 261         default:
 262                 return 0;
 263         }
 264
 265         seq_puts(m, status);
 266
 267         return 0;
 268 }
 269
 270 static int connector_open(struct inode *inode, struct file *file)
 271 {
 272         struct drm_connector *dev = inode->i_private;
 273
 274         return single_open(file, connector_show, dev);
 275 }
 276
 277 static ssize_t connector_write(struct file *file, const char __user *ubuf,
 278                                size_t len, loff_t *offp)
 279 {
 280         struct seq_file *m = file->private_data;
 281         struct drm_connector *connector = m->private;
 282         char buf[12];
 283
 284         if (len > sizeof(buf) - 1)
 285                 return -EINVAL;
 286
 287         if (copy_from_user(buf, ubuf, len))
 288                 return -EFAULT;
 289
 290         buf[len] = '\0';
 291
 292         if (!strcmp(buf, "on"))
 293                 connector->force = DRM_FORCE_ON;
 294         else if (!strcmp(buf, "digital"))
 295                 connector->force = DRM_FORCE_ON_DIGITAL;
 296         else if (!strcmp(buf, "off"))
 297                 connector->force = DRM_FORCE_OFF;
 298         else if (!strcmp(buf, "unspecified"))
 299                 connector->force = DRM_FORCE_UNSPECIFIED;
 300         else
 301                 return -EINVAL;
 302
 303         return len;
 304 }
 305
 306 static int edid_show(struct seq_file *m, void *data)
 307 {
 308         struct drm_connector *connector = m->private;
 309         struct drm_property_blob *edid = connector->edid_blob_ptr;
 310
 311         if (connector->override_edid && edid)
 312                 seq_write(m, edid->data, edid->length);
 313
 314         return 0;
 315 }
 316
 317 static int edid_open(struct inode *inode, struct file *file)
 318 {
 319         struct drm_connector *dev = inode->i_private;
 320
 321         return single_open(file, edid_show, dev);
 322 }
 323
 324 static ssize_t edid_write(struct file *file, const char __user *ubuf,
 325                           size_t len, loff_t *offp)
 326 {
 327         struct seq_file *m = file->private_data;
 328         struct drm_connector *connector = m->private;
 329         char *buf;
 330         struct edid *edid;
 331         int ret;
 332
 333         buf = memdup_user(ubuf, len);
 334         if (IS_ERR(buf))
 335                 return PTR_ERR(buf);
 336
 337         edid = (struct edid *) buf;
 338
 339         if (len == 5 && !strncmp(buf, "reset", 5)) {
 340                 connector->override_edid = false;
 341                 ret = drm_mode_connector_update_edid_property(connector, NULL);
 342         } else if (len < EDID_LENGTH ||
 343                    EDID_LENGTH * (1 + edid->extensions) > len)
 344                 ret = -EINVAL;
 345         else {
 346                 connector->override_edid = false;
 347                 ret = drm_mode_connector_update_edid_property(connector, edid);
 348                 if (!ret)
 349                         connector->override_edid = true;
 350         }
 351
 352         kfree(buf);
 353
 354         return (ret) ? ret : len;
 355 }
 356
 357 static const struct file_operations drm_edid_fops = {
 358         .owner = THIS_MODULE,
 359         .open = edid_open,
 360         .read = seq_read,
 361         .llseek = seq_lseek,
 362         .release = single_release,
 363         .write = edid_write
 364 };
 365
 366
 367 static const struct file_operations drm_connector_fops = {
 368         .owner = THIS_MODULE,
 369         .open = connector_open,
 370         .read = seq_read,
 371         .llseek = seq_lseek,
 372         .release = single_release,
 373         .write = connector_write
 374 };
 375
 376 int drm_debugfs_connector_add(struct drm_connector *connector)
 377 {
 378         struct drm_minor *minor = connector->dev->primary;
 379         struct dentry *root, *ent;
 380
 381         if (!minor->debugfs_root)
 382                 return -1;
 383
 384         root = debugfs_create_dir(connector->name, minor->debugfs_root);
 385         if (!root)
 386                 return -ENOMEM;
 387
 388         connector->debugfs_entry = root;
 389
 390         /* force */
 391         ent = debugfs_create_file("force", S_IRUGO | S_IWUSR, root, connector,
 392                                   &drm_connector_fops);
 393         if (!ent)
 394                 goto error;
 395
 396         /* edid */
 397         ent = debugfs_create_file("edid_override", S_IRUGO | S_IWUSR, root,
 398                                   connector, &drm_edid_fops);
 399         if (!ent)
 400                 goto error;
 401
 402         return 0;
 403
 404 error:
 405         debugfs_remove_recursive(connector->debugfs_entry);
 406         connector->debugfs_entry = NULL;
 407         return -ENOMEM;
 408 }
 409
 410 void drm_debugfs_connector_remove(struct drm_connector *connector)
 411 {
 412         if (!connector->debugfs_entry)
 413                 return;
 414
 415         debugfs_remove_recursive(connector->debugfs_entry);
 416
 417         connector->debugfs_entry = NULL;
 418 }
 419
 420 #endif /* CONFIG_DEBUG_FS */
 421