]> git.proxmox.com Git - mirror_ubuntu-focal-kernel.git/blame - include/linux/debugfs.h
PCI: iproc: Fix return value of iproc_msi_irq_domain_alloc()
[mirror_ubuntu-focal-kernel.git] / include / linux / debugfs.h
CommitLineData
3bce94fd 1// SPDX-License-Identifier: GPL-2.0
1da177e4
LT
2/*
3 * debugfs.h - a tiny little debug file system
4 *
5 * Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
6 * Copyright (C) 2004 IBM Inc.
7 *
1da177e4 8 * debugfs is for people to use instead of /proc or /sys.
e1b4fc7a 9 * See Documentation/filesystems/ for more details.
1da177e4
LT
10 */
11
12#ifndef _DEBUGFS_H_
13#define _DEBUGFS_H_
14
15#include <linux/fs.h>
1a087c6a 16#include <linux/seq_file.h>
1da177e4 17
a7a76cef 18#include <linux/types.h>
49d200de 19#include <linux/compiler.h>
a7a76cef 20
f30d0a81 21struct device;
a7a76cef
RD
22struct file_operations;
23
dd308bc3
ME
24struct debugfs_blob_wrapper {
25 void *data;
26 unsigned long size;
27};
28
1a087c6a
AR
29struct debugfs_reg32 {
30 char *name;
31 unsigned long offset;
32};
33
34struct debugfs_regset32 {
833d6e01 35 const struct debugfs_reg32 *regs;
1a087c6a
AR
36 int nregs;
37 void __iomem *base;
38};
39
ae79cdaa 40extern struct dentry *arch_debugfs_dir;
41
7f847dd3
AB
42#define DEFINE_DEBUGFS_ATTRIBUTE(__fops, __get, __set, __fmt) \
43static int __fops ## _open(struct inode *inode, struct file *file) \
44{ \
45 __simple_attr_check_format(__fmt, 0ull); \
46 return simple_attr_open(inode, file, __get, __set, __fmt); \
47} \
48static const struct file_operations __fops = { \
49 .owner = THIS_MODULE, \
50 .open = __fops ## _open, \
51 .release = simple_attr_release, \
52 .read = debugfs_attr_read, \
53 .write = debugfs_attr_write, \
895ce6c8 54 .llseek = no_llseek, \
7f847dd3
AB
55}
56
20269686
KK
57typedef struct vfsmount *(*debugfs_automount_t)(struct dentry *, void *);
58
1da177e4 59#if defined(CONFIG_DEBUG_FS)
3634634e 60
a7c5437b
OS
61struct dentry *debugfs_lookup(const char *name, struct dentry *parent);
62
f4ae40a6 63struct dentry *debugfs_create_file(const char *name, umode_t mode,
1da177e4 64 struct dentry *parent, void *data,
99ac48f5 65 const struct file_operations *fops);
c6468808
NS
66struct dentry *debugfs_create_file_unsafe(const char *name, umode_t mode,
67 struct dentry *parent, void *data,
68 const struct file_operations *fops);
1da177e4 69
e59b4e91
DH
70struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
71 struct dentry *parent, void *data,
72 const struct file_operations *fops,
73 loff_t file_size);
74
1da177e4
LT
75struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
76
66f54963
PO
77struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
78 const char *dest);
79
77b3da6e
AV
80struct dentry *debugfs_create_automount(const char *name,
81 struct dentry *parent,
93faccbb 82 debugfs_automount_t f,
77b3da6e
AV
83 void *data);
84
1da177e4 85void debugfs_remove(struct dentry *dentry);
9505e637 86void debugfs_remove_recursive(struct dentry *dentry);
1da177e4 87
055ab8e3 88const struct file_operations *debugfs_real_fops(const struct file *filp);
7c8d4698 89
e9117a5a
NS
90int debugfs_file_get(struct dentry *dentry);
91void debugfs_file_put(struct dentry *dentry);
92
c6468808
NS
93ssize_t debugfs_attr_read(struct file *file, char __user *buf,
94 size_t len, loff_t *ppos);
95ssize_t debugfs_attr_write(struct file *file, const char __user *buf,
96 size_t len, loff_t *ppos);
97
cfc94cdf
JK
98struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
99 struct dentry *new_dir, const char *new_name);
100
f4ae40a6 101struct dentry *debugfs_create_u8(const char *name, umode_t mode,
1da177e4 102 struct dentry *parent, u8 *value);
f4ae40a6 103struct dentry *debugfs_create_u16(const char *name, umode_t mode,
1da177e4 104 struct dentry *parent, u16 *value);
f4ae40a6 105struct dentry *debugfs_create_u32(const char *name, umode_t mode,
1da177e4 106 struct dentry *parent, u32 *value);
f4ae40a6 107struct dentry *debugfs_create_u64(const char *name, umode_t mode,
8447891f 108 struct dentry *parent, u64 *value);
c23fe831
VK
109struct dentry *debugfs_create_ulong(const char *name, umode_t mode,
110 struct dentry *parent, unsigned long *value);
f4ae40a6 111struct dentry *debugfs_create_x8(const char *name, umode_t mode,
2ebefc50 112 struct dentry *parent, u8 *value);
f4ae40a6 113struct dentry *debugfs_create_x16(const char *name, umode_t mode,
2ebefc50 114 struct dentry *parent, u16 *value);
f4ae40a6 115struct dentry *debugfs_create_x32(const char *name, umode_t mode,
2ebefc50 116 struct dentry *parent, u32 *value);
f4ae40a6 117struct dentry *debugfs_create_x64(const char *name, umode_t mode,
15b0beaa 118 struct dentry *parent, u64 *value);
f4ae40a6 119struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
5e078787 120 struct dentry *parent, size_t *value);
3a76e5e0
SJ
121struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode,
122 struct dentry *parent, atomic_t *value);
f4ae40a6 123struct dentry *debugfs_create_bool(const char *name, umode_t mode,
621a5f7a 124 struct dentry *parent, bool *value);
1da177e4 125
f4ae40a6 126struct dentry *debugfs_create_blob(const char *name, umode_t mode,
dd308bc3
ME
127 struct dentry *parent,
128 struct debugfs_blob_wrapper *blob);
c0f92ba9 129
88187398 130struct dentry *debugfs_create_regset32(const char *name, umode_t mode,
1a087c6a
AR
131 struct dentry *parent,
132 struct debugfs_regset32 *regset);
133
9761536e
JP
134void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
135 int nregs, void __iomem *base, char *prefix);
1a087c6a 136
c9c2c27d
GKH
137void debugfs_create_u32_array(const char *name, umode_t mode,
138 struct dentry *parent, u32 *array, u32 elements);
9fe2a701 139
98210b7f
AS
140struct dentry *debugfs_create_devm_seqfile(struct device *dev, const char *name,
141 struct dentry *parent,
142 int (*read_fn)(struct seq_file *s,
143 void *data));
144
c0f92ba9
FW
145bool debugfs_initialized(void);
146
0642ef6f
RF
147ssize_t debugfs_read_file_bool(struct file *file, char __user *user_buf,
148 size_t count, loff_t *ppos);
149
150ssize_t debugfs_write_file_bool(struct file *file, const char __user *user_buf,
151 size_t count, loff_t *ppos);
152
1da177e4 153#else
a7a76cef
RD
154
155#include <linux/err.h>
156
98210b7f 157/*
1da177e4
LT
158 * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
159 * so users have a chance to detect if there was a real error or not. We don't
160 * want to duplicate the design decision mistakes of procfs and devfs again.
161 */
162
a7c5437b
OS
163static inline struct dentry *debugfs_lookup(const char *name,
164 struct dentry *parent)
165{
166 return ERR_PTR(-ENODEV);
167}
168
f4ae40a6 169static inline struct dentry *debugfs_create_file(const char *name, umode_t mode,
bde11d79
JD
170 struct dentry *parent, void *data,
171 const struct file_operations *fops)
1da177e4
LT
172{
173 return ERR_PTR(-ENODEV);
174}
175
c2a737eb
VK
176static inline struct dentry *debugfs_create_file_unsafe(const char *name,
177 umode_t mode, struct dentry *parent,
178 void *data,
179 const struct file_operations *fops)
180{
181 return ERR_PTR(-ENODEV);
182}
183
e59b4e91
DH
184static inline struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
185 struct dentry *parent, void *data,
186 const struct file_operations *fops,
187 loff_t file_size)
188{
189 return ERR_PTR(-ENODEV);
190}
191
1da177e4
LT
192static inline struct dentry *debugfs_create_dir(const char *name,
193 struct dentry *parent)
194{
195 return ERR_PTR(-ENODEV);
196}
197
66f54963
PO
198static inline struct dentry *debugfs_create_symlink(const char *name,
199 struct dentry *parent,
200 const char *dest)
201{
202 return ERR_PTR(-ENODEV);
203}
204
94e1dec7
JW
205static inline struct dentry *debugfs_create_automount(const char *name,
206 struct dentry *parent,
20269686 207 debugfs_automount_t f,
94e1dec7
JW
208 void *data)
209{
210 return ERR_PTR(-ENODEV);
211}
212
1da177e4
LT
213static inline void debugfs_remove(struct dentry *dentry)
214{ }
215
9505e637
HS
216static inline void debugfs_remove_recursive(struct dentry *dentry)
217{ }
218
f50caa9b
AB
219const struct file_operations *debugfs_real_fops(const struct file *filp);
220
e9117a5a
NS
221static inline int debugfs_file_get(struct dentry *dentry)
222{
223 return 0;
224}
225
226static inline void debugfs_file_put(struct dentry *dentry)
227{ }
228
7f847dd3
AB
229static inline ssize_t debugfs_attr_read(struct file *file, char __user *buf,
230 size_t len, loff_t *ppos)
231{
232 return -ENODEV;
233}
234
235static inline ssize_t debugfs_attr_write(struct file *file,
236 const char __user *buf,
237 size_t len, loff_t *ppos)
238{
239 return -ENODEV;
240}
c6468808 241
cfc94cdf
JK
242static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
243 struct dentry *new_dir, char *new_name)
244{
245 return ERR_PTR(-ENODEV);
246}
247
f4ae40a6 248static inline struct dentry *debugfs_create_u8(const char *name, umode_t mode,
1da177e4
LT
249 struct dentry *parent,
250 u8 *value)
251{
252 return ERR_PTR(-ENODEV);
253}
254
f4ae40a6 255static inline struct dentry *debugfs_create_u16(const char *name, umode_t mode,
1da177e4 256 struct dentry *parent,
7b558637 257 u16 *value)
1da177e4
LT
258{
259 return ERR_PTR(-ENODEV);
260}
261
f4ae40a6 262static inline struct dentry *debugfs_create_u32(const char *name, umode_t mode,
1da177e4 263 struct dentry *parent,
7b558637 264 u32 *value)
1da177e4
LT
265{
266 return ERR_PTR(-ENODEV);
267}
268
f4ae40a6 269static inline struct dentry *debugfs_create_u64(const char *name, umode_t mode,
8447891f
ME
270 struct dentry *parent,
271 u64 *value)
272{
273 return ERR_PTR(-ENODEV);
274}
275
c2a737eb
VK
276static inline struct dentry *debugfs_create_ulong(const char *name,
277 umode_t mode,
278 struct dentry *parent,
279 unsigned long *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
c9c2c27d
GKH
356static inline void debugfs_create_u32_array(const char *name, umode_t mode,
357 struct dentry *parent, u32 *array,
358 u32 elements)
9fe2a701 359{
9fe2a701
SV
360}
361
98210b7f
AS
362static inline struct dentry *debugfs_create_devm_seqfile(struct device *dev,
363 const char *name,
364 struct dentry *parent,
365 int (*read_fn)(struct seq_file *s,
366 void *data))
367{
368 return ERR_PTR(-ENODEV);
369}
370
0642ef6f
RF
371static inline ssize_t debugfs_read_file_bool(struct file *file,
372 char __user *user_buf,
373 size_t count, loff_t *ppos)
374{
375 return -ENODEV;
376}
377
378static inline ssize_t debugfs_write_file_bool(struct file *file,
379 const char __user *user_buf,
380 size_t count, loff_t *ppos)
381{
382 return -ENODEV;
383}
384
1da177e4
LT
385#endif
386
387#endif