[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;
extern const struct inode_operations debugfs_link_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_dir(const char *name, struct dentry *parent);

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

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, u32 *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);

#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_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,
						 u32 *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);
}

#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;
	48	extern const struct inode_operations debugfs_link_operations;
	49
f4ae40a6	50	struct dentry debugfs_create_file(const char name, umode_t mode,
1da177e4	51	struct dentry parent, void data,
99ac48f5	52	const struct file_operations *fops);
1da177e4 LT	53
	54	struct dentry debugfs_create_dir(const char name, struct dentry *parent);
	55
66f54963 PO	56	struct dentry debugfs_create_symlink(const char name, struct dentry *parent,
	57	const char *dest);
	58
1da177e4	59	void debugfs_remove(struct dentry *dentry);
9505e637	60	void debugfs_remove_recursive(struct dentry *dentry);
1da177e4	61
cfc94cdf JK	62	struct dentry debugfs_rename(struct dentry old_dir, struct dentry *old_dentry,
	63	struct dentry new_dir, const char new_name);
	64
f4ae40a6	65	struct dentry debugfs_create_u8(const char name, umode_t mode,
1da177e4	66	struct dentry parent, u8 value);
f4ae40a6	67	struct dentry debugfs_create_u16(const char name, umode_t mode,
1da177e4	68	struct dentry parent, u16 value);
f4ae40a6	69	struct dentry debugfs_create_u32(const char name, umode_t mode,
1da177e4	70	struct dentry parent, u32 value);
f4ae40a6	71	struct dentry debugfs_create_u64(const char name, umode_t mode,
8447891f	72	struct dentry parent, u64 value);
f4ae40a6	73	struct dentry debugfs_create_x8(const char name, umode_t mode,
2ebefc50	74	struct dentry parent, u8 value);
f4ae40a6	75	struct dentry debugfs_create_x16(const char name, umode_t mode,
2ebefc50	76	struct dentry parent, u16 value);
f4ae40a6	77	struct dentry debugfs_create_x32(const char name, umode_t mode,
2ebefc50	78	struct dentry parent, u32 value);
f4ae40a6	79	struct dentry debugfs_create_x64(const char name, umode_t mode,
15b0beaa	80	struct dentry parent, u64 value);
f4ae40a6	81	struct dentry debugfs_create_size_t(const char name, umode_t mode,
5e078787	82	struct dentry parent, size_t value);
3a76e5e0 SJ	83	struct dentry debugfs_create_atomic_t(const char name, umode_t mode,
3a76e5e0 SJ	84	struct dentry parent, atomic_t value);
f4ae40a6	85	struct dentry debugfs_create_bool(const char name, umode_t mode,
1da177e4 LT	86	struct dentry parent, u32 value);
1da177e4 LT	87
f4ae40a6	88	struct dentry debugfs_create_blob(const char name, umode_t mode,
dd308bc3 ME	89	struct dentry *parent,
dd308bc3 ME	90	struct debugfs_blob_wrapper *blob);
c0f92ba9	91
88187398	92	struct dentry debugfs_create_regset32(const char name, umode_t mode,
1a087c6a AR	93	struct dentry *parent,
	94	struct debugfs_regset32 *regset);
	95
9761536e JP	96	void debugfs_print_regs32(struct seq_file s, const struct debugfs_reg32 regs,
9761536e JP	97	int nregs, void __iomem base, char prefix);
1a087c6a	98
9fe2a701 SV	99	struct dentry debugfs_create_u32_array(const char name, umode_t mode,
	100	struct dentry *parent,
	101	u32 *array, u32 elements);
	102
98210b7f AS	103	struct dentry debugfs_create_devm_seqfile(struct device dev, const char *name,
	104	struct dentry *parent,
	105	int (read_fn)(struct seq_file s,
	106	void *data));
	107
c0f92ba9 FW	108	bool debugfs_initialized(void);
c0f92ba9 FW	109
1da177e4	110	#else
a7a76cef RD	111
	112	#include <linux/err.h>
	113
98210b7f	114	/*
1da177e4 LT	115	* We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
	116	* so users have a chance to detect if there was a real error or not. We don't
	117	* want to duplicate the design decision mistakes of procfs and devfs again.
	118	*/
	119
f4ae40a6	120	static inline struct dentry debugfs_create_file(const char name, umode_t mode,
bde11d79 JD	121	struct dentry parent, void data,
bde11d79 JD	122	const struct file_operations *fops)
1da177e4 LT	123	{
	124	return ERR_PTR(-ENODEV);
	125	}
	126
	127	static inline struct dentry debugfs_create_dir(const char name,
	128	struct dentry *parent)
	129	{
	130	return ERR_PTR(-ENODEV);
	131	}
	132
66f54963 PO	133	static inline struct dentry debugfs_create_symlink(const char name,
	134	struct dentry *parent,
	135	const char *dest)
	136	{
	137	return ERR_PTR(-ENODEV);
	138	}
	139
