]>
git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blob - include/linux/debugfs.h
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 #if defined(CONFIG_DEBUG_FS)
59 struct dentry
*debugfs_lookup(const char *name
, struct dentry
*parent
);
61 struct dentry
*debugfs_create_file(const char *name
, umode_t mode
,
62 struct dentry
*parent
, void *data
,
63 const struct file_operations
*fops
);
64 struct dentry
*debugfs_create_file_unsafe(const char *name
, umode_t mode
,
65 struct dentry
*parent
, void *data
,
66 const struct file_operations
*fops
);
68 struct dentry
*debugfs_create_file_size(const char *name
, umode_t mode
,
69 struct dentry
*parent
, void *data
,
70 const struct file_operations
*fops
,
73 struct dentry
*debugfs_create_dir(const char *name
, struct dentry
*parent
);
75 struct dentry
*debugfs_create_symlink(const char *name
, struct dentry
*parent
,
78 typedef struct vfsmount
*(*debugfs_automount_t
)(struct dentry
*, void *);
79 struct dentry
*debugfs_create_automount(const char *name
,
80 struct dentry
*parent
,
81 debugfs_automount_t f
,
84 void debugfs_remove(struct dentry
*dentry
);
85 void debugfs_remove_recursive(struct dentry
*dentry
);
87 const struct file_operations
*debugfs_real_fops(const struct file
*filp
);
89 int debugfs_file_get(struct dentry
*dentry
);
90 void debugfs_file_put(struct dentry
*dentry
);
92 ssize_t
debugfs_attr_read(struct file
*file
, char __user
*buf
,
93 size_t len
, loff_t
*ppos
);
94 ssize_t
debugfs_attr_write(struct file
*file
, const char __user
*buf
,
95 size_t len
, loff_t
*ppos
);
97 struct dentry
*debugfs_rename(struct dentry
*old_dir
, struct dentry
*old_dentry
,
98 struct dentry
*new_dir
, const char *new_name
);
100 struct dentry
*debugfs_create_u8(const char *name
, umode_t mode
,
101 struct dentry
*parent
, u8
*value
);
102 struct dentry
*debugfs_create_u16(const char *name
, umode_t mode
,
103 struct dentry
*parent
, u16
*value
);
104 struct dentry
*debugfs_create_u32(const char *name
, umode_t mode
,
105 struct dentry
*parent
, u32
*value
);
106 struct dentry
*debugfs_create_u64(const char *name
, umode_t mode
,
107 struct dentry
*parent
, u64
*value
);
108 struct dentry
*debugfs_create_ulong(const char *name
, umode_t mode
,
109 struct dentry
*parent
, unsigned long *value
);
110 struct dentry
*debugfs_create_x8(const char *name
, umode_t mode
,
111 struct dentry
*parent
, u8
*value
);
112 struct dentry
*debugfs_create_x16(const char *name
, umode_t mode
,
113 struct dentry
*parent
, u16
*value
);
114 struct dentry
*debugfs_create_x32(const char *name
, umode_t mode
,
115 struct dentry
*parent
, u32
*value
);
116 struct dentry
*debugfs_create_x64(const char *name
, umode_t mode
,
117 struct dentry
*parent
, u64
*value
);
118 struct dentry
*debugfs_create_size_t(const char *name
, umode_t mode
,
119 struct dentry
*parent
, size_t *value
);
120 struct dentry
*debugfs_create_atomic_t(const char *name
, umode_t mode
,
121 struct dentry
*parent
, atomic_t
*value
);
122 struct dentry
*debugfs_create_bool(const char *name
, umode_t mode
,
123 struct dentry
*parent
, bool *value
);
125 struct dentry
*debugfs_create_blob(const char *name
, umode_t mode
,
126 struct dentry
*parent
,
127 struct debugfs_blob_wrapper
*blob
);
129 struct dentry
*debugfs_create_regset32(const char *name
, umode_t mode
,
130 struct dentry
*parent
,
131 struct debugfs_regset32
*regset
);
133 void debugfs_print_regs32(struct seq_file
*s
, const struct debugfs_reg32
*regs
,
134 int nregs
, void __iomem
*base
, char *prefix
);
136 void debugfs_create_u32_array(const char *name
, umode_t mode
,
137 struct dentry
*parent
, u32
*array
, u32 elements
);
139 struct dentry
*debugfs_create_devm_seqfile(struct device
*dev
, const char *name
,
140 struct dentry
*parent
,
141 int (*read_fn
)(struct seq_file
*s
,
144 bool debugfs_initialized(void);
146 ssize_t
debugfs_read_file_bool(struct file
*file
, char __user
*user_buf
,
147 size_t count
, loff_t
*ppos
);
149 ssize_t
debugfs_write_file_bool(struct file
*file
, const char __user
*user_buf
,
150 size_t count
, loff_t
*ppos
);
154 #include <linux/err.h>
157 * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
158 * so users have a chance to detect if there was a real error or not. We don't
159 * want to duplicate the design decision mistakes of procfs and devfs again.
162 static inline struct dentry
*debugfs_lookup(const char *name
,
163 struct dentry
*parent
)
165 return ERR_PTR(-ENODEV
);
168 static inline struct dentry
*debugfs_create_file(const char *name
, umode_t mode
,
169 struct dentry
*parent
, void *data
,
170 const struct file_operations
*fops
)
172 return ERR_PTR(-ENODEV
);
175 static inline struct dentry
*debugfs_create_file_unsafe(const char *name
,
176 umode_t mode
, struct dentry
*parent
,
178 const struct file_operations
*fops
)
180 return ERR_PTR(-ENODEV
);
183 static inline struct dentry
*debugfs_create_file_size(const char *name
, umode_t mode
,
184 struct dentry
*parent
, void *data
,
185 const struct file_operations
*fops
,
188 return ERR_PTR(-ENODEV
);
191 static inline struct dentry
*debugfs_create_dir(const char *name
,
192 struct dentry
*parent
)
194 return ERR_PTR(-ENODEV
);
197 static inline struct dentry
*debugfs_create_symlink(const char *name
,
198 struct dentry
*parent
,
201 return ERR_PTR(-ENODEV
);
204 static inline struct dentry
*debugfs_create_automount(const char *name
,
205 struct dentry
*parent
,
206 struct vfsmount
*(*f
)(void *),
209 return ERR_PTR(-ENODEV
);
212 static inline void debugfs_remove(struct dentry
*dentry
)
215 static inline void debugfs_remove_recursive(struct dentry
*dentry
)
218 const struct file_operations
*debugfs_real_fops(const struct file
*filp
);
220 static inline int debugfs_file_get(struct dentry
*dentry
)
225 static inline void debugfs_file_put(struct dentry
*dentry
)
228 static inline ssize_t
debugfs_attr_read(struct file
*file
, char __user
*buf
,
229 size_t len
, loff_t
*ppos
)
234 static inline ssize_t
debugfs_attr_write(struct file
*file
,
235 const char __user
*buf
,
236 size_t len
, loff_t
*ppos
)
241 static inline struct dentry
*debugfs_rename(struct dentry
*old_dir
, struct dentry
*old_dentry
,
242 struct dentry
*new_dir
, char *new_name
)
244 return ERR_PTR(-ENODEV
);
247 static inline struct dentry
*debugfs_create_u8(const char *name
, umode_t mode
,
248 struct dentry
*parent
,
251 return ERR_PTR(-ENODEV
);
254 static inline struct dentry
*debugfs_create_u16(const char *name
, umode_t mode
,
255 struct dentry
*parent
,
258 return ERR_PTR(-ENODEV
);
261 static inline struct dentry
*debugfs_create_u32(const char *name
, umode_t mode
,
262 struct dentry
*parent
,
265 return ERR_PTR(-ENODEV
);
268 static inline struct dentry
*debugfs_create_u64(const char *name
, umode_t mode
,
269 struct dentry
*parent
,
272 return ERR_PTR(-ENODEV
);
275 static inline struct dentry
*debugfs_create_ulong(const char *name
,
277 struct dentry
*parent
,
278 unsigned long *value
)
280 return ERR_PTR(-ENODEV
);
283 static inline struct dentry
*debugfs_create_x8(const char *name
, umode_t mode
,
284 struct dentry
*parent
,
287 return ERR_PTR(-ENODEV
);
290 static inline struct dentry
*debugfs_create_x16(const char *name
, umode_t mode
,
291 struct dentry
*parent
,
294 return ERR_PTR(-ENODEV
);
297 static inline struct dentry
*debugfs_create_x32(const char *name
, umode_t mode
,
298 struct dentry
*parent
,
301 return ERR_PTR(-ENODEV
);
304 static inline struct dentry
*debugfs_create_x64(const char *name
, umode_t mode
,
305 struct dentry
*parent
,
308 return ERR_PTR(-ENODEV
);
311 static inline struct dentry
*debugfs_create_size_t(const char *name
, umode_t mode
,
312 struct dentry
*parent
,
315 return ERR_PTR(-ENODEV
);
318 static inline struct dentry
*debugfs_create_atomic_t(const char *name
, umode_t mode
,
319 struct dentry
*parent
, atomic_t
*value
)
321 return ERR_PTR(-ENODEV
);
324 static inline struct dentry
*debugfs_create_bool(const char *name
, umode_t mode
,
325 struct dentry
*parent
,
328 return ERR_PTR(-ENODEV
);
331 static inline struct dentry
*debugfs_create_blob(const char *name
, umode_t mode
,
332 struct dentry
*parent
,
333 struct debugfs_blob_wrapper
*blob
)
335 return ERR_PTR(-ENODEV
);
338 static inline struct dentry
*debugfs_create_regset32(const char *name
,
339 umode_t mode
, struct dentry
*parent
,
340 struct debugfs_regset32
*regset
)
342 return ERR_PTR(-ENODEV
);
345 static inline void debugfs_print_regs32(struct seq_file
*s
, const struct debugfs_reg32
*regs
,
346 int nregs
, void __iomem
*base
, char *prefix
)
350 static inline bool debugfs_initialized(void)
355 static inline void debugfs_create_u32_array(const char *name
, umode_t mode
,
356 struct dentry
*parent
, u32
*array
,
361 static inline struct dentry
*debugfs_create_devm_seqfile(struct device
*dev
,
363 struct dentry
*parent
,
364 int (*read_fn
)(struct seq_file
*s
,
367 return ERR_PTR(-ENODEV
);
370 static inline ssize_t
debugfs_read_file_bool(struct file
*file
,
371 char __user
*user_buf
,
372 size_t count
, loff_t
*ppos
)
377 static inline ssize_t
debugfs_write_file_bool(struct file
*file
,
378 const char __user
*user_buf
,
379 size_t count
, loff_t
*ppos
)