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