[deliverable/linux.git] / drivers / base / regmap / regmap-debugfs.c

/*
 * Register map access API - debugfs
 *
 * Copyright 2011 Wolfson Microelectronics plc
 *
 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
 *
 * 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.
 */

#include <linux/slab.h>
#include <linux/mutex.h>
#include <linux/debugfs.h>
#include <linux/uaccess.h>
#include <linux/device.h>

#include "internal.h"

static struct dentry *regmap_debugfs_root;

/* Calculate the length of a fixed format  */
static size_t regmap_calc_reg_len(int max_val, char *buf, size_t buf_size)
{
	snprintf(buf, buf_size, "%x", max_val);
	return strlen(buf);
}

static ssize_t regmap_name_read_file(struct file *file,
				     char __user *user_buf, size_t count,
				     loff_t *ppos)
{
	struct regmap *map = file->private_data;
	int ret;
	char *buf;

	buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
	if (!buf)
		return -ENOMEM;

	ret = snprintf(buf, PAGE_SIZE, "%s\n", map->dev->driver->name);
	if (ret < 0) {
		kfree(buf);
		return ret;
	}

	ret = simple_read_from_buffer(user_buf, count, ppos, buf, ret);
	kfree(buf);
	return ret;
}

static const struct file_operations regmap_name_fops = {
	.open = simple_open,
	.read = regmap_name_read_file,
	.llseek = default_llseek,
};

static ssize_t regmap_map_read_file(struct file *file, char __user *user_buf,
				    size_t count, loff_t *ppos)
{
	int reg_len, val_len, tot_len;
	size_t buf_pos = 0;
	loff_t p = 0;
	ssize_t ret;
	int i;
	struct regmap *map = file->private_data;
	char *buf;
	unsigned int val;

	if (*ppos < 0 || !count)
		return -EINVAL;

	buf = kmalloc(count, GFP_KERNEL);
	if (!buf)
		return -ENOMEM;

	/* Calculate the length of a fixed format  */
	reg_len = regmap_calc_reg_len(map->max_register, buf, count);
	val_len = 2 * map->format.val_bytes;
	tot_len = reg_len + val_len + 3;      /* : \n */

	for (i = 0; i < map->max_register + 1; i++) {
		if (!regmap_readable(map, i))
			continue;

		if (regmap_precious(map, i))
			continue;

		/* If we're in the region the user is trying to read */
		if (p >= *ppos) {
			/* ...but not beyond it */
			if (buf_pos >= count - 1 - tot_len)
				break;

			/* Format the register */
			snprintf(buf + buf_pos, count - buf_pos, "%.*x: ",
				 reg_len, i);
			buf_pos += reg_len + 2;

			/* Format the value, write all X if we can't read */
			ret = regmap_read(map, i, &val);
			if (ret == 0)
				snprintf(buf + buf_pos, count - buf_pos,
					 "%.*x", val_len, val);
			else
				memset(buf + buf_pos, 'X', val_len);
			buf_pos += 2 * map->format.val_bytes;

			buf[buf_pos++] = '\n';
		}
		p += tot_len;
	}

	ret = buf_pos;

	if (copy_to_user(user_buf, buf, buf_pos)) {
		ret = -EFAULT;
		goto out;
	}

	*ppos += buf_pos;

out:
	kfree(buf);
	return ret;
}

#undef REGMAP_ALLOW_WRITE_DEBUGFS
#ifdef REGMAP_ALLOW_WRITE_DEBUGFS
/*
 * This can be dangerous especially when we have clients such as
 * PMICs, therefore don't provide any real compile time configuration option
 * for this feature, people who want to use this will need to modify
 * the source code directly.
 */
static ssize_t regmap_map_write_file(struct file *file,
				     const char __user *user_buf,
				     size_t count, loff_t *ppos)
{
	char buf[32];
	size_t buf_size;
	char *start = buf;
	unsigned long reg, value;
	struct regmap *map = file->private_data;

	buf_size = min(count, (sizeof(buf)-1));
	if (copy_from_user(buf, user_buf, buf_size))
		return -EFAULT;
	buf[buf_size] = 0;

	while (*start == ' ')
		start++;
	reg = simple_strtoul(start, &start, 16);
	while (*start == ' ')
		start++;
	if (strict_strtoul(start, 16, &value))
		return -EINVAL;

	/* Userspace has been fiddling around behind the kernel's back */
	add_taint(TAINT_USER);

	regmap_write(map, reg, value);
	return buf_size;
}
#else
#define regmap_map_write_file NULL
#endif

