1 /* 2 * debugfs.h - a tiny little debug file system 3 * 4 * Copyright (C) 2004 Greg Kroah-Hartman <[email protected]> 5 * Copyright (C) 2004 IBM Inc. 6 * 7 * This program is free software; you can redistribute it and/or 8 * modify it under the terms of the GNU General Public License version 9 * 2 as published by the Free Software Foundation. 10 * 11 * debugfs is for people to use instead of /proc or /sys. 12 * See Documentation/DocBook/kernel-api for more details. 13 */ 14 15 #ifndef _DEBUGFS_H_ 16 #define _DEBUGFS_H_ 17 18 #include <linux/fs.h> 19 20 #include <linux/types.h> 21 22 struct file_operations; 23 24 struct debugfs_blob_wrapper { 25 void *data; 26 unsigned long size; 27 }; 28 29 extern struct dentry *arch_debugfs_dir; 30 31 #if defined(CONFIG_DEBUG_FS) 32 33 /* declared over in file.c */ 34 extern const struct file_operations debugfs_file_operations; 35 extern const struct inode_operations debugfs_link_operations; 36 37 struct dentry *debugfs_create_file(const char *name, mode_t mode, 38 struct dentry *parent, void *data, 39 const struct file_operations *fops); 40 41 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent); 42 43 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent, 44 const char *dest); 45 46 void debugfs_remove(struct dentry *dentry); 47 48 struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry, 49 struct dentry *new_dir, const char *new_name); 50 51 struct dentry *debugfs_create_u8(const char *name, mode_t mode, 52 struct dentry *parent, u8 *value); 53 struct dentry *debugfs_create_u16(const char *name, mode_t mode, 54 struct dentry *parent, u16 *value); 55 struct dentry *debugfs_create_u32(const char *name, mode_t mode, 56 struct dentry *parent, u32 *value); 57 struct dentry *debugfs_create_u64(const char *name, mode_t mode, 58 struct dentry *parent, u64 *value); 59 struct dentry *debugfs_create_x8(const char *name, mode_t mode, 60 struct dentry *parent, u8 *value); 61 struct dentry *debugfs_create_x16(const char *name, mode_t mode, 62 struct dentry *parent, u16 *value); 63 struct dentry *debugfs_create_x32(const char *name, mode_t mode, 64 struct dentry *parent, u32 *value); 65 struct dentry *debugfs_create_bool(const char *name, mode_t mode, 66 struct dentry *parent, u32 *value); 67 68 struct dentry *debugfs_create_blob(const char *name, mode_t mode, 69 struct dentry *parent, 70 struct debugfs_blob_wrapper *blob); 71 #else 72 73 #include <linux/err.h> 74 75 /* 76 * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled 77 * so users have a chance to detect if there was a real error or not. We don't 78 * want to duplicate the design decision mistakes of procfs and devfs again. 79 */ 80 81 static inline struct dentry *debugfs_create_file(const char *name, mode_t mode, 82 struct dentry *parent, void *data, 83 const struct file_operations *fops) 84 { 85 return ERR_PTR(-ENODEV); 86 } 87 88 static inline struct dentry *debugfs_create_dir(const char *name, 89 struct dentry *parent) 90 { 91 return ERR_PTR(-ENODEV); 92 } 93 94 static inline struct dentry *debugfs_create_symlink(const char *name, 95 struct dentry *parent, 96 const char *dest) 97 { 98 return ERR_PTR(-ENODEV); 99 } 100 101 static inline void debugfs_remove(struct dentry *dentry) 102 { } 103 104 static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry, 105 struct dentry *new_dir, char *new_name) 106 { 107 return ERR_PTR(-ENODEV); 108 } 109 110 static inline struct dentry *debugfs_create_u8(const char *name, mode_t mode, 111 struct dentry *parent, 112 u8 *value) 113 { 114 return ERR_PTR(-ENODEV); 115 } 116 117 static inline struct dentry *debugfs_create_u16(const char *name, mode_t mode, 118 struct dentry *parent, 119 u16 *value) 120 { 121 return ERR_PTR(-ENODEV); 122 } 123 124 static inline struct dentry *debugfs_create_u32(const char *name, mode_t mode, 125 struct dentry *parent, 126 u32 *value) 127 { 128 return ERR_PTR(-ENODEV); 129 } 130 131 static inline struct dentry *debugfs_create_u64(const char *name, mode_t mode, 132 struct dentry *parent, 133 u64 *value) 134 { 135 return ERR_PTR(-ENODEV); 136 } 137 138 static inline struct dentry *debugfs_create_x8(const char *name, mode_t mode, 139 struct dentry *parent, 140 u8 *value) 141 { 142 return ERR_PTR(-ENODEV); 143 } 144 145 static inline struct dentry *debugfs_create_x16(const char *name, mode_t mode, 146 struct dentry *parent, 147 u16 *value) 148 { 149 return ERR_PTR(-ENODEV); 150 } 151 152 static inline struct dentry *debugfs_create_x32(const char *name, mode_t mode, 153 struct dentry *parent, 154 u32 *value) 155 { 156 return ERR_PTR(-ENODEV); 157 } 158 159 static inline struct dentry *debugfs_create_bool(const char *name, mode_t mode, 160 struct dentry *parent, 161 u32 *value) 162 { 163 return ERR_PTR(-ENODEV); 164 } 165 166 static inline struct dentry *debugfs_create_blob(const char *name, mode_t mode, 167 struct dentry *parent, 168 struct debugfs_blob_wrapper *blob) 169 { 170 return ERR_PTR(-ENODEV); 171 } 172 173 #endif 174 175 #endif 176