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