xref: /freebsd/sys/compat/linuxkpi/common/include/linux/debugfs.h (revision 8c5c572125665e3fd8a033d1a8b0a370e5a43e24)

/*-
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Copyright (c) 2016-2018, Matthew Macy <mmacy@freebsd.org>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef _LINUXKPI_LINUX_DEBUGFS_H_
#define _LINUXKPI_LINUX_DEBUGFS_H_

#include <linux/fs.h>
#include <linux/module.h>
#include <linux/seq_file.h>
#include <linux/types.h>

MALLOC_DECLARE(M_DFSINT);

struct debugfs_reg32 {
	char *name;
	unsigned long offset;
};

struct debugfs_regset32 {
	const struct debugfs_reg32 *regs;
	int nregs;
};

struct debugfs_blob_wrapper {
	void			*data;
	size_t			size;
};

static inline bool
debugfs_initialized(void)
{

	return (true);
}

struct dentry *debugfs_create_file(const char *name, umode_t mode,
    struct dentry *parent, void *data,
    const struct file_operations *fops);

/* TODO: We currently ignore the `file_size` argument. */
struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
    struct dentry *parent, void *data,
    const struct file_operations *fops,
    loff_t file_size);

struct dentry *debugfs_create_file_unsafe(const char *name, umode_t mode,
struct dentry *parent, void *data,
    const struct file_operations *fops);

struct dentry *debugfs_create_mode_unsafe(const char *name, umode_t mode,
    struct dentry *parent, void *data,
    const struct file_operations *fops,
    const struct file_operations *fops_ro,
    const struct file_operations *fops_wo);

struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);

struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
    const char *dest);

void debugfs_remove(struct dentry *dentry);

void debugfs_remove_recursive(struct dentry *dentry);

#define DEFINE_DEBUGFS_ATTRIBUTE(__fops, __get, __set, __fmt) \
	DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt)
#define DEFINE_DEBUGFS_ATTRIBUTE_SIGNED(__fops, __get, __set, __fmt) \
	DEFINE_SIMPLE_ATTRIBUTE_SIGNED(__fops, __get, __set, __fmt)

void debugfs_create_bool(const char *name, umode_t mode, struct dentry *parent,
    bool *value);
void debugfs_create_u8(const char *name, umode_t mode, struct dentry *parent,
    uint8_t *value);
void debugfs_create_u16(const char *name, umode_t mode, struct dentry *parent,
    uint16_t *value);
void debugfs_create_u32(const char *name, umode_t mode, struct dentry *parent,
    uint32_t *value);
void debugfs_create_u64(const char *name, umode_t mode, struct dentry *parent,
    uint64_t *value);
void debugfs_create_x8(const char *name, umode_t mode, struct dentry *parent,
    uint8_t *value);
void debugfs_create_x16(const char *name, umode_t mode, struct dentry *parent,
    uint16_t *value);
void debugfs_create_x32(const char *name, umode_t mode, struct dentry *parent,
    uint32_t *value);
void debugfs_create_x64(const char *name, umode_t mode, struct dentry *parent,
    uint64_t *value);
void debugfs_create_ulong(const char *name, umode_t mode, struct dentry *parent,
    unsigned long *value);
void debugfs_create_atomic_t(const char *name, umode_t mode, struct dentry *parent,
    atomic_t *value);

struct dentry *debugfs_create_blob(const char *name, umode_t mode,
    struct dentry *parent, struct debugfs_blob_wrapper *value);

#endif /* _LINUXKPI_LINUX_DEBUGFS_H_ */