xref: /linux-6.15/include/linux/debugfs.h (revision 1da177e4)
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 #if defined(CONFIG_DEBUG_FS)
21 struct dentry *debugfs_create_file(const char *name, mode_t mode,
22 				   struct dentry *parent, void *data,
23 				   struct file_operations *fops);
24 
25 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
26 
27 void debugfs_remove(struct dentry *dentry);
28 
29 struct dentry *debugfs_create_u8(const char *name, mode_t mode,
30 				 struct dentry *parent, u8 *value);
31 struct dentry *debugfs_create_u16(const char *name, mode_t mode,
32 				  struct dentry *parent, u16 *value);
33 struct dentry *debugfs_create_u32(const char *name, mode_t mode,
34 				  struct dentry *parent, u32 *value);
35 struct dentry *debugfs_create_bool(const char *name, mode_t mode,
36 				  struct dentry *parent, u32 *value);
37 
38 #else
39 /*
40  * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
41  * so users have a chance to detect if there was a real error or not.  We don't
42  * want to duplicate the design decision mistakes of procfs and devfs again.
43  */
44 
45 static inline struct dentry *debugfs_create_file(const char *name, mode_t mode,
46 						 struct dentry *parent,
47 						 void *data,
48 						 struct file_operations *fops)
49 {
50 	return ERR_PTR(-ENODEV);
51 }
52 
53 static inline struct dentry *debugfs_create_dir(const char *name,
54 						struct dentry *parent)
55 {
56 	return ERR_PTR(-ENODEV);
57 }
58 
59 static inline void debugfs_remove(struct dentry *dentry)
60 { }
61 
62 static inline struct dentry *debugfs_create_u8(const char *name, mode_t mode,
63 					       struct dentry *parent,
64 					       u8 *value)
65 {
66 	return ERR_PTR(-ENODEV);
67 }
68 
69 static inline struct dentry *debugfs_create_u16(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_u32(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_bool(const char *name, mode_t mode,
84 						 struct dentry *parent,
85 						 u8 *value)
86 {
87 	return ERR_PTR(-ENODEV);
88 }
89 
90 #endif
91 
92 #endif
93