[linux-2.6-block.git] / drivers / pinctrl / pinconf.c

/*
 * Core driver for the pin config portions of the pin control subsystem
 *
 * Copyright (C) 2011 ST-Ericsson SA
 * Written on behalf of Linaro for ST-Ericsson
 *
 * Author: Linus Walleij <linus.walleij@linaro.org>
 *
 * License terms: GNU General Public License (GPL) version 2
 */
#define pr_fmt(fmt) "pinconfig core: " fmt

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/device.h>
#include <linux/slab.h>
#include <linux/debugfs.h>
#include <linux/seq_file.h>
#include <linux/pinctrl/machine.h>
#include <linux/pinctrl/pinctrl.h>
#include <linux/pinctrl/pinconf.h>
#include "core.h"
#include "pinconf.h"

int pin_config_get_for_pin(struct pinctrl_dev *pctldev, unsigned pin,
			   unsigned long *config)
{
	const struct pinconf_ops *ops = pctldev->desc->confops;

	if (!ops || !ops->pin_config_get) {
		dev_err(pctldev->dev, "cannot get pin configuration, missing "
			"pin_config_get() function in driver\n");
		return -EINVAL;
	}

	return ops->pin_config_get(pctldev, pin, config);
}

/**
 * pin_config_get() - get the configuration of a single pin parameter
 * @dev_name: name of the pin controller device for this pin
 * @name: name of the pin to get the config for
 * @config: the config pointed to by this argument will be filled in with the
 *	current pin state, it can be used directly by drivers as a numeral, or
 *	it can be dereferenced to any struct.
 */
int pin_config_get(const char *dev_name, const char *name,
			  unsigned long *config)
{
	struct pinctrl_dev *pctldev;
	int pin;

	pctldev = get_pinctrl_dev_from_dev(NULL, dev_name);
	if (!pctldev)
		return -EINVAL;

	pin = pin_get_from_name(pctldev, name);
	if (pin < 0)
		return pin;

	return pin_config_get_for_pin(pctldev, pin, config);
}
EXPORT_SYMBOL(pin_config_get);

int pin_config_set_for_pin(struct pinctrl_dev *pctldev, unsigned pin,
			   unsigned long config)
{
	const struct pinconf_ops *ops = pctldev->desc->confops;
	int ret;

	if (!ops || !ops->pin_config_set) {
		dev_err(pctldev->dev, "cannot configure pin, missing "
			"config function in driver\n");
		return -EINVAL;
	}

	ret = ops->pin_config_set(pctldev, pin, config);
	if (ret) {
		dev_err(pctldev->dev,
			"unable to set pin configuration on pin %d\n", pin);
		return ret;
	}

	return 0;
}

/**
 * pin_config_set() - set the configuration of a single pin parameter
 * @dev_name: name of pin controller device for this pin
 * @name: name of the pin to set the config for
 * @config: the config in this argument will contain the desired pin state, it
 *	can be used directly by drivers as a numeral, or it can be dereferenced
 *	to any struct.
 */
int pin_config_set(const char *dev_name, const char *name,
		   unsigned long config)
{
	struct pinctrl_dev *pctldev;
	int pin;

	pctldev = get_pinctrl_dev_from_dev(NULL, dev_name);
	if (!pctldev)
		return -EINVAL;

	pin = pin_get_from_name(pctldev, name);
	if (pin < 0)
		return pin;

	return pin_config_set_for_pin(pctldev, pin, config);
}
EXPORT_SYMBOL(pin_config_set);

