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