[deliverable/linux.git] / drivers / gpio / gpiolib-of.c

/*
 * OF helpers for the GPIO API
 *
 * Copyright (c) 2007-2008  MontaVista Software, Inc.
 *
 * Author: Anton Vorontsov <avorontsov@ru.mvista.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 */

#include <linux/device.h>
#include <linux/err.h>
#include <linux/errno.h>
#include <linux/module.h>
#include <linux/io.h>
#include <linux/gpio/consumer.h>
#include <linux/of.h>
#include <linux/of_address.h>
#include <linux/of_gpio.h>
#include <linux/pinctrl/pinctrl.h>
#include <linux/slab.h>

#include "gpiolib.h"

/* Private data structure for of_gpiochip_find_and_xlate */
struct gg_data {
	enum of_gpio_flags *flags;
	struct of_phandle_args gpiospec;

	struct gpio_desc *out_gpio;
};

/* Private function for resolving node pointer to gpio_chip */
static int of_gpiochip_find_and_xlate(struct gpio_chip *gc, void *data)
{
	struct gg_data *gg_data = data;
	int ret;

	if ((gc->of_node != gg_data->gpiospec.np) ||
	    (gc->of_gpio_n_cells != gg_data->gpiospec.args_count) ||
	    (!gc->of_xlate))
		return false;

	ret = gc->of_xlate(gc, &gg_data->gpiospec, gg_data->flags);
	if (ret < 0) {
		/* We've found a gpio chip, but the translation failed.
		 * Store translation error in out_gpio.
		 * Return false to keep looking, as more than one gpio chip
		 * could be registered per of-node.
		 */
		gg_data->out_gpio = ERR_PTR(ret);
		return false;
	 }

	gg_data->out_gpio = gpiochip_get_desc(gc, ret);
	return true;
}

/**
 * of_get_named_gpiod_flags() - Get a GPIO descriptor and flags for GPIO API
 * @np:		device node to get GPIO from
 * @propname:	property name containing gpio specifier(s)
 * @index:	index of the GPIO
 * @flags:	a flags pointer to fill in
 *
 * Returns GPIO descriptor to use with Linux GPIO API, or one of the errno
 * value on the error condition. If @flags is not NULL the function also fills
 * in flags for the GPIO.
 */
struct gpio_desc *of_get_named_gpiod_flags(struct device_node *np,
		     const char *propname, int index, enum of_gpio_flags *flags)
{
	/* Return -EPROBE_DEFER to support probe() functions to be called
	 * later when the GPIO actually becomes available
	 */
	struct gg_data gg_data = {
		.flags = flags,
		.out_gpio = ERR_PTR(-EPROBE_DEFER)
	};
	int ret;

	/* .of_xlate might decide to not fill in the flags, so clear it. */
	if (flags)
		*flags = 0;

	ret = of_parse_phandle_with_args(np, propname, "#gpio-cells", index,
					 &gg_data.gpiospec);
	if (ret) {
		pr_debug("%s: can't parse '%s' property of node '%s[%d]'\n",
			__func__, propname, np->full_name, index);
		return ERR_PTR(ret);
	}

	gpiochip_find(&gg_data, of_gpiochip_find_and_xlate);

	of_node_put(gg_data.gpiospec.np);
	pr_debug("%s: parsed '%s' property of node '%s[%d]' - status (%d)\n",
		 __func__, propname, np->full_name, index,
		 PTR_ERR_OR_ZERO(gg_data.out_gpio));
	return gg_data.out_gpio;
}

int of_get_named_gpio_flags(struct device_node *np, const char *list_name,
			    int index, enum of_gpio_flags *flags)
{
	struct gpio_desc *desc;

	desc = of_get_named_gpiod_flags(np, list_name, index, flags);

	if (IS_ERR(desc))
		return PTR_ERR(desc);
	else
		return desc_to_gpio(desc);
}
EXPORT_SYMBOL(of_get_named_gpio_flags);

