[linux-2.6-block.git] / drivers / opp / debugfs.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * Generic OPP debugfs interface
 *
 * Copyright (C) 2015-2016 Viresh Kumar <viresh.kumar@linaro.org>
 */

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <linux/debugfs.h>
#include <linux/device.h>
#include <linux/err.h>
#include <linux/of.h>
#include <linux/init.h>
#include <linux/limits.h>
#include <linux/slab.h>

#include "opp.h"

static struct dentry *rootdir;

static void opp_set_dev_name(const struct device *dev, char *name)
{
	if (dev->parent)
		snprintf(name, NAME_MAX, "%s-%s", dev_name(dev->parent),
			 dev_name(dev));
	else
		snprintf(name, NAME_MAX, "%s", dev_name(dev));
}

void opp_debug_remove_one(struct dev_pm_opp *opp)
{
	debugfs_remove_recursive(opp->dentry);
}

static ssize_t bw_name_read(struct file *fp, char __user *userbuf,
			    size_t count, loff_t *ppos)
{
	struct icc_path *path = fp->private_data;
	char buf[64];
	int i;

	i = scnprintf(buf, sizeof(buf), "%.62s\n", icc_get_name(path));

	return simple_read_from_buffer(userbuf, count, ppos, buf, i);
}

static const struct file_operations bw_name_fops = {
	.open = simple_open,
	.read = bw_name_read,
	.llseek = default_llseek,
};

static void opp_debug_create_bw(struct dev_pm_opp *opp,
				struct opp_table *opp_table,
				struct dentry *pdentry)
{
	struct dentry *d;
	char name[20];
	int i;

	for (i = 0; i < opp_table->path_count; i++) {
		snprintf(name, sizeof(name), "icc-path-%.1d", i);

		/* Create per-path directory */
		d = debugfs_create_dir(name, pdentry);

		debugfs_create_file("name", S_IRUGO, d, opp_table->paths[i],
				    &bw_name_fops);
		debugfs_create_u32("peak_bw", S_IRUGO, d,
				   &opp->bandwidth[i].peak);
		debugfs_create_u32("avg_bw", S_IRUGO, d,
				   &opp->bandwidth[i].avg);
	}
}

static void opp_debug_create_clks(struct dev_pm_opp *opp,
				  struct opp_table *opp_table,
				  struct dentry *pdentry)
{
	char name[12];
	int i;

	if (opp_table->clk_count == 1) {
		debugfs_create_ulong("rate_hz", S_IRUGO, pdentry, &opp->rates[0]);
		return;
	}

	for (i = 0; i < opp_table->clk_count; i++) {
		snprintf(name, sizeof(name), "rate_hz_%d", i);
		debugfs_create_ulong(name, S_IRUGO, pdentry, &opp->rates[i]);
	}
}

static void opp_debug_create_supplies(struct dev_pm_opp *opp,
				      struct opp_table *opp_table,
				      struct dentry *pdentry)
{
	struct dentry *d;
	int i;

	for (i = 0; i < opp_table->regulator_count; i++) {
		char name[15];

		snprintf(name, sizeof(name), "supply-%d", i);

		/* Create per-opp directory */
		d = debugfs_create_dir(name, pdentry);

		debugfs_create_ulong("u_volt_target", S_IRUGO, d,
				     &opp->supplies[i].u_volt);

		debugfs_create_ulong("u_volt_min", S_IRUGO, d,
				     &opp->supplies[i].u_volt_min);

		debugfs_create_ulong("u_volt_max", S_IRUGO, d,
				     &opp->supplies[i].u_volt_max);

		debugfs_create_ulong("u_amp", S_IRUGO, d,
				     &opp->supplies[i].u_amp);

		debugfs_create_ulong("u_watt", S_IRUGO, d,
				     &opp->supplies[i].u_watt);
	}
}

