Blame view

include/linux/debugfs.h 6 KB
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1
2
3
4
5
6
7
8
9
10
11
  /*
   *  debugfs.h - a tiny little debug file system
   *
   *  Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
   *  Copyright (C) 2004 IBM Inc.
   *
   *	This program is free software; you can redistribute it and/or
   *	modify it under the terms of the GNU General Public License version
   *	2 as published by the Free Software Foundation.
   *
   *  debugfs is for people to use instead of /proc or /sys.
55dff4954   Randy Dunlap   docs: fix various...
12
   *  See Documentation/DocBook/filesystems for more details.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
13
14
15
16
17
18
   */
  
  #ifndef _DEBUGFS_H_
  #define _DEBUGFS_H_
  
  #include <linux/fs.h>
1a087c6ad   Alessandro Rubini   debugfs: add tool...
19
  #include <linux/seq_file.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
20

a7a76cefc   Roland Dreier   [PATCH] debugfs: ...
21
22
23
  #include <linux/types.h>
  
  struct file_operations;
dd308bc35   Michael Ellerman   [PATCH] debugfs: ...
24
25
26
27
  struct debugfs_blob_wrapper {
  	void *data;
  	unsigned long size;
  };
1a087c6ad   Alessandro Rubini   debugfs: add tool...
28
29
30
31
32
33
34
35
36
37
  struct debugfs_reg32 {
  	char *name;
  	unsigned long offset;
  };
  
  struct debugfs_regset32 {
  	struct debugfs_reg32 *regs;
  	int nregs;
  	void __iomem *base;
  };
ae79cdaac   venkatesh.pallipadi@intel.com   x86: Add a arch d...
38
  extern struct dentry *arch_debugfs_dir;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
39
  #if defined(CONFIG_DEBUG_FS)
3634634ed   Harvey Harrison   debugfs: fix spar...
40
41
42
43
  
  /* declared over in file.c */
  extern const struct file_operations debugfs_file_operations;
  extern const struct inode_operations debugfs_link_operations;
f4ae40a6a   Al Viro   switch debugfs to...
44
  struct dentry *debugfs_create_file(const char *name, umode_t mode,
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
45
  				   struct dentry *parent, void *data,
99ac48f54   Arjan van de Ven   [PATCH] mark f_op...
46
  				   const struct file_operations *fops);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
47
48
  
  struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
66f549639   Peter Oberparleiter   debugfs: implemen...
49
50
  struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
  				      const char *dest);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
51
  void debugfs_remove(struct dentry *dentry);
9505e6375   Haavard Skinnemoen   debugfs: Implemen...
52
  void debugfs_remove_recursive(struct dentry *dentry);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
53

cfc94cdf8   Jan Kara   debugfs: add rena...
54
55
  struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
                  struct dentry *new_dir, const char *new_name);
f4ae40a6a   Al Viro   switch debugfs to...
56
  struct dentry *debugfs_create_u8(const char *name, umode_t mode,
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
57
  				 struct dentry *parent, u8 *value);
f4ae40a6a   Al Viro   switch debugfs to...
58
  struct dentry *debugfs_create_u16(const char *name, umode_t mode,
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
59
  				  struct dentry *parent, u16 *value);
f4ae40a6a   Al Viro   switch debugfs to...
60
  struct dentry *debugfs_create_u32(const char *name, umode_t mode,
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
61
  				  struct dentry *parent, u32 *value);
f4ae40a6a   Al Viro   switch debugfs to...
62
  struct dentry *debugfs_create_u64(const char *name, umode_t mode,
8447891fe   Michael Ellerman   debugfs: Add debu...
63
  				  struct dentry *parent, u64 *value);
f4ae40a6a   Al Viro   switch debugfs to...
64
  struct dentry *debugfs_create_x8(const char *name, umode_t mode,
2ebefc501   Robin Getz   debugfs: helper f...
65
  				 struct dentry *parent, u8 *value);
