2 * debugfs.h - a tiny little debug file system
4 * Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
5 * Copyright (C) 2004 IBM Inc.
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.
11 * debugfs is for people to use instead of /proc or /sys.
12 * See Documentation/DocBook/filesystems for more details.
19 #include <linux/seq_file.h>
21 #include <linux/types.h>
24 struct file_operations;
26 struct debugfs_blob_wrapper {
31 struct debugfs_reg32 {
36 struct debugfs_regset32 {
37 const struct debugfs_reg32 *regs;
42 extern struct dentry *arch_debugfs_dir;
44 #if defined(CONFIG_DEBUG_FS)
46 /* declared over in file.c */
47 extern const struct file_operations debugfs_file_operations;
48 extern const struct inode_operations debugfs_link_operations;
50 struct dentry *debugfs_create_file(const char *name, umode_t mode,
51 struct dentry *parent, void *data,
52 const struct file_operations *fops);
54 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
56 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
59 void debugfs_remove(struct dentry *dentry);
60 void debugfs_remove_recursive(struct dentry *dentry);
62 struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
63 struct dentry *new_dir, const char *new_name);
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);
88 struct dentry *debugfs_create_blob(const char *name, umode_t mode,
89 struct dentry *parent,
90 struct debugfs_blob_wrapper *blob);
92 struct dentry *debugfs_create_regset32(const char *name, umode_t mode,
93 struct dentry *parent,
94 struct debugfs_regset32 *regset);
96 void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
97 int nregs, void __iomem *base, char *prefix);
99 struct dentry *debugfs_create_u32_array(const char *name, umode_t mode,
100 struct dentry *parent,
101 u32 *array, u32 elements);
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,
108 bool debugfs_initialized(void);
112 #include <linux/err.h>
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.
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)
124 return ERR_PTR(-ENODEV);
127 static inline struct dentry *debugfs_create_dir(const char *name,
128 struct dentry *parent)
130 return ERR_PTR(-ENODEV);
133 static inline struct dentry *debugfs_create_symlink(const char *name,
134 struct dentry *parent,
137 return ERR_PTR(-ENODEV);
140 static inline void debugfs_remove(struct dentry *dentry)
143 static inline void debugfs_remove_recursive(struct dentry *dentry)
146 static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
147 struct dentry *new_dir, char *new_name)
149 return ERR_PTR(-ENODEV);
152 static inline struct dentry *debugfs_create_u8(const char *name, umode_t mode,
153 struct dentry *parent,
156 return ERR_PTR(-ENODEV);
159 static inline struct dentry *debugfs_create_u16(const char *name, umode_t mode,
160 struct dentry *parent,
163 return ERR_PTR(-ENODEV);
166 static inline struct dentry *debugfs_create_u32(const char *name, umode_t mode,
167 struct dentry *parent,
170 return ERR_PTR(-ENODEV);
173 static inline struct dentry *debugfs_create_u64(const char *name, umode_t mode,
174 struct dentry *parent,
177 return ERR_PTR(-ENODEV);
180 static inline struct dentry *debugfs_create_x8(const char *name, umode_t mode,
181 struct dentry *parent,
184 return ERR_PTR(-ENODEV);
187 static inline struct dentry *debugfs_create_x16(const char *name, umode_t mode,
188 struct dentry *parent,
191 return ERR_PTR(-ENODEV);
194 static inline struct dentry *debugfs_create_x32(const char *name, umode_t mode,
195 struct dentry *parent,
198 return ERR_PTR(-ENODEV);
201 static inline struct dentry *debugfs_create_x64(const char *name, umode_t mode,
202 struct dentry *parent,
205 return ERR_PTR(-ENODEV);
208 static inline struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
209 struct dentry *parent,
212 return ERR_PTR(-ENODEV);
215 static inline struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode,
216 struct dentry *parent, atomic_t *value)
218 return ERR_PTR(-ENODEV);
221 static inline struct dentry *debugfs_create_bool(const char *name, umode_t mode,
222 struct dentry *parent,
225 return ERR_PTR(-ENODEV);
228 static inline struct dentry *debugfs_create_blob(const char *name, umode_t mode,
229 struct dentry *parent,
230 struct debugfs_blob_wrapper *blob)
232 return ERR_PTR(-ENODEV);
235 static inline struct dentry *debugfs_create_regset32(const char *name,
236 umode_t mode, struct dentry *parent,
237 struct debugfs_regset32 *regset)
239 return ERR_PTR(-ENODEV);
242 static inline void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
243 int nregs, void __iomem *base, char *prefix)
247 static inline bool debugfs_initialized(void)
252 static inline struct dentry *debugfs_create_u32_array(const char *name, umode_t mode,
253 struct dentry *parent,
254 u32 *array, u32 elements)
256 return ERR_PTR(-ENODEV);
259 static inline struct dentry *debugfs_create_devm_seqfile(struct device *dev,
261 struct dentry *parent,
262 int (*read_fn)(struct seq_file *s,
265 return ERR_PTR(-ENODEV);