static const struct file_operations regmap_map_fops = {
	.open = simple_open,
	.read = regmap_map_read_file,
	.write = regmap_map_write_file,
	.llseek = default_llseek,
};

static ssize_t regmap_access_read_file(struct file *file,
				       char __user *user_buf, size_t count,
				       loff_t *ppos)
{
	int reg_len, tot_len;
	size_t buf_pos = 0;
	loff_t p = 0;
	ssize_t ret;
	int i;
	struct regmap *map = file->private_data;
	char *buf;

	if (*ppos < 0 || !count)
		return -EINVAL;

	buf = kmalloc(count, GFP_KERNEL);
	if (!buf)
		return -ENOMEM;

	/* Calculate the length of a fixed format  */
	reg_len = regmap_calc_reg_len(map->max_register, buf, count);
	tot_len = reg_len + 10; /* ': R W V P\n' */

	for (i = 0; i < map->max_register + 1; i++) {
		/* Ignore registers which are neither readable nor writable */
		if (!regmap_readable(map, i) && !regmap_writeable(map, i))
			continue;

		/* If we're in the region the user is trying to read */
		if (p >= *ppos) {
			/* ...but not beyond it */
			if (buf_pos >= count - 1 - tot_len)
				break;

			/* Format the register */
			snprintf(buf + buf_pos, count - buf_pos,
				 "%.*x: %c %c %c %c\n",
				 reg_len, i,
				 regmap_readable(map, i) ? 'y' : 'n',
				 regmap_writeable(map, i) ? 'y' : 'n',
				 regmap_volatile(map, i) ? 'y' : 'n',
				 regmap_precious(map, i) ? 'y' : 'n');

			buf_pos += tot_len;
		}
		p += tot_len;
	}

	ret = buf_pos;

	if (copy_to_user(user_buf, buf, buf_pos)) {
		ret = -EFAULT;
		goto out;
	}

	*ppos += buf_pos;

out:
	kfree(buf);
	return ret;
}

static const struct file_operations regmap_access_fops = {
	.open = simple_open,
	.read = regmap_access_read_file,
	.llseek = default_llseek,
};

void regmap_debugfs_init(struct regmap *map)
{
	map->debugfs = debugfs_create_dir(dev_name(map->dev),
					  regmap_debugfs_root);
	if (!map->debugfs) {
		dev_warn(map->dev, "Failed to create debugfs directory\n");
		return;
	}

	debugfs_create_file("name", 0400, map->debugfs,
			    map, &regmap_name_fops);

	if (map->max_register) {
		debugfs_create_file("registers", 0400, map->debugfs,
				    map, &regmap_map_fops);
		debugfs_create_file("access", 0400, map->debugfs,
				    map, &regmap_access_fops);
	}

	if (map->cache_type) {
		debugfs_create_bool("cache_only", 0400, map->debugfs,
				    &map->cache_only);
		debugfs_create_bool("cache_dirty", 0400, map->debugfs,
				    &map->cache_dirty);
		debugfs_create_bool("cache_bypass", 0400, map->debugfs,
				    &map->cache_bypass);
	}
}

void regmap_debugfs_exit(struct regmap *map)
{
	debugfs_remove_recursive(map->debugfs);
}

void regmap_debugfs_initcall(void)
{
	regmap_debugfs_root = debugfs_create_dir("regmap", NULL);
	if (!regmap_debugfs_root) {
		pr_warn("regmap: Failed to create debugfs root\n");
		return;
	}
}
Commit	Line	Data
31244e39 MB	1	/*
	2	* Register map access API - debugfs
	3	*
	4	* Copyright 2011 Wolfson Microelectronics plc
	5	*
	6	* Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License version 2 as
	10	* published by the Free Software Foundation.
	11	*/
	12
	13	#include <linux/slab.h>
31244e39 MB	14	#include <linux/mutex.h>
	15	#include <linux/debugfs.h>
	16	#include <linux/uaccess.h>
51990e82	17	#include <linux/device.h>
31244e39 MB	18
	19	#include "internal.h"
	20
	21	static struct dentry *regmap_debugfs_root;
	22
21f55544 MB	23	/* Calculate the length of a fixed format */
	24	static size_t regmap_calc_reg_len(int max_val, char *buf, size_t buf_size)
	25	{
	26	snprintf(buf, buf_size, "%x", max_val);
	27	return strlen(buf);
	28	}
	29
