xref: /linux/drivers/gpu/drm/drm_debugfs.c (revision e5c86679d5e864947a52fb31e45a425dea3e7fa9) 
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 <linux/export.h>
37 #include <drm/drmP.h>
38 #include <drm/drm_edid.h>
39 #include <drm/drm_atomic.h>
40 #include "drm_internal.h"
41 #include "drm_crtc_internal.h"
42 
43 #if defined(CONFIG_DEBUG_FS)
44 
45 /***************************************************
46  * Initialization, etc.
47  **************************************************/
48 
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},
53 };
54 #define DRM_DEBUGFS_ENTRIES ARRAY_SIZE(drm_debugfs_list)
55 
56 
57 static int drm_debugfs_open(struct inode *inode, struct file *file)
58 {
59 	struct drm_info_node *node = inode->i_private;
60 
61 	return single_open(file, node->info_ent->show, node);
62 }
63 
64 
65 static const struct file_operations drm_debugfs_fops = {
66 	.owner = THIS_MODULE,
67 	.open = drm_debugfs_open,
68 	.read = seq_read,
69 	.llseek = seq_lseek,
70 	.release = single_release,
71 };
72 
73 
74 /**
75  * Initialize a given set of debugfs files for a device
76  *
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
82  *
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().
86  */
87 int drm_debugfs_create_files(const 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 			DRM_ERROR("Cannot create /sys/kernel/debug/dri/%pd/%s\n",
111 				  root, files[i].name);
112 			kfree(tmp);
113 			ret = -1;
114 			goto fail;
115 		}
116 
117 		tmp->minor = minor;
118 		tmp->dent = ent;
119 		tmp->info_ent = &files[i];
120 
121 		mutex_lock(&minor->debugfs_lock);
122 		list_add(&tmp->list, &minor->debugfs_list);
123 		mutex_unlock(&minor->debugfs_lock);
124 	}
125 	return 0;
126 
127 fail:
128 	drm_debugfs_remove_files(files, count, minor);
129 	return ret;
130 }
131 EXPORT_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  */
144 int 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_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);
157 		return -1;
158 	}
159 
160 	ret = drm_debugfs_create_files(drm_debugfs_list, DRM_DEBUGFS_ENTRIES,
161 				       minor->debugfs_root, minor);
162 	if (ret) {
163 		debugfs_remove(minor->debugfs_root);
164 		minor->debugfs_root = NULL;
165 		DRM_ERROR("Failed to create core drm debugfs files\n");
166 		return ret;
167 	}
168 
169 	if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
170 		ret = drm_atomic_debugfs_init(minor);
171 		if (ret) {
172 			DRM_ERROR("Failed to create atomic debugfs files\n");
173 			return ret;
174 		}
175 	}
176 
177 	if (dev->driver->debugfs_init) {
178 		ret = dev->driver->debugfs_init(minor);
179 		if (ret) {
180 			DRM_ERROR("DRM: Driver failed to initialize "
181 				  "/sys/kernel/debug/dri.\n");
182 			return ret;
183 		}
184 	}
185 	return 0;
186 }
187 
188 
189 /**
190  * Remove a list of debugfs files
191  *
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.
196  *
197  * Remove all debugfs entries created by debugfs_init().
198  */
199 int drm_debugfs_remove_files(const struct drm_info_list *files, int count,
200 			     struct drm_minor *minor)
201 {
202 	struct list_head *pos, *q;
203 	struct drm_info_node *tmp;
204 	int i;
205 
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);
212 				list_del(pos);
213 				kfree(tmp);
214 			}
215 		}
216 	}
217 	mutex_unlock(&minor->debugfs_lock);
218 	return 0;
219 }
220 EXPORT_SYMBOL(drm_debugfs_remove_files);
221 
222 static void drm_debugfs_remove_all_files(struct drm_minor *minor)
223 {
224 	struct drm_info_node *node, *tmp;
225 
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);
230 		kfree(node);
231 	}
232 	mutex_unlock(&minor->debugfs_lock);
233 }
234 
235 /**
236  * Cleanup the debugfs filesystem resources.
237  *
238  * \param minor device minor number.
239  * \return always zero.
240  *
241  * Remove all debugfs entries created by debugfs_init().
242  */
243 int drm_debugfs_cleanup(struct drm_minor *minor)
244 {
245 	struct drm_device *dev = minor->dev;
246 
247 	if (!minor->debugfs_root)
248 		return 0;
249 
250 	if (dev->driver->debugfs_cleanup)
251 		dev->driver->debugfs_cleanup(minor);
252 
253 	drm_debugfs_remove_all_files(minor);
254 
255 	debugfs_remove_recursive(minor->debugfs_root);
256 	minor->debugfs_root = NULL;
257 
258 	return 0;
259 }
260 
261 static int connector_show(struct seq_file *m, void *data)
262 {
263 	struct drm_connector *connector = m->private;
264 	const char *status;
265 
266 	switch (connector->force) {
267 	case DRM_FORCE_ON:
268 		status = "on\n";
269 		break;
270 
271 	case DRM_FORCE_ON_DIGITAL:
272 		status = "digital\n";
273 		break;
274 
275 	case DRM_FORCE_OFF:
276 		status = "off\n";
277 		break;
278 
279 	case DRM_FORCE_UNSPECIFIED:
280 		status = "unspecified\n";
281 		break;
282 
283 	default:
284 		return 0;
285 	}
286 
287 	seq_puts(m, status);
288 
289 	return 0;
290 }
291 
292 static int connector_open(struct inode *inode, struct file *file)
293 {
294 	struct drm_connector *dev = inode->i_private;
295 
296 	return single_open(file, connector_show, dev);
297 }
298 
299 static ssize_t connector_write(struct file *file, const char __user *ubuf,
300 			       size_t len, loff_t *offp)
301 {
302 	struct seq_file *m = file->private_data;
303 	struct drm_connector *connector = m->private;
304 	char buf[12];
305 
306 	if (len > sizeof(buf) - 1)
307 		return -EINVAL;
308 
309 	if (copy_from_user(buf, ubuf, len))
310 		return -EFAULT;
311 
312 	buf[len] = '\0';
313 
314 	if (!strcmp(buf, "on"))
315 		connector->force = DRM_FORCE_ON;
316 	else if (!strcmp(buf, "digital"))
317 		connector->force = DRM_FORCE_ON_DIGITAL;
318 	else if (!strcmp(buf, "off"))
319 		connector->force = DRM_FORCE_OFF;
320 	else if (!strcmp(buf, "unspecified"))
321 		connector->force = DRM_FORCE_UNSPECIFIED;
322 	else
323 		return -EINVAL;
324 
325 	return len;
326 }
327 
328 static int edid_show(struct seq_file *m, void *data)
329 {
330 	struct drm_connector *connector = m->private;
331 	struct drm_property_blob *edid = connector->edid_blob_ptr;
332 
333 	if (connector->override_edid && edid)
334 		seq_write(m, edid->data, edid->length);
335 
336 	return 0;
337 }
338 
339 static int edid_open(struct inode *inode, struct file *file)
340 {
341 	struct drm_connector *dev = inode->i_private;
342 
343 	return single_open(file, edid_show, dev);
344 }
345 
346 static ssize_t edid_write(struct file *file, const char __user *ubuf,
347 			  size_t len, loff_t *offp)
348 {
349 	struct seq_file *m = file->private_data;
350 	struct drm_connector *connector = m->private;
351 	char *buf;
352 	struct edid *edid;
353 	int ret;
354 
355 	buf = memdup_user(ubuf, len);
356 	if (IS_ERR(buf))
357 		return PTR_ERR(buf);
358 
359 	edid = (struct edid *) buf;
360 
361 	if (len == 5 && !strncmp(buf, "reset", 5)) {
362 		connector->override_edid = false;
363 		ret = drm_mode_connector_update_edid_property(connector, NULL);
364 	} else if (len < EDID_LENGTH ||
365 		   EDID_LENGTH * (1 + edid->extensions) > len)
366 		ret = -EINVAL;
367 	else {
368 		connector->override_edid = false;
369 		ret = drm_mode_connector_update_edid_property(connector, edid);
370 		if (!ret)
371 			connector->override_edid = true;
372 	}
373 
374 	kfree(buf);
375 
376 	return (ret) ? ret : len;
377 }
378 
379 static const struct file_operations drm_edid_fops = {
380 	.owner = THIS_MODULE,
381 	.open = edid_open,
382 	.read = seq_read,
383 	.llseek = seq_lseek,
384 	.release = single_release,
385 	.write = edid_write
386 };
387 
388 
389 static const struct file_operations drm_connector_fops = {
390 	.owner = THIS_MODULE,
391 	.open = connector_open,
392 	.read = seq_read,
393 	.llseek = seq_lseek,
394 	.release = single_release,
395 	.write = connector_write
396 };
397 
398 int drm_debugfs_connector_add(struct drm_connector *connector)
399 {
400 	struct drm_minor *minor = connector->dev->primary;
401 	struct dentry *root, *ent;
402 
403 	if (!minor->debugfs_root)
404 		return -1;
405 
406 	root = debugfs_create_dir(connector->name, minor->debugfs_root);
407 	if (!root)
408 		return -ENOMEM;
409 
410 	connector->debugfs_entry = root;
411 
412 	/* force */
413 	ent = debugfs_create_file("force", S_IRUGO | S_IWUSR, root, connector,
414 				  &drm_connector_fops);
415 	if (!ent)
416 		goto error;
417 
418 	/* edid */
419 	ent = debugfs_create_file("edid_override", S_IRUGO | S_IWUSR, root,
420 				  connector, &drm_edid_fops);
421 	if (!ent)
422 		goto error;
423 
424 	return 0;
425 
426 error:
427 	debugfs_remove_recursive(connector->debugfs_entry);
428 	connector->debugfs_entry = NULL;
429 	return -ENOMEM;
430 }
431 
432 void drm_debugfs_connector_remove(struct drm_connector *connector)
433 {
434 	if (!connector->debugfs_entry)
435 		return;
436 
437 	debugfs_remove_recursive(connector->debugfs_entry);
438 
439 	connector->debugfs_entry = NULL;
440 }
441 
442 int drm_debugfs_crtc_add(struct drm_crtc *crtc)
443 {
444 	struct drm_minor *minor = crtc->dev->primary;
445 	struct dentry *root;
446 	char *name;
447 
448 	name = kasprintf(GFP_KERNEL, "crtc-%d", crtc->index);
449 	if (!name)
450 		return -ENOMEM;
451 
452 	root = debugfs_create_dir(name, minor->debugfs_root);
453 	kfree(name);
454 	if (!root)
455 		return -ENOMEM;
456 
457 	crtc->debugfs_entry = root;
458 
459 	if (drm_debugfs_crtc_crc_add(crtc))
460 		goto error;
461 
462 	return 0;
463 
464 error:
465 	drm_debugfs_crtc_remove(crtc);
466 	return -ENOMEM;
467 }
468 
469 void drm_debugfs_crtc_remove(struct drm_crtc *crtc)
470 {
471 	debugfs_remove_recursive(crtc->debugfs_entry);
472 	crtc->debugfs_entry = NULL;
473 }
474 
475 #endif /* CONFIG_DEBUG_FS */
476