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 "drmP.h" 38 39 #if defined(CONFIG_DEBUG_FS) 40 41 /*************************************************** 42 * Initialization, etc. 43 **************************************************/ 44 45 static struct drm_info_list drm_debugfs_list[] = { 46 {"name", drm_name_info, 0}, 47 {"vm", drm_vm_info, 0}, 48 {"clients", drm_clients_info, 0}, 49 {"queues", drm_queues_info, 0}, 50 {"bufs", drm_bufs_info, 0}, 51 {"gem_names", drm_gem_name_info, DRIVER_GEM}, 52 #if DRM_DEBUG_CODE 53 {"vma", drm_vma_info, 0}, 54 #endif 55 }; 56 #define DRM_DEBUGFS_ENTRIES ARRAY_SIZE(drm_debugfs_list) 57 58 59 static int drm_debugfs_open(struct inode *inode, struct file *file) 60 { 61 struct drm_info_node *node = inode->i_private; 62 63 return single_open(file, node->info_ent->show, node); 64 } 65 66 67 static const struct file_operations drm_debugfs_fops = { 68 .owner = THIS_MODULE, 69 .open = drm_debugfs_open, 70 .read = seq_read, 71 .llseek = seq_lseek, 72 .release = single_release, 73 }; 74 75 76 /** 77 * Initialize a given set of debugfs files for a device 78 * 79 * \param files The array of files to create 80 * \param count The number of files given 81 * \param root DRI debugfs dir entry. 82 * \param minor device minor number 83 * \return Zero on success, non-zero on failure 84 * 85 * Create a given set of debugfs files represented by an array of 86 * gdm_debugfs_lists in the given root directory. 87 */ 88 int drm_debugfs_create_files(struct drm_info_list *files, int count, 89 struct dentry *root, struct drm_minor *minor) 90 { 91 struct drm_device *dev = minor->dev; 92 struct dentry *ent; 93 struct drm_info_node *tmp; 94 int i, ret; 95 96 for (i = 0; i < count; i++) { 97 u32 features = files[i].driver_features; 98 99 if (features != 0 && 100 (dev->driver->driver_features & features) != features) 101 continue; 102 103 tmp = kmalloc(sizeof(struct drm_info_node), GFP_KERNEL); 104 if (tmp == NULL) { 105 ret = -1; 106 goto fail; 107 } 108 ent = debugfs_create_file(files[i].name, S_IFREG | S_IRUGO, 109 root, tmp, &drm_debugfs_fops); 110 if (!ent) { 111 DRM_ERROR("Cannot create /sys/kernel/debug/dri/%s/%s\n", 112 root->d_name.name, files[i].name); 113 kfree(tmp); 114 ret = -1; 115 goto fail; 116 } 117 118 tmp->minor = minor; 119 tmp->dent = ent; 120 tmp->info_ent = &files[i]; 121 122 mutex_lock(&minor->debugfs_lock); 123 list_add(&tmp->list, &minor->debugfs_list); 124 mutex_unlock(&minor->debugfs_lock); 125 } 126 return 0; 127 128 fail: 129 drm_debugfs_remove_files(files, count, minor); 130 return ret; 131 } 132 EXPORT_SYMBOL(drm_debugfs_create_files); 133 134 /** 135 * Initialize the DRI debugfs filesystem for a device 136 * 137 * \param dev DRM device 138 * \param minor device minor number 139 * \param root DRI debugfs dir entry. 140 * 141 * Create the DRI debugfs root entry "/sys/kernel/debug/dri", the device debugfs root entry 142 * "/sys/kernel/debug/dri/%minor%/", and each entry in debugfs_list as 143 * "/sys/kernel/debug/dri/%minor%/%name%". 144 */ 145 int drm_debugfs_init(struct drm_minor *minor, int minor_id, 146 struct dentry *root) 147 { 148 struct drm_device *dev = minor->dev; 149 char name[64]; 150 int ret; 151 152 INIT_LIST_HEAD(&minor->debugfs_list); 153 mutex_init(&minor->debugfs_lock); 154 sprintf(name, "%d", minor_id); 155 minor->debugfs_root = debugfs_create_dir(name, root); 156 if (!minor->debugfs_root) { 157 DRM_ERROR("Cannot create /sys/kernel/debug/dri/%s\n", name); 158 return -1; 159 } 160 161 ret = drm_debugfs_create_files(drm_debugfs_list, DRM_DEBUGFS_ENTRIES, 162 minor->debugfs_root, minor); 163 if (ret) { 164 debugfs_remove(minor->debugfs_root); 165 minor->debugfs_root = NULL; 166 DRM_ERROR("Failed to create core drm debugfs files\n"); 167 return ret; 168 } 169 170 if (dev->driver->debugfs_init) { 171 ret = dev->driver->debugfs_init(minor); 172 if (ret) { 173 DRM_ERROR("DRM: Driver failed to initialize " 174 "/sys/kernel/debug/dri.\n"); 175 return ret; 176 } 177 } 178 return 0; 179 } 180 181 182 /** 183 * Remove a list of debugfs files 184 * 185 * \param files The list of files 186 * \param count The number of files 187 * \param minor The minor of which we should remove the files 188 * \return always zero. 189 * 190 * Remove all debugfs entries created by debugfs_init(). 191 */ 192 int drm_debugfs_remove_files(struct drm_info_list *files, int count, 193 struct drm_minor *minor) 194 { 195 struct list_head *pos, *q; 196 struct drm_info_node *tmp; 197 int i; 198 199 mutex_lock(&minor->debugfs_lock); 200 for (i = 0; i < count; i++) { 201 list_for_each_safe(pos, q, &minor->debugfs_list) { 202 tmp = list_entry(pos, struct drm_info_node, list); 203 if (tmp->info_ent == &files[i]) { 204 debugfs_remove(tmp->dent); 205 list_del(pos); 206 kfree(tmp); 207 } 208 } 209 } 210 mutex_unlock(&minor->debugfs_lock); 211 return 0; 212 } 213 EXPORT_SYMBOL(drm_debugfs_remove_files); 214 215 /** 216 * Cleanup the debugfs filesystem resources. 217 * 218 * \param minor device minor number. 219 * \return always zero. 220 * 221 * Remove all debugfs entries created by debugfs_init(). 222 */ 223 int drm_debugfs_cleanup(struct drm_minor *minor) 224 { 225 struct drm_device *dev = minor->dev; 226 227 if (!minor->debugfs_root) 228 return 0; 229 230 if (dev->driver->debugfs_cleanup) 231 dev->driver->debugfs_cleanup(minor); 232 233 drm_debugfs_remove_files(drm_debugfs_list, DRM_DEBUGFS_ENTRIES, minor); 234 235 debugfs_remove(minor->debugfs_root); 236 minor->debugfs_root = NULL; 237 238 return 0; 239 } 240 241 #endif /* CONFIG_DEBUG_FS */ 242 243