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