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_debugfs.h>
36 #include <drm/drm_device.h>
37 #include <drm/drm_drv.h>
38 #include <drm/drm_edid.h>
39 #include <drm/drm_file.h>
40 #include <drm/drm_gem.h>
41 #include <drm/drm_managed.h>
42 #include <drm/drm_gpuvm.h>
44 #include "drm_crtc_internal.h"
45 #include "drm_internal.h"
47 /***************************************************
48 * Initialization, etc.
49 **************************************************/
51 static int drm_name_info(struct seq_file *m, void *data)
53 struct drm_debugfs_entry *entry = m->private;
54 struct drm_device *dev = entry->dev;
55 struct drm_master *master;
57 mutex_lock(&dev->master_mutex);
59 seq_printf(m, "%s", dev->driver->name);
61 seq_printf(m, " dev=%s", dev_name(dev->dev));
62 if (master && master->unique)
63 seq_printf(m, " master=%s", master->unique);
65 seq_printf(m, " unique=%s", dev->unique);
67 mutex_unlock(&dev->master_mutex);
72 static int drm_clients_info(struct seq_file *m, void *data)
74 struct drm_debugfs_entry *entry = m->private;
75 struct drm_device *dev = entry->dev;
76 struct drm_file *priv;
80 "%20s %5s %3s master a %5s %10s %*s\n",
86 DRM_CLIENT_NAME_MAX_LEN,
89 /* dev->filelist is sorted youngest first, but we want to present
90 * oldest first (i.e. kernel, servers, clients), so walk backwardss.
92 mutex_lock(&dev->filelist_mutex);
93 list_for_each_entry_reverse(priv, &dev->filelist, lhead) {
94 bool is_current_master = drm_is_current_master(priv);
95 struct task_struct *task;
98 mutex_lock(&priv->client_name_lock);
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 %*s\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),
111 DRM_CLIENT_NAME_MAX_LEN,
112 priv->client_name ? priv->client_name : "<unset>");
114 mutex_unlock(&priv->client_name_lock);
116 mutex_unlock(&dev->filelist_mutex);
120 static int drm_gem_one_name_info(int id, void *ptr, void *data)
122 struct drm_gem_object *obj = ptr;
123 struct seq_file *m = data;
125 seq_printf(m, "%6d %8zd %7d %8d\n",
126 obj->name, obj->size,
128 kref_read(&obj->refcount));
132 static int drm_gem_name_info(struct seq_file *m, void *data)
134 struct drm_debugfs_entry *entry = m->private;
135 struct drm_device *dev = entry->dev;
137 seq_printf(m, " name size handles refcount\n");
139 mutex_lock(&dev->object_name_lock);
140 idr_for_each(&dev->object_name_idr, drm_gem_one_name_info, m);
141 mutex_unlock(&dev->object_name_lock);
146 static const struct drm_debugfs_info drm_debugfs_list[] = {
147 {"name", drm_name_info, 0},
148 {"clients", drm_clients_info, 0},
149 {"gem_names", drm_gem_name_info, DRIVER_GEM},
151 #define DRM_DEBUGFS_ENTRIES ARRAY_SIZE(drm_debugfs_list)
154 static int drm_debugfs_open(struct inode *inode, struct file *file)
156 struct drm_info_node *node = inode->i_private;
158 if (!device_is_registered(node->minor->kdev))
161 return single_open(file, node->info_ent->show, node);
164 static int drm_debugfs_entry_open(struct inode *inode, struct file *file)
166 struct drm_debugfs_entry *entry = inode->i_private;
167 struct drm_debugfs_info *node = &entry->file;
168 struct drm_minor *minor = entry->dev->primary ?: entry->dev->accel;
170 if (!device_is_registered(minor->kdev))
173 return single_open(file, node->show, entry);
176 static const struct file_operations drm_debugfs_entry_fops = {
177 .owner = THIS_MODULE,
178 .open = drm_debugfs_entry_open,
181 .release = single_release,
184 static const struct file_operations drm_debugfs_fops = {
185 .owner = THIS_MODULE,
186 .open = drm_debugfs_open,
189 .release = single_release,
193 * drm_debugfs_gpuva_info - dump the given DRM GPU VA space
194 * @m: pointer to the &seq_file to write
195 * @gpuvm: the &drm_gpuvm representing the GPU VA space
197 * Dumps the GPU VA mappings of a given DRM GPU VA manager.
199 * For each DRM GPU VA space drivers should call this function from their
200 * &drm_info_list's show callback.
202 * Returns: 0 on success, -ENODEV if the &gpuvm is not initialized
204 int drm_debugfs_gpuva_info(struct seq_file *m,
205 struct drm_gpuvm *gpuvm)
207 struct drm_gpuva *va, *kva = &gpuvm->kernel_alloc_node;
212 seq_printf(m, "DRM GPU VA space (%s) [0x%016llx;0x%016llx]\n",
213 gpuvm->name, gpuvm->mm_start, gpuvm->mm_start + gpuvm->mm_range);
214 seq_printf(m, "Kernel reserved node [0x%016llx;0x%016llx]\n",
215 kva->va.addr, kva->va.addr + kva->va.range);
217 seq_puts(m, " VAs | start | range | end | object | object offset\n");
218 seq_puts(m, "-------------------------------------------------------------------------------------------------------------\n");
219 drm_gpuvm_for_each_va(va, gpuvm) {
220 if (unlikely(va == kva))
223 seq_printf(m, " | 0x%016llx | 0x%016llx | 0x%016llx | 0x%016llx | 0x%016llx\n",
224 va->va.addr, va->va.range, va->va.addr + va->va.range,
225 (u64)(uintptr_t)va->gem.obj, va->gem.offset);
230 EXPORT_SYMBOL(drm_debugfs_gpuva_info);
233 * drm_debugfs_create_files - Initialize a given set of debugfs files for DRM
235 * @files: The array of files to create
236 * @count: The number of files given
237 * @root: DRI debugfs dir entry.
238 * @minor: device minor number
240 * Create a given set of debugfs files represented by an array of
241 * &struct drm_info_list in the given root directory. These files will be removed
242 * automatically on drm_debugfs_dev_fini().
244 void drm_debugfs_create_files(const struct drm_info_list *files, int count,
245 struct dentry *root, struct drm_minor *minor)
247 struct drm_device *dev = minor->dev;
248 struct drm_info_node *tmp;
251 for (i = 0; i < count; i++) {
252 u32 features = files[i].driver_features;
254 if (features && !drm_core_check_all_features(dev, features))
257 tmp = drmm_kzalloc(dev, sizeof(*tmp), GFP_KERNEL);
262 tmp->dent = debugfs_create_file(files[i].name,
265 tmp->info_ent = &files[i];
268 EXPORT_SYMBOL(drm_debugfs_create_files);
270 int drm_debugfs_remove_files(const struct drm_info_list *files, int count,
271 struct dentry *root, struct drm_minor *minor)
275 for (i = 0; i < count; i++) {
276 struct dentry *dent = debugfs_lookup(files[i].name, root);
281 drmm_kfree(minor->dev, d_inode(dent)->i_private);
282 debugfs_remove(dent);
286 EXPORT_SYMBOL(drm_debugfs_remove_files);
289 * drm_debugfs_dev_init - create debugfs directory for the device
290 * @dev: the device which we want to create the directory for
291 * @root: the parent directory depending on the device type
293 * Creates the debugfs directory for the device under the given root directory.
295 void drm_debugfs_dev_init(struct drm_device *dev, struct dentry *root)
297 dev->debugfs_root = debugfs_create_dir(dev->unique, root);
301 * drm_debugfs_dev_fini - cleanup debugfs directory
302 * @dev: the device to cleanup the debugfs stuff
304 * Remove the debugfs directory, might be called multiple times.
306 void drm_debugfs_dev_fini(struct drm_device *dev)
308 debugfs_remove_recursive(dev->debugfs_root);
309 dev->debugfs_root = NULL;
312 void drm_debugfs_dev_register(struct drm_device *dev)
314 drm_debugfs_add_files(dev, drm_debugfs_list, DRM_DEBUGFS_ENTRIES);
316 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
317 drm_framebuffer_debugfs_init(dev);
318 drm_client_debugfs_init(dev);
320 if (drm_drv_uses_atomic_modeset(dev))
321 drm_atomic_debugfs_init(dev);
324 int drm_debugfs_register(struct drm_minor *minor, int minor_id,
327 struct drm_device *dev = minor->dev;
330 sprintf(name, "%d", minor_id);
331 minor->debugfs_symlink = debugfs_create_symlink(name, root,
334 /* TODO: Only for compatibility with drivers */
335 minor->debugfs_root = dev->debugfs_root;
337 if (dev->driver->debugfs_init && dev->render != minor)
338 dev->driver->debugfs_init(minor);
343 void drm_debugfs_unregister(struct drm_minor *minor)
345 debugfs_remove(minor->debugfs_symlink);
346 minor->debugfs_symlink = NULL;
350 * drm_debugfs_add_file - Add a given file to the DRM device debugfs file list
351 * @dev: drm device for the ioctl
352 * @name: debugfs file name
353 * @show: show callback
354 * @data: driver-private data, should not be device-specific
356 * Add a given file entry to the DRM device debugfs file list to be created on
359 void drm_debugfs_add_file(struct drm_device *dev, const char *name,
360 int (*show)(struct seq_file*, void*), void *data)
362 struct drm_debugfs_entry *entry = drmm_kzalloc(dev, sizeof(*entry), GFP_KERNEL);
367 entry->file.name = name;
368 entry->file.show = show;
369 entry->file.data = data;
372 debugfs_create_file(name, 0444, dev->debugfs_root, entry,
373 &drm_debugfs_entry_fops);
375 EXPORT_SYMBOL(drm_debugfs_add_file);
378 * drm_debugfs_add_files - Add an array of files to the DRM device debugfs file list
379 * @dev: drm device for the ioctl
380 * @files: The array of files to create
381 * @count: The number of files given
383 * Add a given set of debugfs files represented by an array of
384 * &struct drm_debugfs_info in the DRM device debugfs file list.
386 void drm_debugfs_add_files(struct drm_device *dev, const struct drm_debugfs_info *files, int count)
390 for (i = 0; i < count; i++)
391 drm_debugfs_add_file(dev, files[i].name, files[i].show, files[i].data);
393 EXPORT_SYMBOL(drm_debugfs_add_files);
395 static int connector_show(struct seq_file *m, void *data)
397 struct drm_connector *connector = m->private;
399 seq_printf(m, "%s\n", drm_get_connector_force_name(connector->force));
404 static int connector_open(struct inode *inode, struct file *file)
406 struct drm_connector *dev = inode->i_private;
408 return single_open(file, connector_show, dev);
411 static ssize_t connector_write(struct file *file, const char __user *ubuf,
412 size_t len, loff_t *offp)
414 struct seq_file *m = file->private_data;
415 struct drm_connector *connector = m->private;
418 if (len > sizeof(buf) - 1)
421 if (copy_from_user(buf, ubuf, len))
426 if (sysfs_streq(buf, "on"))
427 connector->force = DRM_FORCE_ON;
428 else if (sysfs_streq(buf, "digital"))
429 connector->force = DRM_FORCE_ON_DIGITAL;
430 else if (sysfs_streq(buf, "off"))
431 connector->force = DRM_FORCE_OFF;
432 else if (sysfs_streq(buf, "unspecified"))
433 connector->force = DRM_FORCE_UNSPECIFIED;
440 static int edid_show(struct seq_file *m, void *data)
442 return drm_edid_override_show(m->private, m);
445 static int edid_open(struct inode *inode, struct file *file)
447 struct drm_connector *dev = inode->i_private;
449 return single_open(file, edid_show, dev);
452 static ssize_t edid_write(struct file *file, const char __user *ubuf,
453 size_t len, loff_t *offp)
455 struct seq_file *m = file->private_data;
456 struct drm_connector *connector = m->private;
460 buf = memdup_user(ubuf, len);
464 if (len == 5 && !strncmp(buf, "reset", 5))
465 ret = drm_edid_override_reset(connector);
467 ret = drm_edid_override_set(connector, buf, len);
471 return ret ? ret : len;
475 * Returns the min and max vrr vfreq through the connector's debugfs file.
476 * Example usage: cat /sys/kernel/debug/dri/0/DP-1/vrr_range
478 static int vrr_range_show(struct seq_file *m, void *data)
480 struct drm_connector *connector = m->private;
482 if (connector->status != connector_status_connected)
485 seq_printf(m, "Min: %u\n", connector->display_info.monitor_range.min_vfreq);
486 seq_printf(m, "Max: %u\n", connector->display_info.monitor_range.max_vfreq);
490 DEFINE_SHOW_ATTRIBUTE(vrr_range);
493 * Returns Connector's max supported bpc through debugfs file.
494 * Example usage: cat /sys/kernel/debug/dri/0/DP-1/output_bpc
496 static int output_bpc_show(struct seq_file *m, void *data)
498 struct drm_connector *connector = m->private;
500 if (connector->status != connector_status_connected)
503 seq_printf(m, "Maximum: %u\n", connector->display_info.bpc);
507 DEFINE_SHOW_ATTRIBUTE(output_bpc);
509 static const struct file_operations drm_edid_fops = {
510 .owner = THIS_MODULE,
514 .release = single_release,
519 static const struct file_operations drm_connector_fops = {
520 .owner = THIS_MODULE,
521 .open = connector_open,
524 .release = single_release,
525 .write = connector_write
529 audio_infoframe_read(struct file *filp, char __user *ubuf, size_t count, loff_t *ppos)
531 struct drm_connector_hdmi_infoframe *infoframe;
532 struct drm_connector *connector;
533 union hdmi_infoframe *frame;
534 u8 buf[HDMI_INFOFRAME_SIZE(AUDIO)];
537 connector = filp->private_data;
538 mutex_lock(&connector->hdmi.infoframes.lock);
540 infoframe = &connector->hdmi.infoframes.audio;
544 frame = &infoframe->data;
545 len = hdmi_infoframe_pack(frame, buf, sizeof(buf));
549 len = simple_read_from_buffer(ubuf, count, ppos, buf, len);
552 mutex_unlock(&connector->hdmi.infoframes.lock);
556 static const struct file_operations audio_infoframe_fops = {
557 .owner = THIS_MODULE,
559 .read = audio_infoframe_read,
562 static int create_hdmi_audio_infoframe_file(struct drm_connector *connector,
563 struct dentry *parent)
567 file = debugfs_create_file("audio", 0400, parent, connector, &audio_infoframe_fops);
569 return PTR_ERR(file);
574 #define DEFINE_INFOFRAME_FILE(_f) \
575 static ssize_t _f##_read_infoframe(struct file *filp, \
580 struct drm_connector_hdmi_infoframe *infoframe; \
581 struct drm_connector_state *conn_state; \
582 struct drm_connector *connector; \
583 union hdmi_infoframe *frame; \
584 struct drm_device *dev; \
585 u8 buf[HDMI_INFOFRAME_SIZE(MAX)]; \
588 connector = filp->private_data; \
589 dev = connector->dev; \
591 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL); \
593 conn_state = connector->state; \
594 infoframe = &conn_state->hdmi.infoframes._f; \
595 if (!infoframe->set) \
598 frame = &infoframe->data; \
599 len = hdmi_infoframe_pack(frame, buf, sizeof(buf)); \
603 len = simple_read_from_buffer(ubuf, count, ppos, buf, len); \
606 drm_modeset_unlock(&dev->mode_config.connection_mutex); \
610 static const struct file_operations _f##_infoframe_fops = { \
611 .owner = THIS_MODULE, \
612 .open = simple_open, \
613 .read = _f##_read_infoframe, \
616 static int create_hdmi_## _f ## _infoframe_file(struct drm_connector *connector, \
617 struct dentry *parent) \
619 struct dentry *file; \
621 file = debugfs_create_file(#_f, 0400, parent, connector, &_f ## _infoframe_fops); \
623 return PTR_ERR(file); \
628 DEFINE_INFOFRAME_FILE(avi);
629 DEFINE_INFOFRAME_FILE(hdmi);
630 DEFINE_INFOFRAME_FILE(hdr_drm);
631 DEFINE_INFOFRAME_FILE(spd);
633 static int create_hdmi_infoframe_files(struct drm_connector *connector,
634 struct dentry *parent)
638 ret = create_hdmi_audio_infoframe_file(connector, parent);
642 ret = create_hdmi_avi_infoframe_file(connector, parent);
646 ret = create_hdmi_hdmi_infoframe_file(connector, parent);
650 ret = create_hdmi_hdr_drm_infoframe_file(connector, parent);
654 ret = create_hdmi_spd_infoframe_file(connector, parent);
661 static void hdmi_debugfs_add(struct drm_connector *connector)
665 if (!(connector->connector_type == DRM_MODE_CONNECTOR_HDMIA ||
666 connector->connector_type == DRM_MODE_CONNECTOR_HDMIB))
669 dir = debugfs_create_dir("infoframes", connector->debugfs_entry);
673 create_hdmi_infoframe_files(connector, dir);
676 void drm_debugfs_connector_add(struct drm_connector *connector)
678 struct drm_device *dev = connector->dev;
681 if (!dev->debugfs_root)
684 root = debugfs_create_dir(connector->name, dev->debugfs_root);
685 connector->debugfs_entry = root;
688 debugfs_create_file("force", 0644, root, connector,
689 &drm_connector_fops);
692 debugfs_create_file("edid_override", 0644, root, connector,
696 debugfs_create_file("vrr_range", 0444, root, connector,
700 debugfs_create_file("output_bpc", 0444, root, connector,
703 hdmi_debugfs_add(connector);
705 if (connector->funcs->debugfs_init)
706 connector->funcs->debugfs_init(connector, root);
709 void drm_debugfs_connector_remove(struct drm_connector *connector)
711 if (!connector->debugfs_entry)
714 debugfs_remove_recursive(connector->debugfs_entry);
716 connector->debugfs_entry = NULL;
719 void drm_debugfs_crtc_add(struct drm_crtc *crtc)
721 struct drm_device *dev = crtc->dev;
725 name = kasprintf(GFP_KERNEL, "crtc-%d", crtc->index);
729 root = debugfs_create_dir(name, dev->debugfs_root);
732 crtc->debugfs_entry = root;
734 drm_debugfs_crtc_crc_add(crtc);
737 void drm_debugfs_crtc_remove(struct drm_crtc *crtc)
739 debugfs_remove_recursive(crtc->debugfs_entry);
740 crtc->debugfs_entry = NULL;
743 static int bridges_show(struct seq_file *m, void *data)
745 struct drm_encoder *encoder = m->private;
746 struct drm_printer p = drm_seq_file_printer(m);
747 struct drm_bridge *bridge;
748 unsigned int idx = 0;
750 drm_for_each_bridge_in_chain(encoder, bridge) {
751 drm_printf(&p, "bridge[%d]: %ps\n", idx++, bridge->funcs);
752 drm_printf(&p, "\ttype: [%d] %s\n",
754 drm_get_connector_type_name(bridge->type));
757 drm_printf(&p, "\tOF: %pOFfc\n", bridge->of_node);
759 drm_printf(&p, "\tops: [0x%x]", bridge->ops);
760 if (bridge->ops & DRM_BRIDGE_OP_DETECT)
761 drm_puts(&p, " detect");
762 if (bridge->ops & DRM_BRIDGE_OP_EDID)
763 drm_puts(&p, " edid");
764 if (bridge->ops & DRM_BRIDGE_OP_HPD)
765 drm_puts(&p, " hpd");
766 if (bridge->ops & DRM_BRIDGE_OP_MODES)
767 drm_puts(&p, " modes");
768 if (bridge->ops & DRM_BRIDGE_OP_HDMI)
769 drm_puts(&p, " hdmi");
775 DEFINE_SHOW_ATTRIBUTE(bridges);
777 void drm_debugfs_encoder_add(struct drm_encoder *encoder)
779 struct drm_minor *minor = encoder->dev->primary;
783 name = kasprintf(GFP_KERNEL, "encoder-%d", encoder->index);
787 root = debugfs_create_dir(name, minor->debugfs_root);
790 encoder->debugfs_entry = root;
793 debugfs_create_file("bridges", 0444, root, encoder,
796 if (encoder->funcs && encoder->funcs->debugfs_init)
797 encoder->funcs->debugfs_init(encoder, root);
800 void drm_debugfs_encoder_remove(struct drm_encoder *encoder)
802 debugfs_remove_recursive(encoder->debugfs_entry);
803 encoder->debugfs_entry = NULL;