blob: 176e2d37157783153458fc1d8e57b53057482171 [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
36void debugfs_remove(struct dentry *dentry);
37
38struct dentry *debugfs_create_u8(const char *name, mode_t mode,
39 struct dentry *parent, u8 *value);
40struct dentry *debugfs_create_u16(const char *name, mode_t mode,
41 struct dentry *parent, u16 *value);
42struct dentry *debugfs_create_u32(const char *name, mode_t mode,
43 struct dentry *parent, u32 *value);
44struct dentry *debugfs_create_bool(const char *name, mode_t mode,
45 struct dentry *parent, u32 *value);
46
Michael Ellermandd308bc2006-03-07 21:41:59 +110047struct dentry *debugfs_create_blob(const char *name, mode_t mode,
48 struct dentry *parent,
49 struct debugfs_blob_wrapper *blob);
Linus Torvalds1da177e2005-04-16 15:20:36 -070050#else
Roland Dreiera7a76ce2005-04-18 21:57:33 -070051
52#include <linux/err.h>
53
Linus Torvalds1da177e2005-04-16 15:20:36 -070054/*
55 * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
56 * so users have a chance to detect if there was a real error or not. We don't
57 * want to duplicate the design decision mistakes of procfs and devfs again.
58 */
59
60static inline struct dentry *debugfs_create_file(const char *name, mode_t mode,
61 struct dentry *parent,
62 void *data,
63 struct file_operations *fops)
64{
65 return ERR_PTR(-ENODEV);
66}
67
68static inline struct dentry *debugfs_create_dir(const char *name,
69 struct dentry *parent)
70{
71 return ERR_PTR(-ENODEV);
72}
73
74static inline void debugfs_remove(struct dentry *dentry)
75{ }
76
77static inline struct dentry *debugfs_create_u8(const char *name, mode_t mode,
78 struct dentry *parent,
79 u8 *value)
80{
81 return ERR_PTR(-ENODEV);
82}
83
84static inline struct dentry *debugfs_create_u16(const char *name, mode_t mode,
85 struct dentry *parent,
Michal Ostrowski7b558632005-04-18 21:57:34 -070086 u16 *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -070087{
88 return ERR_PTR(-ENODEV);
89}
90
91static inline struct dentry *debugfs_create_u32(const char *name, mode_t mode,
92 struct dentry *parent,
Michal Ostrowski7b558632005-04-18 21:57:34 -070093 u32 *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -070094{
95 return ERR_PTR(-ENODEV);
96}
97
98static inline struct dentry *debugfs_create_bool(const char *name, mode_t mode,
99 struct dentry *parent,
Michal Ostrowski7b558632005-04-18 21:57:34 -0700100 u32 *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101{
102 return ERR_PTR(-ENODEV);
103}
104
Michael Ellermandd308bc2006-03-07 21:41:59 +1100105static inline struct dentry *debugfs_create_blob(const char *name, mode_t mode,
106 struct dentry *parent,
107 struct debugfs_blob_wrapper *blob)
108{
109 return ERR_PTR(-ENODEV);
110}
111
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112#endif
113
114#endif