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_client.h> 36#include <drm/drm_debugfs.h> 37#include <drm/drm_device.h> 38#include <drm/drm_drv.h> 39#include <drm/drm_edid.h> 40#include <drm/drm_file.h> 41#include <drm/drm_gem.h> 42#include <drm/drm_managed.h> 43#include <drm/drm_gpuva_mgr.h> 44 45#include "drm_crtc_internal.h" 46#include "drm_internal.h" 47 48#if defined(CONFIG_DEBUG_FS) 49 50/*************************************************** 51 * Initialization, etc. 52 **************************************************/ 53 54static int drm_name_info(struct seq_file *m, void *data) 55{ 56 struct drm_debugfs_entry *entry = m->private; 57 struct drm_device *dev = entry->dev; 58 struct drm_master *master; 59 60 mutex_lock(&dev->master_mutex); 61 master = dev->master; 62 seq_printf(m, "%s", dev->driver->name); 63 if (dev->dev) 64 seq_printf(m, " dev=%s", dev_name(dev->dev)); 65 if (master && master->unique) 66 seq_printf(m, " master=%s", master->unique); 67 if (dev->unique) 68 seq_printf(m, " unique=%s", dev->unique); 69 seq_printf(m, "\n"); 70 mutex_unlock(&dev->master_mutex); 71 72 return 0; 73} 74 75static int drm_clients_info(struct seq_file *m, void *data) 76{ 77 struct drm_debugfs_entry *entry = m->private; 78 struct drm_device *dev = entry->dev; 79 struct drm_file *priv; 80 kuid_t uid; 81 82 seq_printf(m, 83 "%20s %5s %3s master a %5s %10s\n", 84 "command", 85 "tgid", 86 "dev", 87 "uid", 88 "magic"); 89 90 /* dev->filelist is sorted youngest first, but we want to present 91 * oldest first (i.e. kernel, servers, clients), so walk backwardss. 92 */ 93 mutex_lock(&dev->filelist_mutex); 94 list_for_each_entry_reverse(priv, &dev->filelist, lhead) { 95 bool is_current_master = drm_is_current_master(priv); 96 struct task_struct *task; 97 struct pid *pid; 98 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\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 rcu_read_unlock(); 112 } 113 mutex_unlock(&dev->filelist_mutex); 114 return 0; 115} 116 117static int drm_gem_one_name_info(int id, void *ptr, void *data) 118{ 119 struct drm_gem_object *obj = ptr; 120 struct seq_file *m = data; 121 122 seq_printf(m, "%6d %8zd %7d %8d\n", 123 obj->name, obj->size, 124 obj->handle_count, 125 kref_read(&obj->refcount)); 126 return 0; 127} 128 129static int drm_gem_name_info(struct seq_file *m, void *data) 130{ 131 struct drm_debugfs_entry *entry = m->private; 132 struct drm_device *dev = entry->dev; 133 134 seq_printf(m, " name size handles refcount\n"); 135 136 mutex_lock(&dev->object_name_lock); 137 idr_for_each(&dev->object_name_idr, drm_gem_one_name_info, m); 138 mutex_unlock(&dev->object_name_lock); 139 140 return 0; 141} 142 143static const struct drm_debugfs_info drm_debugfs_list[] = { 144 {"name", drm_name_info, 0}, 145 {"clients", drm_clients_info, 0}, 146 {"gem_names", drm_gem_name_info, DRIVER_GEM}, 147}; 148#define DRM_DEBUGFS_ENTRIES ARRAY_SIZE(drm_debugfs_list) 149 150 151static int drm_debugfs_open(struct inode *inode, struct file *file) 152{ 153 struct drm_info_node *node = inode->i_private; 154 155 return single_open(file, node->info_ent->show, node); 156} 157 158static int drm_debugfs_entry_open(struct inode *inode, struct file *file) 159{ 160 struct drm_debugfs_entry *entry = inode->i_private; 161 struct drm_debugfs_info *node = &entry->file; 162 163 return single_open(file, node->show, entry); 164} 165 166static const struct file_operations drm_debugfs_entry_fops = { 167 .owner = THIS_MODULE, 168 .open = drm_debugfs_entry_open, 169 .read = seq_read, 170 .llseek = seq_lseek, 171 .release = single_release, 172}; 173 174static const struct file_operations drm_debugfs_fops = { 175 .owner = THIS_MODULE, 176 .open = drm_debugfs_open, 177 .read = seq_read, 178 .llseek = seq_lseek, 179 .release = single_release, 180}; 181 182/** 183 * drm_debugfs_gpuva_info - dump the given DRM GPU VA space 184 * @m: pointer to the &seq_file to write 185 * @mgr: the &drm_gpuva_manager representing the GPU VA space 186 * 187 * Dumps the GPU VA mappings of a given DRM GPU VA manager. 188 * 189 * For each DRM GPU VA space drivers should call this function from their 190 * &drm_info_list's show callback. 191 * 192 * Returns: 0 on success, -ENODEV if the &mgr is not initialized 193 */ 194int drm_debugfs_gpuva_info(struct seq_file *m, 195 struct drm_gpuva_manager *mgr) 196{ 197 struct drm_gpuva *va, *kva = &mgr->kernel_alloc_node; 198 199 if (!mgr->name) 200 return -ENODEV; 201 202 seq_printf(m, "DRM GPU VA space (%s) [0x%016llx;0x%016llx]\n", 203 mgr->name, mgr->mm_start, mgr->mm_start + mgr->mm_range); 204 seq_printf(m, "Kernel reserved node [0x%016llx;0x%016llx]\n", 205 kva->va.addr, kva->va.addr + kva->va.range); 206 seq_puts(m, "\n"); 207 seq_puts(m, " VAs | start | range | end | object | object offset\n"); 208 seq_puts(m, "-------------------------------------------------------------------------------------------------------------\n"); 209 drm_gpuva_for_each_va(va, mgr) { 210 if (unlikely(va == kva)) 211 continue; 212 213 seq_printf(m, " | 0x%016llx | 0x%016llx | 0x%016llx | 0x%016llx | 0x%016llx\n", 214 va->va.addr, va->va.range, va->va.addr + va->va.range, 215 (u64)(uintptr_t)va->gem.obj, va->gem.offset); 216 } 217 218 return 0; 219} 220EXPORT_SYMBOL(drm_debugfs_gpuva_info); 221 222/** 223 * drm_debugfs_create_files - Initialize a given set of debugfs files for DRM 224 * minor 225 * @files: The array of files to create 226 * @count: The number of files given 227 * @root: DRI debugfs dir entry. 228 * @minor: device minor number 229 * 230 * Create a given set of debugfs files represented by an array of 231 * &struct drm_info_list in the given root directory. These files will be removed 232 * automatically on drm_debugfs_cleanup(). 233 */ 234void drm_debugfs_create_files(const struct drm_info_list *files, int count, 235 struct dentry *root, struct drm_minor *minor) 236{ 237 struct drm_device *dev = minor->dev; 238 struct drm_info_node *tmp; 239 int i; 240 241 for (i = 0; i < count; i++) { 242 u32 features = files[i].driver_features; 243 244 if (features && !drm_core_check_all_features(dev, features)) 245 continue; 246 247 tmp = kmalloc(sizeof(struct drm_info_node), GFP_KERNEL); 248 if (tmp == NULL) 249 continue; 250 251 tmp->minor = minor; 252 tmp->dent = debugfs_create_file(files[i].name, 253 0444, root, tmp, 254 &drm_debugfs_fops); 255 tmp->info_ent = &files[i]; 256 257 mutex_lock(&minor->debugfs_lock); 258 list_add(&tmp->list, &minor->debugfs_list); 259 mutex_unlock(&minor->debugfs_lock); 260 } 261} 262EXPORT_SYMBOL(drm_debugfs_create_files); 263 264int drm_debugfs_init(struct drm_minor *minor, int minor_id, 265 struct dentry *root) 266{ 267 struct drm_device *dev = minor->dev; 268 struct drm_debugfs_entry *entry, *tmp; 269 char name[64]; 270 271 INIT_LIST_HEAD(&minor->debugfs_list); 272 mutex_init(&minor->debugfs_lock); 273 sprintf(name, "%d", minor_id); 274 minor->debugfs_root = debugfs_create_dir(name, root); 275 276 drm_debugfs_add_files(minor->dev, drm_debugfs_list, DRM_DEBUGFS_ENTRIES); 277 278 if (drm_drv_uses_atomic_modeset(dev)) { 279 drm_atomic_debugfs_init(minor); 280 drm_bridge_debugfs_init(minor); 281 } 282 283 if (drm_core_check_feature(dev, DRIVER_MODESET)) { 284 drm_framebuffer_debugfs_init(minor); 285 286 drm_client_debugfs_init(minor); 287 } 288 289 if (dev->driver->debugfs_init) 290 dev->driver->debugfs_init(minor); 291 292 list_for_each_entry_safe(entry, tmp, &dev->debugfs_list, list) { 293 debugfs_create_file(entry->file.name, 0444, 294 minor->debugfs_root, entry, &drm_debugfs_entry_fops); 295 list_del(&entry->list); 296 } 297 298 return 0; 299} 300 301void drm_debugfs_late_register(struct drm_device *dev) 302{ 303 struct drm_minor *minor = dev->primary; 304 struct drm_debugfs_entry *entry, *tmp; 305 306 if (!minor) 307 return; 308 309 list_for_each_entry_safe(entry, tmp, &dev->debugfs_list, list) { 310 debugfs_create_file(entry->file.name, 0444, 311 minor->debugfs_root, entry, &drm_debugfs_entry_fops); 312 list_del(&entry->list); 313 } 314} 315 316int drm_debugfs_remove_files(const struct drm_info_list *files, int count, 317 struct drm_minor *minor) 318{ 319 struct list_head *pos, *q; 320 struct drm_info_node *tmp; 321 int i; 322 323 mutex_lock(&minor->debugfs_lock); 324 for (i = 0; i < count; i++) { 325 list_for_each_safe(pos, q, &minor->debugfs_list) { 326 tmp = list_entry(pos, struct drm_info_node, list); 327 if (tmp->info_ent == &files[i]) { 328 debugfs_remove(tmp->dent); 329 list_del(pos); 330 kfree(tmp); 331 } 332 } 333 } 334 mutex_unlock(&minor->debugfs_lock); 335 return 0; 336} 337EXPORT_SYMBOL(drm_debugfs_remove_files); 338 339static void drm_debugfs_remove_all_files(struct drm_minor *minor) 340{ 341 struct drm_info_node *node, *tmp; 342 343 mutex_lock(&minor->debugfs_lock); 344 list_for_each_entry_safe(node, tmp, &minor->debugfs_list, list) { 345 debugfs_remove(node->dent); 346 list_del(&node->list); 347 kfree(node); 348 } 349 mutex_unlock(&minor->debugfs_lock); 350} 351 352void drm_debugfs_cleanup(struct drm_minor *minor) 353{ 354 if (!minor->debugfs_root) 355 return; 356 357 drm_debugfs_remove_all_files(minor); 358 359 debugfs_remove_recursive(minor->debugfs_root); 360 minor->debugfs_root = NULL; 361} 362 363/** 364 * drm_debugfs_add_file - Add a given file to the DRM device debugfs file list 365 * @dev: drm device for the ioctl 366 * @name: debugfs file name 367 * @show: show callback 368 * @data: driver-private data, should not be device-specific 369 * 370 * Add a given file entry to the DRM device debugfs file list to be created on 371 * drm_debugfs_init. 372 */ 373void drm_debugfs_add_file(struct drm_device *dev, const char *name, 374 int (*show)(struct seq_file*, void*), void *data) 375{ 376 struct drm_debugfs_entry *entry = drmm_kzalloc(dev, sizeof(*entry), GFP_KERNEL); 377 378 if (!entry) 379 return; 380 381 entry->file.name = name; 382 entry->file.show = show; 383 entry->file.data = data; 384 entry->dev = dev; 385 386 mutex_lock(&dev->debugfs_mutex); 387 list_add(&entry->list, &dev->debugfs_list); 388 mutex_unlock(&dev->debugfs_mutex); 389} 390EXPORT_SYMBOL(drm_debugfs_add_file); 391 392/** 393 * drm_debugfs_add_files - Add an array of files to the DRM device debugfs file list 394 * @dev: drm device for the ioctl 395 * @files: The array of files to create 396 * @count: The number of files given 397 * 398 * Add a given set of debugfs files represented by an array of 399 * &struct drm_debugfs_info in the DRM device debugfs file list. 400 */ 401void drm_debugfs_add_files(struct drm_device *dev, const struct drm_debugfs_info *files, int count) 402{ 403 int i; 404 405 for (i = 0; i < count; i++) 406 drm_debugfs_add_file(dev, files[i].name, files[i].show, files[i].data); 407} 408EXPORT_SYMBOL(drm_debugfs_add_files); 409 410static int connector_show(struct seq_file *m, void *data) 411{ 412 struct drm_connector *connector = m->private; 413 414 seq_printf(m, "%s\n", drm_get_connector_force_name(connector->force)); 415 416 return 0; 417} 418 419static int connector_open(struct inode *inode, struct file *file) 420{ 421 struct drm_connector *dev = inode->i_private; 422 423 return single_open(file, connector_show, dev); 424} 425 426static ssize_t connector_write(struct file *file, const char __user *ubuf, 427 size_t len, loff_t *offp) 428{ 429 struct seq_file *m = file->private_data; 430 struct drm_connector *connector = m->private; 431 char buf[12]; 432 433 if (len > sizeof(buf) - 1) 434 return -EINVAL; 435 436 if (copy_from_user(buf, ubuf, len)) 437 return -EFAULT; 438 439 buf[len] = '\0'; 440 441 if (sysfs_streq(buf, "on")) 442 connector->force = DRM_FORCE_ON; 443 else if (sysfs_streq(buf, "digital")) 444 connector->force = DRM_FORCE_ON_DIGITAL; 445 else if (sysfs_streq(buf, "off")) 446 connector->force = DRM_FORCE_OFF; 447 else if (sysfs_streq(buf, "unspecified")) 448 connector->force = DRM_FORCE_UNSPECIFIED; 449 else 450 return -EINVAL; 451 452 return len; 453} 454 455static int edid_show(struct seq_file *m, void *data) 456{ 457 return drm_edid_override_show(m->private, m); 458} 459 460static int edid_open(struct inode *inode, struct file *file) 461{ 462 struct drm_connector *dev = inode->i_private; 463 464 return single_open(file, edid_show, dev); 465} 466 467static ssize_t edid_write(struct file *file, const char __user *ubuf, 468 size_t len, loff_t *offp) 469{ 470 struct seq_file *m = file->private_data; 471 struct drm_connector *connector = m->private; 472 char *buf; 473 int ret; 474 475 buf = memdup_user(ubuf, len); 476 if (IS_ERR(buf)) 477 return PTR_ERR(buf); 478 479 if (len == 5 && !strncmp(buf, "reset", 5)) 480 ret = drm_edid_override_reset(connector); 481 else 482 ret = drm_edid_override_set(connector, buf, len); 483 484 kfree(buf); 485 486 return ret ? ret : len; 487} 488 489/* 490 * Returns the min and max vrr vfreq through the connector's debugfs file. 491 * Example usage: cat /sys/kernel/debug/dri/0/DP-1/vrr_range 492 */ 493static int vrr_range_show(struct seq_file *m, void *data) 494{ 495 struct drm_connector *connector = m->private; 496 497 if (connector->status != connector_status_connected) 498 return -ENODEV; 499 500 seq_printf(m, "Min: %u\n", connector->display_info.monitor_range.min_vfreq); 501 seq_printf(m, "Max: %u\n", connector->display_info.monitor_range.max_vfreq); 502 503 return 0; 504} 505DEFINE_SHOW_ATTRIBUTE(vrr_range); 506 507/* 508 * Returns Connector's max supported bpc through debugfs file. 509 * Example usage: cat /sys/kernel/debug/dri/0/DP-1/output_bpc 510 */ 511static int output_bpc_show(struct seq_file *m, void *data) 512{ 513 struct drm_connector *connector = m->private; 514 515 if (connector->status != connector_status_connected) 516 return -ENODEV; 517 518 seq_printf(m, "Maximum: %u\n", connector->display_info.bpc); 519 520 return 0; 521} 522DEFINE_SHOW_ATTRIBUTE(output_bpc); 523 524static const struct file_operations drm_edid_fops = { 525 .owner = THIS_MODULE, 526 .open = edid_open, 527 .read = seq_read, 528 .llseek = seq_lseek, 529 .release = single_release, 530 .write = edid_write 531}; 532 533 534static const struct file_operations drm_connector_fops = { 535 .owner = THIS_MODULE, 536 .open = connector_open, 537 .read = seq_read, 538 .llseek = seq_lseek, 539 .release = single_release, 540 .write = connector_write 541}; 542 543void drm_debugfs_connector_add(struct drm_connector *connector) 544{ 545 struct drm_minor *minor = connector->dev->primary; 546 struct dentry *root; 547 548 if (!minor->debugfs_root) 549 return; 550 551 root = debugfs_create_dir(connector->name, minor->debugfs_root); 552 connector->debugfs_entry = root; 553 554 /* force */ 555 debugfs_create_file("force", 0644, root, connector, 556 &drm_connector_fops); 557 558 /* edid */ 559 debugfs_create_file("edid_override", 0644, root, connector, 560 &drm_edid_fops); 561 562 /* vrr range */ 563 debugfs_create_file("vrr_range", 0444, root, connector, 564 &vrr_range_fops); 565 566 /* max bpc */ 567 debugfs_create_file("output_bpc", 0444, root, connector, 568 &output_bpc_fops); 569 570 if (connector->funcs->debugfs_init) 571 connector->funcs->debugfs_init(connector, root); 572} 573 574void drm_debugfs_connector_remove(struct drm_connector *connector) 575{ 576 if (!connector->debugfs_entry) 577 return; 578 579 debugfs_remove_recursive(connector->debugfs_entry); 580 581 connector->debugfs_entry = NULL; 582} 583 584void drm_debugfs_crtc_add(struct drm_crtc *crtc) 585{ 586 struct drm_minor *minor = crtc->dev->primary; 587 struct dentry *root; 588 char *name; 589 590 name = kasprintf(GFP_KERNEL, "crtc-%d", crtc->index); 591 if (!name) 592 return; 593 594 root = debugfs_create_dir(name, minor->debugfs_root); 595 kfree(name); 596 597 crtc->debugfs_entry = root; 598 599 drm_debugfs_crtc_crc_add(crtc); 600} 601 602void drm_debugfs_crtc_remove(struct drm_crtc *crtc) 603{ 604 debugfs_remove_recursive(crtc->debugfs_entry); 605 crtc->debugfs_entry = NULL; 606} 607 608#endif /* CONFIG_DEBUG_FS */ 609