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. | |
e1b4fc7a | 12 | * See Documentation/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 | 21 | #include <linux/types.h> |
49d200de | 22 | #include <linux/compiler.h> |
a7a76cef | 23 | |
f30d0a81 | 24 | struct device; |
a7a76cef RD |
25 | struct file_operations; |
26 | ||
dd308bc3 ME |
27 | struct debugfs_blob_wrapper { |
28 | void *data; | |
29 | unsigned long size; | |
30 | }; | |
31 | ||
1a087c6a AR |
32 | struct debugfs_reg32 { |
33 | char *name; | |
34 | unsigned long offset; | |
35 | }; | |
36 | ||
37 | struct debugfs_regset32 { | |
833d6e01 | 38 | const struct debugfs_reg32 *regs; |
1a087c6a AR |
39 | int nregs; |
40 | void __iomem *base; | |
41 | }; | |
42 | ||
ae79cdaa | 43 | extern struct dentry *arch_debugfs_dir; |
44 | ||
7f847dd3 AB |
45 | #define DEFINE_DEBUGFS_ATTRIBUTE(__fops, __get, __set, __fmt) \ |
46 | static int __fops ## _open(struct inode *inode, struct file *file) \ | |
47 | { \ | |
48 | __simple_attr_check_format(__fmt, 0ull); \ | |
49 | return simple_attr_open(inode, file, __get, __set, __fmt); \ | |
50 | } \ | |
51 | static const struct file_operations __fops = { \ | |
52 | .owner = THIS_MODULE, \ | |
53 | .open = __fops ## _open, \ | |
54 | .release = simple_attr_release, \ | |
55 | .read = debugfs_attr_read, \ | |
56 | .write = debugfs_attr_write, \ | |
895ce6c8 | 57 | .llseek = no_llseek, \ |
7f847dd3 AB |
58 | } |
59 | ||
1da177e4 | 60 | #if defined(CONFIG_DEBUG_FS) |
3634634e | 61 | |
a7c5437b OS |
62 | struct dentry *debugfs_lookup(const char *name, struct dentry *parent); |
63 | ||
f4ae40a6 | 64 | struct dentry *debugfs_create_file(const char *name, umode_t mode, |
1da177e4 | 65 | struct dentry *parent, void *data, |
99ac48f5 | 66 | const struct file_operations *fops); |
c6468808 NS |
67 | struct dentry *debugfs_create_file_unsafe(const char *name, umode_t mode, |
68 | struct dentry *parent, void *data, | |
69 | const struct file_operations *fops); | |
1da177e4 | 70 | |
e59b4e91 DH |
71 | struct dentry *debugfs_create_file_size(const char *name, umode_t mode, |
72 | struct dentry *parent, void *data, | |
73 | const struct file_operations *fops, | |
74 | loff_t file_size); | |
75 | ||
1da177e4 LT |
76 | struct dentry *debugfs_create_dir(const char *name, struct dentry *parent); |
77 | ||
66f54963 PO |
78 | struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent, |
79 | const char *dest); | |
80 | ||
93faccbb | 81 | typedef struct vfsmount *(*debugfs_automount_t)(struct dentry *, void *); |
77b3da6e AV |
82 | struct dentry *debugfs_create_automount(const char *name, |
83 | struct dentry *parent, | |
93faccbb | 84 | debugfs_automount_t f, |
77b3da6e AV |
85 | void *data); |
86 | ||
1da177e4 | 87 | void debugfs_remove(struct dentry *dentry); |
9505e637 | 88 | void debugfs_remove_recursive(struct dentry *dentry); |
1da177e4 | 89 | |
055ab8e3 | 90 | const struct file_operations *debugfs_real_fops(const struct file *filp); |
7c8d4698 | 91 | |
e9117a5a NS |
92 | int debugfs_file_get(struct dentry *dentry); |
93 | void debugfs_file_put(struct dentry *dentry); | |
94 | ||
c6468808 NS |
95 | ssize_t debugfs_attr_read(struct file *file, char __user *buf, |
96 | size_t len, loff_t *ppos); | |
97 | ssize_t debugfs_attr_write(struct file *file, const char __user *buf, | |
98 | size_t len, loff_t *ppos); | |
99 | ||
cfc94cdf JK |
100 | struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry, |
101 | struct dentry *new_dir, const char *new_name); | |
102 | ||
f4ae40a6 | 103 | struct dentry *debugfs_create_u8(const char *name, umode_t mode, |
1da177e4 | 104 | struct dentry *parent, u8 *value); |
f4ae40a6 | 105 | struct dentry *debugfs_create_u16(const char *name, umode_t mode, |
1da177e4 | 106 | struct dentry *parent, u16 *value); |
f4ae40a6 | 107 | struct dentry *debugfs_create_u32(const char *name, umode_t mode, |
1da177e4 | 108 | struct dentry *parent, u32 *value); |
f4ae40a6 | 109 | struct dentry *debugfs_create_u64(const char *name, umode_t mode, |
8447891f | 110 | struct dentry *parent, u64 *value); |
c23fe831 VK |
111 | struct dentry *debugfs_create_ulong(const char *name, umode_t mode, |
112 | struct dentry *parent, unsigned long *value); | |
f4ae40a6 | 113 | struct dentry *debugfs_create_x8(const char *name, umode_t mode, |
2ebefc50 | 114 | struct dentry *parent, u8 *value); |
f4ae40a6 | 115 | struct dentry *debugfs_create_x16(const char *name, umode_t mode, |
2ebefc50 | 116 | struct dentry *parent, u16 *value); |
f4ae40a6 | 117 | struct dentry *debugfs_create_x32(const char *name, umode_t mode, |
2ebefc50 | 118 | struct dentry *parent, u32 *value); |
f4ae40a6 | 119 | struct dentry *debugfs_create_x64(const char *name, umode_t mode, |
15b0beaa | 120 | struct dentry *parent, u64 *value); |
f4ae40a6 | 121 | struct dentry *debugfs_create_size_t(const char *name, umode_t mode, |
5e078787 | 122 | struct dentry *parent, size_t *value); |
3a76e5e0 SJ |
123 | struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode, |
124 | struct dentry *parent, atomic_t *value); | |
f4ae40a6 | 125 | struct dentry *debugfs_create_bool(const char *name, umode_t mode, |
621a5f7a | 126 | struct dentry *parent, bool *value); |
1da177e4 | 127 | |
f4ae40a6 | 128 | struct dentry *debugfs_create_blob(const char *name, umode_t mode, |
dd308bc3 ME |
129 | struct dentry *parent, |
130 | struct debugfs_blob_wrapper *blob); | |
c0f92ba9 | 131 | |
88187398 | 132 | struct dentry *debugfs_create_regset32(const char *name, umode_t mode, |
1a087c6a AR |
133 | struct dentry *parent, |
134 | struct debugfs_regset32 *regset); | |
135 | ||
9761536e JP |
136 | void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs, |
137 | int nregs, void __iomem *base, char *prefix); | |
1a087c6a | 138 | |
9fe2a701 SV |
139 | struct dentry *debugfs_create_u32_array(const char *name, umode_t mode, |
140 | struct dentry *parent, | |
141 | u32 *array, u32 elements); | |
142 | ||
98210b7f AS |
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, | |
146 | void *data)); | |
147 | ||
c0f92ba9 FW |
148 | bool debugfs_initialized(void); |
149 | ||
0642ef6f RF |
150 | ssize_t debugfs_read_file_bool(struct file *file, char __user *user_buf, |
151 | size_t count, loff_t *ppos); | |
152 | ||
153 | ssize_t debugfs_write_file_bool(struct file *file, const char __user *user_buf, | |
154 | size_t count, loff_t *ppos); | |
155 | ||
1da177e4 | 156 | #else |
a7a76cef RD |
157 | |
158 | #include <linux/err.h> | |
159 | ||
98210b7f | 160 | /* |
1da177e4 LT |
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. | |
164 | */ | |
165 | ||
a7c5437b OS |
166 | static inline struct dentry *debugfs_lookup(const char *name, |
167 | struct dentry *parent) | |
168 | { | |
169 | return ERR_PTR(-ENODEV); | |
170 | } | |
171 | ||
f4ae40a6 | 172 | static inline struct dentry *debugfs_create_file(const char *name, umode_t mode, |
bde11d79 JD |
173 | struct dentry *parent, void *data, |
174 | const struct file_operations *fops) | |
1da177e4 LT |
175 | { |
176 | return ERR_PTR(-ENODEV); | |
177 | } | |
178 | ||
c2a737eb VK |
179 | static inline struct dentry *debugfs_create_file_unsafe(const char *name, |
180 | umode_t mode, struct dentry *parent, | |
181 | void *data, | |
182 | const struct file_operations *fops) | |
183 | { | |
184 | return ERR_PTR(-ENODEV); | |
185 | } | |
186 | ||
e59b4e91 DH |
187 | static inline struct dentry *debugfs_create_file_size(const char *name, umode_t mode, |
188 | struct dentry *parent, void *data, | |
189 | const struct file_operations *fops, | |
190 | loff_t file_size) | |
191 | { | |
192 | return ERR_PTR(-ENODEV); | |
193 | } | |
194 | ||
1da177e4 LT |
195 | static inline struct dentry *debugfs_create_dir(const char *name, |
196 | struct dentry *parent) | |
197 | { | |
198 | return ERR_PTR(-ENODEV); | |
199 | } | |
200 | ||
66f54963 PO |
201 | static inline struct dentry *debugfs_create_symlink(const char *name, |
202 | struct dentry *parent, | |
203 | const char *dest) | |
204 | { | |
205 | return ERR_PTR(-ENODEV); | |
206 | } | |
207 | ||
94e1dec7 JW |
208 | static inline struct dentry *debugfs_create_automount(const char *name, |
209 | struct dentry *parent, | |
210 | struct vfsmount *(*f)(void *), | |
211 | void *data) | |
212 | { | |
213 | return ERR_PTR(-ENODEV); | |
214 | } | |
215 | ||
1da177e4 LT |
216 | static inline void debugfs_remove(struct dentry *dentry) |
217 | { } | |
218 | ||
9505e637 HS |
219 | static inline void debugfs_remove_recursive(struct dentry *dentry) |
220 | { } | |
221 | ||
e9117a5a NS |
222 | static inline int debugfs_file_get(struct dentry *dentry) |
223 | { | |
224 | return 0; | |
225 | } | |
226 | ||
227 | static inline void debugfs_file_put(struct dentry *dentry) | |
228 | { } | |
229 | ||
7f847dd3 AB |
230 | static inline ssize_t debugfs_attr_read(struct file *file, char __user *buf, |
231 | size_t len, loff_t *ppos) | |
232 | { | |
233 | return -ENODEV; | |
234 | } | |
235 | ||
236 | static inline ssize_t debugfs_attr_write(struct file *file, | |
237 | const char __user *buf, | |
238 | size_t len, loff_t *ppos) | |
239 | { | |
240 | return -ENODEV; | |
241 | } | |
c6468808 | 242 | |
cfc94cdf JK |
243 | static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry, |
244 | struct dentry *new_dir, char *new_name) | |
245 | { | |
246 | return ERR_PTR(-ENODEV); | |
247 | } | |
248 | ||
f4ae40a6 | 249 | static inline struct dentry *debugfs_create_u8(const char *name, umode_t mode, |
1da177e4 LT |
250 | struct dentry *parent, |
251 | u8 *value) | |
252 | { | |
253 | return ERR_PTR(-ENODEV); | |
254 | } | |
255 | ||
f4ae40a6 | 256 | static inline struct dentry *debugfs_create_u16(const char *name, umode_t mode, |
1da177e4 | 257 | struct dentry *parent, |
7b558637 | 258 | u16 *value) |
1da177e4 LT |
259 | { |
260 | return ERR_PTR(-ENODEV); | |
261 | } | |
262 | ||
f4ae40a6 | 263 | static inline struct dentry *debugfs_create_u32(const char *name, umode_t mode, |
1da177e4 | 264 | struct dentry *parent, |
7b558637 | 265 | u32 *value) |
1da177e4 LT |
266 | { |
267 | return ERR_PTR(-ENODEV); | |
268 | } | |
269 | ||
f4ae40a6 | 270 | static inline struct dentry *debugfs_create_u64(const char *name, umode_t mode, |
8447891f ME |
271 | struct dentry *parent, |
272 | u64 *value) | |
273 | { | |
274 | return ERR_PTR(-ENODEV); | |
275 | } | |
276 | ||
c2a737eb VK |
277 | static inline struct dentry *debugfs_create_ulong(const char *name, |
278 | umode_t mode, | |
279 | struct dentry *parent, | |
280 | unsigned long *value) | |
281 | { | |
282 | return ERR_PTR(-ENODEV); | |
283 | } | |
284 | ||
f4ae40a6 | 285 | static inline struct dentry *debugfs_create_x8(const char *name, umode_t mode, |
2ebefc50 RG |
286 | struct dentry *parent, |
287 | u8 *value) | |
288 | { | |
289 | return ERR_PTR(-ENODEV); | |
290 | } | |
291 | ||
f4ae40a6 | 292 | static inline struct dentry *debugfs_create_x16(const char *name, umode_t mode, |
2ebefc50 RG |
293 | struct dentry *parent, |
294 | u16 *value) | |
295 | { | |
296 | return ERR_PTR(-ENODEV); | |
297 | } | |
298 | ||
f4ae40a6 | 299 | static inline struct dentry *debugfs_create_x32(const char *name, umode_t mode, |
2ebefc50 RG |
300 | struct dentry *parent, |
301 | u32 *value) | |
302 | { | |
303 | return ERR_PTR(-ENODEV); | |
304 | } | |
305 | ||
3159269e JB |
306 | static inline struct dentry *debugfs_create_x64(const char *name, umode_t mode, |
307 | struct dentry *parent, | |
308 | u64 *value) | |
309 | { | |
310 | return ERR_PTR(-ENODEV); | |
311 | } | |
312 | ||
f4ae40a6 | 313 | static inline struct dentry *debugfs_create_size_t(const char *name, umode_t mode, |
8adb711f IPG |
314 | struct dentry *parent, |
315 | size_t *value) | |
316 | { | |
317 | return ERR_PTR(-ENODEV); | |
318 | } | |
319 | ||
5b880214 WY |
320 | static inline struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode, |
321 | struct dentry *parent, atomic_t *value) | |
322 | { | |
323 | return ERR_PTR(-ENODEV); | |
324 | } | |
325 | ||
f4ae40a6 | 326 | static inline struct dentry *debugfs_create_bool(const char *name, umode_t mode, |
1da177e4 | 327 | struct dentry *parent, |
621a5f7a | 328 | bool *value) |
1da177e4 LT |
329 | { |
330 | return ERR_PTR(-ENODEV); | |
331 | } | |
332 | ||
f4ae40a6 | 333 | static inline struct dentry *debugfs_create_blob(const char *name, umode_t mode, |
dd308bc3 ME |
334 | struct dentry *parent, |
335 | struct debugfs_blob_wrapper *blob) | |
336 | { | |
337 | return ERR_PTR(-ENODEV); | |
338 | } | |
339 | ||
1a087c6a | 340 | static inline struct dentry *debugfs_create_regset32(const char *name, |
88187398 | 341 | umode_t mode, struct dentry *parent, |
1a087c6a AR |
342 | struct debugfs_regset32 *regset) |
343 | { | |
344 | return ERR_PTR(-ENODEV); | |
345 | } | |
346 | ||
9761536e | 347 | static inline void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs, |
5b880214 WY |
348 | int nregs, void __iomem *base, char *prefix) |
349 | { | |
5b880214 WY |
350 | } |
351 | ||
c0f92ba9 FW |
352 | static inline bool debugfs_initialized(void) |
353 | { | |
354 | return false; | |
355 | } | |
356 | ||
9fe2a701 SV |
357 | static inline struct dentry *debugfs_create_u32_array(const char *name, umode_t mode, |
358 | struct dentry *parent, | |
359 | u32 *array, u32 elements) | |
360 | { | |
361 | return ERR_PTR(-ENODEV); | |
362 | } | |
363 | ||
98210b7f AS |
364 | static inline struct dentry *debugfs_create_devm_seqfile(struct device *dev, |
365 | const char *name, | |
366 | struct dentry *parent, | |
367 | int (*read_fn)(struct seq_file *s, | |
368 | void *data)) | |
369 | { | |
370 | return ERR_PTR(-ENODEV); | |
371 | } | |
372 | ||
0642ef6f RF |
373 | static inline ssize_t debugfs_read_file_bool(struct file *file, |
374 | char __user *user_buf, | |
375 | size_t count, loff_t *ppos) | |
376 | { | |
377 | return -ENODEV; | |
378 | } | |
379 | ||
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) | |
383 | { | |
384 | return -ENODEV; | |
385 | } | |
386 | ||
1da177e4 LT |
387 | #endif |
388 | ||
389 | #endif |