[GitHub/mt8127/android_kernel_alcatel_ttab.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 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_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);

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

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_size_t(const char *name, umode_t mode,
				     struct dentry *parent,
				     size_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 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);
}

#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>
	22
	23	struct file_operations;
	24
dd308bc3 ME	25	struct debugfs_blob_wrapper {
	26	void *data;
	27	unsigned long size;
	28	};
	29
1a087c6a AR	30	struct debugfs_reg32 {
	31	char *name;
	32	unsigned long offset;
	33	};
	34
	35	struct debugfs_regset32 {
833d6e01	36	const struct debugfs_reg32 *regs;
1a087c6a AR	37	int nregs;
	38	void __iomem *base;
	39	};
	40
ae79cdaa	41	extern struct dentry *arch_debugfs_dir;
ae79cdaa	42
1da177e4	43	#if defined(CONFIG_DEBUG_FS)
3634634e HH	44
	45	/* declared over in file.c */
	46	extern const struct file_operations debugfs_file_operations;
	47	extern const struct inode_operations debugfs_link_operations;
	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 LT	52
	53	struct dentry debugfs_create_dir(const char name, struct dentry *parent);
	54
66f54963 PO	55	struct dentry debugfs_create_symlink(const char name, struct dentry *parent,
	56	const char *dest);
	57
1da177e4	58	void debugfs_remove(struct dentry *dentry);
9505e637	59	void debugfs_remove_recursive(struct dentry *dentry);
1da177e4	60
cfc94cdf JK	61	struct dentry debugfs_rename(struct dentry old_dir, struct dentry *old_dentry,
	62	struct dentry new_dir, const char new_name);
	63
f4ae40a6	64	struct dentry debugfs_create_u8(const char name, umode_t mode,
1da177e4	65	struct dentry parent, u8 value);
f4ae40a6	66	struct dentry debugfs_create_u16(const char name, umode_t mode,
1da177e4	67	struct dentry parent, u16 value);
f4ae40a6	68	struct dentry debugfs_create_u32(const char name, umode_t mode,
1da177e4	69	struct dentry parent, u32 value);
f4ae40a6	70	struct dentry debugfs_create_u64(const char name, umode_t mode,
8447891f	71	struct dentry parent, u64 value);
f4ae40a6	72	struct dentry debugfs_create_x8(const char name, umode_t mode,
2ebefc50	73	struct dentry parent, u8 value);
f4ae40a6	74	struct dentry debugfs_create_x16(const char name, umode_t mode,
2ebefc50	75	struct dentry parent, u16 value);
f4ae40a6	76	struct dentry debugfs_create_x32(const char name, umode_t mode,
2ebefc50	77	struct dentry parent, u32 value);
f4ae40a6	78	struct dentry debugfs_create_x64(const char name, umode_t mode,
15b0beaa	79	struct dentry parent, u64 value);
f4ae40a6	80	struct dentry debugfs_create_size_t(const char name, umode_t mode,
5e078787	81	struct dentry parent, size_t value);
f4ae40a6	82	struct dentry debugfs_create_bool(const char name, umode_t mode,
1da177e4 LT	83	struct dentry parent, u32 value);
1da177e4 LT	84
f4ae40a6	85	struct dentry debugfs_create_blob(const char name, umode_t mode,
dd308bc3 ME	86	struct dentry *parent,
dd308bc3 ME	87	struct debugfs_blob_wrapper *blob);
c0f92ba9	88
88187398	89	struct dentry debugfs_create_regset32(const char name, umode_t mode,
1a087c6a AR	90	struct dentry *parent,
	91	struct debugfs_regset32 *regset);
	92
8ee4dd9f	93	int debugfs_print_regs32(struct seq_file s, const struct debugfs_reg32 regs,
1a087c6a AR	94	int nregs, void __iomem base, char prefix);
1a087c6a AR	95
9fe2a701 SV	96	struct dentry debugfs_create_u32_array(const char name, umode_t mode,
	97	struct dentry *parent,
	98	u32 *array, u32 elements);
	99
c0f92ba9 FW	100	bool debugfs_initialized(void);
c0f92ba9 FW	101
1da177e4	102	#else
a7a76cef RD	103
	104	#include <linux/err.h>
	105
1da177e4 LT	106	/*
	107	* We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
	108	* so users have a chance to detect if there was a real error or not. We don't
	109	* want to duplicate the design decision mistakes of procfs and devfs again.
	110	*/
	111