/**
 * of_gpio_simple_xlate - translate gpio_spec to the GPIO number and flags
 * @gc:		pointer to the gpio_chip structure
 * @np:		device node of the GPIO chip
 * @gpio_spec:	gpio specifier as found in the device tree
 * @flags:	a flags pointer to fill in
 *
 * This is simple translation function, suitable for the most 1:1 mapped
 * gpio chips. This function performs only one sanity check: whether gpio
 * is less than ngpios (that is specified in the gpio_chip).
 */
int of_gpio_simple_xlate(struct gpio_chip *gc,
			 const struct of_phandle_args *gpiospec, u32 *flags)
{
	/*
	 * We're discouraging gpio_cells < 2, since that way you'll have to
	 * write your own xlate function (that will have to retrive the GPIO
	 * number and the flags from a single gpio cell -- this is possible,
	 * but not recommended).
	 */
	if (gc->of_gpio_n_cells < 2) {
		WARN_ON(1);
		return -EINVAL;
	}

	if (WARN_ON(gpiospec->args_count < gc->of_gpio_n_cells))
		return -EINVAL;

	if (gpiospec->args[0] >= gc->ngpio)
		return -EINVAL;

	if (flags)
		*flags = gpiospec->args[1];

	return gpiospec->args[0];
}
EXPORT_SYMBOL(of_gpio_simple_xlate);

/**
 * of_mm_gpiochip_add - Add memory mapped GPIO chip (bank)
 * @np:		device node of the GPIO chip
 * @mm_gc:	pointer to the of_mm_gpio_chip allocated structure
 *
 * To use this function you should allocate and fill mm_gc with:
 *
 * 1) In the gpio_chip structure:
 *    - all the callbacks
 *    - of_gpio_n_cells
 *    - of_xlate callback (optional)
 *
 * 3) In the of_mm_gpio_chip structure:
 *    - save_regs callback (optional)
 *
 * If succeeded, this function will map bank's memory and will
 * do all necessary work for you. Then you'll able to use .regs
 * to manage GPIOs from the callbacks.
 */
int of_mm_gpiochip_add(struct device_node *np,
		       struct of_mm_gpio_chip *mm_gc)
{
	int ret = -ENOMEM;
	struct gpio_chip *gc = &mm_gc->gc;

	gc->label = kstrdup(np->full_name, GFP_KERNEL);
	if (!gc->label)
		goto err0;

	mm_gc->regs = of_iomap(np, 0);
	if (!mm_gc->regs)
		goto err1;

	gc->base = -1;

	if (mm_gc->save_regs)
		mm_gc->save_regs(mm_gc);

	mm_gc->gc.of_node = np;

	ret = gpiochip_add(gc);
	if (ret)
		goto err2;

	return 0;
err2:
	iounmap(mm_gc->regs);
err1:
	kfree(gc->label);
err0:
	pr_err("%s: GPIO chip registration failed with status %d\n",
	       np->full_name, ret);
	return ret;
}
EXPORT_SYMBOL(of_mm_gpiochip_add);

/**
 * of_mm_gpiochip_remove - Remove memory mapped GPIO chip (bank)
 * @mm_gc:	pointer to the of_mm_gpio_chip allocated structure
 */
void of_mm_gpiochip_remove(struct of_mm_gpio_chip *mm_gc)
{
	struct gpio_chip *gc = &mm_gc->gc;

	if (!mm_gc)
		return;

	gpiochip_remove(gc);
	iounmap(mm_gc->regs);
	kfree(gc->label);
}
EXPORT_SYMBOL(of_mm_gpiochip_remove);

