debugfs: introduce stub for debugfs_create_size_t() when DEBUG_FS=n
[linux-2.6.git] / include / linux / debugfs.h
1 /*
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
20 #include <linux/types.h>
21
22 struct file_operations;
23
24 struct debugfs_blob_wrapper {
25         void *data;
26         unsigned long size;
27 };
28
29 extern struct dentry *arch_debugfs_dir;
30
31 #if defined(CONFIG_DEBUG_FS)
32
33 /* declared over in file.c */
34 extern const struct file_operations debugfs_file_operations;
35 extern const struct inode_operations debugfs_link_operations;
36
37 struct dentry *debugfs_create_file(const char *name, mode_t mode,
38                                    struct dentry *parent, void *data,
39                                    const struct file_operations *fops);
40
41 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
42
43 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
44                                       const char *dest);
45
46 void debugfs_remove(struct dentry *dentry);
47 void debugfs_remove_recursive(struct dentry *dentry);
48
49 struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
50                 struct dentry *new_dir, const char *new_name);
51
52 struct dentry *debugfs_create_u8(const char *name, mode_t mode,
53                                  struct dentry *parent, u8 *value);
54 struct dentry *debugfs_create_u16(const char *name, mode_t mode,
55                                   struct dentry *parent, u16 *value);
56 struct dentry *debugfs_create_u32(const char *name, mode_t mode,
57                                   struct dentry *parent, u32 *value);
58 struct dentry *debugfs_create_u64(const char *name, mode_t mode,
59                                   struct dentry *parent, u64 *value);
60 struct dentry *debugfs_create_x8(const char *name, mode_t mode,
61                                  struct dentry *parent, u8 *value);
62 struct dentry *debugfs_create_x16(const char *name, mode_t mode,
63                                   struct dentry *parent, u16 *value);
64 struct dentry *debugfs_create_x32(const char *name, mode_t mode,
65                                   struct dentry *parent, u32 *value);
66 struct dentry *debugfs_create_size_t(const char *name, mode_t mode,
67                                      struct dentry *parent, size_t *value);
68 struct dentry *debugfs_create_bool(const char *name, mode_t mode,
69                                   struct dentry *parent, u32 *value);
70
71 struct dentry *debugfs_create_blob(const char *name, mode_t mode,
72                                   struct dentry *parent,
73                                   struct debugfs_blob_wrapper *blob);
74 #else
75
76 #include <linux/err.h>
77
78 /* 
79  * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
80  * so users have a chance to detect if there was a real error or not.  We don't
81  * want to duplicate the design decision mistakes of procfs and devfs again.
82  */
83
84 static inline struct dentry *debugfs_create_file(const char *name, mode_t mode,
85                                         struct dentry *parent, void *data,
86                                         const struct file_operations *fops)
87 {
88         return ERR_PTR(-ENODEV);
89 }
90
91 static inline struct dentry *debugfs_create_dir(const char *name,
92                                                 struct dentry *parent)
93 {
94         return ERR_PTR(-ENODEV);
95 }
96
97 static inline struct dentry *debugfs_create_symlink(const char *name,
98                                                     struct dentry *parent,
99                                                     const char *dest)
100 {
101         return ERR_PTR(-ENODEV);
102 }
103
104 static inline void debugfs_remove(struct dentry *dentry)
105 { }
106
107 static inline void debugfs_remove_recursive(struct dentry *dentry)
108 { }
109
110 static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
111                 struct dentry *new_dir, char *new_name)
112 {
113         return ERR_PTR(-ENODEV);
114 }
115
116 static inline struct dentry *debugfs_create_u8(const char *name, mode_t mode,
117                                                struct dentry *parent,
118                                                u8 *value)
119 {
120         return ERR_PTR(-ENODEV);
121 }
122
123 static inline struct dentry *debugfs_create_u16(const char *name, mode_t mode,
124                                                 struct dentry *parent,
125                                                 u16 *value)
126 {
127         return ERR_PTR(-ENODEV);
128 }
129
130 static inline struct dentry *debugfs_create_u32(const char *name, mode_t mode,
131                                                 struct dentry *parent,
132                                                 u32 *value)
133 {
134         return ERR_PTR(-ENODEV);
135 }
136
137 static inline struct dentry *debugfs_create_u64(const char *name, mode_t mode,
138                                                 struct dentry *parent,
139                                                 u64 *value)
140 {
141         return ERR_PTR(-ENODEV);
142 }
143
144 static inline struct dentry *debugfs_create_x8(const char *name, mode_t mode,
145                                                struct dentry *parent,
146                                                u8 *value)
147 {
148         return ERR_PTR(-ENODEV);
149 }
150
151 static inline struct dentry *debugfs_create_x16(const char *name, mode_t mode,
152                                                 struct dentry *parent,
153                                                 u16 *value)
154 {
155         return ERR_PTR(-ENODEV);
156 }
157
158 static inline struct dentry *debugfs_create_x32(const char *name, mode_t mode,
159                                                 struct dentry *parent,
160                                                 u32 *value)
161 {
162         return ERR_PTR(-ENODEV);
163 }
164
165 struct dentry *debugfs_create_size_t(const char *name, mode_t mode,
166                                      struct dentry *parent,
167                                      size_t *value)
168 {
169         return ERR_PTR(-ENODEV);
170 }
171
172 static inline struct dentry *debugfs_create_bool(const char *name, mode_t mode,
173                                                  struct dentry *parent,
174                                                  u32 *value)
175 {
176         return ERR_PTR(-ENODEV);
177 }
178
179 static inline struct dentry *debugfs_create_blob(const char *name, mode_t mode,
180                                   struct dentry *parent,
181                                   struct debugfs_blob_wrapper *blob)
182 {
183         return ERR_PTR(-ENODEV);
184 }
185
186 #endif
187
188 #endif