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 #if defined(CONFIG_DEBUG_FS) 30 31 /* declared over in file.c */ 32 extern const struct file_operations debugfs_file_operations; 33 extern const struct inode_operations debugfs_link_operations; 34 35 struct dentry *debugfs_create_file(const char *name, mode_t mode, 36 struct dentry *parent, void *data, 37 const struct file_operations *fops); 38 39 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent); 40 41 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent, 42 const char *dest); 43 44 void debugfs_remove(struct dentry *dentry); 45 46 struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry, 47 struct dentry *new_dir, const char *new_name); 48 49 struct dentry *debugfs_create_u8(const char *name, mode_t mode, 50 struct dentry *parent, u8 *value); 51 struct dentry *debugfs_create_u16(const char *name, mode_t mode, 52 struct dentry *parent, u16 *value); 53 struct dentry *debugfs_create_u32(const char *name, mode_t mode, 54 struct dentry *parent, u32 *value); 55 struct dentry *debugfs_create_u64(const char *name, mode_t mode, 56 struct dentry *parent, u64 *value); 57 struct dentry *debugfs_create_x8(const char *name, mode_t mode, 58 struct dentry *parent, u8 *value); 59 struct dentry *debugfs_create_x16(const char *name, mode_t mode, 60 struct dentry *parent, u16 *value); 61 struct dentry *debugfs_create_x32(const char *name, mode_t mode, 62 struct dentry *parent, u32 *value); 63 struct dentry *debugfs_create_bool(const char *name, mode_t mode, 64 struct dentry *parent, u32 *value); 65 66 struct dentry *debugfs_create_blob(const char *name, mode_t mode, 67 struct dentry *parent, 68 struct debugfs_blob_wrapper *blob); 69 #else 70 71 #include <linux/err.h> 72 73 /* 74 * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled 75 * so users have a chance to detect if there was a real error or not. We don't 76 * want to duplicate the design decision mistakes of procfs and devfs again. 77 */ 78 79 static inline struct dentry *debugfs_create_file(const char *name, mode_t mode, 80 struct dentry *parent, void *data, 81 const struct file_operations *fops) 82 { 83 return ERR_PTR(-ENODEV); 84 } 85 86 static inline struct dentry *debugfs_create_dir(const char *name, 87 struct dentry *parent) 88 { 89 return ERR_PTR(-ENODEV); 90 } 91 92 static inline struct dentry *debugfs_create_symlink(const char *name, 93 struct dentry *parent, 94 const char *dest) 95 { 96 return ERR_PTR(-ENODEV); 97 } 98 99 static inline void debugfs_remove(struct dentry *dentry) 100 { } 101 102 static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry, 103 struct dentry *new_dir, char *new_name) 104 { 105 return ERR_PTR(-ENODEV); 106 } 107 108 static inline struct dentry *debugfs_create_u8(const char *name, mode_t mode, 109 struct dentry *parent, 110 u8 *value) 111 { 112 return ERR_PTR(-ENODEV); 113 } 114 115 static inline struct dentry *debugfs_create_u16(const char *name, mode_t mode, 116 struct dentry *parent, 117 u16 *value) 118 { 119 return ERR_PTR(-ENODEV); 120 } 121 122 static inline struct dentry *debugfs_create_u32(const char *name, mode_t mode, 123 struct dentry *parent, 124 u32 *value) 125 { 126 return ERR_PTR(-ENODEV); 127 } 128 129 static inline struct dentry *debugfs_create_u64(const char *name, mode_t mode, 130 struct dentry *parent, 131 u64 *value) 132 { 133 return ERR_PTR(-ENODEV); 134 } 135 136 static inline struct dentry *debugfs_create_x8(const char *name, mode_t mode, 137 struct dentry *parent, 138 u8 *value) 139 { 140 return ERR_PTR(-ENODEV); 141 } 142 143 static inline struct dentry *debugfs_create_x16(const char *name, mode_t mode, 144 struct dentry *parent, 145 u16 *value) 146 { 147 return ERR_PTR(-ENODEV); 148 } 149 150 static inline struct dentry *debugfs_create_x32(const char *name, mode_t mode, 151 struct dentry *parent, 152 u32 *value) 153 { 154 return ERR_PTR(-ENODEV); 155 } 156 157 static inline struct dentry *debugfs_create_bool(const char *name, mode_t mode, 158 struct dentry *parent, 159 u32 *value) 160 { 161 return ERR_PTR(-ENODEV); 162 } 163 164 static inline struct dentry *debugfs_create_blob(const char *name, mode_t mode, 165 struct dentry *parent, 166 struct debugfs_blob_wrapper *blob) 167 { 168 return ERR_PTR(-ENODEV); 169 } 170 171 #endif 172 173 #endif 174