void opp_debug_create_one(struct dev_pm_opp *opp, struct opp_table *opp_table)
{
	struct dentry *pdentry = opp_table->dentry;
	struct dentry *d;
	unsigned long id;
	char name[25];	/* 20 chars for 64 bit value + 5 (opp:\0) */

	/*
	 * Get directory name for OPP.
	 *
	 * - Normally rate is unique to each OPP, use it to get unique opp-name.
	 * - For some devices rate isn't available or there are multiple, use
	 *   index instead for them.
	 */
	if (likely(opp_table->clk_count == 1 && opp->rates[0]))
		id = opp->rates[0];
	else
		id = _get_opp_count(opp_table);

	snprintf(name, sizeof(name), "opp:%lu", id);

	/* Create per-opp directory */
	d = debugfs_create_dir(name, pdentry);

	debugfs_create_bool("available", S_IRUGO, d, &opp->available);
	debugfs_create_bool("dynamic", S_IRUGO, d, &opp->dynamic);
	debugfs_create_bool("turbo", S_IRUGO, d, &opp->turbo);
	debugfs_create_bool("suspend", S_IRUGO, d, &opp->suspend);
	debugfs_create_u32("level", S_IRUGO, d, &opp->level);
	debugfs_create_ulong("clock_latency_ns", S_IRUGO, d,
			     &opp->clock_latency_ns);

	opp->of_name = of_node_full_name(opp->np);
	debugfs_create_str("of_name", S_IRUGO, d, (char **)&opp->of_name);

	opp_debug_create_clks(opp, opp_table, d);
	opp_debug_create_supplies(opp, opp_table, d);
	opp_debug_create_bw(opp, opp_table, d);

	opp->dentry = d;
}

static void opp_list_debug_create_dir(struct opp_device *opp_dev,
				      struct opp_table *opp_table)
{
	const struct device *dev = opp_dev->dev;
	struct dentry *d;

	opp_set_dev_name(dev, opp_table->dentry_name);

	/* Create device specific directory */
	d = debugfs_create_dir(opp_table->dentry_name, rootdir);

	opp_dev->dentry = d;
	opp_table->dentry = d;
}

static void opp_list_debug_create_link(struct opp_device *opp_dev,
				       struct opp_table *opp_table)
{
	char name[NAME_MAX];

	opp_set_dev_name(opp_dev->dev, name);

	/* Create device specific directory link */
	opp_dev->dentry = debugfs_create_symlink(name, rootdir,
						 opp_table->dentry_name);
}

/**
 * opp_debug_register - add a device opp node to the debugfs 'opp' directory
 * @opp_dev: opp-dev pointer for device
 * @opp_table: the device-opp being added
 *
 * Dynamically adds device specific directory in debugfs 'opp' directory. If the
 * device-opp is shared with other devices, then links will be created for all
 * devices except the first.
 */
void opp_debug_register(struct opp_device *opp_dev, struct opp_table *opp_table)
{
	if (opp_table->dentry)
		opp_list_debug_create_link(opp_dev, opp_table);
	else
		opp_list_debug_create_dir(opp_dev, opp_table);
}

static void opp_migrate_dentry(struct opp_device *opp_dev,
			       struct opp_table *opp_table)
{
	struct opp_device *new_dev = NULL, *iter;
	const struct device *dev;
	struct dentry *dentry;

	/* Look for next opp-dev */
	list_for_each_entry(iter, &opp_table->dev_list, node)
		if (iter != opp_dev) {
			new_dev = iter;
			break;
		}

	BUG_ON(!new_dev);

	/* new_dev is guaranteed to be valid here */
	dev = new_dev->dev;
	debugfs_remove_recursive(new_dev->dentry);

	opp_set_dev_name(dev, opp_table->dentry_name);

	dentry = debugfs_rename(rootdir, opp_dev->dentry, rootdir,
				opp_table->dentry_name);
	if (IS_ERR(dentry)) {
		dev_err(dev, "%s: Failed to rename link from: %s to %s\n",
			__func__, dev_name(opp_dev->dev), dev_name(dev));
		return;
	}

	new_dev->dentry = dentry;
	opp_table->dentry = dentry;
}

/**
 * opp_debug_unregister - remove a device opp node from debugfs opp directory
 * @opp_dev: opp-dev pointer for device
 * @opp_table: the device-opp being removed
 *
 * Dynamically removes device specific directory from debugfs 'opp' directory.
 */
void opp_debug_unregister(struct opp_device *opp_dev,
			  struct opp_table *opp_table)
{
	if (opp_dev->dentry == opp_table->dentry) {
		/* Move the real dentry object under another device */
		if (!list_is_singular(&opp_table->dev_list)) {
			opp_migrate_dentry(opp_dev, opp_table);
			goto out;
		}
		opp_table->dentry = NULL;
	}

	debugfs_remove_recursive(opp_dev->dentry);

out:
	opp_dev->dentry = NULL;
}

