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