int pin_config_group_get(const char *dev_name, const char *pin_group,
			 unsigned long *config)
{
	struct pinctrl_dev *pctldev;
	const struct pinconf_ops *ops;
	int selector;

	pctldev = get_pinctrl_dev_from_dev(NULL, dev_name);
	if (!pctldev)
		return -EINVAL;
	ops = pctldev->desc->confops;

	if (!ops || !ops->pin_config_group_get) {
		dev_err(pctldev->dev, "cannot get configuration for pin "
			"group, missing group config get function in "
			"driver\n");
		return -EINVAL;
	}

	selector = pinctrl_get_group_selector(pctldev, pin_group);
	if (selector < 0)
		return selector;

	return ops->pin_config_group_get(pctldev, selector, config);
}
EXPORT_SYMBOL(pin_config_group_get);


int pin_config_group_set(const char *dev_name, const char *pin_group,
			 unsigned long config)
{
	struct pinctrl_dev *pctldev;
	const struct pinconf_ops *ops;
	const struct pinctrl_ops *pctlops;
	int selector;
	const unsigned *pins;
	unsigned num_pins;
	int ret;
	int i;

	pctldev = get_pinctrl_dev_from_dev(NULL, dev_name);
	if (!pctldev)
		return -EINVAL;
	ops = pctldev->desc->confops;
	pctlops = pctldev->desc->pctlops;

	if (!ops || (!ops->pin_config_group_set && !ops->pin_config_set)) {
		dev_err(pctldev->dev, "cannot configure pin group, missing "
			"config function in driver\n");
		return -EINVAL;
	}

	selector = pinctrl_get_group_selector(pctldev, pin_group);
	if (selector < 0)
		return selector;

	ret = pctlops->get_group_pins(pctldev, selector, &pins, &num_pins);
	if (ret) {
		dev_err(pctldev->dev, "cannot configure pin group, error "
			"getting pins\n");
		return ret;
	}

	/*
	 * If the pin controller supports handling entire groups we use that
	 * capability.
	 */
	if (ops->pin_config_group_set) {
		ret = ops->pin_config_group_set(pctldev, selector, config);
		/*
		 * If the pin controller prefer that a certain group be handled
		 * pin-by-pin as well, it returns -EAGAIN.
		 */
		if (ret != -EAGAIN)
			return ret;
	}

	/*
	 * If the controller cannot handle entire groups, we configure each pin
	 * individually.
	 */
	if (!ops->pin_config_set)
		return 0;

	for (i = 0; i < num_pins; i++) {
		ret = ops->pin_config_set(pctldev, pins[i], config);
		if (ret < 0)
			return ret;
	}

	return 0;
}
EXPORT_SYMBOL(pin_config_group_set);

int pinconf_check_ops(struct pinctrl_dev *pctldev)
{
	const struct pinconf_ops *ops = pctldev->desc->confops;

	/* We must be able to read out pin status */
	if (!ops->pin_config_get && !ops->pin_config_group_get)
		return -EINVAL;
	/* We have to be able to config the pins in SOME way */
	if (!ops->pin_config_set && !ops->pin_config_group_set)
		return -EINVAL;
	return 0;
}

#ifdef CONFIG_DEBUG_FS

static void pinconf_dump_pin(struct pinctrl_dev *pctldev,
			     struct seq_file *s, int pin)
{
	const struct pinconf_ops *ops = pctldev->desc->confops;

	if (ops && ops->pin_config_dbg_show)
		ops->pin_config_dbg_show(pctldev, s, pin);
}

static int pinconf_pins_show(struct seq_file *s, void *what)
{
	struct pinctrl_dev *pctldev = s->private;
	unsigned i, pin;

	seq_puts(s, "Pin config settings per pin\n");
	seq_puts(s, "Format: pin (name): pinmux setting array\n");

	/* The pin number can be retrived from the pin controller descriptor */
	for (i = 0; i < pctldev->desc->npins; i++) {
		struct pin_desc *desc;

		pin = pctldev->desc->pins[i].number;
		desc = pin_desc_get(pctldev, pin);
		/* Skip if we cannot search the pin */
		if (desc == NULL)
			continue;

		seq_printf(s, "pin %d (%s):", pin,
			   desc->name ? desc->name : "unnamed");

		pinconf_dump_pin(pctldev, s, pin);

		seq_printf(s, "\n");
	}

	return 0;
}

