Version:  2.0.40 2.2.26 2.4.37 3.3 3.4 3.5 3.6 3.7 3.8 3.9 3.10 3.11 3.12 3.13 3.14 3.15 3.16 3.17 3.18 3.19

Linux/include/linux/debugfs.h

  1 /*
  2  *  debugfs.h - a tiny little debug file system
  3  *
  4  *  Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
  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/filesystems for more details.
 13  */
 14 
 15 #ifndef _DEBUGFS_H_
 16 #define _DEBUGFS_H_
 17 
 18 #include <linux/fs.h>
 19 #include <linux/seq_file.h>
 20 
 21 #include <linux/types.h>
 22 
 23 struct device;
 24 struct file_operations;
 25 
 26 struct debugfs_blob_wrapper {
 27         void *data;
 28         unsigned long size;
 29 };
 30 
 31 struct debugfs_reg32 {
 32         char *name;
 33         unsigned long offset;
 34 };
 35 
 36 struct debugfs_regset32 {
 37         const struct debugfs_reg32 *regs;
 38         int nregs;
 39         void __iomem *base;
 40 };
 41 
 42 extern struct dentry *arch_debugfs_dir;
 43 
 44 #if defined(CONFIG_DEBUG_FS)
 45 
 46 /* declared over in file.c */
 47 extern const struct file_operations debugfs_file_operations;
 48 extern const struct inode_operations debugfs_link_operations;
 49 
 50 struct dentry *debugfs_create_file(const char *name, umode_t mode,
 51                                    struct dentry *parent, void *data,
 52                                    const struct file_operations *fops);
 53 
 54 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
 55 
 56 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
 57                                       const char *dest);
 58 
 59 void debugfs_remove(struct dentry *dentry);
 60 void debugfs_remove_recursive(struct dentry *dentry);
 61 
 62 struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
 63                 struct dentry *new_dir, const char *new_name);
 64 
 65 struct dentry *debugfs_create_u8(const char *name, umode_t mode,
 66                                  struct dentry *parent, u8 *value);
 67 struct dentry *debugfs_create_u16(const char *name, umode_t mode,
 68                                   struct dentry *parent, u16 *value);
 69 struct dentry *debugfs_create_u32(const char *name, umode_t mode,
 70                                   struct dentry *parent, u32 *value);
 71 struct dentry *debugfs_create_u64(const char *name, umode_t mode,
 72                                   struct dentry *parent, u64 *value);
 73 struct dentry *debugfs_create_x8(const char *name, umode_t mode,
 74                                  struct dentry *parent, u8 *value);
 75 struct dentry *debugfs_create_x16(const char *name, umode_t mode,
 76                                   struct dentry *parent, u16 *value);
 77 struct dentry *debugfs_create_x32(const char *name, umode_t mode,
 78                                   struct dentry *parent, u32 *value);
 79 struct dentry *debugfs_create_x64(const char *name, umode_t mode,
 80                                   struct dentry *parent, u64 *value);
 81 struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
 82                                      struct dentry *parent, size_t *value);
 83 struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode,
 84                                      struct dentry *parent, atomic_t *value);
 85 struct dentry *debugfs_create_bool(const char *name, umode_t mode,
 86                                   struct dentry *parent, u32 *value);
 87 
 88 struct dentry *debugfs_create_blob(const char *name, umode_t mode,
 89                                   struct dentry *parent,
 90                                   struct debugfs_blob_wrapper *blob);
 91 
 92 struct dentry *debugfs_create_regset32(const char *name, umode_t mode,
 93                                      struct dentry *parent,
 94                                      struct debugfs_regset32 *regset);
 95 
 96 void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
 97                           int nregs, void __iomem *base, char *prefix);
 98 
 99 struct dentry *debugfs_create_u32_array(const char *name, umode_t mode,
100                                         struct dentry *parent,
101                                         u32 *array, u32 elements);
102 
103 struct dentry *debugfs_create_devm_seqfile(struct device *dev, const char *name,
104                                            struct dentry *parent,
105                                            int (*read_fn)(struct seq_file *s,
106                                                           void *data));
107 
108 bool debugfs_initialized(void);
109 
110 #else
111 
112 #include <linux/err.h>
113 
114 /*
115  * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
116  * so users have a chance to detect if there was a real error or not.  We don't
117  * want to duplicate the design decision mistakes of procfs and devfs again.
118  */
119 
120 static inline struct dentry *debugfs_create_file(const char *name, umode_t mode,
121                                         struct dentry *parent, void *data,
122                                         const struct file_operations *fops)
123 {
124         return ERR_PTR(-ENODEV);
125 }
126 
127 static inline struct dentry *debugfs_create_dir(const char *name,
128                                                 struct dentry *parent)
129 {
130         return ERR_PTR(-ENODEV);
131 }
132 
133 static inline struct dentry *debugfs_create_symlink(const char *name,
134                                                     struct dentry *parent,
135                                                     const char *dest)
136 {
137         return ERR_PTR(-ENODEV);
138 }
139 
140 static inline void debugfs_remove(struct dentry *dentry)
141 { }
142 
143 static inline void debugfs_remove_recursive(struct dentry *dentry)
144 { }
145 
146 static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
147                 struct dentry *new_dir, char *new_name)
148 {
149         return ERR_PTR(-ENODEV);
150 }
151 
152 static inline struct dentry *debugfs_create_u8(const char *name, umode_t mode,
153                                                struct dentry *parent,
154                                                u8 *value)
155 {
156         return ERR_PTR(-ENODEV);
157 }
158 
159 static inline struct dentry *debugfs_create_u16(const char *name, umode_t mode,
160                                                 struct dentry *parent,
161                                                 u16 *value)
162 {
163         return ERR_PTR(-ENODEV);
164 }
165 
166 static inline struct dentry *debugfs_create_u32(const char *name, umode_t mode,
167                                                 struct dentry *parent,
168                                                 u32 *value)
169 {
170         return ERR_PTR(-ENODEV);
171 }
172 
173 static inline struct dentry *debugfs_create_u64(const char *name, umode_t mode,
174                                                 struct dentry *parent,
175                                                 u64 *value)
176 {
177         return ERR_PTR(-ENODEV);
178 }
179 
180 static inline struct dentry *debugfs_create_x8(const char *name, umode_t mode,
181                                                struct dentry *parent,
182                                                u8 *value)
183 {
184         return ERR_PTR(-ENODEV);
185 }
186 
187 static inline struct dentry *debugfs_create_x16(const char *name, umode_t mode,
188                                                 struct dentry *parent,
189                                                 u16 *value)
190 {
191         return ERR_PTR(-ENODEV);
192 }
193 
194 static inline struct dentry *debugfs_create_x32(const char *name, umode_t mode,
195                                                 struct dentry *parent,
196                                                 u32 *value)
197 {
198         return ERR_PTR(-ENODEV);
199 }
200 
201 static inline struct dentry *debugfs_create_x64(const char *name, umode_t mode,
202                                                 struct dentry *parent,
203                                                 u64 *value)
204 {
205         return ERR_PTR(-ENODEV);
206 }
207 
208 static inline struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
209                                      struct dentry *parent,
210                                      size_t *value)
211 {
212         return ERR_PTR(-ENODEV);
213 }
214 
215 static inline struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode,
216                                      struct dentry *parent, atomic_t *value)
217 {
218         return ERR_PTR(-ENODEV);
219 }
220 
221 static inline struct dentry *debugfs_create_bool(const char *name, umode_t mode,
222                                                  struct dentry *parent,
223                                                  u32 *value)
224 {
225         return ERR_PTR(-ENODEV);
226 }
227 
228 static inline struct dentry *debugfs_create_blob(const char *name, umode_t mode,
229                                   struct dentry *parent,
230                                   struct debugfs_blob_wrapper *blob)
231 {
232         return ERR_PTR(-ENODEV);
233 }
234 
235 static inline struct dentry *debugfs_create_regset32(const char *name,
236                                    umode_t mode, struct dentry *parent,
237                                    struct debugfs_regset32 *regset)
238 {
239         return ERR_PTR(-ENODEV);
240 }
241 
242 static inline void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
243                          int nregs, void __iomem *base, char *prefix)
244 {
245 }
246 
247 static inline bool debugfs_initialized(void)
248 {
249         return false;
250 }
251 
252 static inline struct dentry *debugfs_create_u32_array(const char *name, umode_t mode,
253                                         struct dentry *parent,
254                                         u32 *array, u32 elements)
255 {
256         return ERR_PTR(-ENODEV);
257 }
258 
259 static inline struct dentry *debugfs_create_devm_seqfile(struct device *dev,
260                                                          const char *name,
261                                                          struct dentry *parent,
262                                            int (*read_fn)(struct seq_file *s,
263                                                           void *data))
264 {
265         return ERR_PTR(-ENODEV);
266 }
267 
268 #endif
269 
270 #endif
271 

This page was automatically generated by LXR 0.3.1 (source).  •  Linux is a registered trademark of Linus Torvalds  •  Contact us