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 "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}, 51 {"gem_objects", drm_gem_object_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 char name[64]; 95 int i, ret; 96 97 for (i = 0; i < count; i++) { 98 u32 features = files[i].driver_features; 99 100 if (features != 0 && 101 (dev->driver->driver_features & features) != features) 102 continue; 103 104 tmp = kmalloc(sizeof(struct drm_info_node), GFP_KERNEL); 105 if (tmp == NULL) { 106 ret = -1; 107 goto fail; 108 } 109 ent = debugfs_create_file(files[i].name, S_IFREG | S_IRUGO, 110 root, tmp, &drm_debugfs_fops); 111 if (!ent) { 112 DRM_ERROR("Cannot create /sys/kernel/debug/dri/%s/%s\n", 113 name, files[i].name); 114 kfree(tmp); 115 ret = -1; 116 goto fail; 117 } 118 119 tmp->minor = minor; 120 tmp->dent = ent; 121 tmp->info_ent = &files[i]; 122 list_add(&(tmp->list), &(minor->debugfs_nodes.list)); 123 } 124 return 0; 125 126 fail: 127 drm_debugfs_remove_files(files, count, minor); 128 return ret; 129 } 130 EXPORT_SYMBOL(drm_debugfs_create_files); 131 132 /** 133 * Initialize the DRI debugfs filesystem for a device 134 * 135 * \param dev DRM device 136 * \param minor device minor number 137 * \param root DRI debugfs dir entry. 138 * 139 * Create the DRI debugfs root entry "/sys/kernel/debug/dri", the device debugfs root entry 140 * "/sys/kernel/debug/dri/%minor%/", and each entry in debugfs_list as 141 * "/sys/kernel/debug/dri/%minor%/%name%". 142 */ 143 int drm_debugfs_init(struct drm_minor *minor, int minor_id, 144 struct dentry *root) 145 { 146 struct drm_device *dev = minor->dev; 147 char name[64]; 148 int ret; 149 150 INIT_LIST_HEAD(&minor->debugfs_nodes.list); 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 (dev->driver->debugfs_init) { 168 ret = dev->driver->debugfs_init(minor); 169 if (ret) { 170 DRM_ERROR("DRM: Driver failed to initialize " 171 "/sys/kernel/debug/dri.\n"); 172 return ret; 173 } 174 } 175 return 0; 176 } 177 178 179 /** 180 * Remove a list of debugfs files 181 * 182 * \param files The list of files 183 * \param count The number of files 184 * \param minor The minor of which we should remove the files 185 * \return always zero. 186 * 187 * Remove all debugfs entries created by debugfs_init(). 188 */ 189 int drm_debugfs_remove_files(struct drm_info_list *files, int count, 190 struct drm_minor *minor) 191 { 192 struct list_head *pos, *q; 193 struct drm_info_node *tmp; 194 int i; 195 196 for (i = 0; i < count; i++) { 197 list_for_each_safe(pos, q, &minor->debugfs_nodes.list) { 198 tmp = list_entry(pos, struct drm_info_node, list); 199 if (tmp->info_ent == &files[i]) { 200 debugfs_remove(tmp->dent); 201 list_del(pos); 202 kfree(tmp); 203 } 204 } 205 } 206 return 0; 207 } 208 EXPORT_SYMBOL(drm_debugfs_remove_files); 209 210 /** 211 * Cleanup the debugfs filesystem resources. 212 * 213 * \param minor device minor number. 214 * \return always zero. 215 * 216 * Remove all debugfs entries created by debugfs_init(). 217 */ 218 int drm_debugfs_cleanup(struct drm_minor *minor) 219 { 220 struct drm_device *dev = minor->dev; 221 222 if (!minor->debugfs_root) 223 return 0; 224 225 if (dev->driver->debugfs_cleanup) 226 dev->driver->debugfs_cleanup(minor); 227 228 drm_debugfs_remove_files(drm_debugfs_list, DRM_DEBUGFS_ENTRIES, minor); 229 230 debugfs_remove(minor->debugfs_root); 231 minor->debugfs_root = NULL; 232 233 return 0; 234 } 235 236 #endif /* CONFIG_DEBUG_FS */ 237 238