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