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>
40 #if defined(CONFIG_DEBUG_FS)
42 /***************************************************
43 * Initialization, etc.
44 **************************************************/
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},
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 * gdm_debugfs_lists in the given root directory.
86 int drm_debugfs_create_files(const struct drm_info_list
*files
, int count
,
87 struct dentry
*root
, struct drm_minor
*minor
)
89 struct drm_device
*dev
= minor
->dev
;
91 struct drm_info_node
*tmp
;
94 for (i
= 0; i
< count
; i
++) {
95 u32 features
= files
[i
].driver_features
;
98 (dev
->driver
->driver_features
& features
) != features
)
101 tmp
= kmalloc(sizeof(struct drm_info_node
), GFP_KERNEL
);
106 ent
= debugfs_create_file(files
[i
].name
, S_IFREG
| S_IRUGO
,
107 root
, tmp
, &drm_debugfs_fops
);
109 DRM_ERROR("Cannot create /sys/kernel/debug/dri/%s/%s\n",
110 root
->d_name
.name
, files
[i
].name
);
118 tmp
->info_ent
= &files
[i
];
120 mutex_lock(&minor
->debugfs_lock
);
121 list_add(&tmp
->list
, &minor
->debugfs_list
);
122 mutex_unlock(&minor
->debugfs_lock
);
127 drm_debugfs_remove_files(files
, count
, minor
);
130 EXPORT_SYMBOL(drm_debugfs_create_files
);
133 * Initialize the DRI debugfs filesystem for a device
135 * \param dev DRM device
136 * \param minor device minor number
137 * \param root DRI debugfs dir entry.
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%".
143 int drm_debugfs_init(struct drm_minor
*minor
, int minor_id
,
146 struct drm_device
*dev
= minor
->dev
;
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
);
159 ret
= drm_debugfs_create_files(drm_debugfs_list
, DRM_DEBUGFS_ENTRIES
,
160 minor
->debugfs_root
, minor
);
162 debugfs_remove(minor
->debugfs_root
);
163 minor
->debugfs_root
= NULL
;
164 DRM_ERROR("Failed to create core drm debugfs files\n");
168 if (dev
->driver
->debugfs_init
) {
169 ret
= dev
->driver
->debugfs_init(minor
);
171 DRM_ERROR("DRM: Driver failed to initialize "
172 "/sys/kernel/debug/dri.\n");
181 * Remove a list of debugfs files
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.
188 * Remove all debugfs entries created by debugfs_init().
190 int drm_debugfs_remove_files(const struct drm_info_list
*files
, int count
,
191 struct drm_minor
*minor
)
193 struct list_head
*pos
, *q
;
194 struct drm_info_node
*tmp
;
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
);
208 mutex_unlock(&minor
->debugfs_lock
);
211 EXPORT_SYMBOL(drm_debugfs_remove_files
);
214 * Cleanup the debugfs filesystem resources.
216 * \param minor device minor number.
217 * \return always zero.
219 * Remove all debugfs entries created by debugfs_init().
221 int drm_debugfs_cleanup(struct drm_minor
*minor
)
223 struct drm_device
*dev
= minor
->dev
;
225 if (!minor
->debugfs_root
)
228 if (dev
->driver
->debugfs_cleanup
)
229 dev
->driver
->debugfs_cleanup(minor
);
231 drm_debugfs_remove_files(drm_debugfs_list
, DRM_DEBUGFS_ENTRIES
, minor
);
233 debugfs_remove(minor
->debugfs_root
);
234 minor
->debugfs_root
= NULL
;
239 static int connector_show(struct seq_file
*m
, void *data
)
241 struct drm_connector
*connector
= m
->private;
244 switch (connector
->force
) {
249 case DRM_FORCE_ON_DIGITAL
:
250 status
= "digital\n";
257 case DRM_FORCE_UNSPECIFIED
:
258 status
= "unspecified\n";
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 #endif /* CONFIG_DEBUG_FS */