#ifdef CONFIG_PINCTRL
static void of_gpiochip_add_pin_range(struct gpio_chip *chip)
{
	struct device_node *np = chip->of_node;
	struct of_phandle_args pinspec;
	struct pinctrl_dev *pctldev;
	int index = 0, ret;
	const char *name;
	static const char group_names_propname[] = "gpio-ranges-group-names";
	struct property *group_names;

	if (!np)
		return;

	group_names = of_find_property(np, group_names_propname, NULL);

	for (;; index++) {
		ret = of_parse_phandle_with_fixed_args(np, "gpio-ranges", 3,
				index, &pinspec);
		if (ret)
			break;

		pctldev = of_pinctrl_get(pinspec.np);
		if (!pctldev)
			break;

		if (pinspec.args[2]) {
			if (group_names) {
				ret = of_property_read_string_index(np,
						group_names_propname,
						index, &name);
				if (strlen(name)) {
					pr_err("%s: Group name of numeric GPIO ranges must be the empty string.\n",
						np->full_name);
					break;
				}
			}
			/* npins != 0: linear range */
			ret = gpiochip_add_pin_range(chip,
					pinctrl_dev_get_devname(pctldev),
					pinspec.args[0],
					pinspec.args[1],
					pinspec.args[2]);
			if (ret)
				break;
		} else {
			/* npins == 0: special range */
			if (pinspec.args[1]) {
				pr_err("%s: Illegal gpio-range format.\n",
					np->full_name);
				break;
			}

			if (!group_names) {
				pr_err("%s: GPIO group range requested but no %s property.\n",
					np->full_name, group_names_propname);
				break;
			}

			ret = of_property_read_string_index(np,
						group_names_propname,
						index, &name);
			if (ret)
				break;

			if (!strlen(name)) {
				pr_err("%s: Group name of GPIO group range cannot be the empty string.\n",
				np->full_name);
				break;
			}

			ret = gpiochip_add_pingroup_range(chip, pctldev,
						pinspec.args[0], name);
			if (ret)
				break;
		}
	}
}

#else
static void of_gpiochip_add_pin_range(struct gpio_chip *chip) {}
#endif

void of_gpiochip_add(struct gpio_chip *chip)
{
	if ((!chip->of_node) && (chip->dev))
		chip->of_node = chip->dev->of_node;

	if (!chip->of_node)
		return;

	if (!chip->of_xlate) {
		chip->of_gpio_n_cells = 2;
		chip->of_xlate = of_gpio_simple_xlate;
	}

	of_gpiochip_add_pin_range(chip);
	of_node_get(chip->of_node);
}

void of_gpiochip_remove(struct gpio_chip *chip)
{
	gpiochip_remove_pin_ranges(chip);
	of_node_put(chip->of_node);
}
Commit	Line	Data
863fbf49 AV	1	/*
	2	* OF helpers for the GPIO API
	3	*
	4	* Copyright (c) 2007-2008 MontaVista Software, Inc.
	5	*
	6	* Author: Anton Vorontsov <avorontsov@ru.mvista.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 as published by
	10	* the Free Software Foundation; either version 2 of the License, or
	11	* (at your option) any later version.
	12	*/
	13
2e13cba8	14	#include <linux/device.h>
bea4dbee	15	#include <linux/err.h>
863fbf49	16	#include <linux/errno.h>
2e13cba8	17	#include <linux/module.h>
863fbf49	18	#include <linux/io.h>
af8b6375	19	#include <linux/gpio/consumer.h>
863fbf49	20	#include <linux/of.h>
2e13cba8	21	#include <linux/of_address.h>
863fbf49	22	#include <linux/of_gpio.h>
f23f1516	23	#include <linux/pinctrl/pinctrl.h>
2e13cba8	24	#include <linux/slab.h>
863fbf49	25
1bd6b601	26	#include "gpiolib.h"
af8b6375	27
0df2c999	28	/* Private data structure for of_gpiochip_find_and_xlate */
3d0f7cf0 GL	29	struct gg_data {
	30	enum of_gpio_flags *flags;
	31	struct of_phandle_args gpiospec;
	32
af8b6375	33	struct gpio_desc *out_gpio;
3d0f7cf0 GL	34	};
	35
	36	/* Private function for resolving node pointer to gpio_chip */
	37	static int of_gpiochip_find_and_xlate(struct gpio_chip gc, void data)
	38	{
	39	struct gg_data *gg_data = data;
	40	int ret;
	41
	42	if ((gc->of_node != gg_data->gpiospec.np) \|\|
	43	(gc->of_gpio_n_cells != gg_data->gpiospec.args_count) \|\|
	44	(!gc->of_xlate))
	45	return false;
	46
	47	ret = gc->of_xlate(gc, &gg_data->gpiospec, gg_data->flags);
7b8792bb	48	if (ret < 0) {
9cf75e9e HH	49	/* We've found a gpio chip, but the translation failed.
	50	* Store translation error in out_gpio.
	51	* Return false to keep looking, as more than one gpio chip
	52	* could be registered per of-node.
7b8792bb HH	53	*/
7b8792bb HH	54	gg_data->out_gpio = ERR_PTR(ret);
9cf75e9e	55	return false;
7b8792bb	56	}
3d0f7cf0	57
ccd9726e	58	gg_data->out_gpio = gpiochip_get_desc(gc, ret);
3d0f7cf0 GL	59	return true;
	60	}
	61
