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

/*
 * Generic OPP debugfs interface
 *
 * Copyright (C) 2015-2016 Viresh Kumar <viresh.kumar@linaro.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <linux/debugfs.h>
#include <linux/device.h>
#include <linux/err.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 bool 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);

		if (!d)
			return false;

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

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

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

		if (!debugfs_create_ulong("u_amp", S_IRUGO, d,
					  &opp->supplies[i].u_amp))
			return false;
	}

	return true;
}

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

	/* Rate is unique to each OPP, use it to give opp-name */
	snprintf(name, sizeof(name), "opp:%lu", opp->rate);

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

	if (!debugfs_create_bool("available", S_IRUGO, d, &opp->available))
		return -ENOMEM;

	if (!debugfs_create_bool("dynamic", S_IRUGO, d, &opp->dynamic))
		return -ENOMEM;

	if (!debugfs_create_bool("turbo", S_IRUGO, d, &opp->turbo))
		return -ENOMEM;

	if (!debugfs_create_bool("suspend", S_IRUGO, d, &opp->suspend))
		return -ENOMEM;

	if (!debugfs_create_ulong("rate_hz", S_IRUGO, d, &opp->rate))
		return -ENOMEM;

	if (!opp_debug_create_supplies(opp, opp_table, d))
		return -ENOMEM;

	if (!debugfs_create_ulong("clock_latency_ns", S_IRUGO, d,
				  &opp->clock_latency_ns))
		return -ENOMEM;

	opp->dentry = d;
	return 0;
}

static int 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);
	if (!d) {
		dev_err(dev, "%s: Failed to create debugfs dir\n", __func__);
		return -ENOMEM;
	}

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

	return 0;
}

static int opp_list_debug_create_link(struct opp_device *opp_dev,
				      struct opp_table *opp_table)
{
	const struct device *dev = opp_dev->dev;
	char name[NAME_MAX];
	struct dentry *d;

	opp_set_dev_name(opp_dev->dev, name);

	/* Create device specific directory link */
	d = debugfs_create_symlink(name, rootdir, opp_table->dentry_name);
	if (!d) {
		dev_err(dev, "%s: Failed to create link\n", __func__);
		return -ENOMEM;
	}

	opp_dev->dentry = d;

	return 0;
}

/**
 * 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.
 *
 * Return: 0 on success, otherwise negative error.
 */
