[linux-2.6-block.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"

static int of_gpiochip_match_node_and_xlate(struct gpio_chip *chip, void *data)
{
	struct of_phandle_args *gpiospec = data;

	return chip->gpiodev->dev.of_node == gpiospec->np &&
				chip->of_xlate(chip, gpiospec, NULL) >= 0;
}

static struct gpio_chip *of_find_gpiochip_by_xlate(
					struct of_phandle_args *gpiospec)
{
	return gpiochip_find(gpiospec, of_gpiochip_match_node_and_xlate);
}

static struct gpio_desc *of_xlate_and_get_gpiod_flags(struct gpio_chip *chip,
					struct of_phandle_args *gpiospec,
					enum of_gpio_flags *flags)
{
	int ret;

	if (chip->of_gpio_n_cells != gpiospec->args_count)
		return ERR_PTR(-EINVAL);

	ret = chip->of_xlate(chip, gpiospec, flags);
	if (ret < 0)
		return ERR_PTR(ret);

	return gpiochip_get_desc(chip, ret);
}

/**
 * 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)
{
	struct of_phandle_args gpiospec;
	struct gpio_chip *chip;
	struct gpio_desc *desc;
	int ret;

	ret = of_parse_phandle_with_args(np, propname, "#gpio-cells", index,
					 &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);
	}

	chip = of_find_gpiochip_by_xlate(&gpiospec);
	if (!chip) {
		desc = ERR_PTR(-EPROBE_DEFER);
		goto out;
	}

	desc = of_xlate_and_get_gpiod_flags(chip, &gpiospec, flags);
	if (IS_ERR(desc))
		goto out;

	pr_debug("%s: parsed '%s' property of node '%s[%d]' - status (%d)\n",
		 __func__, propname, np->full_name, index,
		 PTR_ERR_OR_ZERO(desc));

out:
	of_node_put(gpiospec.np);

	return desc;
}

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);

struct gpio_desc *of_find_gpio(struct device *dev, const char *con_id,
			       unsigned int idx,
			       enum gpio_lookup_flags *flags)
{
	char prop_name[32]; /* 32 is max size of property name */
	enum of_gpio_flags of_flags;
	struct gpio_desc *desc;
	unsigned int i;

	for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
		if (con_id)
			snprintf(prop_name, sizeof(prop_name), "%s-%s", con_id,
				 gpio_suffixes[i]);
		else
			snprintf(prop_name, sizeof(prop_name), "%s",
				 gpio_suffixes[i]);

		desc = of_get_named_gpiod_flags(dev->of_node, prop_name, idx,
						&of_flags);
		if (!IS_ERR(desc) || (PTR_ERR(desc) != -ENOENT))
			break;
	}

	if (IS_ERR(desc))
		return desc;

	if (of_flags & OF_GPIO_ACTIVE_LOW)
		*flags |= GPIO_ACTIVE_LOW;

	if (of_flags & OF_GPIO_SINGLE_ENDED) {
		if (of_flags & OF_GPIO_OPEN_DRAIN)
			*flags |= GPIO_OPEN_DRAIN;
		else
			*flags |= GPIO_OPEN_SOURCE;
	}

	return desc;
}