1da177e4 LT	140	static inline void debugfs_remove(struct dentry *dentry)
	141	{ }
	142
9505e637 HS	143	static inline void debugfs_remove_recursive(struct dentry *dentry)
	144	{ }
	145
cfc94cdf JK	146	static inline struct dentry debugfs_rename(struct dentry old_dir, struct dentry *old_dentry,
	147	struct dentry new_dir, char new_name)
	148	{
	149	return ERR_PTR(-ENODEV);
	150	}
	151
f4ae40a6	152	static inline struct dentry debugfs_create_u8(const char name, umode_t mode,
1da177e4 LT	153	struct dentry *parent,
	154	u8 *value)
	155	{
	156	return ERR_PTR(-ENODEV);
	157	}
	158
f4ae40a6	159	static inline struct dentry debugfs_create_u16(const char name, umode_t mode,
1da177e4	160	struct dentry *parent,
7b558637	161	u16 *value)
1da177e4 LT	162	{
	163	return ERR_PTR(-ENODEV);
	164	}
	165
f4ae40a6	166	static inline struct dentry debugfs_create_u32(const char name, umode_t mode,
1da177e4	167	struct dentry *parent,
7b558637	168	u32 *value)
1da177e4 LT	169	{
	170	return ERR_PTR(-ENODEV);
	171	}
	172
f4ae40a6	173	static inline struct dentry debugfs_create_u64(const char name, umode_t mode,
8447891f ME	174	struct dentry *parent,
	175	u64 *value)
	176	{
	177	return ERR_PTR(-ENODEV);
	178	}
	179
f4ae40a6	180	static inline struct dentry debugfs_create_x8(const char name, umode_t mode,
2ebefc50 RG	181	struct dentry *parent,
	182	u8 *value)
	183	{
	184	return ERR_PTR(-ENODEV);
	185	}
	186
f4ae40a6	187	static inline struct dentry debugfs_create_x16(const char name, umode_t mode,
2ebefc50 RG	188	struct dentry *parent,
	189	u16 *value)
	190	{
	191	return ERR_PTR(-ENODEV);
	192	}
	193
f4ae40a6	194	static inline struct dentry debugfs_create_x32(const char name, umode_t mode,
2ebefc50 RG	195	struct dentry *parent,
	196	u32 *value)
	197	{
	198	return ERR_PTR(-ENODEV);
	199	}
	200
3159269e JB	201	static inline struct dentry debugfs_create_x64(const char name, umode_t mode,
	202	struct dentry *parent,
	203	u64 *value)
	204	{
	205	return ERR_PTR(-ENODEV);
	206	}
	207
f4ae40a6	208	static inline struct dentry debugfs_create_size_t(const char name, umode_t mode,
8adb711f IPG	209	struct dentry *parent,
	210	size_t *value)
	211	{
	212	return ERR_PTR(-ENODEV);
	213	}
	214
5b880214 WY	215	static inline struct dentry debugfs_create_atomic_t(const char name, umode_t mode,
	216	struct dentry parent, atomic_t value)
	217	{
	218	return ERR_PTR(-ENODEV);
	219	}
	220
f4ae40a6	221	static inline struct dentry debugfs_create_bool(const char name, umode_t mode,
1da177e4	222	struct dentry *parent,
7b558637	223	u32 *value)
1da177e4 LT	224	{
	225	return ERR_PTR(-ENODEV);
	226	}
	227
f4ae40a6	228	static inline struct dentry debugfs_create_blob(const char name, umode_t mode,
dd308bc3 ME	229	struct dentry *parent,
	230	struct debugfs_blob_wrapper *blob)
	231	{
	232	return ERR_PTR(-ENODEV);
	233	}
	234
1a087c6a	235	static inline struct dentry debugfs_create_regset32(const char name,
88187398	236	umode_t mode, struct dentry *parent,
1a087c6a AR	237	struct debugfs_regset32 *regset)
	238	{
	239	return ERR_PTR(-ENODEV);
	240	}
	241
9761536e	242	static inline void debugfs_print_regs32(struct seq_file s, const struct debugfs_reg32 regs,
5b880214 WY	243	int nregs, void __iomem base, char prefix)
5b880214 WY	244	{
5b880214 WY	245	}
5b880214 WY	246
c0f92ba9 FW	247	static inline bool debugfs_initialized(void)
	248	{
	249	return false;
	250	}
	251
9fe2a701 SV	252	static inline struct dentry debugfs_create_u32_array(const char name, umode_t mode,
	253	struct dentry *parent,
	254	u32 *array, u32 elements)
	255	{
	256	return ERR_PTR(-ENODEV);
	257	}
	258
98210b7f AS	259	static inline struct dentry debugfs_create_devm_seqfile(struct device dev,
	260	const char *name,
	261	struct dentry *parent,
	262	int (read_fn)(struct seq_file s,
	263	void *data))
	264	{
	265	return ERR_PTR(-ENODEV);
	266	}
	267
1da177e4 LT	268	#endif
	269
	270	#endif