f4ae40a6a   Al Viro   switch debugfs to...
66
  struct dentry *debugfs_create_x16(const char *name, umode_t mode,
2ebefc501   Robin Getz   debugfs: helper f...
67
  				  struct dentry *parent, u16 *value);
f4ae40a6a   Al Viro   switch debugfs to...
68
  struct dentry *debugfs_create_x32(const char *name, umode_t mode,
2ebefc501   Robin Getz   debugfs: helper f...
69
  				  struct dentry *parent, u32 *value);
f4ae40a6a   Al Viro   switch debugfs to...
70
  struct dentry *debugfs_create_x64(const char *name, umode_t mode,
15b0beaa3   Huang Ying   Add x64 support t...
71
  				  struct dentry *parent, u64 *value);
f4ae40a6a   Al Viro   switch debugfs to...
72
  struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
5e0787878   Inaky Perez-Gonzalez   debugfs: add help...
73
  				     struct dentry *parent, size_t *value);
f4ae40a6a   Al Viro   switch debugfs to...
74
  struct dentry *debugfs_create_bool(const char *name, umode_t mode,
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
75
  				  struct dentry *parent, u32 *value);
f4ae40a6a   Al Viro   switch debugfs to...
76
  struct dentry *debugfs_create_blob(const char *name, umode_t mode,
dd308bc35   Michael Ellerman   [PATCH] debugfs: ...
77
78
  				  struct dentry *parent,
  				  struct debugfs_blob_wrapper *blob);
c0f92ba99   Frederic Weisbecker   debugfs: function...
79

1a087c6ad   Alessandro Rubini   debugfs: add tool...
80
81
82
  struct dentry *debugfs_create_regset32(const char *name, mode_t mode,
  				     struct dentry *parent,
  				     struct debugfs_regset32 *regset);
8ee4dd9f0   Alessandro Rubini   debugfs: print_re...
83
  int debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
1a087c6ad   Alessandro Rubini   debugfs: add tool...
84
  			 int nregs, void __iomem *base, char *prefix);
c0f92ba99   Frederic Weisbecker   debugfs: function...
85
  bool debugfs_initialized(void);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
86
  #else
a7a76cefc   Roland Dreier   [PATCH] debugfs: ...
87
88
  
  #include <linux/err.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
89
90
91
92
93
  /* 
   * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
   * so users have a chance to detect if there was a real error or not.  We don't
   * want to duplicate the design decision mistakes of procfs and devfs again.
   */
f4ae40a6a   Al Viro   switch debugfs to...
94
  static inline struct dentry *debugfs_create_file(const char *name, umode_t mode,
bde11d794   Jean Delvare   [PATCH] Fix OCFS2...
95
96
  					struct dentry *parent, void *data,
  					const struct file_operations *fops)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
97
98
99
100
101
102
103
104
105
  {
  	return ERR_PTR(-ENODEV);
  }
  
  static inline struct dentry *debugfs_create_dir(const char *name,
  						struct dentry *parent)
  {
  	return ERR_PTR(-ENODEV);
  }
66f549639   Peter Oberparleiter   debugfs: implemen...
106
107
108
109
110
111
  static inline struct dentry *debugfs_create_symlink(const char *name,
  						    struct dentry *parent,
  						    const char *dest)
  {
  	return ERR_PTR(-ENODEV);
  }
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
112
113
  static inline void debugfs_remove(struct dentry *dentry)
  { }
9505e6375   Haavard Skinnemoen   debugfs: Implemen...
114
115
  static inline void debugfs_remove_recursive(struct dentry *dentry)
  { }
cfc94cdf8   Jan Kara   debugfs: add rena...
116
117
118
119
120
  static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
                  struct dentry *new_dir, char *new_name)
  {
  	return ERR_PTR(-ENODEV);
  }
f4ae40a6a   Al Viro   switch debugfs to...
121
  static inline struct dentry *debugfs_create_u8(const char *name, umode_t mode,
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
122
123
124
125
126
  					       struct dentry *parent,
  					       u8 *value)
  {
  	return ERR_PTR(-ENODEV);
  }