/**
 * of_parse_own_gpio() - Get a GPIO hog descriptor, names and flags for GPIO API
 * @np:		device node to get GPIO from
 * @chip:	GPIO chip whose hog is parsed
 * @idx:	Index of the GPIO to parse
 * @name:	GPIO line name
 * @lflags:	gpio_lookup_flags - returned from of_find_gpio() or
 *		of_parse_own_gpio()
 * @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_parse_own_gpio(struct device_node *np,
					   struct gpio_chip *chip,
					   unsigned int idx, const char **name,
					   enum gpio_lookup_flags *lflags,
					   enum gpiod_flags *dflags)
{
	struct device_node *chip_np;
	enum of_gpio_flags xlate_flags;
	struct of_phandle_args gpiospec;
	struct gpio_desc *desc;
	unsigned int i;
	u32 tmp;
	int ret;

	chip_np = chip->of_node;
	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);

	gpiospec.np = chip_np;
	gpiospec.args_count = tmp;

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

	desc = of_xlate_and_get_gpiod_flags(chip, &gpiospec, &xlate_flags);
	if (IS_ERR(desc))
		return desc;

	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(desc), np->name);
		return ERR_PTR(-EINVAL);
	}

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

	return desc;
}

/**
 * of_gpiochip_scan_gpios - Scan gpio-controller for gpio definitions
 * @chip:	gpio chip to act on
 *
 * This is only used by of_gpiochip_add to request/set GPIO initial
 * configuration.
 * It retures error if it fails otherwise 0 on success.
 */
static int of_gpiochip_scan_gpios(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;
	unsigned int i;
	int ret;

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

		for (i = 0;; i++) {
			desc = of_parse_own_gpio(np, chip, i, &name, &lflags,
						 &dflags);
			if (IS_ERR(desc))
				break;

			ret = gpiod_hog(desc, name, lflags, dflags);
			if (ret < 0) {
				of_node_put(np);
				return ret;
			}
		}
	}

	return 0;
}

