Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * debugfs.h - a tiny little debug file system | |
3 | * | |
4 | * Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com> | |
5 | * Copyright (C) 2004 IBM Inc. | |
6 | * | |
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. | |
10 | * | |
11 | * debugfs is for people to use instead of /proc or /sys. | |
55dff495 | 12 | * See Documentation/DocBook/filesystems for more details. |
1da177e4 LT |
13 | */ |
14 | ||
15 | #ifndef _DEBUGFS_H_ | |
16 | #define _DEBUGFS_H_ | |
17 | ||
18 | #include <linux/fs.h> | |
1a087c6a | 19 | #include <linux/seq_file.h> |
1da177e4 | 20 | |
a7a76cef RD |
21 | #include <linux/types.h> |
22 | ||
f30d0a81 | 23 | struct device; |
a7a76cef RD |
24 | struct file_operations; |
25 | ||
dd308bc3 ME |
26 | struct debugfs_blob_wrapper { |
27 | void *data; | |
28 | unsigned long size; | |
29 | }; | |
30 | ||
1a087c6a AR |
31 | struct debugfs_reg32 { |
32 | char *name; | |
33 | unsigned long offset; | |
34 | }; | |
35 | ||
36 | struct debugfs_regset32 { | |
833d6e01 | 37 | const struct debugfs_reg32 *regs; |
1a087c6a AR |
38 | int nregs; |
39 | void __iomem *base; | |
40 | }; | |
41 | ||
ae79cdaa | 42 | extern struct dentry *arch_debugfs_dir; |
43 | ||
1da177e4 | 44 | #if defined(CONFIG_DEBUG_FS) |
3634634e HH |
45 | |
46 | /* declared over in file.c */ | |
47 | extern const struct file_operations debugfs_file_operations; | |
3634634e | 48 | |
f4ae40a6 | 49 | struct dentry *debugfs_create_file(const char *name, umode_t mode, |
1da177e4 | 50 | struct dentry *parent, void *data, |
99ac48f5 | 51 | const struct file_operations *fops); |
1da177e4 | 52 | |
e59b4e91 DH |
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, | |
56 | loff_t file_size); | |
57 | ||
1da177e4 LT |
58 | struct dentry *debugfs_create_dir(const char *name, struct dentry *parent); |
59 | ||
66f54963 PO |
60 | struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent, |
61 | const char *dest); | |
62 | ||
77b3da6e AV |
63 | struct dentry *debugfs_create_automount(const char *name, |
64 | struct dentry *parent, | |
65 | struct vfsmount *(*f)(void *), | |
66 | void *data); | |
67 | ||
1da177e4 | 68 | void debugfs_remove(struct dentry *dentry); |
9505e637 | 69 | void debugfs_remove_recursive(struct dentry *dentry); |
1da177e4 | 70 | |
cfc94cdf JK |
71 | struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry, |
72 | struct dentry *new_dir, const char *new_name); | |
73 | ||
f4ae40a6 | 74 | struct dentry *debugfs_create_u8(const char *name, umode_t mode, |
1da177e4 | 75 | struct dentry *parent, u8 *value); |
f4ae40a6 | 76 | struct dentry *debugfs_create_u16(const char *name, umode_t mode, |
1da177e4 | 77 | struct dentry *parent, u16 *value); |
f4ae40a6 | 78 | struct dentry *debugfs_create_u32(const char *name, umode_t mode, |
1da177e4 | 79 | struct dentry *parent, u32 *value); |
f4ae40a6 | 80 | struct dentry *debugfs_create_u64(const char *name, umode_t mode, |
8447891f | 81 | struct dentry *parent, u64 *value); |
f4ae40a6 | 82 | struct dentry *debugfs_create_x8(const char *name, umode_t mode, |
2ebefc50 | 83 | struct dentry *parent, u8 *value); |
f4ae40a6 | 84 | struct dentry *debugfs_create_x16(const char *name, umode_t mode, |
2ebefc50 | 85 | struct dentry *parent, u16 *value); |
f4ae40a6 | 86 | struct dentry *debugfs_create_x32(const char *name, umode_t mode, |
2ebefc50 | 87 | struct dentry *parent, u32 *value); |
f4ae40a6 | 88 | struct dentry *debugfs_create_x64(const char *name, umode_t mode, |
15b0beaa | 89 | struct dentry *parent, u64 *value); |
f4ae40a6 | 90 | struct dentry *debugfs_create_size_t(const char *name, umode_t mode, |
5e078787 | 91 | struct dentry *parent, size_t *value); |
3a76e5e0 SJ |
92 | struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode, |
93 | struct dentry *parent, atomic_t *value); | |
f4ae40a6 | 94 | struct dentry *debugfs_create_bool(const char *name, umode_t mode, |
1da177e4 LT |
95 | struct dentry *parent, u32 *value); |
96 | ||
f4ae40a6 | 97 | struct dentry *debugfs_create_blob(const char *name, umode_t mode, |
dd308bc3 ME |
98 | struct dentry *parent, |
99 | struct debugfs_blob_wrapper *blob); | |
c0f92ba9 | 100 | |
88187398 | 101 | struct dentry *debugfs_create_regset32(const char *name, umode_t mode, |
1a087c6a AR |
102 | struct dentry *parent, |
103 | struct debugfs_regset32 *regset); | |
104 | ||
9761536e JP |
105 | void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs, |
106 | int nregs, void __iomem *base, char *prefix); | |
1a087c6a | 107 | |
9fe2a701 SV |
108 | struct dentry *debugfs_create_u32_array(const char *name, umode_t mode, |
109 | struct dentry *parent, | |
110 | u32 *array, u32 elements); | |
111 | ||
98210b7f AS |
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, | |
115 | void *data)); | |
116 | ||
c0f92ba9 FW |
117 | bool debugfs_initialized(void); |
118 | ||
1da177e4 | 119 | #else |
a7a76cef RD |
120 | |
121 | #include <linux/err.h> | |
122 | ||
98210b7f | 123 | /* |
1da177e4 LT |
124 | * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled |
125 | * so users have a chance to detect if there was a real error or not. We don't | |
126 | * want to duplicate the design decision mistakes of procfs and devfs again. | |
127 | */ | |
128 | ||
f4ae40a6 | 129 | static inline struct dentry *debugfs_create_file(const char *name, umode_t mode, |
bde11d79 JD |
130 | struct dentry *parent, void *data, |
131 | const struct file_operations *fops) | |
1da177e4 LT |
132 | { |
133 | return ERR_PTR(-ENODEV); | |
134 | } | |
135 | ||
e59b4e91 DH |
136 | static inline struct dentry *debugfs_create_file_size(const char *name, umode_t mode, |
137 | struct dentry *parent, void *data, | |
138 | const struct file_operations *fops, | |
139 | loff_t file_size) | |
140 | { | |
141 | return ERR_PTR(-ENODEV); | |
142 | } | |
143 | ||
1da177e4 LT |
144 | static inline struct dentry *debugfs_create_dir(const char *name, |
145 | struct dentry *parent) | |
146 | { | |
147 | return ERR_PTR(-ENODEV); | |
148 | } | |
149 | ||
66f54963 PO |
150 | static inline struct dentry *debugfs_create_symlink(const char *name, |
151 | struct dentry *parent, | |
152 | const char *dest) | |
153 | { | |
154 | return ERR_PTR(-ENODEV); | |
155 | } | |
156 | ||
1da177e4 LT |
157 | static inline void debugfs_remove(struct dentry *dentry) |
158 | { } | |
159 | ||
9505e637 HS |
160 | static inline void debugfs_remove_recursive(struct dentry *dentry) |
161 | { } | |
162 | ||
cfc94cdf JK |
163 | static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry, |
164 | struct dentry *new_dir, char *new_name) | |
165 | { | |
166 | return ERR_PTR(-ENODEV); | |
167 | } | |
168 | ||
f4ae40a6 | 169 | static inline struct dentry *debugfs_create_u8(const char *name, umode_t mode, |
1da177e4 LT |
170 | struct dentry *parent, |
171 | u8 *value) | |
172 | { | |
173 | return ERR_PTR(-ENODEV); | |
174 | } | |
175 | ||
f4ae40a6 | 176 | static inline struct dentry *debugfs_create_u16(const char *name, umode_t mode, |
1da177e4 | 177 | struct dentry *parent, |
7b558637 | 178 | u16 *value) |
1da177e4 LT |
179 | { |
180 | return ERR_PTR(-ENODEV); | |
181 | } | |
182 | ||
f4ae40a6 | 183 | static inline struct dentry *debugfs_create_u32(const char *name, umode_t mode, |
1da177e4 | 184 | struct dentry *parent, |
7b558637 | 185 | u32 *value) |
1da177e4 LT |
186 | { |
187 | return ERR_PTR(-ENODEV); | |
188 | } | |
189 | ||
f4ae40a6 | 190 | static inline struct dentry *debugfs_create_u64(const char *name, umode_t mode, |
8447891f ME |
191 | struct dentry *parent, |
192 | u64 *value) | |
193 | { | |
194 | return ERR_PTR(-ENODEV); | |
195 | } | |
196 | ||
f4ae40a6 | 197 | static inline struct dentry *debugfs_create_x8(const char *name, umode_t mode, |
2ebefc50 RG |
198 | struct dentry *parent, |
199 | u8 *value) | |
200 | { | |
201 | return ERR_PTR(-ENODEV); | |
202 | } | |
203 | ||
f4ae40a6 | 204 | static inline struct dentry *debugfs_create_x16(const char *name, umode_t mode, |
2ebefc50 RG |
205 | struct dentry *parent, |
206 | u16 *value) | |
207 | { | |
208 | return ERR_PTR(-ENODEV); | |
209 | } | |
210 | ||
f4ae40a6 | 211 | static inline struct dentry *debugfs_create_x32(const char *name, umode_t mode, |
2ebefc50 RG |
212 | struct dentry *parent, |
213 | u32 *value) | |
214 | { | |
215 | return ERR_PTR(-ENODEV); | |
216 | } | |
217 | ||
3159269e JB |
218 | static inline struct dentry *debugfs_create_x64(const char *name, umode_t mode, |
219 | struct dentry *parent, | |
220 | u64 *value) | |
221 | { | |
222 | return ERR_PTR(-ENODEV); | |
223 | } | |
224 | ||
f4ae40a6 | 225 | static inline struct dentry *debugfs_create_size_t(const char *name, umode_t mode, |
8adb711f IPG |
226 | struct dentry *parent, |
227 | size_t *value) | |
228 | { | |
229 | return ERR_PTR(-ENODEV); | |
230 | } | |
231 | ||
5b880214 WY |
232 | static inline struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode, |
233 | struct dentry *parent, atomic_t *value) | |
234 | { | |
235 | return ERR_PTR(-ENODEV); | |
236 | } | |
237 | ||
f4ae40a6 | 238 | static inline struct dentry *debugfs_create_bool(const char *name, umode_t mode, |
1da177e4 | 239 | struct dentry *parent, |
7b558637 | 240 | u32 *value) |
1da177e4 LT |
241 | { |
242 | return ERR_PTR(-ENODEV); | |
243 | } | |
244 | ||
f4ae40a6 | 245 | static inline struct dentry *debugfs_create_blob(const char *name, umode_t mode, |
dd308bc3 ME |
246 | struct dentry *parent, |
247 | struct debugfs_blob_wrapper *blob) | |
248 | { | |
249 | return ERR_PTR(-ENODEV); | |
250 | } | |
251 | ||
1a087c6a | 252 | static inline struct dentry *debugfs_create_regset32(const char *name, |
88187398 | 253 | umode_t mode, struct dentry *parent, |
1a087c6a AR |
254 | struct debugfs_regset32 *regset) |
255 | { | |
256 | return ERR_PTR(-ENODEV); | |
257 | } | |
258 | ||
9761536e | 259 | static inline void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs, |
5b880214 WY |
260 | int nregs, void __iomem *base, char *prefix) |
261 | { | |
5b880214 WY |
262 | } |
263 | ||
c0f92ba9 FW |
264 | static inline bool debugfs_initialized(void) |
265 | { | |
266 | return false; | |
267 | } | |
268 | ||
9fe2a701 SV |
269 | static inline struct dentry *debugfs_create_u32_array(const char *name, umode_t mode, |
270 | struct dentry *parent, | |
271 | u32 *array, u32 elements) | |
272 | { | |
273 | return ERR_PTR(-ENODEV); | |
274 | } | |
275 | ||
98210b7f AS |
276 | static inline struct dentry *debugfs_create_devm_seqfile(struct device *dev, |
277 | const char *name, | |
278 | struct dentry *parent, | |
279 | int (*read_fn)(struct seq_file *s, | |
280 | void *data)) | |
281 | { | |
282 | return ERR_PTR(-ENODEV); | |
283 | } | |
284 | ||
1da177e4 LT |
285 | #endif |
286 | ||
287 | #endif |