Loading...
1/**
2 * \file drm_debugfs.c
3 * debugfs support for DRM
4 *
5 * \author Ben Gamari <bgamari@gmail.com>
6 */
7
8/*
9 * Created: Sun Dec 21 13:08:50 2008 by bgamari@gmail.com
10 *
11 * Copyright 2008 Ben Gamari <bgamari@gmail.com>
12 *
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:
19 *
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
22 * Software.
23 *
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.
31 */
32
33#include <linux/debugfs.h>
34#include <linux/seq_file.h>
35#include <linux/slab.h>
36#include "drmP.h"
37
38#if defined(CONFIG_DEBUG_FS)
39
40/***************************************************
41 * Initialization, etc.
42 **************************************************/
43
44static struct drm_info_list drm_debugfs_list[] = {
45 {"name", drm_name_info, 0},
46 {"vm", drm_vm_info, 0},
47 {"clients", drm_clients_info, 0},
48 {"queues", drm_queues_info, 0},
49 {"bufs", drm_bufs_info, 0},
50 {"gem_names", drm_gem_name_info, DRIVER_GEM},
51#if DRM_DEBUG_CODE
52 {"vma", drm_vma_info, 0},
53#endif
54};
55#define DRM_DEBUGFS_ENTRIES ARRAY_SIZE(drm_debugfs_list)
56
57
58static int drm_debugfs_open(struct inode *inode, struct file *file)
59{
60 struct drm_info_node *node = inode->i_private;
61
62 return single_open(file, node->info_ent->show, node);
63}
64
65
66static const struct file_operations drm_debugfs_fops = {
67 .owner = THIS_MODULE,
68 .open = drm_debugfs_open,
69 .read = seq_read,
70 .llseek = seq_lseek,
71 .release = single_release,
72};
73
74
75/**
76 * Initialize a given set of debugfs files for a device
77 *
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
83 *
84 * Create a given set of debugfs files represented by an array of
85 * gdm_debugfs_lists in the given root directory.
86 */
87int drm_debugfs_create_files(struct drm_info_list *files, int count,
88 struct dentry *root, struct drm_minor *minor)
89{
90 struct drm_device *dev = minor->dev;
91 struct dentry *ent;
92 struct drm_info_node *tmp;
93 int i, ret;
94
95 for (i = 0; i < count; i++) {
96 u32 features = files[i].driver_features;
97
98 if (features != 0 &&
99 (dev->driver->driver_features & features) != features)
100 continue;
101
102 tmp = kmalloc(sizeof(struct drm_info_node), GFP_KERNEL);
103 if (tmp == NULL) {
104 ret = -1;
105 goto fail;
106 }
107 ent = debugfs_create_file(files[i].name, S_IFREG | S_IRUGO,
108 root, tmp, &drm_debugfs_fops);
109 if (!ent) {
110 char name[64];
111 strncpy(name, root->d_name.name,
112 min(root->d_name.len, 64U));
113 DRM_ERROR("Cannot create /sys/kernel/debug/dri/%s/%s\n",
114 name, files[i].name);
115 kfree(tmp);
116 ret = -1;
117 goto fail;
118 }
119
120 tmp->minor = minor;
121 tmp->dent = ent;
122 tmp->info_ent = &files[i];
123 list_add(&(tmp->list), &(minor->debugfs_nodes.list));
124 }
125 return 0;
126
127fail:
128 drm_debugfs_remove_files(files, count, minor);
129 return ret;
130}
131EXPORT_SYMBOL(drm_debugfs_create_files);
132
133/**
134 * Initialize the DRI debugfs filesystem for a device
135 *
136 * \param dev DRM device
137 * \param minor device minor number
138 * \param root DRI debugfs dir entry.
139 *
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%".
143 */
144int drm_debugfs_init(struct drm_minor *minor, int minor_id,
145 struct dentry *root)
146{
147 struct drm_device *dev = minor->dev;
148 char name[64];
149 int ret;
150
151 INIT_LIST_HEAD(&minor->debugfs_nodes.list);
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);
156 return -1;
157 }
158
159 ret = drm_debugfs_create_files(drm_debugfs_list, DRM_DEBUGFS_ENTRIES,
160 minor->debugfs_root, minor);
161 if (ret) {
162 debugfs_remove(minor->debugfs_root);
163 minor->debugfs_root = NULL;
164 DRM_ERROR("Failed to create core drm debugfs files\n");
165 return ret;
166 }
167
168 if (dev->driver->debugfs_init) {
169 ret = dev->driver->debugfs_init(minor);
170 if (ret) {
171 DRM_ERROR("DRM: Driver failed to initialize "
172 "/sys/kernel/debug/dri.\n");
173 return ret;
174 }
175 }
176 return 0;
177}
178
179
180/**
181 * Remove a list of debugfs files
182 *
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.
187 *
188 * Remove all debugfs entries created by debugfs_init().
189 */
190int drm_debugfs_remove_files(struct drm_info_list *files, int count,
191 struct drm_minor *minor)
192{
193 struct list_head *pos, *q;
194 struct drm_info_node *tmp;
195 int i;
196
197 for (i = 0; i < count; i++) {
198 list_for_each_safe(pos, q, &minor->debugfs_nodes.list) {
199 tmp = list_entry(pos, struct drm_info_node, list);
200 if (tmp->info_ent == &files[i]) {
201 debugfs_remove(tmp->dent);
202 list_del(pos);
203 kfree(tmp);
204 }
205 }
206 }
207 return 0;
208}
209EXPORT_SYMBOL(drm_debugfs_remove_files);
210
211/**
212 * Cleanup the debugfs filesystem resources.
213 *
214 * \param minor device minor number.
215 * \return always zero.
216 *
217 * Remove all debugfs entries created by debugfs_init().
218 */
219int drm_debugfs_cleanup(struct drm_minor *minor)
220{
221 struct drm_device *dev = minor->dev;
222
223 if (!minor->debugfs_root)
224 return 0;
225
226 if (dev->driver->debugfs_cleanup)
227 dev->driver->debugfs_cleanup(minor);
228
229 drm_debugfs_remove_files(drm_debugfs_list, DRM_DEBUGFS_ENTRIES, minor);
230
231 debugfs_remove(minor->debugfs_root);
232 minor->debugfs_root = NULL;
233
234 return 0;
235}
236
237#endif /* CONFIG_DEBUG_FS */
238
1/*
2 * Created: Sun Dec 21 13:08:50 2008 by bgamari@gmail.com
3 *
4 * Copyright 2008 Ben Gamari <bgamari@gmail.com>
5 *
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:
12 *
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
15 * Software.
16 *
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.
24 */
25
26#include <linux/debugfs.h>
27#include <linux/seq_file.h>
28#include <linux/slab.h>
29#include <linux/export.h>
30
31#include <drm/drm_debugfs.h>
32#include <drm/drm_edid.h>
33#include <drm/drm_atomic.h>
34#include <drm/drmP.h>
35
36#include "drm_internal.h"
37#include "drm_crtc_internal.h"
38
39#if defined(CONFIG_DEBUG_FS)
40
41/***************************************************
42 * Initialization, etc.
43 **************************************************/
44
45static const struct drm_info_list drm_debugfs_list[] = {
46 {"name", drm_name_info, 0},
47 {"clients", drm_clients_info, 0},
48 {"gem_names", drm_gem_name_info, DRIVER_GEM},
49};
50#define DRM_DEBUGFS_ENTRIES ARRAY_SIZE(drm_debugfs_list)
51
52
53static int drm_debugfs_open(struct inode *inode, struct file *file)
54{
55 struct drm_info_node *node = inode->i_private;
56
57 return single_open(file, node->info_ent->show, node);
58}
59
60
61static const struct file_operations drm_debugfs_fops = {
62 .owner = THIS_MODULE,
63 .open = drm_debugfs_open,
64 .read = seq_read,
65 .llseek = seq_lseek,
66 .release = single_release,
67};
68
69
70/**
71 * drm_debugfs_create_files - Initialize a given set of debugfs files for DRM
72 * minor
73 * @files: The array of files to create
74 * @count: The number of files given
75 * @root: DRI debugfs dir entry.
76 * @minor: device minor number
77 *
78 * Create a given set of debugfs files represented by an array of
79 * &struct drm_info_list in the given root directory. These files will be removed
80 * automatically on drm_debugfs_cleanup().
81 */
82int drm_debugfs_create_files(const struct drm_info_list *files, int count,
83 struct dentry *root, struct drm_minor *minor)
84{
85 struct drm_device *dev = minor->dev;
86 struct dentry *ent;
87 struct drm_info_node *tmp;
88 int i, ret;
89
90 for (i = 0; i < count; i++) {
91 u32 features = files[i].driver_features;
92
93 if (features != 0 &&
94 (dev->driver->driver_features & features) != features)
95 continue;
96
97 tmp = kmalloc(sizeof(struct drm_info_node), GFP_KERNEL);
98 if (tmp == NULL) {
99 ret = -1;
100 goto fail;
101 }
102 ent = debugfs_create_file(files[i].name, S_IFREG | S_IRUGO,
103 root, tmp, &drm_debugfs_fops);
104 if (!ent) {
105 DRM_ERROR("Cannot create /sys/kernel/debug/dri/%pd/%s\n",
106 root, files[i].name);
107 kfree(tmp);
108 ret = -1;
109 goto fail;
110 }
111
112 tmp->minor = minor;
113 tmp->dent = ent;
114 tmp->info_ent = &files[i];
115
116 mutex_lock(&minor->debugfs_lock);
117 list_add(&tmp->list, &minor->debugfs_list);
118 mutex_unlock(&minor->debugfs_lock);
119 }
120 return 0;
121
122fail:
123 drm_debugfs_remove_files(files, count, minor);
124 return ret;
125}
126EXPORT_SYMBOL(drm_debugfs_create_files);
127
128int drm_debugfs_init(struct drm_minor *minor, int minor_id,
129 struct dentry *root)
130{
131 struct drm_device *dev = minor->dev;
132 char name[64];
133 int ret;
134
135 INIT_LIST_HEAD(&minor->debugfs_list);
136 mutex_init(&minor->debugfs_lock);
137 sprintf(name, "%d", minor_id);
138 minor->debugfs_root = debugfs_create_dir(name, root);
139 if (!minor->debugfs_root) {
140 DRM_ERROR("Cannot create /sys/kernel/debug/dri/%s\n", name);
141 return -1;
142 }
143
144 ret = drm_debugfs_create_files(drm_debugfs_list, DRM_DEBUGFS_ENTRIES,
145 minor->debugfs_root, minor);
146 if (ret) {
147 debugfs_remove(minor->debugfs_root);
148 minor->debugfs_root = NULL;
149 DRM_ERROR("Failed to create core drm debugfs files\n");
150 return ret;
151 }
152
153 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
154 ret = drm_atomic_debugfs_init(minor);
155 if (ret) {
156 DRM_ERROR("Failed to create atomic debugfs files\n");
157 return ret;
158 }
159 }
160
161 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
162 ret = drm_framebuffer_debugfs_init(minor);
163 if (ret) {
164 DRM_ERROR("Failed to create framebuffer debugfs file\n");
165 return ret;
166 }
167 }
168
169 if (dev->driver->debugfs_init) {
170 ret = dev->driver->debugfs_init(minor);
171 if (ret) {
172 DRM_ERROR("DRM: Driver failed to initialize "
173 "/sys/kernel/debug/dri.\n");
174 return ret;
175 }
176 }
177 return 0;
178}
179
180
181int drm_debugfs_remove_files(const struct drm_info_list *files, int count,
182 struct drm_minor *minor)
183{
184 struct list_head *pos, *q;
185 struct drm_info_node *tmp;
186 int i;
187
188 mutex_lock(&minor->debugfs_lock);
189 for (i = 0; i < count; i++) {
190 list_for_each_safe(pos, q, &minor->debugfs_list) {
191 tmp = list_entry(pos, struct drm_info_node, list);
192 if (tmp->info_ent == &files[i]) {
193 debugfs_remove(tmp->dent);
194 list_del(pos);
195 kfree(tmp);
196 }
197 }
198 }
199 mutex_unlock(&minor->debugfs_lock);
200 return 0;
201}
202EXPORT_SYMBOL(drm_debugfs_remove_files);
203
204static void drm_debugfs_remove_all_files(struct drm_minor *minor)
205{
206 struct drm_info_node *node, *tmp;
207
208 mutex_lock(&minor->debugfs_lock);
209 list_for_each_entry_safe(node, tmp, &minor->debugfs_list, list) {
210 debugfs_remove(node->dent);
211 list_del(&node->list);
212 kfree(node);
213 }
214 mutex_unlock(&minor->debugfs_lock);
215}
216
217int drm_debugfs_cleanup(struct drm_minor *minor)
218{
219 if (!minor->debugfs_root)
220 return 0;
221
222 drm_debugfs_remove_all_files(minor);
223
224 debugfs_remove_recursive(minor->debugfs_root);
225 minor->debugfs_root = NULL;
226
227 return 0;
228}
229
230static int connector_show(struct seq_file *m, void *data)
231{
232 struct drm_connector *connector = m->private;
233
234 seq_printf(m, "%s\n", drm_get_connector_force_name(connector->force));
235
236 return 0;
237}
238
239static int connector_open(struct inode *inode, struct file *file)
240{
241 struct drm_connector *dev = inode->i_private;
242
243 return single_open(file, connector_show, dev);
244}
245
246static ssize_t connector_write(struct file *file, const char __user *ubuf,
247 size_t len, loff_t *offp)
248{
249 struct seq_file *m = file->private_data;
250 struct drm_connector *connector = m->private;
251 char buf[12];
252
253 if (len > sizeof(buf) - 1)
254 return -EINVAL;
255
256 if (copy_from_user(buf, ubuf, len))
257 return -EFAULT;
258
259 buf[len] = '\0';
260
261 if (!strcmp(buf, "on"))
262 connector->force = DRM_FORCE_ON;
263 else if (!strcmp(buf, "digital"))
264 connector->force = DRM_FORCE_ON_DIGITAL;
265 else if (!strcmp(buf, "off"))
266 connector->force = DRM_FORCE_OFF;
267 else if (!strcmp(buf, "unspecified"))
268 connector->force = DRM_FORCE_UNSPECIFIED;
269 else
270 return -EINVAL;
271
272 return len;
273}
274
275static int edid_show(struct seq_file *m, void *data)
276{
277 struct drm_connector *connector = m->private;
278 struct drm_property_blob *edid = connector->edid_blob_ptr;
279
280 if (connector->override_edid && edid)
281 seq_write(m, edid->data, edid->length);
282
283 return 0;
284}
285
286static int edid_open(struct inode *inode, struct file *file)
287{
288 struct drm_connector *dev = inode->i_private;
289
290 return single_open(file, edid_show, dev);
291}
292
293static ssize_t edid_write(struct file *file, const char __user *ubuf,
294 size_t len, loff_t *offp)
295{
296 struct seq_file *m = file->private_data;
297 struct drm_connector *connector = m->private;
298 char *buf;
299 struct edid *edid;
300 int ret;
301
302 buf = memdup_user(ubuf, len);
303 if (IS_ERR(buf))
304 return PTR_ERR(buf);
305
306 edid = (struct edid *) buf;
307
308 if (len == 5 && !strncmp(buf, "reset", 5)) {
309 connector->override_edid = false;
310 ret = drm_mode_connector_update_edid_property(connector, NULL);
311 } else if (len < EDID_LENGTH ||
312 EDID_LENGTH * (1 + edid->extensions) > len)
313 ret = -EINVAL;
314 else {
315 connector->override_edid = false;
316 ret = drm_mode_connector_update_edid_property(connector, edid);
317 if (!ret)
318 connector->override_edid = true;
319 }
320
321 kfree(buf);
322
323 return (ret) ? ret : len;
324}
325
326static const struct file_operations drm_edid_fops = {
327 .owner = THIS_MODULE,
328 .open = edid_open,
329 .read = seq_read,
330 .llseek = seq_lseek,
331 .release = single_release,
332 .write = edid_write
333};
334
335
336static const struct file_operations drm_connector_fops = {
337 .owner = THIS_MODULE,
338 .open = connector_open,
339 .read = seq_read,
340 .llseek = seq_lseek,
341 .release = single_release,
342 .write = connector_write
343};
344
345int drm_debugfs_connector_add(struct drm_connector *connector)
346{
347 struct drm_minor *minor = connector->dev->primary;
348 struct dentry *root, *ent;
349
350 if (!minor->debugfs_root)
351 return -1;
352
353 root = debugfs_create_dir(connector->name, minor->debugfs_root);
354 if (!root)
355 return -ENOMEM;
356
357 connector->debugfs_entry = root;
358
359 /* force */
360 ent = debugfs_create_file("force", S_IRUGO | S_IWUSR, root, connector,
361 &drm_connector_fops);
362 if (!ent)
363 goto error;
364
365 /* edid */
366 ent = debugfs_create_file("edid_override", S_IRUGO | S_IWUSR, root,
367 connector, &drm_edid_fops);
368 if (!ent)
369 goto error;
370
371 return 0;
372
373error:
374 debugfs_remove_recursive(connector->debugfs_entry);
375 connector->debugfs_entry = NULL;
376 return -ENOMEM;
377}
378
379void drm_debugfs_connector_remove(struct drm_connector *connector)
380{
381 if (!connector->debugfs_entry)
382 return;
383
384 debugfs_remove_recursive(connector->debugfs_entry);
385
386 connector->debugfs_entry = NULL;
387}
388
389int drm_debugfs_crtc_add(struct drm_crtc *crtc)
390{
391 struct drm_minor *minor = crtc->dev->primary;
392 struct dentry *root;
393 char *name;
394
395 name = kasprintf(GFP_KERNEL, "crtc-%d", crtc->index);
396 if (!name)
397 return -ENOMEM;
398
399 root = debugfs_create_dir(name, minor->debugfs_root);
400 kfree(name);
401 if (!root)
402 return -ENOMEM;
403
404 crtc->debugfs_entry = root;
405
406 if (drm_debugfs_crtc_crc_add(crtc))
407 goto error;
408
409 return 0;
410
411error:
412 drm_debugfs_crtc_remove(crtc);
413 return -ENOMEM;
414}
415
416void drm_debugfs_crtc_remove(struct drm_crtc *crtc)
417{
418 debugfs_remove_recursive(crtc->debugfs_entry);
419 crtc->debugfs_entry = NULL;
420}
421
422#endif /* CONFIG_DEBUG_FS */