xref: /linux-6.15/include/linux/debugfs.h (revision 757dea93)
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 struct debugfs_blob_wrapper {
25 	void *data;
26 	unsigned long size;
27 };
28 
29 #if defined(CONFIG_DEBUG_FS)
30 struct dentry *debugfs_create_file(const char *name, mode_t mode,
31 				   struct dentry *parent, void *data,
32 				   const struct file_operations *fops);
33 
34 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
35 
36 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
37 				      const char *dest);
38 
39 void debugfs_remove(struct dentry *dentry);
40 
41 struct dentry *debugfs_create_u8(const char *name, mode_t mode,
42 				 struct dentry *parent, u8 *value);
43 struct dentry *debugfs_create_u16(const char *name, mode_t mode,
44 				  struct dentry *parent, u16 *value);
45 struct dentry *debugfs_create_u32(const char *name, mode_t mode,
46 				  struct dentry *parent, u32 *value);
47 struct dentry *debugfs_create_u64(const char *name, mode_t mode,
48 				  struct dentry *parent, u64 *value);
49 struct dentry *debugfs_create_bool(const char *name, mode_t mode,
50 				  struct dentry *parent, u32 *value);
51 
52 struct dentry *debugfs_create_blob(const char *name, mode_t mode,
53 				  struct dentry *parent,
54 				  struct debugfs_blob_wrapper *blob);
55 #else
56 
57 #include <linux/err.h>
58 
59 /*
60  * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
61  * so users have a chance to detect if there was a real error or not.  We don't
62  * want to duplicate the design decision mistakes of procfs and devfs again.
63  */
64 
65 static inline struct dentry *debugfs_create_file(const char *name, mode_t mode,
66 					struct dentry *parent, void *data,
67 					const struct file_operations *fops)
68 {
69 	return ERR_PTR(-ENODEV);
70 }
71 
72 static inline struct dentry *debugfs_create_dir(const char *name,
73 						struct dentry *parent)
74 {
75 	return ERR_PTR(-ENODEV);
76 }
77 
78 static inline struct dentry *debugfs_create_symlink(const char *name,
79 						    struct dentry *parent,
80 						    const char *dest)
81 {
82 	return ERR_PTR(-ENODEV);
83 }
84 
85 static inline void debugfs_remove(struct dentry *dentry)
86 { }
87 
88 static inline struct dentry *debugfs_create_u8(const char *name, mode_t mode,
89 					       struct dentry *parent,
90 					       u8 *value)
91 {
92 	return ERR_PTR(-ENODEV);
93 }
94 
95 static inline struct dentry *debugfs_create_u16(const char *name, mode_t mode,
96 						struct dentry *parent,
97 						u16 *value)
98 {
99 	return ERR_PTR(-ENODEV);
100 }
101 
102 static inline struct dentry *debugfs_create_u32(const char *name, mode_t mode,
103 						struct dentry *parent,
104 						u32 *value)
105 {
106 	return ERR_PTR(-ENODEV);
107 }
108 
109 static inline struct dentry *debugfs_create_u64(const char *name, mode_t mode,
110 						struct dentry *parent,
111 						u64 *value)
112 {
113 	return ERR_PTR(-ENODEV);
114 }
115 
116 static inline struct dentry *debugfs_create_bool(const char *name, mode_t mode,
117 						 struct dentry *parent,
118 						 u32 *value)
119 {
120 	return ERR_PTR(-ENODEV);
121 }
122 
123 static inline struct dentry *debugfs_create_blob(const char *name, mode_t mode,
124 				  struct dentry *parent,
125 				  struct debugfs_blob_wrapper *blob)
126 {
127 	return ERR_PTR(-ENODEV);
128 }
129 
130 #endif
131 
132 #endif
133