[deliverable/linux.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_ulong(const char *name, umode_t mode,
				    struct dentry *parent, unsigned long *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);
c23fe831 VK	82	struct dentry debugfs_create_ulong(const char name, umode_t mode,
c23fe831 VK	83	struct dentry parent, unsigned long value);
f4ae40a6	84	struct dentry debugfs_create_x8(const char name, umode_t mode,
2ebefc50	85	struct dentry parent, u8 value);
f4ae40a6	86	struct dentry debugfs_create_x16(const char name, umode_t mode,
2ebefc50	87	struct dentry parent, u16 value);
f4ae40a6	88	struct dentry debugfs_create_x32(const char name, umode_t mode,
2ebefc50	89	struct dentry parent, u32 value);
f4ae40a6	90	struct dentry debugfs_create_x64(const char name, umode_t mode,
15b0beaa	91	struct dentry parent, u64 value);
f4ae40a6	92	struct dentry debugfs_create_size_t(const char name, umode_t mode,
5e078787	93	struct dentry parent, size_t value);
3a76e5e0 SJ	94	struct dentry debugfs_create_atomic_t(const char name, umode_t mode,
3a76e5e0 SJ	95	struct dentry parent, atomic_t value);
f4ae40a6	96	struct dentry debugfs_create_bool(const char name, umode_t mode,
621a5f7a	97	struct dentry parent, bool value);
1da177e4	98
f4ae40a6	99	struct dentry debugfs_create_blob(const char name, umode_t mode,
dd308bc3 ME	100	struct dentry *parent,
dd308bc3 ME	101	struct debugfs_blob_wrapper *blob);
c0f92ba9	102
88187398	103	struct dentry debugfs_create_regset32(const char name, umode_t mode,
1a087c6a AR	104	struct dentry *parent,
	105	struct debugfs_regset32 *regset);
	106
9761536e JP	107	void debugfs_print_regs32(struct seq_file s, const struct debugfs_reg32 regs,
9761536e JP	108	int nregs, void __iomem base, char prefix);
1a087c6a	109
9fe2a701 SV	110	struct dentry debugfs_create_u32_array(const char name, umode_t mode,
	111	struct dentry *parent,
	112	u32 *array, u32 elements);
	113
98210b7f AS	114	struct dentry debugfs_create_devm_seqfile(struct device dev, const char *name,
	115	struct dentry *parent,
	116	int (read_fn)(struct seq_file s,
	117	void *data));
	118
c0f92ba9 FW	119	bool debugfs_initialized(void);
c0f92ba9 FW	120
0642ef6f RF	121	ssize_t debugfs_read_file_bool(struct file file, char __user user_buf,
	122	size_t count, loff_t *ppos);
	123
	124	ssize_t debugfs_write_file_bool(struct file file, const char __user user_buf,
	125	size_t count, loff_t *ppos);
	126
1da177e4	127	#else
a7a76cef RD	128
	129	#include <linux/err.h>
	130
98210b7f	131	/*
1da177e4 LT	132	* We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
	133	* so users have a chance to detect if there was a real error or not. We don't
	134	* want to duplicate the design decision mistakes of procfs and devfs again.
	135	*/
	136
f4ae40a6	137	static inline struct dentry debugfs_create_file(const char name, umode_t mode,
bde11d79 JD	138	struct dentry parent, void data,
bde11d79 JD	139	const struct file_operations *fops)
1da177e4 LT	140	{
	141	return ERR_PTR(-ENODEV);
	142	}
	143
e59b4e91 DH	144	static inline struct dentry debugfs_create_file_size(const char name, umode_t mode,
	145	struct dentry parent, void data,
	146	const struct file_operations *fops,
	147	loff_t file_size)
	148	{
	149	return ERR_PTR(-ENODEV);
	150	}
	151
1da177e4 LT	152	static inline struct dentry debugfs_create_dir(const char name,
	153	struct dentry *parent)
	154	{
	155	return ERR_PTR(-ENODEV);
	156	}
	157
66f54963 PO	158	static inline struct dentry debugfs_create_symlink(const char name,
	159	struct dentry *parent,
	160	const char *dest)
	161	{
	162	return ERR_PTR(-ENODEV);
	163	}
	164
1da177e4 LT	165	static inline void debugfs_remove(struct dentry *dentry)
	166	{ }
	167
9505e637 HS	168	static inline void debugfs_remove_recursive(struct dentry *dentry)
	169	{ }
	170
cfc94cdf JK	171	static inline struct dentry debugfs_rename(struct dentry old_dir, struct dentry *old_dentry,
	172	struct dentry new_dir, char new_name)
	173	{
	174	return ERR_PTR(-ENODEV);
	175	}
	176
f4ae40a6	177	static inline struct dentry debugfs_create_u8(const char name, umode_t mode,
1da177e4 LT	178	struct dentry *parent,
	179	u8 *value)
	180	{
	181	return ERR_PTR(-ENODEV);
	182	}
	183
f4ae40a6	184	static inline struct dentry debugfs_create_u16(const char name, umode_t mode,
1da177e4	185	struct dentry *parent,
7b558637	186	u16 *value)
1da177e4 LT	187	{
	188	return ERR_PTR(-ENODEV);
	189	}
	190
f4ae40a6	191	static inline struct dentry debugfs_create_u32(const char name, umode_t mode,
1da177e4	192	struct dentry *parent,
7b558637	193	u32 *value)
1da177e4 LT	194	{
	195	return ERR_PTR(-ENODEV);
	196	}
	197
f4ae40a6	198	static inline struct dentry debugfs_create_u64(const char name, umode_t mode,
8447891f ME	199	struct dentry *parent,
	200	u64 *value)
	201	{
	202	return ERR_PTR(-ENODEV);
	203	}
	204
f4ae40a6	205	static inline struct dentry debugfs_create_x8(const char name, umode_t mode,
2ebefc50 RG	206	struct dentry *parent,
	207	u8 *value)
	208	{
	209	return ERR_PTR(-ENODEV);
	210	}
	211
f4ae40a6	212	static inline struct dentry debugfs_create_x16(const char name, umode_t mode,
2ebefc50 RG	213	struct dentry *parent,
	214	u16 *value)
	215	{
	216	return ERR_PTR(-ENODEV);
	217	}
	218
f4ae40a6	219	static inline struct dentry debugfs_create_x32(const char name, umode_t mode,
2ebefc50 RG	220	struct dentry *parent,
	221	u32 *value)
	222	{
	223	return ERR_PTR(-ENODEV);
	224	}
	225
3159269e JB	226	static inline struct dentry debugfs_create_x64(const char name, umode_t mode,
	227	struct dentry *parent,
	228	u64 *value)
	229	{
	230	return ERR_PTR(-ENODEV);
	231	}
	232
f4ae40a6	233	static inline struct dentry debugfs_create_size_t(const char name, umode_t mode,
8adb711f IPG	234	struct dentry *parent,
	235	size_t *value)
	236	{
	237	return ERR_PTR(-ENODEV);
	238	}
	239
5b880214 WY	240	static inline struct dentry debugfs_create_atomic_t(const char name, umode_t mode,
	241	struct dentry parent, atomic_t value)
	242	{
	243	return ERR_PTR(-ENODEV);
	244	}
	245
f4ae40a6	246	static inline struct dentry debugfs_create_bool(const char name, umode_t mode,
1da177e4	247	struct dentry *parent,
621a5f7a	248	bool *value)
1da177e4 LT	249	{
	250	return ERR_PTR(-ENODEV);
	251	}
	252
f4ae40a6	253	static inline struct dentry debugfs_create_blob(const char name, umode_t mode,
dd308bc3 ME	254	struct dentry *parent,
	255	struct debugfs_blob_wrapper *blob)
	256	{
	257	return ERR_PTR(-ENODEV);
	258	}
	259
1a087c6a	260	static inline struct dentry debugfs_create_regset32(const char name,
88187398	261	umode_t mode, struct dentry *parent,
1a087c6a AR	262	struct debugfs_regset32 *regset)
	263	{
	264	return ERR_PTR(-ENODEV);
	265	}
	266
9761536e	267	static inline void debugfs_print_regs32(struct seq_file s, const struct debugfs_reg32 regs,
5b880214 WY	268	int nregs, void __iomem base, char prefix)
5b880214 WY	269	{
5b880214 WY	270	}
5b880214 WY	271
c0f92ba9 FW	272	static inline bool debugfs_initialized(void)
	273	{
	274	return false;
	275	}
	276
9fe2a701 SV	277	static inline struct dentry debugfs_create_u32_array(const char name, umode_t mode,
	278	struct dentry *parent,
	279	u32 *array, u32 elements)
	280	{
	281	return ERR_PTR(-ENODEV);
	282	}
	283
98210b7f AS	284	static inline struct dentry debugfs_create_devm_seqfile(struct device dev,
	285	const char *name,
	286	struct dentry *parent,
	287	int (read_fn)(struct seq_file s,
	288	void *data))
	289	{
	290	return ERR_PTR(-ENODEV);
	291	}
	292
0642ef6f RF	293	static inline ssize_t debugfs_read_file_bool(struct file *file,
	294	char __user *user_buf,
	295	size_t count, loff_t *ppos)
	296	{
	297	return -ENODEV;
	298	}
	299
	300	static inline ssize_t debugfs_write_file_bool(struct file *file,
	301	const char __user *user_buf,
	302	size_t count, loff_t *ppos)
	303	{
	304	return -ENODEV;
	305	}
	306
1da177e4 LT	307	#endif
	308
	309	#endif