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> |
67d0ec4e | 39 | #include "drm_internal.h" |
28a62277 BG |
40 | |
41 | #if defined(CONFIG_DEBUG_FS) | |
42 | ||
43 | /*************************************************** | |
44 | * Initialization, etc. | |
45 | **************************************************/ | |
46 | ||
36f73b2f | 47 | static const struct drm_info_list drm_debugfs_list[] = { |
28a62277 BG |
48 | {"name", drm_name_info, 0}, |
49 | {"vm", drm_vm_info, 0}, | |
50 | {"clients", drm_clients_info, 0}, | |
28a62277 BG |
51 | {"bufs", drm_bufs_info, 0}, |
52 | {"gem_names", drm_gem_name_info, DRIVER_GEM}, | |
28a62277 | 53 | {"vma", drm_vma_info, 0}, |
28a62277 BG |
54 | }; |
55 | #define DRM_DEBUGFS_ENTRIES ARRAY_SIZE(drm_debugfs_list) | |
56 | ||
57 | ||
58 | static 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 | ||
66 | static 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 | */ | |
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) { | |
156f5a78 | 110 | DRM_ERROR("Cannot create /sys/kernel/debug/dri/%s/%s\n", |
bd8315c4 | 111 | root->d_name.name, 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 | ||
169 | if (dev->driver->debugfs_init) { | |
170 | ret = dev->driver->debugfs_init(minor); | |
171 | if (ret) { | |
172 | DRM_ERROR("DRM: Driver failed to initialize " | |
156f5a78 | 173 | "/sys/kernel/debug/dri.\n"); |
28a62277 BG |
174 | return ret; |
175 | } | |
176 | } | |
177 | return 0; | |
178 | } | |
179 | ||
180 | ||
181 | /** | |
182 | * Remove a list of debugfs files | |
183 | * | |
184 | * \param files The list of files | |
185 | * \param count The number of files | |
186 | * \param minor The minor of which we should remove the files | |
187 | * \return always zero. | |
188 | * | |
189 | * Remove all debugfs entries created by debugfs_init(). | |
190 | */ | |
7d74795b | 191 | int drm_debugfs_remove_files(const struct drm_info_list *files, int count, |
28a62277 BG |
192 | struct drm_minor *minor) |
193 | { | |
194 | struct list_head *pos, *q; | |
195 | struct drm_info_node *tmp; | |
196 | int i; | |
197 | ||
b3e067c0 | 198 | mutex_lock(&minor->debugfs_lock); |
28a62277 | 199 | for (i = 0; i < count; i++) { |
b3e067c0 | 200 | list_for_each_safe(pos, q, &minor->debugfs_list) { |
28a62277 BG |
201 | tmp = list_entry(pos, struct drm_info_node, list); |
202 | if (tmp->info_ent == &files[i]) { | |
203 | debugfs_remove(tmp->dent); | |
204 | list_del(pos); | |
9a298b2a | 205 | kfree(tmp); |
28a62277 BG |
206 | } |
207 | } | |
208 | } | |
b3e067c0 | 209 | mutex_unlock(&minor->debugfs_lock); |
28a62277 BG |
210 | return 0; |
211 | } | |
212 | EXPORT_SYMBOL(drm_debugfs_remove_files); | |
213 | ||
214 | /** | |
215 | * Cleanup the debugfs filesystem resources. | |
216 | * | |
217 | * \param minor device minor number. | |
218 | * \return always zero. | |
219 | * | |
220 | * Remove all debugfs entries created by debugfs_init(). | |
221 | */ | |
222 | int drm_debugfs_cleanup(struct drm_minor *minor) | |
223 | { | |
224 | struct drm_device *dev = minor->dev; | |
225 | ||
226 | if (!minor->debugfs_root) | |
227 | return 0; | |
228 | ||
229 | if (dev->driver->debugfs_cleanup) | |
230 | dev->driver->debugfs_cleanup(minor); | |
231 | ||
232 | drm_debugfs_remove_files(drm_debugfs_list, DRM_DEBUGFS_ENTRIES, minor); | |
233 | ||
234 | debugfs_remove(minor->debugfs_root); | |
235 | minor->debugfs_root = NULL; | |
236 | ||
237 | return 0; | |
238 | } | |
239 | ||
30f65707 TW |
240 | static int connector_show(struct seq_file *m, void *data) |
241 | { | |
242 | struct drm_connector *connector = m->private; | |
243 | const char *status; | |
244 | ||
245 | switch (connector->force) { | |
246 | case DRM_FORCE_ON: | |
247 | status = "on\n"; | |
248 | break; | |
249 | ||
250 | case DRM_FORCE_ON_DIGITAL: | |
251 | status = "digital\n"; | |
252 | break; | |
253 | ||
254 | case DRM_FORCE_OFF: | |
255 | status = "off\n"; | |
256 | break; | |
257 | ||
258 | case DRM_FORCE_UNSPECIFIED: | |
259 | status = "unspecified\n"; | |
260 | break; | |
261 | ||
262 | default: | |
263 | return 0; | |
264 | } | |
265 | ||
266 | seq_puts(m, status); | |
267 | ||
268 | return 0; | |
269 | } | |
270 | ||
271 | static int connector_open(struct inode *inode, struct file *file) | |
272 | { | |
273 | struct drm_connector *dev = inode->i_private; | |
274 | ||
275 | return single_open(file, connector_show, dev); | |
276 | } | |
277 | ||
278 | static ssize_t connector_write(struct file *file, const char __user *ubuf, | |
279 | size_t len, loff_t *offp) | |
280 | { | |
281 | struct seq_file *m = file->private_data; | |
282 | struct drm_connector *connector = m->private; | |
283 | char buf[12]; | |
284 | ||
285 | if (len > sizeof(buf) - 1) | |
286 | return -EINVAL; | |
287 | ||
288 | if (copy_from_user(buf, ubuf, len)) | |
289 | return -EFAULT; | |
290 | ||
291 | buf[len] = '\0'; | |
292 | ||
293 | if (!strcmp(buf, "on")) | |
294 | connector->force = DRM_FORCE_ON; | |
295 | else if (!strcmp(buf, "digital")) | |
296 | connector->force = DRM_FORCE_ON_DIGITAL; | |
297 | else if (!strcmp(buf, "off")) | |
298 | connector->force = DRM_FORCE_OFF; | |
299 | else if (!strcmp(buf, "unspecified")) | |
300 | connector->force = DRM_FORCE_UNSPECIFIED; | |
301 | else | |
302 | return -EINVAL; | |
303 | ||
304 | return len; | |
305 | } | |
306 | ||
4cf2b281 TW |
307 | static int edid_show(struct seq_file *m, void *data) |
308 | { | |
309 | struct drm_connector *connector = m->private; | |
310 | struct drm_property_blob *edid = connector->edid_blob_ptr; | |
311 | ||
312 | if (connector->override_edid && edid) | |
313 | seq_write(m, edid->data, edid->length); | |
314 | ||
315 | return 0; | |
316 | } | |
317 | ||
318 | static int edid_open(struct inode *inode, struct file *file) | |
319 | { | |
320 | struct drm_connector *dev = inode->i_private; | |
321 | ||
322 | return single_open(file, edid_show, dev); | |
323 | } | |
324 | ||
325 | static ssize_t edid_write(struct file *file, const char __user *ubuf, | |
326 | size_t len, loff_t *offp) | |
327 | { | |
328 | struct seq_file *m = file->private_data; | |
329 | struct drm_connector *connector = m->private; | |
330 | char *buf; | |
331 | struct edid *edid; | |
332 | int ret; | |
333 | ||
334 | buf = memdup_user(ubuf, len); | |
335 | if (IS_ERR(buf)) | |
336 | return PTR_ERR(buf); | |
337 | ||
338 | edid = (struct edid *) buf; | |
339 | ||
340 | if (len == 5 && !strncmp(buf, "reset", 5)) { | |
341 | connector->override_edid = false; | |
342 | ret = drm_mode_connector_update_edid_property(connector, NULL); | |
343 | } else if (len < EDID_LENGTH || | |
344 | EDID_LENGTH * (1 + edid->extensions) > len) | |
345 | ret = -EINVAL; | |
346 | else { | |
347 | connector->override_edid = false; | |
348 | ret = drm_mode_connector_update_edid_property(connector, edid); | |
349 | if (!ret) | |
350 | connector->override_edid = true; | |
351 | } | |
352 | ||
353 | kfree(buf); | |
354 | ||
355 | return (ret) ? ret : len; | |
356 | } | |
357 | ||
358 | static const struct file_operations drm_edid_fops = { | |
359 | .owner = THIS_MODULE, | |
360 | .open = edid_open, | |
361 | .read = seq_read, | |
362 | .llseek = seq_lseek, | |
363 | .release = single_release, | |
364 | .write = edid_write | |
365 | }; | |
366 | ||
367 | ||
30f65707 TW |
368 | static const struct file_operations drm_connector_fops = { |
369 | .owner = THIS_MODULE, | |
370 | .open = connector_open, | |
371 | .read = seq_read, | |
372 | .llseek = seq_lseek, | |
373 | .release = single_release, | |
374 | .write = connector_write | |
375 | }; | |
376 | ||
377 | int drm_debugfs_connector_add(struct drm_connector *connector) | |
378 | { | |
379 | struct drm_minor *minor = connector->dev->primary; | |
380 | struct dentry *root, *ent; | |
381 | ||
382 | if (!minor->debugfs_root) | |
383 | return -1; | |
384 | ||
385 | root = debugfs_create_dir(connector->name, minor->debugfs_root); | |
386 | if (!root) | |
387 | return -ENOMEM; | |
388 | ||
389 | connector->debugfs_entry = root; | |
390 | ||
391 | /* force */ | |
392 | ent = debugfs_create_file("force", S_IRUGO | S_IWUSR, root, connector, | |
393 | &drm_connector_fops); | |
394 | if (!ent) | |
395 | goto error; | |
396 | ||
4cf2b281 TW |
397 | /* edid */ |
398 | ent = debugfs_create_file("edid_override", S_IRUGO | S_IWUSR, root, | |
399 | connector, &drm_edid_fops); | |
400 | if (!ent) | |
401 | goto error; | |
402 | ||
30f65707 TW |
403 | return 0; |
404 | ||
405 | error: | |
406 | debugfs_remove_recursive(connector->debugfs_entry); | |
407 | connector->debugfs_entry = NULL; | |
408 | return -ENOMEM; | |
409 | } | |
410 | ||
411 | void drm_debugfs_connector_remove(struct drm_connector *connector) | |
412 | { | |
413 | if (!connector->debugfs_entry) | |
414 | return; | |
415 | ||
416 | debugfs_remove_recursive(connector->debugfs_entry); | |
417 | ||
418 | connector->debugfs_entry = NULL; | |
419 | } | |
420 | ||
28a62277 BG |
421 | #endif /* CONFIG_DEBUG_FS */ |
422 |