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>
22 #include <linux/compiler.h>
25 struct file_operations
;
28 struct debugfs_blob_wrapper
{
33 struct debugfs_reg32
{
38 struct debugfs_regset32
{
39 const struct debugfs_reg32
*regs
;
44 extern struct dentry
*arch_debugfs_dir
;
46 extern struct srcu_struct debugfs_srcu
;
48 #if defined(CONFIG_DEBUG_FS)
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 struct dentry
*debugfs_create_file_unsafe(const char *name
, umode_t mode
,
54 struct dentry
*parent
, void *data
,
55 const struct file_operations
*fops
);
57 struct dentry
*debugfs_create_file_size(const char *name
, umode_t mode
,
58 struct dentry
*parent
, void *data
,
59 const struct file_operations
*fops
,
62 struct dentry
*debugfs_create_dir(const char *name
, struct dentry
*parent
);
64 struct dentry
*debugfs_create_symlink(const char *name
, struct dentry
*parent
,
67 struct dentry
*debugfs_create_automount(const char *name
,
68 struct dentry
*parent
,
69 struct vfsmount
*(*f
)(void *),
72 void debugfs_remove(struct dentry
*dentry
);
73 void debugfs_remove_recursive(struct dentry
*dentry
);
75 int debugfs_use_file_start(const struct dentry
*dentry
, int *srcu_idx
)
76 __acquires(&debugfs_srcu
);
78 void debugfs_use_file_finish(int srcu_idx
) __releases(&debugfs_srcu
);
80 ssize_t
debugfs_attr_read(struct file
*file
, char __user
*buf
,
81 size_t len
, loff_t
*ppos
);
82 ssize_t
debugfs_attr_write(struct file
*file
, const char __user
*buf
,
83 size_t len
, loff_t
*ppos
);
85 #define DEFINE_DEBUGFS_ATTRIBUTE(__fops, __get, __set, __fmt) \
86 static int __fops ## _open(struct inode *inode, struct file *file) \
88 __simple_attr_check_format(__fmt, 0ull); \
89 return simple_attr_open(inode, file, __get, __set, __fmt); \
91 static const struct file_operations __fops = { \
92 .owner = THIS_MODULE, \
93 .open = __fops ## _open, \
94 .release = simple_attr_release, \
95 .read = debugfs_attr_read, \
96 .write = debugfs_attr_write, \
97 .llseek = generic_file_llseek, \
100 struct dentry
*debugfs_rename(struct dentry
*old_dir
, struct dentry
*old_dentry
,
101 struct dentry
*new_dir
, const char *new_name
);
103 struct dentry
*debugfs_create_u8(const char *name
, umode_t mode
,
104 struct dentry
*parent
, u8
*value
);
105 struct dentry
*debugfs_create_u16(const char *name
, umode_t mode
,
106 struct dentry
*parent
, u16
*value
);
107 struct dentry
*debugfs_create_u32(const char *name
, umode_t mode
,
108 struct dentry
*parent
, u32
*value
);
109 struct dentry
*debugfs_create_u64(const char *name
, umode_t mode
,
110 struct dentry
*parent
, u64
*value
);
111 struct dentry
*debugfs_create_ulong(const char *name
, umode_t mode
,
112 struct dentry
*parent
, unsigned long *value
);
113 struct dentry
*debugfs_create_x8(const char *name
, umode_t mode
,
114 struct dentry
*parent
, u8
*value
);
115 struct dentry
*debugfs_create_x16(const char *name
, umode_t mode
,
116 struct dentry
*parent
, u16
*value
);
117 struct dentry
*debugfs_create_x32(const char *name
, umode_t mode
,
118 struct dentry
*parent
, u32
*value
);
119 struct dentry
*debugfs_create_x64(const char *name
, umode_t mode
,
120 struct dentry
*parent
, u64
*value
);
121 struct dentry
*debugfs_create_size_t(const char *name
, umode_t mode
,
122 struct dentry
*parent
, size_t *value
);
123 struct dentry
*debugfs_create_atomic_t(const char *name
, umode_t mode
,
124 struct dentry
*parent
, atomic_t
*value
);
125 struct dentry
*debugfs_create_bool(const char *name
, umode_t mode
,
126 struct dentry
*parent
, bool *value
);
128 struct dentry
*debugfs_create_blob(const char *name
, umode_t mode
,
129 struct dentry
*parent
,
130 struct debugfs_blob_wrapper
*blob
);
132 struct dentry
*debugfs_create_regset32(const char *name
, umode_t mode
,
133 struct dentry
*parent
,
134 struct debugfs_regset32
*regset
);
136 void debugfs_print_regs32(struct seq_file
*s
, const struct debugfs_reg32
*regs
,
137 int nregs
, void __iomem
*base
, char *prefix
);
139 struct dentry
*debugfs_create_u32_array(const char *name
, umode_t mode
,
140 struct dentry
*parent
,
141 u32
*array
, u32 elements
);
143 struct dentry
*debugfs_create_devm_seqfile(struct device
*dev
, const char *name
,
144 struct dentry
*parent
,
145 int (*read_fn
)(struct seq_file
*s
,
148 bool debugfs_initialized(void);
150 ssize_t
debugfs_read_file_bool(struct file
*file
, char __user
*user_buf
,
151 size_t count
, loff_t
*ppos
);
153 ssize_t
debugfs_write_file_bool(struct file
*file
, const char __user
*user_buf
,
154 size_t count
, loff_t
*ppos
);
158 #include <linux/err.h>
161 * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
162 * so users have a chance to detect if there was a real error or not. We don't
163 * want to duplicate the design decision mistakes of procfs and devfs again.
166 static inline struct dentry
*debugfs_create_file(const char *name
, umode_t mode
,
167 struct dentry
*parent
, void *data
,
168 const struct file_operations
*fops
)
170 return ERR_PTR(-ENODEV
);
173 static inline struct dentry
*debugfs_create_file_size(const char *name
, umode_t mode
,
174 struct dentry
*parent
, void *data
,
175 const struct file_operations
*fops
,
178 return ERR_PTR(-ENODEV
);
181 static inline struct dentry
*debugfs_create_dir(const char *name
,
182 struct dentry
*parent
)
184 return ERR_PTR(-ENODEV
);
187 static inline struct dentry
*debugfs_create_symlink(const char *name
,
188 struct dentry
*parent
,
191 return ERR_PTR(-ENODEV
);
194 static inline struct dentry
*debugfs_create_automount(const char *name
,
195 struct dentry
*parent
,
196 struct vfsmount
*(*f
)(void *),
199 return ERR_PTR(-ENODEV
);
202 static inline void debugfs_remove(struct dentry
*dentry
)
205 static inline void debugfs_remove_recursive(struct dentry
*dentry
)
208 static inline int debugfs_use_file_start(const struct dentry
*dentry
,
210 __acquires(&debugfs_srcu
)
215 static inline void debugfs_use_file_finish(int srcu_idx
)
216 __releases(&debugfs_srcu
)
219 #define DEFINE_DEBUGFS_ATTRIBUTE(__fops, __get, __set, __fmt) \
220 static const struct file_operations __fops = { 0 }
222 static inline struct dentry
*debugfs_rename(struct dentry
*old_dir
, struct dentry
*old_dentry
,
223 struct dentry
*new_dir
, char *new_name
)
225 return ERR_PTR(-ENODEV
);
228 static inline struct dentry
*debugfs_create_u8(const char *name
, umode_t mode
,
229 struct dentry
*parent
,
232 return ERR_PTR(-ENODEV
);
235 static inline struct dentry
*debugfs_create_u16(const char *name
, umode_t mode
,
236 struct dentry
*parent
,
239 return ERR_PTR(-ENODEV
);
242 static inline struct dentry
*debugfs_create_u32(const char *name
, umode_t mode
,
243 struct dentry
*parent
,
246 return ERR_PTR(-ENODEV
);
249 static inline struct dentry
*debugfs_create_u64(const char *name
, umode_t mode
,
250 struct dentry
*parent
,
253 return ERR_PTR(-ENODEV
);
256 static inline struct dentry
*debugfs_create_x8(const char *name
, umode_t mode
,
257 struct dentry
*parent
,
260 return ERR_PTR(-ENODEV
);
263 static inline struct dentry
*debugfs_create_x16(const char *name
, umode_t mode
,
264 struct dentry
*parent
,
267 return ERR_PTR(-ENODEV
);
270 static inline struct dentry
*debugfs_create_x32(const char *name
, umode_t mode
,
271 struct dentry
*parent
,
274 return ERR_PTR(-ENODEV
);
277 static inline struct dentry
*debugfs_create_x64(const char *name
, umode_t mode
,
278 struct dentry
*parent
,
281 return ERR_PTR(-ENODEV
);
284 static inline struct dentry
*debugfs_create_size_t(const char *name
, umode_t mode
,
285 struct dentry
*parent
,
288 return ERR_PTR(-ENODEV
);
291 static inline struct dentry
*debugfs_create_atomic_t(const char *name
, umode_t mode
,
292 struct dentry
*parent
, atomic_t
*value
)
294 return ERR_PTR(-ENODEV
);
297 static inline struct dentry
*debugfs_create_bool(const char *name
, umode_t mode
,
298 struct dentry
*parent
,
301 return ERR_PTR(-ENODEV
);
304 static inline struct dentry
*debugfs_create_blob(const char *name
, umode_t mode
,
305 struct dentry
*parent
,
306 struct debugfs_blob_wrapper
*blob
)
308 return ERR_PTR(-ENODEV
);
311 static inline struct dentry
*debugfs_create_regset32(const char *name
,
312 umode_t mode
, struct dentry
*parent
,
313 struct debugfs_regset32
*regset
)
315 return ERR_PTR(-ENODEV
);
318 static inline void debugfs_print_regs32(struct seq_file
*s
, const struct debugfs_reg32
*regs
,
319 int nregs
, void __iomem
*base
, char *prefix
)
323 static inline bool debugfs_initialized(void)
328 static inline struct dentry
*debugfs_create_u32_array(const char *name
, umode_t mode
,
329 struct dentry
*parent
,
330 u32
*array
, u32 elements
)
332 return ERR_PTR(-ENODEV
);
335 static inline struct dentry
*debugfs_create_devm_seqfile(struct device
*dev
,
337 struct dentry
*parent
,
338 int (*read_fn
)(struct seq_file
*s
,
341 return ERR_PTR(-ENODEV
);
344 static inline ssize_t
debugfs_read_file_bool(struct file
*file
,
345 char __user
*user_buf
,
346 size_t count
, loff_t
*ppos
)
351 static inline ssize_t
debugfs_write_file_bool(struct file
*file
,
352 const char __user
*user_buf
,
353 size_t count
, loff_t
*ppos
)