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/export.h>
28#include <linux/seq_file.h>
29#include <linux/slab.h>
30#include <linux/uaccess.h>
31
32#include <drm/drm_atomic.h>
33#include <drm/drm_auth.h>
34#include <drm/drm_client.h>
35#include <drm/drm_debugfs.h>
36#include <drm/drm_device.h>
37#include <drm/drm_drv.h>
38#include <drm/drm_edid.h>
39#include <drm/drm_file.h>
40#include <drm/drm_gem.h>
41
42#include "drm_crtc_internal.h"
43#include "drm_internal.h"
44
45#if defined(CONFIG_DEBUG_FS)
46
47/***************************************************
48 * Initialization, etc.
49 **************************************************/
50
51static int drm_name_info(struct seq_file *m, void *data)
52{
53 struct drm_info_node *node = (struct drm_info_node *) m->private;
54 struct drm_minor *minor = node->minor;
55 struct drm_device *dev = minor->dev;
56 struct drm_master *master;
57
58 mutex_lock(&dev->master_mutex);
59 master = dev->master;
60 seq_printf(m, "%s", dev->driver->name);
61 if (dev->dev)
62 seq_printf(m, " dev=%s", dev_name(dev->dev));
63 if (master && master->unique)
64 seq_printf(m, " master=%s", master->unique);
65 if (dev->unique)
66 seq_printf(m, " unique=%s", dev->unique);
67 seq_printf(m, "\n");
68 mutex_unlock(&dev->master_mutex);
69
70 return 0;
71}
72
73static int drm_clients_info(struct seq_file *m, void *data)
74{
75 struct drm_info_node *node = (struct drm_info_node *) m->private;
76 struct drm_device *dev = node->minor->dev;
77 struct drm_file *priv;
78 kuid_t uid;
79
80 seq_printf(m,
81 "%20s %5s %3s master a %5s %10s\n",
82 "command",
83 "pid",
84 "dev",
85 "uid",
86 "magic");
87
88 /* dev->filelist is sorted youngest first, but we want to present
89 * oldest first (i.e. kernel, servers, clients), so walk backwardss.
90 */
91 mutex_lock(&dev->filelist_mutex);
92 list_for_each_entry_reverse(priv, &dev->filelist, lhead) {
93 struct task_struct *task;
94 bool is_current_master = drm_is_current_master(priv);
95
96 rcu_read_lock(); /* locks pid_task()->comm */
97 task = pid_task(priv->pid, PIDTYPE_PID);
98 uid = task ? __task_cred(task)->euid : GLOBAL_ROOT_UID;
99 seq_printf(m, "%20s %5d %3d %c %c %5d %10u\n",
100 task ? task->comm : "<unknown>",
101 pid_vnr(priv->pid),
102 priv->minor->index,
103 is_current_master ? 'y' : 'n',
104 priv->authenticated ? 'y' : 'n',
105 from_kuid_munged(seq_user_ns(m), uid),
106 priv->magic);
107 rcu_read_unlock();
108 }
109 mutex_unlock(&dev->filelist_mutex);
110 return 0;
111}
112
113static int drm_gem_one_name_info(int id, void *ptr, void *data)
114{
115 struct drm_gem_object *obj = ptr;
116 struct seq_file *m = data;
117
118 seq_printf(m, "%6d %8zd %7d %8d\n",
119 obj->name, obj->size,
120 obj->handle_count,
121 kref_read(&obj->refcount));
122 return 0;
123}
124
125static int drm_gem_name_info(struct seq_file *m, void *data)
126{
127 struct drm_info_node *node = (struct drm_info_node *) m->private;
128 struct drm_device *dev = node->minor->dev;
129
130 seq_printf(m, " name size handles refcount\n");
131
132 mutex_lock(&dev->object_name_lock);
133 idr_for_each(&dev->object_name_idr, drm_gem_one_name_info, m);
134 mutex_unlock(&dev->object_name_lock);
135
136 return 0;
137}
138
139static const struct drm_info_list drm_debugfs_list[] = {
140 {"name", drm_name_info, 0},
141 {"clients", drm_clients_info, 0},
142 {"gem_names", drm_gem_name_info, DRIVER_GEM},
143};
144#define DRM_DEBUGFS_ENTRIES ARRAY_SIZE(drm_debugfs_list)
145
146
147static int drm_debugfs_open(struct inode *inode, struct file *file)
148{
149 struct drm_info_node *node = inode->i_private;
150
151 return single_open(file, node->info_ent->show, node);
152}
153
154
155static const struct file_operations drm_debugfs_fops = {
156 .owner = THIS_MODULE,
157 .open = drm_debugfs_open,
158 .read = seq_read,
159 .llseek = seq_lseek,
160 .release = single_release,
161};
162
163
164/**
165 * drm_debugfs_create_files - Initialize a given set of debugfs files for DRM
166 * minor
167 * @files: The array of files to create
168 * @count: The number of files given
169 * @root: DRI debugfs dir entry.
170 * @minor: device minor number
171 *
172 * Create a given set of debugfs files represented by an array of
173 * &struct drm_info_list in the given root directory. These files will be removed
174 * automatically on drm_debugfs_cleanup().
175 */
176void drm_debugfs_create_files(const struct drm_info_list *files, int count,
177 struct dentry *root, struct drm_minor *minor)
178{
179 struct drm_device *dev = minor->dev;
180 struct drm_info_node *tmp;
181 int i;
182
183 for (i = 0; i < count; i++) {
184 u32 features = files[i].driver_features;
185
186 if (features && !drm_core_check_all_features(dev, features))
187 continue;
188
189 tmp = kmalloc(sizeof(struct drm_info_node), GFP_KERNEL);
190 if (tmp == NULL)
191 continue;
192
193 tmp->minor = minor;
194 tmp->dent = debugfs_create_file(files[i].name,
195 S_IFREG | S_IRUGO, root, tmp,
196 &drm_debugfs_fops);
197 tmp->info_ent = &files[i];
198
199 mutex_lock(&minor->debugfs_lock);
200 list_add(&tmp->list, &minor->debugfs_list);
201 mutex_unlock(&minor->debugfs_lock);
202 }
203}
204EXPORT_SYMBOL(drm_debugfs_create_files);
205
206int drm_debugfs_init(struct drm_minor *minor, int minor_id,
207 struct dentry *root)
208{
209 struct drm_device *dev = minor->dev;
210 char name[64];
211
212 INIT_LIST_HEAD(&minor->debugfs_list);
213 mutex_init(&minor->debugfs_lock);
214 sprintf(name, "%d", minor_id);
215 minor->debugfs_root = debugfs_create_dir(name, root);
216
217 drm_debugfs_create_files(drm_debugfs_list, DRM_DEBUGFS_ENTRIES,
218 minor->debugfs_root, minor);
219
220 if (drm_drv_uses_atomic_modeset(dev)) {
221 drm_atomic_debugfs_init(minor);
222 }
223
224 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
225 drm_framebuffer_debugfs_init(minor);
226
227 drm_client_debugfs_init(minor);
228 }
229
230 if (dev->driver->debugfs_init)
231 dev->driver->debugfs_init(minor);
232
233 return 0;
234}
235
236
237int drm_debugfs_remove_files(const struct drm_info_list *files, int count,
238 struct drm_minor *minor)
239{
240 struct list_head *pos, *q;
241 struct drm_info_node *tmp;
242 int i;
243
244 mutex_lock(&minor->debugfs_lock);
245 for (i = 0; i < count; i++) {
246 list_for_each_safe(pos, q, &minor->debugfs_list) {
247 tmp = list_entry(pos, struct drm_info_node, list);
248 if (tmp->info_ent == &files[i]) {
249 debugfs_remove(tmp->dent);
250 list_del(pos);
251 kfree(tmp);
252 }
253 }
254 }
255 mutex_unlock(&minor->debugfs_lock);
256 return 0;
257}
258EXPORT_SYMBOL(drm_debugfs_remove_files);
259
260static void drm_debugfs_remove_all_files(struct drm_minor *minor)
261{
262 struct drm_info_node *node, *tmp;
263
264 mutex_lock(&minor->debugfs_lock);
265 list_for_each_entry_safe(node, tmp, &minor->debugfs_list, list) {
266 debugfs_remove(node->dent);
267 list_del(&node->list);
268 kfree(node);
269 }
270 mutex_unlock(&minor->debugfs_lock);
271}
272
273void drm_debugfs_cleanup(struct drm_minor *minor)
274{
275 if (!minor->debugfs_root)
276 return;
277
278 drm_debugfs_remove_all_files(minor);
279
280 debugfs_remove_recursive(minor->debugfs_root);
281 minor->debugfs_root = NULL;
282}
283
284static int connector_show(struct seq_file *m, void *data)
285{
286 struct drm_connector *connector = m->private;
287
288 seq_printf(m, "%s\n", drm_get_connector_force_name(connector->force));
289
290 return 0;
291}
292
293static int connector_open(struct inode *inode, struct file *file)
294{
295 struct drm_connector *dev = inode->i_private;
296
297 return single_open(file, connector_show, dev);
298}
299
300static ssize_t connector_write(struct file *file, const char __user *ubuf,
301 size_t len, loff_t *offp)
302{
303 struct seq_file *m = file->private_data;
304 struct drm_connector *connector = m->private;
305 char buf[12];
306
307 if (len > sizeof(buf) - 1)
308 return -EINVAL;
309
310 if (copy_from_user(buf, ubuf, len))
311 return -EFAULT;
312
313 buf[len] = '\0';
314
315 if (sysfs_streq(buf, "on"))
316 connector->force = DRM_FORCE_ON;
317 else if (sysfs_streq(buf, "digital"))
318 connector->force = DRM_FORCE_ON_DIGITAL;
319 else if (sysfs_streq(buf, "off"))
320 connector->force = DRM_FORCE_OFF;
321 else if (sysfs_streq(buf, "unspecified"))
322 connector->force = DRM_FORCE_UNSPECIFIED;
323 else
324 return -EINVAL;
325
326 return len;
327}
328
329static int edid_show(struct seq_file *m, void *data)
330{
331 return drm_edid_override_show(m->private, m);
332}
333
334static 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
341static 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 int ret;
348
349 buf = memdup_user(ubuf, len);
350 if (IS_ERR(buf))
351 return PTR_ERR(buf);
352
353 if (len == 5 && !strncmp(buf, "reset", 5))
354 ret = drm_edid_override_reset(connector);
355 else
356 ret = drm_edid_override_set(connector, buf, len);
357
358 kfree(buf);
359
360 return ret ? ret : len;
361}
362
363/*
364 * Returns the min and max vrr vfreq through the connector's debugfs file.
365 * Example usage: cat /sys/kernel/debug/dri/0/DP-1/vrr_range
366 */
367static int vrr_range_show(struct seq_file *m, void *data)
368{
369 struct drm_connector *connector = m->private;
370
371 if (connector->status != connector_status_connected)
372 return -ENODEV;
373
374 seq_printf(m, "Min: %u\n", connector->display_info.monitor_range.min_vfreq);
375 seq_printf(m, "Max: %u\n", connector->display_info.monitor_range.max_vfreq);
376
377 return 0;
378}
379DEFINE_SHOW_ATTRIBUTE(vrr_range);
380
381/*
382 * Returns Connector's max supported bpc through debugfs file.
383 * Example usage: cat /sys/kernel/debug/dri/0/DP-1/output_bpc
384 */
385static int output_bpc_show(struct seq_file *m, void *data)
386{
387 struct drm_connector *connector = m->private;
388
389 if (connector->status != connector_status_connected)
390 return -ENODEV;
391
392 seq_printf(m, "Maximum: %u\n", connector->display_info.bpc);
393
394 return 0;
395}
396DEFINE_SHOW_ATTRIBUTE(output_bpc);
397
398static const struct file_operations drm_edid_fops = {
399 .owner = THIS_MODULE,
400 .open = edid_open,
401 .read = seq_read,
402 .llseek = seq_lseek,
403 .release = single_release,
404 .write = edid_write
405};
406
407
408static const struct file_operations drm_connector_fops = {
409 .owner = THIS_MODULE,
410 .open = connector_open,
411 .read = seq_read,
412 .llseek = seq_lseek,
413 .release = single_release,
414 .write = connector_write
415};
416
417void drm_debugfs_connector_add(struct drm_connector *connector)
418{
419 struct drm_minor *minor = connector->dev->primary;
420 struct dentry *root;
421
422 if (!minor->debugfs_root)
423 return;
424
425 root = debugfs_create_dir(connector->name, minor->debugfs_root);
426 connector->debugfs_entry = root;
427
428 /* force */
429 debugfs_create_file("force", S_IRUGO | S_IWUSR, root, connector,
430 &drm_connector_fops);
431
432 /* edid */
433 debugfs_create_file("edid_override", S_IRUGO | S_IWUSR, root, connector,
434 &drm_edid_fops);
435
436 /* vrr range */
437 debugfs_create_file("vrr_range", S_IRUGO, root, connector,
438 &vrr_range_fops);
439
440 /* max bpc */
441 debugfs_create_file("output_bpc", 0444, root, connector,
442 &output_bpc_fops);
443
444 if (connector->funcs->debugfs_init)
445 connector->funcs->debugfs_init(connector, root);
446}
447
448void drm_debugfs_connector_remove(struct drm_connector *connector)
449{
450 if (!connector->debugfs_entry)
451 return;
452
453 debugfs_remove_recursive(connector->debugfs_entry);
454
455 connector->debugfs_entry = NULL;
456}
457
458void drm_debugfs_crtc_add(struct drm_crtc *crtc)
459{
460 struct drm_minor *minor = crtc->dev->primary;
461 struct dentry *root;
462 char *name;
463
464 name = kasprintf(GFP_KERNEL, "crtc-%d", crtc->index);
465 if (!name)
466 return;
467
468 root = debugfs_create_dir(name, minor->debugfs_root);
469 kfree(name);
470
471 crtc->debugfs_entry = root;
472
473 drm_debugfs_crtc_crc_add(crtc);
474}
475
476void drm_debugfs_crtc_remove(struct drm_crtc *crtc)
477{
478 debugfs_remove_recursive(crtc->debugfs_entry);
479 crtc->debugfs_entry = NULL;
480}
481
482#endif /* CONFIG_DEBUG_FS */