1 /*
2 * debugfs.h - a tiny little debug file system
3 *
4 * Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
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/filesystems for more details.
13 */
14
15 #ifndef _DEBUGFS_H_
16 #define _DEBUGFS_H_
17
18 #include <linux/fs.h>
19 #include <linux/seq_file.h>
20
21 #include <linux/types.h>
22
23 struct file_operations;
24
25 struct debugfs_blob_wrapper {
26 void *data;
27 unsigned long size;
28 };
29
30 struct debugfs_reg32 {
31 char *name;
32 unsigned long offset;
33 };
34
35 struct debugfs_regset32 {
36 struct debugfs_reg32 *regs;
37 int nregs;
38 void __iomem *base;
39 };
40
41 extern struct dentry *arch_debugfs_dir;
42
43 #if defined(CONFIG_DEBUG_FS)
44
45 /* declared over in file.c */
46 extern const struct file_operations debugfs_file_operations;
47 extern const struct inode_operations debugfs_link_operations;
48
49 struct dentry *debugfs_create_file(const char *name, umode_t mode,
50 struct dentry *parent, void *data,
51 const struct file_operations *fops);
52
53 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
54
55 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
56 const char *dest);
57
58 void debugfs_remove(struct dentry *dentry);
59 void debugfs_remove_recursive(struct dentry *dentry);
60
61 struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
62 struct dentry *new_dir, const char *new_name);
63
64 struct dentry *debugfs_create_u8(const char *name, umode_t mode,
65 struct dentry *parent, u8 *value);
66 struct dentry *debugfs_create_u16(const char *name, umode_t mode,
67 struct dentry *parent, u16 *value);
68 struct dentry *debugfs_create_u32(const char *name, umode_t mode,
69 struct dentry *parent, u32 *value);
70 struct dentry *debugfs_create_u64(const char *name, umode_t mode,
71 struct dentry *parent, u64 *value);
72 struct dentry *debugfs_create_x8(const char *name, umode_t mode,
73 struct dentry *parent, u8 *value);
74 struct dentry *debugfs_create_x16(const char *name, umode_t mode,
75 struct dentry *parent, u16 *value);
76 struct dentry *debugfs_create_x32(const char *name, umode_t mode,
77 struct dentry *parent, u32 *value);
78 struct dentry *debugfs_create_x64(const char *name, umode_t mode,
79 struct dentry *parent, u64 *value);
80 struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
81 struct dentry *parent, size_t *value);
82 struct dentry *debugfs_create_bool(const char *name, umode_t mode,
83 struct dentry *parent, u32 *value);
84
85 struct dentry *debugfs_create_blob(const char *name, umode_t mode,
86 struct dentry *parent,
87 struct debugfs_blob_wrapper *blob);
88
89 struct dentry *debugfs_create_regset32(const char *name, mode_t mode,
90 struct dentry *parent,
91 struct debugfs_regset32 *regset);
92
93 int debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
94 int nregs, void __iomem *base, char *prefix);
95
96 bool debugfs_initialized(void);
97
98 #else
99
100 #include <linux/err.h>
101
102 /*
103 * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
104 * so users have a chance to detect if there was a real error or not. We don't
105 * want to duplicate the design decision mistakes of procfs and devfs again.
106 */
107
debugfs_create_file(const char * name,umode_t mode,struct dentry * parent,void * data,const struct file_operations * fops)108 static inline struct dentry *debugfs_create_file(const char *name, umode_t mode,
109 struct dentry *parent, void *data,
110 const struct file_operations *fops)
111 {
112 return ERR_PTR(-ENODEV);
113 }
114
debugfs_create_dir(const char * name,struct dentry * parent)115 static inline struct dentry *debugfs_create_dir(const char *name,
116 struct dentry *parent)
117 {
118 return ERR_PTR(-ENODEV);
119 }
120
debugfs_create_symlink(const char * name,struct dentry * parent,const char * dest)121 static inline struct dentry *debugfs_create_symlink(const char *name,
122 struct dentry *parent,
123 const char *dest)
124 {
125 return ERR_PTR(-ENODEV);
126 }
127
debugfs_remove(struct dentry * dentry)128 static inline void debugfs_remove(struct dentry *dentry)
129 { }
130
debugfs_remove_recursive(struct dentry * dentry)131 static inline void debugfs_remove_recursive(struct dentry *dentry)
132 { }
133
debugfs_rename(struct dentry * old_dir,struct dentry * old_dentry,struct dentry * new_dir,char * new_name)134 static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
135 struct dentry *new_dir, char *new_name)
136 {
137 return ERR_PTR(-ENODEV);
138 }
139
debugfs_create_u8(const char * name,umode_t mode,struct dentry * parent,u8 * value)140 static inline struct dentry *debugfs_create_u8(const char *name, umode_t mode,
141 struct dentry *parent,
142 u8 *value)
143 {
144 return ERR_PTR(-ENODEV);
145 }
146
debugfs_create_u16(const char * name,umode_t mode,struct dentry * parent,u16 * value)147 static inline struct dentry *debugfs_create_u16(const char *name, umode_t mode,
148 struct dentry *parent,
149 u16 *value)
150 {
151 return ERR_PTR(-ENODEV);
152 }
153
debugfs_create_u32(const char * name,umode_t mode,struct dentry * parent,u32 * value)154 static inline struct dentry *debugfs_create_u32(const char *name, umode_t mode,
155 struct dentry *parent,
156 u32 *value)
157 {
158 return ERR_PTR(-ENODEV);
159 }
160
debugfs_create_u64(const char * name,umode_t mode,struct dentry * parent,u64 * value)161 static inline struct dentry *debugfs_create_u64(const char *name, umode_t mode,
162 struct dentry *parent,
163 u64 *value)
164 {
165 return ERR_PTR(-ENODEV);
166 }
167
debugfs_create_x8(const char * name,umode_t mode,struct dentry * parent,u8 * value)168 static inline struct dentry *debugfs_create_x8(const char *name, umode_t mode,
169 struct dentry *parent,
170 u8 *value)
171 {
172 return ERR_PTR(-ENODEV);
173 }
174
debugfs_create_x16(const char * name,umode_t mode,struct dentry * parent,u16 * value)175 static inline struct dentry *debugfs_create_x16(const char *name, umode_t mode,
176 struct dentry *parent,
177 u16 *value)
178 {
179 return ERR_PTR(-ENODEV);
180 }
181
debugfs_create_x32(const char * name,umode_t mode,struct dentry * parent,u32 * value)182 static inline struct dentry *debugfs_create_x32(const char *name, umode_t mode,
183 struct dentry *parent,
184 u32 *value)
185 {
186 return ERR_PTR(-ENODEV);
187 }
188
debugfs_create_size_t(const char * name,umode_t mode,struct dentry * parent,size_t * value)189 static inline struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
190 struct dentry *parent,
191 size_t *value)
192 {
193 return ERR_PTR(-ENODEV);
194 }
195
debugfs_create_bool(const char * name,umode_t mode,struct dentry * parent,u32 * value)196 static inline struct dentry *debugfs_create_bool(const char *name, umode_t mode,
197 struct dentry *parent,
198 u32 *value)
199 {
200 return ERR_PTR(-ENODEV);
201 }
202
debugfs_create_blob(const char * name,umode_t mode,struct dentry * parent,struct debugfs_blob_wrapper * blob)203 static inline struct dentry *debugfs_create_blob(const char *name, umode_t mode,
204 struct dentry *parent,
205 struct debugfs_blob_wrapper *blob)
206 {
207 return ERR_PTR(-ENODEV);
208 }
209
debugfs_create_regset32(const char * name,mode_t mode,struct dentry * parent,struct debugfs_regset32 * regset)210 static inline struct dentry *debugfs_create_regset32(const char *name,
211 mode_t mode, struct dentry *parent,
212 struct debugfs_regset32 *regset)
213 {
214 return ERR_PTR(-ENODEV);
215 }
216
debugfs_initialized(void)217 static inline bool debugfs_initialized(void)
218 {
219 return false;
220 }
221
222 #endif
223
224 #endif
225