[linux-2.6-block.git] / include / linux / debugfs.h

/*
 *  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.
 *  See Documentation/DocBook/filesystems for more details.
 */

#ifndef _DEBUGFS_H_
#define _DEBUGFS_H_

#include <linux/fs.h>
#include <linux/seq_file.h>

#include <linux/types.h>

struct device;
struct file_operations;

struct debugfs_blob_wrapper {
	void *data;
	unsigned long size;
};

struct debugfs_reg32 {
	char *name;
	unsigned long offset;
};

struct debugfs_regset32 {
	const struct debugfs_reg32 *regs;
	int nregs;
	void __iomem *base;
};

extern struct dentry *arch_debugfs_dir;

#if defined(CONFIG_DEBUG_FS)

/* declared over in file.c */
extern const struct file_operations debugfs_file_operations;

struct dentry *debugfs_create_file(const char *name, umode_t mode,
				   struct dentry *parent, void *data,
				   const struct file_operations *fops);

struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
					struct dentry *parent, void *data,
					const struct file_operations *fops,
					loff_t file_size);

struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);

struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
				      const char *dest);

struct dentry *debugfs_create_automount(const char *name,
					struct dentry *parent,
					struct vfsmount *(*f)(void *),
					void *data);

void debugfs_remove(struct dentry *dentry);
void debugfs_remove_recursive(struct dentry *dentry);

struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
                struct dentry *new_dir, const char *new_name);

struct dentry *debugfs_create_u8(const char *name, umode_t mode,
				 struct dentry *parent, u8 *value);
struct dentry *debugfs_create_u16(const char *name, umode_t mode,
				  struct dentry *parent, u16 *value);
struct dentry *debugfs_create_u32(const char *name, umode_t mode,
				  struct dentry *parent, u32 *value);
struct dentry *debugfs_create_u64(const char *name, umode_t mode,
				  struct dentry *parent, u64 *value);
struct dentry *debugfs_create_x8(const char *name, umode_t mode,
				 struct dentry *parent, u8 *value);
struct dentry *debugfs_create_x16(const char *name, umode_t mode,
				  struct dentry *parent, u16 *value);
struct dentry *debugfs_create_x32(const char *name, umode_t mode,
				  struct dentry *parent, u32 *value);
struct dentry *debugfs_create_x64(const char *name, umode_t mode,
				  struct dentry *parent, u64 *value);
struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
				     struct dentry *parent, size_t *value);
struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode,
				     struct dentry *parent, atomic_t *value);
struct dentry *debugfs_create_bool(const char *name, umode_t mode,
				  struct dentry *parent, bool *value);

struct dentry *debugfs_create_blob(const char *name, umode_t mode,
				  struct dentry *parent,
				  struct debugfs_blob_wrapper *blob);

struct dentry *debugfs_create_regset32(const char *name, umode_t mode,
				     struct dentry *parent,
				     struct debugfs_regset32 *regset);

void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
			  int nregs, void __iomem *base, char *prefix);

struct dentry *debugfs_create_u32_array(const char *name, umode_t mode,
					struct dentry *parent,
					u32 *array, u32 elements);

struct dentry *debugfs_create_devm_seqfile(struct device *dev, const char *name,
					   struct dentry *parent,
					   int (*read_fn)(struct seq_file *s,
							  void *data));

bool debugfs_initialized(void);

ssize_t debugfs_read_file_bool(struct file *file, char __user *user_buf,
			       size_t count, loff_t *ppos);

ssize_t debugfs_write_file_bool(struct file *file, const char __user *user_buf,
				size_t count, loff_t *ppos);

#else

#include <linux/err.h>

/*
 * 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.
 */

static inline struct dentry *debugfs_create_file(const char *name, umode_t mode,
					struct dentry *parent, void *data,
					const struct file_operations *fops)
{
	return ERR_PTR(-ENODEV);
}

static inline struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
					struct dentry *parent, void *data,
					const struct file_operations *fops,
					loff_t file_size)
{
	return ERR_PTR(-ENODEV);
}

