1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2016-2018, Matthew Macy <mmacy@freebsd.org>
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 */
27
28 #ifndef _LINUXKPI_LINUX_DEBUGFS_H_
29 #define _LINUXKPI_LINUX_DEBUGFS_H_
30
31 #include <linux/fs.h>
32 #include <linux/module.h>
33 #include <linux/seq_file.h>
34 #include <linux/types.h>
35
36 MALLOC_DECLARE(M_DFSINT);
37
38 struct debugfs_reg32 {
39 char *name;
40 unsigned long offset;
41 };
42
43 struct debugfs_regset32 {
44 const struct debugfs_reg32 *regs;
45 int nregs;
46 };
47
48 struct debugfs_blob_wrapper {
49 void *data;
50 size_t size;
51 };
52
53 static inline bool
debugfs_initialized(void)54 debugfs_initialized(void)
55 {
56
57 return (true);
58 }
59
60 struct dentry *debugfs_create_file(const char *name, umode_t mode,
61 struct dentry *parent, void *data,
62 const struct file_operations *fops);
63
64 /* TODO: We currently ignore the `file_size` argument. */
65 struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
66 struct dentry *parent, void *data,
67 const struct file_operations *fops,
68 loff_t file_size);
69
70 struct dentry *debugfs_create_file_unsafe(const char *name, umode_t mode,
71 struct dentry *parent, void *data,
72 const struct file_operations *fops);
73
74 struct dentry *debugfs_create_mode_unsafe(const char *name, umode_t mode,
75 struct dentry *parent, void *data,
76 const struct file_operations *fops,
77 const struct file_operations *fops_ro,
78 const struct file_operations *fops_wo);
79
80 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
81
82 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
83 const char *dest);
84
85 struct dentry *debugfs_lookup(const char *name, struct dentry *parent);
86
87 void debugfs_remove(struct dentry *dentry);
88
89 void debugfs_remove_recursive(struct dentry *dentry);
90
91 #define DEFINE_DEBUGFS_ATTRIBUTE(__fops, __get, __set, __fmt) \
92 DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt)
93 #define DEFINE_DEBUGFS_ATTRIBUTE_SIGNED(__fops, __get, __set, __fmt) \
94 DEFINE_SIMPLE_ATTRIBUTE_SIGNED(__fops, __get, __set, __fmt)
95
96 void debugfs_create_bool(const char *name, umode_t mode, struct dentry *parent,
97 bool *value);
98 void debugfs_create_u8(const char *name, umode_t mode, struct dentry *parent,
99 uint8_t *value);
100 void debugfs_create_u16(const char *name, umode_t mode, struct dentry *parent,
101 uint16_t *value);
102 void debugfs_create_u32(const char *name, umode_t mode, struct dentry *parent,
103 uint32_t *value);
104 void debugfs_create_u64(const char *name, umode_t mode, struct dentry *parent,
105 uint64_t *value);
106 void debugfs_create_x8(const char *name, umode_t mode, struct dentry *parent,
107 uint8_t *value);
108 void debugfs_create_x16(const char *name, umode_t mode, struct dentry *parent,
109 uint16_t *value);
110 void debugfs_create_x32(const char *name, umode_t mode, struct dentry *parent,
111 uint32_t *value);
112 void debugfs_create_x64(const char *name, umode_t mode, struct dentry *parent,
113 uint64_t *value);
114 void debugfs_create_ulong(const char *name, umode_t mode, struct dentry *parent,
115 unsigned long *value);
116 void debugfs_create_atomic_t(const char *name, umode_t mode, struct dentry *parent,
117 atomic_t *value);
118
119 struct dentry *debugfs_create_blob(const char *name, umode_t mode,
120 struct dentry *parent, struct debugfs_blob_wrapper *value);
121
122 #endif /* _LINUXKPI_LINUX_DEBUGFS_H_ */
123