]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - include/linux/debugfs.h
Merge branch 'pci/microchip'
[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);
1da177e4 131
f4ae40a6 132struct dentry *debugfs_create_blob(const char *name, umode_t mode,
dd308bc3
ME
133 struct dentry *parent,
134 struct debugfs_blob_wrapper *blob);
c0f92ba9 135
ae91c925
GKH
136void debugfs_create_regset32(const char *name, umode_t mode,
137 struct dentry *parent,
138 struct debugfs_regset32 *regset);
1a087c6a 139
9761536e
JP
140void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
141 int nregs, void __iomem *base, char *prefix);
1a087c6a 142
c9c2c27d 143void debugfs_create_u32_array(const char *name, umode_t mode,
a2b992c8
JK
144 struct dentry *parent,
145 struct debugfs_u32_array *array);
9fe2a701 146
0d519cbf
GKH
147void debugfs_create_devm_seqfile(struct device *dev, const char *name,
148 struct dentry *parent,
149 int (*read_fn)(struct seq_file *s, void *data));
98210b7f 150
c0f92ba9
FW
151bool debugfs_initialized(void);
152
0642ef6f
RF
153ssize_t debugfs_read_file_bool(struct file *file, char __user *user_buf,
154 size_t count, loff_t *ppos);
155
156ssize_t debugfs_write_file_bool(struct file *file, const char __user *user_buf,
157 size_t count, loff_t *ppos);
158
1da177e4 159#else
a7a76cef
RD
160
161#include <linux/err.h>
162
98210b7f 163/*
1da177e4
LT
164 * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
165 * so users have a chance to detect if there was a real error or not. We don't
166 * want to duplicate the design decision mistakes of procfs and devfs again.
167 */
168
a7c5437b
OS
169static inline struct dentry *debugfs_lookup(const char *name,
170 struct dentry *parent)
171{
172 return ERR_PTR(-ENODEV);
173}
174
f4ae40a6 175static inline struct dentry *debugfs_create_file(const char *name, umode_t mode,
bde11d79
JD
176 struct dentry *parent, void *data,
177 const struct file_operations *fops)
1da177e4
LT
178{
179 return ERR_PTR(-ENODEV);
180}
181
c2a737eb
VK
182static inline struct dentry *debugfs_create_file_unsafe(const char *name,
183 umode_t mode, struct dentry *parent,
184 void *data,
185 const struct file_operations *fops)
186{
187 return ERR_PTR(-ENODEV);
188}
189
526ee72d
GKH
190static inline void debugfs_create_file_size(const char *name, umode_t mode,
191 struct dentry *parent, void *data,
192 const struct file_operations *fops,
193 loff_t file_size)
194{ }
e59b4e91 195
1da177e4
LT
196static inline struct dentry *debugfs_create_dir(const char *name,
197 struct dentry *parent)
198{
199 return ERR_PTR(-ENODEV);
200}
201
66f54963
PO
202static inline struct dentry *debugfs_create_symlink(const char *name,
203 struct dentry *parent,
204 const char *dest)
205{
206 return ERR_PTR(-ENODEV);
207}
208
94e1dec7
JW
209static inline struct dentry *debugfs_create_automount(const char *name,
210 struct dentry *parent,
4250b047 211 debugfs_automount_t f,
94e1dec7
JW
212 void *data)
213{
214 return ERR_PTR(-ENODEV);
215}
216
1da177e4
LT
217static inline void debugfs_remove(struct dentry *dentry)
218{ }
219
9505e637
HS
220static inline void debugfs_remove_recursive(struct dentry *dentry)
221{ }
222
f50caa9b
AB
223const struct file_operations *debugfs_real_fops(const struct file *filp);
224
e9117a5a
NS
225static inline int debugfs_file_get(struct dentry *dentry)
226{
227 return 0;
228}
229
230static inline void debugfs_file_put(struct dentry *dentry)
231{ }
232
7f847dd3
AB
233static inline ssize_t debugfs_attr_read(struct file *file, char __user *buf,
234 size_t len, loff_t *ppos)
235{
236 return -ENODEV;
237}
238
239static inline ssize_t debugfs_attr_write(struct file *file,
240 const char __user *buf,
241 size_t len, loff_t *ppos)
242{
243 return -ENODEV;
244}
c6468808 245
cfc94cdf
JK
246static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
247 struct dentry *new_dir, char *new_name)
248{
249 return ERR_PTR(-ENODEV);
250}
251
9655ac4a
GKH
252static inline void debugfs_create_u8(const char *name, umode_t mode,
253 struct dentry *parent, u8 *value) { }
1da177e4 254
313f5dbb
GKH
255static inline void debugfs_create_u16(const char *name, umode_t mode,
256 struct dentry *parent, u16 *value) { }
1da177e4 257
2b07021a
GKH
258static inline void debugfs_create_u32(const char *name, umode_t mode,
259 struct dentry *parent, u32 *value) { }
1da177e4 260
ad26221f
GKH
261static inline void debugfs_create_u64(const char *name, umode_t mode,
262 struct dentry *parent, u64 *value) { }
8447891f 263
c2a737eb
VK
264static inline struct dentry *debugfs_create_ulong(const char *name,
265 umode_t mode,
266 struct dentry *parent,
267 unsigned long *value)
268{
269 return ERR_PTR(-ENODEV);
270}
271
c7c11689
GKH
272static inline void debugfs_create_x8(const char *name, umode_t mode,
273 struct dentry *parent, u8 *value) { }
2ebefc50 274
e40d38f2
GKH
275static inline void debugfs_create_x16(const char *name, umode_t mode,
276 struct dentry *parent, u16 *value) { }
2ebefc50 277
f5cb0a7e
GKH
278static inline void debugfs_create_x32(const char *name, umode_t mode,
279 struct dentry *parent, u32 *value) { }
2ebefc50 280
0864c408
GKH
281static inline void debugfs_create_x64(const char *name, umode_t mode,
282 struct dentry *parent, u64 *value) { }
3159269e 283
8e580263
GKH
284static inline void debugfs_create_size_t(const char *name, umode_t mode,
285 struct dentry *parent, size_t *value)
286{ }
8adb711f 287
9927c6fa
GKH
288static inline void debugfs_create_atomic_t(const char *name, umode_t mode,
289 struct dentry *parent,
290 atomic_t *value)
291{ }
5b880214 292
f4ae40a6 293static inline struct dentry *debugfs_create_bool(const char *name, umode_t mode,
1da177e4 294 struct dentry *parent,
621a5f7a 295 bool *value)
1da177e4
LT
296{
297 return ERR_PTR(-ENODEV);
298}
299
f4ae40a6 300static inline struct dentry *debugfs_create_blob(const char *name, umode_t mode,
dd308bc3
ME
301 struct dentry *parent,
302 struct debugfs_blob_wrapper *blob)
303{
304 return ERR_PTR(-ENODEV);
305}
306
ae91c925
GKH
307static inline void debugfs_create_regset32(const char *name, umode_t mode,
308 struct dentry *parent,
309 struct debugfs_regset32 *regset)
1a087c6a 310{
1a087c6a
AR
311}
312
9761536e 313static inline void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
5b880214
WY
314 int nregs, void __iomem *base, char *prefix)
315{
5b880214
WY
316}
317
c0f92ba9
FW
318static inline bool debugfs_initialized(void)
319{
320 return false;
321}
322
c9c2c27d 323static inline void debugfs_create_u32_array(const char *name, umode_t mode,
a2b992c8
JK
324 struct dentry *parent,
325 struct debugfs_u32_array *array)
9fe2a701 326{
9fe2a701
SV
327}
328
0d519cbf
GKH
329static inline void debugfs_create_devm_seqfile(struct device *dev,
330 const char *name,
331 struct dentry *parent,
332 int (*read_fn)(struct seq_file *s,
333 void *data))
98210b7f 334{
98210b7f
AS
335}
336
0642ef6f
RF
337static inline ssize_t debugfs_read_file_bool(struct file *file,
338 char __user *user_buf,
339 size_t count, loff_t *ppos)
340{
341 return -ENODEV;
342}
343
344static inline ssize_t debugfs_write_file_bool(struct file *file,
345 const char __user *user_buf,
346 size_t count, loff_t *ppos)
347{
348 return -ENODEV;
349}
350
1da177e4
LT
351#endif
352
d3504757
GU
353/**
354 * debugfs_create_xul - create a debugfs file that is used to read and write an
355 * unsigned long value, formatted in hexadecimal
356 * @name: a pointer to a string containing the name of the file to create.
357 * @mode: the permission that the file should have
358 * @parent: a pointer to the parent dentry for this file. This should be a
359 * directory dentry if set. If this parameter is %NULL, then the
360 * file will be created in the root of the debugfs filesystem.
361 * @value: a pointer to the variable that the file should read to and write
362 * from.
363 */
364static inline void debugfs_create_xul(const char *name, umode_t mode,
365 struct dentry *parent,
366 unsigned long *value)
367{
368 if (sizeof(*value) == sizeof(u32))
369 debugfs_create_x32(name, mode, parent, (u32 *)value);
370 else
371 debugfs_create_x64(name, mode, parent, (u64 *)value);
372}
373
1da177e4 374#endif