static int __init opp_debug_init(void)
{
	/* Create /sys/kernel/debug/opp directory */
	rootdir = debugfs_create_dir("opp", NULL);

	return 0;
}
core_initcall(opp_debug_init);
Commit	Line	Data
d2912cb1	1	// SPDX-License-Identifier: GPL-2.0-only
deaa5146 VK	2	/*
	3	* Generic OPP debugfs interface
	4	*
	5	* Copyright (C) 2015-2016 Viresh Kumar <viresh.kumar@linaro.org>
deaa5146 VK	6	*/
	7
	8	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
	9
	10	#include <linux/debugfs.h>
	11	#include <linux/device.h>
	12	#include <linux/err.h>
021dbeca	13	#include <linux/of.h>
deaa5146 VK	14	#include <linux/init.h>
deaa5146 VK	15	#include <linux/limits.h>
dfbe4678	16	#include <linux/slab.h>
deaa5146 VK	17
	18	#include "opp.h"
	19
	20	static struct dentry *rootdir;
	21
	22	static void opp_set_dev_name(const struct device dev, char name)
	23	{
	24	if (dev->parent)
	25	snprintf(name, NAME_MAX, "%s-%s", dev_name(dev->parent),
	26	dev_name(dev));
	27	else
	28	snprintf(name, NAME_MAX, "%s", dev_name(dev));
	29	}
	30
	31	void opp_debug_remove_one(struct dev_pm_opp *opp)
	32	{
	33	debugfs_remove_recursive(opp->dentry);
	34	}
	35
0430b1d5 VK	36	static ssize_t bw_name_read(struct file fp, char __user userbuf,
	37	size_t count, loff_t *ppos)
	38	{
	39	struct icc_path *path = fp->private_data;
	40	char buf[64];
	41	int i;
	42
	43	i = scnprintf(buf, sizeof(buf), "%.62s\n", icc_get_name(path));
	44
	45	return simple_read_from_buffer(userbuf, count, ppos, buf, i);
	46	}
	47
	48	static const struct file_operations bw_name_fops = {
	49	.open = simple_open,
	50	.read = bw_name_read,
	51	.llseek = default_llseek,
	52	};
	53
	54	static void opp_debug_create_bw(struct dev_pm_opp *opp,
	55	struct opp_table *opp_table,
	56	struct dentry *pdentry)
	57	{
	58	struct dentry *d;
3aa87254	59	char name[20];
0430b1d5 VK	60	int i;
	61
	62	for (i = 0; i < opp_table->path_count; i++) {
	63	snprintf(name, sizeof(name), "icc-path-%.1d", i);
	64
	65	/* Create per-path directory */
	66	d = debugfs_create_dir(name, pdentry);
	67
	68	debugfs_create_file("name", S_IRUGO, d, opp_table->paths[i],
	69	&bw_name_fops);
	70	debugfs_create_u32("peak_bw", S_IRUGO, d,
	71	&opp->bandwidth[i].peak);
	72	debugfs_create_u32("avg_bw", S_IRUGO, d,
	73	&opp->bandwidth[i].avg);
	74	}
	75	}
	76
2083da24 VK	77	static void opp_debug_create_clks(struct dev_pm_opp *opp,
	78	struct opp_table *opp_table,
	79	struct dentry *pdentry)
	80	{
	81	char name[12];
	82	int i;
	83
	84	if (opp_table->clk_count == 1) {
	85	debugfs_create_ulong("rate_hz", S_IRUGO, pdentry, &opp->rates[0]);
	86	return;
	87	}
	88
	89	for (i = 0; i < opp_table->clk_count; i++) {
	90	snprintf(name, sizeof(name), "rate_hz_%d", i);
	91	debugfs_create_ulong(name, S_IRUGO, pdentry, &opp->rates[i]);
	92	}
	93	}
	94
