3 * debugfs support for DRM
5 * \author Ben Gamari <bgamari@gmail.com>
9 * Created: Sun Dec 21 13:08:50 2008 by bgamari@gmail.com
11 * Copyright 2008 Ben Gamari <bgamari@gmail.com>
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:
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
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.
33 #include <linux/debugfs.h>
34 #include <linux/seq_file.h>
35 #include <linux/slab.h>
36 #include <linux/export.h>
38 #include <drm/drm_edid.h>
39 #include <drm/drm_atomic.h>
40 #include "drm_internal.h"
41 #include "drm_crtc_internal.h"
43 #if defined(CONFIG_DEBUG_FS)
45 /***************************************************
46 * Initialization, etc.
47 **************************************************/
49 static const struct drm_info_list drm_debugfs_list[] = {
50 {"name", drm_name_info, 0},
51 {"clients", drm_clients_info, 0},
52 {"gem_names", drm_gem_name_info, DRIVER_GEM},
54 #define DRM_DEBUGFS_ENTRIES ARRAY_SIZE(drm_debugfs_list)
57 static int drm_debugfs_open(struct inode *inode, struct file *file)
59 struct drm_info_node *node = inode->i_private;
61 return single_open(file, node->info_ent->show, node);
65 static const struct file_operations drm_debugfs_fops = {
67 .open = drm_debugfs_open,
70 .release = single_release,
75 * Initialize a given set of debugfs files for a device
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
83 * Create a given set of debugfs files represented by an array of
84 * &drm_info_list in the given root directory. These files will be removed
85 * automatically on drm_debugfs_cleanup().
87 int drm_debugfs_create_files(const struct drm_info_list *files, int count,
88 struct dentry *root, struct drm_minor *minor)
90 struct drm_device *dev = minor->dev;
92 struct drm_info_node *tmp;
95 for (i = 0; i < count; i++) {
96 u32 features = files[i].driver_features;
99 (dev->driver->driver_features & features) != features)
102 tmp = kmalloc(sizeof(struct drm_info_node), GFP_KERNEL);
107 ent = debugfs_create_file(files[i].name, S_IFREG | S_IRUGO,
108 root, tmp, &drm_debugfs_fops);
110 DRM_ERROR("Cannot create /sys/kernel/debug/dri/%pd/%s\n",
111 root, files[i].name);
119 tmp->info_ent = &files[i];
121 mutex_lock(&minor->debugfs_lock);
122 list_add(&tmp->list, &minor->debugfs_list);
123 mutex_unlock(&minor->debugfs_lock);
128 drm_debugfs_remove_files(files, count, minor);
131 EXPORT_SYMBOL(drm_debugfs_create_files);
134 * Initialize the DRI debugfs filesystem for a device
136 * \param dev DRM device
137 * \param minor device minor number
138 * \param root DRI debugfs dir entry.
140 * Create the DRI debugfs root entry "/sys/kernel/debug/dri", the device debugfs root entry
141 * "/sys/kernel/debug/dri/%minor%/", and each entry in debugfs_list as
142 * "/sys/kernel/debug/dri/%minor%/%name%".
144 int drm_debugfs_init(struct drm_minor *minor, int minor_id,
147 struct drm_device *dev = minor->dev;
151 INIT_LIST_HEAD(&minor->debugfs_list);
152 mutex_init(&minor->debugfs_lock);
153 sprintf(name, "%d", minor_id);
154 minor->debugfs_root = debugfs_create_dir(name, root);
155 if (!minor->debugfs_root) {
156 DRM_ERROR("Cannot create /sys/kernel/debug/dri/%s\n", name);
160 ret = drm_debugfs_create_files(drm_debugfs_list, DRM_DEBUGFS_ENTRIES,
161 minor->debugfs_root, minor);
163 debugfs_remove(minor->debugfs_root);
164 minor->debugfs_root = NULL;
165 DRM_ERROR("Failed to create core drm debugfs files\n");
169 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
170 ret = drm_atomic_debugfs_init(minor);
172 DRM_ERROR("Failed to create atomic debugfs files\n");
177 if (dev->driver->debugfs_init) {
178 ret = dev->driver->debugfs_init(minor);
180 DRM_ERROR("DRM: Driver failed to initialize "
181 "/sys/kernel/debug/dri.\n");
190 * Remove a list of debugfs files
192 * \param files The list of files
193 * \param count The number of files
194 * \param minor The minor of which we should remove the files
195 * \return always zero.
197 * Remove all debugfs entries created by debugfs_init().
199 int drm_debugfs_remove_files(const struct drm_info_list *files, int count,
200 struct drm_minor *minor)
202 struct list_head *pos, *q;
203 struct drm_info_node *tmp;
206 mutex_lock(&minor->debugfs_lock);
207 for (i = 0; i < count; i++) {
208 list_for_each_safe(pos, q, &minor->debugfs_list) {
209 tmp = list_entry(pos, struct drm_info_node, list);
210 if (tmp->info_ent == &files[i]) {
211 debugfs_remove(tmp->dent);
217 mutex_unlock(&minor->debugfs_lock);
220 EXPORT_SYMBOL(drm_debugfs_remove_files);
222 static void drm_debugfs_remove_all_files(struct drm_minor *minor)
224 struct drm_info_node *node, *tmp;
226 mutex_lock(&minor->debugfs_lock);
227 list_for_each_entry_safe(node, tmp, &minor->debugfs_list, list) {
228 debugfs_remove(node->dent);
229 list_del(&node->list);
232 mutex_unlock(&minor->debugfs_lock);
236 * Cleanup the debugfs filesystem resources.
238 * \param minor device minor number.
239 * \return always zero.
241 * Remove all debugfs entries created by debugfs_init().
243 int drm_debugfs_cleanup(struct drm_minor *minor)
245 struct drm_device *dev = minor->dev;
247 if (!minor->debugfs_root)
250 if (dev->driver->debugfs_cleanup)
251 dev->driver->debugfs_cleanup(minor);
253 drm_debugfs_remove_all_files(minor);
255 debugfs_remove_recursive(minor->debugfs_root);
256 minor->debugfs_root = NULL;
261 static int connector_show(struct seq_file *m, void *data)
263 struct drm_connector *connector = m->private;
265 seq_printf(m, "%s\n", drm_get_connector_force_name(connector->force));
270 static int connector_open(struct inode *inode, struct file *file)
272 struct drm_connector *dev = inode->i_private;
274 return single_open(file, connector_show, dev);
277 static ssize_t connector_write(struct file *file, const char __user *ubuf,
278 size_t len, loff_t *offp)
280 struct seq_file *m = file->private_data;
281 struct drm_connector *connector = m->private;
284 if (len > sizeof(buf) - 1)
287 if (copy_from_user(buf, ubuf, len))
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;
306 static int edid_show(struct seq_file *m, void *data)
308 struct drm_connector *connector = m->private;
309 struct drm_property_blob *edid = connector->edid_blob_ptr;
311 if (connector->override_edid && edid)
312 seq_write(m, edid->data, edid->length);
317 static int edid_open(struct inode *inode, struct file *file)
319 struct drm_connector *dev = inode->i_private;
321 return single_open(file, edid_show, dev);
324 static ssize_t edid_write(struct file *file, const char __user *ubuf,
325 size_t len, loff_t *offp)
327 struct seq_file *m = file->private_data;
328 struct drm_connector *connector = m->private;
333 buf = memdup_user(ubuf, len);
337 edid = (struct edid *) buf;
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)
346 connector->override_edid = false;
347 ret = drm_mode_connector_update_edid_property(connector, edid);
349 connector->override_edid = true;
354 return (ret) ? ret : len;
357 static const struct file_operations drm_edid_fops = {
358 .owner = THIS_MODULE,
362 .release = single_release,
367 static const struct file_operations drm_connector_fops = {
368 .owner = THIS_MODULE,
369 .open = connector_open,
372 .release = single_release,
373 .write = connector_write
376 int drm_debugfs_connector_add(struct drm_connector *connector)
378 struct drm_minor *minor = connector->dev->primary;
379 struct dentry *root, *ent;
381 if (!minor->debugfs_root)
384 root = debugfs_create_dir(connector->name, minor->debugfs_root);
388 connector->debugfs_entry = root;
391 ent = debugfs_create_file("force", S_IRUGO | S_IWUSR, root, connector,
392 &drm_connector_fops);
397 ent = debugfs_create_file("edid_override", S_IRUGO | S_IWUSR, root,
398 connector, &drm_edid_fops);
405 debugfs_remove_recursive(connector->debugfs_entry);
406 connector->debugfs_entry = NULL;
410 void drm_debugfs_connector_remove(struct drm_connector *connector)
412 if (!connector->debugfs_entry)
415 debugfs_remove_recursive(connector->debugfs_entry);
417 connector->debugfs_entry = NULL;
420 int drm_debugfs_crtc_add(struct drm_crtc *crtc)
422 struct drm_minor *minor = crtc->dev->primary;
426 name = kasprintf(GFP_KERNEL, "crtc-%d", crtc->index);
430 root = debugfs_create_dir(name, minor->debugfs_root);
435 crtc->debugfs_entry = root;
437 if (drm_debugfs_crtc_crc_add(crtc))
443 drm_debugfs_crtc_remove(crtc);
447 void drm_debugfs_crtc_remove(struct drm_crtc *crtc)
449 debugfs_remove_recursive(crtc->debugfs_entry);
450 crtc->debugfs_entry = NULL;
453 #endif /* CONFIG_DEBUG_FS */