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
;
49 struct dentry
*debugfs_create_file(const char *name
, umode_t mode
,
50 struct dentry
*parent
, void *data
,
51 const struct file_operations
*fops
);
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
,
58 struct dentry
*debugfs_create_dir(const char *name
, struct dentry
*parent
);
60 struct dentry
*debugfs_create_symlink(const char *name
, struct dentry
*parent
,
63 struct dentry
*debugfs_create_automount(const char *name
,
64 struct dentry
*parent
,
65 struct vfsmount
*(*f
)(void *),
68 void debugfs_remove(struct dentry
*dentry
);
69 void debugfs_remove_recursive(struct dentry
*dentry
);
71 struct dentry
*debugfs_rename(struct dentry
*old_dir
, struct dentry
*old_dentry
,
72 struct dentry
*new_dir
, const char *new_name
);
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_x8(const char *name
, umode_t mode
,
83 struct dentry
*parent
, u8
*value
);
84 struct dentry
*debugfs_create_x16(const char *name
, umode_t mode
,
85 struct dentry
*parent
, u16
*value
);
86 struct dentry
*debugfs_create_x32(const char *name
, umode_t mode
,
87 struct dentry
*parent
, u32
*value
);
88 struct dentry
*debugfs_create_x64(const char *name
, umode_t mode
,
89 struct dentry
*parent
, u64
*value
);
90 struct dentry
*debugfs_create_size_t(const char *name
, umode_t mode
,
91 struct dentry
*parent
, size_t *value
);
92 struct dentry
*debugfs_create_atomic_t(const char *name
, umode_t mode
,
93 struct dentry
*parent
, atomic_t
*value
);
94 struct dentry
*debugfs_create_bool(const char *name
, umode_t mode
,
95 struct dentry
*parent
, u32
*value
);
97 struct dentry
*debugfs_create_blob(const char *name
, umode_t mode
,
98 struct dentry
*parent
,
99 struct debugfs_blob_wrapper
*blob
);
101 struct dentry
*debugfs_create_regset32(const char *name
, umode_t mode
,
102 struct dentry
*parent
,
103 struct debugfs_regset32
*regset
);
105 void debugfs_print_regs32(struct seq_file
*s
, const struct debugfs_reg32
*regs
,
106 int nregs
, void __iomem
*base
, char *prefix
);
108 struct dentry
*debugfs_create_u32_array(const char *name
, umode_t mode
,
109 struct dentry
*parent
,
110 u32
*array
, u32 elements
);
112 struct dentry
*debugfs_create_devm_seqfile(struct device
*dev
, const char *name
,
113 struct dentry
*parent
,
114 int (*read_fn
)(struct seq_file
*s
,
117 bool debugfs_initialized(void);
119 ssize_t
debugfs_read_file_bool(struct file
*file
, char __user
*user_buf
,
120 size_t count
, loff_t
*ppos
);
122 ssize_t
debugfs_write_file_bool(struct file
*file
, const char __user
*user_buf
,
123 size_t count
, loff_t
*ppos
);
127 #include <linux/err.h>
130 * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
131 * so users have a chance to detect if there was a real error or not. We don't
132 * want to duplicate the design decision mistakes of procfs and devfs again.
135 static inline struct dentry
*debugfs_create_file(const char *name
, umode_t mode
,
136 struct dentry
*parent
, void *data
,
137 const struct file_operations
*fops
)
139 return ERR_PTR(-ENODEV
);
142 static inline struct dentry
*debugfs_create_file_size(const char *name
, umode_t mode
,
143 struct dentry
*parent
, void *data
,
144 const struct file_operations
*fops
,
147 return ERR_PTR(-ENODEV
);
150 static inline struct dentry
*debugfs_create_dir(const char *name
,
151 struct dentry
*parent
)
153 return ERR_PTR(-ENODEV
);
156 static inline struct dentry
*debugfs_create_symlink(const char *name
,
157 struct dentry
*parent
,
160 return ERR_PTR(-ENODEV
);
163 static inline void debugfs_remove(struct dentry
*dentry
)
166 static inline void debugfs_remove_recursive(struct dentry
*dentry
)
169 static inline struct dentry
*debugfs_rename(struct dentry
*old_dir
, struct dentry
*old_dentry
,
170 struct dentry
*new_dir
, char *new_name
)
172 return ERR_PTR(-ENODEV
);
175 static inline struct dentry
*debugfs_create_u8(const char *name
, umode_t mode
,
176 struct dentry
*parent
,
179 return ERR_PTR(-ENODEV
);
182 static inline struct dentry
*debugfs_create_u16(const char *name
, umode_t mode
,
183 struct dentry
*parent
,
186 return ERR_PTR(-ENODEV
);
189 static inline struct dentry
*debugfs_create_u32(const char *name
, umode_t mode
,
190 struct dentry
*parent
,
193 return ERR_PTR(-ENODEV
);
196 static inline struct dentry
*debugfs_create_u64(const char *name
, umode_t mode
,
197 struct dentry
*parent
,
200 return ERR_PTR(-ENODEV
);
203 static inline struct dentry
*debugfs_create_x8(const char *name
, umode_t mode
,
204 struct dentry
*parent
,
207 return ERR_PTR(-ENODEV
);
210 static inline struct dentry
*debugfs_create_x16(const char *name
, umode_t mode
,
211 struct dentry
*parent
,
214 return ERR_PTR(-ENODEV
);
217 static inline struct dentry
*debugfs_create_x32(const char *name
, umode_t mode
,
218 struct dentry
*parent
,
221 return ERR_PTR(-ENODEV
);
224 static inline struct dentry
*debugfs_create_x64(const char *name
, umode_t mode
,
225 struct dentry
*parent
,
228 return ERR_PTR(-ENODEV
);
231 static inline struct dentry
*debugfs_create_size_t(const char *name
, umode_t mode
,
232 struct dentry
*parent
,
235 return ERR_PTR(-ENODEV
);
238 static inline struct dentry
*debugfs_create_atomic_t(const char *name
, umode_t mode
,
239 struct dentry
*parent
, atomic_t
*value
)
241 return ERR_PTR(-ENODEV
);
244 static inline struct dentry
*debugfs_create_bool(const char *name
, umode_t mode
,
245 struct dentry
*parent
,
248 return ERR_PTR(-ENODEV
);
251 static inline struct dentry
*debugfs_create_blob(const char *name
, umode_t mode
,
252 struct dentry
*parent
,
253 struct debugfs_blob_wrapper
*blob
)
255 return ERR_PTR(-ENODEV
);
258 static inline struct dentry
*debugfs_create_regset32(const char *name
,
259 umode_t mode
, struct dentry
*parent
,
260 struct debugfs_regset32
*regset
)
262 return ERR_PTR(-ENODEV
);
265 static inline void debugfs_print_regs32(struct seq_file
*s
, const struct debugfs_reg32
*regs
,
266 int nregs
, void __iomem
*base
, char *prefix
)
270 static inline bool debugfs_initialized(void)
275 static inline struct dentry
*debugfs_create_u32_array(const char *name
, umode_t mode
,
276 struct dentry
*parent
,
277 u32
*array
, u32 elements
)
279 return ERR_PTR(-ENODEV
);
282 static inline struct dentry
*debugfs_create_devm_seqfile(struct device
*dev
,
284 struct dentry
*parent
,
285 int (*read_fn
)(struct seq_file
*s
,
288 return ERR_PTR(-ENODEV
);
291 static inline ssize_t
debugfs_read_file_bool(struct file
*file
,
292 char __user
*user_buf
,
293 size_t count
, loff_t
*ppos
)
298 static inline ssize_t
debugfs_write_file_bool(struct file
*file
,
299 const char __user
*user_buf
,
300 size_t count
, loff_t
*ppos
)