static void pinconf_dump_group(struct pinctrl_dev *pctldev,
			       struct seq_file *s, unsigned selector,
			       const char *gname)
{
	const struct pinconf_ops *ops = pctldev->desc->confops;

	if (ops && ops->pin_config_group_dbg_show)
		ops->pin_config_group_dbg_show(pctldev, s, selector);
}

static int pinconf_groups_show(struct seq_file *s, void *what)
{
	struct pinctrl_dev *pctldev = s->private;
	const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
	const struct pinconf_ops *ops = pctldev->desc->confops;
	unsigned selector = 0;

	if (!ops || !ops->pin_config_group_get)
		return 0;

	seq_puts(s, "Pin config settings per pin group\n");
	seq_puts(s, "Format: group (name): pinmux setting array\n");

	while (pctlops->list_groups(pctldev, selector) >= 0) {
		const char *gname = pctlops->get_group_name(pctldev, selector);

		seq_printf(s, "%u (%s):", selector, gname);
		pinconf_dump_group(pctldev, s, selector, gname);
		selector++;
	}

	return 0;
}

static int pinconf_pins_open(struct inode *inode, struct file *file)
{
	return single_open(file, pinconf_pins_show, inode->i_private);
}

static int pinconf_groups_open(struct inode *inode, struct file *file)
{
	return single_open(file, pinconf_groups_show, inode->i_private);
}

static const struct file_operations pinconf_pins_ops = {
	.open		= pinconf_pins_open,
	.read		= seq_read,
	.llseek		= seq_lseek,
	.release	= single_release,
};

static const struct file_operations pinconf_groups_ops = {
	.open		= pinconf_groups_open,
	.read		= seq_read,
	.llseek		= seq_lseek,
	.release	= single_release,
};

void pinconf_init_device_debugfs(struct dentry *devroot,
			 struct pinctrl_dev *pctldev)
{
	debugfs_create_file("pinconf-pins", S_IFREG | S_IRUGO,
			    devroot, pctldev, &pinconf_pins_ops);
	debugfs_create_file("pinconf-groups", S_IFREG | S_IRUGO,
			    devroot, pctldev, &pinconf_groups_ops);
}

#endif
Commit	Line	Data
ae6b4d85 LW	1	/*
	2	* Core driver for the pin config portions of the pin control subsystem
	3	*
	4	* Copyright (C) 2011 ST-Ericsson SA
	5	* Written on behalf of Linaro for ST-Ericsson
	6	*
	7	* Author: Linus Walleij <linus.walleij@linaro.org>
	8	*
	9	* License terms: GNU General Public License (GPL) version 2
	10	*/
	11	#define pr_fmt(fmt) "pinconfig core: " fmt
	12
	13	#include <linux/kernel.h>
	14	#include <linux/module.h>
	15	#include <linux/init.h>
	16	#include <linux/device.h>
	17	#include <linux/slab.h>
	18	#include <linux/debugfs.h>
	19	#include <linux/seq_file.h>
	20	#include <linux/pinctrl/machine.h>
	21	#include <linux/pinctrl/pinctrl.h>
	22	#include <linux/pinctrl/pinconf.h>
	23	#include "core.h"
	24	#include "pinconf.h"
	25
	26	int pin_config_get_for_pin(struct pinctrl_dev *pctldev, unsigned pin,
	27	unsigned long *config)
	28	{
	29	const struct pinconf_ops *ops = pctldev->desc->confops;
	30
	31	if (!ops \|\| !ops->pin_config_get) {
51cd24ee	32	dev_err(pctldev->dev, "cannot get pin configuration, missing "
ae6b4d85 LW	33	"pin_config_get() function in driver\n");
	34	return -EINVAL;
	35	}
	36
	37	return ops->pin_config_get(pctldev, pin, config);
	38	}
	39
	40	/**
	41	* pin_config_get() - get the configuration of a single pin parameter
43699dea	42	* @dev_name: name of the pin controller device for this pin
ae6b4d85 LW	43	* @name: name of the pin to get the config for
	44	* @config: the config pointed to by this argument will be filled in with the
	45	* current pin state, it can be used directly by drivers as a numeral, or
	46	* it can be dereferenced to any struct.
	47	*/
