blob: f592d6de3b971592a2b289e57175d776c212f3b1 [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)
30struct dentry *debugfs_create_file(const char *name, mode_t mode,
31 struct dentry *parent, void *data,
Arjan van de Ven99ac48f2006-03-28 01:56:41 -080032 const struct file_operations *fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
34struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
35
Peter Oberparleiter66f54962007-02-13 12:13:54 +010036struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
37 const char *dest);
38
Linus Torvalds1da177e2005-04-16 15:20:36 -070039void debugfs_remove(struct dentry *dentry);
40
Jan Karacfc94cd2007-05-09 13:19:52 +020041struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
42 struct dentry *new_dir, const char *new_name);
43
Linus Torvalds1da177e2005-04-16 15:20:36 -070044struct dentry *debugfs_create_u8(const char *name, mode_t mode,
45 struct dentry *parent, u8 *value);
46struct dentry *debugfs_create_u16(const char *name, mode_t mode,
47 struct dentry *parent, u16 *value);
48struct dentry *debugfs_create_u32(const char *name, mode_t mode,
49 struct dentry *parent, u32 *value);
Michael Ellerman84478912007-04-17 15:59:36 +100050struct dentry *debugfs_create_u64(const char *name, mode_t mode,
51 struct dentry *parent, u64 *value);
Robin Getz2ebefc52007-08-02 18:23:50 -040052struct dentry *debugfs_create_x8(const char *name, mode_t mode,
53 struct dentry *parent, u8 *value);
54struct dentry *debugfs_create_x16(const char *name, mode_t mode,
55 struct dentry *parent, u16 *value);
56struct dentry *debugfs_create_x32(const char *name, mode_t mode,
57 struct dentry *parent, u32 *value);
Linus Torvalds1da177e2005-04-16 15:20:36 -070058struct dentry *debugfs_create_bool(const char *name, mode_t mode,
59 struct dentry *parent, u32 *value);
60
Michael Ellermandd308bc2006-03-07 21:41:59 +110061struct dentry *debugfs_create_blob(const char *name, mode_t mode,
62 struct dentry *parent,
63 struct debugfs_blob_wrapper *blob);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064#else
Roland Dreiera7a76ce2005-04-18 21:57:33 -070065
66#include <linux/err.h>
67
Linus Torvalds1da177e2005-04-16 15:20:36 -070068/*
69 * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
70 * so users have a chance to detect if there was a real error or not. We don't
71 * want to duplicate the design decision mistakes of procfs and devfs again.
72 */
73
74static inline struct dentry *debugfs_create_file(const char *name, mode_t mode,
Jean Delvarebde11d72006-04-18 21:30:22 -070075 struct dentry *parent, void *data,
76 const struct file_operations *fops)
Linus Torvalds1da177e2005-04-16 15:20:36 -070077{
78 return ERR_PTR(-ENODEV);
79}
80
81static inline struct dentry *debugfs_create_dir(const char *name,
82 struct dentry *parent)
83{
84 return ERR_PTR(-ENODEV);
85}
86
Peter Oberparleiter66f54962007-02-13 12:13:54 +010087static inline struct dentry *debugfs_create_symlink(const char *name,
88 struct dentry *parent,
89 const char *dest)
90{
91 return ERR_PTR(-ENODEV);
92}
93
Linus Torvalds1da177e2005-04-16 15:20:36 -070094static inline void debugfs_remove(struct dentry *dentry)
95{ }
96
Jan Karacfc94cd2007-05-09 13:19:52 +020097static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
98 struct dentry *new_dir, char *new_name)
99{
100 return ERR_PTR(-ENODEV);
101}
102
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103static inline struct dentry *debugfs_create_u8(const char *name, mode_t mode,
104 struct dentry *parent,
105 u8 *value)
106{
107 return ERR_PTR(-ENODEV);
108}
109
110static inline struct dentry *debugfs_create_u16(const char *name, mode_t mode,
111 struct dentry *parent,
Michal Ostrowski7b558632005-04-18 21:57:34 -0700112 u16 *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113{
114 return ERR_PTR(-ENODEV);
115}
116
117static inline struct dentry *debugfs_create_u32(const char *name, mode_t mode,
118 struct dentry *parent,
Michal Ostrowski7b558632005-04-18 21:57:34 -0700119 u32 *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120{
121 return ERR_PTR(-ENODEV);
122}
123
Michael Ellerman84478912007-04-17 15:59:36 +1000124static inline struct dentry *debugfs_create_u64(const char *name, mode_t mode,
125 struct dentry *parent,
126 u64 *value)
127{
128 return ERR_PTR(-ENODEV);
129}
130
Robin Getz2ebefc52007-08-02 18:23:50 -0400131static inline struct dentry *debugfs_create_x8(const char *name, mode_t mode,
132 struct dentry *parent,
133 u8 *value)
134{
135 return ERR_PTR(-ENODEV);
136}
137
138static inline struct dentry *debugfs_create_x16(const char *name, mode_t mode,
139 struct dentry *parent,
140 u16 *value)
141{
142 return ERR_PTR(-ENODEV);
143}
144
145static inline struct dentry *debugfs_create_x32(const char *name, mode_t mode,
146 struct dentry *parent,
147 u32 *value)
148{
149 return ERR_PTR(-ENODEV);
150}
151
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152static inline struct dentry *debugfs_create_bool(const char *name, mode_t mode,
153 struct dentry *parent,
Michal Ostrowski7b558632005-04-18 21:57:34 -0700154 u32 *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155{
156 return ERR_PTR(-ENODEV);
157}
158
Michael Ellermandd308bc2006-03-07 21:41:59 +1100159static inline struct dentry *debugfs_create_blob(const char *name, mode_t mode,
160 struct dentry *parent,
161 struct debugfs_blob_wrapper *blob)
162{
163 return ERR_PTR(-ENODEV);
164}
165
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166#endif
167
168#endif