xref: /linux-6.15/include/linux/debugfs.h (revision 776cfebb)
1 /*
2  *  debugfs.h - a tiny little debug file system
3  *
4  *  Copyright (C) 2004 Greg Kroah-Hartman <[email protected]>
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.
12  *  See Documentation/DocBook/kernel-api for more details.
13  */
14 
15 #ifndef _DEBUGFS_H_
16 #define _DEBUGFS_H_
17 
18 #include <linux/fs.h>
19 
20 #include <linux/types.h>
21 
22 struct file_operations;
23 
24 #if defined(CONFIG_DEBUG_FS)
25 struct dentry *debugfs_create_file(const char *name, mode_t mode,
26 				   struct dentry *parent, void *data,
27 				   struct file_operations *fops);
28 
29 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
30 
31 void debugfs_remove(struct dentry *dentry);
32 
33 struct dentry *debugfs_create_u8(const char *name, mode_t mode,
34 				 struct dentry *parent, u8 *value);
35 struct dentry *debugfs_create_u16(const char *name, mode_t mode,
36 				  struct dentry *parent, u16 *value);
37 struct dentry *debugfs_create_u32(const char *name, mode_t mode,
38 				  struct dentry *parent, u32 *value);
39 struct dentry *debugfs_create_bool(const char *name, mode_t mode,
40 				  struct dentry *parent, u32 *value);
41 
42 #else
43 
44 #include <linux/err.h>
45 
46 /*
47  * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
48  * so users have a chance to detect if there was a real error or not.  We don't
49  * want to duplicate the design decision mistakes of procfs and devfs again.
50  */
51 
52 static inline struct dentry *debugfs_create_file(const char *name, mode_t mode,
53 						 struct dentry *parent,
54 						 void *data,
55 						 struct file_operations *fops)
56 {
57 	return ERR_PTR(-ENODEV);
58 }
59 
60 static inline struct dentry *debugfs_create_dir(const char *name,
61 						struct dentry *parent)
62 {
63 	return ERR_PTR(-ENODEV);
64 }
65 
66 static inline void debugfs_remove(struct dentry *dentry)
67 { }
68 
69 static inline struct dentry *debugfs_create_u8(const char *name, mode_t mode,
70 					       struct dentry *parent,
71 					       u8 *value)
72 {
73 	return ERR_PTR(-ENODEV);
74 }
75 
76 static inline struct dentry *debugfs_create_u16(const char *name, mode_t mode,
77 						struct dentry *parent,
78 						u16 *value)
79 {
80 	return ERR_PTR(-ENODEV);
81 }
82 
83 static inline struct dentry *debugfs_create_u32(const char *name, mode_t mode,
84 						struct dentry *parent,
85 						u32 *value)
86 {
87 	return ERR_PTR(-ENODEV);
88 }
89 
90 static inline struct dentry *debugfs_create_bool(const char *name, mode_t mode,
91 						 struct dentry *parent,
92 						 u32 *value)
93 {
94 	return ERR_PTR(-ENODEV);
95 }
96 
97 #endif
98 
99 #endif
100