Loading...
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_bridge.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#include <drm/drm_managed.h>
42#include <drm/drm_gpuvm.h>
43
44#include "drm_crtc_internal.h"
45#include "drm_internal.h"
46
47/***************************************************
48 * Initialization, etc.
49 **************************************************/
50
51static int drm_name_info(struct seq_file *m, void *data)
52{
53 struct drm_debugfs_entry *entry = m->private;
54 struct drm_device *dev = entry->dev;
55 struct drm_master *master;
56
57 mutex_lock(&dev->master_mutex);
58 master = dev->master;
59 seq_printf(m, "%s", dev->driver->name);
60 if (dev->dev)
61 seq_printf(m, " dev=%s", dev_name(dev->dev));
62 if (master && master->unique)
63 seq_printf(m, " master=%s", master->unique);
64 if (dev->unique)
65 seq_printf(m, " unique=%s", dev->unique);
66 seq_printf(m, "\n");
67 mutex_unlock(&dev->master_mutex);
68
69 return 0;
70}
71
72static int drm_clients_info(struct seq_file *m, void *data)
73{
74 struct drm_debugfs_entry *entry = m->private;
75 struct drm_device *dev = entry->dev;
76 struct drm_file *priv;
77 kuid_t uid;
78
79 seq_printf(m,
80 "%20s %5s %3s master a %5s %10s %*s\n",
81 "command",
82 "tgid",
83 "dev",
84 "uid",
85 "magic",
86 DRM_CLIENT_NAME_MAX_LEN,
87 "name");
88
89 /* dev->filelist is sorted youngest first, but we want to present
90 * oldest first (i.e. kernel, servers, clients), so walk backwardss.
91 */
92 mutex_lock(&dev->filelist_mutex);
93 list_for_each_entry_reverse(priv, &dev->filelist, lhead) {
94 bool is_current_master = drm_is_current_master(priv);
95 struct task_struct *task;
96 struct pid *pid;
97
98 mutex_lock(&priv->client_name_lock);
99 rcu_read_lock(); /* Locks priv->pid and pid_task()->comm! */
100 pid = rcu_dereference(priv->pid);
101 task = pid_task(pid, PIDTYPE_TGID);
102 uid = task ? __task_cred(task)->euid : GLOBAL_ROOT_UID;
103 seq_printf(m, "%20s %5d %3d %c %c %5d %10u %*s\n",
104 task ? task->comm : "<unknown>",
105 pid_vnr(pid),
106 priv->minor->index,
107 is_current_master ? 'y' : 'n',
108 priv->authenticated ? 'y' : 'n',
109 from_kuid_munged(seq_user_ns(m), uid),
110 priv->magic,
111 DRM_CLIENT_NAME_MAX_LEN,
112 priv->client_name ? priv->client_name : "<unset>");
113 rcu_read_unlock();
114 mutex_unlock(&priv->client_name_lock);
115 }
116 mutex_unlock(&dev->filelist_mutex);
117 return 0;
118}
119
120static int drm_gem_one_name_info(int id, void *ptr, void *data)
121{
122 struct drm_gem_object *obj = ptr;
123 struct seq_file *m = data;
124
125 seq_printf(m, "%6d %8zd %7d %8d\n",
126 obj->name, obj->size,
127 obj->handle_count,
128 kref_read(&obj->refcount));
129 return 0;
130}
131
132static int drm_gem_name_info(struct seq_file *m, void *data)
133{
134 struct drm_debugfs_entry *entry = m->private;
135 struct drm_device *dev = entry->dev;
136
137 seq_printf(m, " name size handles refcount\n");
138
139 mutex_lock(&dev->object_name_lock);
140 idr_for_each(&dev->object_name_idr, drm_gem_one_name_info, m);
141 mutex_unlock(&dev->object_name_lock);
142
143 return 0;
144}
145
146static const struct drm_debugfs_info drm_debugfs_list[] = {
147 {"name", drm_name_info, 0},
148 {"clients", drm_clients_info, 0},
149 {"gem_names", drm_gem_name_info, DRIVER_GEM},
150};
151#define DRM_DEBUGFS_ENTRIES ARRAY_SIZE(drm_debugfs_list)
152
153
154static int drm_debugfs_open(struct inode *inode, struct file *file)
155{
156 struct drm_info_node *node = inode->i_private;
157
158 if (!device_is_registered(node->minor->kdev))
159 return -ENODEV;
160
161 return single_open(file, node->info_ent->show, node);
162}
163
164static int drm_debugfs_entry_open(struct inode *inode, struct file *file)
165{
166 struct drm_debugfs_entry *entry = inode->i_private;
167 struct drm_debugfs_info *node = &entry->file;
168 struct drm_minor *minor = entry->dev->primary ?: entry->dev->accel;
169
170 if (!device_is_registered(minor->kdev))
171 return -ENODEV;
172
173 return single_open(file, node->show, entry);
174}
175
176static const struct file_operations drm_debugfs_entry_fops = {
177 .owner = THIS_MODULE,
178 .open = drm_debugfs_entry_open,
179 .read = seq_read,
180 .llseek = seq_lseek,
181 .release = single_release,
182};
183
184static const struct file_operations drm_debugfs_fops = {
185 .owner = THIS_MODULE,
186 .open = drm_debugfs_open,
187 .read = seq_read,
188 .llseek = seq_lseek,
189 .release = single_release,
190};
191
192/**
193 * drm_debugfs_gpuva_info - dump the given DRM GPU VA space
194 * @m: pointer to the &seq_file to write
195 * @gpuvm: the &drm_gpuvm representing the GPU VA space
196 *
197 * Dumps the GPU VA mappings of a given DRM GPU VA manager.
198 *
199 * For each DRM GPU VA space drivers should call this function from their
200 * &drm_info_list's show callback.
201 *
202 * Returns: 0 on success, -ENODEV if the &gpuvm is not initialized
203 */
204int drm_debugfs_gpuva_info(struct seq_file *m,
205 struct drm_gpuvm *gpuvm)
206{
207 struct drm_gpuva *va, *kva = &gpuvm->kernel_alloc_node;
208
209 if (!gpuvm->name)
210 return -ENODEV;
211
212 seq_printf(m, "DRM GPU VA space (%s) [0x%016llx;0x%016llx]\n",
213 gpuvm->name, gpuvm->mm_start, gpuvm->mm_start + gpuvm->mm_range);
214 seq_printf(m, "Kernel reserved node [0x%016llx;0x%016llx]\n",
215 kva->va.addr, kva->va.addr + kva->va.range);
216 seq_puts(m, "\n");
217 seq_puts(m, " VAs | start | range | end | object | object offset\n");
218 seq_puts(m, "-------------------------------------------------------------------------------------------------------------\n");
219 drm_gpuvm_for_each_va(va, gpuvm) {
220 if (unlikely(va == kva))
221 continue;
222
223 seq_printf(m, " | 0x%016llx | 0x%016llx | 0x%016llx | 0x%016llx | 0x%016llx\n",
224 va->va.addr, va->va.range, va->va.addr + va->va.range,
225 (u64)(uintptr_t)va->gem.obj, va->gem.offset);
226 }
227
228 return 0;
229}
230EXPORT_SYMBOL(drm_debugfs_gpuva_info);
231
232/**
233 * drm_debugfs_create_files - Initialize a given set of debugfs files for DRM
234 * minor
235 * @files: The array of files to create
236 * @count: The number of files given
237 * @root: DRI debugfs dir entry.
238 * @minor: device minor number
239 *
240 * Create a given set of debugfs files represented by an array of
241 * &struct drm_info_list in the given root directory. These files will be removed
242 * automatically on drm_debugfs_dev_fini().
243 */
244void drm_debugfs_create_files(const struct drm_info_list *files, int count,
245 struct dentry *root, struct drm_minor *minor)
246{
247 struct drm_device *dev = minor->dev;
248 struct drm_info_node *tmp;
249 int i;
250
251 for (i = 0; i < count; i++) {
252 u32 features = files[i].driver_features;
253
254 if (features && !drm_core_check_all_features(dev, features))
255 continue;
256
257 tmp = drmm_kzalloc(dev, sizeof(*tmp), GFP_KERNEL);
258 if (tmp == NULL)
259 continue;
260
261 tmp->minor = minor;
262 tmp->dent = debugfs_create_file(files[i].name,
263 0444, root, tmp,
264 &drm_debugfs_fops);
265 tmp->info_ent = &files[i];
266 }
267}
268EXPORT_SYMBOL(drm_debugfs_create_files);
269
270int drm_debugfs_remove_files(const struct drm_info_list *files, int count,
271 struct dentry *root, struct drm_minor *minor)
272{
273 int i;
274
275 for (i = 0; i < count; i++) {
276 struct dentry *dent = debugfs_lookup(files[i].name, root);
277
278 if (!dent)
279 continue;
280
281 drmm_kfree(minor->dev, d_inode(dent)->i_private);
282 debugfs_remove(dent);
283 }
284 return 0;
285}
286EXPORT_SYMBOL(drm_debugfs_remove_files);
287
288/**
289 * drm_debugfs_dev_init - create debugfs directory for the device
290 * @dev: the device which we want to create the directory for
291 * @root: the parent directory depending on the device type
292 *
293 * Creates the debugfs directory for the device under the given root directory.
294 */
295void drm_debugfs_dev_init(struct drm_device *dev, struct dentry *root)
296{
297 dev->debugfs_root = debugfs_create_dir(dev->unique, root);
298}
299
300/**
301 * drm_debugfs_dev_fini - cleanup debugfs directory
302 * @dev: the device to cleanup the debugfs stuff
303 *
304 * Remove the debugfs directory, might be called multiple times.
305 */
306void drm_debugfs_dev_fini(struct drm_device *dev)
307{
308 debugfs_remove_recursive(dev->debugfs_root);
309 dev->debugfs_root = NULL;
310}
311
312void drm_debugfs_dev_register(struct drm_device *dev)
313{
314 drm_debugfs_add_files(dev, drm_debugfs_list, DRM_DEBUGFS_ENTRIES);
315
316 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
317 drm_framebuffer_debugfs_init(dev);
318 drm_client_debugfs_init(dev);
319 }
320 if (drm_drv_uses_atomic_modeset(dev))
321 drm_atomic_debugfs_init(dev);
322}
323
324int drm_debugfs_register(struct drm_minor *minor, int minor_id,
325 struct dentry *root)
326{
327 struct drm_device *dev = minor->dev;
328 char name[64];
329
330 sprintf(name, "%d", minor_id);
331 minor->debugfs_symlink = debugfs_create_symlink(name, root,
332 dev->unique);
333
334 /* TODO: Only for compatibility with drivers */
335 minor->debugfs_root = dev->debugfs_root;
336
337 if (dev->driver->debugfs_init && dev->render != minor)
338 dev->driver->debugfs_init(minor);
339
340 return 0;
341}
342
343void drm_debugfs_unregister(struct drm_minor *minor)
344{
345 debugfs_remove(minor->debugfs_symlink);
346 minor->debugfs_symlink = NULL;
347}
348
349/**
350 * drm_debugfs_add_file - Add a given file to the DRM device debugfs file list
351 * @dev: drm device for the ioctl
352 * @name: debugfs file name
353 * @show: show callback
354 * @data: driver-private data, should not be device-specific
355 *
356 * Add a given file entry to the DRM device debugfs file list to be created on
357 * drm_debugfs_init.
358 */
359void drm_debugfs_add_file(struct drm_device *dev, const char *name,
360 int (*show)(struct seq_file*, void*), void *data)
361{
362 struct drm_debugfs_entry *entry = drmm_kzalloc(dev, sizeof(*entry), GFP_KERNEL);
363
364 if (!entry)
365 return;
366
367 entry->file.name = name;
368 entry->file.show = show;
369 entry->file.data = data;
370 entry->dev = dev;
371
372 debugfs_create_file(name, 0444, dev->debugfs_root, entry,
373 &drm_debugfs_entry_fops);
374}
375EXPORT_SYMBOL(drm_debugfs_add_file);
376
377/**
378 * drm_debugfs_add_files - Add an array of files to the DRM device debugfs file list
379 * @dev: drm device for the ioctl
380 * @files: The array of files to create
381 * @count: The number of files given
382 *
383 * Add a given set of debugfs files represented by an array of
384 * &struct drm_debugfs_info in the DRM device debugfs file list.
385 */
386void drm_debugfs_add_files(struct drm_device *dev, const struct drm_debugfs_info *files, int count)
387{
388 int i;
389
390 for (i = 0; i < count; i++)
391 drm_debugfs_add_file(dev, files[i].name, files[i].show, files[i].data);
392}
393EXPORT_SYMBOL(drm_debugfs_add_files);
394
395static int connector_show(struct seq_file *m, void *data)
396{
397 struct drm_connector *connector = m->private;
398
399 seq_printf(m, "%s\n", drm_get_connector_force_name(connector->force));
400
401 return 0;
402}
403
404static int connector_open(struct inode *inode, struct file *file)
405{
406 struct drm_connector *dev = inode->i_private;
407
408 return single_open(file, connector_show, dev);
409}
410
411static ssize_t connector_write(struct file *file, const char __user *ubuf,
412 size_t len, loff_t *offp)
413{
414 struct seq_file *m = file->private_data;
415 struct drm_connector *connector = m->private;
416 char buf[12];
417
418 if (len > sizeof(buf) - 1)
419 return -EINVAL;
420
421 if (copy_from_user(buf, ubuf, len))
422 return -EFAULT;
423
424 buf[len] = '\0';
425
426 if (sysfs_streq(buf, "on"))
427 connector->force = DRM_FORCE_ON;
428 else if (sysfs_streq(buf, "digital"))
429 connector->force = DRM_FORCE_ON_DIGITAL;
430 else if (sysfs_streq(buf, "off"))
431 connector->force = DRM_FORCE_OFF;
432 else if (sysfs_streq(buf, "unspecified"))
433 connector->force = DRM_FORCE_UNSPECIFIED;
434 else
435 return -EINVAL;
436
437 return len;
438}
439
440static int edid_show(struct seq_file *m, void *data)
441{
442 return drm_edid_override_show(m->private, m);
443}
444
445static int edid_open(struct inode *inode, struct file *file)
446{
447 struct drm_connector *dev = inode->i_private;
448
449 return single_open(file, edid_show, dev);
450}
451
452static ssize_t edid_write(struct file *file, const char __user *ubuf,
453 size_t len, loff_t *offp)
454{
455 struct seq_file *m = file->private_data;
456 struct drm_connector *connector = m->private;
457 char *buf;
458 int ret;
459
460 buf = memdup_user(ubuf, len);
461 if (IS_ERR(buf))
462 return PTR_ERR(buf);
463
464 if (len == 5 && !strncmp(buf, "reset", 5))
465 ret = drm_edid_override_reset(connector);
466 else
467 ret = drm_edid_override_set(connector, buf, len);
468
469 kfree(buf);
470
471 return ret ? ret : len;
472}
473
474/*
475 * Returns the min and max vrr vfreq through the connector's debugfs file.
476 * Example usage: cat /sys/kernel/debug/dri/0/DP-1/vrr_range
477 */
478static int vrr_range_show(struct seq_file *m, void *data)
479{
480 struct drm_connector *connector = m->private;
481
482 if (connector->status != connector_status_connected)
483 return -ENODEV;
484
485 seq_printf(m, "Min: %u\n", connector->display_info.monitor_range.min_vfreq);
486 seq_printf(m, "Max: %u\n", connector->display_info.monitor_range.max_vfreq);
487
488 return 0;
489}
490DEFINE_SHOW_ATTRIBUTE(vrr_range);
491
492/*
493 * Returns Connector's max supported bpc through debugfs file.
494 * Example usage: cat /sys/kernel/debug/dri/0/DP-1/output_bpc
495 */
496static int output_bpc_show(struct seq_file *m, void *data)
497{
498 struct drm_connector *connector = m->private;
499
500 if (connector->status != connector_status_connected)
501 return -ENODEV;
502
503 seq_printf(m, "Maximum: %u\n", connector->display_info.bpc);
504
505 return 0;
506}
507DEFINE_SHOW_ATTRIBUTE(output_bpc);
508
509static const struct file_operations drm_edid_fops = {
510 .owner = THIS_MODULE,
511 .open = edid_open,
512 .read = seq_read,
513 .llseek = seq_lseek,
514 .release = single_release,
515 .write = edid_write
516};
517
518
519static const struct file_operations drm_connector_fops = {
520 .owner = THIS_MODULE,
521 .open = connector_open,
522 .read = seq_read,
523 .llseek = seq_lseek,
524 .release = single_release,
525 .write = connector_write
526};
527
528static ssize_t
529audio_infoframe_read(struct file *filp, char __user *ubuf, size_t count, loff_t *ppos)
530{
531 struct drm_connector_hdmi_infoframe *infoframe;
532 struct drm_connector *connector;
533 union hdmi_infoframe *frame;
534 u8 buf[HDMI_INFOFRAME_SIZE(AUDIO)];
535 ssize_t len = 0;
536
537 connector = filp->private_data;
538 mutex_lock(&connector->hdmi.infoframes.lock);
539
540 infoframe = &connector->hdmi.infoframes.audio;
541 if (!infoframe->set)
542 goto out;
543
544 frame = &infoframe->data;
545 len = hdmi_infoframe_pack(frame, buf, sizeof(buf));
546 if (len < 0)
547 goto out;
548
549 len = simple_read_from_buffer(ubuf, count, ppos, buf, len);
550
551out:
552 mutex_unlock(&connector->hdmi.infoframes.lock);
553 return len;
554}
555
556static const struct file_operations audio_infoframe_fops = {
557 .owner = THIS_MODULE,
558 .open = simple_open,
559 .read = audio_infoframe_read,
560};
561
562static int create_hdmi_audio_infoframe_file(struct drm_connector *connector,
563 struct dentry *parent)
564{
565 struct dentry *file;
566
567 file = debugfs_create_file("audio", 0400, parent, connector, &audio_infoframe_fops);
568 if (IS_ERR(file))
569 return PTR_ERR(file);
570
571 return 0;
572}
573
574#define DEFINE_INFOFRAME_FILE(_f) \
575static ssize_t _f##_read_infoframe(struct file *filp, \
576 char __user *ubuf, \
577 size_t count, \
578 loff_t *ppos) \
579{ \
580 struct drm_connector_hdmi_infoframe *infoframe; \
581 struct drm_connector_state *conn_state; \
582 struct drm_connector *connector; \
583 union hdmi_infoframe *frame; \
584 struct drm_device *dev; \
585 u8 buf[HDMI_INFOFRAME_SIZE(MAX)]; \
586 ssize_t len = 0; \
587 \
588 connector = filp->private_data; \
589 dev = connector->dev; \
590 \
591 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL); \
592 \
593 conn_state = connector->state; \
594 infoframe = &conn_state->hdmi.infoframes._f; \
595 if (!infoframe->set) \
596 goto out; \
597 \
598 frame = &infoframe->data; \
599 len = hdmi_infoframe_pack(frame, buf, sizeof(buf)); \
600 if (len < 0) \
601 goto out; \
602 \
603 len = simple_read_from_buffer(ubuf, count, ppos, buf, len); \
604 \
605out: \
606 drm_modeset_unlock(&dev->mode_config.connection_mutex); \
607 return len; \
608} \
609\
610static const struct file_operations _f##_infoframe_fops = { \
611 .owner = THIS_MODULE, \
612 .open = simple_open, \
613 .read = _f##_read_infoframe, \
614}; \
615\
616static int create_hdmi_## _f ## _infoframe_file(struct drm_connector *connector, \
617 struct dentry *parent) \
618{ \
619 struct dentry *file; \
620 \
621 file = debugfs_create_file(#_f, 0400, parent, connector, &_f ## _infoframe_fops); \
622 if (IS_ERR(file)) \
623 return PTR_ERR(file); \
624 \
625 return 0; \
626}
627
628DEFINE_INFOFRAME_FILE(avi);
629DEFINE_INFOFRAME_FILE(hdmi);
630DEFINE_INFOFRAME_FILE(hdr_drm);
631DEFINE_INFOFRAME_FILE(spd);
632
633static int create_hdmi_infoframe_files(struct drm_connector *connector,
634 struct dentry *parent)
635{
636 int ret;
637
638 ret = create_hdmi_audio_infoframe_file(connector, parent);
639 if (ret)
640 return ret;
641
642 ret = create_hdmi_avi_infoframe_file(connector, parent);
643 if (ret)
644 return ret;
645
646 ret = create_hdmi_hdmi_infoframe_file(connector, parent);
647 if (ret)
648 return ret;
649
650 ret = create_hdmi_hdr_drm_infoframe_file(connector, parent);
651 if (ret)
652 return ret;
653
654 ret = create_hdmi_spd_infoframe_file(connector, parent);
655 if (ret)
656 return ret;
657
658 return 0;
659}
660
661static void hdmi_debugfs_add(struct drm_connector *connector)
662{
663 struct dentry *dir;
664
665 if (!(connector->connector_type == DRM_MODE_CONNECTOR_HDMIA ||
666 connector->connector_type == DRM_MODE_CONNECTOR_HDMIB))
667 return;
668
669 dir = debugfs_create_dir("infoframes", connector->debugfs_entry);
670 if (IS_ERR(dir))
671 return;
672
673 create_hdmi_infoframe_files(connector, dir);
674}
675
676void drm_debugfs_connector_add(struct drm_connector *connector)
677{
678 struct drm_device *dev = connector->dev;
679 struct dentry *root;
680
681 if (!dev->debugfs_root)
682 return;
683
684 root = debugfs_create_dir(connector->name, dev->debugfs_root);
685 connector->debugfs_entry = root;
686
687 /* force */
688 debugfs_create_file("force", 0644, root, connector,
689 &drm_connector_fops);
690
691 /* edid */
692 debugfs_create_file("edid_override", 0644, root, connector,
693 &drm_edid_fops);
694
695 /* vrr range */
696 debugfs_create_file("vrr_range", 0444, root, connector,
697 &vrr_range_fops);
698
699 /* max bpc */
700 debugfs_create_file("output_bpc", 0444, root, connector,
701 &output_bpc_fops);
702
703 hdmi_debugfs_add(connector);
704
705 if (connector->funcs->debugfs_init)
706 connector->funcs->debugfs_init(connector, root);
707}
708
709void drm_debugfs_connector_remove(struct drm_connector *connector)
710{
711 if (!connector->debugfs_entry)
712 return;
713
714 debugfs_remove_recursive(connector->debugfs_entry);
715
716 connector->debugfs_entry = NULL;
717}
718
719void drm_debugfs_crtc_add(struct drm_crtc *crtc)
720{
721 struct drm_device *dev = crtc->dev;
722 struct dentry *root;
723 char *name;
724
725 name = kasprintf(GFP_KERNEL, "crtc-%d", crtc->index);
726 if (!name)
727 return;
728
729 root = debugfs_create_dir(name, dev->debugfs_root);
730 kfree(name);
731
732 crtc->debugfs_entry = root;
733
734 drm_debugfs_crtc_crc_add(crtc);
735}
736
737void drm_debugfs_crtc_remove(struct drm_crtc *crtc)
738{
739 debugfs_remove_recursive(crtc->debugfs_entry);
740 crtc->debugfs_entry = NULL;
741}
742
743static int bridges_show(struct seq_file *m, void *data)
744{
745 struct drm_encoder *encoder = m->private;
746 struct drm_printer p = drm_seq_file_printer(m);
747 struct drm_bridge *bridge;
748 unsigned int idx = 0;
749
750 drm_for_each_bridge_in_chain(encoder, bridge) {
751 drm_printf(&p, "bridge[%d]: %ps\n", idx++, bridge->funcs);
752 drm_printf(&p, "\ttype: [%d] %s\n",
753 bridge->type,
754 drm_get_connector_type_name(bridge->type));
755
756 if (bridge->of_node)
757 drm_printf(&p, "\tOF: %pOFfc\n", bridge->of_node);
758
759 drm_printf(&p, "\tops: [0x%x]", bridge->ops);
760 if (bridge->ops & DRM_BRIDGE_OP_DETECT)
761 drm_puts(&p, " detect");
762 if (bridge->ops & DRM_BRIDGE_OP_EDID)
763 drm_puts(&p, " edid");
764 if (bridge->ops & DRM_BRIDGE_OP_HPD)
765 drm_puts(&p, " hpd");
766 if (bridge->ops & DRM_BRIDGE_OP_MODES)
767 drm_puts(&p, " modes");
768 if (bridge->ops & DRM_BRIDGE_OP_HDMI)
769 drm_puts(&p, " hdmi");
770 drm_puts(&p, "\n");
771 }
772
773 return 0;
774}
775DEFINE_SHOW_ATTRIBUTE(bridges);
776
777void drm_debugfs_encoder_add(struct drm_encoder *encoder)
778{
779 struct drm_minor *minor = encoder->dev->primary;
780 struct dentry *root;
781 char *name;
782
783 name = kasprintf(GFP_KERNEL, "encoder-%d", encoder->index);
784 if (!name)
785 return;
786
787 root = debugfs_create_dir(name, minor->debugfs_root);
788 kfree(name);
789
790 encoder->debugfs_entry = root;
791
792 /* bridges list */
793 debugfs_create_file("bridges", 0444, root, encoder,
794 &bridges_fops);
795
796 if (encoder->funcs && encoder->funcs->debugfs_init)
797 encoder->funcs->debugfs_init(encoder, root);
798}
799
800void drm_debugfs_encoder_remove(struct drm_encoder *encoder)
801{
802 debugfs_remove_recursive(encoder->debugfs_entry);
803 encoder->debugfs_entry = NULL;
804}
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
42#if defined(CONFIG_DEBUG_FS)
43
44/***************************************************
45 * Initialization, etc.
46 **************************************************/
47
48static const struct drm_info_list drm_debugfs_list[] = {
49 {"name", drm_name_info, 0},
50 {"clients", drm_clients_info, 0},
51 {"gem_names", drm_gem_name_info, DRIVER_GEM},
52};
53#define DRM_DEBUGFS_ENTRIES ARRAY_SIZE(drm_debugfs_list)
54
55
56static int drm_debugfs_open(struct inode *inode, struct file *file)
57{
58 struct drm_info_node *node = inode->i_private;
59
60 return single_open(file, node->info_ent->show, node);
61}
62
63
64static const struct file_operations drm_debugfs_fops = {
65 .owner = THIS_MODULE,
66 .open = drm_debugfs_open,
67 .read = seq_read,
68 .llseek = seq_lseek,
69 .release = single_release,
70};
71
72
73/**
74 * Initialize a given set of debugfs files for a device
75 *
76 * \param files The array of files to create
77 * \param count The number of files given
78 * \param root DRI debugfs dir entry.
79 * \param minor device minor number
80 * \return Zero on success, non-zero on failure
81 *
82 * Create a given set of debugfs files represented by an array of
83 * gdm_debugfs_lists in the given root directory.
84 */
85int drm_debugfs_create_files(const struct drm_info_list *files, int count,
86 struct dentry *root, struct drm_minor *minor)
87{
88 struct drm_device *dev = minor->dev;
89 struct dentry *ent;
90 struct drm_info_node *tmp;
91 int i, ret;
92
93 for (i = 0; i < count; i++) {
94 u32 features = files[i].driver_features;
95
96 if (features != 0 &&
97 (dev->driver->driver_features & features) != features)
98 continue;
99
100 tmp = kmalloc(sizeof(struct drm_info_node), GFP_KERNEL);
101 if (tmp == NULL) {
102 ret = -1;
103 goto fail;
104 }
105 ent = debugfs_create_file(files[i].name, S_IFREG | S_IRUGO,
106 root, tmp, &drm_debugfs_fops);
107 if (!ent) {
108 DRM_ERROR("Cannot create /sys/kernel/debug/dri/%pd/%s\n",
109 root, files[i].name);
110 kfree(tmp);
111 ret = -1;
112 goto fail;
113 }
114
115 tmp->minor = minor;
116 tmp->dent = ent;
117 tmp->info_ent = &files[i];
118
119 mutex_lock(&minor->debugfs_lock);
120 list_add(&tmp->list, &minor->debugfs_list);
121 mutex_unlock(&minor->debugfs_lock);
122 }
123 return 0;
124
125fail:
126 drm_debugfs_remove_files(files, count, minor);
127 return ret;
128}
129EXPORT_SYMBOL(drm_debugfs_create_files);
130
131/**
132 * Initialize the DRI debugfs filesystem for a device
133 *
134 * \param dev DRM device
135 * \param minor device minor number
136 * \param root DRI debugfs dir entry.
137 *
138 * Create the DRI debugfs root entry "/sys/kernel/debug/dri", the device debugfs root entry
139 * "/sys/kernel/debug/dri/%minor%/", and each entry in debugfs_list as
140 * "/sys/kernel/debug/dri/%minor%/%name%".
141 */
142int drm_debugfs_init(struct drm_minor *minor, int minor_id,
143 struct dentry *root)
144{
145 struct drm_device *dev = minor->dev;
146 char name[64];
147 int ret;
148
149 INIT_LIST_HEAD(&minor->debugfs_list);
150 mutex_init(&minor->debugfs_lock);
151 sprintf(name, "%d", minor_id);
152 minor->debugfs_root = debugfs_create_dir(name, root);
153 if (!minor->debugfs_root) {
154 DRM_ERROR("Cannot create /sys/kernel/debug/dri/%s\n", name);
155 return -1;
156 }
157
158 ret = drm_debugfs_create_files(drm_debugfs_list, DRM_DEBUGFS_ENTRIES,
159 minor->debugfs_root, minor);
160 if (ret) {
161 debugfs_remove(minor->debugfs_root);
162 minor->debugfs_root = NULL;
163 DRM_ERROR("Failed to create core drm debugfs files\n");
164 return ret;
165 }
166
167 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
168 ret = drm_atomic_debugfs_init(minor);
169 if (ret) {
170 DRM_ERROR("Failed to create atomic debugfs files\n");
171 return ret;
172 }
173 }
174
175 if (dev->driver->debugfs_init) {
176 ret = dev->driver->debugfs_init(minor);
177 if (ret) {
178 DRM_ERROR("DRM: Driver failed to initialize "
179 "/sys/kernel/debug/dri.\n");
180 return ret;
181 }
182 }
183 return 0;
184}
185
186
187/**
188 * Remove a list of debugfs files
189 *
190 * \param files The list of files
191 * \param count The number of files
192 * \param minor The minor of which we should remove the files
193 * \return always zero.
194 *
195 * Remove all debugfs entries created by debugfs_init().
196 */
197int drm_debugfs_remove_files(const struct drm_info_list *files, int count,
198 struct drm_minor *minor)
199{
200 struct list_head *pos, *q;
201 struct drm_info_node *tmp;
202 int i;
203
204 mutex_lock(&minor->debugfs_lock);
205 for (i = 0; i < count; i++) {
206 list_for_each_safe(pos, q, &minor->debugfs_list) {
207 tmp = list_entry(pos, struct drm_info_node, list);
208 if (tmp->info_ent == &files[i]) {
209 debugfs_remove(tmp->dent);
210 list_del(pos);
211 kfree(tmp);
212 }
213 }
214 }
215 mutex_unlock(&minor->debugfs_lock);
216 return 0;
217}
218EXPORT_SYMBOL(drm_debugfs_remove_files);
219
220/**
221 * Cleanup the debugfs filesystem resources.
222 *
223 * \param minor device minor number.
224 * \return always zero.
225 *
226 * Remove all debugfs entries created by debugfs_init().
227 */
228int drm_debugfs_cleanup(struct drm_minor *minor)
229{
230 struct drm_device *dev = minor->dev;
231 int ret;
232
233 if (!minor->debugfs_root)
234 return 0;
235
236 if (dev->driver->debugfs_cleanup)
237 dev->driver->debugfs_cleanup(minor);
238
239 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
240 ret = drm_atomic_debugfs_cleanup(minor);
241 if (ret) {
242 DRM_ERROR("DRM: Failed to remove atomic debugfs entries\n");
243 return ret;
244 }
245 }
246
247 drm_debugfs_remove_files(drm_debugfs_list, DRM_DEBUGFS_ENTRIES, minor);
248
249 debugfs_remove(minor->debugfs_root);
250 minor->debugfs_root = NULL;
251
252 return 0;
253}
254
255static int connector_show(struct seq_file *m, void *data)
256{
257 struct drm_connector *connector = m->private;
258 const char *status;
259
260 switch (connector->force) {
261 case DRM_FORCE_ON:
262 status = "on\n";
263 break;
264
265 case DRM_FORCE_ON_DIGITAL:
266 status = "digital\n";
267 break;
268
269 case DRM_FORCE_OFF:
270 status = "off\n";
271 break;
272
273 case DRM_FORCE_UNSPECIFIED:
274 status = "unspecified\n";
275 break;
276
277 default:
278 return 0;
279 }
280
281 seq_puts(m, status);
282
283 return 0;
284}
285
286static int connector_open(struct inode *inode, struct file *file)
287{
288 struct drm_connector *dev = inode->i_private;
289
290 return single_open(file, connector_show, dev);
291}
292
293static ssize_t connector_write(struct file *file, const char __user *ubuf,
294 size_t len, loff_t *offp)
295{
296 struct seq_file *m = file->private_data;
297 struct drm_connector *connector = m->private;
298 char buf[12];
299
300 if (len > sizeof(buf) - 1)
301 return -EINVAL;
302
303 if (copy_from_user(buf, ubuf, len))
304 return -EFAULT;
305
306 buf[len] = '\0';
307
308 if (!strcmp(buf, "on"))
309 connector->force = DRM_FORCE_ON;
310 else if (!strcmp(buf, "digital"))
311 connector->force = DRM_FORCE_ON_DIGITAL;
312 else if (!strcmp(buf, "off"))
313 connector->force = DRM_FORCE_OFF;
314 else if (!strcmp(buf, "unspecified"))
315 connector->force = DRM_FORCE_UNSPECIFIED;
316 else
317 return -EINVAL;
318
319 return len;
320}
321
322static int edid_show(struct seq_file *m, void *data)
323{
324 struct drm_connector *connector = m->private;
325 struct drm_property_blob *edid = connector->edid_blob_ptr;
326
327 if (connector->override_edid && edid)
328 seq_write(m, edid->data, edid->length);
329
330 return 0;
331}
332
333static int edid_open(struct inode *inode, struct file *file)
334{
335 struct drm_connector *dev = inode->i_private;
336
337 return single_open(file, edid_show, dev);
338}
339
340static ssize_t edid_write(struct file *file, const char __user *ubuf,
341 size_t len, loff_t *offp)
342{
343 struct seq_file *m = file->private_data;
344 struct drm_connector *connector = m->private;
345 char *buf;
346 struct edid *edid;
347 int ret;
348
349 buf = memdup_user(ubuf, len);
350 if (IS_ERR(buf))
351 return PTR_ERR(buf);
352
353 edid = (struct edid *) buf;
354
355 if (len == 5 && !strncmp(buf, "reset", 5)) {
356 connector->override_edid = false;
357 ret = drm_mode_connector_update_edid_property(connector, NULL);
358 } else if (len < EDID_LENGTH ||
359 EDID_LENGTH * (1 + edid->extensions) > len)
360 ret = -EINVAL;
361 else {
362 connector->override_edid = false;
363 ret = drm_mode_connector_update_edid_property(connector, edid);
364 if (!ret)
365 connector->override_edid = true;
366 }
367
368 kfree(buf);
369
370 return (ret) ? ret : len;
371}
372
373static const struct file_operations drm_edid_fops = {
374 .owner = THIS_MODULE,
375 .open = edid_open,
376 .read = seq_read,
377 .llseek = seq_lseek,
378 .release = single_release,
379 .write = edid_write
380};
381
382
383static const struct file_operations drm_connector_fops = {
384 .owner = THIS_MODULE,
385 .open = connector_open,
386 .read = seq_read,
387 .llseek = seq_lseek,
388 .release = single_release,
389 .write = connector_write
390};
391
392int drm_debugfs_connector_add(struct drm_connector *connector)
393{
394 struct drm_minor *minor = connector->dev->primary;
395 struct dentry *root, *ent;
396
397 if (!minor->debugfs_root)
398 return -1;
399
400 root = debugfs_create_dir(connector->name, minor->debugfs_root);
401 if (!root)
402 return -ENOMEM;
403
404 connector->debugfs_entry = root;
405
406 /* force */
407 ent = debugfs_create_file("force", S_IRUGO | S_IWUSR, root, connector,
408 &drm_connector_fops);
409 if (!ent)
410 goto error;
411
412 /* edid */
413 ent = debugfs_create_file("edid_override", S_IRUGO | S_IWUSR, root,
414 connector, &drm_edid_fops);
415 if (!ent)
416 goto error;
417
418 return 0;
419
420error:
421 debugfs_remove_recursive(connector->debugfs_entry);
422 connector->debugfs_entry = NULL;
423 return -ENOMEM;
424}
425
426void drm_debugfs_connector_remove(struct drm_connector *connector)
427{
428 if (!connector->debugfs_entry)
429 return;
430
431 debugfs_remove_recursive(connector->debugfs_entry);
432
433 connector->debugfs_entry = NULL;
434}
435
436int drm_debugfs_crtc_add(struct drm_crtc *crtc)
437{
438 struct drm_minor *minor = crtc->dev->primary;
439 struct dentry *root;
440 char *name;
441
442 name = kasprintf(GFP_KERNEL, "crtc-%d", crtc->index);
443 if (!name)
444 return -ENOMEM;
445
446 root = debugfs_create_dir(name, minor->debugfs_root);
447 kfree(name);
448 if (!root)
449 return -ENOMEM;
450
451 crtc->debugfs_entry = root;
452
453 if (drm_debugfs_crtc_crc_add(crtc))
454 goto error;
455
456 return 0;
457
458error:
459 drm_debugfs_crtc_remove(crtc);
460 return -ENOMEM;
461}
462
463void drm_debugfs_crtc_remove(struct drm_crtc *crtc)
464{
465 debugfs_remove_recursive(crtc->debugfs_entry);
466 crtc->debugfs_entry = NULL;
467}
468
469#endif /* CONFIG_DEBUG_FS */