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:
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
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.
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>
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>
45 #include "drm_crtc_internal.h"
46 #include "drm_internal.h"
48 #if defined(CONFIG_DEBUG_FS)
50 /***************************************************
51 * Initialization, etc.
52 **************************************************/
54 static int drm_name_info(struct seq_file *m, void *data)
56 struct drm_debugfs_entry *entry = m->private;
57 struct drm_device *dev = entry->dev;
58 struct drm_master *master;
60 mutex_lock(&dev->master_mutex);
62 seq_printf(m, "%s", dev->driver->name);
64 seq_printf(m, " dev=%s", dev_name(dev->dev));
65 if (master && master->unique)
66 seq_printf(m, " master=%s", master->unique);
68 seq_printf(m, " unique=%s", dev->unique);
70 mutex_unlock(&dev->master_mutex);
75 static int drm_clients_info(struct seq_file *m, void *data)
77 struct drm_debugfs_entry *entry = m->private;
78 struct drm_device *dev = entry->dev;
79 struct drm_file *priv;
83 "%20s %5s %3s master a %5s %10s\n",
90 /* dev->filelist is sorted youngest first, but we want to present
91 * oldest first (i.e. kernel, servers, clients), so walk backwardss.
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;
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>",
107 is_current_master ? 'y' : 'n',
108 priv->authenticated ? 'y' : 'n',
109 from_kuid_munged(seq_user_ns(m), uid),
113 mutex_unlock(&dev->filelist_mutex);
117 static int drm_gem_one_name_info(int id, void *ptr, void *data)
119 struct drm_gem_object *obj = ptr;
120 struct seq_file *m = data;
122 seq_printf(m, "%6d %8zd %7d %8d\n",
123 obj->name, obj->size,
125 kref_read(&obj->refcount));
129 static int drm_gem_name_info(struct seq_file *m, void *data)
131 struct drm_debugfs_entry *entry = m->private;
132 struct drm_device *dev = entry->dev;
134 seq_printf(m, " name size handles refcount\n");
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);
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},
148 #define DRM_DEBUGFS_ENTRIES ARRAY_SIZE(drm_debugfs_list)
151 static int drm_debugfs_open(struct inode *inode, struct file *file)
153 struct drm_info_node *node = inode->i_private;
155 if (!device_is_registered(node->minor->kdev))
158 return single_open(file, node->info_ent->show, node);
161 static int drm_debugfs_entry_open(struct inode *inode, struct file *file)
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;
167 if (!device_is_registered(minor->kdev))
170 return single_open(file, node->show, entry);
173 static const struct file_operations drm_debugfs_entry_fops = {
174 .owner = THIS_MODULE,
175 .open = drm_debugfs_entry_open,
178 .release = single_release,
181 static const struct file_operations drm_debugfs_fops = {
182 .owner = THIS_MODULE,
183 .open = drm_debugfs_open,
186 .release = single_release,
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
194 * Dumps the GPU VA mappings of a given DRM GPU VA manager.
196 * For each DRM GPU VA space drivers should call this function from their
197 * &drm_info_list's show callback.
199 * Returns: 0 on success, -ENODEV if the &gpuvm is not initialized
201 int drm_debugfs_gpuva_info(struct seq_file *m,
202 struct drm_gpuvm *gpuvm)
204 struct drm_gpuva *va, *kva = &gpuvm->kernel_alloc_node;
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);
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))
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);
227 EXPORT_SYMBOL(drm_debugfs_gpuva_info);
230 * drm_debugfs_create_files - Initialize a given set of debugfs files for DRM
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
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().
241 void drm_debugfs_create_files(const struct drm_info_list *files, int count,
242 struct dentry *root, struct drm_minor *minor)
244 struct drm_device *dev = minor->dev;
245 struct drm_info_node *tmp;
248 for (i = 0; i < count; i++) {
249 u32 features = files[i].driver_features;
251 if (features && !drm_core_check_all_features(dev, features))
254 tmp = drmm_kzalloc(dev, sizeof(*tmp), GFP_KERNEL);
259 tmp->dent = debugfs_create_file(files[i].name,
262 tmp->info_ent = &files[i];
265 EXPORT_SYMBOL(drm_debugfs_create_files);
267 int drm_debugfs_remove_files(const struct drm_info_list *files, int count,
268 struct dentry *root, struct drm_minor *minor)
272 for (i = 0; i < count; i++) {
273 struct dentry *dent = debugfs_lookup(files[i].name, root);
278 drmm_kfree(minor->dev, d_inode(dent)->i_private);
279 debugfs_remove(dent);
283 EXPORT_SYMBOL(drm_debugfs_remove_files);
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
290 * Creates the debugfs directory for the device under the given root directory.
292 void drm_debugfs_dev_init(struct drm_device *dev, struct dentry *root)
294 dev->debugfs_root = debugfs_create_dir(dev->unique, root);
298 * drm_debugfs_dev_fini - cleanup debugfs directory
299 * @dev: the device to cleanup the debugfs stuff
301 * Remove the debugfs directory, might be called multiple times.
303 void drm_debugfs_dev_fini(struct drm_device *dev)
305 debugfs_remove_recursive(dev->debugfs_root);
306 dev->debugfs_root = NULL;
309 void drm_debugfs_dev_register(struct drm_device *dev)
311 drm_debugfs_add_files(dev, drm_debugfs_list, DRM_DEBUGFS_ENTRIES);
313 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
314 drm_framebuffer_debugfs_init(dev);
315 drm_client_debugfs_init(dev);
317 if (drm_drv_uses_atomic_modeset(dev))
318 drm_atomic_debugfs_init(dev);
321 int drm_debugfs_register(struct drm_minor *minor, int minor_id,
324 struct drm_device *dev = minor->dev;
327 sprintf(name, "%d", minor_id);
328 minor->debugfs_symlink = debugfs_create_symlink(name, root,
331 /* TODO: Only for compatibility with drivers */
332 minor->debugfs_root = dev->debugfs_root;
334 if (dev->driver->debugfs_init && dev->render != minor)
335 dev->driver->debugfs_init(minor);
340 void drm_debugfs_unregister(struct drm_minor *minor)
342 debugfs_remove(minor->debugfs_symlink);
343 minor->debugfs_symlink = NULL;
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
353 * Add a given file entry to the DRM device debugfs file list to be created on
356 void drm_debugfs_add_file(struct drm_device *dev, const char *name,
357 int (*show)(struct seq_file*, void*), void *data)
359 struct drm_debugfs_entry *entry = drmm_kzalloc(dev, sizeof(*entry), GFP_KERNEL);
364 entry->file.name = name;
365 entry->file.show = show;
366 entry->file.data = data;
369 debugfs_create_file(name, 0444, dev->debugfs_root, entry,
370 &drm_debugfs_entry_fops);
372 EXPORT_SYMBOL(drm_debugfs_add_file);
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
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.
383 void drm_debugfs_add_files(struct drm_device *dev, const struct drm_debugfs_info *files, int count)
387 for (i = 0; i < count; i++)
388 drm_debugfs_add_file(dev, files[i].name, files[i].show, files[i].data);
390 EXPORT_SYMBOL(drm_debugfs_add_files);
392 static int connector_show(struct seq_file *m, void *data)
394 struct drm_connector *connector = m->private;
396 seq_printf(m, "%s\n", drm_get_connector_force_name(connector->force));
401 static int connector_open(struct inode *inode, struct file *file)
403 struct drm_connector *dev = inode->i_private;
405 return single_open(file, connector_show, dev);
408 static ssize_t connector_write(struct file *file, const char __user *ubuf,
409 size_t len, loff_t *offp)
411 struct seq_file *m = file->private_data;
412 struct drm_connector *connector = m->private;
415 if (len > sizeof(buf) - 1)
418 if (copy_from_user(buf, ubuf, len))
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;
437 static int edid_show(struct seq_file *m, void *data)
439 return drm_edid_override_show(m->private, m);
442 static int edid_open(struct inode *inode, struct file *file)
444 struct drm_connector *dev = inode->i_private;
446 return single_open(file, edid_show, dev);
449 static ssize_t edid_write(struct file *file, const char __user *ubuf,
450 size_t len, loff_t *offp)
452 struct seq_file *m = file->private_data;
453 struct drm_connector *connector = m->private;
457 buf = memdup_user(ubuf, len);
461 if (len == 5 && !strncmp(buf, "reset", 5))
462 ret = drm_edid_override_reset(connector);
464 ret = drm_edid_override_set(connector, buf, len);
468 return ret ? ret : len;
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
475 static int vrr_range_show(struct seq_file *m, void *data)
477 struct drm_connector *connector = m->private;
479 if (connector->status != connector_status_connected)
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);
487 DEFINE_SHOW_ATTRIBUTE(vrr_range);
490 * Returns Connector's max supported bpc through debugfs file.
491 * Example usage: cat /sys/kernel/debug/dri/0/DP-1/output_bpc
493 static int output_bpc_show(struct seq_file *m, void *data)
495 struct drm_connector *connector = m->private;
497 if (connector->status != connector_status_connected)
500 seq_printf(m, "Maximum: %u\n", connector->display_info.bpc);
504 DEFINE_SHOW_ATTRIBUTE(output_bpc);
506 static const struct file_operations drm_edid_fops = {
507 .owner = THIS_MODULE,
511 .release = single_release,
516 static const struct file_operations drm_connector_fops = {
517 .owner = THIS_MODULE,
518 .open = connector_open,
521 .release = single_release,
522 .write = connector_write
525 void drm_debugfs_connector_add(struct drm_connector *connector)
527 struct drm_device *dev = connector->dev;
530 if (!dev->debugfs_root)
533 root = debugfs_create_dir(connector->name, dev->debugfs_root);
534 connector->debugfs_entry = root;
537 debugfs_create_file("force", 0644, root, connector,
538 &drm_connector_fops);
541 debugfs_create_file("edid_override", 0644, root, connector,
545 debugfs_create_file("vrr_range", 0444, root, connector,
549 debugfs_create_file("output_bpc", 0444, root, connector,
552 if (connector->funcs->debugfs_init)
553 connector->funcs->debugfs_init(connector, root);
556 void drm_debugfs_connector_remove(struct drm_connector *connector)
558 if (!connector->debugfs_entry)
561 debugfs_remove_recursive(connector->debugfs_entry);
563 connector->debugfs_entry = NULL;
566 void drm_debugfs_crtc_add(struct drm_crtc *crtc)
568 struct drm_device *dev = crtc->dev;
572 name = kasprintf(GFP_KERNEL, "crtc-%d", crtc->index);
576 root = debugfs_create_dir(name, dev->debugfs_root);
579 crtc->debugfs_entry = root;
581 drm_debugfs_crtc_crc_add(crtc);
584 void drm_debugfs_crtc_remove(struct drm_crtc *crtc)
586 debugfs_remove_recursive(crtc->debugfs_entry);
587 crtc->debugfs_entry = NULL;
590 static int bridges_show(struct seq_file *m, void *data)
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;
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",
601 drm_get_connector_type_name(bridge->type));
604 drm_printf(&p, "\tOF: %pOFfc\n", bridge->of_node);
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");
620 DEFINE_SHOW_ATTRIBUTE(bridges);
622 void drm_debugfs_encoder_add(struct drm_encoder *encoder)
624 struct drm_minor *minor = encoder->dev->primary;
628 name = kasprintf(GFP_KERNEL, "encoder-%d", encoder->index);
632 root = debugfs_create_dir(name, minor->debugfs_root);
635 encoder->debugfs_entry = root;
638 debugfs_create_file("bridges", 0444, root, encoder,
641 if (encoder->funcs && encoder->funcs->debugfs_init)
642 encoder->funcs->debugfs_init(encoder, root);
645 void drm_debugfs_encoder_remove(struct drm_encoder *encoder)
647 debugfs_remove_recursive(encoder->debugfs_entry);
648 encoder->debugfs_entry = NULL;
651 #endif /* CONFIG_DEBUG_FS */