2 * debugfs.h - a tiny little debug file system
4 * Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
5 * Copyright (C) 2004 IBM Inc.
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.
11 * debugfs is for people to use instead of /proc or /sys.
12 * See Documentation/DocBook/filesystems for more details.
19 #include <linux/seq_file.h>
21 #include <linux/types.h>
23 struct file_operations
;
25 struct debugfs_blob_wrapper
{
30 struct debugfs_reg32
{
35 struct debugfs_regset32
{
36 const struct debugfs_reg32
*regs
;
41 extern struct dentry
*arch_debugfs_dir
;
43 #if defined(CONFIG_DEBUG_FS)
45 /* declared over in file.c */
46 extern const struct file_operations debugfs_file_operations
;
47 extern const struct inode_operations debugfs_link_operations
;
49 struct dentry
*debugfs_create_file(const char *name
, umode_t mode
,
50 struct dentry
*parent
, void *data
,
51 const struct file_operations
*fops
);
53 struct dentry
*debugfs_create_dir(const char *name
, struct dentry
*parent
);
55 struct dentry
*debugfs_create_symlink(const char *name
, struct dentry
*parent
,
58 void debugfs_remove(struct dentry
*dentry
);
59 void debugfs_remove_recursive(struct dentry
*dentry
);
61 struct dentry
*debugfs_rename(struct dentry
*old_dir
, struct dentry
*old_dentry
,
62 struct dentry
*new_dir
, const char *new_name
);
64 struct dentry
*debugfs_create_u8(const char *name
, umode_t mode
,
65 struct dentry
*parent
, u8
*value
);
66 struct dentry
*debugfs_create_u16(const char *name
, umode_t mode
,
67 struct dentry
*parent
, u16
*value
);
68 struct dentry
*debugfs_create_u32(const char *name
, umode_t mode
,
69 struct dentry
*parent
, u32
*value
);
70 struct dentry
*debugfs_create_u64(const char *name
, umode_t mode
,
71 struct dentry
*parent
, u64
*value
);
72 struct dentry
*debugfs_create_x8(const char *name
, umode_t mode
,
73 struct dentry
*parent
, u8
*value
);
74 struct dentry
*debugfs_create_x16(const char *name
, umode_t mode
,
75 struct dentry
*parent
, u16
*value
);
76 struct dentry
*debugfs_create_x32(const char *name
, umode_t mode
,
77 struct dentry
*parent
, u32
*value
);
78 struct dentry
*debugfs_create_x64(const char *name
, umode_t mode
,
79 struct dentry
*parent
, u64
*value
);
80 struct dentry
*debugfs_create_size_t(const char *name
, umode_t mode
,
81 struct dentry
*parent
, size_t *value
);
82 struct dentry
*debugfs_create_atomic_t(const char *name
, umode_t mode
,
83 struct dentry
*parent
, atomic_t
*value
);
84 struct dentry
*debugfs_create_bool(const char *name
, umode_t mode
,
85 struct dentry
*parent
, u32
*value
);
87 struct dentry
*debugfs_create_blob(const char *name
, umode_t mode
,
88 struct dentry
*parent
,
89 struct debugfs_blob_wrapper
*blob
);
91 struct dentry
*debugfs_create_regset32(const char *name
, umode_t mode
,
92 struct dentry
*parent
,
93 struct debugfs_regset32
*regset
);
95 int debugfs_print_regs32(struct seq_file
*s
, const struct debugfs_reg32
*regs
,
96 int nregs
, void __iomem
*base
, char *prefix
);
98 struct dentry
*debugfs_create_u32_array(const char *name
, umode_t mode
,
99 struct dentry
*parent
,
100 u32
*array
, u32 elements
);
102 bool debugfs_initialized(void);
106 #include <linux/err.h>
109 * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
110 * so users have a chance to detect if there was a real error or not. We don't
111 * want to duplicate the design decision mistakes of procfs and devfs again.
114 static inline struct dentry
*debugfs_create_file(const char *name
, umode_t mode
,
115 struct dentry
*parent
, void *data
,
116 const struct file_operations
*fops
)
118 return ERR_PTR(-ENODEV
);
121 static inline struct dentry
*debugfs_create_dir(const char *name
,
122 struct dentry
*parent
)
124 return ERR_PTR(-ENODEV
);
127 static inline struct dentry
*debugfs_create_symlink(const char *name
,
128 struct dentry
*parent
,
131 return ERR_PTR(-ENODEV
);
134 static inline void debugfs_remove(struct dentry
*dentry
)
137 static inline void debugfs_remove_recursive(struct dentry
*dentry
)
140 static inline struct dentry
*debugfs_rename(struct dentry
*old_dir
, struct dentry
*old_dentry
,
141 struct dentry
*new_dir
, char *new_name
)
143 return ERR_PTR(-ENODEV
);
146 static inline struct dentry
*debugfs_create_u8(const char *name
, umode_t mode
,
147 struct dentry
*parent
,
150 return ERR_PTR(-ENODEV
);
153 static inline struct dentry
*debugfs_create_u16(const char *name
, umode_t mode
,
154 struct dentry
*parent
,
157 return ERR_PTR(-ENODEV
);
160 static inline struct dentry
*debugfs_create_u32(const char *name
, umode_t mode
,
161 struct dentry
*parent
,
164 return ERR_PTR(-ENODEV
);
167 static inline struct dentry
*debugfs_create_u64(const char *name
, umode_t mode
,
168 struct dentry
*parent
,
171 return ERR_PTR(-ENODEV
);
174 static inline struct dentry
*debugfs_create_x8(const char *name
, umode_t mode
,
175 struct dentry
*parent
,
178 return ERR_PTR(-ENODEV
);
181 static inline struct dentry
*debugfs_create_x16(const char *name
, umode_t mode
,
182 struct dentry
*parent
,
185 return ERR_PTR(-ENODEV
);
188 static inline struct dentry
*debugfs_create_x32(const char *name
, umode_t mode
,
189 struct dentry
*parent
,
192 return ERR_PTR(-ENODEV
);
195 static inline struct dentry
*debugfs_create_x64(const char *name
, umode_t mode
,
196 struct dentry
*parent
,
199 return ERR_PTR(-ENODEV
);
202 static inline struct dentry
*debugfs_create_size_t(const char *name
, umode_t mode
,
203 struct dentry
*parent
,
206 return ERR_PTR(-ENODEV
);
209 static inline struct dentry
*debugfs_create_bool(const char *name
, umode_t mode
,
210 struct dentry
*parent
,
213 return ERR_PTR(-ENODEV
);
216 static inline struct dentry
*debugfs_create_blob(const char *name
, umode_t mode
,
217 struct dentry
*parent
,
218 struct debugfs_blob_wrapper
*blob
)
220 return ERR_PTR(-ENODEV
);
223 static inline struct dentry
*debugfs_create_regset32(const char *name
,
224 umode_t mode
, struct dentry
*parent
,
225 struct debugfs_regset32
*regset
)
227 return ERR_PTR(-ENODEV
);
230 static inline bool debugfs_initialized(void)
235 static inline struct dentry
*debugfs_create_u32_array(const char *name
, umode_t mode
,
236 struct dentry
*parent
,
237 u32
*array
, u32 elements
)
239 return ERR_PTR(-ENODEV
);