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