debugfs.h 6.0 KB

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