Release 4.7 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/io-mapping.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;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
grant likely
grant likely
96
84.21%
1
20.00%
hans holmberg
hans holmberg
13
11.40%
2
40.00%
linus walleij
linus walleij
3
2.63%
1
20.00%
alexandre courbot
alexandre courbot
2
1.75%
1
20.00%
Total
114
100.00%
5
100.00%

/**
 * 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;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
anton vorontsov
anton vorontsov
61
41.50%
3
23.08%
grant likely
grant likely
43
29.25%
2
15.38%
alexandre courbot
alexandre courbot
14
9.52%
2
15.38%
tushar behera
tushar behera
12
8.16%
1
7.69%
lothar wassmann
lothar wassmann
6
4.08%
1
7.69%
john bonesio
john bonesio
6
4.08%
1
7.69%
thierry reding
thierry reding
3
2.04%
1
7.69%
sachin kamat
sachin kamat
1
0.68%
1
7.69%
roland stigge
roland stigge
1
0.68%
1
7.69%
Total
147
100.00%
13
100.00%



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);
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
alexandre courbot
alexandre courbot
61
100.00%
1
100.00%
Total
61
100.00%
1
100.00%


EXPORT_SYMBOL(of_get_named_gpio_flags);

/**
 * of_parse_own_gpio() - 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_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,
					   const char **name,
					   enum gpio_lookup_flags *lflags,
					   enum gpiod_flags *dflags)
{
	struct device_node *chip_np;
	enum of_gpio_flags xlate_flags;
	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;

	return gg_data.out_gpio;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
benoit parrot
benoit parrot
331
99.40%
1
33.33%
masahiro yamada
masahiro yamada
1
0.30%
1
33.33%
markus pargmann
markus pargmann
1
0.30%
1
33.33%
Total
333
100.00%
3
100.00%

/**
 * of_gpiochip_set_names() - set up the names of the lines
 * @chip: GPIO chip whose lines should be named, if possible
 */


