include/linux/debugfs.h

   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/filesystems 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 extern struct dentry *arch_debugfs_dir;
  30
  31 #if defined(CONFIG_DEBUG_FS)
  32
  33 /* declared over in file.c */
  34 extern const struct file_operations debugfs_file_operations;
  35 extern const struct inode_operations debugfs_link_operations;
  36
  37 struct dentry *debugfs_create_file(const char *name, umode_t mode,
  38                                    struct dentry *parent, void *data,
  39                                    const struct file_operations *fops);
  40
  41 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
  42
  43 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
  44                                       const char *dest);
  45
  46 void debugfs_remove(struct dentry *dentry);
  47 void debugfs_remove_recursive(struct dentry *dentry);
  48
  49 struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
  50                 struct dentry *new_dir, const char *new_name);
  51
  52 struct dentry *debugfs_create_u8(const char *name, umode_t mode,
  53                                  struct dentry *parent, u8 *value);
  54 struct dentry *debugfs_create_u16(const char *name, umode_t mode,
  55                                   struct dentry *parent, u16 *value);
  56 struct dentry *debugfs_create_u32(const char *name, umode_t mode,
  57                                   struct dentry *parent, u32 *value);
  58 struct dentry *debugfs_create_u64(const char *name, umode_t mode,
  59                                   struct dentry *parent, u64 *value);
  60 struct dentry *debugfs_create_x8(const char *name, umode_t mode,
  61                                  struct dentry *parent, u8 *value);
  62 struct dentry *debugfs_create_x16(const char *name, umode_t mode,
  63                                   struct dentry *parent, u16 *value);
  64 struct dentry *debugfs_create_x32(const char *name, umode_t mode,
  65                                   struct dentry *parent, u32 *value);
  66 struct dentry *debugfs_create_x64(const char *name, umode_t mode,
  67                                   struct dentry *parent, u64 *value);
  68 struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
  69                                      struct dentry *parent, size_t *value);
  70 struct dentry *debugfs_create_bool(const char *name, umode_t mode,
  71                                   struct dentry *parent, u32 *value);
  72
  73 struct dentry *debugfs_create_blob(const char *name, umode_t mode,
  74                                   struct dentry *parent,
  75                                   struct debugfs_blob_wrapper *blob);
  76
  77 bool debugfs_initialized(void);
  78
  79 #else
  80
  81 #include <linux/err.h>
  82
  83 /*
  84  * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
  85  * so users have a chance to detect if there was a real error or not.  We don't
  86  * want to duplicate the design decision mistakes of procfs and devfs again.
  87  */
  88
  89 static inline struct dentry *debugfs_create_file(const char *name, umode_t mode,
  90                                         struct dentry *parent, void *data,
  91                                         const struct file_operations *fops)
  92 {
  93         return ERR_PTR(-ENODEV);
  94 }
  95
  96 static inline struct dentry *debugfs_create_dir(const char *name,
  97                                                 struct dentry *parent)
  98 {
  99         return ERR_PTR(-ENODEV);
 100 }
 101
 102 static inline struct dentry *debugfs_create_symlink(const char *name,
 103                                                     struct dentry *parent,
 104                                                     const char *dest)
 105 {
 106         return ERR_PTR(-ENODEV);
 107 }
 108
 109 static inline void debugfs_remove(struct dentry *dentry)
 110 { }
 111
 112 static inline void debugfs_remove_recursive(struct dentry *dentry)
 113 { }
 114
 115 static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
 116                 struct dentry *new_dir, char *new_name)
 117 {
 118         return ERR_PTR(-ENODEV);
 119 }
 120
 121 static inline struct dentry *debugfs_create_u8(const char *name, umode_t mode,
 122                                                struct dentry *parent,
 123                                                u8 *value)
 124 {
 125         return ERR_PTR(-ENODEV);
 126 }
 127
 128 static inline struct dentry *debugfs_create_u16(const char *name, umode_t mode,
 129                                                 struct dentry *parent,
 130                                                 u16 *value)
 131 {
 132         return ERR_PTR(-ENODEV);
 133 }
 134
 135 static inline struct dentry *debugfs_create_u32(const char *name, umode_t mode,
 136                                                 struct dentry *parent,
 137                                                 u32 *value)
 138 {
 139         return ERR_PTR(-ENODEV);
 140 }
 141
 142 static inline struct dentry *debugfs_create_u64(const char *name, umode_t mode,
 143                                                 struct dentry *parent,
 144                                                 u64 *value)
 145 {
 146         return ERR_PTR(-ENODEV);
 147 }
 148
 149 static inline struct dentry *debugfs_create_x8(const char *name, umode_t mode,
 150                                                struct dentry *parent,
 151                                                u8 *value)
 152 {
 153         return ERR_PTR(-ENODEV);
 154 }
 155
 156 static inline struct dentry *debugfs_create_x16(const char *name, umode_t mode,
 157                                                 struct dentry *parent,
 158                                                 u16 *value)
 159 {
 160         return ERR_PTR(-ENODEV);
 161 }
 162
 163 static inline struct dentry *debugfs_create_x32(const char *name, umode_t mode,
 164                                                 struct dentry *parent,
 165                                                 u32 *value)
 166 {
 167         return ERR_PTR(-ENODEV);
 168 }
 169
 170 static inline struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
 171                                      struct dentry *parent,
 172                                      size_t *value)
 173 {
 174         return ERR_PTR(-ENODEV);
 175 }
 176
 177 static inline struct dentry *debugfs_create_bool(const char *name, umode_t mode,
 178                                                  struct dentry *parent,
 179                                                  u32 *value)
 180 {
 181         return ERR_PTR(-ENODEV);
 182 }
 183
 184 static inline struct dentry *debugfs_create_blob(const char *name, umode_t mode,
 185                                   struct dentry *parent,
 186                                   struct debugfs_blob_wrapper *blob)
 187 {
 188         return ERR_PTR(-ENODEV);
 189 }
 190
 191 static inline bool debugfs_initialized(void)
 192 {
 193         return false;
 194 }
 195
 196 #endif
 197
 198 #endif