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