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