blob: 7266124361b44f24259db727c7dc23d0694fb8de [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * debugfs.h - a tiny little debug file system
3 *
4 * Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
5 * Copyright (C) 2004 IBM Inc.
6 *
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.
10 *
11 * debugfs is for people to use instead of /proc or /sys.
12 * See Documentation/DocBook/kernel-api for more details.
13 */
14
15#ifndef _DEBUGFS_H_
16#define _DEBUGFS_H_
17
18#include <linux/fs.h>
19
Roland Dreiera7a76ce2005-04-18 21:57:33 -070020#include <linux/types.h>
21
22struct file_operations;
23
Michael Ellermandd308bc2006-03-07 21:41:59 +110024struct debugfs_blob_wrapper {
25 void *data;
26 unsigned long size;
27};
28
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#if defined(CONFIG_DEBUG_FS)
Harvey Harrison36346342008-02-13 17:08:16 -080030
31/* declared over in file.c */
32extern const struct file_operations debugfs_file_operations;
33extern const struct inode_operations debugfs_link_operations;
34
Linus Torvalds1da177e2005-04-16 15:20:36 -070035struct dentry *debugfs_create_file(const char *name, mode_t mode,
36 struct dentry *parent, void *data,
Arjan van de Ven99ac48f2006-03-28 01:56:41 -080037 const struct file_operations *fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
39struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
40
Peter Oberparleiter66f54962007-02-13 12:13:54 +010041struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
42 const char *dest);
43
Linus Torvalds1da177e2005-04-16 15:20:36 -070044void debugfs_remove(struct dentry *dentry);
45
Jan Karacfc94cd2007-05-09 13:19:52 +020046struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
47 struct dentry *new_dir, const char *new_name);
48
Linus Torvalds1da177e2005-04-16 15:20:36 -070049struct dentry *debugfs_create_u8(const char *name, mode_t mode,
50 struct dentry *parent, u8 *value);
51struct dentry *debugfs_create_u16(const char *name, mode_t mode,
52 struct dentry *parent, u16 *value);
53struct dentry *debugfs_create_u32(const char *name, mode_t mode,
54 struct dentry *parent, u32 *value);
Michael Ellerman84478912007-04-17 15:59:36 +100055struct dentry *debugfs_create_u64(const char *name, mode_t mode,
56 struct dentry *parent, u64 *value);
Robin Getz2ebefc52007-08-02 18:23:50 -040057struct dentry *debugfs_create_x8(const char *name, mode_t mode,
58 struct dentry *parent, u8 *value);
59struct dentry *debugfs_create_x16(const char *name, mode_t mode,
60 struct dentry *parent, u16 *value);
61struct dentry *debugfs_create_x32(const char *name, mode_t mode,
62 struct dentry *parent, u32 *value);
Linus Torvalds1da177e2005-04-16 15:20:36 -070063struct dentry *debugfs_create_bool(const char *name, mode_t mode,
64 struct dentry *parent, u32 *value);
65
Michael Ellermandd308bc2006-03-07 21:41:59 +110066struct dentry *debugfs_create_blob(const char *name, mode_t mode,
67 struct dentry *parent,
68 struct debugfs_blob_wrapper *blob);
Linus Torvalds1da177e2005-04-16 15:20:36 -070069#else
Roland Dreiera7a76ce2005-04-18 21:57:33 -070070
71#include <linux/err.h>
72
Linus Torvalds1da177e2005-04-16 15:20:36 -070073/*
74 * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
75 * so users have a chance to detect if there was a real error or not. We don't
76 * want to duplicate the design decision mistakes of procfs and devfs again.
77 */
78
79static inline struct dentry *debugfs_create_file(const char *name, mode_t mode,
Jean Delvarebde11d72006-04-18 21:30:22 -070080 struct dentry *parent, void *data,
81 const struct file_operations *fops)
Linus Torvalds1da177e2005-04-16 15:20:36 -070082{
83 return ERR_PTR(-ENODEV);
84}
85
86static inline struct dentry *debugfs_create_dir(const char *name,
87 struct dentry *parent)
88{
89 return ERR_PTR(-ENODEV);
90}
91
Peter Oberparleiter66f54962007-02-13 12:13:54 +010092static inline struct dentry *debugfs_create_symlink(const char *name,
93 struct dentry *parent,
94 const char *dest)
95{
96 return ERR_PTR(-ENODEV);
97}
98
Linus Torvalds1da177e2005-04-16 15:20:36 -070099static inline void debugfs_remove(struct dentry *dentry)
100{ }
101
Jan Karacfc94cd2007-05-09 13:19:52 +0200102static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
103 struct dentry *new_dir, char *new_name)
104{
105 return ERR_PTR(-ENODEV);
106}
107
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108static inline struct dentry *debugfs_create_u8(const char *name, mode_t mode,
109 struct dentry *parent,
110 u8 *value)
111{
112 return ERR_PTR(-ENODEV);
113}
114
115static inline struct dentry *debugfs_create_u16(const char *name, mode_t mode,
116 struct dentry *parent,
Michal Ostrowski7b558632005-04-18 21:57:34 -0700117 u16 *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118{
119 return ERR_PTR(-ENODEV);
120}
121
122static inline struct dentry *debugfs_create_u32(const char *name, mode_t mode,
123 struct dentry *parent,
Michal Ostrowski7b558632005-04-18 21:57:34 -0700124 u32 *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125{
126 return ERR_PTR(-ENODEV);
127}
128
Michael Ellerman84478912007-04-17 15:59:36 +1000129static inline struct dentry *debugfs_create_u64(const char *name, mode_t mode,
130 struct dentry *parent,
131 u64 *value)
132{
133 return ERR_PTR(-ENODEV);
134}
135
Robin Getz2ebefc52007-08-02 18:23:50 -0400136static inline struct dentry *debugfs_create_x8(const char *name, mode_t mode,
137 struct dentry *parent,
138 u8 *value)
139{
140 return ERR_PTR(-ENODEV);
141}
142
143static inline struct dentry *debugfs_create_x16(const char *name, mode_t mode,
144 struct dentry *parent,
145 u16 *value)
146{
147 return ERR_PTR(-ENODEV);
148}
149
150static inline struct dentry *debugfs_create_x32(const char *name, mode_t mode,
151 struct dentry *parent,
152 u32 *value)
153{
154 return ERR_PTR(-ENODEV);
155}
156
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157static inline struct dentry *debugfs_create_bool(const char *name, mode_t mode,
158 struct dentry *parent,
Michal Ostrowski7b558632005-04-18 21:57:34 -0700159 u32 *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160{
161 return ERR_PTR(-ENODEV);
162}
163
Michael Ellermandd308bc2006-03-07 21:41:59 +1100164static inline struct dentry *debugfs_create_blob(const char *name, mode_t mode,
165 struct dentry *parent,
166 struct debugfs_blob_wrapper *blob)
167{
168 return ERR_PTR(-ENODEV);
169}
170
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171#endif
172
173#endif