blob: a5fa6a6eede814ab502894736146fde295dee8c5 [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
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#if defined(CONFIG_DEBUG_FS)
25struct dentry *debugfs_create_file(const char *name, mode_t mode,
26 struct dentry *parent, void *data,
27 struct file_operations *fops);
28
29struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
30
31void debugfs_remove(struct dentry *dentry);
32
33struct dentry *debugfs_create_u8(const char *name, mode_t mode,
34 struct dentry *parent, u8 *value);
35struct dentry *debugfs_create_u16(const char *name, mode_t mode,
36 struct dentry *parent, u16 *value);
37struct dentry *debugfs_create_u32(const char *name, mode_t mode,
38 struct dentry *parent, u32 *value);
39struct dentry *debugfs_create_bool(const char *name, mode_t mode,
40 struct dentry *parent, u32 *value);
41
42#else
Roland Dreiera7a76ce2005-04-18 21:57:33 -070043
44#include <linux/err.h>
45
Linus Torvalds1da177e2005-04-16 15:20:36 -070046/*
47 * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
48 * so users have a chance to detect if there was a real error or not. We don't
49 * want to duplicate the design decision mistakes of procfs and devfs again.
50 */
51
52static inline struct dentry *debugfs_create_file(const char *name, mode_t mode,
53 struct dentry *parent,
54 void *data,
55 struct file_operations *fops)
56{
57 return ERR_PTR(-ENODEV);
58}
59
60static inline struct dentry *debugfs_create_dir(const char *name,
61 struct dentry *parent)
62{
63 return ERR_PTR(-ENODEV);
64}
65
66static inline void debugfs_remove(struct dentry *dentry)
67{ }
68
69static inline struct dentry *debugfs_create_u8(const char *name, mode_t mode,
70 struct dentry *parent,
71 u8 *value)
72{
73 return ERR_PTR(-ENODEV);
74}
75
76static inline struct dentry *debugfs_create_u16(const char *name, mode_t mode,
77 struct dentry *parent,
Michal Ostrowski7b558632005-04-18 21:57:34 -070078 u16 *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -070079{
80 return ERR_PTR(-ENODEV);
81}
82
83static inline struct dentry *debugfs_create_u32(const char *name, mode_t mode,
84 struct dentry *parent,
Michal Ostrowski7b558632005-04-18 21:57:34 -070085 u32 *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -070086{
87 return ERR_PTR(-ENODEV);
88}
89
90static inline struct dentry *debugfs_create_bool(const char *name, mode_t mode,
91 struct dentry *parent,
Michal Ostrowski7b558632005-04-18 21:57:34 -070092 u32 *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -070093{
94 return ERR_PTR(-ENODEV);
95}
96
97#endif
98
99#endif