static inline struct dentry *debugfs_create_dir(const char *name,
						struct dentry *parent)
{
	return ERR_PTR(-ENODEV);
}

static inline struct dentry *debugfs_create_symlink(const char *name,
						    struct dentry *parent,
						    const char *dest)
{
	return ERR_PTR(-ENODEV);
}

static inline void debugfs_remove(struct dentry *dentry)
{ }

static inline void debugfs_remove_recursive(struct dentry *dentry)
{ }

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);
}

static inline struct dentry *debugfs_create_u8(const char *name, umode_t mode,
					       struct dentry *parent,
					       u8 *value)
{
	return ERR_PTR(-ENODEV);
}

static inline struct dentry *debugfs_create_u16(const char *name, umode_t mode,
						struct dentry *parent,
						u16 *value)
{
	return ERR_PTR(-ENODEV);
}

static inline struct dentry *debugfs_create_u32(const char *name, umode_t mode,
						struct dentry *parent,
						u32 *value)
{
	return ERR_PTR(-ENODEV);
}

static inline struct dentry *debugfs_create_u64(const char *name, umode_t mode,
						struct dentry *parent,
						u64 *value)
{
	return ERR_PTR(-ENODEV);
}

static inline struct dentry *debugfs_create_x8(const char *name, umode_t mode,
					       struct dentry *parent,
					       u8 *value)
{
	return ERR_PTR(-ENODEV);
}

static inline struct dentry *debugfs_create_x16(const char *name, umode_t mode,
						struct dentry *parent,
						u16 *value)
{
	return ERR_PTR(-ENODEV);
}

static inline struct dentry *debugfs_create_x32(const char *name, umode_t mode,
						struct dentry *parent,
						u32 *value)
{
	return ERR_PTR(-ENODEV);
}

static inline struct dentry *debugfs_create_x64(const char *name, umode_t mode,
						struct dentry *parent,
						u64 *value)
{
	return ERR_PTR(-ENODEV);
}

static inline struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
				     struct dentry *parent,
				     size_t *value)
{
	return ERR_PTR(-ENODEV);
}

static inline struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode,
				     struct dentry *parent, atomic_t *value)
{
	return ERR_PTR(-ENODEV);
}

static inline struct dentry *debugfs_create_bool(const char *name, umode_t mode,
						 struct dentry *parent,
						 bool *value)
{
	return ERR_PTR(-ENODEV);
}

static inline struct dentry *debugfs_create_blob(const char *name, umode_t mode,
				  struct dentry *parent,
				  struct debugfs_blob_wrapper *blob)
{
	return ERR_PTR(-ENODEV);
}

static inline struct dentry *debugfs_create_regset32(const char *name,
				   umode_t mode, struct dentry *parent,
				   struct debugfs_regset32 *regset)
{
	return ERR_PTR(-ENODEV);
}

static inline void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
			 int nregs, void __iomem *base, char *prefix)
{
}

static inline bool debugfs_initialized(void)
{
	return false;
}

static inline struct dentry *debugfs_create_u32_array(const char *name, umode_t mode,
					struct dentry *parent,
					u32 *array, u32 elements)
{
	return ERR_PTR(-ENODEV);
}

static inline struct dentry *debugfs_create_devm_seqfile(struct device *dev,
							 const char *name,
							 struct dentry *parent,
					   int (*read_fn)(struct seq_file *s,
							  void *data))
{
	return ERR_PTR(-ENODEV);
}

static inline ssize_t debugfs_read_file_bool(struct file *file,
					     char __user *user_buf,
					     size_t count, loff_t *ppos)
{
	return -ENODEV;
}

static inline ssize_t debugfs_write_file_bool(struct file *file,
					      const char __user *user_buf,
					      size_t count, loff_t *ppos)
{
	return -ENODEV;
}

#endif

#endif
Commit	Line	Data
1da177e4 LT	1	/*
	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.
55dff495	12	* See Documentation/DocBook/filesystems for more details.
1da177e4 LT	13	*/
	14
	15	#ifndef _DEBUGFS_H_
	16	#define _DEBUGFS_H_
	17
	18	#include <linux/fs.h>