a2dea4cb	95	static void opp_debug_create_supplies(struct dev_pm_opp *opp,
dfbe4678 VK	96	struct opp_table *opp_table,
	97	struct dentry *pdentry)
	98	{
	99	struct dentry *d;
1fae788e	100	int i;
dfbe4678	101
1fae788e	102	for (i = 0; i < opp_table->regulator_count; i++) {
d741029a AY	103	char name[15];
	104
	105	snprintf(name, sizeof(name), "supply-%d", i);
dfbe4678 VK	106
	107	/* Create per-opp directory */
	108	d = debugfs_create_dir(name, pdentry);
	109
a2dea4cb GKH	110	debugfs_create_ulong("u_volt_target", S_IRUGO, d,
a2dea4cb GKH	111	&opp->supplies[i].u_volt);
dfbe4678	112
a2dea4cb GKH	113	debugfs_create_ulong("u_volt_min", S_IRUGO, d,
a2dea4cb GKH	114	&opp->supplies[i].u_volt_min);
dfbe4678	115
a2dea4cb GKH	116	debugfs_create_ulong("u_volt_max", S_IRUGO, d,
a2dea4cb GKH	117	&opp->supplies[i].u_volt_max);
dfbe4678	118
a2dea4cb GKH	119	debugfs_create_ulong("u_amp", S_IRUGO, d,
a2dea4cb GKH	120	&opp->supplies[i].u_amp);
4f9a7a1d LL	121
	122	debugfs_create_ulong("u_watt", S_IRUGO, d,
	123	&opp->supplies[i].u_watt);
1fae788e	124	}
dfbe4678 VK	125	}
dfbe4678 VK	126
a2dea4cb	127	void opp_debug_create_one(struct dev_pm_opp opp, struct opp_table opp_table)
deaa5146	128	{
2c2709dc	129	struct dentry *pdentry = opp_table->dentry;
deaa5146	130	struct dentry *d;
a1e8c136	131	unsigned long id;
deaa5146 VK	132	char name[25]; /* 20 chars for 64 bit value + 5 (opp:\0) */
deaa5146 VK	133
a1e8c136 VK	134	/*
	135	* Get directory name for OPP.
	136	*
	137	* - Normally rate is unique to each OPP, use it to get unique opp-name.
2083da24 VK	138	* - For some devices rate isn't available or there are multiple, use
2083da24 VK	139	* index instead for them.
a1e8c136	140	*/
2083da24 VK	141	if (likely(opp_table->clk_count == 1 && opp->rates[0]))
2083da24 VK	142	id = opp->rates[0];
a1e8c136 VK	143	else
	144	id = _get_opp_count(opp_table);
	145
	146	snprintf(name, sizeof(name), "opp:%lu", id);
deaa5146 VK	147
	148	/* Create per-opp directory */
	149	d = debugfs_create_dir(name, pdentry);
009acd19	150
a2dea4cb GKH	151	debugfs_create_bool("available", S_IRUGO, d, &opp->available);
	152	debugfs_create_bool("dynamic", S_IRUGO, d, &opp->dynamic);
	153	debugfs_create_bool("turbo", S_IRUGO, d, &opp->turbo);
	154	debugfs_create_bool("suspend", S_IRUGO, d, &opp->suspend);
021dbeca	155	debugfs_create_u32("level", S_IRUGO, d, &opp->level);
a2dea4cb GKH	156	debugfs_create_ulong("clock_latency_ns", S_IRUGO, d,
a2dea4cb GKH	157	&opp->clock_latency_ns);
deaa5146	158
021dbeca VK	159	opp->of_name = of_node_full_name(opp->np);
	160	debugfs_create_str("of_name", S_IRUGO, d, (char **)&opp->of_name);
	161
2083da24	162	opp_debug_create_clks(opp, opp_table, d);
a2dea4cb	163	opp_debug_create_supplies(opp, opp_table, d);
0430b1d5	164	opp_debug_create_bw(opp, opp_table, d);
deaa5146 VK	165
deaa5146 VK	166	opp->dentry = d;
deaa5146 VK	167	}
deaa5146 VK	168
a2dea4cb GKH	169	static void opp_list_debug_create_dir(struct opp_device *opp_dev,
a2dea4cb GKH	170	struct opp_table *opp_table)
deaa5146	171	{
2c2709dc	172	const struct device *dev = opp_dev->dev;
deaa5146 VK	173	struct dentry *d;
deaa5146 VK	174
2c2709dc	175	opp_set_dev_name(dev, opp_table->dentry_name);
deaa5146 VK	176
deaa5146 VK	177	/* Create device specific directory */
2c2709dc	178	d = debugfs_create_dir(opp_table->dentry_name, rootdir);
deaa5146	179
2c2709dc VK	180	opp_dev->dentry = d;
2c2709dc VK	181	opp_table->dentry = d;
deaa5146 VK	182	}
deaa5146 VK	183
a2dea4cb GKH	184	static void opp_list_debug_create_link(struct opp_device *opp_dev,
a2dea4cb GKH	185	struct opp_table *opp_table)
deaa5146	186	{
deaa5146	187	char name[NAME_MAX];
deaa5146	188
2c2709dc	189	opp_set_dev_name(opp_dev->dev, name);
deaa5146 VK	190
deaa5146 VK	191	/* Create device specific directory link */
a2dea4cb GKH	192	opp_dev->dentry = debugfs_create_symlink(name, rootdir,
a2dea4cb GKH	193	opp_table->dentry_name);
deaa5146 VK	194	}
	195
	196	/**
	197	* opp_debug_register - add a device opp node to the debugfs 'opp' directory
2c2709dc VK	198	* @opp_dev: opp-dev pointer for device
2c2709dc VK	199	* @opp_table: the device-opp being added
deaa5146 VK	200	*
	201	* Dynamically adds device specific directory in debugfs 'opp' directory. If the
	202	* device-opp is shared with other devices, then links will be created for all
	203	* devices except the first.
deaa5146	204	*/
a2dea4cb	205	void opp_debug_register(struct opp_device opp_dev, struct opp_table opp_table)
deaa5146	206	{
2c2709dc	207	if (opp_table->dentry)
a2dea4cb GKH	208	opp_list_debug_create_link(opp_dev, opp_table);
	209	else
	210	opp_list_debug_create_dir(opp_dev, opp_table);
deaa5146 VK	211	}
deaa5146 VK	212
2c2709dc VK	213	static void opp_migrate_dentry(struct opp_device *opp_dev,
2c2709dc VK	214	struct opp_table *opp_table)
deaa5146	215	{
c14faabf	216	struct opp_device new_dev = NULL, iter;
deaa5146 VK	217	const struct device *dev;
	218	struct dentry *dentry;
	219
2c2709dc	220	/* Look for next opp-dev */
c14faabf XT	221	list_for_each_entry(iter, &opp_table->dev_list, node)
	222	if (iter != opp_dev) {
	223	new_dev = iter;
deaa5146	224	break;
c14faabf XT	225	}
	226
	227	BUG_ON(!new_dev);
deaa5146 VK	228
	229	/* new_dev is guaranteed to be valid here */
	230	dev = new_dev->dev;
	231	debugfs_remove_recursive(new_dev->dentry);
	232
2c2709dc	233	opp_set_dev_name(dev, opp_table->dentry_name);
deaa5146	234
2c2709dc VK	235	dentry = debugfs_rename(rootdir, opp_dev->dentry, rootdir,
2c2709dc VK	236	opp_table->dentry_name);
eca4c0ee	237	if (IS_ERR(dentry)) {
deaa5146	238	dev_err(dev, "%s: Failed to rename link from: %s to %s\n",
2c2709dc	239	__func__, dev_name(opp_dev->dev), dev_name(dev));
deaa5146 VK	240	return;
	241	}
	242
	243	new_dev->dentry = dentry;
2c2709dc	244	opp_table->dentry = dentry;
deaa5146 VK	245	}
	246
	247	/**
	248	* opp_debug_unregister - remove a device opp node from debugfs opp directory
2c2709dc VK	249	* @opp_dev: opp-dev pointer for device
2c2709dc VK	250	* @opp_table: the device-opp being removed
deaa5146 VK	251	*
	252	* Dynamically removes device specific directory from debugfs 'opp' directory.
	253	*/
2c2709dc VK	254	void opp_debug_unregister(struct opp_device *opp_dev,
2c2709dc VK	255	struct opp_table *opp_table)
deaa5146	256	{
2c2709dc	257	if (opp_dev->dentry == opp_table->dentry) {
deaa5146	258	/* Move the real dentry object under another device */
2c2709dc VK	259	if (!list_is_singular(&opp_table->dev_list)) {
2c2709dc VK	260	opp_migrate_dentry(opp_dev, opp_table);
deaa5146 VK	261	goto out;
deaa5146 VK	262	}
2c2709dc	263	opp_table->dentry = NULL;
deaa5146 VK	264	}
deaa5146 VK	265
2c2709dc	266	debugfs_remove_recursive(opp_dev->dentry);
deaa5146 VK	267
deaa5146 VK	268	out:
2c2709dc	269	opp_dev->dentry = NULL;
deaa5146 VK	270	}
	271
	272	static int __init opp_debug_init(void)
	273	{
	274	/* Create /sys/kernel/debug/opp directory */
	275	rootdir = debugfs_create_dir("opp", NULL);
deaa5146 VK	276
	277	return 0;
	278	}
	279	core_initcall(opp_debug_init);