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