[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 <linux/gpio/machine.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_get_gpio_hog() - Get a GPIO hog descriptor, names and flags for GPIO API
 * @np:		device node to get GPIO from
 * @name:	GPIO line name
 * @lflags:	gpio_lookup_flags - returned from of_find_gpio() or
 *		of_get_gpio_hog()
 * @dflags:	gpiod_flags - optional GPIO initialization flags
 *
 * Returns GPIO descriptor to use with Linux GPIO API, or one of the errno
 * value on the error condition.
 */
static struct gpio_desc *of_get_gpio_hog(struct device_node *np,
				  const char **name,
				  enum gpio_lookup_flags *lflags,
				  enum gpiod_flags *dflags)
{
	struct device_node *chip_np;
	enum of_gpio_flags xlate_flags;
	struct gpio_desc *desc;
	struct gg_data gg_data = {
		.flags = &xlate_flags,
	};
	u32 tmp;
	int i, ret;

	chip_np = np->parent;
	if (!chip_np)
		return ERR_PTR(-EINVAL);

	xlate_flags = 0;
	*lflags = 0;
	*dflags = 0;

	ret = of_property_read_u32(chip_np, "#gpio-cells", &tmp);
	if (ret)
		return ERR_PTR(ret);

	if (tmp > MAX_PHANDLE_ARGS)
		return ERR_PTR(-EINVAL);

	gg_data.gpiospec.args_count = tmp;
	gg_data.gpiospec.np = chip_np;
	for (i = 0; i < tmp; i++) {
		ret = of_property_read_u32_index(np, "gpios", i,
					   &gg_data.gpiospec.args[i]);
		if (ret)
			return ERR_PTR(ret);
	}

	gpiochip_find(&gg_data, of_gpiochip_find_and_xlate);
	if (!gg_data.out_gpio) {
		if (np->parent == np)
			return ERR_PTR(-ENXIO);
		else
			return ERR_PTR(-EINVAL);
	}

	if (xlate_flags & OF_GPIO_ACTIVE_LOW)
		*lflags |= GPIO_ACTIVE_LOW;

	if (of_property_read_bool(np, "input"))
		*dflags |= GPIOD_IN;
	else if (of_property_read_bool(np, "output-low"))
		*dflags |= GPIOD_OUT_LOW;
	else if (of_property_read_bool(np, "output-high"))
		*dflags |= GPIOD_OUT_HIGH;
	else {
		pr_warn("GPIO line %d (%s): no hogging state specified, bailing out\n",
			desc_to_gpio(gg_data.out_gpio), np->name);
		return ERR_PTR(-EINVAL);
	}

	if (name && of_property_read_string(np, "line-name", name))
		*name = np->name;

	desc = gg_data.out_gpio;

	return desc;
}

/**
 * of_gpiochip_scan_hogs - Scan gpio-controller and apply GPIO hog as requested
 * @chip:	gpio chip to act on
 *
 * This is only used by of_gpiochip_add to request/set GPIO initial
 * configuration.
 */
static void of_gpiochip_scan_hogs(struct gpio_chip *chip)
{
	struct gpio_desc *desc = NULL;
	struct device_node *np;
	const char *name;
	enum gpio_lookup_flags lflags;
	enum gpiod_flags dflags;

	for_each_child_of_node(chip->of_node, np) {
		if (!of_property_read_bool(np, "gpio-hog"))
			continue;

		desc = of_get_gpio_hog(np, &name, &lflags, &dflags);
		if (IS_ERR(desc))
			continue;

		if (gpiod_hog(desc, name, lflags, dflags))
			continue;
	}
}

/**
 * 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 retrieve 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);

	of_gpiochip_scan_hogs(chip);
}

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>
f625d460	25	#include <linux/gpio/machine.h>
863fbf49	26
1bd6b601	27	#include "gpiolib.h"
af8b6375	28
0df2c999	29	/* Private data structure for of_gpiochip_find_and_xlate */
3d0f7cf0 GL	30	struct gg_data {
	31	enum of_gpio_flags *flags;
	32	struct of_phandle_args gpiospec;
	33
af8b6375	34	struct gpio_desc *out_gpio;
3d0f7cf0 GL	35	};
	36
	37	/* Private function for resolving node pointer to gpio_chip */
	38	static int of_gpiochip_find_and_xlate(struct gpio_chip gc, void data)
	39	{
	40	struct gg_data *gg_data = data;
	41	int ret;
	42
	43	if ((gc->of_node != gg_data->gpiospec.np) \|\|
	44	(gc->of_gpio_n_cells != gg_data->gpiospec.args_count) \|\|
	45	(!gc->of_xlate))
	46	return false;
	47
	48	ret = gc->of_xlate(gc, &gg_data->gpiospec, gg_data->flags);
7b8792bb	49	if (ret < 0) {
9cf75e9e HH	50	/* We've found a gpio chip, but the translation failed.
	51	* Store translation error in out_gpio.
	52	* Return false to keep looking, as more than one gpio chip
	53	* could be registered per of-node.
7b8792bb HH	54	*/
7b8792bb HH	55	gg_data->out_gpio = ERR_PTR(ret);
9cf75e9e	56	return false;
7b8792bb	57	}
3d0f7cf0	58
ccd9726e	59	gg_data->out_gpio = gpiochip_get_desc(gc, ret);
3d0f7cf0 GL	60	return true;
	61	}
	62
863fbf49	63	/**
af8b6375	64	* of_get_named_gpiod_flags() - Get a GPIO descriptor and flags for GPIO API
863fbf49	65	* @np: device node to get GPIO from
a6b09191	66	* @propname: property name containing gpio specifier(s)
863fbf49	67	* @index: index of the GPIO
b908b53d	68	* @flags: a flags pointer to fill in
863fbf49	69	*
af8b6375	70	* Returns GPIO descriptor to use with Linux GPIO API, or one of the errno
b908b53d AV	71	* value on the error condition. If @flags is not NULL the function also fills
b908b53d AV	72	* in flags for the GPIO.
863fbf49	73	*/
af8b6375 AC	74	struct gpio_desc of_get_named_gpiod_flags(struct device_node np,
af8b6375 AC	75	const char propname, int index, enum of_gpio_flags flags)
863fbf49	76	{
4fbb0022 RS	77	/* Return -EPROBE_DEFER to support probe() functions to be called
	78	* later when the GPIO actually becomes available
	79	*/
af8b6375 AC	80	struct gg_data gg_data = {
	81	.flags = flags,
	82	.out_gpio = ERR_PTR(-EPROBE_DEFER)
	83	};
64b60e09	84	int ret;
3d0f7cf0 GL	85
	86	/* .of_xlate might decide to not fill in the flags, so clear it. */
	87	if (flags)
	88	*flags = 0;
863fbf49	89
15c9a0ac	90	ret = of_parse_phandle_with_args(np, propname, "#gpio-cells", index,
3d0f7cf0	91	&gg_data.gpiospec);
64b60e09	92	if (ret) {
85ea29ac TB	93	pr_debug("%s: can't parse '%s' property of node '%s[%d]'\n",
85ea29ac TB	94	__func__, propname, np->full_name, index);
af8b6375	95	return ERR_PTR(ret);
863fbf49 AV	96	}
863fbf49 AV	97
3d0f7cf0	98	gpiochip_find(&gg_data, of_gpiochip_find_and_xlate);
863fbf49	99
3d0f7cf0	100	of_node_put(gg_data.gpiospec.np);
85ea29ac TB	101	pr_debug("%s: parsed '%s' property of node '%s[%d]' - status (%d)\n",
85ea29ac TB	102	__func__, propname, np->full_name, index,
bea4dbee	103	PTR_ERR_OR_ZERO(gg_data.out_gpio));
3d0f7cf0	104	return gg_data.out_gpio;
863fbf49	105	}
863fbf49	106
f01d9075 AC	107	int of_get_named_gpio_flags(struct device_node np, const char list_name,
	108	int index, enum of_gpio_flags *flags)
	109	{
	110	struct gpio_desc *desc;
	111
	112	desc = of_get_named_gpiod_flags(np, list_name, index, flags);
	113
	114	if (IS_ERR(desc))
	115	return PTR_ERR(desc);
	116	else
	117	return desc_to_gpio(desc);
	118	}
	119	EXPORT_SYMBOL(of_get_named_gpio_flags);
	120
f625d460 BP	121	/**
	122	* of_get_gpio_hog() - Get a GPIO hog descriptor, names and flags for GPIO API
	123	* @np: device node to get GPIO from
	124	* @name: GPIO line name
	125	* @lflags: gpio_lookup_flags - returned from of_find_gpio() or
	126	* of_get_gpio_hog()
	127	* @dflags: gpiod_flags - optional GPIO initialization flags
	128	*
	129	* Returns GPIO descriptor to use with Linux GPIO API, or one of the errno
	130	* value on the error condition.
	131	*/
	132	static struct gpio_desc of_get_gpio_hog(struct device_node np,
	133	const char **name,
	134	enum gpio_lookup_flags *lflags,
	135	enum gpiod_flags *dflags)
	136	{
	137	struct device_node *chip_np;
	138	enum of_gpio_flags xlate_flags;
	139	struct gpio_desc *desc;
	140	struct gg_data gg_data = {
	141	.flags = &xlate_flags,
	142	};
	143	u32 tmp;
	144	int i, ret;
	145
	146	chip_np = np->parent;
	147	if (!chip_np)
	148	return ERR_PTR(-EINVAL);
	149
	150	xlate_flags = 0;
	151	*lflags = 0;
	152	*dflags = 0;
	153
	154	ret = of_property_read_u32(chip_np, "#gpio-cells", &tmp);
	155	if (ret)
	156	return ERR_PTR(ret);
	157
	158	if (tmp > MAX_PHANDLE_ARGS)
	159	return ERR_PTR(-EINVAL);
	160
	161	gg_data.gpiospec.args_count = tmp;
	162	gg_data.gpiospec.np = chip_np;
	163	for (i = 0; i < tmp; i++) {
	164	ret = of_property_read_u32_index(np, "gpios", i,
	165	&gg_data.gpiospec.args[i]);
	166	if (ret)
	167	return ERR_PTR(ret);
	168	}
	169
	170	gpiochip_find(&gg_data, of_gpiochip_find_and_xlate);
	171	if (!gg_data.out_gpio) {
	172	if (np->parent == np)
	173	return ERR_PTR(-ENXIO);
	174	else
	175	return ERR_PTR(-EINVAL);
	176	}
	177
	178	if (xlate_flags & OF_GPIO_ACTIVE_LOW)
	179	*lflags \|= GPIO_ACTIVE_LOW;
	180
	181	if (of_property_read_bool(np, "input"))
	182	*dflags \|= GPIOD_IN;
	183	else if (of_property_read_bool(np, "output-low"))
	184	*dflags \|= GPIOD_OUT_LOW;
185	else if (of_property_read_bool(np, "output-high"))
186	*dflags \|= GPIOD_OUT_HIGH;
187	else {
188	pr_warn("GPIO line %d (%s): no hogging state specified, bailing out\n",
189	desc_to_gpio(gg_data.out_gpio), np->name);
190	return ERR_PTR(-EINVAL);
191	}
192
193	if (name && of_property_read_string(np, "line-name", name))
194	*name = np->name;
195
196	desc = gg_data.out_gpio;
197
198	return desc;
199	}
200
201	/**
202	* of_gpiochip_scan_hogs - Scan gpio-controller and apply GPIO hog as requested
203	* @chip: gpio chip to act on
204	*
205	* This is only used by of_gpiochip_add to request/set GPIO initial
206	* configuration.
207	*/
208	static void of_gpiochip_scan_hogs(struct gpio_chip *chip)
209	{
210	struct gpio_desc *desc = NULL;
211	struct device_node *np;
212	const char *name;
213	enum gpio_lookup_flags lflags;
214	enum gpiod_flags dflags;
215
216	for_each_child_of_node(chip->of_node, np) {
217	if (!of_property_read_bool(np, "gpio-hog"))
218	continue;
219
220	desc = of_get_gpio_hog(np, &name, &lflags, &dflags);
221	if (IS_ERR(desc))
222	continue;
223
224	if (gpiod_hog(desc, name, lflags, dflags))
225	continue;
226	}
227	}
228
863fbf49	229	/**
b908b53d	230	* of_gpio_simple_xlate - translate gpio_spec to the GPIO number and flags
a19e3da5	231	* @gc: pointer to the gpio_chip structure
863fbf49 AV	232	* @np: device node of the GPIO chip
863fbf49 AV	233	* @gpio_spec: gpio specifier as found in the device tree
b908b53d	234	* @flags: a flags pointer to fill in
863fbf49 AV	235	*
	236	* This is simple translation function, suitable for the most 1:1 mapped
	237	* gpio chips. This function performs only one sanity check: whether gpio
	238	* is less than ngpios (that is specified in the gpio_chip).
	239	*/
15c9a0ac GL	240	int of_gpio_simple_xlate(struct gpio_chip *gc,
15c9a0ac GL	241	const struct of_phandle_args gpiospec, u32 flags)
863fbf49	242	{
b908b53d AV	243	/*
b908b53d AV	244	* We're discouraging gpio_cells < 2, since that way you'll have to
20a8a968	245	* write your own xlate function (that will have to retrieve the GPIO
b908b53d AV	246	* number and the flags from a single gpio cell -- this is possible,
	247	* but not recommended).
	248	*/
a19e3da5	249	if (gc->of_gpio_n_cells < 2) {
b908b53d AV	250	WARN_ON(1);
	251	return -EINVAL;
	252	}
	253
15c9a0ac GL	254	if (WARN_ON(gpiospec->args_count < gc->of_gpio_n_cells))
	255	return -EINVAL;
	256
6270d830	257	if (gpiospec->args[0] >= gc->ngpio)
863fbf49 AV	258	return -EINVAL;
863fbf49 AV	259
b908b53d	260	if (flags)
15c9a0ac	261	*flags = gpiospec->args[1];
b908b53d	262
15c9a0ac	263	return gpiospec->args[0];
863fbf49	264	}
3038bbdf	265	EXPORT_SYMBOL(of_gpio_simple_xlate);
863fbf49	266
863fbf49 AV	267	/**
	268	* of_mm_gpiochip_add - Add memory mapped GPIO chip (bank)
	269	* @np: device node of the GPIO chip
	270	* @mm_gc: pointer to the of_mm_gpio_chip allocated structure
	271	*
	272	* To use this function you should allocate and fill mm_gc with:
	273	*
	274	* 1) In the gpio_chip structure:
	275	* - all the callbacks
a19e3da5 AV	276	* - of_gpio_n_cells
a19e3da5 AV	277	* - of_xlate callback (optional)
863fbf49 AV	278	*
	279	* 3) In the of_mm_gpio_chip structure:
	280	* - save_regs callback (optional)
	281	*
	282	* If succeeded, this function will map bank's memory and will
	283	* do all necessary work for you. Then you'll able to use .regs
	284	* to manage GPIOs from the callbacks.
	285	*/
	286	int of_mm_gpiochip_add(struct device_node *np,
	287	struct of_mm_gpio_chip *mm_gc)
	288	{
	289	int ret = -ENOMEM;
a19e3da5	290	struct gpio_chip *gc = &mm_gc->gc;
863fbf49 AV	291
	292	gc->label = kstrdup(np->full_name, GFP_KERNEL);
	293	if (!gc->label)
	294	goto err0;
	295
	296	mm_gc->regs = of_iomap(np, 0);
	297	if (!mm_gc->regs)
	298	goto err1;
	299
21451155	300	gc->base = -1;
863fbf49	301
863fbf49 AV	302	if (mm_gc->save_regs)
	303	mm_gc->save_regs(mm_gc);
	304
a19e3da5	305	mm_gc->gc.of_node = np;
863fbf49 AV	306
	307	ret = gpiochip_add(gc);
	308	if (ret)
	309	goto err2;
	310
863fbf49 AV	311	return 0;
863fbf49 AV	312	err2:
863fbf49 AV	313	iounmap(mm_gc->regs);
	314	err1:
	315	kfree(gc->label);
	316	err0:
	317	pr_err("%s: GPIO chip registration failed with status %d\n",
	318	np->full_name, ret);
	319	return ret;
	320	}
	321	EXPORT_SYMBOL(of_mm_gpiochip_add);
594fa265	322
d621e8ba RRD	323	/**
	324	* of_mm_gpiochip_remove - Remove memory mapped GPIO chip (bank)
	325	* @mm_gc: pointer to the of_mm_gpio_chip allocated structure
	326	*/
	327	void of_mm_gpiochip_remove(struct of_mm_gpio_chip *mm_gc)
	328	{
	329	struct gpio_chip *gc = &mm_gc->gc;
	330
	331	if (!mm_gc)
	332	return;
	333
	334	gpiochip_remove(gc);
	335	iounmap(mm_gc->regs);
	336	kfree(gc->label);
	337	}
	338	EXPORT_SYMBOL(of_mm_gpiochip_remove);
	339
f23f1516	340	#ifdef CONFIG_PINCTRL
167c1af9	341	static void of_gpiochip_add_pin_range(struct gpio_chip *chip)
f23f1516 SH	342	{
f23f1516 SH	343	struct device_node *np = chip->of_node;
f23f1516	344	struct of_phandle_args pinspec;
1e63d7b9	345	struct pinctrl_dev *pctldev;
f23f1516	346	int index = 0, ret;
586a87e6 CR	347	const char *name;
	348	static const char group_names_propname[] = "gpio-ranges-group-names";
	349	struct property *group_names;
f23f1516 SH	350
	351	if (!np)
	352	return;
	353
586a87e6 CR	354	group_names = of_find_property(np, group_names_propname, NULL);
586a87e6 CR	355
ad4e1a7c	356	for (;; index++) {
d9fe0039 SW	357	ret = of_parse_phandle_with_fixed_args(np, "gpio-ranges", 3,
d9fe0039 SW	358	index, &pinspec);
f23f1516 SH	359	if (ret)
	360	break;
	361
1e63d7b9 LW	362	pctldev = of_pinctrl_get(pinspec.np);
1e63d7b9 LW	363	if (!pctldev)
f23f1516	364	break;
f23f1516	365
586a87e6 CR	366	if (pinspec.args[2]) {
	367	if (group_names) {
	368	ret = of_property_read_string_index(np,
	369	group_names_propname,
	370	index, &name);
	371	if (strlen(name)) {
	372	pr_err("%s: Group name of numeric GPIO ranges must be the empty string.\n",
	373	np->full_name);
	374	break;
	375	}
	376	}
	377	/* npins != 0: linear range */
	378	ret = gpiochip_add_pin_range(chip,
	379	pinctrl_dev_get_devname(pctldev),
	380	pinspec.args[0],
	381	pinspec.args[1],
	382	pinspec.args[2]);
	383	if (ret)
	384	break;
	385	} else {
	386	/* npins == 0: special range */
	387	if (pinspec.args[1]) {
	388	pr_err("%s: Illegal gpio-range format.\n",
	389	np->full_name);
	390	break;
	391	}
	392
	393	if (!group_names) {
	394	pr_err("%s: GPIO group range requested but no %s property.\n",
	395	np->full_name, group_names_propname);
	396	break;
	397	}
	398
	399	ret = of_property_read_string_index(np,
	400	group_names_propname,
	401	index, &name);
	402	if (ret)
	403	break;
	404
	405	if (!strlen(name)) {
	406	pr_err("%s: Group name of GPIO group range cannot be the empty string.\n",
	407	np->full_name);
	408	break;
	409	}
	410
	411	ret = gpiochip_add_pingroup_range(chip, pctldev,
	412	pinspec.args[0], name);
	413	if (ret)
	414	break;
	415	}
ad4e1a7c	416	}
f23f1516 SH	417	}
f23f1516 SH	418
f23f1516	419	#else
167c1af9	420	static void of_gpiochip_add_pin_range(struct gpio_chip *chip) {}
f23f1516 SH	421	#endif
f23f1516 SH	422
391c970c AV	423	void of_gpiochip_add(struct gpio_chip *chip)
	424	{
	425	if ((!chip->of_node) && (chip->dev))
	426	chip->of_node = chip->dev->of_node;
	427
	428	if (!chip->of_node)
	429	return;
	430
	431	if (!chip->of_xlate) {
	432	chip->of_gpio_n_cells = 2;
	433	chip->of_xlate = of_gpio_simple_xlate;
	434	}
	435
f23f1516	436	of_gpiochip_add_pin_range(chip);
391c970c	437	of_node_get(chip->of_node);
f625d460 BP	438
f625d460 BP	439	of_gpiochip_scan_hogs(chip);
391c970c AV	440	}
	441
	442	void of_gpiochip_remove(struct gpio_chip *chip)
	443	{
e93fa3f2	444	gpiochip_remove_pin_ranges(chip);
8a691550	445	of_node_put(chip->of_node);
391c970c	446	}