863fbf49	62	/**
af8b6375	63	* of_get_named_gpiod_flags() - Get a GPIO descriptor and flags for GPIO API
863fbf49	64	* @np: device node to get GPIO from
a6b09191	65	* @propname: property name containing gpio specifier(s)
863fbf49	66	* @index: index of the GPIO
b908b53d	67	* @flags: a flags pointer to fill in
863fbf49	68	*
af8b6375	69	* Returns GPIO descriptor to use with Linux GPIO API, or one of the errno
b908b53d AV	70	* value on the error condition. If @flags is not NULL the function also fills
b908b53d AV	71	* in flags for the GPIO.
863fbf49	72	*/
af8b6375 AC	73	struct gpio_desc of_get_named_gpiod_flags(struct device_node np,
af8b6375 AC	74	const char propname, int index, enum of_gpio_flags flags)
863fbf49	75	{
4fbb0022 RS	76	/* Return -EPROBE_DEFER to support probe() functions to be called
	77	* later when the GPIO actually becomes available
	78	*/
af8b6375 AC	79	struct gg_data gg_data = {
	80	.flags = flags,
	81	.out_gpio = ERR_PTR(-EPROBE_DEFER)
	82	};
64b60e09	83	int ret;
3d0f7cf0 GL	84
	85	/* .of_xlate might decide to not fill in the flags, so clear it. */
	86	if (flags)
	87	*flags = 0;
863fbf49	88
15c9a0ac	89	ret = of_parse_phandle_with_args(np, propname, "#gpio-cells", index,
3d0f7cf0	90	&gg_data.gpiospec);
64b60e09	91	if (ret) {
85ea29ac TB	92	pr_debug("%s: can't parse '%s' property of node '%s[%d]'\n",
85ea29ac TB	93	__func__, propname, np->full_name, index);
af8b6375	94	return ERR_PTR(ret);
863fbf49 AV	95	}
863fbf49 AV	96
3d0f7cf0	97	gpiochip_find(&gg_data, of_gpiochip_find_and_xlate);
863fbf49	98
3d0f7cf0	99	of_node_put(gg_data.gpiospec.np);
85ea29ac TB	100	pr_debug("%s: parsed '%s' property of node '%s[%d]' - status (%d)\n",
85ea29ac TB	101	__func__, propname, np->full_name, index,
bea4dbee	102	PTR_ERR_OR_ZERO(gg_data.out_gpio));
3d0f7cf0	103	return gg_data.out_gpio;
863fbf49	104	}
863fbf49	105
f01d9075 AC	106	int of_get_named_gpio_flags(struct device_node np, const char list_name,
	107	int index, enum of_gpio_flags *flags)
	108	{
	109	struct gpio_desc *desc;
	110
	111	desc = of_get_named_gpiod_flags(np, list_name, index, flags);
	112
	113	if (IS_ERR(desc))
	114	return PTR_ERR(desc);
	115	else
	116	return desc_to_gpio(desc);
	117	}
	118	EXPORT_SYMBOL(of_get_named_gpio_flags);
	119
863fbf49	120	/**
b908b53d	121	* of_gpio_simple_xlate - translate gpio_spec to the GPIO number and flags
a19e3da5	122	* @gc: pointer to the gpio_chip structure
863fbf49 AV	123	* @np: device node of the GPIO chip
863fbf49 AV	124	* @gpio_spec: gpio specifier as found in the device tree
b908b53d	125	* @flags: a flags pointer to fill in
863fbf49 AV	126	*
	127	* This is simple translation function, suitable for the most 1:1 mapped
	128	* gpio chips. This function performs only one sanity check: whether gpio
	129	* is less than ngpios (that is specified in the gpio_chip).
	130	*/