int opp_debug_register(struct opp_device *opp_dev, struct opp_table *opp_table)
{
	if (!rootdir) {
		pr_debug("%s: Uninitialized rootdir\n", __func__);
		return -EINVAL;
	}

	if (opp_table->dentry)
		return opp_list_debug_create_link(opp_dev, opp_table);

	return 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;
	const struct device *dev;
	struct dentry *dentry;

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

	/* 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 (!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);
	if (!rootdir) {
		pr_err("%s: Failed to create root directory\n", __func__);
		return -ENOMEM;
	}

	return 0;
}
core_initcall(opp_debug_init);
Commit	Line	Data
deaa5146 VK	1	/*
	2	* Generic OPP debugfs interface
	3	*
	4	* Copyright (C) 2015-2016 Viresh Kumar <viresh.kumar@linaro.org>
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License version 2 as
	8	* published by the Free Software Foundation.
	9	*/
	10
	11	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
	12
	13	#include <linux/debugfs.h>
	14	#include <linux/device.h>
	15	#include <linux/err.h>
	16	#include <linux/init.h>
	17	#include <linux/limits.h>
dfbe4678	18	#include <linux/slab.h>
deaa5146 VK	19
	20	#include "opp.h"
	21
	22	static struct dentry *rootdir;
	23
	24	static void opp_set_dev_name(const struct device dev, char name)
	25	{
	26	if (dev->parent)
	27	snprintf(name, NAME_MAX, "%s-%s", dev_name(dev->parent),
	28	dev_name(dev));
	29	else
	30	snprintf(name, NAME_MAX, "%s", dev_name(dev));
	31	}
	32
	33	void opp_debug_remove_one(struct dev_pm_opp *opp)
	34	{
	35	debugfs_remove_recursive(opp->dentry);
	36	}
	37
dfbe4678 VK	38	static bool opp_debug_create_supplies(struct dev_pm_opp *opp,
	39	struct opp_table *opp_table,
	40	struct dentry *pdentry)
	41	{
	42	struct dentry *d;
1fae788e	43	int i;
dfbe4678	44
1fae788e	45	for (i = 0; i < opp_table->regulator_count; i++) {
d741029a AY	46	char name[15];
	47
	48	snprintf(name, sizeof(name), "supply-%d", i);
dfbe4678 VK	49
	50	/* Create per-opp directory */
	51	d = debugfs_create_dir(name, pdentry);
	52
dfbe4678 VK	53	if (!d)
	54	return false;
	55
	56	if (!debugfs_create_ulong("u_volt_target", S_IRUGO, d,
	57	&opp->supplies[i].u_volt))
	58	return false;
	59
	60	if (!debugfs_create_ulong("u_volt_min", S_IRUGO, d,
	61	&opp->supplies[i].u_volt_min))
	62	return false;
	63
	64	if (!debugfs_create_ulong("u_volt_max", S_IRUGO, d,
	65	&opp->supplies[i].u_volt_max))
	66	return false;
	67
	68	if (!debugfs_create_ulong("u_amp", S_IRUGO, d,
	69	&opp->supplies[i].u_amp))
	70	return false;
1fae788e	71	}
dfbe4678 VK	72
	73	return true;
	74	}
	75
2c2709dc	76	int opp_debug_create_one(struct dev_pm_opp opp, struct opp_table opp_table)
deaa5146	77	{
2c2709dc	78	struct dentry *pdentry = opp_table->dentry;
deaa5146 VK	79	struct dentry *d;
	80	char name[25]; /* 20 chars for 64 bit value + 5 (opp:\0) */
	81
	82	/* Rate is unique to each OPP, use it to give opp-name */
	83	snprintf(name, sizeof(name), "opp:%lu", opp->rate);
	84
	85	/* Create per-opp directory */
	86	d = debugfs_create_dir(name, pdentry);
	87	if (!d)
	88	return -ENOMEM;
	89
	90	if (!debugfs_create_bool("available", S_IRUGO, d, &opp->available))
	91	return -ENOMEM;
	92
	93	if (!debugfs_create_bool("dynamic", S_IRUGO, d, &opp->dynamic))
	94	return -ENOMEM;
	95
	96	if (!debugfs_create_bool("turbo", S_IRUGO, d, &opp->turbo))
	97	return -ENOMEM;
	98
	99	if (!debugfs_create_bool("suspend", S_IRUGO, d, &opp->suspend))
	100	return -ENOMEM;
	101
	102	if (!debugfs_create_ulong("rate_hz", S_IRUGO, d, &opp->rate))
	103	return -ENOMEM;
	104
dfbe4678	105	if (!opp_debug_create_supplies(opp, opp_table, d))
deaa5146 VK	106	return -ENOMEM;
	107
	108	if (!debugfs_create_ulong("clock_latency_ns", S_IRUGO, d,
	109	&opp->clock_latency_ns))
	110	return -ENOMEM;
	111
	112	opp->dentry = d;
	113	return 0;
	114	}
	115
2c2709dc VK	116	static int opp_list_debug_create_dir(struct opp_device *opp_dev,
2c2709dc VK	117	struct opp_table *opp_table)
deaa5146	118	{
2c2709dc	119	const struct device *dev = opp_dev->dev;
deaa5146 VK	120	struct dentry *d;
deaa5146 VK	121
2c2709dc	122	opp_set_dev_name(dev, opp_table->dentry_name);
deaa5146 VK	123
deaa5146 VK	124	/* Create device specific directory */
2c2709dc	125	d = debugfs_create_dir(opp_table->dentry_name, rootdir);
deaa5146 VK	126	if (!d) {
	127	dev_err(dev, "%s: Failed to create debugfs dir\n", __func__);
	128	return -ENOMEM;
	129	}
	130
2c2709dc VK	131	opp_dev->dentry = d;
2c2709dc VK	132	opp_table->dentry = d;
deaa5146 VK	133
	134	return 0;
	135	}
	136
2c2709dc VK	137	static int opp_list_debug_create_link(struct opp_device *opp_dev,
2c2709dc VK	138	struct opp_table *opp_table)
deaa5146	139	{
2c2709dc	140	const struct device *dev = opp_dev->dev;
deaa5146 VK	141	char name[NAME_MAX];
	142	struct dentry *d;
	143
2c2709dc	144	opp_set_dev_name(opp_dev->dev, name);
deaa5146 VK	145
deaa5146 VK	146	/* Create device specific directory link */
2c2709dc	147	d = debugfs_create_symlink(name, rootdir, opp_table->dentry_name);
deaa5146 VK	148	if (!d) {
	149	dev_err(dev, "%s: Failed to create link\n", __func__);
	150	return -ENOMEM;
	151	}
	152
2c2709dc	153	opp_dev->dentry = d;
deaa5146 VK	154
	155	return 0;
	156	}
	157
	158	/**
	159	* opp_debug_register - add a device opp node to the debugfs 'opp' directory
2c2709dc VK	160	* @opp_dev: opp-dev pointer for device
2c2709dc VK	161	* @opp_table: the device-opp being added
deaa5146 VK	162	*
	163	* Dynamically adds device specific directory in debugfs 'opp' directory. If the
	164	* device-opp is shared with other devices, then links will be created for all
	165	* devices except the first.
	166	*
	167	* Return: 0 on success, otherwise negative error.
	168	*/
2c2709dc	169	int opp_debug_register(struct opp_device opp_dev, struct opp_table opp_table)
deaa5146 VK	170	{
	171	if (!rootdir) {
	172	pr_debug("%s: Uninitialized rootdir\n", __func__);
	173	return -EINVAL;
	174	}
	175
2c2709dc VK	176	if (opp_table->dentry)
2c2709dc VK	177	return opp_list_debug_create_link(opp_dev, opp_table);
deaa5146	178
2c2709dc	179	return opp_list_debug_create_dir(opp_dev, opp_table);
deaa5146 VK	180	}
deaa5146 VK	181
2c2709dc VK	182	static void opp_migrate_dentry(struct opp_device *opp_dev,
2c2709dc VK	183	struct opp_table *opp_table)
deaa5146	184	{
2c2709dc	185	struct opp_device *new_dev;
deaa5146 VK	186	const struct device *dev;
	187	struct dentry *dentry;
	188
2c2709dc VK	189	/* Look for next opp-dev */
	190	list_for_each_entry(new_dev, &opp_table->dev_list, node)
	191	if (new_dev != opp_dev)
deaa5146 VK	192	break;
	193
	194	/* new_dev is guaranteed to be valid here */
	195	dev = new_dev->dev;
	196	debugfs_remove_recursive(new_dev->dentry);
	197
2c2709dc	198	opp_set_dev_name(dev, opp_table->dentry_name);
deaa5146	199
2c2709dc VK	200	dentry = debugfs_rename(rootdir, opp_dev->dentry, rootdir,
2c2709dc VK	201	opp_table->dentry_name);
deaa5146 VK	202	if (!dentry) {
deaa5146 VK	203	dev_err(dev, "%s: Failed to rename link from: %s to %s\n",
2c2709dc	204	__func__, dev_name(opp_dev->dev), dev_name(dev));
deaa5146 VK	205	return;
	206	}
	207
	208	new_dev->dentry = dentry;
2c2709dc	209	opp_table->dentry = dentry;
deaa5146 VK	210	}
	211
	212	/**
	213	* opp_debug_unregister - remove a device opp node from debugfs opp directory
2c2709dc VK	214	* @opp_dev: opp-dev pointer for device
2c2709dc VK	215	* @opp_table: the device-opp being removed
deaa5146 VK	216	*
	217	* Dynamically removes device specific directory from debugfs 'opp' directory.
	218	*/
2c2709dc VK	219	void opp_debug_unregister(struct opp_device *opp_dev,
2c2709dc VK	220	struct opp_table *opp_table)
deaa5146	221	{
2c2709dc	222	if (opp_dev->dentry == opp_table->dentry) {
deaa5146	223	/* Move the real dentry object under another device */
2c2709dc VK	224	if (!list_is_singular(&opp_table->dev_list)) {
2c2709dc VK	225	opp_migrate_dentry(opp_dev, opp_table);
deaa5146 VK	226	goto out;
deaa5146 VK	227	}
2c2709dc	228	opp_table->dentry = NULL;
deaa5146 VK	229	}
deaa5146 VK	230
2c2709dc	231	debugfs_remove_recursive(opp_dev->dentry);
deaa5146 VK	232
deaa5146 VK	233	out:
2c2709dc	234	opp_dev->dentry = NULL;
deaa5146 VK	235	}
	236
	237	static int __init opp_debug_init(void)
	238	{
	239	/* Create /sys/kernel/debug/opp directory */
	240	rootdir = debugfs_create_dir("opp", NULL);
	241	if (!rootdir) {
	242	pr_err("%s: Failed to create root directory\n", __func__);
	243	return -ENOMEM;
	244	}
	245
	246	return 0;
	247	}
	248	core_initcall(opp_debug_init);