43699dea	48	int pin_config_get(const char dev_name, const char name,
ae6b4d85 LW	49	unsigned long *config)
ae6b4d85 LW	50	{
43699dea	51	struct pinctrl_dev *pctldev;
ae6b4d85 LW	52	int pin;
ae6b4d85 LW	53
43699dea SW	54	pctldev = get_pinctrl_dev_from_dev(NULL, dev_name);
	55	if (!pctldev)
	56	return -EINVAL;
	57
ae6b4d85 LW	58	pin = pin_get_from_name(pctldev, name);
	59	if (pin < 0)
	60	return pin;
	61
	62	return pin_config_get_for_pin(pctldev, pin, config);
	63	}
	64	EXPORT_SYMBOL(pin_config_get);
	65
	66	int pin_config_set_for_pin(struct pinctrl_dev *pctldev, unsigned pin,
	67	unsigned long config)
	68	{
	69	const struct pinconf_ops *ops = pctldev->desc->confops;
	70	int ret;
	71
	72	if (!ops \|\| !ops->pin_config_set) {
51cd24ee	73	dev_err(pctldev->dev, "cannot configure pin, missing "
ae6b4d85 LW	74	"config function in driver\n");
	75	return -EINVAL;
	76	}
	77
	78	ret = ops->pin_config_set(pctldev, pin, config);
	79	if (ret) {
51cd24ee	80	dev_err(pctldev->dev,
ae6b4d85 LW	81	"unable to set pin configuration on pin %d\n", pin);
	82	return ret;
	83	}
	84
	85	return 0;
	86	}
	87
	88	/**
	89	* pin_config_set() - set the configuration of a single pin parameter
43699dea	90	* @dev_name: name of pin controller device for this pin
ae6b4d85 LW	91	* @name: name of the pin to set the config for
	92	* @config: the config in this argument will contain the desired pin state, it
	93	* can be used directly by drivers as a numeral, or it can be dereferenced
	94	* to any struct.
	95	*/
43699dea	96	int pin_config_set(const char dev_name, const char name,
ae6b4d85 LW	97	unsigned long config)
ae6b4d85 LW	98	{
43699dea	99	struct pinctrl_dev *pctldev;
ae6b4d85 LW	100	int pin;
ae6b4d85 LW	101
43699dea SW	102	pctldev = get_pinctrl_dev_from_dev(NULL, dev_name);
	103	if (!pctldev)
	104	return -EINVAL;
	105
ae6b4d85 LW	106	pin = pin_get_from_name(pctldev, name);
	107	if (pin < 0)
	108	return pin;
	109
	110	return pin_config_set_for_pin(pctldev, pin, config);
	111	}
	112	EXPORT_SYMBOL(pin_config_set);
	113
43699dea	114	int pin_config_group_get(const char dev_name, const char pin_group,
ae6b4d85 LW	115	unsigned long *config)
ae6b4d85 LW	116	{
43699dea SW	117	struct pinctrl_dev *pctldev;
43699dea SW	118	const struct pinconf_ops *ops;
ae6b4d85 LW	119	int selector;
ae6b4d85 LW	120
43699dea SW	121	pctldev = get_pinctrl_dev_from_dev(NULL, dev_name);
	122	if (!pctldev)
	123	return -EINVAL;
	124	ops = pctldev->desc->confops;
	125
ae6b4d85	126	if (!ops \|\| !ops->pin_config_group_get) {
51cd24ee	127	dev_err(pctldev->dev, "cannot get configuration for pin "
ae6b4d85 LW	128	"group, missing group config get function in "
	129	"driver\n");
	130	return -EINVAL;
	131	}
	132
	133	selector = pinctrl_get_group_selector(pctldev, pin_group);
	134	if (selector < 0)
	135	return selector;
	136
	137	return ops->pin_config_group_get(pctldev, selector, config);
	138	}
	139	EXPORT_SYMBOL(pin_config_group_get);
	140
	141
