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