1a087c6a	19	#include <linux/seq_file.h>
1da177e4	20
a7a76cef RD	21	#include <linux/types.h>
a7a76cef RD	22
f30d0a81	23	struct device;
a7a76cef RD	24	struct file_operations;
a7a76cef RD	25
dd308bc3 ME	26	struct debugfs_blob_wrapper {
	27	void *data;
	28	unsigned long size;
	29	};
	30
1a087c6a AR	31	struct debugfs_reg32 {
	32	char *name;
	33	unsigned long offset;
	34	};
	35
	36	struct debugfs_regset32 {
833d6e01	37	const struct debugfs_reg32 *regs;
1a087c6a AR	38	int nregs;
	39	void __iomem *base;
	40	};
	41
ae79cdaa	42	extern struct dentry *arch_debugfs_dir;
ae79cdaa	43
1da177e4	44	#if defined(CONFIG_DEBUG_FS)
3634634e HH	45
	46	/* declared over in file.c */
	47	extern const struct file_operations debugfs_file_operations;
3634634e	48
f4ae40a6	49	struct dentry debugfs_create_file(const char name, umode_t mode,
1da177e4	50	struct dentry parent, void data,
99ac48f5	51	const struct file_operations *fops);
1da177e4	52
e59b4e91 DH	53	struct dentry debugfs_create_file_size(const char name, umode_t mode,
	54	struct dentry parent, void data,
	55	const struct file_operations *fops,
	56	loff_t file_size);
	57
1da177e4 LT	58	struct dentry debugfs_create_dir(const char name, struct dentry *parent);
1da177e4 LT	59
66f54963 PO	60	struct dentry debugfs_create_symlink(const char name, struct dentry *parent,
	61	const char *dest);
	62
77b3da6e AV	63	struct dentry debugfs_create_automount(const char name,
	64	struct dentry *parent,
	65	struct vfsmount (f)(void *),
	66	void *data);
	67
1da177e4	68	void debugfs_remove(struct dentry *dentry);
9505e637	69	void debugfs_remove_recursive(struct dentry *dentry);
1da177e4	70
cfc94cdf JK	71	struct dentry debugfs_rename(struct dentry old_dir, struct dentry *old_dentry,
	72	struct dentry new_dir, const char new_name);
	73
f4ae40a6	74	struct dentry debugfs_create_u8(const char name, umode_t mode,
1da177e4	75	struct dentry parent, u8 value);
f4ae40a6	76	struct dentry debugfs_create_u16(const char name, umode_t mode,
1da177e4	77	struct dentry parent, u16 value);
f4ae40a6	78	struct dentry debugfs_create_u32(const char name, umode_t mode,
1da177e4	79	struct dentry parent, u32 value);
f4ae40a6	80	struct dentry debugfs_create_u64(const char name, umode_t mode,
8447891f	81	struct dentry parent, u64 value);
f4ae40a6	82	struct dentry debugfs_create_x8(const char name, umode_t mode,
2ebefc50	83	struct dentry parent, u8 value);
f4ae40a6	84	struct dentry debugfs_create_x16(const char name, umode_t mode,
2ebefc50	85	struct dentry parent, u16 value);
f4ae40a6	86	struct dentry debugfs_create_x32(const char name, umode_t mode,
2ebefc50	87	struct dentry parent, u32 value);
f4ae40a6	88	struct dentry debugfs_create_x64(const char name, umode_t mode,
15b0beaa	89	struct dentry parent, u64 value);
f4ae40a6	90	struct dentry debugfs_create_size_t(const char name, umode_t mode,
5e078787	91	struct dentry parent, size_t value);
3a76e5e0 SJ	92	struct dentry debugfs_create_atomic_t(const char name, umode_t mode,
3a76e5e0 SJ	93	struct dentry parent, atomic_t value);
f4ae40a6	94	struct dentry debugfs_create_bool(const char name, umode_t mode,
621a5f7a	95	struct dentry parent, bool value);
1da177e4	96
f4ae40a6	97	struct dentry debugfs_create_blob(const char name, umode_t mode,
dd308bc3 ME	98	struct dentry *parent,
dd308bc3 ME	99	struct debugfs_blob_wrapper *blob);
c0f92ba9	100
88187398	101	struct dentry debugfs_create_regset32(const char name, umode_t mode,
1a087c6a AR	102	struct dentry *parent,
	103	struct debugfs_regset32 *regset);
	104