43699dea	142	int pin_config_group_set(const char dev_name, const char pin_group,
ae6b4d85 LW	143	unsigned long config)
ae6b4d85 LW	144	{
43699dea SW	145	struct pinctrl_dev *pctldev;
	146	const struct pinconf_ops *ops;
	147	const struct pinctrl_ops *pctlops;
ae6b4d85 LW	148	int selector;
	149	const unsigned *pins;
	150	unsigned num_pins;
	151	int ret;
	152	int i;
	153
43699dea SW	154	pctldev = get_pinctrl_dev_from_dev(NULL, dev_name);
	155	if (!pctldev)
	156	return -EINVAL;
	157	ops = pctldev->desc->confops;
	158	pctlops = pctldev->desc->pctlops;
	159
ae6b4d85	160	if (!ops \|\| (!ops->pin_config_group_set && !ops->pin_config_set)) {
51cd24ee	161	dev_err(pctldev->dev, "cannot configure pin group, missing "
ae6b4d85 LW	162	"config function in driver\n");
	163	return -EINVAL;
	164	}
	165
	166	selector = pinctrl_get_group_selector(pctldev, pin_group);
	167	if (selector < 0)
	168	return selector;
	169
	170	ret = pctlops->get_group_pins(pctldev, selector, &pins, &num_pins);
	171	if (ret) {
51cd24ee	172	dev_err(pctldev->dev, "cannot configure pin group, error "
ae6b4d85 LW	173	"getting pins\n");
	174	return ret;
	175	}
	176
	177	/*
	178	* If the pin controller supports handling entire groups we use that
	179	* capability.
	180	*/
	181	if (ops->pin_config_group_set) {
	182	ret = ops->pin_config_group_set(pctldev, selector, config);
	183	/*
	184	* If the pin controller prefer that a certain group be handled
	185	* pin-by-pin as well, it returns -EAGAIN.
	186	*/
	187	if (ret != -EAGAIN)
	188	return ret;
	189	}
	190
	191	/*
	192	* If the controller cannot handle entire groups, we configure each pin
	193	* individually.
	194	*/
	195	if (!ops->pin_config_set)
	196	return 0;
	197
	198	for (i = 0; i < num_pins; i++) {
	199	ret = ops->pin_config_set(pctldev, pins[i], config);
	200	if (ret < 0)
	201	return ret;
	202	}
	203
	204	return 0;
	205	}
	206	EXPORT_SYMBOL(pin_config_group_set);
	207
