blob: ae36b72c22f3c49402fa4b84f8d529d00e777704 [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.
Randy Dunlap55dff492009-09-23 15:56:17 -070012 * See Documentation/DocBook/filesystems for more details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 */
14
15#ifndef _DEBUGFS_H_
16#define _DEBUGFS_H_
17
18#include <linux/fs.h>
Alessandro Rubini1a087c62011-11-18 14:50:21 +010019#include <linux/seq_file.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
Roland Dreiera7a76ce2005-04-18 21:57:33 -070021#include <linux/types.h>
22
23struct file_operations;
24
Michael Ellermandd308bc2006-03-07 21:41:59 +110025struct debugfs_blob_wrapper {
26 void *data;
27 unsigned long size;
28};
29
Alessandro Rubini1a087c62011-11-18 14:50:21 +010030struct debugfs_reg32 {
31 char *name;
32 unsigned long offset;
33};
34
35struct debugfs_regset32 {
36 struct debugfs_reg32 *regs;
37 int nregs;
38 void __iomem *base;
39};
40
venkatesh.pallipadi@intel.comae79cda2008-07-18 16:08:13 -070041extern struct dentry *arch_debugfs_dir;
42
Linus Torvalds1da177e2005-04-16 15:20:36 -070043#if defined(CONFIG_DEBUG_FS)
Harvey Harrison36346342008-02-13 17:08:16 -080044
45/* declared over in file.c */
46extern const struct file_operations debugfs_file_operations;
47extern const struct inode_operations debugfs_link_operations;
48
Al Virof4ae40a2011-07-24 04:33:43 -040049struct dentry *debugfs_create_file(const char *name, umode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 struct dentry *parent, void *data,
Arjan van de Ven99ac48f2006-03-28 01:56:41 -080051 const struct file_operations *fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
53struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
54
Peter Oberparleiter66f54962007-02-13 12:13:54 +010055struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
56 const char *dest);
57
Linus Torvalds1da177e2005-04-16 15:20:36 -070058void debugfs_remove(struct dentry *dentry);
Haavard Skinnemoen9505e632008-07-01 15:14:51 +020059void debugfs_remove_recursive(struct dentry *dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
Jan Karacfc94cd2007-05-09 13:19:52 +020061struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
62 struct dentry *new_dir, const char *new_name);
63
Al Virof4ae40a2011-07-24 04:33:43 -040064struct dentry *debugfs_create_u8(const char *name, umode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 struct dentry *parent, u8 *value);
Al Virof4ae40a2011-07-24 04:33:43 -040066struct dentry *debugfs_create_u16(const char *name, umode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 struct dentry *parent, u16 *value);
Al Virof4ae40a2011-07-24 04:33:43 -040068struct dentry *debugfs_create_u32(const char *name, umode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -070069 struct dentry *parent, u32 *value);
Al Virof4ae40a2011-07-24 04:33:43 -040070struct dentry *debugfs_create_u64(const char *name, umode_t mode,
Michael Ellerman84478912007-04-17 15:59:36 +100071 struct dentry *parent, u64 *value);
Al Virof4ae40a2011-07-24 04:33:43 -040072struct dentry *debugfs_create_x8(const char *name, umode_t mode,
Robin Getz2ebefc52007-08-02 18:23:50 -040073 struct dentry *parent, u8 *value);
Al Virof4ae40a2011-07-24 04:33:43 -040074struct dentry *debugfs_create_x16(const char *name, umode_t mode,
Robin Getz2ebefc52007-08-02 18:23:50 -040075 struct dentry *parent, u16 *value);
Al Virof4ae40a2011-07-24 04:33:43 -040076struct dentry *debugfs_create_x32(const char *name, umode_t mode,
Robin Getz2ebefc52007-08-02 18:23:50 -040077 struct dentry *parent, u32 *value);
Al Virof4ae40a2011-07-24 04:33:43 -040078struct dentry *debugfs_create_x64(const char *name, umode_t mode,
Huang Ying15b0bea2010-05-18 14:35:23 +080079 struct dentry *parent, u64 *value);
Al Virof4ae40a2011-07-24 04:33:43 -040080struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
Inaky Perez-Gonzalez5e078782008-12-20 16:57:39 -080081 struct dentry *parent, size_t *value);
Al Virof4ae40a2011-07-24 04:33:43 -040082struct dentry *debugfs_create_bool(const char *name, umode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 struct dentry *parent, u32 *value);
84
Al Virof4ae40a2011-07-24 04:33:43 -040085struct dentry *debugfs_create_blob(const char *name, umode_t mode,
Michael Ellermandd308bc2006-03-07 21:41:59 +110086 struct dentry *parent,
87 struct debugfs_blob_wrapper *blob);
Frederic Weisbeckerc0f92ba2009-03-22 23:10:44 +010088
Al Viro88187392012-03-20 06:00:24 -040089struct dentry *debugfs_create_regset32(const char *name, umode_t mode,
Alessandro Rubini1a087c62011-11-18 14:50:21 +010090 struct dentry *parent,
91 struct debugfs_regset32 *regset);
92
Alessandro Rubini8ee4dd92011-11-18 23:53:29 +010093int debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
Alessandro Rubini1a087c62011-11-18 14:50:21 +010094 int nregs, void __iomem *base, char *prefix);
95
Frederic Weisbeckerc0f92ba2009-03-22 23:10:44 +010096bool debugfs_initialized(void);
97
Linus Torvalds1da177e2005-04-16 15:20:36 -070098#else
Roland Dreiera7a76ce2005-04-18 21:57:33 -070099
100#include <linux/err.h>
101
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102/*
103 * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
104 * so users have a chance to detect if there was a real error or not. We don't
105 * want to duplicate the design decision mistakes of procfs and devfs again.
106 */
107
Al Virof4ae40a2011-07-24 04:33:43 -0400108static inline struct dentry *debugfs_create_file(const char *name, umode_t mode,
Jean Delvarebde11d72006-04-18 21:30:22 -0700109 struct dentry *parent, void *data,
110 const struct file_operations *fops)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111{
112 return ERR_PTR(-ENODEV);
113}
114
115static inline struct dentry *debugfs_create_dir(const char *name,
116 struct dentry *parent)
117{
118 return ERR_PTR(-ENODEV);
119}
120
Peter Oberparleiter66f54962007-02-13 12:13:54 +0100121static inline struct dentry *debugfs_create_symlink(const char *name,
122 struct dentry *parent,
123 const char *dest)
124{
125 return ERR_PTR(-ENODEV);
126}
127
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128static inline void debugfs_remove(struct dentry *dentry)
129{ }
130
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200131static inline void debugfs_remove_recursive(struct dentry *dentry)
132{ }
133
Jan Karacfc94cd2007-05-09 13:19:52 +0200134static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
135 struct dentry *new_dir, char *new_name)
136{
137 return ERR_PTR(-ENODEV);
138}
139
Al Virof4ae40a2011-07-24 04:33:43 -0400140static inline struct dentry *debugfs_create_u8(const char *name, umode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 struct dentry *parent,
142 u8 *value)
143{
144 return ERR_PTR(-ENODEV);
145}
146
Al Virof4ae40a2011-07-24 04:33:43 -0400147static inline struct dentry *debugfs_create_u16(const char *name, umode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 struct dentry *parent,
Michal Ostrowski7b558632005-04-18 21:57:34 -0700149 u16 *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150{
151 return ERR_PTR(-ENODEV);
152}
153
Al Virof4ae40a2011-07-24 04:33:43 -0400154static inline struct dentry *debugfs_create_u32(const char *name, umode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 struct dentry *parent,
Michal Ostrowski7b558632005-04-18 21:57:34 -0700156 u32 *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157{
158 return ERR_PTR(-ENODEV);
159}
160
Al Virof4ae40a2011-07-24 04:33:43 -0400161static inline struct dentry *debugfs_create_u64(const char *name, umode_t mode,
Michael Ellerman84478912007-04-17 15:59:36 +1000162 struct dentry *parent,
163 u64 *value)
164{
165 return ERR_PTR(-ENODEV);
166}
167
Al Virof4ae40a2011-07-24 04:33:43 -0400168static inline struct dentry *debugfs_create_x8(const char *name, umode_t mode,
Robin Getz2ebefc52007-08-02 18:23:50 -0400169 struct dentry *parent,
170 u8 *value)
171{
172 return ERR_PTR(-ENODEV);
173}
174
Al Virof4ae40a2011-07-24 04:33:43 -0400175static inline struct dentry *debugfs_create_x16(const char *name, umode_t mode,
Robin Getz2ebefc52007-08-02 18:23:50 -0400176 struct dentry *parent,
177 u16 *value)
178{
179 return ERR_PTR(-ENODEV);
180}
181
Al Virof4ae40a2011-07-24 04:33:43 -0400182static inline struct dentry *debugfs_create_x32(const char *name, umode_t mode,
Robin Getz2ebefc52007-08-02 18:23:50 -0400183 struct dentry *parent,
184 u32 *value)
185{
186 return ERR_PTR(-ENODEV);
187}
188
Al Virof4ae40a2011-07-24 04:33:43 -0400189static inline struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
Inaky Perez-Gonzalez8adb7112009-01-20 12:17:28 -0800190 struct dentry *parent,
191 size_t *value)
192{
193 return ERR_PTR(-ENODEV);
194}
195
Al Virof4ae40a2011-07-24 04:33:43 -0400196static inline struct dentry *debugfs_create_bool(const char *name, umode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 struct dentry *parent,
Michal Ostrowski7b558632005-04-18 21:57:34 -0700198 u32 *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199{
200 return ERR_PTR(-ENODEV);
201}
202
Al Virof4ae40a2011-07-24 04:33:43 -0400203static inline struct dentry *debugfs_create_blob(const char *name, umode_t mode,
Michael Ellermandd308bc2006-03-07 21:41:59 +1100204 struct dentry *parent,
205 struct debugfs_blob_wrapper *blob)
206{
207 return ERR_PTR(-ENODEV);
208}
209
Alessandro Rubini1a087c62011-11-18 14:50:21 +0100210static inline struct dentry *debugfs_create_regset32(const char *name,
Al Viro88187392012-03-20 06:00:24 -0400211 umode_t mode, struct dentry *parent,
Alessandro Rubini1a087c62011-11-18 14:50:21 +0100212 struct debugfs_regset32 *regset)
213{
214 return ERR_PTR(-ENODEV);
215}
216
Frederic Weisbeckerc0f92ba2009-03-22 23:10:44 +0100217static inline bool debugfs_initialized(void)
218{
219 return false;
220}
221
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222#endif
223
224#endif