debugfs.h 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  1. #ifndef _HFI1_DEBUGFS_H
  2. #define _HFI1_DEBUGFS_H
  3. /*
  4. * Copyright(c) 2015, 2016, 2018 Intel Corporation.
  5. *
  6. * This file is provided under a dual BSD/GPLv2 license. When using or
  7. * redistributing this file, you may do so under either license.
  8. *
  9. * GPL LICENSE SUMMARY
  10. *
  11. * This program is free software; you can redistribute it and/or modify
  12. * it under the terms of version 2 of the GNU General Public License as
  13. * published by the Free Software Foundation.
  14. *
  15. * This program is distributed in the hope that it will be useful, but
  16. * WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18. * General Public License for more details.
  19. *
  20. * BSD LICENSE
  21. *
  22. * Redistribution and use in source and binary forms, with or without
  23. * modification, are permitted provided that the following conditions
  24. * are met:
  25. *
  26. * - Redistributions of source code must retain the above copyright
  27. * notice, this list of conditions and the following disclaimer.
  28. * - Redistributions in binary form must reproduce the above copyright
  29. * notice, this list of conditions and the following disclaimer in
  30. * the documentation and/or other materials provided with the
  31. * distribution.
  32. * - Neither the name of Intel Corporation nor the names of its
  33. * contributors may be used to endorse or promote products derived
  34. * from this software without specific prior written permission.
  35. *
  36. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  37. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  38. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  39. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  40. * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  41. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  42. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  43. * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  44. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  45. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  46. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  47. *
  48. */
  49. struct hfi1_ibdev;
  50. #define DEBUGFS_FILE_CREATE(name, parent, data, ops, mode) \
  51. do { \
  52. struct dentry *ent; \
  53. const char *__name = name; \
  54. ent = debugfs_create_file(__name, mode, parent, \
  55. data, ops); \
  56. if (!ent) \
  57. pr_warn("create of %s failed\n", __name); \
  58. } while (0)
  59. #define DEBUGFS_SEQ_FILE_OPS(name) \
  60. static const struct seq_operations _##name##_seq_ops = { \
  61. .start = _##name##_seq_start, \
  62. .next = _##name##_seq_next, \
  63. .stop = _##name##_seq_stop, \
  64. .show = _##name##_seq_show \
  65. }
  66. #define DEBUGFS_SEQ_FILE_OPEN(name) \
  67. static int _##name##_open(struct inode *inode, struct file *s) \
  68. { \
  69. struct seq_file *seq; \
  70. int ret; \
  71. ret = seq_open(s, &_##name##_seq_ops); \
  72. if (ret) \
  73. return ret; \
  74. seq = s->private_data; \
  75. seq->private = inode->i_private; \
  76. return 0; \
  77. }
  78. #define DEBUGFS_FILE_OPS(name) \
  79. static const struct file_operations _##name##_file_ops = { \
  80. .owner = THIS_MODULE, \
  81. .open = _##name##_open, \
  82. .read = hfi1_seq_read, \
  83. .llseek = hfi1_seq_lseek, \
  84. .release = seq_release \
  85. }
  86. #define DEBUGFS_SEQ_FILE_CREATE(name, parent, data) \
  87. DEBUGFS_FILE_CREATE(#name, parent, data, &_##name##_file_ops, 0444)
  88. ssize_t hfi1_seq_read(struct file *file, char __user *buf, size_t size,
  89. loff_t *ppos);
  90. loff_t hfi1_seq_lseek(struct file *file, loff_t offset, int whence);
  91. #ifdef CONFIG_DEBUG_FS
  92. void hfi1_dbg_ibdev_init(struct hfi1_ibdev *ibd);
  93. void hfi1_dbg_ibdev_exit(struct hfi1_ibdev *ibd);
  94. void hfi1_dbg_init(void);
  95. void hfi1_dbg_exit(void);
  96. #else
  97. static inline void hfi1_dbg_ibdev_init(struct hfi1_ibdev *ibd)
  98. {
  99. }
  100. static inline void hfi1_dbg_ibdev_exit(struct hfi1_ibdev *ibd)
  101. {
  102. }
  103. static inline void hfi1_dbg_init(void)
  104. {
  105. }
  106. static inline void hfi1_dbg_exit(void)
  107. {
  108. }
  109. #endif
  110. #endif /* _HFI1_DEBUGFS_H */