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