9761536e JP	105	void debugfs_print_regs32(struct seq_file s, const struct debugfs_reg32 regs,
9761536e JP	106	int nregs, void __iomem base, char prefix);
1a087c6a	107
9fe2a701 SV	108	struct dentry debugfs_create_u32_array(const char name, umode_t mode,
	109	struct dentry *parent,
	110	u32 *array, u32 elements);
	111
98210b7f AS	112	struct dentry debugfs_create_devm_seqfile(struct device dev, const char *name,
	113	struct dentry *parent,
	114	int (read_fn)(struct seq_file s,
	115	void *data));
	116
c0f92ba9 FW	117	bool debugfs_initialized(void);
c0f92ba9 FW	118
0642ef6f RF	119	ssize_t debugfs_read_file_bool(struct file file, char __user user_buf,
	120	size_t count, loff_t *ppos);
	121
	122	ssize_t debugfs_write_file_bool(struct file file, const char __user user_buf,
	123	size_t count, loff_t *ppos);
	124
1da177e4	125	#else
a7a76cef RD	126
	127	#include <linux/err.h>
	128
98210b7f	129	/*
1da177e4 LT	130	* We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
	131	* so users have a chance to detect if there was a real error or not. We don't
	132	* want to duplicate the design decision mistakes of procfs and devfs again.
	133	*/
	134
f4ae40a6	135	static inline struct dentry debugfs_create_file(const char name, umode_t mode,
bde11d79 JD	136	struct dentry parent, void data,
bde11d79 JD	137	const struct file_operations *fops)
1da177e4 LT	138	{
	139	return ERR_PTR(-ENODEV);
	140	}
	141
e59b4e91 DH	142	static inline struct dentry debugfs_create_file_size(const char name, umode_t mode,
	143	struct dentry parent, void data,
	144	const struct file_operations *fops,
	145	loff_t file_size)
	146	{
	147	return ERR_PTR(-ENODEV);
	148	}
	149
1da177e4 LT	150	static inline struct dentry debugfs_create_dir(const char name,
	151	struct dentry *parent)
	152	{
	153	return ERR_PTR(-ENODEV);
	154	}
	155
66f54963 PO	156	static inline struct dentry debugfs_create_symlink(const char name,
	157	struct dentry *parent,
	158	const char *dest)
	159	{
	160	return ERR_PTR(-ENODEV);
	161	}
	162
1da177e4 LT	163	static inline void debugfs_remove(struct dentry *dentry)
	164	{ }
	165
9505e637 HS	166	static inline void debugfs_remove_recursive(struct dentry *dentry)
	167	{ }
	168
cfc94cdf JK	169	static inline struct dentry debugfs_rename(struct dentry old_dir, struct dentry *old_dentry,
	170	struct dentry new_dir, char new_name)
	171	{
	172	return ERR_PTR(-ENODEV);
	173	}
	174
f4ae40a6	175	static inline struct dentry debugfs_create_u8(const char name, umode_t mode,
1da177e4 LT	176	struct dentry *parent,
	177	u8 *value)
	178	{
	179	return ERR_PTR(-ENODEV);
	180	}
	181
f4ae40a6	182	static inline struct dentry debugfs_create_u16(const char name, umode_t mode,
1da177e4	183	struct dentry *parent,
7b558637	184	u16 *value)
1da177e4 LT	185	{
	186	return ERR_PTR(-ENODEV);
	187	}
	188
f4ae40a6	189	static inline struct dentry debugfs_create_u32(const char name, umode_t mode,
1da177e4	190	struct dentry *parent,
7b558637	191	u32 *value)
1da177e4 LT	192	{
	193	return ERR_PTR(-ENODEV);
	194	}
	195