f0c2319f DP	30	static ssize_t regmap_name_read_file(struct file *file,
	31	char __user *user_buf, size_t count,
	32	loff_t *ppos)
	33	{
	34	struct regmap *map = file->private_data;
	35	int ret;
	36	char *buf;
	37
	38	buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
	39	if (!buf)
	40	return -ENOMEM;
	41
	42	ret = snprintf(buf, PAGE_SIZE, "%s\n", map->dev->driver->name);
	43	if (ret < 0) {
	44	kfree(buf);
	45	return ret;
	46	}
	47
	48	ret = simple_read_from_buffer(user_buf, count, ppos, buf, ret);
	49	kfree(buf);
	50	return ret;
	51	}
	52
	53	static const struct file_operations regmap_name_fops = {
234e3405	54	.open = simple_open,
f0c2319f DP	55	.read = regmap_name_read_file,
	56	.llseek = default_llseek,
	57	};
	58
31244e39 MB	59	static ssize_t regmap_map_read_file(struct file file, char __user user_buf,
	60	size_t count, loff_t *ppos)
	61	{
cb3c2dcf	62	int reg_len, val_len, tot_len;
31244e39 MB	63	size_t buf_pos = 0;
	64	loff_t p = 0;
	65	ssize_t ret;
	66	int i;
	67	struct regmap *map = file->private_data;
	68	char *buf;
	69	unsigned int val;
	70
	71	if (*ppos < 0 \|\| !count)
	72	return -EINVAL;
	73
	74	buf = kmalloc(count, GFP_KERNEL);
	75	if (!buf)
	76	return -ENOMEM;
	77
	78	/* Calculate the length of a fixed format */
21f55544	79	reg_len = regmap_calc_reg_len(map->max_register, buf, count);
31244e39 MB	80	val_len = 2 * map->format.val_bytes;
	81	tot_len = reg_len + val_len + 3; /* : \n */
	82
d813ae9a	83	for (i = 0; i < map->max_register + 1; i++) {
8de2f081	84	if (!regmap_readable(map, i))
31244e39 MB	85	continue;
31244e39 MB	86
8de2f081	87	if (regmap_precious(map, i))
2efe1642 MB	88	continue;
2efe1642 MB	89
31244e39 MB	90	/* If we're in the region the user is trying to read */
	91	if (p >= *ppos) {
	92	/* ...but not beyond it */
	93	if (buf_pos >= count - 1 - tot_len)
	94	break;
	95
	96	/* Format the register */
	97	snprintf(buf + buf_pos, count - buf_pos, "%.*x: ",
	98	reg_len, i);
	99	buf_pos += reg_len + 2;
	100
	101	/* Format the value, write all X if we can't read */
	102	ret = regmap_read(map, i, &val);
	103	if (ret == 0)
	104	snprintf(buf + buf_pos, count - buf_pos,
	105	"%.*x", val_len, val);
	106	else
	107	memset(buf + buf_pos, 'X', val_len);
	108	buf_pos += 2 * map->format.val_bytes;
	109
	110	buf[buf_pos++] = '\n';
	111	}
	112	p += tot_len;
	113	}
	114
	115	ret = buf_pos;
	116
	117	if (copy_to_user(user_buf, buf, buf_pos)) {
	118	ret = -EFAULT;
	119	goto out;
	120	}
	121
	122	*ppos += buf_pos;
	123
	124	out:
	125	kfree(buf);
	126	return ret;
	127	}
	128
09c6ecd3 DP	129	#undef REGMAP_ALLOW_WRITE_DEBUGFS
	130	#ifdef REGMAP_ALLOW_WRITE_DEBUGFS
	131	/*
	132	* This can be dangerous especially when we have clients such as
	133	* PMICs, therefore don't provide any real compile time configuration option
	134	* for this feature, people who want to use this will need to modify
	135	* the source code directly.
	136	*/
	137	static ssize_t regmap_map_write_file(struct file *file,
	138	const char __user *user_buf,
	139	size_t count, loff_t *ppos)
	140	{
	141	char buf[32];
	142	size_t buf_size;
	143	char *start = buf;
	144	unsigned long reg, value;
	145	struct regmap *map = file->private_data;
	146
	147	buf_size = min(count, (sizeof(buf)-1));
	148	if (copy_from_user(buf, user_buf, buf_size))
	149	return -EFAULT;
	150	buf[buf_size] = 0;
	151
	152	while (*start == ' ')
	153	start++;
	154	reg = simple_strtoul(start, &start, 16);
	155	while (*start == ' ')
	156	start++;
	157	if (strict_strtoul(start, 16, &value))
	158	return -EINVAL;
	159
	160	/* Userspace has been fiddling around behind the kernel's back */
	161	add_taint(TAINT_USER);
	162
	163	regmap_write(map, reg, value);
	164	return buf_size;
	165	}
	166	#else
	167	#define regmap_map_write_file NULL
	168	#endif
	169
