Merge branches 'acpica-fixes', 'acpi-pci-fixes' and 'acpi-debug-fixes'
[deliverable/linux.git] / include / linux / debugfs.h
CommitLineData
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 21#include <linux/types.h>
49d200de 22#include <linux/compiler.h>
a7a76cef 23
f30d0a81 24struct device;
a7a76cef 25struct file_operations;
49d200de 26struct srcu_struct;
a7a76cef 27
dd308bc3
ME
28struct debugfs_blob_wrapper {
29 void *data;
30 unsigned long size;
31};
32
1a087c6a
AR
33struct debugfs_reg32 {
34 char *name;
35 unsigned long offset;
36};
37
38struct debugfs_regset32 {
833d6e01 39 const struct debugfs_reg32 *regs;
1a087c6a
AR
40 int nregs;
41 void __iomem *base;
42};
43
ae79cdaa 44extern struct dentry *arch_debugfs_dir;
45
49d200de
NS
46extern struct srcu_struct debugfs_srcu;
47
1da177e4 48#if defined(CONFIG_DEBUG_FS)
3634634e 49
f4ae40a6 50struct dentry *debugfs_create_file(const char *name, umode_t mode,
1da177e4 51 struct dentry *parent, void *data,
99ac48f5 52 const struct file_operations *fops);
c6468808
NS
53struct dentry *debugfs_create_file_unsafe(const char *name, umode_t mode,
54 struct dentry *parent, void *data,
55 const struct file_operations *fops);
1da177e4 56
e59b4e91
DH
57struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
58 struct dentry *parent, void *data,
59 const struct file_operations *fops,
60 loff_t file_size);
61
1da177e4
LT
62struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
63
66f54963
PO
64struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
65 const char *dest);
66
77b3da6e
AV
67struct dentry *debugfs_create_automount(const char *name,
68 struct dentry *parent,
69 struct vfsmount *(*f)(void *),
70 void *data);
71
1da177e4 72void debugfs_remove(struct dentry *dentry);
9505e637 73void debugfs_remove_recursive(struct dentry *dentry);
1da177e4 74
49d200de
NS
75int debugfs_use_file_start(const struct dentry *dentry, int *srcu_idx)
76 __acquires(&debugfs_srcu);
77
78void debugfs_use_file_finish(int srcu_idx) __releases(&debugfs_srcu);
79
c6468808
NS
80ssize_t debugfs_attr_read(struct file *file, char __user *buf,
81 size_t len, loff_t *ppos);
82ssize_t debugfs_attr_write(struct file *file, const char __user *buf,
83 size_t len, loff_t *ppos);
84
85#define DEFINE_DEBUGFS_ATTRIBUTE(__fops, __get, __set, __fmt) \
86static int __fops ## _open(struct inode *inode, struct file *file) \
87{ \
88 __simple_attr_check_format(__fmt, 0ull); \
89 return simple_attr_open(inode, file, __get, __set, __fmt); \
90} \
91static const struct file_operations __fops = { \
92 .owner = THIS_MODULE, \
93 .open = __fops ## _open, \
94 .release = simple_attr_release, \
95 .read = debugfs_attr_read, \
96 .write = debugfs_attr_write, \
97 .llseek = generic_file_llseek, \
98}
99
cfc94cdf
JK
100struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
101 struct dentry *new_dir, const char *new_name);
102
f4ae40a6 103struct dentry *debugfs_create_u8(const char *name, umode_t mode,
1da177e4 104 struct dentry *parent, u8 *value);
f4ae40a6 105struct dentry *debugfs_create_u16(const char *name, umode_t mode,
1da177e4 106 struct dentry *parent, u16 *value);
f4ae40a6 107struct dentry *debugfs_create_u32(const char *name, umode_t mode,
1da177e4 108 struct dentry *parent, u32 *value);
f4ae40a6 109struct dentry *debugfs_create_u64(const char *name, umode_t mode,
8447891f 110 struct dentry *parent, u64 *value);
c23fe831
VK
111struct dentry *debugfs_create_ulong(const char *name, umode_t mode,
112 struct dentry *parent, unsigned long *value);
f4ae40a6 113struct dentry *debugfs_create_x8(const char *name, umode_t mode,
2ebefc50 114 struct dentry *parent, u8 *value);
f4ae40a6 115struct dentry *debugfs_create_x16(const char *name, umode_t mode,
2ebefc50 116 struct dentry *parent, u16 *value);
f4ae40a6 117struct dentry *debugfs_create_x32(const char *name, umode_t mode,
2ebefc50 118 struct dentry *parent, u32 *value);
f4ae40a6 119struct dentry *debugfs_create_x64(const char *name, umode_t mode,
15b0beaa 120 struct dentry *parent, u64 *value);
f4ae40a6 121struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
5e078787 122 struct dentry *parent, size_t *value);
3a76e5e0
SJ
123struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode,
124 struct dentry *parent, atomic_t *value);
f4ae40a6 125struct dentry *debugfs_create_bool(const char *name, umode_t mode,
621a5f7a 126 struct dentry *parent, bool *value);
1da177e4 127
f4ae40a6 128struct dentry *debugfs_create_blob(const char *name, umode_t mode,
dd308bc3
ME
129 struct dentry *parent,
130 struct debugfs_blob_wrapper *blob);
c0f92ba9 131
88187398 132struct dentry *debugfs_create_regset32(const char *name, umode_t mode,
1a087c6a
AR
133 struct dentry *parent,
134 struct debugfs_regset32 *regset);
135
9761536e
JP
136void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
137 int nregs, void __iomem *base, char *prefix);
1a087c6a 138
9fe2a701
SV
139struct dentry *debugfs_create_u32_array(const char *name, umode_t mode,
140 struct dentry *parent,
141 u32 *array, u32 elements);
142
98210b7f
AS
143struct dentry *debugfs_create_devm_seqfile(struct device *dev, const char *name,
144 struct dentry *parent,
145 int (*read_fn)(struct seq_file *s,
146 void *data));
147
c0f92ba9
FW
148bool debugfs_initialized(void);
149
0642ef6f
RF
150ssize_t debugfs_read_file_bool(struct file *file, char __user *user_buf,
151 size_t count, loff_t *ppos);
152
153ssize_t debugfs_write_file_bool(struct file *file, const char __user *user_buf,
154 size_t count, loff_t *ppos);
155
1da177e4 156#else
a7a76cef
RD
157
158#include <linux/err.h>
159
98210b7f 160/*
1da177e4
LT
161 * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
162 * so users have a chance to detect if there was a real error or not. We don't
163 * want to duplicate the design decision mistakes of procfs and devfs again.
164 */
165
f4ae40a6 166static inline struct dentry *debugfs_create_file(const char *name, umode_t mode,
bde11d79
JD
167 struct dentry *parent, void *data,
168 const struct file_operations *fops)
1da177e4
LT
169{
170 return ERR_PTR(-ENODEV);
171}
172
e59b4e91
DH
173static inline struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
174 struct dentry *parent, void *data,
175 const struct file_operations *fops,
176 loff_t file_size)
177{
178 return ERR_PTR(-ENODEV);
179}
180
1da177e4
LT
181static inline struct dentry *debugfs_create_dir(const char *name,
182 struct dentry *parent)
183{
184 return ERR_PTR(-ENODEV);
185}
186
66f54963
PO
187static inline struct dentry *debugfs_create_symlink(const char *name,
188 struct dentry *parent,
189 const char *dest)
190{
191 return ERR_PTR(-ENODEV);
192}
193
94e1dec7
JW
194static inline struct dentry *debugfs_create_automount(const char *name,
195 struct dentry *parent,
196 struct vfsmount *(*f)(void *),
197 void *data)
198{
199 return ERR_PTR(-ENODEV);
200}
201
1da177e4
LT
202static inline void debugfs_remove(struct dentry *dentry)
203{ }
204
9505e637
HS
205static inline void debugfs_remove_recursive(struct dentry *dentry)
206{ }
207
49d200de
NS
208static inline int debugfs_use_file_start(const struct dentry *dentry,
209 int *srcu_idx)
210 __acquires(&debugfs_srcu)
211{
212 return 0;
213}
214
215static inline void debugfs_use_file_finish(int srcu_idx)
216 __releases(&debugfs_srcu)
217{ }
218
c6468808
NS
219#define DEFINE_DEBUGFS_ATTRIBUTE(__fops, __get, __set, __fmt) \
220 static const struct file_operations __fops = { 0 }
221
cfc94cdf
JK
222static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
223 struct dentry *new_dir, char *new_name)
224{
225 return ERR_PTR(-ENODEV);
226}
227
f4ae40a6 228static inline struct dentry *debugfs_create_u8(const char *name, umode_t mode,
1da177e4
LT
229 struct dentry *parent,
230 u8 *value)
231{
232 return ERR_PTR(-ENODEV);
233}
234
f4ae40a6 235static inline struct dentry *debugfs_create_u16(const char *name, umode_t mode,
1da177e4 236 struct dentry *parent,
7b558637 237 u16 *value)
1da177e4
LT
238{
239 return ERR_PTR(-ENODEV);
240}
241
f4ae40a6 242static inline struct dentry *debugfs_create_u32(const char *name, umode_t mode,
1da177e4 243 struct dentry *parent,
7b558637 244 u32 *value)
1da177e4
LT
245{
246 return ERR_PTR(-ENODEV);
247}
248
f4ae40a6 249static inline struct dentry *debugfs_create_u64(const char *name, umode_t mode,
8447891f
ME
250 struct dentry *parent,
251 u64 *value)
252{
253 return ERR_PTR(-ENODEV);
254}
255
f4ae40a6 256static inline struct dentry *debugfs_create_x8(const char *name, umode_t mode,
2ebefc50
RG
257 struct dentry *parent,
258 u8 *value)
259{
260 return ERR_PTR(-ENODEV);
261}
262
f4ae40a6 263static inline struct dentry *debugfs_create_x16(const char *name, umode_t mode,
2ebefc50
RG
264 struct dentry *parent,
265 u16 *value)
266{
267 return ERR_PTR(-ENODEV);
268}
269
f4ae40a6 270static inline struct dentry *debugfs_create_x32(const char *name, umode_t mode,
2ebefc50
RG
271 struct dentry *parent,
272 u32 *value)
273{
274 return ERR_PTR(-ENODEV);
275}
276
3159269e
JB
277static inline struct dentry *debugfs_create_x64(const char *name, umode_t mode,
278 struct dentry *parent,
279 u64 *value)
280{
281 return ERR_PTR(-ENODEV);
282}
283
f4ae40a6 284static inline struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
8adb711f
IPG
285 struct dentry *parent,
286 size_t *value)
287{
288 return ERR_PTR(-ENODEV);
289}
290
5b880214
WY
291static inline struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode,
292 struct dentry *parent, atomic_t *value)
293{
294 return ERR_PTR(-ENODEV);
295}
296
f4ae40a6 297static inline struct dentry *debugfs_create_bool(const char *name, umode_t mode,
1da177e4 298 struct dentry *parent,
621a5f7a 299 bool *value)
1da177e4
LT
300{
301 return ERR_PTR(-ENODEV);
302}
303
f4ae40a6 304static inline struct dentry *debugfs_create_blob(const char *name, umode_t mode,
dd308bc3
ME
305 struct dentry *parent,
306 struct debugfs_blob_wrapper *blob)
307{
308 return ERR_PTR(-ENODEV);
309}
310
1a087c6a 311static inline struct dentry *debugfs_create_regset32(const char *name,
88187398 312 umode_t mode, struct dentry *parent,
1a087c6a
AR
313 struct debugfs_regset32 *regset)
314{
315 return ERR_PTR(-ENODEV);
316}
317
9761536e 318static inline void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
5b880214
WY
319 int nregs, void __iomem *base, char *prefix)
320{
5b880214
WY
321}
322
c0f92ba9
FW
323static inline bool debugfs_initialized(void)
324{
325 return false;
326}
327
9fe2a701
SV
328static inline struct dentry *debugfs_create_u32_array(const char *name, umode_t mode,
329 struct dentry *parent,
330 u32 *array, u32 elements)
331{
332 return ERR_PTR(-ENODEV);
333}
334
98210b7f
AS
335static inline struct dentry *debugfs_create_devm_seqfile(struct device *dev,
336 const char *name,
337 struct dentry *parent,
338 int (*read_fn)(struct seq_file *s,
339 void *data))
340{
341 return ERR_PTR(-ENODEV);
342}
343
0642ef6f
RF
344static inline ssize_t debugfs_read_file_bool(struct file *file,
345 char __user *user_buf,
346 size_t count, loff_t *ppos)
347{
348 return -ENODEV;
349}
350
351static inline ssize_t debugfs_write_file_bool(struct file *file,
352 const char __user *user_buf,
353 size_t count, loff_t *ppos)
354{
355 return -ENODEV;
356}
357
1da177e4
LT
358#endif
359
360#endif
This page took 0.921725 seconds and 5 git commands to generate.