debugfs.h 5.4 KB

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