31244e39	170	static const struct file_operations regmap_map_fops = {
234e3405	171	.open = simple_open,
31244e39	172	.read = regmap_map_read_file,
09c6ecd3	173	.write = regmap_map_write_file,
31244e39 MB	174	.llseek = default_llseek,
	175	};
	176
449e3842 MB	177	static ssize_t regmap_access_read_file(struct file *file,
	178	char __user *user_buf, size_t count,
	179	loff_t *ppos)
	180	{
	181	int reg_len, tot_len;
	182	size_t buf_pos = 0;
	183	loff_t p = 0;
	184	ssize_t ret;
	185	int i;
	186	struct regmap *map = file->private_data;
	187	char *buf;
	188
	189	if (*ppos < 0 \|\| !count)
	190	return -EINVAL;
	191
	192	buf = kmalloc(count, GFP_KERNEL);
	193	if (!buf)
	194	return -ENOMEM;
	195
	196	/* Calculate the length of a fixed format */
	197	reg_len = regmap_calc_reg_len(map->max_register, buf, count);
	198	tot_len = reg_len + 10; /* ': R W V P\n' */
	199
d813ae9a	200	for (i = 0; i < map->max_register + 1; i++) {
449e3842 MB	201	/* Ignore registers which are neither readable nor writable */
	202	if (!regmap_readable(map, i) && !regmap_writeable(map, i))
	203	continue;
	204
	205	/* If we're in the region the user is trying to read */
	206	if (p >= *ppos) {
	207	/* ...but not beyond it */
	208	if (buf_pos >= count - 1 - tot_len)
	209	break;
	210
	211	/* Format the register */
	212	snprintf(buf + buf_pos, count - buf_pos,
	213	"%.*x: %c %c %c %c\n",
	214	reg_len, i,
	215	regmap_readable(map, i) ? 'y' : 'n',
	216	regmap_writeable(map, i) ? 'y' : 'n',
	217	regmap_volatile(map, i) ? 'y' : 'n',
	218	regmap_precious(map, i) ? 'y' : 'n');
	219
	220	buf_pos += tot_len;
	221	}
	222	p += tot_len;
	223	}
	224
	225	ret = buf_pos;
	226
	227	if (copy_to_user(user_buf, buf, buf_pos)) {
	228	ret = -EFAULT;
	229	goto out;
	230	}
	231
	232	*ppos += buf_pos;
	233
	234	out:
	235	kfree(buf);
	236	return ret;
	237	}
	238
	239	static const struct file_operations regmap_access_fops = {
234e3405	240	.open = simple_open,
449e3842 MB	241	.read = regmap_access_read_file,
	242	.llseek = default_llseek,
	243	};
31244e39 MB	244
	245	void regmap_debugfs_init(struct regmap *map)
	246	{
	247	map->debugfs = debugfs_create_dir(dev_name(map->dev),
	248	regmap_debugfs_root);
	249	if (!map->debugfs) {
	250	dev_warn(map->dev, "Failed to create debugfs directory\n");
	251	return;
	252	}
	253
f0c2319f DP	254	debugfs_create_file("name", 0400, map->debugfs,
	255	map, &regmap_name_fops);
	256
449e3842	257	if (map->max_register) {
31244e39 MB	258	debugfs_create_file("registers", 0400, map->debugfs,
31244e39 MB	259	map, &regmap_map_fops);
449e3842 MB	260	debugfs_create_file("access", 0400, map->debugfs,
	261	map, &regmap_access_fops);
	262	}
028a01e6 MB	263
	264	if (map->cache_type) {
	265	debugfs_create_bool("cache_only", 0400, map->debugfs,
	266	&map->cache_only);
	267	debugfs_create_bool("cache_dirty", 0400, map->debugfs,
	268	&map->cache_dirty);
	269	debugfs_create_bool("cache_bypass", 0400, map->debugfs,
	270	&map->cache_bypass);
	271	}
31244e39 MB	272	}
	273
	274	void regmap_debugfs_exit(struct regmap *map)
	275	{
	276	debugfs_remove_recursive(map->debugfs);
	277	}
	278
	279	void regmap_debugfs_initcall(void)
	280	{
	281	regmap_debugfs_root = debugfs_create_dir("regmap", NULL);
	282	if (!regmap_debugfs_root) {
	283	pr_warn("regmap: Failed to create debugfs root\n");
	284	return;
	285	}
	286	}