| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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. | 
 | 12 |  *  See Documentation/DocBook/kernel-api for more details. | 
 | 13 |  */ | 
 | 14 |  | 
 | 15 | #ifndef _DEBUGFS_H_ | 
 | 16 | #define _DEBUGFS_H_ | 
 | 17 |  | 
 | 18 | #include <linux/fs.h> | 
 | 19 |  | 
| Roland Dreier | a7a76ce | 2005-04-18 21:57:33 -0700 | [diff] [blame] | 20 | #include <linux/types.h> | 
 | 21 |  | 
 | 22 | struct file_operations; | 
 | 23 |  | 
| Michael Ellerman | dd308bc | 2006-03-07 21:41:59 +1100 | [diff] [blame] | 24 | struct debugfs_blob_wrapper { | 
 | 25 | 	void *data; | 
 | 26 | 	unsigned long size; | 
 | 27 | }; | 
 | 28 |  | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 29 | #if defined(CONFIG_DEBUG_FS) | 
 | 30 | struct dentry *debugfs_create_file(const char *name, mode_t mode, | 
 | 31 | 				   struct dentry *parent, void *data, | 
| Arjan van de Ven | 99ac48f | 2006-03-28 01:56:41 -0800 | [diff] [blame] | 32 | 				   const struct file_operations *fops); | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 33 |  | 
 | 34 | struct dentry *debugfs_create_dir(const char *name, struct dentry *parent); | 
 | 35 |  | 
| Peter Oberparleiter | 66f5496 | 2007-02-13 12:13:54 +0100 | [diff] [blame] | 36 | struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent, | 
 | 37 | 				      const char *dest); | 
 | 38 |  | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 39 | void debugfs_remove(struct dentry *dentry); | 
 | 40 |  | 
 | 41 | struct dentry *debugfs_create_u8(const char *name, mode_t mode, | 
 | 42 | 				 struct dentry *parent, u8 *value); | 
 | 43 | struct dentry *debugfs_create_u16(const char *name, mode_t mode, | 
 | 44 | 				  struct dentry *parent, u16 *value); | 
 | 45 | struct dentry *debugfs_create_u32(const char *name, mode_t mode, | 
 | 46 | 				  struct dentry *parent, u32 *value); | 
| Michael Ellerman | 8447891 | 2007-04-17 15:59:36 +1000 | [diff] [blame] | 47 | struct dentry *debugfs_create_u64(const char *name, mode_t mode, | 
 | 48 | 				  struct dentry *parent, u64 *value); | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 49 | struct dentry *debugfs_create_bool(const char *name, mode_t mode, | 
 | 50 | 				  struct dentry *parent, u32 *value); | 
 | 51 |  | 
| Michael Ellerman | dd308bc | 2006-03-07 21:41:59 +1100 | [diff] [blame] | 52 | struct dentry *debugfs_create_blob(const char *name, mode_t mode, | 
 | 53 | 				  struct dentry *parent, | 
 | 54 | 				  struct debugfs_blob_wrapper *blob); | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 55 | #else | 
| Roland Dreier | a7a76ce | 2005-04-18 21:57:33 -0700 | [diff] [blame] | 56 |  | 
 | 57 | #include <linux/err.h> | 
 | 58 |  | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 59 | /*  | 
 | 60 |  * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled | 
 | 61 |  * so users have a chance to detect if there was a real error or not.  We don't | 
 | 62 |  * want to duplicate the design decision mistakes of procfs and devfs again. | 
 | 63 |  */ | 
 | 64 |  | 
 | 65 | static inline struct dentry *debugfs_create_file(const char *name, mode_t mode, | 
| Jean Delvare | bde11d7 | 2006-04-18 21:30:22 -0700 | [diff] [blame] | 66 | 					struct dentry *parent, void *data, | 
 | 67 | 					const struct file_operations *fops) | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 68 | { | 
 | 69 | 	return ERR_PTR(-ENODEV); | 
 | 70 | } | 
 | 71 |  | 
 | 72 | static inline struct dentry *debugfs_create_dir(const char *name, | 
 | 73 | 						struct dentry *parent) | 
 | 74 | { | 
 | 75 | 	return ERR_PTR(-ENODEV); | 
 | 76 | } | 
 | 77 |  | 
| Peter Oberparleiter | 66f5496 | 2007-02-13 12:13:54 +0100 | [diff] [blame] | 78 | static inline struct dentry *debugfs_create_symlink(const char *name, | 
 | 79 | 						    struct dentry *parent, | 
 | 80 | 						    const char *dest) | 
 | 81 | { | 
 | 82 | 	return ERR_PTR(-ENODEV); | 
 | 83 | } | 
 | 84 |  | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 85 | static inline void debugfs_remove(struct dentry *dentry) | 
 | 86 | { } | 
 | 87 |  | 
 | 88 | static inline struct dentry *debugfs_create_u8(const char *name, mode_t mode, | 
 | 89 | 					       struct dentry *parent, | 
 | 90 | 					       u8 *value) | 
 | 91 | { | 
 | 92 | 	return ERR_PTR(-ENODEV); | 
 | 93 | } | 
 | 94 |  | 
 | 95 | static inline struct dentry *debugfs_create_u16(const char *name, mode_t mode, | 
 | 96 | 						struct dentry *parent, | 
| Michal Ostrowski | 7b55863 | 2005-04-18 21:57:34 -0700 | [diff] [blame] | 97 | 						u16 *value) | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 98 | { | 
 | 99 | 	return ERR_PTR(-ENODEV); | 
 | 100 | } | 
 | 101 |  | 
 | 102 | static inline struct dentry *debugfs_create_u32(const char *name, mode_t mode, | 
 | 103 | 						struct dentry *parent, | 
| Michal Ostrowski | 7b55863 | 2005-04-18 21:57:34 -0700 | [diff] [blame] | 104 | 						u32 *value) | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 105 | { | 
 | 106 | 	return ERR_PTR(-ENODEV); | 
 | 107 | } | 
 | 108 |  | 
| Michael Ellerman | 8447891 | 2007-04-17 15:59:36 +1000 | [diff] [blame] | 109 | static inline struct dentry *debugfs_create_u64(const char *name, mode_t mode, | 
 | 110 | 						struct dentry *parent, | 
 | 111 | 						u64 *value) | 
 | 112 | { | 
 | 113 | 	return ERR_PTR(-ENODEV); | 
 | 114 | } | 
 | 115 |  | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 116 | static inline struct dentry *debugfs_create_bool(const char *name, mode_t mode, | 
 | 117 | 						 struct dentry *parent, | 
| Michal Ostrowski | 7b55863 | 2005-04-18 21:57:34 -0700 | [diff] [blame] | 118 | 						 u32 *value) | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 119 | { | 
 | 120 | 	return ERR_PTR(-ENODEV); | 
 | 121 | } | 
 | 122 |  | 
| Michael Ellerman | dd308bc | 2006-03-07 21:41:59 +1100 | [diff] [blame] | 123 | static inline struct dentry *debugfs_create_blob(const char *name, mode_t mode, | 
 | 124 | 				  struct dentry *parent, | 
 | 125 | 				  struct debugfs_blob_wrapper *blob) | 
 | 126 | { | 
 | 127 | 	return ERR_PTR(-ENODEV); | 
 | 128 | } | 
 | 129 |  | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 130 | #endif | 
 | 131 |  | 
 | 132 | #endif |