1 // SPDX-License-Identifier: GPL-2.0
3 * debugfs.h - a tiny little debug file system
5 * Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
6 * Copyright (C) 2004 IBM Inc.
8 * debugfs is for people to use instead of /proc or /sys.
9 * See Documentation/filesystems/ for more details.
16 #include <linux/seq_file.h>
18 #include <linux/types.h>
19 #include <linux/compiler.h>
22 struct file_operations;
24 struct debugfs_blob_wrapper {
29 struct debugfs_reg32 {
34 struct debugfs_regset32 {
35 const struct debugfs_reg32 *regs;
40 extern struct dentry *arch_debugfs_dir;
42 #define DEFINE_DEBUGFS_ATTRIBUTE(__fops, __get, __set, __fmt) \
43 static int __fops ## _open(struct inode *inode, struct file *file) \
45 __simple_attr_check_format(__fmt, 0ull); \
46 return simple_attr_open(inode, file, __get, __set, __fmt); \
48 static const struct file_operations __fops = { \
49 .owner = THIS_MODULE, \
50 .open = __fops ## _open, \
51 .release = simple_attr_release, \
52 .read = debugfs_attr_read, \
53 .write = debugfs_attr_write, \
54 .llseek = no_llseek, \
57 typedef struct vfsmount *(*debugfs_automount_t)(struct dentry *, void *);
59 #if defined(CONFIG_DEBUG_FS)
61 struct dentry *debugfs_lookup(const char *name, struct dentry *parent);
63 struct dentry *debugfs_create_file(const char *name, umode_t mode,
64 struct dentry *parent, void *data,
65 const struct file_operations *fops);
66 struct dentry *debugfs_create_file_unsafe(const char *name, umode_t mode,
67 struct dentry *parent, void *data,
68 const struct file_operations *fops);
70 struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
71 struct dentry *parent, void *data,
72 const struct file_operations *fops,
75 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
77 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
80 struct dentry *debugfs_create_automount(const char *name,
81 struct dentry *parent,
82 debugfs_automount_t f,
85 void debugfs_remove(struct dentry *dentry);
86 void debugfs_remove_recursive(struct dentry *dentry);
88 const struct file_operations *debugfs_real_fops(const struct file *filp);
90 int debugfs_file_get(struct dentry *dentry);
91 void debugfs_file_put(struct dentry *dentry);
93 ssize_t debugfs_attr_read(struct file *file, char __user *buf,
94 size_t len, loff_t *ppos);
95 ssize_t debugfs_attr_write(struct file *file, const char __user *buf,
96 size_t len, loff_t *ppos);
98 struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
99 struct dentry *new_dir, const char *new_name);
101 struct dentry *debugfs_create_u8(const char *name, umode_t mode,
102 struct dentry *parent, u8 *value);
103 struct dentry *debugfs_create_u16(const char *name, umode_t mode,
104 struct dentry *parent, u16 *value);
105 struct dentry *debugfs_create_u32(const char *name, umode_t mode,
106 struct dentry *parent, u32 *value);
107 struct dentry *debugfs_create_u64(const char *name, umode_t mode,
108 struct dentry *parent, u64 *value);
109 struct dentry *debugfs_create_ulong(const char *name, umode_t mode,
110 struct dentry *parent, unsigned long *value);
111 struct dentry *debugfs_create_x8(const char *name, umode_t mode,
112 struct dentry *parent, u8 *value);
113 struct dentry *debugfs_create_x16(const char *name, umode_t mode,
114 struct dentry *parent, u16 *value);
115 struct dentry *debugfs_create_x32(const char *name, umode_t mode,
116 struct dentry *parent, u32 *value);
117 struct dentry *debugfs_create_x64(const char *name, umode_t mode,
118 struct dentry *parent, u64 *value);
119 struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
120 struct dentry *parent, size_t *value);
121 struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode,
122 struct dentry *parent, atomic_t *value);
123 struct dentry *debugfs_create_bool(const char *name, umode_t mode,
124 struct dentry *parent, bool *value);
126 struct dentry *debugfs_create_blob(const char *name, umode_t mode,
127 struct dentry *parent,
128 struct debugfs_blob_wrapper *blob);
130 struct dentry *debugfs_create_regset32(const char *name, umode_t mode,
131 struct dentry *parent,
132 struct debugfs_regset32 *regset);
134 void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
135 int nregs, void __iomem *base, char *prefix);
137 struct dentry *debugfs_create_u32_array(const char *name, umode_t mode,
138 struct dentry *parent,
139 u32 *array, u32 elements);
141 struct dentry *debugfs_create_devm_seqfile(struct device *dev, const char *name,
142 struct dentry *parent,
143 int (*read_fn)(struct seq_file *s,
146 bool debugfs_initialized(void);
148 ssize_t debugfs_read_file_bool(struct file *file, char __user *user_buf,
149 size_t count, loff_t *ppos);
151 ssize_t debugfs_write_file_bool(struct file *file, const char __user *user_buf,
152 size_t count, loff_t *ppos);
156 #include <linux/err.h>
159 * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
160 * so users have a chance to detect if there was a real error or not. We don't
161 * want to duplicate the design decision mistakes of procfs and devfs again.
164 static inline struct dentry *debugfs_lookup(const char *name,
165 struct dentry *parent)
167 return ERR_PTR(-ENODEV);
170 static inline struct dentry *debugfs_create_file(const char *name, umode_t mode,
171 struct dentry *parent, void *data,
172 const struct file_operations *fops)
174 return ERR_PTR(-ENODEV);
177 static inline struct dentry *debugfs_create_file_unsafe(const char *name,
178 umode_t mode, struct dentry *parent,
180 const struct file_operations *fops)
182 return ERR_PTR(-ENODEV);
185 static inline struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
186 struct dentry *parent, void *data,
187 const struct file_operations *fops,
190 return ERR_PTR(-ENODEV);
193 static inline struct dentry *debugfs_create_dir(const char *name,
194 struct dentry *parent)
196 return ERR_PTR(-ENODEV);
199 static inline struct dentry *debugfs_create_symlink(const char *name,
200 struct dentry *parent,
203 return ERR_PTR(-ENODEV);
206 static inline struct dentry *debugfs_create_automount(const char *name,
207 struct dentry *parent,
208 debugfs_automount_t f,
211 return ERR_PTR(-ENODEV);
214 static inline void debugfs_remove(struct dentry *dentry)
217 static inline void debugfs_remove_recursive(struct dentry *dentry)
220 const struct file_operations *debugfs_real_fops(const struct file *filp);
222 static inline int debugfs_file_get(struct dentry *dentry)
227 static inline void debugfs_file_put(struct dentry *dentry)
230 static inline ssize_t debugfs_attr_read(struct file *file, char __user *buf,
231 size_t len, loff_t *ppos)
236 static inline ssize_t debugfs_attr_write(struct file *file,
237 const char __user *buf,
238 size_t len, loff_t *ppos)
243 static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
244 struct dentry *new_dir, char *new_name)
246 return ERR_PTR(-ENODEV);
249 static inline struct dentry *debugfs_create_u8(const char *name, umode_t mode,
250 struct dentry *parent,
253 return ERR_PTR(-ENODEV);
256 static inline struct dentry *debugfs_create_u16(const char *name, umode_t mode,
257 struct dentry *parent,
260 return ERR_PTR(-ENODEV);
263 static inline struct dentry *debugfs_create_u32(const char *name, umode_t mode,
264 struct dentry *parent,
267 return ERR_PTR(-ENODEV);
270 static inline struct dentry *debugfs_create_u64(const char *name, umode_t mode,
271 struct dentry *parent,
274 return ERR_PTR(-ENODEV);
277 static inline struct dentry *debugfs_create_ulong(const char *name,
279 struct dentry *parent,
280 unsigned long *value)
282 return ERR_PTR(-ENODEV);
285 static inline struct dentry *debugfs_create_x8(const char *name, umode_t mode,
286 struct dentry *parent,
289 return ERR_PTR(-ENODEV);
292 static inline struct dentry *debugfs_create_x16(const char *name, umode_t mode,
293 struct dentry *parent,
296 return ERR_PTR(-ENODEV);
299 static inline struct dentry *debugfs_create_x32(const char *name, umode_t mode,
300 struct dentry *parent,
303 return ERR_PTR(-ENODEV);
306 static inline struct dentry *debugfs_create_x64(const char *name, umode_t mode,
307 struct dentry *parent,
310 return ERR_PTR(-ENODEV);
313 static inline struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
314 struct dentry *parent,
317 return ERR_PTR(-ENODEV);
320 static inline struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode,
321 struct dentry *parent, atomic_t *value)
323 return ERR_PTR(-ENODEV);
326 static inline struct dentry *debugfs_create_bool(const char *name, umode_t mode,
327 struct dentry *parent,
330 return ERR_PTR(-ENODEV);
333 static inline struct dentry *debugfs_create_blob(const char *name, umode_t mode,
334 struct dentry *parent,
335 struct debugfs_blob_wrapper *blob)
337 return ERR_PTR(-ENODEV);
340 static inline struct dentry *debugfs_create_regset32(const char *name,
341 umode_t mode, struct dentry *parent,
342 struct debugfs_regset32 *regset)
344 return ERR_PTR(-ENODEV);
347 static inline void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
348 int nregs, void __iomem *base, char *prefix)
352 static inline bool debugfs_initialized(void)
357 static inline struct dentry *debugfs_create_u32_array(const char *name, umode_t mode,
358 struct dentry *parent,
359 u32 *array, u32 elements)
361 return ERR_PTR(-ENODEV);
364 static inline struct dentry *debugfs_create_devm_seqfile(struct device *dev,
366 struct dentry *parent,
367 int (*read_fn)(struct seq_file *s,
370 return ERR_PTR(-ENODEV);
373 static inline ssize_t debugfs_read_file_bool(struct file *file,
374 char __user *user_buf,
375 size_t count, loff_t *ppos)
380 static inline ssize_t debugfs_write_file_bool(struct file *file,
381 const char __user *user_buf,
382 size_t count, loff_t *ppos)