Commit | Line | Data |
---|---|---|
1da177e4 LT |
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. | |
55dff495 | 12 | * See Documentation/DocBook/filesystems for more details. |
1da177e4 LT |
13 | */ |
14 | ||
15 | #ifndef _DEBUGFS_H_ | |
16 | #define _DEBUGFS_H_ | |
17 | ||
18 | #include <linux/fs.h> | |
1a087c6a | 19 | #include <linux/seq_file.h> |
1da177e4 | 20 | |
a7a76cef RD |
21 | #include <linux/types.h> |
22 | ||
f30d0a81 | 23 | struct device; |
a7a76cef RD |
24 | struct file_operations; |
25 | ||
dd308bc3 ME |
26 | struct debugfs_blob_wrapper { |
27 | void *data; | |
28 | unsigned long size; | |
29 | }; | |
30 | ||
1a087c6a AR |
31 | struct debugfs_reg32 { |
32 | char *name; | |
33 | unsigned long offset; | |
34 | }; | |
35 | ||
36 | struct debugfs_regset32 { | |
833d6e01 | 37 | const struct debugfs_reg32 *regs; |
1a087c6a AR |
38 | int nregs; |
39 | void __iomem *base; | |
40 | }; | |
41 | ||
ae79cdaa | 42 | extern struct dentry *arch_debugfs_dir; |
43 | ||
1da177e4 | 44 | #if defined(CONFIG_DEBUG_FS) |
3634634e HH |
45 | |
46 | /* declared over in file.c */ | |
47 | extern const struct file_operations debugfs_file_operations; | |
48 | extern const struct inode_operations debugfs_link_operations; | |
49 | ||
f4ae40a6 | 50 | struct dentry *debugfs_create_file(const char *name, umode_t mode, |
1da177e4 | 51 | struct dentry *parent, void *data, |
99ac48f5 | 52 | const struct file_operations *fops); |
1da177e4 | 53 | |
e59b4e91 DH |
54 | struct dentry *debugfs_create_file_size(const char *name, umode_t mode, |
55 | struct dentry *parent, void *data, | |
56 | const struct file_operations *fops, | |
57 | loff_t file_size); | |
58 | ||
1da177e4 LT |
59 | struct dentry *debugfs_create_dir(const char *name, struct dentry *parent); |
60 | ||
66f54963 PO |
61 | struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent, |
62 | const char *dest); | |
63 | ||
77b3da6e AV |
64 | struct dentry *debugfs_create_automount(const char *name, |
65 | struct dentry *parent, | |
66 | struct vfsmount *(*f)(void *), | |
67 | void *data); | |
68 | ||
1da177e4 | 69 | void debugfs_remove(struct dentry *dentry); |
9505e637 | 70 | void debugfs_remove_recursive(struct dentry *dentry); |
1da177e4 | 71 | |
cfc94cdf JK |
72 | struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry, |
73 | struct dentry *new_dir, const char *new_name); | |
74 | ||
f4ae40a6 | 75 | struct dentry *debugfs_create_u8(const char *name, umode_t mode, |
1da177e4 | 76 | struct dentry *parent, u8 *value); |
f4ae40a6 | 77 | struct dentry *debugfs_create_u16(const char *name, umode_t mode, |
1da177e4 | 78 | struct dentry *parent, u16 *value); |
f4ae40a6 | 79 | struct dentry *debugfs_create_u32(const char *name, umode_t mode, |
1da177e4 | 80 | struct dentry *parent, u32 *value); |
f4ae40a6 | 81 | struct dentry *debugfs_create_u64(const char *name, umode_t mode, |
8447891f | 82 | struct dentry *parent, u64 *value); |
f4ae40a6 | 83 | struct dentry *debugfs_create_x8(const char *name, umode_t mode, |
2ebefc50 | 84 | struct dentry *parent, u8 *value); |
f4ae40a6 | 85 | struct dentry *debugfs_create_x16(const char *name, umode_t mode, |
2ebefc50 | 86 | struct dentry *parent, u16 *value); |
f4ae40a6 | 87 | struct dentry *debugfs_create_x32(const char *name, umode_t mode, |
2ebefc50 | 88 | struct dentry *parent, u32 *value); |
f4ae40a6 | 89 | struct dentry *debugfs_create_x64(const char *name, umode_t mode, |
15b0beaa | 90 | struct dentry *parent, u64 *value); |
f4ae40a6 | 91 | struct dentry *debugfs_create_size_t(const char *name, umode_t mode, |
5e078787 | 92 | struct dentry *parent, size_t *value); |
3a76e5e0 SJ |
93 | struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode, |
94 | struct dentry *parent, atomic_t *value); | |
f4ae40a6 | 95 | struct dentry *debugfs_create_bool(const char *name, umode_t mode, |
1da177e4 LT |
96 | struct dentry *parent, u32 *value); |
97 | ||
f4ae40a6 | 98 | struct dentry *debugfs_create_blob(const char *name, umode_t mode, |
dd308bc3 ME |
99 | struct dentry *parent, |
100 | struct debugfs_blob_wrapper *blob); | |
c0f92ba9 | 101 | |
88187398 | 102 | struct dentry *debugfs_create_regset32(const char *name, umode_t mode, |
1a087c6a AR |
103 | struct dentry *parent, |
104 | struct debugfs_regset32 *regset); | |
105 | ||
9761536e JP |
106 | void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs, |
107 | int nregs, void __iomem *base, char *prefix); | |
1a087c6a | 108 | |
9fe2a701 SV |
109 | struct dentry *debugfs_create_u32_array(const char *name, umode_t mode, |
110 | struct dentry *parent, | |
111 | u32 *array, u32 elements); | |
112 | ||
98210b7f AS |
113 | struct dentry *debugfs_create_devm_seqfile(struct device *dev, const char *name, |
114 | struct dentry *parent, | |
115 | int (*read_fn)(struct seq_file *s, | |
116 | void *data)); | |
117 | ||
c0f92ba9 FW |
118 | bool debugfs_initialized(void); |
119 | ||
1da177e4 | 120 | #else |
a7a76cef RD |
121 | |
122 | #include <linux/err.h> | |
123 | ||
98210b7f | 124 | /* |
1da177e4 LT |
125 | * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled |
126 | * so users have a chance to detect if there was a real error or not. We don't | |
127 | * want to duplicate the design decision mistakes of procfs and devfs again. | |
128 | */ | |
129 | ||
f4ae40a6 | 130 | static inline struct dentry *debugfs_create_file(const char *name, umode_t mode, |
bde11d79 JD |
131 | struct dentry *parent, void *data, |
132 | const struct file_operations *fops) | |
1da177e4 LT |
133 | { |
134 | return ERR_PTR(-ENODEV); | |
135 | } | |
136 | ||
e59b4e91 DH |
137 | static inline struct dentry *debugfs_create_file_size(const char *name, umode_t mode, |
138 | struct dentry *parent, void *data, | |
139 | const struct file_operations *fops, | |
140 | loff_t file_size) | |
141 | { | |
142 | return ERR_PTR(-ENODEV); | |
143 | } | |
144 | ||
1da177e4 LT |
145 | static inline struct dentry *debugfs_create_dir(const char *name, |
146 | struct dentry *parent) | |
147 | { | |
148 | return ERR_PTR(-ENODEV); | |
149 | } | |
150 | ||
66f54963 PO |
151 | static inline struct dentry *debugfs_create_symlink(const char *name, |
152 | struct dentry *parent, | |
153 | const char *dest) | |
154 | { | |
155 | return ERR_PTR(-ENODEV); | |
156 | } | |
157 | ||
1da177e4 LT |
158 | static inline void debugfs_remove(struct dentry *dentry) |
159 | { } | |
160 | ||
9505e637 HS |
161 | static inline void debugfs_remove_recursive(struct dentry *dentry) |
162 | { } | |
163 | ||
cfc94cdf JK |
164 | static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry, |
165 | struct dentry *new_dir, char *new_name) | |
166 | { | |
167 | return ERR_PTR(-ENODEV); | |
168 | } | |
169 | ||
f4ae40a6 | 170 | static inline struct dentry *debugfs_create_u8(const char *name, umode_t mode, |
1da177e4 LT |
171 | struct dentry *parent, |
172 | u8 *value) | |
173 | { | |
174 | return ERR_PTR(-ENODEV); | |
175 | } | |
176 | ||
f4ae40a6 | 177 | static inline struct dentry *debugfs_create_u16(const char *name, umode_t mode, |
1da177e4 | 178 | struct dentry *parent, |
7b558637 | 179 | u16 *value) |
1da177e4 LT |
180 | { |
181 | return ERR_PTR(-ENODEV); | |
182 | } | |
183 | ||
f4ae40a6 | 184 | static inline struct dentry *debugfs_create_u32(const char *name, umode_t mode, |
1da177e4 | 185 | struct dentry *parent, |
7b558637 | 186 | u32 *value) |
1da177e4 LT |
187 | { |
188 | return ERR_PTR(-ENODEV); | |
189 | } | |
190 | ||
f4ae40a6 | 191 | static inline struct dentry *debugfs_create_u64(const char *name, umode_t mode, |
8447891f ME |
192 | struct dentry *parent, |
193 | u64 *value) | |
194 | { | |
195 | return ERR_PTR(-ENODEV); | |
196 | } | |
197 | ||
f4ae40a6 | 198 | static inline struct dentry *debugfs_create_x8(const char *name, umode_t mode, |
2ebefc50 RG |
199 | struct dentry *parent, |
200 | u8 *value) | |
201 | { | |
202 | return ERR_PTR(-ENODEV); | |
203 | } | |
204 | ||
f4ae40a6 | 205 | static inline struct dentry *debugfs_create_x16(const char *name, umode_t mode, |
2ebefc50 RG |
206 | struct dentry *parent, |
207 | u16 *value) | |
208 | { | |
209 | return ERR_PTR(-ENODEV); | |
210 | } | |
211 | ||
f4ae40a6 | 212 | static inline struct dentry *debugfs_create_x32(const char *name, umode_t mode, |
2ebefc50 RG |
213 | struct dentry *parent, |
214 | u32 *value) | |
215 | { | |
216 | return ERR_PTR(-ENODEV); | |
217 | } | |
218 | ||
3159269e JB |
219 | static inline struct dentry *debugfs_create_x64(const char *name, umode_t mode, |
220 | struct dentry *parent, | |
221 | u64 *value) | |
222 | { | |
223 | return ERR_PTR(-ENODEV); | |
224 | } | |
225 | ||
f4ae40a6 | 226 | static inline struct dentry *debugfs_create_size_t(const char *name, umode_t mode, |
8adb711f IPG |
227 | struct dentry *parent, |
228 | size_t *value) | |
229 | { | |
230 | return ERR_PTR(-ENODEV); | |
231 | } | |
232 | ||
5b880214 WY |
233 | static inline struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode, |
234 | struct dentry *parent, atomic_t *value) | |
235 | { | |
236 | return ERR_PTR(-ENODEV); | |
237 | } | |
238 | ||
f4ae40a6 | 239 | static inline struct dentry *debugfs_create_bool(const char *name, umode_t mode, |
1da177e4 | 240 | struct dentry *parent, |
7b558637 | 241 | u32 *value) |
1da177e4 LT |
242 | { |
243 | return ERR_PTR(-ENODEV); | |
244 | } | |
245 | ||
f4ae40a6 | 246 | static inline struct dentry *debugfs_create_blob(const char *name, umode_t mode, |
dd308bc3 ME |
247 | struct dentry *parent, |
248 | struct debugfs_blob_wrapper *blob) | |
249 | { | |
250 | return ERR_PTR(-ENODEV); | |
251 | } | |
252 | ||
1a087c6a | 253 | static inline struct dentry *debugfs_create_regset32(const char *name, |
88187398 | 254 | umode_t mode, struct dentry *parent, |
1a087c6a AR |
255 | struct debugfs_regset32 *regset) |
256 | { | |
257 | return ERR_PTR(-ENODEV); | |
258 | } | |
259 | ||
9761536e | 260 | static inline void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs, |
5b880214 WY |
261 | int nregs, void __iomem *base, char *prefix) |
262 | { | |
5b880214 WY |
263 | } |
264 | ||
c0f92ba9 FW |
265 | static inline bool debugfs_initialized(void) |
266 | { | |
267 | return false; | |
268 | } | |
269 | ||
9fe2a701 SV |
270 | static inline struct dentry *debugfs_create_u32_array(const char *name, umode_t mode, |
271 | struct dentry *parent, | |
272 | u32 *array, u32 elements) | |
273 | { | |
274 | return ERR_PTR(-ENODEV); | |
275 | } | |
276 | ||
98210b7f AS |
277 | static inline struct dentry *debugfs_create_devm_seqfile(struct device *dev, |
278 | const char *name, | |
279 | struct dentry *parent, | |
280 | int (*read_fn)(struct seq_file *s, | |
281 | void *data)) | |
282 | { | |
283 | return ERR_PTR(-ENODEV); | |
284 | } | |
285 | ||
1da177e4 LT |
286 | #endif |
287 | ||
288 | #endif |