Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 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 | |
Grant Likely | 2e13cba | 2010-07-05 16:11:55 -0600 | [diff] [blame] | 14 | #include <linux/device.h> |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 15 | #include <linux/errno.h> |
Grant Likely | 2e13cba | 2010-07-05 16:11:55 -0600 | [diff] [blame] | 16 | #include <linux/module.h> |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 17 | #include <linux/io.h> |
Grant Likely | 3d0f7cf | 2012-05-17 13:54:40 -0600 | [diff] [blame] | 18 | #include <linux/gpio.h> |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 19 | #include <linux/of.h> |
Grant Likely | 2e13cba | 2010-07-05 16:11:55 -0600 | [diff] [blame] | 20 | #include <linux/of_address.h> |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 21 | #include <linux/of_gpio.h> |
Shiraz Hashim | f23f151 | 2012-10-27 15:21:36 +0530 | [diff] [blame] | 22 | #include <linux/pinctrl/pinctrl.h> |
Grant Likely | 2e13cba | 2010-07-05 16:11:55 -0600 | [diff] [blame] | 23 | #include <linux/slab.h> |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 24 | |
Dong Aisheng | 0df2c99 | 2012-05-25 21:36:15 +0800 | [diff] [blame] | 25 | /* Private data structure for of_gpiochip_find_and_xlate */ |
Grant Likely | 3d0f7cf | 2012-05-17 13:54:40 -0600 | [diff] [blame] | 26 | struct gg_data { |
| 27 | enum of_gpio_flags *flags; |
| 28 | struct of_phandle_args gpiospec; |
| 29 | |
| 30 | int out_gpio; |
| 31 | }; |
| 32 | |
| 33 | /* Private function for resolving node pointer to gpio_chip */ |
| 34 | static int of_gpiochip_find_and_xlate(struct gpio_chip *gc, void *data) |
| 35 | { |
| 36 | struct gg_data *gg_data = data; |
| 37 | int ret; |
| 38 | |
| 39 | if ((gc->of_node != gg_data->gpiospec.np) || |
| 40 | (gc->of_gpio_n_cells != gg_data->gpiospec.args_count) || |
| 41 | (!gc->of_xlate)) |
| 42 | return false; |
| 43 | |
| 44 | ret = gc->of_xlate(gc, &gg_data->gpiospec, gg_data->flags); |
| 45 | if (ret < 0) |
| 46 | return false; |
| 47 | |
| 48 | gg_data->out_gpio = ret + gc->base; |
| 49 | return true; |
| 50 | } |
| 51 | |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 52 | /** |
John Bonesio | a6b0919 | 2011-06-27 16:49:57 -0700 | [diff] [blame] | 53 | * of_get_named_gpio_flags() - Get a GPIO number and flags to use with GPIO API |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 54 | * @np: device node to get GPIO from |
John Bonesio | a6b0919 | 2011-06-27 16:49:57 -0700 | [diff] [blame] | 55 | * @propname: property name containing gpio specifier(s) |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 56 | * @index: index of the GPIO |
Anton Vorontsov | b908b53 | 2008-12-01 06:30:04 +0000 | [diff] [blame] | 57 | * @flags: a flags pointer to fill in |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 58 | * |
| 59 | * Returns GPIO number to use with Linux generic GPIO API, or one of the errno |
Anton Vorontsov | b908b53 | 2008-12-01 06:30:04 +0000 | [diff] [blame] | 60 | * value on the error condition. If @flags is not NULL the function also fills |
| 61 | * in flags for the GPIO. |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 62 | */ |
John Bonesio | a6b0919 | 2011-06-27 16:49:57 -0700 | [diff] [blame] | 63 | int of_get_named_gpio_flags(struct device_node *np, const char *propname, |
Laurent Navet | 9ccb1a2 | 2013-03-20 13:15:55 +0100 | [diff] [blame] | 64 | int index, enum of_gpio_flags *flags) |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 65 | { |
Roland Stigge | 4fbb002 | 2012-06-28 00:32:14 +0200 | [diff] [blame] | 66 | /* Return -EPROBE_DEFER to support probe() functions to be called |
| 67 | * later when the GPIO actually becomes available |
| 68 | */ |
| 69 | struct gg_data gg_data = { .flags = flags, .out_gpio = -EPROBE_DEFER }; |
Anton Vorontsov | 64b60e0 | 2008-10-10 04:43:17 +0000 | [diff] [blame] | 70 | int ret; |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 71 | |
Grant Likely | 3d0f7cf | 2012-05-17 13:54:40 -0600 | [diff] [blame] | 72 | /* .of_xlate might decide to not fill in the flags, so clear it. */ |
Anton Vorontsov | b908b53 | 2008-12-01 06:30:04 +0000 | [diff] [blame] | 73 | if (flags) |
| 74 | *flags = 0; |
| 75 | |
Grant Likely | 3d0f7cf | 2012-05-17 13:54:40 -0600 | [diff] [blame] | 76 | ret = of_parse_phandle_with_args(np, propname, "#gpio-cells", index, |
| 77 | &gg_data.gpiospec); |
| 78 | if (ret) { |
| 79 | pr_debug("%s: can't parse gpios property\n", __func__); |
Alexandre Courbot | 41920d16 | 2012-06-29 13:57:59 +0900 | [diff] [blame] | 80 | return ret; |
Grant Likely | 3d0f7cf | 2012-05-17 13:54:40 -0600 | [diff] [blame] | 81 | } |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 82 | |
Grant Likely | 3d0f7cf | 2012-05-17 13:54:40 -0600 | [diff] [blame] | 83 | gpiochip_find(&gg_data, of_gpiochip_find_and_xlate); |
| 84 | |
| 85 | of_node_put(gg_data.gpiospec.np); |
Thierry Reding | c61307a | 2012-08-09 08:38:43 +0200 | [diff] [blame] | 86 | pr_debug("%s exited with status %d\n", __func__, gg_data.out_gpio); |
Grant Likely | 3d0f7cf | 2012-05-17 13:54:40 -0600 | [diff] [blame] | 87 | return gg_data.out_gpio; |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 88 | } |
John Bonesio | a6b0919 | 2011-06-27 16:49:57 -0700 | [diff] [blame] | 89 | EXPORT_SYMBOL(of_get_named_gpio_flags); |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 90 | |
| 91 | /** |
Anton Vorontsov | b908b53 | 2008-12-01 06:30:04 +0000 | [diff] [blame] | 92 | * of_gpio_simple_xlate - translate gpio_spec to the GPIO number and flags |
Anton Vorontsov | a19e3da | 2010-06-08 07:48:16 -0600 | [diff] [blame] | 93 | * @gc: pointer to the gpio_chip structure |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 94 | * @np: device node of the GPIO chip |
| 95 | * @gpio_spec: gpio specifier as found in the device tree |
Anton Vorontsov | b908b53 | 2008-12-01 06:30:04 +0000 | [diff] [blame] | 96 | * @flags: a flags pointer to fill in |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 97 | * |
| 98 | * This is simple translation function, suitable for the most 1:1 mapped |
| 99 | * gpio chips. This function performs only one sanity check: whether gpio |
| 100 | * is less than ngpios (that is specified in the gpio_chip). |
| 101 | */ |
Grant Likely | 15c9a0a | 2011-12-12 09:25:57 -0700 | [diff] [blame] | 102 | int of_gpio_simple_xlate(struct gpio_chip *gc, |
| 103 | const struct of_phandle_args *gpiospec, u32 *flags) |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 104 | { |
Anton Vorontsov | b908b53 | 2008-12-01 06:30:04 +0000 | [diff] [blame] | 105 | /* |
| 106 | * We're discouraging gpio_cells < 2, since that way you'll have to |
| 107 | * write your own xlate function (that will have to retrive the GPIO |
| 108 | * number and the flags from a single gpio cell -- this is possible, |
| 109 | * but not recommended). |
| 110 | */ |
Anton Vorontsov | a19e3da | 2010-06-08 07:48:16 -0600 | [diff] [blame] | 111 | if (gc->of_gpio_n_cells < 2) { |
Anton Vorontsov | b908b53 | 2008-12-01 06:30:04 +0000 | [diff] [blame] | 112 | WARN_ON(1); |
| 113 | return -EINVAL; |
| 114 | } |
| 115 | |
Grant Likely | 15c9a0a | 2011-12-12 09:25:57 -0700 | [diff] [blame] | 116 | if (WARN_ON(gpiospec->args_count < gc->of_gpio_n_cells)) |
| 117 | return -EINVAL; |
| 118 | |
Roland Stigge | 6270d83 | 2012-04-04 02:02:58 +0200 | [diff] [blame] | 119 | if (gpiospec->args[0] >= gc->ngpio) |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 120 | return -EINVAL; |
| 121 | |
Anton Vorontsov | b908b53 | 2008-12-01 06:30:04 +0000 | [diff] [blame] | 122 | if (flags) |
Grant Likely | 15c9a0a | 2011-12-12 09:25:57 -0700 | [diff] [blame] | 123 | *flags = gpiospec->args[1]; |
Anton Vorontsov | b908b53 | 2008-12-01 06:30:04 +0000 | [diff] [blame] | 124 | |
Grant Likely | 15c9a0a | 2011-12-12 09:25:57 -0700 | [diff] [blame] | 125 | return gpiospec->args[0]; |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 126 | } |
Jamie Iles | 3038bbd | 2011-07-28 16:25:41 +0100 | [diff] [blame] | 127 | EXPORT_SYMBOL(of_gpio_simple_xlate); |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 128 | |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 129 | /** |
| 130 | * of_mm_gpiochip_add - Add memory mapped GPIO chip (bank) |
| 131 | * @np: device node of the GPIO chip |
| 132 | * @mm_gc: pointer to the of_mm_gpio_chip allocated structure |
| 133 | * |
| 134 | * To use this function you should allocate and fill mm_gc with: |
| 135 | * |
| 136 | * 1) In the gpio_chip structure: |
| 137 | * - all the callbacks |
Anton Vorontsov | a19e3da | 2010-06-08 07:48:16 -0600 | [diff] [blame] | 138 | * - of_gpio_n_cells |
| 139 | * - of_xlate callback (optional) |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 140 | * |
| 141 | * 3) In the of_mm_gpio_chip structure: |
| 142 | * - save_regs callback (optional) |
| 143 | * |
| 144 | * If succeeded, this function will map bank's memory and will |
| 145 | * do all necessary work for you. Then you'll able to use .regs |
| 146 | * to manage GPIOs from the callbacks. |
| 147 | */ |
| 148 | int of_mm_gpiochip_add(struct device_node *np, |
| 149 | struct of_mm_gpio_chip *mm_gc) |
| 150 | { |
| 151 | int ret = -ENOMEM; |
Anton Vorontsov | a19e3da | 2010-06-08 07:48:16 -0600 | [diff] [blame] | 152 | struct gpio_chip *gc = &mm_gc->gc; |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 153 | |
| 154 | gc->label = kstrdup(np->full_name, GFP_KERNEL); |
| 155 | if (!gc->label) |
| 156 | goto err0; |
| 157 | |
| 158 | mm_gc->regs = of_iomap(np, 0); |
| 159 | if (!mm_gc->regs) |
| 160 | goto err1; |
| 161 | |
Anton Vorontsov | 2145115 | 2008-04-30 00:05:24 +1000 | [diff] [blame] | 162 | gc->base = -1; |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 163 | |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 164 | if (mm_gc->save_regs) |
| 165 | mm_gc->save_regs(mm_gc); |
| 166 | |
Anton Vorontsov | a19e3da | 2010-06-08 07:48:16 -0600 | [diff] [blame] | 167 | mm_gc->gc.of_node = np; |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 168 | |
| 169 | ret = gpiochip_add(gc); |
| 170 | if (ret) |
| 171 | goto err2; |
| 172 | |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 173 | return 0; |
| 174 | err2: |
Anton Vorontsov | 863fbf4 | 2008-04-11 23:06:45 +1000 | [diff] [blame] | 175 | iounmap(mm_gc->regs); |
| 176 | err1: |
| 177 | kfree(gc->label); |
| 178 | err0: |
| 179 | pr_err("%s: GPIO chip registration failed with status %d\n", |
| 180 | np->full_name, ret); |
| 181 | return ret; |
| 182 | } |
| 183 | EXPORT_SYMBOL(of_mm_gpiochip_add); |
Grant Likely | 594fa26 | 2010-06-08 07:48:16 -0600 | [diff] [blame] | 184 | |
Shiraz Hashim | f23f151 | 2012-10-27 15:21:36 +0530 | [diff] [blame] | 185 | #ifdef CONFIG_PINCTRL |
Linus Walleij | 167c1af | 2012-11-06 14:58:55 +0100 | [diff] [blame] | 186 | static void of_gpiochip_add_pin_range(struct gpio_chip *chip) |
Shiraz Hashim | f23f151 | 2012-10-27 15:21:36 +0530 | [diff] [blame] | 187 | { |
| 188 | struct device_node *np = chip->of_node; |
Shiraz Hashim | f23f151 | 2012-10-27 15:21:36 +0530 | [diff] [blame] | 189 | struct of_phandle_args pinspec; |
Linus Walleij | 1e63d7b | 2012-11-06 16:03:35 +0100 | [diff] [blame] | 190 | struct pinctrl_dev *pctldev; |
Shiraz Hashim | f23f151 | 2012-10-27 15:21:36 +0530 | [diff] [blame] | 191 | int index = 0, ret; |
| 192 | |
| 193 | if (!np) |
| 194 | return; |
| 195 | |
Haojian Zhuang | ad4e1a7 | 2013-02-17 19:42:48 +0800 | [diff] [blame] | 196 | for (;; index++) { |
Shiraz Hashim | f23f151 | 2012-10-27 15:21:36 +0530 | [diff] [blame] | 197 | ret = of_parse_phandle_with_args(np, "gpio-ranges", |
| 198 | "#gpio-range-cells", index, &pinspec); |
| 199 | if (ret) |
| 200 | break; |
| 201 | |
Linus Walleij | 1e63d7b | 2012-11-06 16:03:35 +0100 | [diff] [blame] | 202 | pctldev = of_pinctrl_get(pinspec.np); |
| 203 | if (!pctldev) |
Shiraz Hashim | f23f151 | 2012-10-27 15:21:36 +0530 | [diff] [blame] | 204 | break; |
Shiraz Hashim | f23f151 | 2012-10-27 15:21:36 +0530 | [diff] [blame] | 205 | |
Linus Walleij | 1e63d7b | 2012-11-06 16:03:35 +0100 | [diff] [blame] | 206 | ret = gpiochip_add_pin_range(chip, |
Haojian Zhuang | ef5e3ee | 2013-01-18 15:31:07 +0800 | [diff] [blame] | 207 | pinctrl_dev_get_devname(pctldev), |
Linus Walleij | 1e63d7b | 2012-11-06 16:03:35 +0100 | [diff] [blame] | 208 | pinspec.args[0], |
Haojian Zhuang | 86853c8 | 2013-02-17 19:42:47 +0800 | [diff] [blame] | 209 | pinspec.args[1], |
| 210 | pinspec.args[2]); |
Shiraz Hashim | f23f151 | 2012-10-27 15:21:36 +0530 | [diff] [blame] | 211 | |
Linus Walleij | 1e63d7b | 2012-11-06 16:03:35 +0100 | [diff] [blame] | 212 | if (ret) |
| 213 | break; |
Haojian Zhuang | ad4e1a7 | 2013-02-17 19:42:48 +0800 | [diff] [blame] | 214 | } |
Shiraz Hashim | f23f151 | 2012-10-27 15:21:36 +0530 | [diff] [blame] | 215 | } |
| 216 | |
Shiraz Hashim | f23f151 | 2012-10-27 15:21:36 +0530 | [diff] [blame] | 217 | #else |
Linus Walleij | 167c1af | 2012-11-06 14:58:55 +0100 | [diff] [blame] | 218 | static void of_gpiochip_add_pin_range(struct gpio_chip *chip) {} |
Shiraz Hashim | f23f151 | 2012-10-27 15:21:36 +0530 | [diff] [blame] | 219 | #endif |
| 220 | |
Anton Vorontsov | 391c970 | 2010-06-08 07:48:17 -0600 | [diff] [blame] | 221 | void of_gpiochip_add(struct gpio_chip *chip) |
| 222 | { |
| 223 | if ((!chip->of_node) && (chip->dev)) |
| 224 | chip->of_node = chip->dev->of_node; |
| 225 | |
| 226 | if (!chip->of_node) |
| 227 | return; |
| 228 | |
| 229 | if (!chip->of_xlate) { |
| 230 | chip->of_gpio_n_cells = 2; |
| 231 | chip->of_xlate = of_gpio_simple_xlate; |
| 232 | } |
| 233 | |
Shiraz Hashim | f23f151 | 2012-10-27 15:21:36 +0530 | [diff] [blame] | 234 | of_gpiochip_add_pin_range(chip); |
Anton Vorontsov | 391c970 | 2010-06-08 07:48:17 -0600 | [diff] [blame] | 235 | of_node_get(chip->of_node); |
| 236 | } |
| 237 | |
| 238 | void of_gpiochip_remove(struct gpio_chip *chip) |
| 239 | { |
Linus Walleij | e93fa3f | 2012-11-06 15:03:47 +0100 | [diff] [blame] | 240 | gpiochip_remove_pin_ranges(chip); |
Shiraz Hashim | f23f151 | 2012-10-27 15:21:36 +0530 | [diff] [blame] | 241 | |
Anton Vorontsov | 391c970 | 2010-06-08 07:48:17 -0600 | [diff] [blame] | 242 | if (chip->of_node) |
| 243 | of_node_put(chip->of_node); |
| 244 | } |