2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2016-2018, Matthew Macy <mmacy@freebsd.org>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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
30 #ifndef _LINUXKPI_LINUX_DEBUGFS_H_
31 #define _LINUXKPI_LINUX_DEBUGFS_H_
34 #include <linux/module.h>
35 #include <linux/seq_file.h>
36 #include <linux/types.h>
38 MALLOC_DECLARE(M_DFSINT);
40 struct debugfs_reg32 {
45 struct debugfs_regset32 {
46 const struct debugfs_reg32 *regs;
50 struct debugfs_blob_wrapper {
56 debugfs_initialized(void)
62 struct dentry *debugfs_create_file(const char *name, umode_t mode,
63 struct dentry *parent, void *data,
64 const struct file_operations *fops);
66 /* TODO: We currently ignore the `file_size` argument. */
67 struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
68 struct dentry *parent, void *data,
69 const struct file_operations *fops,
72 struct dentry *debugfs_create_file_unsafe(const char *name, umode_t mode,
73 struct dentry *parent, void *data,
74 const struct file_operations *fops);
76 struct dentry *debugfs_create_mode_unsafe(const char *name, umode_t mode,
77 struct dentry *parent, void *data,
78 const struct file_operations *fops,
79 const struct file_operations *fops_ro,
80 const struct file_operations *fops_wo);
82 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
84 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
87 void debugfs_remove(struct dentry *dentry);
89 void debugfs_remove_recursive(struct dentry *dentry);
91 #define DEFINE_DEBUGFS_ATTRIBUTE(__fops, __get, __set, __fmt) \
92 DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt)
94 void debugfs_create_bool(const char *name, umode_t mode, struct dentry *parent,
96 void debugfs_create_u8(const char *name, umode_t mode, struct dentry *parent,
98 void debugfs_create_u16(const char *name, umode_t mode, struct dentry *parent,
100 void debugfs_create_u32(const char *name, umode_t mode, struct dentry *parent,
102 void debugfs_create_u64(const char *name, umode_t mode, struct dentry *parent,
104 void debugfs_create_x8(const char *name, umode_t mode, struct dentry *parent,
106 void debugfs_create_x16(const char *name, umode_t mode, struct dentry *parent,
108 void debugfs_create_x32(const char *name, umode_t mode, struct dentry *parent,
110 void debugfs_create_x64(const char *name, umode_t mode, struct dentry *parent,
112 void debugfs_create_ulong(const char *name, umode_t mode, struct dentry *parent,
113 unsigned long *value);
114 void debugfs_create_atomic_t(const char *name, umode_t mode, struct dentry *parent,
117 struct dentry *debugfs_create_blob(const char *name, umode_t mode,
118 struct dentry *parent, struct debugfs_blob_wrapper *value);
120 #endif /* _LINUXKPI_LINUX_DEBUGFS_H_ */