f4ae40a6	196	static inline struct dentry debugfs_create_u64(const char name, umode_t mode,
8447891f ME	197	struct dentry *parent,
	198	u64 *value)
	199	{
	200	return ERR_PTR(-ENODEV);
	201	}
	202
f4ae40a6	203	static inline struct dentry debugfs_create_x8(const char name, umode_t mode,
2ebefc50 RG	204	struct dentry *parent,
	205	u8 *value)
	206	{
	207	return ERR_PTR(-ENODEV);
	208	}
	209
f4ae40a6	210	static inline struct dentry debugfs_create_x16(const char name, umode_t mode,
2ebefc50 RG	211	struct dentry *parent,
	212	u16 *value)
	213	{
	214	return ERR_PTR(-ENODEV);
	215	}
	216
f4ae40a6	217	static inline struct dentry debugfs_create_x32(const char name, umode_t mode,
2ebefc50 RG	218	struct dentry *parent,
	219	u32 *value)
	220	{
	221	return ERR_PTR(-ENODEV);
	222	}
	223
3159269e JB	224	static inline struct dentry debugfs_create_x64(const char name, umode_t mode,
	225	struct dentry *parent,
	226	u64 *value)
	227	{
	228	return ERR_PTR(-ENODEV);
	229	}
	230
f4ae40a6	231	static inline struct dentry debugfs_create_size_t(const char name, umode_t mode,
8adb711f IPG	232	struct dentry *parent,
	233	size_t *value)
	234	{
	235	return ERR_PTR(-ENODEV);
	236	}
	237
5b880214 WY	238	static inline struct dentry debugfs_create_atomic_t(const char name, umode_t mode,
	239	struct dentry parent, atomic_t value)
	240	{
	241	return ERR_PTR(-ENODEV);
	242	}
	243
f4ae40a6	244	static inline struct dentry debugfs_create_bool(const char name, umode_t mode,
1da177e4	245	struct dentry *parent,
621a5f7a	246	bool *value)
1da177e4 LT	247	{
	248	return ERR_PTR(-ENODEV);
	249	}
	250
f4ae40a6	251	static inline struct dentry debugfs_create_blob(const char name, umode_t mode,
dd308bc3 ME	252	struct dentry *parent,
	253	struct debugfs_blob_wrapper *blob)
	254	{
	255	return ERR_PTR(-ENODEV);
	256	}
	257
1a087c6a	258	static inline struct dentry debugfs_create_regset32(const char name,
88187398	259	umode_t mode, struct dentry *parent,
1a087c6a AR	260	struct debugfs_regset32 *regset)
	261	{
	262	return ERR_PTR(-ENODEV);
	263	}
	264
9761536e	265	static inline void debugfs_print_regs32(struct seq_file s, const struct debugfs_reg32 regs,
5b880214 WY	266	int nregs, void __iomem base, char prefix)
5b880214 WY	267	{
5b880214 WY	268	}
5b880214 WY	269
c0f92ba9 FW	270	static inline bool debugfs_initialized(void)
	271	{
	272	return false;
	273	}
	274
9fe2a701 SV	275	static inline struct dentry debugfs_create_u32_array(const char name, umode_t mode,
	276	struct dentry *parent,
	277	u32 *array, u32 elements)
	278	{
	279	return ERR_PTR(-ENODEV);
	280	}
	281
98210b7f AS	282	static inline struct dentry debugfs_create_devm_seqfile(struct device dev,
	283	const char *name,
	284	struct dentry *parent,
	285	int (read_fn)(struct seq_file s,
	286	void *data))
	287	{
	288	return ERR_PTR(-ENODEV);
	289	}
	290
0642ef6f RF	291	static inline ssize_t debugfs_read_file_bool(struct file *file,
	292	char __user *user_buf,
	293	size_t count, loff_t *ppos)
	294	{
	295	return -ENODEV;
	296	}
	297
	298	static inline ssize_t debugfs_write_file_bool(struct file *file,
	299	const char __user *user_buf,
	300	size_t count, loff_t *ppos)
	301	{
	302	return -ENODEV;
	303	}
	304
1da177e4 LT	305	#endif
	306
	307	#endif