15c9a0ac GL	131	int of_gpio_simple_xlate(struct gpio_chip *gc,
15c9a0ac GL	132	const struct of_phandle_args gpiospec, u32 flags)
863fbf49	133	{
b908b53d AV	134	/*
	135	* We're discouraging gpio_cells < 2, since that way you'll have to
	136	* write your own xlate function (that will have to retrive the GPIO
	137	* number and the flags from a single gpio cell -- this is possible,
	138	* but not recommended).
	139	*/
a19e3da5	140	if (gc->of_gpio_n_cells < 2) {
b908b53d AV	141	WARN_ON(1);
	142	return -EINVAL;
	143	}
	144
15c9a0ac GL	145	if (WARN_ON(gpiospec->args_count < gc->of_gpio_n_cells))
	146	return -EINVAL;
	147
6270d830	148	if (gpiospec->args[0] >= gc->ngpio)
863fbf49 AV	149	return -EINVAL;
863fbf49 AV	150
b908b53d	151	if (flags)
15c9a0ac	152	*flags = gpiospec->args[1];
b908b53d	153
15c9a0ac	154	return gpiospec->args[0];
863fbf49	155	}
3038bbdf	156	EXPORT_SYMBOL(of_gpio_simple_xlate);
863fbf49	157
863fbf49 AV	158	/**
	159	* of_mm_gpiochip_add - Add memory mapped GPIO chip (bank)
	160	* @np: device node of the GPIO chip
	161	* @mm_gc: pointer to the of_mm_gpio_chip allocated structure
	162	*
	163	* To use this function you should allocate and fill mm_gc with:
	164	*
	165	* 1) In the gpio_chip structure:
	166	* - all the callbacks
a19e3da5 AV	167	* - of_gpio_n_cells
a19e3da5 AV	168	* - of_xlate callback (optional)
863fbf49 AV	169	*
	170	* 3) In the of_mm_gpio_chip structure:
	171	* - save_regs callback (optional)
	172	*
	173	* If succeeded, this function will map bank's memory and will
	174	* do all necessary work for you. Then you'll able to use .regs
	175	* to manage GPIOs from the callbacks.
	176	*/
	177	int of_mm_gpiochip_add(struct device_node *np,
	178	struct of_mm_gpio_chip *mm_gc)
	179	{
	180	int ret = -ENOMEM;
a19e3da5	181	struct gpio_chip *gc = &mm_gc->gc;
863fbf49 AV	182
	183	gc->label = kstrdup(np->full_name, GFP_KERNEL);
	184	if (!gc->label)
	185	goto err0;
	186
	187	mm_gc->regs = of_iomap(np, 0);
	188	if (!mm_gc->regs)
	189	goto err1;
	190
21451155	191	gc->base = -1;
863fbf49	192
863fbf49 AV	193	if (mm_gc->save_regs)
	194	mm_gc->save_regs(mm_gc);
	195
a19e3da5	196	mm_gc->gc.of_node = np;
863fbf49 AV	197
	198	ret = gpiochip_add(gc);
	199	if (ret)
	200	goto err2;
	201
863fbf49 AV	202	return 0;
863fbf49 AV	203	err2:
863fbf49 AV	204	iounmap(mm_gc->regs);
	205	err1:
	206	kfree(gc->label);
	207	err0:
	208	pr_err("%s: GPIO chip registration failed with status %d\n",
	209	np->full_name, ret);
	210	return ret;
	211	}
	212	EXPORT_SYMBOL(of_mm_gpiochip_add);
594fa265	213
d621e8ba RRD	214	/**
	215	* of_mm_gpiochip_remove - Remove memory mapped GPIO chip (bank)
	216	* @mm_gc: pointer to the of_mm_gpio_chip allocated structure
	217	*/
	218	void of_mm_gpiochip_remove(struct of_mm_gpio_chip *mm_gc)
	219	{
	220	struct gpio_chip *gc = &mm_gc->gc;
	221
	222	if (!mm_gc)
	223	return;
	224
	225	gpiochip_remove(gc);
	226	iounmap(mm_gc->regs);
	227	kfree(gc->label);
	228	}
	229	EXPORT_SYMBOL(of_mm_gpiochip_remove);
	230
