debugfs.h 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270
  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. const 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, umode_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, umode_t mode,
  49. struct dentry *parent, u8 *value);
  50. struct dentry *debugfs_create_u16(const char *name, umode_t mode,
  51. struct dentry *parent, u16 *value);
  52. struct dentry *debugfs_create_u32(const char *name, umode_t mode,
  53. struct dentry *parent, u32 *value);
  54. struct dentry *debugfs_create_u64(const char *name, umode_t mode,
  55. struct dentry *parent, u64 *value);
  56. struct dentry *debugfs_create_x8(const char *name, umode_t mode,
  57. struct dentry *parent, u8 *value);
  58. struct dentry *debugfs_create_x16(const char *name, umode_t mode,
  59. struct dentry *parent, u16 *value);
  60. struct dentry *debugfs_create_x32(const char *name, umode_t mode,
  61. struct dentry *parent, u32 *value);
  62. struct dentry *debugfs_create_x64(const char *name, umode_t mode,
  63. struct dentry *parent, u64 *value);
  64. struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
  65. struct dentry *parent, size_t *value);
  66. struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode,
  67. struct dentry *parent, atomic_t *value);
  68. struct dentry *debugfs_create_bool(const char *name, umode_t mode,
  69. struct dentry *parent, u32 *value);
  70. struct dentry *debugfs_create_blob(const char *name, umode_t mode,
  71. struct dentry *parent,
  72. struct debugfs_blob_wrapper *blob);
  73. struct dentry *debugfs_create_regset32(const char *name, umode_t mode,
  74. struct dentry *parent,
  75. struct debugfs_regset32 *regset);
  76. int debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
  77. int nregs, void __iomem *base, char *prefix);
  78. struct dentry *debugfs_create_u32_array(const char *name, umode_t mode,
  79. struct dentry *parent,
  80. u32 *array, u32 elements);
  81. struct dentry *debugfs_create_devm_seqfile(struct device *dev, const char *name,
  82. struct dentry *parent,
  83. int (*read_fn)(struct seq_file *s,
  84. void *data));
  85. bool debugfs_initialized(void);
  86. #else
  87. #include <linux/err.h>
  88. /*
  89. * We do not return NULL from these functions if CONFIG_DEBUG_FS is not enabled
  90. * so users have a chance to detect if there was a real error or not. We don't
  91. * want to duplicate the design decision mistakes of procfs and devfs again.
  92. */
  93. static inline struct dentry *debugfs_create_file(const char *name, umode_t mode,
  94. struct dentry *parent, void *data,
  95. const struct file_operations *fops)
  96. {
  97. return ERR_PTR(-ENODEV);
  98. }
  99. static inline struct dentry *debugfs_create_dir(const char *name,
  100. struct dentry *parent)
  101. {
  102. return ERR_PTR(-ENODEV);
  103. }
  104. static inline struct dentry *debugfs_create_symlink(const char *name,
  105. struct dentry *parent,
  106. const char *dest)
  107. {
  108. return ERR_PTR(-ENODEV);
  109. }
  110. static inline void debugfs_remove(struct dentry *dentry)
  111. { }
  112. static inline void debugfs_remove_recursive(struct dentry *dentry)
  113. { }
  114. static inline struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
  115. struct dentry *new_dir, char *new_name)
  116. {
  117. return ERR_PTR(-ENODEV);
  118. }
  119. static inline struct dentry *debugfs_create_u8(const char *name, umode_t mode,
  120. struct dentry *parent,
  121. u8 *value)
  122. {
  123. return ERR_PTR(-ENODEV);
  124. }
  125. static inline struct dentry *debugfs_create_u16(const char *name, umode_t mode,
  126. struct dentry *parent,
  127. u16 *value)
  128. {
  129. return ERR_PTR(-ENODEV);
  130. }
  131. static inline struct dentry *debugfs_create_u32(const char *name, umode_t mode,
  132. struct dentry *parent,
  133. u32 *value)
  134. {
  135. return ERR_PTR(-ENODEV);
  136. }
  137. static inline struct dentry *debugfs_create_u64(const char *name, umode_t mode,
  138. struct dentry *parent,
  139. u64 *value)
  140. {
  141. return ERR_PTR(-ENODEV);
  142. }
  143. static inline struct dentry *debugfs_create_x8(const char *name, umode_t mode,
  144. struct dentry *parent,
  145. u8 *value)
  146. {
  147. return ERR_PTR(-ENODEV);
  148. }
  149. static inline struct dentry *debugfs_create_x16(const char *name, umode_t mode,
  150. struct dentry *parent,
  151. u16 *value)
  152. {
  153. return ERR_PTR(-ENODEV);
  154. }
  155. static inline struct dentry *debugfs_create_x32(const char *name, umode_t mode,
  156. struct dentry *parent,
  157. u32 *value)
  158. {
  159. return ERR_PTR(-ENODEV);
  160. }
  161. static inline struct dentry *debugfs_create_x64(const char *name, umode_t mode,
  162. struct dentry *parent,
  163. u64 *value)
  164. {
  165. return ERR_PTR(-ENODEV);
  166. }
  167. static inline struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
  168. struct dentry *parent,
  169. size_t *value)
  170. {
  171. return ERR_PTR(-ENODEV);
  172. }
  173. static inline struct dentry *debugfs_create_atomic_t(const char *name, umode_t mode,
  174. struct dentry *parent, atomic_t *value)
  175. {
  176. return ERR_PTR(-ENODEV);
  177. }
  178. static inline struct dentry *debugfs_create_bool(const char *name, umode_t mode,
  179. struct dentry *parent,
  180. u32 *value)
  181. {
  182. return ERR_PTR(-ENODEV);
  183. }
  184. static inline struct dentry *debugfs_create_blob(const char *name, umode_t mode,
  185. struct dentry *parent,
  186. struct debugfs_blob_wrapper *blob)
  187. {
  188. return ERR_PTR(-ENODEV);
  189. }
  190. static inline struct dentry *debugfs_create_regset32(const char *name,
  191. umode_t mode, struct dentry *parent,
  192. struct debugfs_regset32 *regset)
  193. {
  194. return ERR_PTR(-ENODEV);
  195. }
  196. static inline int debugfs_print_regs32(struct seq_file *s, const struct debugfs_reg32 *regs,
  197. int nregs, void __iomem *base, char *prefix)
  198. {
  199. return 0;
  200. }
  201. static inline bool debugfs_initialized(void)
  202. {
  203. return false;
  204. }
  205. static inline struct dentry *debugfs_create_u32_array(const char *name, umode_t mode,
  206. struct dentry *parent,
  207. u32 *array, u32 elements)
  208. {
  209. return ERR_PTR(-ENODEV);
  210. }
  211. static inline struct dentry *debugfs_create_devm_seqfile(struct device *dev,
  212. const char *name,
  213. struct dentry *parent,
  214. int (*read_fn)(struct seq_file *s,
  215. void *data))
  216. {
  217. return ERR_PTR(-ENODEV);
  218. }
  219. #endif
  220. #endif