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/kernel-api for more details.
  13  */
  14
  15 #ifndef _DEBUGFS_H_
  16 #define _DEBUGFS_H_
  17
  18 #if defined(CONFIG_DEBUG_FS)
  19 struct dentry *debugfs_create_file(const char *name, mode_t mode,
  20                                    struct dentry *parent, void *data,
  21                                    struct file_operations *fops);
  22
  23 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
  24
  25 void debugfs_remove(struct dentry *dentry);
  26
  27 struct dentry *debugfs_create_u8(const char *name, mode_t mode,
  28                                  struct dentry *parent, u8 *value);
  29 struct dentry *debugfs_create_u16(const char *name, mode_t mode,
  30                                   struct dentry *parent, u16 *value);
  31 struct dentry *debugfs_create_u32(const char *name, mode_t mode,
  32                                   struct dentry *parent, u32 *value);
  33 struct dentry *debugfs_create_bool(const char *name, mode_t mode,
  34                                   struct dentry *parent, u32 *value);
  35
  36 #else
  37 /*
  38  * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
  39  * so users have a chance to detect if there was a real error or not.  We don't
  40  * want to duplicate the design decision mistakes of procfs and devfs again.
  41  */
  42
  43 static inline struct dentry *debugfs_create_file(const char *name, mode_t mode,
  44                                                  struct dentry *parent,
  45                                                  void *data,
  46                                                  struct file_operations *fops)
  47 {
  48         return ERR_PTR(-ENODEV);
  49 }
  50
  51 static inline struct dentry *debugfs_create_dir(const char *name,
  52                                                 struct dentry *parent)
  53 {
  54         return ERR_PTR(-ENODEV);
  55 }
  56
  57 static inline void debugfs_remove(struct dentry *dentry)
  58 { }
  59
  60 static inline struct dentry *debugfs_create_u8(const char *name, mode_t mode,
  61                                                struct dentry *parent,
  62                                                u8 *value)
  63 {
  64         return ERR_PTR(-ENODEV);
  65 }
  66
  67 static inline struct dentry *debugfs_create_u16(const char *name, mode_t mode,
  68                                                 struct dentry *parent,
  69                                                 u8 *value)
  70 {
  71         return ERR_PTR(-ENODEV);
  72 }
  73
  74 static inline struct dentry *debugfs_create_u32(const char *name, mode_t mode,
  75                                                 struct dentry *parent,
  76                                                 u8 *value)
  77 {
  78         return ERR_PTR(-ENODEV);
  79 }
  80
  81 static inline struct dentry *debugfs_create_bool(const char *name, mode_t mode,
  82                                                  struct dentry *parent,
  83                                                  u8 *value)
  84 {
  85         return ERR_PTR(-ENODEV);
  86 }
  87
  88 #endif
  89
  90 #endif