f4ae40a6	112	static inline struct dentry debugfs_create_file(const char name, umode_t mode,
bde11d79 JD	113	struct dentry parent, void data,
bde11d79 JD	114	const struct file_operations *fops)
1da177e4 LT	115	{
	116	return ERR_PTR(-ENODEV);
	117	}
	118
	119	static inline struct dentry debugfs_create_dir(const char name,
	120	struct dentry *parent)
	121	{
	122	return ERR_PTR(-ENODEV);
	123	}
	124
66f54963 PO	125	static inline struct dentry debugfs_create_symlink(const char name,
	126	struct dentry *parent,
	127	const char *dest)
	128	{
	129	return ERR_PTR(-ENODEV);
	130	}
	131
1da177e4 LT	132	static inline void debugfs_remove(struct dentry *dentry)
	133	{ }
	134
9505e637 HS	135	static inline void debugfs_remove_recursive(struct dentry *dentry)
	136	{ }
	137
cfc94cdf JK	138	static inline struct dentry debugfs_rename(struct dentry old_dir, struct dentry *old_dentry,
	139	struct dentry new_dir, char new_name)
	140	{
	141	return ERR_PTR(-ENODEV);
	142	}
	143
f4ae40a6	144	static inline struct dentry debugfs_create_u8(const char name, umode_t mode,
1da177e4 LT	145	struct dentry *parent,
	146	u8 *value)
	147	{
	148	return ERR_PTR(-ENODEV);
	149	}
	150
f4ae40a6	151	static inline struct dentry debugfs_create_u16(const char name, umode_t mode,
1da177e4	152	struct dentry *parent,
7b558637	153	u16 *value)
1da177e4 LT	154	{
	155	return ERR_PTR(-ENODEV);
	156	}
	157
f4ae40a6	158	static inline struct dentry debugfs_create_u32(const char name, umode_t mode,
1da177e4	159	struct dentry *parent,
7b558637	160	u32 *value)
1da177e4 LT	161	{
	162	return ERR_PTR(-ENODEV);
	163	}
	164
f4ae40a6	165	static inline struct dentry debugfs_create_u64(const char name, umode_t mode,
8447891f ME	166	struct dentry *parent,
	167	u64 *value)
	168	{
	169	return ERR_PTR(-ENODEV);
	170	}
	171
f4ae40a6	172	static inline struct dentry debugfs_create_x8(const char name, umode_t mode,
2ebefc50 RG	173	struct dentry *parent,
	174	u8 *value)
	175	{
	176	return ERR_PTR(-ENODEV);
	177	}
	178
f4ae40a6	179	static inline struct dentry debugfs_create_x16(const char name, umode_t mode,
2ebefc50 RG	180	struct dentry *parent,
	181	u16 *value)
	182	{
	183	return ERR_PTR(-ENODEV);
	184	}
	185
f4ae40a6	186	static inline struct dentry debugfs_create_x32(const char name, umode_t mode,
2ebefc50 RG	187	struct dentry *parent,
	188	u32 *value)
	189	{
	190	return ERR_PTR(-ENODEV);
	191	}
	192
f4ae40a6	193	static inline struct dentry debugfs_create_size_t(const char name, umode_t mode,
8adb711f IPG	194	struct dentry *parent,
	195	size_t *value)
	196	{
	197	return ERR_PTR(-ENODEV);
	198	}
	199
f4ae40a6	200	static inline struct dentry debugfs_create_bool(const char name, umode_t mode,
1da177e4	201	struct dentry *parent,
7b558637	202	u32 *value)
1da177e4 LT	203	{
	204	return ERR_PTR(-ENODEV);
	205	}
	206
f4ae40a6	207	static inline struct dentry debugfs_create_blob(const char name, umode_t mode,
dd308bc3 ME	208	struct dentry *parent,
	209	struct debugfs_blob_wrapper *blob)
	210	{
	211	return ERR_PTR(-ENODEV);
	212	}
	213
1a087c6a	214	static inline struct dentry debugfs_create_regset32(const char name,
88187398	215	umode_t mode, struct dentry *parent,
1a087c6a AR	216	struct debugfs_regset32 *regset)
	217	{
	218	return ERR_PTR(-ENODEV);
	219	}
	220
c0f92ba9 FW	221	static inline bool debugfs_initialized(void)
	222	{
	223	return false;
	224	}
	225
9fe2a701 SV	226	static inline struct dentry debugfs_create_u32_array(const char name, umode_t mode,
	227	struct dentry *parent,
	228	u32 *array, u32 elements)
	229	{
	230	return ERR_PTR(-ENODEV);
	231	}
	232
1da177e4 LT	233	#endif
	234
	235	#endif