f4ae40a6a   Al Viro   switch debugfs to...
127
  static inline struct dentry *debugfs_create_u16(const char *name, umode_t mode,
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
128
  						struct dentry *parent,
7b558637b   Michal Ostrowski   [PATCH] debugfs: ...
129
  						u16 *value)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
130
131
132
  {
  	return ERR_PTR(-ENODEV);
  }
f4ae40a6a   Al Viro   switch debugfs to...
133
  static inline struct dentry *debugfs_create_u32(const char *name, umode_t mode,
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
134
  						struct dentry *parent,
7b558637b   Michal Ostrowski   [PATCH] debugfs: ...
135
  						u32 *value)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
136
137
138
  {
  	return ERR_PTR(-ENODEV);
  }
f4ae40a6a   Al Viro   switch debugfs to...
139
  static inline struct dentry *debugfs_create_u64(const char *name, umode_t mode,
8447891fe   Michael Ellerman   debugfs: Add debu...
140
141
142
143
144
  						struct dentry *parent,
  						u64 *value)
  {
  	return ERR_PTR(-ENODEV);
  }
f4ae40a6a   Al Viro   switch debugfs to...
145
  static inline struct dentry *debugfs_create_x8(const char *name, umode_t mode,
2ebefc501   Robin Getz   debugfs: helper f...
146
147
148
149
150
  					       struct dentry *parent,
  					       u8 *value)
  {
  	return ERR_PTR(-ENODEV);
  }
f4ae40a6a   Al Viro   switch debugfs to...
151
  static inline struct dentry *debugfs_create_x16(const char *name, umode_t mode,
2ebefc501   Robin Getz   debugfs: helper f...
152
153
154
155
156
  						struct dentry *parent,
  						u16 *value)
  {
  	return ERR_PTR(-ENODEV);
  }
f4ae40a6a   Al Viro   switch debugfs to...
157
  static inline struct dentry *debugfs_create_x32(const char *name, umode_t mode,
2ebefc501   Robin Getz   debugfs: helper f...
158
159
160
161
162
  						struct dentry *parent,
  						u32 *value)
  {
  	return ERR_PTR(-ENODEV);
  }
f4ae40a6a   Al Viro   switch debugfs to...
163
  static inline struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
8adb711f3   Inaky Perez-Gonzalez   debugfs: introduc...
164
165
166
167
168
  				     struct dentry *parent,
  				     size_t *value)
  {
  	return ERR_PTR(-ENODEV);
  }
f4ae40a6a   Al Viro   switch debugfs to...
169
  static inline struct dentry *debugfs_create_bool(const char *name, umode_t mode,
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
170
  						 struct dentry *parent,
7b558637b   Michal Ostrowski   [PATCH] debugfs: ...
171
  						 u32 *value)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
172
173
174
  {
  	return ERR_PTR(-ENODEV);
  }
f4ae40a6a   Al Viro   switch debugfs to...
175
  static inline struct dentry *debugfs_create_blob(const char *name, umode_t mode,
dd308bc35   Michael Ellerman   [PATCH] debugfs: ...
176
177
178
179
180
  				  struct dentry *parent,
  				  struct debugfs_blob_wrapper *blob)
  {
  	return ERR_PTR(-ENODEV);
  }
1a087c6ad   Alessandro Rubini   debugfs: add tool...
181
182
183
184
185
186
  static inline struct dentry *debugfs_create_regset32(const char *name,
  				   mode_t mode, struct dentry *parent,
  				   struct debugfs_regset32 *regset)
  {
  	return ERR_PTR(-ENODEV);
  }
c0f92ba99   Frederic Weisbecker   debugfs: function...
187
188
189
190
  static inline bool debugfs_initialized(void)
  {
  	return false;
  }
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
191
192
193
  #endif
  
  #endif