b9130b77	208	int pinconf_check_ops(struct pinctrl_dev *pctldev)
ae6b4d85	209	{
b9130b77 TL	210	const struct pinconf_ops *ops = pctldev->desc->confops;
b9130b77 TL	211
ae6b4d85 LW	212	/* We must be able to read out pin status */
	213	if (!ops->pin_config_get && !ops->pin_config_group_get)
	214	return -EINVAL;
	215	/* We have to be able to config the pins in SOME way */
	216	if (!ops->pin_config_set && !ops->pin_config_group_set)
	217	return -EINVAL;
	218	return 0;
	219	}
	220
	221	#ifdef CONFIG_DEBUG_FS
	222
	223	static void pinconf_dump_pin(struct pinctrl_dev *pctldev,
	224	struct seq_file *s, int pin)
	225	{
	226	const struct pinconf_ops *ops = pctldev->desc->confops;
	227
	228	if (ops && ops->pin_config_dbg_show)
	229	ops->pin_config_dbg_show(pctldev, s, pin);
	230	}
	231
	232	static int pinconf_pins_show(struct seq_file s, void what)
	233	{
	234	struct pinctrl_dev *pctldev = s->private;
706e8520	235	unsigned i, pin;
ae6b4d85 LW	236
	237	seq_puts(s, "Pin config settings per pin\n");
	238	seq_puts(s, "Format: pin (name): pinmux setting array\n");
	239
706e8520	240	/* The pin number can be retrived from the pin controller descriptor */
546edd83	241	for (i = 0; i < pctldev->desc->npins; i++) {
ae6b4d85 LW	242	struct pin_desc *desc;
ae6b4d85 LW	243
706e8520	244	pin = pctldev->desc->pins[i].number;
ae6b4d85	245	desc = pin_desc_get(pctldev, pin);
706e8520	246	/* Skip if we cannot search the pin */
ae6b4d85 LW	247	if (desc == NULL)
	248	continue;
	249
	250	seq_printf(s, "pin %d (%s):", pin,
	251	desc->name ? desc->name : "unnamed");
	252
	253	pinconf_dump_pin(pctldev, s, pin);
	254
	255	seq_printf(s, "\n");
	256	}
	257
	258	return 0;
	259	}
	260
	261	static void pinconf_dump_group(struct pinctrl_dev *pctldev,
	262	struct seq_file *s, unsigned selector,
	263	const char *gname)
	264	{
	265	const struct pinconf_ops *ops = pctldev->desc->confops;
	266
	267	if (ops && ops->pin_config_group_dbg_show)
	268	ops->pin_config_group_dbg_show(pctldev, s, selector);
	269	}
	270
	271	static int pinconf_groups_show(struct seq_file s, void what)
	272	{
	273	struct pinctrl_dev *pctldev = s->private;
	274	const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
	275	const struct pinconf_ops *ops = pctldev->desc->confops;
	276	unsigned selector = 0;
	277
	278	if (!ops \|\| !ops->pin_config_group_get)
	279	return 0;
	280
	281	seq_puts(s, "Pin config settings per pin group\n");
	282	seq_puts(s, "Format: group (name): pinmux setting array\n");
	283
	284	while (pctlops->list_groups(pctldev, selector) >= 0) {
	285	const char *gname = pctlops->get_group_name(pctldev, selector);
	286
	287	seq_printf(s, "%u (%s):", selector, gname);
	288	pinconf_dump_group(pctldev, s, selector, gname);
	289	selector++;
	290	}
	291
	292	return 0;
	293	}
	294
	295	static int pinconf_pins_open(struct inode inode, struct file file)
	296	{
	297	return single_open(file, pinconf_pins_show, inode->i_private);
	298	}
	299
	300	static int pinconf_groups_open(struct inode inode, struct file file)
	301	{
	302	return single_open(file, pinconf_groups_show, inode->i_private);
	303	}
	304
	305	static const struct file_operations pinconf_pins_ops = {
	306	.open = pinconf_pins_open,
	307	.read = seq_read,
	308	.llseek = seq_lseek,
	309	.release = single_release,
	310	};
311
312	static const struct file_operations pinconf_groups_ops = {
313	.open = pinconf_groups_open,
314	.read = seq_read,
315	.llseek = seq_lseek,
316	.release = single_release,
317	};
318
319	void pinconf_init_device_debugfs(struct dentry *devroot,
320	struct pinctrl_dev *pctldev)
321	{
322	debugfs_create_file("pinconf-pins", S_IFREG \| S_IRUGO,
323	devroot, pctldev, &pinconf_pins_ops);
324	debugfs_create_file("pinconf-groups", S_IFREG \| S_IRUGO,
325	devroot, pctldev, &pinconf_groups_ops);
326	}
327
328	#endif