blob: 104e51e20e14a56b67e97b868e1bf2847d8b1f91 [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);
Linus Torvalds1da177e2005-04-16 15:20:36 -070052struct dentry *debugfs_create_bool(const char *name, mode_t mode,
53 struct dentry *parent, u32 *value);
54
Michael Ellermandd308bc2006-03-07 21:41:59 +110055struct dentry *debugfs_create_blob(const char *name, mode_t mode,
56 struct dentry *parent,
57 struct debugfs_blob_wrapper *blob);
Linus Torvalds1da177e2005-04-16 15:20:36 -070058#else
Roland Dreiera7a76ce2005-04-18 21:57:33 -070059
60#include <linux/err.h>
61
Linus Torvalds1da177e2005-04-16 15:20:36 -070062/*
63 * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
64 * so users have a chance to detect if there was a real error or not. We don't
65 * want to duplicate the design decision mistakes of procfs and devfs again.
66 */
67
68static inline struct dentry *debugfs_create_file(const char *name, mode_t mode,
Jean Delvarebde11d72006-04-18 21:30:22 -070069 struct dentry *parent, void *data,
70 const struct file_operations *fops)
Linus Torvalds1da177e2005-04-16 15:20:36 -070071{
72 return ERR_PTR(-ENODEV);
73}
74
75static inline struct dentry *debugfs_create_dir(const char *name,
76 struct dentry *parent)
77{
78 return ERR_PTR(-ENODEV);
79}
80
Peter Oberparleiter66f54962007-02-13 12:13:54 +010081static inline struct dentry *debugfs_create_symlink(const char *name,
82 struct dentry *parent,
83 const char *dest)
84{
85 return ERR_PTR(-ENODEV);
86}
87
Linus Torvalds1da177e2005-04-16 15:20:36 -070088static inline void debugfs_remove(struct dentry *dentry)
89{ }
90
Jan Karacfc94cd2007-05-09 13:19:52 +020091static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
92 struct dentry *new_dir, char *new_name)
93{
94 return ERR_PTR(-ENODEV);
95}
96
Linus Torvalds1da177e2005-04-16 15:20:36 -070097static inline struct dentry *debugfs_create_u8(const char *name, mode_t mode,
98 struct dentry *parent,
99 u8 *value)
100{
101 return ERR_PTR(-ENODEV);
102}
103
104static inline struct dentry *debugfs_create_u16(const char *name, mode_t mode,
105 struct dentry *parent,
Michal Ostrowski7b558632005-04-18 21:57:34 -0700106 u16 *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107{
108 return ERR_PTR(-ENODEV);
109}
110
111static inline struct dentry *debugfs_create_u32(const char *name, mode_t mode,
112 struct dentry *parent,
Michal Ostrowski7b558632005-04-18 21:57:34 -0700113 u32 *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114{
115 return ERR_PTR(-ENODEV);
116}
117
Michael Ellerman84478912007-04-17 15:59:36 +1000118static inline struct dentry *debugfs_create_u64(const char *name, mode_t mode,
119 struct dentry *parent,
120 u64 *value)
121{
122 return ERR_PTR(-ENODEV);
123}
124
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125static inline struct dentry *debugfs_create_bool(const char *name, mode_t mode,
126 struct dentry *parent,
Michal Ostrowski7b558632005-04-18 21:57:34 -0700127 u32 *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128{
129 return ERR_PTR(-ENODEV);
130}
131
Michael Ellermandd308bc2006-03-07 21:41:59 +1100132static inline struct dentry *debugfs_create_blob(const char *name, mode_t mode,
133 struct dentry *parent,
134 struct debugfs_blob_wrapper *blob)
135{
136 return ERR_PTR(-ENODEV);
137}
138
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139#endif
140
141#endif