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 
50 struct hfi1_ibdev;
51 
52 #define DEBUGFS_FILE_CREATE(name, parent, data, ops, mode)	\
53 do { \
54 	struct dentry *ent; \
55 	const char *__name = name; \
56 	ent = debugfs_create_file(__name, mode, parent, \
57 		data, ops); \
58 	if (!ent) \
59 		pr_warn("create of %s failed\n", __name); \
60 } while (0)
61 
62 #define DEBUGFS_SEQ_FILE_OPS(name) \
63 static const struct seq_operations _##name##_seq_ops = { \
64 	.start = _##name##_seq_start, \
65 	.next  = _##name##_seq_next, \
66 	.stop  = _##name##_seq_stop, \
67 	.show  = _##name##_seq_show \
68 }
69 
70 #define DEBUGFS_SEQ_FILE_OPEN(name) \
71 static int _##name##_open(struct inode *inode, struct file *s) \
72 { \
73 	struct seq_file *seq; \
74 	int ret; \
75 	ret =  seq_open(s, &_##name##_seq_ops); \
76 	if (ret) \
77 		return ret; \
78 	seq = s->private_data; \
79 	seq->private = inode->i_private; \
80 	return 0; \
81 }
82 
83 #define DEBUGFS_FILE_OPS(name) \
84 static const struct file_operations _##name##_file_ops = { \
85 	.owner   = THIS_MODULE, \
86 	.open    = _##name##_open, \
87 	.read    = hfi1_seq_read, \
88 	.llseek  = hfi1_seq_lseek, \
89 	.release = seq_release \
90 }
91 
92 #define DEBUGFS_SEQ_FILE_CREATE(name, parent, data) \
93 	DEBUGFS_FILE_CREATE(#name, parent, data, &_##name##_file_ops, 0444)
94 
95 ssize_t hfi1_seq_read(struct file *file, char __user *buf, size_t size,
96 		      loff_t *ppos);
97 loff_t hfi1_seq_lseek(struct file *file, loff_t offset, int whence);
98 
99 #ifdef CONFIG_DEBUG_FS
100 void hfi1_dbg_ibdev_init(struct hfi1_ibdev *ibd);
101 void hfi1_dbg_ibdev_exit(struct hfi1_ibdev *ibd);
102 void hfi1_dbg_init(void);
103 void hfi1_dbg_exit(void);
104 
105 #else
106 static inline void hfi1_dbg_ibdev_init(struct hfi1_ibdev *ibd)
107 {
108 }
109 
110 static inline void hfi1_dbg_ibdev_exit(struct hfi1_ibdev *ibd)
111 {
112 }
113 
114 static inline void hfi1_dbg_init(void)
115 {
116 }
117 
118 static inline void hfi1_dbg_exit(void)
119 {
120 }
121 #endif
122 
123 #endif                          /* _HFI1_DEBUGFS_H */
124