]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - include/linux/debugfs.h
Merge tag 'staging-5.13-rc6' of git://git.kernel.org/pub/scm/linux/kernel/git/gregkh...
[mirror_ubuntu-jammy-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;
30332eee 38 struct device *dev; /* Optional device for Runtime PM */
1a087c6a
AR
39};
40
a2b992c8
JK
41struct debugfs_u32_array {
42 u32 *array;
43 u32 n_elements;
44};
45
ae79cdaa 46extern struct dentry *arch_debugfs_dir;
47
7f847dd3
AB
48#define DEFINE_DEBUGFS_ATTRIBUTE(__fops, __get, __set, __fmt) \
49static int __fops ## _open(struct inode *inode, struct file *file) \
50{ \
51 __simple_attr_check_format(__fmt, 0ull); \
52 return simple_attr_open(inode, file, __get, __set, __fmt); \
53} \
54static const struct file_operations __fops = { \
55 .owner = THIS_MODULE, \
56 .open = __fops ## _open, \
57 .release = simple_attr_release, \
58 .read = debugfs_attr_read, \
59 .write = debugfs_attr_write, \
895ce6c8 60 .llseek = no_llseek, \
7f847dd3
AB
61}
62
4250b047
KK
63typedef struct vfsmount *(*debugfs_automount_t)(struct dentry *, void *);
64
1da177e4 65#if defined(CONFIG_DEBUG_FS)
3634634e 66
a7c5437b
OS
67struct dentry *debugfs_lookup(const char *name, struct dentry *parent);
68
f4ae40a6 69struct dentry *debugfs_create_file(const char *name, umode_t mode,
1da177e4 70 struct dentry *parent, void *data,
99ac48f5 71 const struct file_operations *fops);
c6468808
NS
72struct dentry *debugfs_create_file_unsafe(const char *name, umode_t mode,
73 struct dentry *parent, void *data,
74 const struct file_operations *fops);
1da177e4 75
526ee72d
GKH
76void debugfs_create_file_size(const char *name, umode_t mode,
77 struct dentry *parent, void *data,
78 const struct file_operations *fops,
79 loff_t file_size);
e59b4e91 80
1da177e4
LT
81struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
82
66f54963
PO
83struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
84 const char *dest);
85
77b3da6e
AV
86struct dentry *debugfs_create_automount(const char *name,
87 struct dentry *parent,
93faccbb 88 debugfs_automount_t f,
77b3da6e
AV
89 void *data);
90
1da177e4 91void debugfs_remove(struct dentry *dentry);
a3d1e7eb 92#define debugfs_remove_recursive debugfs_remove
1da177e4 93
055ab8e3 94const struct file_operations *debugfs_real_fops(const struct file *filp);
7c8d4698 95
e9117a5a
NS
96int debugfs_file_get(struct dentry *dentry);
97void debugfs_file_put(struct dentry *dentry);
98
c6468808
NS
99ssize_t debugfs_attr_read(struct file *file, char __user *buf,
100 size_t len, loff_t *ppos);
101ssize_t debugfs_attr_write(struct file *file, const char __user *buf,
102 size_t len, loff_t *ppos);
103
cfc94cdf
JK
104struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
105 struct dentry *new_dir, const char *new_name);
106
9655ac4a
GKH
107void debugfs_create_u8(const char *name, umode_t mode, struct dentry *parent,
108 u8 *value);
313f5dbb
GKH
109void debugfs_create_u16(const char *name, umode_t mode, struct dentry *parent,
110 u16 *value);
2b07021a
GKH
111void debugfs_create_u32(const char *name, umode_t mode, struct dentry *parent,
112 u32 *value);
ad26221f
GKH
113void debugfs_create_u64(const char *name, umode_t mode, struct dentry *parent,
114 u64 *value);
c23fe831
VK
115struct dentry *debugfs_create_ulong(const char *name, umode_t mode,
116 struct dentry *parent, unsigned long *value);
c7c11689
GKH
117void debugfs_create_x8(const char *name, umode_t mode, struct dentry *parent,
118 u8 *value);
e40d38f2
GKH
119void debugfs_create_x16(const char *name, umode_t mode, struct dentry *parent,
120 u16 *value);
f5cb0a7e
GKH
121void debugfs_create_x32(const char *name, umode_t mode, struct dentry *parent,
122 u32 *value);
0864c408
GKH
123void debugfs_create_x64(const char *name, umode_t mode, struct dentry *parent,
124 u64 *value);
8e580263
GKH
125void debugfs_create_size_t(const char *name, umode_t mode,
126 struct dentry *parent, size_t *value);
9927c6fa
GKH
127void debugfs_create_atomic_t(const char *name, umode_t mode,
128 struct dentry *parent, atomic_t *value);
f4ae40a6 129struct dentry *debugfs_create_bool(const char *name, umode_t mode,
621a5f7a 130 struct dentry *parent, bool *value);
9af0440e
PZ
131void debugfs_create_str(const char *name, umode_t mode,
132 struct dentry *parent, char **value);
1da177e4 133
f4ae40a6 134struct dentry *debugfs_create_blob(const char *name, umode_t mode,
dd308bc3
ME
135 struct dentry *parent,
136 struct debugfs_blob_wrapper *blob);
c0f92ba9 137
ae91c925
GKH
138void debugfs_create_regset32(const char *name, umode_t mode,
139 struct dentry *parent,
140 struct debugfs_regset32 *regset);
1a087c6a 141
9761536e
JP
142void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
143 int nregs, void __iomem *base, char *prefix);
1a087c6a 144
c9c2c27d 145void debugfs_create_u32_array(const char *name, umode_t mode,
a2b992c8
JK
146 struct dentry *parent,
147 struct debugfs_u32_array *array);
9fe2a701 148
0d519cbf
GKH
149void debugfs_create_devm_seqfile(struct device *dev, const char *name,
150 struct dentry *parent,
151 int (*read_fn)(struct seq_file *s, void *data));
98210b7f 152
c0f92ba9
FW
153bool debugfs_initialized(void);
154
0642ef6f
RF
155ssize_t debugfs_read_file_bool(struct file *file, char __user *user_buf,
156 size_t count, loff_t *ppos);
157
158ssize_t debugfs_write_file_bool(struct file *file, const char __user *user_buf,
159 size_t count, loff_t *ppos);
160
9af0440e
PZ
161ssize_t debugfs_read_file_str(struct file *file, char __user *user_buf,
162 size_t count, loff_t *ppos);
163
1da177e4 164#else
a7a76cef
RD
165
166#include <linux/err.h>
167
98210b7f 168/*
1da177e4
LT
169 * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
170 * so users have a chance to detect if there was a real error or not. We don't
171 * want to duplicate the design decision mistakes of procfs and devfs again.
172 */
173
a7c5437b
OS
174static inline struct dentry *debugfs_lookup(const char *name,
175 struct dentry *parent)
176{
177 return ERR_PTR(-ENODEV);
178}
179
f4ae40a6 180static inline struct dentry *debugfs_create_file(const char *name, umode_t mode,
bde11d79
JD
181 struct dentry *parent, void *data,
182 const struct file_operations *fops)
1da177e4
LT
183{
184 return ERR_PTR(-ENODEV);
185}
186
c2a737eb
VK
187static inline struct dentry *debugfs_create_file_unsafe(const char *name,
188 umode_t mode, struct dentry *parent,
189 void *data,
190 const struct file_operations *fops)
191{
192 return ERR_PTR(-ENODEV);
193}
194
526ee72d
GKH
195static inline void debugfs_create_file_size(const char *name, umode_t mode,
196 struct dentry *parent, void *data,
197 const struct file_operations *fops,
198 loff_t file_size)
199{ }
e59b4e91 200
1da177e4
LT
201static inline struct dentry *debugfs_create_dir(const char *name,
202 struct dentry *parent)
203{
204 return ERR_PTR(-ENODEV);
205}
206
66f54963
PO
207static inline struct dentry *debugfs_create_symlink(const char *name,
208 struct dentry *parent,
209 const char *dest)
210{
211 return ERR_PTR(-ENODEV);
212}
213
94e1dec7
JW
214static inline struct dentry *debugfs_create_automount(const char *name,
215 struct dentry *parent,
4250b047 216 debugfs_automount_t f,
94e1dec7
JW
217 void *data)
218{
219 return ERR_PTR(-ENODEV);
220}
221
1da177e4
LT
222static inline void debugfs_remove(struct dentry *dentry)
223{ }
224
9505e637
HS
225static inline void debugfs_remove_recursive(struct dentry *dentry)
226{ }
227
f50caa9b
AB
228const struct file_operations *debugfs_real_fops(const struct file *filp);
229
e9117a5a
NS
230static inline int debugfs_file_get(struct dentry *dentry)
231{
232 return 0;
233}
234
235static inline void debugfs_file_put(struct dentry *dentry)
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
9655ac4a
GKH
257static inline void debugfs_create_u8(const char *name, umode_t mode,
258 struct dentry *parent, u8 *value) { }
1da177e4 259
313f5dbb
GKH
260static inline void debugfs_create_u16(const char *name, umode_t mode,
261 struct dentry *parent, u16 *value) { }
1da177e4 262
2b07021a
GKH
263static inline void debugfs_create_u32(const char *name, umode_t mode,
264 struct dentry *parent, u32 *value) { }
1da177e4 265
ad26221f
GKH
266static inline void debugfs_create_u64(const char *name, umode_t mode,
267 struct dentry *parent, u64 *value) { }
8447891f 268
c2a737eb
VK
269static inline struct dentry *debugfs_create_ulong(const char *name,
270 umode_t mode,
271 struct dentry *parent,
272 unsigned long *value)
273{
274 return ERR_PTR(-ENODEV);
275}
276
c7c11689
GKH
277static inline void debugfs_create_x8(const char *name, umode_t mode,
278 struct dentry *parent, u8 *value) { }
2ebefc50 279
e40d38f2
GKH
280static inline void debugfs_create_x16(const char *name, umode_t mode,
281 struct dentry *parent, u16 *value) { }
2ebefc50 282
f5cb0a7e
GKH
283static inline void debugfs_create_x32(const char *name, umode_t mode,
284 struct dentry *parent, u32 *value) { }
2ebefc50 285
0864c408
GKH
286static inline void debugfs_create_x64(const char *name, umode_t mode,
287 struct dentry *parent, u64 *value) { }
3159269e 288
8e580263
GKH
289static inline void debugfs_create_size_t(const char *name, umode_t mode,
290 struct dentry *parent, size_t *value)
291{ }
8adb711f 292
9927c6fa
GKH
293static inline void debugfs_create_atomic_t(const char *name, umode_t mode,
294 struct dentry *parent,
295 atomic_t *value)
296{ }
5b880214 297
f4ae40a6 298static inline struct dentry *debugfs_create_bool(const char *name, umode_t mode,
1da177e4 299 struct dentry *parent,
621a5f7a 300 bool *value)
1da177e4
LT
301{
302 return ERR_PTR(-ENODEV);
303}
304
9af0440e
PZ
305static inline void debugfs_create_str(const char *name, umode_t mode,
306 struct dentry *parent,
307 char **value)
308{ }
309
f4ae40a6 310static inline struct dentry *debugfs_create_blob(const char *name, umode_t mode,
dd308bc3
ME
311 struct dentry *parent,
312 struct debugfs_blob_wrapper *blob)
313{
314 return ERR_PTR(-ENODEV);
315}
316
ae91c925
GKH
317static inline void debugfs_create_regset32(const char *name, umode_t mode,
318 struct dentry *parent,
319 struct debugfs_regset32 *regset)
1a087c6a 320{
1a087c6a
AR
321}
322
9761536e 323static inline void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
5b880214
WY
324 int nregs, void __iomem *base, char *prefix)
325{
5b880214
WY
326}
327
c0f92ba9
FW
328static inline bool debugfs_initialized(void)
329{
330 return false;
331}
332
c9c2c27d 333static inline void debugfs_create_u32_array(const char *name, umode_t mode,
a2b992c8
JK
334 struct dentry *parent,
335 struct debugfs_u32_array *array)
9fe2a701 336{
9fe2a701
SV
337}
338
0d519cbf
GKH
339static inline void debugfs_create_devm_seqfile(struct device *dev,
340 const char *name,
341 struct dentry *parent,
342 int (*read_fn)(struct seq_file *s,
343 void *data))
98210b7f 344{
98210b7f
AS
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
9af0440e
PZ
361static inline ssize_t debugfs_read_file_str(struct file *file,
362 char __user *user_buf,
363 size_t count, loff_t *ppos)
364{
365 return -ENODEV;
366}
367
1da177e4
LT
368#endif
369
d3504757
GU
370/**
371 * debugfs_create_xul - create a debugfs file that is used to read and write an
372 * unsigned long value, formatted in hexadecimal
373 * @name: a pointer to a string containing the name of the file to create.
374 * @mode: the permission that the file should have
375 * @parent: a pointer to the parent dentry for this file. This should be a
376 * directory dentry if set. If this parameter is %NULL, then the
377 * file will be created in the root of the debugfs filesystem.
378 * @value: a pointer to the variable that the file should read to and write
379 * from.
380 */
381static inline void debugfs_create_xul(const char *name, umode_t mode,
382 struct dentry *parent,
383 unsigned long *value)
384{
385 if (sizeof(*value) == sizeof(u32))
386 debugfs_create_x32(name, mode, parent, (u32 *)value);
387 else
388 debugfs_create_x64(name, mode, parent, (u64 *)value);
389}
390
1da177e4 391#endif