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 "drmP.h" 36 37 #if defined(CONFIG_DEBUG_FS) 38 39 /*************************************************** 40 * Initialization, etc. 41 **************************************************/ 42 43 static struct drm_info_list drm_debugfs_list[] = { 44 {"name", drm_name_info, 0}, 45 {"vm", drm_vm_info, 0}, 46 {"clients", drm_clients_info, 0}, 47 {"queues", drm_queues_info, 0}, 48 {"bufs", drm_bufs_info, 0}, 49 {"gem_names", drm_gem_name_info, DRIVER_GEM}, 50 {"gem_objects", drm_gem_object_info, DRIVER_GEM}, 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; 93 char name[64]; 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 ent = debugfs_create_file(files[i].name, S_IFREG | S_IRUGO, 105 root, tmp, &drm_debugfs_fops); 106 if (!ent) { 107 DRM_ERROR("Cannot create /sys/kernel/debug/dri/%s/%s\n", 108 name, files[i].name); 109 kfree(tmp); 110 ret = -1; 111 goto fail; 112 } 113 114 tmp->minor = minor; 115 tmp->dent = ent; 116 tmp->info_ent = &files[i]; 117 list_add(&(tmp->list), &(minor->debugfs_nodes.list)); 118 } 119 return 0; 120 121 fail: 122 drm_debugfs_remove_files(files, count, minor); 123 return ret; 124 } 125 EXPORT_SYMBOL(drm_debugfs_create_files); 126 127 /** 128 * Initialize the DRI debugfs filesystem for a device 129 * 130 * \param dev DRM device 131 * \param minor device minor number 132 * \param root DRI debugfs dir entry. 133 * 134 * Create the DRI debugfs root entry "/sys/kernel/debug/dri", the device debugfs root entry 135 * "/sys/kernel/debug/dri/%minor%/", and each entry in debugfs_list as 136 * "/sys/kernel/debug/dri/%minor%/%name%". 137 */ 138 int drm_debugfs_init(struct drm_minor *minor, int minor_id, 139 struct dentry *root) 140 { 141 struct drm_device *dev = minor->dev; 142 char name[64]; 143 int ret; 144 145 INIT_LIST_HEAD(&minor->debugfs_nodes.list); 146 sprintf(name, "%d", minor_id); 147 minor->debugfs_root = debugfs_create_dir(name, root); 148 if (!minor->debugfs_root) { 149 DRM_ERROR("Cannot create /sys/kernel/debug/dri/%s\n", name); 150 return -1; 151 } 152 153 ret = drm_debugfs_create_files(drm_debugfs_list, DRM_DEBUGFS_ENTRIES, 154 minor->debugfs_root, minor); 155 if (ret) { 156 debugfs_remove(minor->debugfs_root); 157 minor->debugfs_root = NULL; 158 DRM_ERROR("Failed to create core drm debugfs files\n"); 159 return ret; 160 } 161 162 if (dev->driver->debugfs_init) { 163 ret = dev->driver->debugfs_init(minor); 164 if (ret) { 165 DRM_ERROR("DRM: Driver failed to initialize " 166 "/sys/kernel/debug/dri.\n"); 167 return ret; 168 } 169 } 170 return 0; 171 } 172 173 174 /** 175 * Remove a list of debugfs files 176 * 177 * \param files The list of files 178 * \param count The number of files 179 * \param minor The minor of which we should remove the files 180 * \return always zero. 181 * 182 * Remove all debugfs entries created by debugfs_init(). 183 */ 184 int drm_debugfs_remove_files(struct drm_info_list *files, int count, 185 struct drm_minor *minor) 186 { 187 struct list_head *pos, *q; 188 struct drm_info_node *tmp; 189 int i; 190 191 for (i = 0; i < count; i++) { 192 list_for_each_safe(pos, q, &minor->debugfs_nodes.list) { 193 tmp = list_entry(pos, struct drm_info_node, list); 194 if (tmp->info_ent == &files[i]) { 195 debugfs_remove(tmp->dent); 196 list_del(pos); 197 kfree(tmp); 198 } 199 } 200 } 201 return 0; 202 } 203 EXPORT_SYMBOL(drm_debugfs_remove_files); 204 205 /** 206 * Cleanup the debugfs filesystem resources. 207 * 208 * \param minor device minor number. 209 * \return always zero. 210 * 211 * Remove all debugfs entries created by debugfs_init(). 212 */ 213 int drm_debugfs_cleanup(struct drm_minor *minor) 214 { 215 struct drm_device *dev = minor->dev; 216 217 if (!minor->debugfs_root) 218 return 0; 219 220 if (dev->driver->debugfs_cleanup) 221 dev->driver->debugfs_cleanup(minor); 222 223 drm_debugfs_remove_files(drm_debugfs_list, DRM_DEBUGFS_ENTRIES, minor); 224 225 debugfs_remove(minor->debugfs_root); 226 minor->debugfs_root = NULL; 227 228 return 0; 229 } 230 231 #endif /* CONFIG_DEBUG_FS */ 232 233