xref: /linux/drivers/gpu/drm/drm_debugfs.c (revision ef426c103892eed94a9bb0ee59c2d0e6eac5179f) 
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  * gdm_debugfs_lists in the given root directory.
85  */
86 int drm_debugfs_create_files(const struct drm_info_list *files, int count,
87 			     struct dentry *root, struct drm_minor *minor)
88 {
89 	struct drm_device *dev = minor->dev;
90 	struct dentry *ent;
91 	struct drm_info_node *tmp;
92 	int i, ret;
93 
94 	for (i = 0; i < count; i++) {
95 		u32 features = files[i].driver_features;
96 
97 		if (features != 0 &&
98 		    (dev->driver->driver_features & features) != features)
99 			continue;
100 
101 		tmp = kmalloc(sizeof(struct drm_info_node), GFP_KERNEL);
102 		if (tmp == NULL) {
103 			ret = -1;
104 			goto fail;
105 		}
106 		ent = debugfs_create_file(files[i].name, S_IFREG | S_IRUGO,
107 					  root, tmp, &drm_debugfs_fops);
108 		if (!ent) {
109 			DRM_ERROR("Cannot create /sys/kernel/debug/dri/%pd/%s\n",
110 				  root, files[i].name);
111 			kfree(tmp);
112 			ret = -1;
113 			goto fail;
114 		}
115 
116 		tmp->minor = minor;
117 		tmp->dent = ent;
118 		tmp->info_ent = &files[i];
119 
120 		mutex_lock(&minor->debugfs_lock);
121 		list_add(&tmp->list, &minor->debugfs_list);
122 		mutex_unlock(&minor->debugfs_lock);
123 	}
124 	return 0;
125 
126 fail:
127 	drm_debugfs_remove_files(files, count, minor);
128 	return ret;
129 }
130 EXPORT_SYMBOL(drm_debugfs_create_files);
131 
132 /**
133  * Initialize the DRI debugfs filesystem for a device
134  *
135  * \param dev DRM device
136  * \param minor device minor number
137  * \param root DRI debugfs dir entry.
138  *
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%".
142  */
143 int drm_debugfs_init(struct drm_minor *minor, int minor_id,
144 		     struct dentry *root)
145 {
146 	struct drm_device *dev = minor->dev;
147 	char name[64];
148 	int ret;
149 
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);
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 (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
169 		ret = drm_atomic_debugfs_init(minor);
170 		if (ret) {
171 			DRM_ERROR("Failed to create atomic debugfs files\n");
172 			return ret;
173 		}
174 	}
175 
176 	if (dev->driver->debugfs_init) {
177 		ret = dev->driver->debugfs_init(minor);
178 		if (ret) {
179 			DRM_ERROR("DRM: Driver failed to initialize "
180 				  "/sys/kernel/debug/dri.\n");
181 			return ret;
182 		}
183 	}
184 	return 0;
185 }
186 
187 
188 /**
189  * Remove a list of debugfs files
190  *
191  * \param files The list of files
192  * \param count The number of files
193  * \param minor The minor of which we should remove the files
194  * \return always zero.
195  *
196  * Remove all debugfs entries created by debugfs_init().
197  */
198 int drm_debugfs_remove_files(const struct drm_info_list *files, int count,
199 			     struct drm_minor *minor)
200 {
201 	struct list_head *pos, *q;
202 	struct drm_info_node *tmp;
203 	int i;
204 
205 	mutex_lock(&minor->debugfs_lock);
206 	for (i = 0; i < count; i++) {
207 		list_for_each_safe(pos, q, &minor->debugfs_list) {
208 			tmp = list_entry(pos, struct drm_info_node, list);
209 			if (tmp->info_ent == &files[i]) {
210 				debugfs_remove(tmp->dent);
211 				list_del(pos);
212 				kfree(tmp);
213 			}
214 		}
215 	}
216 	mutex_unlock(&minor->debugfs_lock);
217 	return 0;
218 }
219 EXPORT_SYMBOL(drm_debugfs_remove_files);
220 
221 /**
222  * Cleanup the debugfs filesystem resources.
223  *
224  * \param minor device minor number.
225  * \return always zero.
226  *
227  * Remove all debugfs entries created by debugfs_init().
228  */
229 int drm_debugfs_cleanup(struct drm_minor *minor)
230 {
231 	struct drm_device *dev = minor->dev;
232 	int ret;
233 
234 	if (!minor->debugfs_root)
235 		return 0;
236 
237 	if (dev->driver->debugfs_cleanup)
238 		dev->driver->debugfs_cleanup(minor);
239 
240 	if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
241 		ret = drm_atomic_debugfs_cleanup(minor);
242 		if (ret) {
243 			DRM_ERROR("DRM: Failed to remove atomic debugfs entries\n");
244 			return ret;
245 		}
246 	}
247 
248 	drm_debugfs_remove_files(drm_debugfs_list, DRM_DEBUGFS_ENTRIES, minor);
249 
250 	debugfs_remove(minor->debugfs_root);
251 	minor->debugfs_root = NULL;
252 
253 	return 0;
254 }
255 
256 static int connector_show(struct seq_file *m, void *data)
257 {
258 	struct drm_connector *connector = m->private;
259 	const char *status;
260 
261 	switch (connector->force) {
262 	case DRM_FORCE_ON:
263 		status = "on\n";
264 		break;
265 
266 	case DRM_FORCE_ON_DIGITAL:
267 		status = "digital\n";
268 		break;
269 
270 	case DRM_FORCE_OFF:
271 		status = "off\n";
272 		break;
273 
274 	case DRM_FORCE_UNSPECIFIED:
275 		status = "unspecified\n";
276 		break;
277 
278 	default:
279 		return 0;
280 	}
281 
282 	seq_puts(m, status);
283 
284 	return 0;
285 }
286 
287 static int connector_open(struct inode *inode, struct file *file)
288 {
289 	struct drm_connector *dev = inode->i_private;
290 
291 	return single_open(file, connector_show, dev);
292 }
293 
294 static ssize_t connector_write(struct file *file, const char __user *ubuf,
295 			       size_t len, loff_t *offp)
296 {
297 	struct seq_file *m = file->private_data;
298 	struct drm_connector *connector = m->private;
299 	char buf[12];
300 
301 	if (len > sizeof(buf) - 1)
302 		return -EINVAL;
303 
304 	if (copy_from_user(buf, ubuf, len))
305 		return -EFAULT;
306 
307 	buf[len] = '\0';
308 
309 	if (!strcmp(buf, "on"))
310 		connector->force = DRM_FORCE_ON;
311 	else if (!strcmp(buf, "digital"))
312 		connector->force = DRM_FORCE_ON_DIGITAL;
313 	else if (!strcmp(buf, "off"))
314 		connector->force = DRM_FORCE_OFF;
315 	else if (!strcmp(buf, "unspecified"))
316 		connector->force = DRM_FORCE_UNSPECIFIED;
317 	else
318 		return -EINVAL;
319 
320 	return len;
321 }
322 
323 static int edid_show(struct seq_file *m, void *data)
324 {
325 	struct drm_connector *connector = m->private;
326 	struct drm_property_blob *edid = connector->edid_blob_ptr;
327 
328 	if (connector->override_edid && edid)
329 		seq_write(m, edid->data, edid->length);
330 
331 	return 0;
332 }
333 
334 static int edid_open(struct inode *inode, struct file *file)
335 {
336 	struct drm_connector *dev = inode->i_private;
337 
338 	return single_open(file, edid_show, dev);
339 }
340 
341 static ssize_t edid_write(struct file *file, const char __user *ubuf,
342 			  size_t len, loff_t *offp)
343 {
344 	struct seq_file *m = file->private_data;
345 	struct drm_connector *connector = m->private;
346 	char *buf;
347 	struct edid *edid;
348 	int ret;
349 
350 	buf = memdup_user(ubuf, len);
351 	if (IS_ERR(buf))
352 		return PTR_ERR(buf);
353 
354 	edid = (struct edid *) buf;
355 
356 	if (len == 5 && !strncmp(buf, "reset", 5)) {
357 		connector->override_edid = false;
358 		ret = drm_mode_connector_update_edid_property(connector, NULL);
359 	} else if (len < EDID_LENGTH ||
360 		   EDID_LENGTH * (1 + edid->extensions) > len)
361 		ret = -EINVAL;
362 	else {
363 		connector->override_edid = false;
364 		ret = drm_mode_connector_update_edid_property(connector, edid);
365 		if (!ret)
366 			connector->override_edid = true;
367 	}
368 
369 	kfree(buf);
370 
371 	return (ret) ? ret : len;
372 }
373 
374 static const struct file_operations drm_edid_fops = {
375 	.owner = THIS_MODULE,
376 	.open = edid_open,
377 	.read = seq_read,
378 	.llseek = seq_lseek,
379 	.release = single_release,
380 	.write = edid_write
381 };
382 
383 
384 static const struct file_operations drm_connector_fops = {
385 	.owner = THIS_MODULE,
386 	.open = connector_open,
387 	.read = seq_read,
388 	.llseek = seq_lseek,
389 	.release = single_release,
390 	.write = connector_write
391 };
392 
393 int drm_debugfs_connector_add(struct drm_connector *connector)
394 {
395 	struct drm_minor *minor = connector->dev->primary;
396 	struct dentry *root, *ent;
397 
398 	if (!minor->debugfs_root)
399 		return -1;
400 
401 	root = debugfs_create_dir(connector->name, minor->debugfs_root);
402 	if (!root)
403 		return -ENOMEM;
404 
405 	connector->debugfs_entry = root;
406 
407 	/* force */
408 	ent = debugfs_create_file("force", S_IRUGO | S_IWUSR, root, connector,
409 				  &drm_connector_fops);
410 	if (!ent)
411 		goto error;
412 
413 	/* edid */
414 	ent = debugfs_create_file("edid_override", S_IRUGO | S_IWUSR, root,
415 				  connector, &drm_edid_fops);
416 	if (!ent)
417 		goto error;
418 
419 	return 0;
420 
421 error:
422 	debugfs_remove_recursive(connector->debugfs_entry);
423 	connector->debugfs_entry = NULL;
424 	return -ENOMEM;
425 }
426 
427 void drm_debugfs_connector_remove(struct drm_connector *connector)
428 {
429 	if (!connector->debugfs_entry)
430 		return;
431 
432 	debugfs_remove_recursive(connector->debugfs_entry);
433 
434 	connector->debugfs_entry = NULL;
435 }
436 
437 int drm_debugfs_crtc_add(struct drm_crtc *crtc)
438 {
439 	struct drm_minor *minor = crtc->dev->primary;
440 	struct dentry *root;
441 	char *name;
442 
443 	name = kasprintf(GFP_KERNEL, "crtc-%d", crtc->index);
444 	if (!name)
445 		return -ENOMEM;
446 
447 	root = debugfs_create_dir(name, minor->debugfs_root);
448 	kfree(name);
449 	if (!root)
450 		return -ENOMEM;
451 
452 	crtc->debugfs_entry = root;
453 
454 	if (drm_debugfs_crtc_crc_add(crtc))
455 		goto error;
456 
457 	return 0;
458 
459 error:
460 	drm_debugfs_crtc_remove(crtc);
461 	return -ENOMEM;
462 }
463 
464 void drm_debugfs_crtc_remove(struct drm_crtc *crtc)
465 {
466 	debugfs_remove_recursive(crtc->debugfs_entry);
467 	crtc->debugfs_entry = NULL;
468 }
469 
470 #endif /* CONFIG_DEBUG_FS */
471