[mirror_ubuntu-jammy-kernel.git] / include / drm / drm_debugfs.h

/*
 * Internal Header for the Direct Rendering Manager
 *
 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
 * Copyright (c) 2009-2010, Code Aurora Forum.
 * All rights reserved.
 *
 * Author: Rickard E. (Rik) Faith <faith@valinux.com>
 * Author: Gareth Hughes <gareth@valinux.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef _DRM_DEBUGFS_H_
#define _DRM_DEBUGFS_H_

#include <linux/types.h>
#include <linux/seq_file.h>
/**
 * struct drm_info_list - debugfs info list entry
 *
 * This structure represents a debugfs file to be created by the drm
 * core.
 */
struct drm_info_list {
	/** @name: file name */
	const char *name;
	/**
	 * @show:
	 *
	 * Show callback. &seq_file->private will be set to the &struct
	 * drm_info_node corresponding to the instance of this info on a given
	 * &struct drm_minor.
	 */
	int (*show)(struct seq_file*, void*);
	/** @driver_features: Required driver features for this entry */
	u32 driver_features;
	/** @data: Driver-private data, should not be device-specific. */
	void *data;
};

/**
 * struct drm_info_node - Per-minor debugfs node structure
 *
 * This structure represents a debugfs file, as an instantiation of a &struct
 * drm_info_list on a &struct drm_minor.
 *
 * FIXME:
 *
 * No it doesn't make a hole lot of sense that we duplicate debugfs entries for
 * both the render and the primary nodes, but that's how this has organically
 * grown. It should probably be fixed, with a compatibility link, if needed.
 */
struct drm_info_node {
	/** @minor: &struct drm_minor for this node. */
	struct drm_minor *minor;
	/** @info_ent: template for this node. */
	const struct drm_info_list *info_ent;
	/* private: */
	struct list_head list;
	struct dentry *dent;
};

#if defined(CONFIG_DEBUG_FS)
void drm_debugfs_create_files(const struct drm_info_list *files,
			      int count, struct dentry *root,
			      struct drm_minor *minor);
int drm_debugfs_remove_files(const struct drm_info_list *files,
			     int count, struct drm_minor *minor);
#else
static inline void drm_debugfs_create_files(const struct drm_info_list *files,
					    int count, struct dentry *root,
					    struct drm_minor *minor)
{}

static inline int drm_debugfs_remove_files(const struct drm_info_list *files,
					   int count, struct drm_minor *minor)
{
	return 0;
}
#endif

#endif /* _DRM_DEBUGFS_H_ */
Commit	Line	Data
4834442d DV	1	/*
	2	* Internal Header for the Direct Rendering Manager
	3	*
	4	* Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
	5	* Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
	6	* Copyright (c) 2009-2010, Code Aurora Forum.
	7	* All rights reserved.
	8	*
	9	* Author: Rickard E. (Rik) Faith <faith@valinux.com>
	10	* Author: Gareth Hughes <gareth@valinux.com>
	11	*
	12	* Permission is hereby granted, free of charge, to any person obtaining a
	13	* copy of this software and associated documentation files (the "Software"),
	14	* to deal in the Software without restriction, including without limitation
	15	* the rights to use, copy, modify, merge, publish, distribute, sublicense,
	16	* and/or sell copies of the Software, and to permit persons to whom the
	17	* Software is furnished to do so, subject to the following conditions:
	18	*
	19	* The above copyright notice and this permission notice (including the next
	20	* paragraph) shall be included in all copies or substantial portions of the
	21	* Software.
	22	*
	23	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	24	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	25	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	26	* VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
	27	* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
	28	* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
	29	* OTHER DEALINGS IN THE SOFTWARE.
	30	*/
	31
	32	#ifndef _DRM_DEBUGFS_H_
	33	#define _DRM_DEBUGFS_H_
	34
a7d469cc SR	35	#include <linux/types.h>
a7d469cc SR	36	#include <linux/seq_file.h>
4834442d	37	/**
0cad7f71 DV	38	* struct drm_info_list - debugfs info list entry
	39	*
	40	* This structure represents a debugfs file to be created by the drm
	41	* core.
4834442d DV	42	*/
4834442d DV	43	struct drm_info_list {
0cad7f71 DV	44	/** @name: file name */
	45	const char *name;
	46	/**
	47	* @show:
	48	*
	49	* Show callback. &seq_file->private will be set to the &struct
	50	* drm_info_node corresponding to the instance of this info on a given
	51	* &struct drm_minor.
	52	*/
	53	int (show)(struct seq_file, void*);
	54	/** @driver_features: Required driver features for this entry */
	55	u32 driver_features;
	56	/** @data: Driver-private data, should not be device-specific. */
4834442d DV	57	void *data;
	58	};
	59
	60	/**
0cad7f71 DV	61	* struct drm_info_node - Per-minor debugfs node structure
	62	*
	63	* This structure represents a debugfs file, as an instantiation of a &struct
	64	* drm_info_list on a &struct drm_minor.
	65	*
	66	* FIXME:
	67	*
	68	* No it doesn't make a hole lot of sense that we duplicate debugfs entries for
	69	* both the render and the primary nodes, but that's how this has organically
	70	* grown. It should probably be fixed, with a compatibility link, if needed.
4834442d DV	71	*/
4834442d DV	72	struct drm_info_node {
0cad7f71	73	/** @minor: &struct drm_minor for this node. */
4834442d	74	struct drm_minor *minor;
0cad7f71	75	/** @info_ent: template for this node. */
4834442d	76	const struct drm_info_list *info_ent;
0cad7f71 DV	77	/* private: */
0cad7f71 DV	78	struct list_head list;
4834442d DV	79	struct dentry *dent;
	80	};
	81
	82	#if defined(CONFIG_DEBUG_FS)
a212d6a5 WK	83	void drm_debugfs_create_files(const struct drm_info_list *files,
	84	int count, struct dentry *root,
	85	struct drm_minor *minor);
4834442d DV	86	int drm_debugfs_remove_files(const struct drm_info_list *files,
	87	int count, struct drm_minor *minor);
	88	#else
a212d6a5 WK	89	static inline void drm_debugfs_create_files(const struct drm_info_list *files,
	90	int count, struct dentry *root,
	91	struct drm_minor *minor)
	92	{}
4834442d DV	93
	94	static inline int drm_debugfs_remove_files(const struct drm_info_list *files,
	95	int count, struct drm_minor *minor)
	96	{
	97	return 0;
	98	}
	99	#endif
	100
	101	#endif /* _DRM_DEBUGFS_H_ */