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 #include <linux/seq_file.h>
  20
  21 #include <linux/types.h>
  22
  23 struct device;
  24 struct file_operations;
  25
  26 struct debugfs_blob_wrapper {
  27         void *data;
  28         unsigned long size;
  29 };
  30
  31 struct debugfs_reg32 {
  32         char *name;
  33         unsigned long offset;
  34 };
  35
  36 struct debugfs_regset32 {
  37         const struct debugfs_reg32 *regs;
  38         int nregs;
  39         void __iomem *base;
  40 };
  41
  42 extern struct dentry *arch_debugfs_dir;
  43
  44 #if defined(CONFIG_DEBUG_FS)
  45
  46 /* declared over in file.c */
  47 extern const struct file_operations debugfs_file_operations;
  48
  49 struct dentry *debugfs_create_file(const char *name, umode_t mode,
  50                                    struct dentry *parent, void *data,
  51                                    const struct file_operations *fops);
  52
  53 struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
  54                                         struct dentry *parent, void *data,
  55                                         const struct file_operations *fops,
  56                                         loff_t file_size);
  57
  58 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
  59
  60 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
  61                                       const char *dest);
  62
  63 struct dentry *debugfs_create_automount(const char *name,
  64                                         struct dentry *parent,
  65                                         struct vfsmount *(*f)(void *),
  66                                         void *data);
  67
  68 void debugfs_remove(struct dentry *dentry);
  69 void debugfs_remove_recursive(struct dentry *dentry);
  70
  71 struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
  72                 struct dentry *new_dir, const char *new_name);
  73
  74 struct dentry *debugfs_create_u8(const char *name, umode_t mode,
  75                                  struct dentry *parent, u8 *value);
  76 struct dentry *debugfs_create_u16(const char *name, umode_t mode,
  77                                   struct dentry *parent, u16 *value);
  78 struct dentry *debugfs_create_u32(const char *name, umode_t mode,
  79                                   struct dentry *parent, u32 *value);
  80 struct dentry *debugfs_create_u64(const char *name, umode_t mode,
  81                                   struct dentry *parent, u64 *value);
  82 struct dentry *debugfs_create_x8(const char *name, umode_t mode,
  83                                  struct dentry *parent, u8 *value);
  84 struct dentry *debugfs_create_x16(const char *name, umode_t mode,
  85                                   struct dentry *parent, u16 *value);
  86 struct dentry *debugfs_create_x32(const char *name, umode_t mode,
  87                                   struct dentry *parent, u32 *value);
  88 struct dentry *debugfs_create_x64(const char *name, umode_t mode,
  89                                   struct dentry *parent, u64 *value);
  90 struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
  91                                      struct dentry *parent, size_t *value);
  92 struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode,
  93                                      struct dentry *parent, atomic_t *value);
  94 struct dentry *debugfs_create_bool(const char *name, umode_t mode,
  95                                   struct dentry *parent, u32 *value);
  96
  97 struct dentry *debugfs_create_blob(const char *name, umode_t mode,
  98                                   struct dentry *parent,
  99                                   struct debugfs_blob_wrapper *blob);
 100
 101 struct dentry *debugfs_create_regset32(const char *name, umode_t mode,
 102                                      struct dentry *parent,
 103                                      struct debugfs_regset32 *regset);
 104
 105 void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
 106                           int nregs, void __iomem *base, char *prefix);
 107
 108 struct dentry *debugfs_create_u32_array(const char *name, umode_t mode,
 109                                         struct dentry *parent,
 110                                         u32 *array, u32 elements);
 111
 112 struct dentry *debugfs_create_devm_seqfile(struct device *dev, const char *name,
 113                                            struct dentry *parent,
 114                                            int (*read_fn)(struct seq_file *s,
 115                                                           void *data));
 116
 117 bool debugfs_initialized(void);
 118
 119 #else
 120
 121 #include <linux/err.h>
 122
 123 /*
 124  * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
 125  * so users have a chance to detect if there was a real error or not.  We don't
 126  * want to duplicate the design decision mistakes of procfs and devfs again.
 127  */
 128
 129 static inline struct dentry *debugfs_create_file(const char *name, umode_t mode,
 130                                         struct dentry *parent, void *data,
 131                                         const struct file_operations *fops)
 132 {
 133         return ERR_PTR(-ENODEV);
 134 }
 135
 136 static inline struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
 137                                         struct dentry *parent, void *data,
 138                                         const struct file_operations *fops,
 139                                         loff_t file_size)
 140 {
 141         return ERR_PTR(-ENODEV);
 142 }
 143
 144 static inline struct dentry *debugfs_create_dir(const char *name,
 145                                                 struct dentry *parent)
 146 {
 147         return ERR_PTR(-ENODEV);
 148 }
 149
 150 static inline struct dentry *debugfs_create_symlink(const char *name,
 151                                                     struct dentry *parent,
 152                                                     const char *dest)
 153 {
 154         return ERR_PTR(-ENODEV);
 155 }
 156
 157 static inline void debugfs_remove(struct dentry *dentry)
 158 { }
 159
 160 static inline void debugfs_remove_recursive(struct dentry *dentry)
 161 { }
 162
 163 static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
 164                 struct dentry *new_dir, char *new_name)
 165 {
 166         return ERR_PTR(-ENODEV);
 167 }
 168
 169 static inline struct dentry *debugfs_create_u8(const char *name, umode_t mode,
 170                                                struct dentry *parent,
 171                                                u8 *value)
 172 {
 173         return ERR_PTR(-ENODEV);
 174 }
 175
 176 static inline struct dentry *debugfs_create_u16(const char *name, umode_t mode,
 177                                                 struct dentry *parent,
 178                                                 u16 *value)
 179 {
 180         return ERR_PTR(-ENODEV);
 181 }
 182
 183 static inline struct dentry *debugfs_create_u32(const char *name, umode_t mode,
 184                                                 struct dentry *parent,
 185                                                 u32 *value)
 186 {
 187         return ERR_PTR(-ENODEV);
 188 }
 189
 190 static inline struct dentry *debugfs_create_u64(const char *name, umode_t mode,
 191                                                 struct dentry *parent,
 192                                                 u64 *value)
 193 {
 194         return ERR_PTR(-ENODEV);
 195 }
 196
 197 static inline struct dentry *debugfs_create_x8(const char *name, umode_t mode,
 198                                                struct dentry *parent,
 199                                                u8 *value)
 200 {
 201         return ERR_PTR(-ENODEV);
 202 }
 203
 204 static inline struct dentry *debugfs_create_x16(const char *name, umode_t mode,
 205                                                 struct dentry *parent,
 206                                                 u16 *value)
 207 {
 208         return ERR_PTR(-ENODEV);
 209 }
 210
 211 static inline struct dentry *debugfs_create_x32(const char *name, umode_t mode,
 212                                                 struct dentry *parent,
 213                                                 u32 *value)
 214 {
 215         return ERR_PTR(-ENODEV);
 216 }
 217
 218 static inline struct dentry *debugfs_create_x64(const char *name, umode_t mode,
 219                                                 struct dentry *parent,
 220                                                 u64 *value)
 221 {
 222         return ERR_PTR(-ENODEV);
 223 }
 224
 225 static inline struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
 226                                      struct dentry *parent,
 227                                      size_t *value)
 228 {
 229         return ERR_PTR(-ENODEV);
 230 }
 231
 232 static inline struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode,
 233                                      struct dentry *parent, atomic_t *value)
 234 {
 235         return ERR_PTR(-ENODEV);
 236 }
 237
 238 static inline struct dentry *debugfs_create_bool(const char *name, umode_t mode,
 239                                                  struct dentry *parent,
 240                                                  u32 *value)
 241 {
 242         return ERR_PTR(-ENODEV);
 243 }
 244
 245 static inline struct dentry *debugfs_create_blob(const char *name, umode_t mode,
 246                                   struct dentry *parent,
 247                                   struct debugfs_blob_wrapper *blob)
 248 {
 249         return ERR_PTR(-ENODEV);
 250 }
 251
 252 static inline struct dentry *debugfs_create_regset32(const char *name,
 253                                    umode_t mode, struct dentry *parent,
 254                                    struct debugfs_regset32 *regset)
 255 {
 256         return ERR_PTR(-ENODEV);
 257 }
 258
 259 static inline void debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
 260                          int nregs, void __iomem *base, char *prefix)
 261 {
 262 }
 263
 264 static inline bool debugfs_initialized(void)
 265 {
 266         return false;
 267 }
 268
 269 static inline struct dentry *debugfs_create_u32_array(const char *name, umode_t mode,
 270                                         struct dentry *parent,
 271                                         u32 *array, u32 elements)
 272 {
 273         return ERR_PTR(-ENODEV);
 274 }
 275
 276 static inline struct dentry *debugfs_create_devm_seqfile(struct device *dev,
 277                                                          const char *name,
 278                                                          struct dentry *parent,
 279                                            int (*read_fn)(struct seq_file *s,
 280                                                           void *data))
 281 {
 282         return ERR_PTR(-ENODEV);
 283 }
 284
 285 #endif
 286
 287 #endif