Version:  2.0.40 2.2.26 2.4.37 3.8 3.9 3.10 3.11 3.12 3.13 3.14 3.15 3.16 3.17 3.18 3.19 4.0 4.1 4.2 4.3 4.4 4.5

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 
 49 struct dentry *debugfs_create_file(const char *name, umode_t mode,
 50                                    struct dentry *parent, void *data,
 51                                    const struct file_operations *fops);
 52 
 53 struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
 54                                         struct dentry *parent, void *data,
 55                                         const struct file_operations *fops,
 56                                         loff_t file_size);
 57 
 58 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
 59 
 60 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
 61                                       const char *dest);
 62 
 63 struct dentry *debugfs_create_automount(const char *name,
 64                                         struct dentry *parent,
 65                                         struct vfsmount *(*f)(void *),
 66                                         void *data);
 67 
 68 void debugfs_remove(struct dentry *dentry);
 69 void debugfs_remove_recursive(struct dentry *dentry);
 70 
 71 struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
 72                 struct dentry *new_dir, const char *new_name);
 73 
 74 struct dentry *debugfs_create_u8(const char *name, umode_t mode,
 75                                  struct dentry *parent, u8 *value);
 76 struct dentry *debugfs_create_u16(const char *name, umode_t mode,
 77                                   struct dentry *parent, u16 *value);
 78 struct dentry *debugfs_create_u32(const char *name, umode_t mode,
 79                                   struct dentry *parent, u32 *value);
 80 struct dentry *debugfs_create_u64(const char *name, umode_t mode,
 81                                   struct dentry *parent, u64 *value);
 82 struct dentry *debugfs_create_ulong(const char *name, umode_t mode,
 83                                     struct dentry *parent, unsigned long *value);
 84 struct dentry *debugfs_create_x8(const char *name, umode_t mode,
 85                                  struct dentry *parent, u8 *value);
 86 struct dentry *debugfs_create_x16(const char *name, umode_t mode,
 87                                   struct dentry *parent, u16 *value);
 88 struct dentry *debugfs_create_x32(const char *name, umode_t mode,
 89                                   struct dentry *parent, u32 *value);
 90 struct dentry *debugfs_create_x64(const char *name, umode_t mode,
 91                                   struct dentry *parent, u64 *value);
 92 struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
 93                                      struct dentry *parent, size_t *value);
 94 struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode,
 95                                      struct dentry *parent, atomic_t *value);
 96 struct dentry *debugfs_create_bool(const char *name, umode_t mode,
 97                                   struct dentry *parent, bool *value);
 98 
 99 struct dentry *debugfs_create_blob(const char *name, umode_t mode,
100                                   struct dentry *parent,
101                                   struct debugfs_blob_wrapper *blob);
102 
103 struct dentry *debugfs_create_regset32(const char *name, umode_t mode,
104                                      struct dentry *parent,
105                                      struct debugfs_regset32 *regset);
106 
107 void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
108                           int nregs, void __iomem *base, char *prefix);
109 
110 struct dentry *debugfs_create_u32_array(const char *name, umode_t mode,
111                                         struct dentry *parent,
112                                         u32 *array, u32 elements);
113 
114 struct dentry *debugfs_create_devm_seqfile(struct device *dev, const char *name,
115                                            struct dentry *parent,
116                                            int (*read_fn)(struct seq_file *s,
117                                                           void *data));
118 
119 bool debugfs_initialized(void);
120 
121 ssize_t debugfs_read_file_bool(struct file *file, char __user *user_buf,
122                                size_t count, loff_t *ppos);
123 
124 ssize_t debugfs_write_file_bool(struct file *file, const char __user *user_buf,
125                                 size_t count, loff_t *ppos);
126 
127 #else
128 
129 #include <linux/err.h>
130 
131 /*
132  * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
133  * so users have a chance to detect if there was a real error or not.  We don't
134  * want to duplicate the design decision mistakes of procfs and devfs again.
135  */
136 
137 static inline struct dentry *debugfs_create_file(const char *name, umode_t mode,
138                                         struct dentry *parent, void *data,
139                                         const struct file_operations *fops)
140 {
141         return ERR_PTR(-ENODEV);
142 }
143 
144 static inline struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
145                                         struct dentry *parent, void *data,
146                                         const struct file_operations *fops,
147                                         loff_t file_size)
148 {
149         return ERR_PTR(-ENODEV);
150 }
151 
152 static inline struct dentry *debugfs_create_dir(const char *name,
153                                                 struct dentry *parent)
154 {
155         return ERR_PTR(-ENODEV);
156 }
157 
158 static inline struct dentry *debugfs_create_symlink(const char *name,
159                                                     struct dentry *parent,
160                                                     const char *dest)
161 {
162         return ERR_PTR(-ENODEV);
163 }
164 
165 static inline void debugfs_remove(struct dentry *dentry)
166 { }
167 
168 static inline void debugfs_remove_recursive(struct dentry *dentry)
169 { }
170 
171 static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
172                 struct dentry *new_dir, char *new_name)
173 {
174         return ERR_PTR(-ENODEV);
175 }
176 
177 static inline struct dentry *debugfs_create_u8(const char *name, umode_t mode,
178                                                struct dentry *parent,
179                                                u8 *value)
180 {
181         return ERR_PTR(-ENODEV);
182 }
183 
184 static inline struct dentry *debugfs_create_u16(const char *name, umode_t mode,
185                                                 struct dentry *parent,
186                                                 u16 *value)
187 {
188         return ERR_PTR(-ENODEV);
189 }
190 
191 static inline struct dentry *debugfs_create_u32(const char *name, umode_t mode,
192                                                 struct dentry *parent,
193                                                 u32 *value)
194 {
195         return ERR_PTR(-ENODEV);
196 }
197 
198 static inline struct dentry *debugfs_create_u64(const char *name, umode_t mode,
199                                                 struct dentry *parent,
200                                                 u64 *value)
201 {
202         return ERR_PTR(-ENODEV);
203 }
204 
205 static inline struct dentry *debugfs_create_x8(const char *name, umode_t mode,
206                                                struct dentry *parent,
207                                                u8 *value)
208 {
209         return ERR_PTR(-ENODEV);
210 }
211 
212 static inline struct dentry *debugfs_create_x16(const char *name, umode_t mode,
213                                                 struct dentry *parent,
214                                                 u16 *value)
215 {
216         return ERR_PTR(-ENODEV);
217 }
218 
219 static inline struct dentry *debugfs_create_x32(const char *name, umode_t mode,
220                                                 struct dentry *parent,
221                                                 u32 *value)
222 {
223         return ERR_PTR(-ENODEV);
224 }
225 
226 static inline struct dentry *debugfs_create_x64(const char *name, umode_t mode,
227                                                 struct dentry *parent,
228                                                 u64 *value)
229 {
230         return ERR_PTR(-ENODEV);
231 }
232 
233 static inline struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
234                                      struct dentry *parent,
235                                      size_t *value)
236 {
237         return ERR_PTR(-ENODEV);
238 }
239 
240 static inline struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode,
241                                      struct dentry *parent, atomic_t *value)
242 {
243         return ERR_PTR(-ENODEV);
244 }
245 
246 static inline struct dentry *debugfs_create_bool(const char *name, umode_t mode,
247                                                  struct dentry *parent,
248                                                  bool *value)
249 {
250         return ERR_PTR(-ENODEV);
251 }
252 
253 static inline struct dentry *debugfs_create_blob(const char *name, umode_t mode,
254                                   struct dentry *parent,
255                                   struct debugfs_blob_wrapper *blob)
256 {
257         return ERR_PTR(-ENODEV);
258 }
259 
260 static inline struct dentry *debugfs_create_regset32(const char *name,
261                                    umode_t mode, struct dentry *parent,
262                                    struct debugfs_regset32 *regset)
263 {
264         return ERR_PTR(-ENODEV);
265 }
266 
267 static inline void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
268                          int nregs, void __iomem *base, char *prefix)
269 {
270 }
271 
272 static inline bool debugfs_initialized(void)
273 {
274         return false;
275 }
276 
277 static inline struct dentry *debugfs_create_u32_array(const char *name, umode_t mode,
278                                         struct dentry *parent,
279                                         u32 *array, u32 elements)
280 {
281         return ERR_PTR(-ENODEV);
282 }
283 
284 static inline struct dentry *debugfs_create_devm_seqfile(struct device *dev,
285                                                          const char *name,
286                                                          struct dentry *parent,
287                                            int (*read_fn)(struct seq_file *s,
288                                                           void *data))
289 {
290         return ERR_PTR(-ENODEV);
291 }
292 
293 static inline ssize_t debugfs_read_file_bool(struct file *file,
294                                              char __user *user_buf,
295                                              size_t count, loff_t *ppos)
296 {
297         return -ENODEV;
298 }
299 
300 static inline ssize_t debugfs_write_file_bool(struct file *file,
301                                               const char __user *user_buf,
302                                               size_t count, loff_t *ppos)
303 {
304         return -ENODEV;
305 }
306 
307 #endif
308 
309 #endif
310 

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