[mirror_ubuntu-bionic-kernel.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_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);

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