f23f1516	231	#ifdef CONFIG_PINCTRL
167c1af9	232	static void of_gpiochip_add_pin_range(struct gpio_chip *chip)
f23f1516 SH	233	{
f23f1516 SH	234	struct device_node *np = chip->of_node;
f23f1516	235	struct of_phandle_args pinspec;
1e63d7b9	236	struct pinctrl_dev *pctldev;
f23f1516	237	int index = 0, ret;
586a87e6 CR	238	const char *name;
	239	static const char group_names_propname[] = "gpio-ranges-group-names";
	240	struct property *group_names;
f23f1516 SH	241
	242	if (!np)
	243	return;
	244
586a87e6 CR	245	group_names = of_find_property(np, group_names_propname, NULL);
586a87e6 CR	246
ad4e1a7c	247	for (;; index++) {
d9fe0039 SW	248	ret = of_parse_phandle_with_fixed_args(np, "gpio-ranges", 3,
d9fe0039 SW	249	index, &pinspec);
f23f1516 SH	250	if (ret)
	251	break;
	252
1e63d7b9 LW	253	pctldev = of_pinctrl_get(pinspec.np);
1e63d7b9 LW	254	if (!pctldev)
f23f1516	255	break;
f23f1516	256
586a87e6 CR	257	if (pinspec.args[2]) {
	258	if (group_names) {
	259	ret = of_property_read_string_index(np,
	260	group_names_propname,
	261	index, &name);
	262	if (strlen(name)) {
	263	pr_err("%s: Group name of numeric GPIO ranges must be the empty string.\n",
	264	np->full_name);
	265	break;
	266	}
	267	}
	268	/* npins != 0: linear range */
	269	ret = gpiochip_add_pin_range(chip,
	270	pinctrl_dev_get_devname(pctldev),
	271	pinspec.args[0],
	272	pinspec.args[1],
	273	pinspec.args[2]);
	274	if (ret)
	275	break;
	276	} else {
	277	/* npins == 0: special range */
	278	if (pinspec.args[1]) {
	279	pr_err("%s: Illegal gpio-range format.\n",
	280	np->full_name);
	281	break;
	282	}
	283
	284	if (!group_names) {
	285	pr_err("%s: GPIO group range requested but no %s property.\n",
	286	np->full_name, group_names_propname);
	287	break;
	288	}
	289
	290	ret = of_property_read_string_index(np,
	291	group_names_propname,
	292	index, &name);
	293	if (ret)
	294	break;
	295
	296	if (!strlen(name)) {
	297	pr_err("%s: Group name of GPIO group range cannot be the empty string.\n",
	298	np->full_name);
	299	break;
	300	}
	301
	302	ret = gpiochip_add_pingroup_range(chip, pctldev,
	303	pinspec.args[0], name);
	304	if (ret)
	305	break;
	306	}
ad4e1a7c	307	}
f23f1516 SH	308	}
f23f1516 SH	309
f23f1516	310	#else
167c1af9	311	static void of_gpiochip_add_pin_range(struct gpio_chip *chip) {}
f23f1516 SH	312	#endif
f23f1516 SH	313
391c970c AV	314	void of_gpiochip_add(struct gpio_chip *chip)
	315	{
	316	if ((!chip->of_node) && (chip->dev))
	317	chip->of_node = chip->dev->of_node;
	318
	319	if (!chip->of_node)
	320	return;
	321
	322	if (!chip->of_xlate) {
	323	chip->of_gpio_n_cells = 2;
	324	chip->of_xlate = of_gpio_simple_xlate;
	325	}
	326
f23f1516	327	of_gpiochip_add_pin_range(chip);
391c970c AV	328	of_node_get(chip->of_node);
	329	}
	330
	331	void of_gpiochip_remove(struct gpio_chip *chip)
	332	{
e93fa3f2	333	gpiochip_remove_pin_ranges(chip);
8a691550	334	of_node_put(chip->of_node);
391c970c	335	}