1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 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 * $FreeBSD$ 28 */ 29 30 #ifndef _LINUXKPI_LINUX_DEBUGFS_H_ 31 #define _LINUXKPI_LINUX_DEBUGFS_H_ 32 33 #include <linux/fs.h> 34 #include <linux/module.h> 35 #include <linux/seq_file.h> 36 #include <linux/types.h> 37 38 MALLOC_DECLARE(M_DFSINT); 39 40 struct debugfs_reg32 { 41 char *name; 42 unsigned long offset; 43 }; 44 45 struct debugfs_regset32 { 46 const struct debugfs_reg32 *regs; 47 int nregs; 48 }; 49 50 struct debugfs_blob_wrapper { 51 void *data; 52 size_t size; 53 }; 54 55 struct dentry *debugfs_create_file(const char *name, umode_t mode, 56 struct dentry *parent, void *data, 57 const struct file_operations *fops); 58 59 /* TODO: We currently ignore the `file_size` argument. */ 60 struct dentry *debugfs_create_file_size(const char *name, umode_t mode, 61 struct dentry *parent, void *data, 62 const struct file_operations *fops, 63 loff_t file_size); 64 65 struct dentry *debugfs_create_file_unsafe(const char *name, umode_t mode, 66 struct dentry *parent, void *data, 67 const struct file_operations *fops); 68 69 struct dentry *debugfs_create_mode_unsafe(const char *name, umode_t mode, 70 struct dentry *parent, void *data, 71 const struct file_operations *fops, 72 const struct file_operations *fops_ro, 73 const struct file_operations *fops_wo); 74 75 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent); 76 77 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent, 78 const char *dest); 79 80 void debugfs_remove(struct dentry *dentry); 81 82 void debugfs_remove_recursive(struct dentry *dentry); 83 84 #define DEFINE_DEBUGFS_ATTRIBUTE(__fops, __get, __set, __fmt) \ 85 DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) 86 87 void debugfs_create_bool(const char *name, umode_t mode, struct dentry *parent, 88 bool *value); 89 void debugfs_create_u8(const char *name, umode_t mode, struct dentry *parent, 90 uint8_t *value); 91 void debugfs_create_u16(const char *name, umode_t mode, struct dentry *parent, 92 uint16_t *value); 93 void debugfs_create_u32(const char *name, umode_t mode, struct dentry *parent, 94 uint32_t *value); 95 void debugfs_create_u64(const char *name, umode_t mode, struct dentry *parent, 96 uint64_t *value); 97 void debugfs_create_x8(const char *name, umode_t mode, struct dentry *parent, 98 uint8_t *value); 99 void debugfs_create_x16(const char *name, umode_t mode, struct dentry *parent, 100 uint16_t *value); 101 void debugfs_create_x32(const char *name, umode_t mode, struct dentry *parent, 102 uint32_t *value); 103 void debugfs_create_x64(const char *name, umode_t mode, struct dentry *parent, 104 uint64_t *value); 105 void debugfs_create_ulong(const char *name, umode_t mode, struct dentry *parent, 106 unsigned long *value); 107 void debugfs_create_atomic_t(const char *name, umode_t mode, struct dentry *parent, 108 atomic_t *value); 109 110 struct dentry *debugfs_create_blob(const char *name, umode_t mode, 111 struct dentry *parent, struct debugfs_blob_wrapper *value); 112 113 #endif /* _LINUXKPI_LINUX_DEBUGFS_H_ */ 114