static void of_gpiochip_set_names(struct gpio_chip *gc)
{
	struct gpio_device *gdev = gc->gpiodev;
	struct device_node *np = gc->of_node;
	int i;
	int nstrings;

	nstrings = of_property_count_strings(np, "gpio-line-names");
	if (nstrings <= 0)
		/* Lines names not present */
		return;

	/* This is normally not what you want */
	if (gdev->ngpio != nstrings)
		dev_info(&gdev->dev, "gpio-line-names specifies %d line "
			 "names but there are %d lines on the chip\n",
			 nstrings, gdev->ngpio);

	/*
         * Make sure to not index beyond the end of the number of descriptors
         * of the GPIO device.
         */
	for (i = 0; i < gdev->ngpio; i++) {
		const char *name;
		int ret;

		ret = of_property_read_string_index(np,
						    "gpio-line-names",
						    i,
						    &name);
		if (ret) {
			if (ret != -ENODATA)
                                dev_err(&gdev->dev,
                                        "unable to name line %d: %d\n",
                                        i, ret);
			break;
		}
		gdev->descs[i].name = name;
	}
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
linus walleij
linus walleij
157
100.00%
1
100.00%
Total
157
100.00%
1
100.00%

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

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

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

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

	return 0;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
benoit parrot
benoit parrot
86
80.37%
1
25.00%
laxman dewangan
laxman dewangan
19
17.76%
2
50.00%
markus pargmann
markus pargmann
2
1.87%
1
25.00%
Total
107
100.00%
4
100.00%

/**
 * 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];
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
anton vorontsov
anton vorontsov
59
61.46%
3
50.00%
grant likely
grant likely
35
36.46%
1
16.67%
colin cronin
colin cronin
1
1.04%
1
16.67%
roland stigge
roland stigge
1
1.04%
1
16.67%
Total
96
100.00%
6
100.00%


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;
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
anton vorontsov
anton vorontsov
152
95.00%
3
75.00%
linus walleij
linus walleij
8
5.00%
1
25.00%
Total
160
100.00%
4
100.00%


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);
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
ricardo ribalda
ricardo ribalda
45
100.00%
1
100.00%
Total
45
100.00%
1
100.00%


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

Contributors
Person
Tokens
Prop
Commits
CommitProp
christian ruppert
christian ruppert
183
57.01%
1
11.11%
shiraz hashim
shiraz hashim
79
24.61%
1
11.11%
linus walleij
linus walleij
25
7.79%
2
22.22%
tomeu vizoso
tomeu vizoso
17
5.30%
1
11.11%
haojian zhuang
haojian zhuang
15
4.67%
3
33.33%
stephen warren
stephen warren
2
0.62%
1
11.11%
Total
321
100.00%
9
100.00%

#else


static int of_gpiochip_add_pin_range(struct gpio_chip *chip) { return 0; }
Contributors
Person
Tokens
Prop
Commits
CommitProp
shiraz hashim
shiraz hashim
7
50.00%
1
33.33%
tomeu vizoso
tomeu vizoso
6
42.86%
1
33.33%
linus walleij
linus walleij
1
7.14%
1
33.33%
Total
14
100.00%
3
100.00%

#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;
	}

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

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

	of_node_get(chip->of_node);

	return of_gpiochip_scan_gpios(chip);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
anton vorontsov
anton vorontsov
67
61.47%
1
12.50%
tomeu vizoso
tomeu vizoso
17
15.60%
1
12.50%
linus walleij
linus walleij
15
13.76%
2
25.00%
shiraz hashim
shiraz hashim
5
4.59%
1
12.50%
benoit parrot
benoit parrot
3
2.75%
1
12.50%
laxman dewangan
laxman dewangan
1
0.92%
1
12.50%
markus pargmann
markus pargmann
1
0.92%
1
12.50%
Total
109
100.00%
8
100.00%



void of_gpiochip_remove(struct gpio_chip *chip)
{
	gpiochip_remove_pin_ranges(chip);
	of_node_put(chip->of_node);
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
anton vorontsov
anton vorontsov
17
77.27%
1
33.33%
shiraz hashim
shiraz hashim
4
18.18%
1
33.33%
linus walleij
linus walleij
1
4.55%
1
33.33%
Total
22
100.00%
3
100.00%

Overall Contributors
Person
Tokens
Prop
Commits
CommitProp
benoit parrot
benoit parrot
423
23.71%
1
2.13%
anton vorontsov
anton vorontsov
378
21.19%
6
12.77%
linus walleij
linus walleij
216
12.11%
8
17.02%
grant likely
grant likely
199
11.15%
3
6.38%
christian ruppert
christian ruppert
183
10.26%
1
2.13%
shiraz hashim
shiraz hashim
105
5.89%
1
2.13%
alexandre courbot
alexandre courbot
90
5.04%
4
8.51%
ricardo ribalda
ricardo ribalda
51
2.86%
1
2.13%
tomeu vizoso
tomeu vizoso
40
2.24%
1
2.13%
laxman dewangan
laxman dewangan
21
1.18%
2
4.26%
haojian zhuang
haojian zhuang
15
0.84%
3
6.38%
hans holmberg
hans holmberg
13
0.73%
2
4.26%
tushar behera
tushar behera
12
0.67%
1
2.13%
lothar wassmann
lothar wassmann
6
0.34%
1
2.13%
john bonesio
john bonesio
6
0.34%
1
2.13%
jamie iles
jamie iles
5
0.28%
1
2.13%
markus pargmann
markus pargmann
5
0.28%
1
2.13%
sachin kamat
sachin kamat
4
0.22%
1
2.13%
thierry reding
thierry reding
3
0.17%
1
2.13%
roland stigge
roland stigge
2
0.11%
2
4.26%
stephen warren
stephen warren
2
0.11%
1
2.13%
tejun heo
tejun heo
2
0.11%
1
2.13%
colin cronin
colin cronin
1
0.06%
1
2.13%
masahiro yamada
masahiro yamada
1
0.06%
1
2.13%
dong aisheng
dong aisheng
1
0.06%
1
2.13%
Total
1784
100.00%
47
100.00%
  
Directory: drivers/gpio

Information contained on this website is for historical information purposes only and does not indicate or represent copyright ownership.