| 1 | |
| 2 | * debugfs.h - a tiny little debug file system
|
| 3 | *
|
| 4 | * Copyright (C) 2004 Greg Kroah-Hartman <[email protected]>
|
| 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 |
|
| 20 | #include <linux/types.h>
|
| 21 |
|
| 22 | struct file_operations;
|
| 23 |
|
| 24 | struct debugfs_blob_wrapper {
|
| 25 | void *data;
|
| 26 | unsigned long size;
|
| 27 | };
|
| 28 |
|
| 29 | #if defined(CONFIG_DEBUG_FS)
|
| 30 | struct dentry *debugfs_create_file(const char *name, mode_t mode,
|
| 31 | struct dentry *parent, void *data,
|
| 32 | const struct file_operations *fops);
|
| 33 |
|
| 34 | struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
|
| 35 |
|
| 36 | struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
|
| 37 | const char *dest);
|
| 38 |
|
| 39 | void debugfs_remove(struct dentry *dentry);
|
| 40 |
|
| 41 | struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
|
| 42 | struct dentry *new_dir, const char *new_name);
|
| 43 |
|
| 44 | struct dentry *debugfs_create_u8(const char *name, mode_t mode,
|
| 45 | struct dentry *parent, u8 *value);
|
| 46 | struct dentry *debugfs_create_u16(const char *name, mode_t mode,
|
| 47 | struct dentry *parent, u16 *value);
|
| 48 | struct dentry *debugfs_create_u32(const char *name, mode_t mode,
|
| 49 | struct dentry *parent, u32 *value);
|
| 50 | struct dentry *debugfs_create_u64(const char *name, mode_t mode,
|
| 51 | struct dentry *parent, u64 *value);
|
| 52 | struct dentry *debugfs_create_x8(const char *name, mode_t mode,
|
| 53 | struct dentry *parent, u8 *value);
|
| 54 | struct dentry *debugfs_create_x16(const char *name, mode_t mode,
|
| 55 | struct dentry *parent, u16 *value);
|
| 56 | struct dentry *debugfs_create_x32(const char *name, mode_t mode,
|
| 57 | struct dentry *parent, u32 *value);
|
| 58 | struct dentry *debugfs_create_bool(const char *name, mode_t mode,
|
| 59 | struct dentry *parent, u32 *value);
|
| 60 |
|
| 61 | struct dentry *debugfs_create_blob(const char *name, mode_t mode,
|
| 62 | struct dentry *parent,
|
| 63 | struct debugfs_blob_wrapper *blob);
|
| 64 | #else
|
| 65 |
|
| 66 | #include <linux/err.h>
|
| 67 |
|
| 68 | |
| 69 | * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
|
| 70 | * so users have a chance to detect if there was a real error or not. We don't
|
| 71 | * want to duplicate the design decision mistakes of procfs and devfs again.
|
| 72 |
|
| 73 |
|
| 74 | static inline struct dentry *debugfs_create_file(const char *name, mode_t mode,
|
| 75 | struct dentry *parent, void *data,
|
| 76 | const struct file_operations *fops)
|
| 77 | {
|
| 78 | return ERR_PTR(-ENODEV);
|
| 79 | }
|
| 80 |
|
| 81 | static inline struct dentry *debugfs_create_dir(const char *name,
|
| 82 | struct dentry *parent)
|
| 83 | {
|
| 84 | return ERR_PTR(-ENODEV);
|
| 85 | }
|
| 86 |
|
| 87 | static inline struct dentry *debugfs_create_symlink(const char *name,
|
| 88 | struct dentry *parent,
|
| 89 | const char *dest)
|
| 90 | {
|
| 91 | return ERR_PTR(-ENODEV);
|
| 92 | }
|
| 93 |
|
| 94 | static inline void debugfs_remove(struct dentry *dentry)
|
| 95 | { }
|
| 96 |
|
| 97 | static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
|
| 98 | struct dentry *new_dir, char *new_name)
|
| 99 | {
|
| 100 | return ERR_PTR(-ENODEV);
|
| 101 | }
|
| 102 |
|
| 103 | static inline struct dentry *debugfs_create_u8(const char *name, mode_t mode,
|
| 104 | struct dentry *parent,
|
| 105 | u8 *value)
|
| 106 | {
|
| 107 | return ERR_PTR(-ENODEV);
|
| 108 | }
|
| 109 |
|
| 110 | static inline struct dentry *debugfs_create_u16(const char *name, mode_t mode,
|
| 111 | struct dentry *parent,
|
| 112 | u16 *value)
|
| 113 | {
|
| 114 | return ERR_PTR(-ENODEV);
|
| 115 | }
|
| 116 |
|
| 117 | static inline struct dentry *debugfs_create_u32(const char *name, mode_t mode,
|
| 118 | struct dentry *parent,
|
| 119 | u32 *value)
|
| 120 | {
|
| 121 | return ERR_PTR(-ENODEV);
|
| 122 | }
|
| 123 |
|
| 124 | static inline struct dentry *debugfs_create_u64(const char *name, mode_t mode,
|
| 125 | struct dentry *parent,
|
| 126 | u64 *value)
|
| 127 | {
|
| 128 | return ERR_PTR(-ENODEV);
|
| 129 | }
|
| 130 |
|
| 131 | static inline struct dentry *debugfs_create_x8(const char *name, mode_t mode,
|
| 132 | struct dentry *parent,
|
| 133 | u8 *value)
|
| 134 | {
|
| 135 | return ERR_PTR(-ENODEV);
|
| 136 | }
|
| 137 |
|
| 138 | static inline struct dentry *debugfs_create_x16(const char *name, mode_t mode,
|
| 139 | struct dentry *parent,
|
| 140 | u16 *value)
|
| 141 | {
|
| 142 | return ERR_PTR(-ENODEV);
|
| 143 | }
|
| 144 |
|
| 145 | static inline struct dentry *debugfs_create_x32(const char *name, mode_t mode,
|
| 146 | struct dentry *parent,
|
| 147 | u32 *value)
|
| 148 | {
|
| 149 | return ERR_PTR(-ENODEV);
|
| 150 | }
|
| 151 |
|
| 152 | static inline struct dentry *debugfs_create_bool(const char *name, mode_t mode,
|
| 153 | struct dentry *parent,
|
| 154 | u32 *value)
|
| 155 | {
|
| 156 | return ERR_PTR(-ENODEV);
|
| 157 | }
|
| 158 |
|
| 159 | static inline struct dentry *debugfs_create_blob(const char *name, mode_t mode,
|
| 160 | struct dentry *parent,
|
| 161 | struct debugfs_blob_wrapper *blob)
|
| 162 | {
|
| 163 | return ERR_PTR(-ENODEV);
|
| 164 | }
|
| 165 |
|
| 166 | #endif
|
| 167 |
|
| 168 | #endif
|