Ben Gamari | 28a6227 | 2009-02-17 20:08:49 -0500 | [diff] [blame] | 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> |
Tejun Heo | 5a0e3ad | 2010-03-24 17:04:11 +0900 | [diff] [blame] | 35 | #include <linux/slab.h> |
Ben Gamari | 28a6227 | 2009-02-17 20:08:49 -0500 | [diff] [blame] | 36 | #include "drmP.h" |
| 37 | |
| 38 | #if defined(CONFIG_DEBUG_FS) |
| 39 | |
| 40 | /*************************************************** |
| 41 | * Initialization, etc. |
| 42 | **************************************************/ |
| 43 | |
| 44 | static 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}, |
Ben Gamari | 28a6227 | 2009-02-17 20:08:49 -0500 | [diff] [blame] | 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 | |
| 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 | */ |
| 87 | int 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; |
Ben Gamari | 28a6227 | 2009-02-17 20:08:49 -0500 | [diff] [blame] | 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 | |
Eric Anholt | 9a298b2 | 2009-03-24 12:23:04 -0700 | [diff] [blame] | 102 | tmp = kmalloc(sizeof(struct drm_info_node), GFP_KERNEL); |
Jiri Slaby | d25e3a6 | 2009-07-13 23:20:20 +0200 | [diff] [blame] | 103 | if (tmp == NULL) { |
| 104 | ret = -1; |
| 105 | goto fail; |
| 106 | } |
Ben Gamari | 28a6227 | 2009-02-17 20:08:49 -0500 | [diff] [blame] | 107 | ent = debugfs_create_file(files[i].name, S_IFREG | S_IRUGO, |
| 108 | root, tmp, &drm_debugfs_fops); |
| 109 | if (!ent) { |
Emil Velikov | 4d5cb60 | 2011-07-30 14:26:01 +0000 | [diff] [blame] | 110 | char name[64]; |
| 111 | strncpy(name, root->d_name.name, |
| 112 | min(root->d_name.len, 64U)); |
GeunSik Lim | 156f5a7 | 2009-06-02 15:01:37 +0900 | [diff] [blame] | 113 | DRM_ERROR("Cannot create /sys/kernel/debug/dri/%s/%s\n", |
Ben Gamari | 28a6227 | 2009-02-17 20:08:49 -0500 | [diff] [blame] | 114 | name, files[i].name); |
Eric Anholt | 9a298b2 | 2009-03-24 12:23:04 -0700 | [diff] [blame] | 115 | kfree(tmp); |
Ben Gamari | 28a6227 | 2009-02-17 20:08:49 -0500 | [diff] [blame] | 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 | |
| 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 | * |
GeunSik Lim | 156f5a7 | 2009-06-02 15:01:37 +0900 | [diff] [blame] | 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%". |
Ben Gamari | 28a6227 | 2009-02-17 20:08:49 -0500 | [diff] [blame] | 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 | |
| 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) { |
GeunSik Lim | 156f5a7 | 2009-06-02 15:01:37 +0900 | [diff] [blame] | 155 | DRM_ERROR("Cannot create /sys/kernel/debug/dri/%s\n", name); |
Ben Gamari | 28a6227 | 2009-02-17 20:08:49 -0500 | [diff] [blame] | 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 " |
GeunSik Lim | 156f5a7 | 2009-06-02 15:01:37 +0900 | [diff] [blame] | 172 | "/sys/kernel/debug/dri.\n"); |
Ben Gamari | 28a6227 | 2009-02-17 20:08:49 -0500 | [diff] [blame] | 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 | */ |
| 190 | int 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); |
Eric Anholt | 9a298b2 | 2009-03-24 12:23:04 -0700 | [diff] [blame] | 203 | kfree(tmp); |
Ben Gamari | 28a6227 | 2009-02-17 20:08:49 -0500 | [diff] [blame] | 204 | } |
| 205 | } |
| 206 | } |
| 207 | return 0; |
| 208 | } |
| 209 | EXPORT_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 | */ |
| 219 | int 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 | |