/**
 * 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_data - Add memory mapped GPIO chip (bank)
 * @np:		device node of the GPIO chip
 * @mm_gc:	pointer to the of_mm_gpio_chip allocated structure
 * @data:	driver data to store in the struct gpio_chip
 *
 * 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_data(struct device_node *np,
			    struct of_mm_gpio_chip *mm_gc,
			    void *data)
{
	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_data(gc, data);
	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_data);

/**
 * 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 int 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 0;

	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);
		of_node_put(pinspec.np);
		if (!pctldev)
			return -EPROBE_DEFER;

		if (pinspec.args[2]) {
			if (group_names) {
				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)
				return ret;
		} 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)
				return ret;
		}
	}

	return 0;
}

#else
static int of_gpiochip_add_pin_range(struct gpio_chip *chip) { return 0; }
#endif

int of_gpiochip_add(struct gpio_chip *chip)
{
	int status;

	if ((!chip->of_node) && (chip->parent))
		chip->of_node = chip->parent->of_node;

	if (!chip->of_node)
		return 0;

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

	if (chip->of_gpio_n_cells > MAX_PHANDLE_ARGS)
		return -EINVAL;

	status = of_gpiochip_add_pin_range(chip);
	if (status)
		return status;

	/* If the chip defines names itself, these take precedence */
	if (!chip->names)
		devprop_gpiochip_set_names(chip);

	of_node_get(chip->of_node);

	return of_gpiochip_scan_gpios(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
c7e9d398	29	static int of_gpiochip_match_node_and_xlate(struct gpio_chip chip, void data)
3d0f7cf0	30	{
c7e9d398 MY	31	struct of_phandle_args *gpiospec = data;
	32
	33	return chip->gpiodev->dev.of_node == gpiospec->np &&
	34	chip->of_xlate(chip, gpiospec, NULL) >= 0;
762c2e46	35	}
3d0f7cf0	36
c7e9d398 MY	37	static struct gpio_chip *of_find_gpiochip_by_xlate(
c7e9d398 MY	38	struct of_phandle_args *gpiospec)
762c2e46	39	{
c7e9d398	40	return gpiochip_find(gpiospec, of_gpiochip_match_node_and_xlate);
3d0f7cf0	41	}
3d0f7cf0	42
99468c1a MY	43	static struct gpio_desc of_xlate_and_get_gpiod_flags(struct gpio_chip chip,
	44	struct of_phandle_args *gpiospec,
	45	enum of_gpio_flags *flags)
3d0f7cf0	46	{
3d0f7cf0 GL	47	int ret;
3d0f7cf0 GL	48
99468c1a MY	49	if (chip->of_gpio_n_cells != gpiospec->args_count)
	50	return ERR_PTR(-EINVAL);
	51
	52	ret = chip->of_xlate(chip, gpiospec, flags);
	53	if (ret < 0)
	54	return ERR_PTR(ret);
	55
	56	return gpiochip_get_desc(chip, ret);
3d0f7cf0 GL	57	}
3d0f7cf0 GL	58
863fbf49	59	/**
af8b6375	60	* of_get_named_gpiod_flags() - Get a GPIO descriptor and flags for GPIO API
863fbf49	61	* @np: device node to get GPIO from
a6b09191	62	* @propname: property name containing gpio specifier(s)
863fbf49	63	* @index: index of the GPIO
b908b53d	64	* @flags: a flags pointer to fill in
863fbf49	65	*
af8b6375	66	* Returns GPIO descriptor to use with Linux GPIO API, or one of the errno
b908b53d AV	67	* value on the error condition. If @flags is not NULL the function also fills
b908b53d AV	68	* in flags for the GPIO.
863fbf49	69	*/
af8b6375 AC	70	struct gpio_desc of_get_named_gpiod_flags(struct device_node np,
af8b6375 AC	71	const char propname, int index, enum of_gpio_flags flags)
863fbf49	72	{
762c2e46 MY	73	struct of_phandle_args gpiospec;
	74	struct gpio_chip *chip;
	75	struct gpio_desc *desc;
64b60e09	76	int ret;
3d0f7cf0	77
15c9a0ac	78	ret = of_parse_phandle_with_args(np, propname, "#gpio-cells", index,
762c2e46	79	&gpiospec);
64b60e09	80	if (ret) {
85ea29ac TB	81	pr_debug("%s: can't parse '%s' property of node '%s[%d]'\n",
85ea29ac TB	82	__func__, propname, np->full_name, index);
af8b6375	83	return ERR_PTR(ret);
863fbf49 AV	84	}
863fbf49 AV	85
c7e9d398	86	chip = of_find_gpiochip_by_xlate(&gpiospec);
762c2e46 MY	87	if (!chip) {
	88	desc = ERR_PTR(-EPROBE_DEFER);
	89	goto out;
	90	}
762c2e46	91
99468c1a	92	desc = of_xlate_and_get_gpiod_flags(chip, &gpiospec, flags);
762c2e46 MY	93	if (IS_ERR(desc))
762c2e46 MY	94	goto out;
863fbf49	95
85ea29ac TB	96	pr_debug("%s: parsed '%s' property of node '%s[%d]' - status (%d)\n",
85ea29ac TB	97	__func__, propname, np->full_name, index,
762c2e46 MY	98	PTR_ERR_OR_ZERO(desc));
	99
	100	out:
	101	of_node_put(gpiospec.np);
	102
	103	return desc;
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
ea713bc4 LW	120	struct gpio_desc of_find_gpio(struct device dev, const char *con_id,
	121	unsigned int idx,
	122	enum gpio_lookup_flags *flags)
	123	{
	124	char prop_name[32]; /* 32 is max size of property name */
	125	enum of_gpio_flags of_flags;
	126	struct gpio_desc *desc;
	127	unsigned int i;
	128
	129	for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
	130	if (con_id)
	131	snprintf(prop_name, sizeof(prop_name), "%s-%s", con_id,
	132	gpio_suffixes[i]);
	133	else
	134	snprintf(prop_name, sizeof(prop_name), "%s",
	135	gpio_suffixes[i]);
	136
	137	desc = of_get_named_gpiod_flags(dev->of_node, prop_name, idx,
	138	&of_flags);
	139	if (!IS_ERR(desc) \|\| (PTR_ERR(desc) != -ENOENT))
	140	break;
	141	}
	142
	143	if (IS_ERR(desc))
	144	return desc;
	145
	146	if (of_flags & OF_GPIO_ACTIVE_LOW)
	147	*flags \|= GPIO_ACTIVE_LOW;
	148
	149	if (of_flags & OF_GPIO_SINGLE_ENDED) {
4c0facdd	150	if (of_flags & OF_GPIO_OPEN_DRAIN)
ea713bc4 LW	151	*flags \|= GPIO_OPEN_DRAIN;
	152	else
	153	*flags \|= GPIO_OPEN_SOURCE;
	154	}
	155
	156	return desc;
	157	}
	158
f625d460	159	/**
fd7337fd	160	* of_parse_own_gpio() - Get a GPIO hog descriptor, names and flags for GPIO API
f625d460	161	* @np: device node to get GPIO from
be715343	162	* @chip: GPIO chip whose hog is parsed
a79fead5	163	* @idx: Index of the GPIO to parse
f625d460 BP	164	* @name: GPIO line name
f625d460 BP	165	* @lflags: gpio_lookup_flags - returned from of_find_gpio() or
fd7337fd	166	* of_parse_own_gpio()
f625d460 BP	167	* @dflags: gpiod_flags - optional GPIO initialization flags
	168	*
	169	* Returns GPIO descriptor to use with Linux GPIO API, or one of the errno
	170	* value on the error condition.
	171	*/
fd7337fd	172	static struct gpio_desc of_parse_own_gpio(struct device_node np,
be715343	173	struct gpio_chip *chip,
a79fead5	174	unsigned int idx, const char **name,
fd7337fd MP	175	enum gpio_lookup_flags *lflags,
fd7337fd MP	176	enum gpiod_flags *dflags)
f625d460 BP	177	{
	178	struct device_node *chip_np;
	179	enum of_gpio_flags xlate_flags;
be715343 MY	180	struct of_phandle_args gpiospec;
be715343 MY	181	struct gpio_desc *desc;
a79fead5	182	unsigned int i;
f625d460	183	u32 tmp;
3f9547e1	184	int ret;
f625d460	185
be715343	186	chip_np = chip->of_node;
f625d460 BP	187	if (!chip_np)
	188	return ERR_PTR(-EINVAL);
	189
	190	xlate_flags = 0;
	191	*lflags = 0;
	192	*dflags = 0;
	193
	194	ret = of_property_read_u32(chip_np, "#gpio-cells", &tmp);
	195	if (ret)
	196	return ERR_PTR(ret);
	197
be715343 MY	198	gpiospec.np = chip_np;
be715343 MY	199	gpiospec.args_count = tmp;
f625d460	200
a79fead5 GU	201	for (i = 0; i < tmp; i++) {
	202	ret = of_property_read_u32_index(np, "gpios", idx * tmp + i,
	203	&gpiospec.args[i]);
	204	if (ret)
	205	return ERR_PTR(ret);
	206	}
f625d460	207
99468c1a	208	desc = of_xlate_and_get_gpiod_flags(chip, &gpiospec, &xlate_flags);
be715343 MY	209	if (IS_ERR(desc))
be715343 MY	210	return desc;
f625d460 BP	211
	212	if (xlate_flags & OF_GPIO_ACTIVE_LOW)
	213	*lflags \|= GPIO_ACTIVE_LOW;
	214
	215	if (of_property_read_bool(np, "input"))
	216	*dflags \|= GPIOD_IN;
	217	else if (of_property_read_bool(np, "output-low"))
	218	*dflags \|= GPIOD_OUT_LOW;
	219	else if (of_property_read_bool(np, "output-high"))
	220	*dflags \|= GPIOD_OUT_HIGH;
	221	else {
	222	pr_warn("GPIO line %d (%s): no hogging state specified, bailing out\n",
be715343	223	desc_to_gpio(desc), np->name);
f625d460 BP	224	return ERR_PTR(-EINVAL);
	225	}
	226
	227	if (name && of_property_read_string(np, "line-name", name))
	228	*name = np->name;
	229
be715343	230	return desc;
f625d460 BP	231	}
	232
	233	/**
fd7337fd	234	* of_gpiochip_scan_gpios - Scan gpio-controller for gpio definitions
f625d460 BP	235	* @chip: gpio chip to act on
	236	*
	237	* This is only used by of_gpiochip_add to request/set GPIO initial
	238	* configuration.
dfbd379b	239	* It retures error if it fails otherwise 0 on success.
f625d460	240	*/
dfbd379b	241	static int of_gpiochip_scan_gpios(struct gpio_chip *chip)
f625d460 BP	242	{
	243	struct gpio_desc *desc = NULL;
	244	struct device_node *np;
	245	const char *name;
	246	enum gpio_lookup_flags lflags;
	247	enum gpiod_flags dflags;
a79fead5	248	unsigned int i;
dfbd379b	249	int ret;
f625d460	250
d1279d94	251	for_each_available_child_of_node(chip->of_node, np) {
f625d460 BP	252	if (!of_property_read_bool(np, "gpio-hog"))
	253	continue;
	254
a79fead5 GU	255	for (i = 0;; i++) {
	256	desc = of_parse_own_gpio(np, chip, i, &name, &lflags,
	257	&dflags);
	258	if (IS_ERR(desc))
	259	break;
	260
	261	ret = gpiod_hog(desc, name, lflags, dflags);
	262	if (ret < 0) {
	263	of_node_put(np);
	264	return ret;
	265	}
09e258af	266	}
f625d460	267	}
dfbd379b LD	268
dfbd379b LD	269	return 0;
f625d460 BP	270	}
f625d460 BP	271
863fbf49	272	/**
b908b53d	273	* of_gpio_simple_xlate - translate gpio_spec to the GPIO number and flags
a19e3da5	274	* @gc: pointer to the gpio_chip structure
863fbf49 AV	275	* @np: device node of the GPIO chip
863fbf49 AV	276	* @gpio_spec: gpio specifier as found in the device tree
b908b53d	277	* @flags: a flags pointer to fill in
863fbf49 AV	278	*
	279	* This is simple translation function, suitable for the most 1:1 mapped
	280	* gpio chips. This function performs only one sanity check: whether gpio
	281	* is less than ngpios (that is specified in the gpio_chip).
	282	*/
15c9a0ac GL	283	int of_gpio_simple_xlate(struct gpio_chip *gc,
15c9a0ac GL	284	const struct of_phandle_args gpiospec, u32 flags)
863fbf49	285	{
b908b53d AV	286	/*
b908b53d AV	287	* We're discouraging gpio_cells < 2, since that way you'll have to
20a8a968	288	* write your own xlate function (that will have to retrieve the GPIO
b908b53d AV	289	* number and the flags from a single gpio cell -- this is possible,
	290	* but not recommended).
	291	*/
a19e3da5	292	if (gc->of_gpio_n_cells < 2) {
b908b53d AV	293	WARN_ON(1);
	294	return -EINVAL;
	295	}
	296
15c9a0ac GL	297	if (WARN_ON(gpiospec->args_count < gc->of_gpio_n_cells))
	298	return -EINVAL;
	299
6270d830	300	if (gpiospec->args[0] >= gc->ngpio)
863fbf49 AV	301	return -EINVAL;
863fbf49 AV	302
b908b53d	303	if (flags)
15c9a0ac	304	*flags = gpiospec->args[1];
b908b53d	305
15c9a0ac	306	return gpiospec->args[0];
863fbf49	307	}
3038bbdf	308	EXPORT_SYMBOL(of_gpio_simple_xlate);
863fbf49	309
863fbf49	310	/**
3208b0f0	311	* of_mm_gpiochip_add_data - Add memory mapped GPIO chip (bank)
863fbf49 AV	312	* @np: device node of the GPIO chip
863fbf49 AV	313	* @mm_gc: pointer to the of_mm_gpio_chip allocated structure
3208b0f0	314	* @data: driver data to store in the struct gpio_chip
863fbf49 AV	315	*
	316	* To use this function you should allocate and fill mm_gc with:
	317	*
	318	* 1) In the gpio_chip structure:
	319	* - all the callbacks
a19e3da5 AV	320	* - of_gpio_n_cells
a19e3da5 AV	321	* - of_xlate callback (optional)
863fbf49 AV	322	*
	323	* 3) In the of_mm_gpio_chip structure:
	324	* - save_regs callback (optional)
	325	*
	326	* If succeeded, this function will map bank's memory and will
	327	* do all necessary work for you. Then you'll able to use .regs
	328	* to manage GPIOs from the callbacks.
	329	*/
3208b0f0 LW	330	int of_mm_gpiochip_add_data(struct device_node *np,
	331	struct of_mm_gpio_chip *mm_gc,
	332	void *data)
863fbf49 AV	333	{
863fbf49 AV	334	int ret = -ENOMEM;
a19e3da5	335	struct gpio_chip *gc = &mm_gc->gc;
863fbf49 AV	336
	337	gc->label = kstrdup(np->full_name, GFP_KERNEL);
	338	if (!gc->label)
	339	goto err0;
	340
	341	mm_gc->regs = of_iomap(np, 0);
	342	if (!mm_gc->regs)
	343	goto err1;
	344
21451155	345	gc->base = -1;
863fbf49	346
863fbf49 AV	347	if (mm_gc->save_regs)
	348	mm_gc->save_regs(mm_gc);
	349
a19e3da5	350	mm_gc->gc.of_node = np;
863fbf49	351
3208b0f0	352	ret = gpiochip_add_data(gc, data);
863fbf49 AV	353	if (ret)
	354	goto err2;
	355
863fbf49 AV	356	return 0;
863fbf49 AV	357	err2:
863fbf49 AV	358	iounmap(mm_gc->regs);
	359	err1:
	360	kfree(gc->label);
	361	err0:
	362	pr_err("%s: GPIO chip registration failed with status %d\n",
	363	np->full_name, ret);
	364	return ret;
	365	}
3208b0f0	366	EXPORT_SYMBOL(of_mm_gpiochip_add_data);
594fa265	367
d621e8ba RRD	368	/**
	369	* of_mm_gpiochip_remove - Remove memory mapped GPIO chip (bank)
	370	* @mm_gc: pointer to the of_mm_gpio_chip allocated structure
	371	*/
	372	void of_mm_gpiochip_remove(struct of_mm_gpio_chip *mm_gc)
	373	{
	374	struct gpio_chip *gc = &mm_gc->gc;
	375
	376	if (!mm_gc)
	377	return;
	378
	379	gpiochip_remove(gc);
	380	iounmap(mm_gc->regs);
	381	kfree(gc->label);
	382	}
	383	EXPORT_SYMBOL(of_mm_gpiochip_remove);
	384
f23f1516	385	#ifdef CONFIG_PINCTRL
28355f81	386	static int of_gpiochip_add_pin_range(struct gpio_chip *chip)
f23f1516 SH	387	{
f23f1516 SH	388	struct device_node *np = chip->of_node;
f23f1516	389	struct of_phandle_args pinspec;
1e63d7b9	390	struct pinctrl_dev *pctldev;
f23f1516	391	int index = 0, ret;
586a87e6 CR	392	const char *name;
	393	static const char group_names_propname[] = "gpio-ranges-group-names";
	394	struct property *group_names;
f23f1516 SH	395
f23f1516 SH	396	if (!np)
28355f81	397	return 0;
f23f1516	398
586a87e6 CR	399	group_names = of_find_property(np, group_names_propname, NULL);
586a87e6 CR	400
ad4e1a7c	401	for (;; index++) {
d9fe0039 SW	402	ret = of_parse_phandle_with_fixed_args(np, "gpio-ranges", 3,
d9fe0039 SW	403	index, &pinspec);
f23f1516 SH	404	if (ret)
	405	break;
	406
1e63d7b9	407	pctldev = of_pinctrl_get(pinspec.np);
602cf638	408	of_node_put(pinspec.np);
1e63d7b9	409	if (!pctldev)
28355f81	410	return -EPROBE_DEFER;
f23f1516	411
586a87e6 CR	412	if (pinspec.args[2]) {
586a87e6 CR	413	if (group_names) {
72858602	414	of_property_read_string_index(np,
586a87e6 CR	415	group_names_propname,
	416	index, &name);
	417	if (strlen(name)) {
	418	pr_err("%s: Group name of numeric GPIO ranges must be the empty string.\n",
	419	np->full_name);
	420	break;
	421	}
	422	}
	423	/* npins != 0: linear range */
	424	ret = gpiochip_add_pin_range(chip,
	425	pinctrl_dev_get_devname(pctldev),
	426	pinspec.args[0],
	427	pinspec.args[1],
	428	pinspec.args[2]);
	429	if (ret)
28355f81	430	return ret;
586a87e6 CR	431	} else {
	432	/* npins == 0: special range */
	433	if (pinspec.args[1]) {
	434	pr_err("%s: Illegal gpio-range format.\n",
	435	np->full_name);
	436	break;
	437	}
	438
	439	if (!group_names) {
	440	pr_err("%s: GPIO group range requested but no %s property.\n",
	441	np->full_name, group_names_propname);
	442	break;
	443	}
	444
	445	ret = of_property_read_string_index(np,
	446	group_names_propname,
	447	index, &name);
	448	if (ret)
	449	break;
	450
	451	if (!strlen(name)) {
	452	pr_err("%s: Group name of GPIO group range cannot be the empty string.\n",
	453	np->full_name);
	454	break;
	455	}
	456
	457	ret = gpiochip_add_pingroup_range(chip, pctldev,
	458	pinspec.args[0], name);
	459	if (ret)
28355f81	460	return ret;
586a87e6	461	}
ad4e1a7c	462	}
28355f81 TV	463
28355f81 TV	464	return 0;
f23f1516 SH	465	}
f23f1516 SH	466
f23f1516	467	#else
28355f81	468	static int of_gpiochip_add_pin_range(struct gpio_chip *chip) { return 0; }
f23f1516 SH	469	#endif
f23f1516 SH	470
28355f81	471	int of_gpiochip_add(struct gpio_chip *chip)
391c970c	472	{
28355f81 TV	473	int status;
28355f81 TV	474
58383c78 LW	475	if ((!chip->of_node) && (chip->parent))
58383c78 LW	476	chip->of_node = chip->parent->of_node;
391c970c AV	477
391c970c AV	478	if (!chip->of_node)
28355f81	479	return 0;
391c970c AV	480
	481	if (!chip->of_xlate) {
	482	chip->of_gpio_n_cells = 2;
	483	chip->of_xlate = of_gpio_simple_xlate;
	484	}
	485
1020dfd1 MY	486	if (chip->of_gpio_n_cells > MAX_PHANDLE_ARGS)
	487	return -EINVAL;
	488
28355f81 TV	489	status = of_gpiochip_add_pin_range(chip);
	490	if (status)
	491	return status;
	492
fd9c5531 LW	493	/* If the chip defines names itself, these take precedence */
fd9c5531 LW	494	if (!chip->names)
9427ecbe	495	devprop_gpiochip_set_names(chip);
fd9c5531	496
391c970c	497	of_node_get(chip->of_node);
f625d460	498
dfbd379b	499	return of_gpiochip_scan_gpios(chip);
391c970c AV	500	}
	501
	502	void of_gpiochip_remove(struct gpio_chip *chip)
	503	{
e93fa3f2	504	gpiochip_remove_pin_ranges(chip);
8a691550	505	of_node_put(chip->of_node);
391c970c	506	}