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>
37
#if defined(CONFIG_DEBUG_FS)
39
/***************************************************
40
* Initialization, etc.
41
**************************************************/
43
static struct drm_info_list drm_debugfs_list[] = {
44
{"name", drm_name_info, 0},
45
{"vm", drm_vm_info, 0},
46
{"clients", drm_clients_info, 0},
47
{"queues", drm_queues_info, 0},
48
{"bufs", drm_bufs_info, 0},
49
{"gem_names", drm_gem_name_info, DRIVER_GEM},
50
{"gem_objects", drm_gem_object_info, DRIVER_GEM},
52
{"vma", drm_vma_info, 0},
55
#define DRM_DEBUGFS_ENTRIES ARRAY_SIZE(drm_debugfs_list)
58
static int drm_debugfs_open(struct inode *inode, struct file *file)
60
struct drm_info_node *node = inode->i_private;
62
return single_open(file, node->info_ent->show, node);
66
static const struct file_operations drm_debugfs_fops = {
68
.open = drm_debugfs_open,
71
.release = single_release,
76
* Initialize a given set of debugfs files for a device
78
* \param files The array of files to create
79
* \param count The number of files given
80
* \param root DRI debugfs dir entry.
81
* \param minor device minor number
82
* \return Zero on success, non-zero on failure
84
* Create a given set of debugfs files represented by an array of
85
* gdm_debugfs_lists in the given root directory.
87
int drm_debugfs_create_files(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;
96
for (i = 0; i < count; i++) {
97
u32 features = files[i].driver_features;
100
(dev->driver->driver_features & features) != features)
103
tmp = kmalloc(sizeof(struct drm_info_node), GFP_KERNEL);
108
ent = debugfs_create_file(files[i].name, S_IFREG | S_IRUGO,
109
root, tmp, &drm_debugfs_fops);
111
DRM_ERROR("Cannot create /sys/kernel/debug/dri/%s/%s\n",
112
name, files[i].name);
120
tmp->info_ent = &files[i];
121
list_add(&(tmp->list), &(minor->debugfs_nodes.list));
126
drm_debugfs_remove_files(files, count, minor);
129
EXPORT_SYMBOL(drm_debugfs_create_files);
132
* Initialize the DRI debugfs filesystem for a device
134
* \param dev DRM device
135
* \param minor device minor number
136
* \param root DRI debugfs dir entry.
138
* Create the DRI debugfs root entry "/sys/kernel/debug/dri", the device debugfs root entry
139
* "/sys/kernel/debug/dri/%minor%/", and each entry in debugfs_list as
140
* "/sys/kernel/debug/dri/%minor%/%name%".
142
int drm_debugfs_init(struct drm_minor *minor, int minor_id,
145
struct drm_device *dev = minor->dev;
149
INIT_LIST_HEAD(&minor->debugfs_nodes.list);
150
sprintf(name, "%d", minor_id);
151
minor->debugfs_root = debugfs_create_dir(name, root);
152
if (!minor->debugfs_root) {
153
DRM_ERROR("Cannot create /sys/kernel/debug/dri/%s\n", name);
157
ret = drm_debugfs_create_files(drm_debugfs_list, DRM_DEBUGFS_ENTRIES,
158
minor->debugfs_root, minor);
160
debugfs_remove(minor->debugfs_root);
161
minor->debugfs_root = NULL;
162
DRM_ERROR("Failed to create core drm debugfs files\n");
166
if (dev->driver->debugfs_init) {
167
ret = dev->driver->debugfs_init(minor);
169
DRM_ERROR("DRM: Driver failed to initialize "
170
"/sys/kernel/debug/dri.\n");
179
* Remove a list of debugfs files
181
* \param files The list of files
182
* \param count The number of files
183
* \param minor The minor of which we should remove the files
184
* \return always zero.
186
* Remove all debugfs entries created by debugfs_init().
188
int drm_debugfs_remove_files(struct drm_info_list *files, int count,
189
struct drm_minor *minor)
191
struct list_head *pos, *q;
192
struct drm_info_node *tmp;
195
for (i = 0; i < count; i++) {
196
list_for_each_safe(pos, q, &minor->debugfs_nodes.list) {
197
tmp = list_entry(pos, struct drm_info_node, list);
198
if (tmp->info_ent == &files[i]) {
199
debugfs_remove(tmp->dent);
207
EXPORT_SYMBOL(drm_debugfs_remove_files);
210
* Cleanup the debugfs filesystem resources.
212
* \param minor device minor number.
213
* \return always zero.
215
* Remove all debugfs entries created by debugfs_init().
217
int drm_debugfs_cleanup(struct drm_minor *minor)
219
struct drm_device *dev = minor->dev;
221
if (!minor->debugfs_root)
224
if (dev->driver->debugfs_cleanup)
225
dev->driver->debugfs_cleanup(minor);
227
drm_debugfs_remove_files(drm_debugfs_list, DRM_DEBUGFS_ENTRIES, minor);
229
debugfs_remove(minor->debugfs_root);
230
minor->debugfs_root = NULL;
235
#endif /* CONFIG_DEBUG_FS */