]>
Commit | Line | Data |
---|---|---|
28a62277 BG |
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> | |
5a0e3ad6 | 35 | #include <linux/slab.h> |
2d1a8a48 | 36 | #include <linux/export.h> |
760285e7 | 37 | #include <drm/drmP.h> |
4cf2b281 | 38 | #include <drm/drm_edid.h> |
6559c901 | 39 | #include <drm/drm_atomic.h> |
67d0ec4e | 40 | #include "drm_internal.h" |
5bc9cb4d | 41 | #include "drm_crtc_internal.h" |
28a62277 BG |
42 | |
43 | #if defined(CONFIG_DEBUG_FS) | |
44 | ||
45 | /*************************************************** | |
46 | * Initialization, etc. | |
47 | **************************************************/ | |
48 | ||
36f73b2f | 49 | static const struct drm_info_list drm_debugfs_list[] = { |
28a62277 | 50 | {"name", drm_name_info, 0}, |
28a62277 | 51 | {"clients", drm_clients_info, 0}, |
28a62277 | 52 | {"gem_names", drm_gem_name_info, DRIVER_GEM}, |
28a62277 BG |
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 | |
086f2e5c NT |
84 | * &drm_info_list in the given root directory. These files will be removed |
85 | * automatically on drm_debugfs_cleanup(). | |
28a62277 | 86 | */ |
7d74795b | 87 | int drm_debugfs_create_files(const struct drm_info_list *files, int count, |
28a62277 BG |
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; | |
28a62277 BG |
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 | ||
9a298b2a | 102 | tmp = kmalloc(sizeof(struct drm_info_node), GFP_KERNEL); |
d25e3a6f JS |
103 | if (tmp == NULL) { |
104 | ret = -1; | |
105 | goto fail; | |
106 | } | |
28a62277 BG |
107 | ent = debugfs_create_file(files[i].name, S_IFREG | S_IRUGO, |
108 | root, tmp, &drm_debugfs_fops); | |
109 | if (!ent) { | |
bcd599e7 AV |
110 | DRM_ERROR("Cannot create /sys/kernel/debug/dri/%pd/%s\n", |
111 | root, files[i].name); | |
9a298b2a | 112 | kfree(tmp); |
28a62277 BG |
113 | ret = -1; |
114 | goto fail; | |
115 | } | |
116 | ||
117 | tmp->minor = minor; | |
118 | tmp->dent = ent; | |
119 | tmp->info_ent = &files[i]; | |
b3e067c0 MS |
120 | |
121 | mutex_lock(&minor->debugfs_lock); | |
122 | list_add(&tmp->list, &minor->debugfs_list); | |
123 | mutex_unlock(&minor->debugfs_lock); | |
28a62277 BG |
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 | * | |
156f5a78 GL |
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%". | |
28a62277 BG |
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 | ||
b3e067c0 MS |
151 | INIT_LIST_HEAD(&minor->debugfs_list); |
152 | mutex_init(&minor->debugfs_lock); | |
28a62277 BG |
153 | sprintf(name, "%d", minor_id); |
154 | minor->debugfs_root = debugfs_create_dir(name, root); | |
155 | if (!minor->debugfs_root) { | |
156f5a78 | 156 | DRM_ERROR("Cannot create /sys/kernel/debug/dri/%s\n", name); |
28a62277 BG |
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 | ||
6559c901 RC |
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 | ||
28a62277 BG |
177 | if (dev->driver->debugfs_init) { |
178 | ret = dev->driver->debugfs_init(minor); | |
179 | if (ret) { | |
180 | DRM_ERROR("DRM: Driver failed to initialize " | |
156f5a78 | 181 | "/sys/kernel/debug/dri.\n"); |
28a62277 BG |
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 | */ | |
7d74795b | 199 | int drm_debugfs_remove_files(const struct drm_info_list *files, int count, |
28a62277 BG |
200 | struct drm_minor *minor) |
201 | { | |
202 | struct list_head *pos, *q; | |
203 | struct drm_info_node *tmp; | |
204 | int i; | |
205 | ||
b3e067c0 | 206 | mutex_lock(&minor->debugfs_lock); |
28a62277 | 207 | for (i = 0; i < count; i++) { |
b3e067c0 | 208 | list_for_each_safe(pos, q, &minor->debugfs_list) { |
28a62277 BG |
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); | |
9a298b2a | 213 | kfree(tmp); |
28a62277 BG |
214 | } |
215 | } | |
216 | } | |
b3e067c0 | 217 | mutex_unlock(&minor->debugfs_lock); |
28a62277 BG |
218 | return 0; |
219 | } | |
220 | EXPORT_SYMBOL(drm_debugfs_remove_files); | |
221 | ||
086f2e5c NT |
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 | ||
28a62277 BG |
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 | ||
086f2e5c | 253 | drm_debugfs_remove_all_files(minor); |
28a62277 | 254 | |
086f2e5c | 255 | debugfs_remove_recursive(minor->debugfs_root); |
28a62277 BG |
256 | minor->debugfs_root = NULL; |
257 | ||
258 | return 0; | |
259 | } | |
260 | ||
30f65707 TW |
261 | static int connector_show(struct seq_file *m, void *data) |
262 | { | |
263 | struct drm_connector *connector = m->private; | |
30f65707 | 264 | |
6140cf20 | 265 | seq_printf(m, "%s\n", drm_get_connector_force_name(connector->force)); |
30f65707 TW |
266 | |
267 | return 0; | |
268 | } | |
269 | ||
270 | static int connector_open(struct inode *inode, struct file *file) | |
271 | { | |
272 | struct drm_connector *dev = inode->i_private; | |
273 | ||
274 | return single_open(file, connector_show, dev); | |
275 | } | |
276 | ||
277 | static ssize_t connector_write(struct file *file, const char __user *ubuf, | |
278 | size_t len, loff_t *offp) | |
279 | { | |
280 | struct seq_file *m = file->private_data; | |
281 | struct drm_connector *connector = m->private; | |
282 | char buf[12]; | |
283 | ||
284 | if (len > sizeof(buf) - 1) | |
285 | return -EINVAL; | |
286 | ||
287 | if (copy_from_user(buf, ubuf, len)) | |
288 | return -EFAULT; | |
289 | ||
290 | buf[len] = '\0'; | |
291 | ||
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; | |
300 | else | |
301 | return -EINVAL; | |
302 | ||
303 | return len; | |
304 | } | |
305 | ||
4cf2b281 TW |
306 | static int edid_show(struct seq_file *m, void *data) |
307 | { | |
308 | struct drm_connector *connector = m->private; | |
309 | struct drm_property_blob *edid = connector->edid_blob_ptr; | |
310 | ||
311 | if (connector->override_edid && edid) | |
312 | seq_write(m, edid->data, edid->length); | |
313 | ||
314 | return 0; | |
315 | } | |
316 | ||
317 | static int edid_open(struct inode *inode, struct file *file) | |
318 | { | |
319 | struct drm_connector *dev = inode->i_private; | |
320 | ||
321 | return single_open(file, edid_show, dev); | |
322 | } | |
323 | ||
324 | static ssize_t edid_write(struct file *file, const char __user *ubuf, | |
325 | size_t len, loff_t *offp) | |
326 | { | |
327 | struct seq_file *m = file->private_data; | |
328 | struct drm_connector *connector = m->private; | |
329 | char *buf; | |
330 | struct edid *edid; | |
331 | int ret; | |
332 | ||
333 | buf = memdup_user(ubuf, len); | |
334 | if (IS_ERR(buf)) | |
335 | return PTR_ERR(buf); | |
336 | ||
337 | edid = (struct edid *) buf; | |
338 | ||
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) | |
344 | ret = -EINVAL; | |
345 | else { | |
346 | connector->override_edid = false; | |
347 | ret = drm_mode_connector_update_edid_property(connector, edid); | |
348 | if (!ret) | |
349 | connector->override_edid = true; | |
350 | } | |
351 | ||
352 | kfree(buf); | |
353 | ||
354 | return (ret) ? ret : len; | |
355 | } | |
356 | ||
357 | static const struct file_operations drm_edid_fops = { | |
358 | .owner = THIS_MODULE, | |
359 | .open = edid_open, | |
360 | .read = seq_read, | |
361 | .llseek = seq_lseek, | |
362 | .release = single_release, | |
363 | .write = edid_write | |
364 | }; | |
365 | ||
366 | ||
30f65707 TW |
367 | static const struct file_operations drm_connector_fops = { |
368 | .owner = THIS_MODULE, | |
369 | .open = connector_open, | |
370 | .read = seq_read, | |
371 | .llseek = seq_lseek, | |
372 | .release = single_release, | |
373 | .write = connector_write | |
374 | }; | |
375 | ||
376 | int drm_debugfs_connector_add(struct drm_connector *connector) | |
377 | { | |
378 | struct drm_minor *minor = connector->dev->primary; | |
379 | struct dentry *root, *ent; | |
380 | ||
381 | if (!minor->debugfs_root) | |
382 | return -1; | |
383 | ||
384 | root = debugfs_create_dir(connector->name, minor->debugfs_root); | |
385 | if (!root) | |
386 | return -ENOMEM; | |
387 | ||
388 | connector->debugfs_entry = root; | |
389 | ||
390 | /* force */ | |
391 | ent = debugfs_create_file("force", S_IRUGO | S_IWUSR, root, connector, | |
392 | &drm_connector_fops); | |
393 | if (!ent) | |
394 | goto error; | |
395 | ||
4cf2b281 TW |
396 | /* edid */ |
397 | ent = debugfs_create_file("edid_override", S_IRUGO | S_IWUSR, root, | |
398 | connector, &drm_edid_fops); | |
399 | if (!ent) | |
400 | goto error; | |
401 | ||
30f65707 TW |
402 | return 0; |
403 | ||
404 | error: | |
405 | debugfs_remove_recursive(connector->debugfs_entry); | |
406 | connector->debugfs_entry = NULL; | |
407 | return -ENOMEM; | |
408 | } | |
409 | ||
410 | void drm_debugfs_connector_remove(struct drm_connector *connector) | |
411 | { | |
412 | if (!connector->debugfs_entry) | |
413 | return; | |
414 | ||
415 | debugfs_remove_recursive(connector->debugfs_entry); | |
416 | ||
417 | connector->debugfs_entry = NULL; | |
418 | } | |
419 | ||
9edbf1fa TV |
420 | int drm_debugfs_crtc_add(struct drm_crtc *crtc) |
421 | { | |
422 | struct drm_minor *minor = crtc->dev->primary; | |
423 | struct dentry *root; | |
424 | char *name; | |
425 | ||
426 | name = kasprintf(GFP_KERNEL, "crtc-%d", crtc->index); | |
427 | if (!name) | |
428 | return -ENOMEM; | |
429 | ||
430 | root = debugfs_create_dir(name, minor->debugfs_root); | |
431 | kfree(name); | |
432 | if (!root) | |
433 | return -ENOMEM; | |
434 | ||
435 | crtc->debugfs_entry = root; | |
436 | ||
437 | if (drm_debugfs_crtc_crc_add(crtc)) | |
438 | goto error; | |
28a62277 | 439 | |
9edbf1fa TV |
440 | return 0; |
441 | ||
442 | error: | |
443 | drm_debugfs_crtc_remove(crtc); | |
444 | return -ENOMEM; | |
445 | } | |
446 | ||
447 | void drm_debugfs_crtc_remove(struct drm_crtc *crtc) | |
448 | { | |
449 | debugfs_remove_recursive(crtc->debugfs_entry); | |
450 | crtc->debugfs_entry = NULL; | |
451 | } | |
452 | ||
453 | #endif /* CONFIG_DEBUG_FS */ |