Commit | Line | Data |
---|---|---|
27038c3e | 1 | // SPDX-License-Identifier: GPL-2.0+ |
863fbf49 AV |
2 | /* |
3 | * OF helpers for the GPIO API | |
4 | * | |
5 | * Copyright (c) 2007-2008 MontaVista Software, Inc. | |
6 | * | |
7 | * Author: Anton Vorontsov <avorontsov@ru.mvista.com> | |
863fbf49 AV |
8 | */ |
9 | ||
2e13cba8 | 10 | #include <linux/device.h> |
bea4dbee | 11 | #include <linux/err.h> |
863fbf49 | 12 | #include <linux/errno.h> |
2e13cba8 | 13 | #include <linux/module.h> |
863fbf49 | 14 | #include <linux/io.h> |
af8b6375 | 15 | #include <linux/gpio/consumer.h> |
863fbf49 | 16 | #include <linux/of.h> |
2e13cba8 | 17 | #include <linux/of_address.h> |
863fbf49 | 18 | #include <linux/of_gpio.h> |
f23f1516 | 19 | #include <linux/pinctrl/pinctrl.h> |
2e13cba8 | 20 | #include <linux/slab.h> |
f625d460 | 21 | #include <linux/gpio/machine.h> |
863fbf49 | 22 | |
1bd6b601 | 23 | #include "gpiolib.h" |
f626d6df LW |
24 | #include "gpiolib-of.h" |
25 | ||
26 | /* | |
27 | * This is used by external users of of_gpio_count() from <linux/of_gpio.h> | |
28 | * | |
29 | * FIXME: get rid of those external users by converting them to GPIO | |
30 | * descriptors and let them all use gpiod_get_count() | |
31 | */ | |
32 | int of_gpio_get_count(struct device *dev, const char *con_id) | |
33 | { | |
34 | int ret; | |
35 | char propname[32]; | |
36 | unsigned int i; | |
37 | ||
38 | for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) { | |
39 | if (con_id) | |
40 | snprintf(propname, sizeof(propname), "%s-%s", | |
41 | con_id, gpio_suffixes[i]); | |
42 | else | |
43 | snprintf(propname, sizeof(propname), "%s", | |
44 | gpio_suffixes[i]); | |
45 | ||
46 | ret = of_gpio_named_count(dev->of_node, propname); | |
47 | if (ret > 0) | |
48 | break; | |
49 | } | |
50 | return ret ? ret : -ENOENT; | |
51 | } | |
af8b6375 | 52 | |
c7e9d398 | 53 | static int of_gpiochip_match_node_and_xlate(struct gpio_chip *chip, void *data) |
3d0f7cf0 | 54 | { |
c7e9d398 MY |
55 | struct of_phandle_args *gpiospec = data; |
56 | ||
57 | return chip->gpiodev->dev.of_node == gpiospec->np && | |
d49b48f0 | 58 | chip->of_xlate && |
c7e9d398 | 59 | chip->of_xlate(chip, gpiospec, NULL) >= 0; |
762c2e46 | 60 | } |
3d0f7cf0 | 61 | |
c7e9d398 MY |
62 | static struct gpio_chip *of_find_gpiochip_by_xlate( |
63 | struct of_phandle_args *gpiospec) | |
762c2e46 | 64 | { |
c7e9d398 | 65 | return gpiochip_find(gpiospec, of_gpiochip_match_node_and_xlate); |
3d0f7cf0 | 66 | } |
3d0f7cf0 | 67 | |
99468c1a MY |
68 | static struct gpio_desc *of_xlate_and_get_gpiod_flags(struct gpio_chip *chip, |
69 | struct of_phandle_args *gpiospec, | |
70 | enum of_gpio_flags *flags) | |
3d0f7cf0 | 71 | { |
3d0f7cf0 GL |
72 | int ret; |
73 | ||
99468c1a MY |
74 | if (chip->of_gpio_n_cells != gpiospec->args_count) |
75 | return ERR_PTR(-EINVAL); | |
76 | ||
77 | ret = chip->of_xlate(chip, gpiospec, flags); | |
78 | if (ret < 0) | |
79 | return ERR_PTR(ret); | |
80 | ||
81 | return gpiochip_get_desc(chip, ret); | |
3d0f7cf0 GL |
82 | } |
83 | ||
f626d6df LW |
84 | /** |
85 | * of_gpio_need_valid_mask() - figure out if the OF GPIO driver needs | |
86 | * to set the .valid_mask | |
87 | * @dev: the device for the GPIO provider | |
88 | * @return: true if the valid mask needs to be set | |
89 | */ | |
49281a22 | 90 | bool of_gpio_need_valid_mask(const struct gpio_chip *gc) |
f626d6df LW |
91 | { |
92 | int size; | |
93 | struct device_node *np = gc->of_node; | |
94 | ||
95 | size = of_property_count_u32_elems(np, "gpio-reserved-ranges"); | |
96 | if (size > 0 && size % 2 == 0) | |
97 | return true; | |
98 | return false; | |
99 | } | |
100 | ||
a603a2b8 | 101 | static void of_gpio_flags_quirks(struct device_node *np, |
89a5e15b | 102 | const char *propname, |
6953c57a LW |
103 | enum of_gpio_flags *flags, |
104 | int index) | |
a603a2b8 | 105 | { |
81c85ec1 LW |
106 | /* |
107 | * Handle MMC "cd-inverted" and "wp-inverted" semantics. | |
108 | */ | |
109 | if (IS_ENABLED(CONFIG_MMC)) { | |
89a5e15b LW |
110 | /* |
111 | * Active low is the default according to the | |
112 | * SDHCI specification and the device tree | |
113 | * bindings. However the code in the current | |
114 | * kernel was written such that the phandle | |
115 | * flags were always respected, and "cd-inverted" | |
116 | * would invert the flag from the device phandle. | |
117 | */ | |
118 | if (!strcmp(propname, "cd-gpios")) { | |
119 | if (of_property_read_bool(np, "cd-inverted")) | |
120 | *flags ^= OF_GPIO_ACTIVE_LOW; | |
81c85ec1 | 121 | } |
89a5e15b LW |
122 | if (!strcmp(propname, "wp-gpios")) { |
123 | if (of_property_read_bool(np, "wp-inverted")) | |
124 | *flags ^= OF_GPIO_ACTIVE_LOW; | |
81c85ec1 LW |
125 | } |
126 | } | |
a603a2b8 LW |
127 | /* |
128 | * Some GPIO fixed regulator quirks. | |
129 | * Note that active low is the default. | |
130 | */ | |
131 | if (IS_ENABLED(CONFIG_REGULATOR) && | |
906402a4 LW |
132 | (of_device_is_compatible(np, "regulator-fixed") || |
133 | of_device_is_compatible(np, "reg-fixed-voltage") || | |
a71a81e7 GU |
134 | (!(strcmp(propname, "enable-gpio") && |
135 | strcmp(propname, "enable-gpios")) && | |
136 | of_device_is_compatible(np, "regulator-gpio")))) { | |
a603a2b8 LW |
137 | /* |
138 | * The regulator GPIO handles are specified such that the | |
139 | * presence or absence of "enable-active-high" solely controls | |
140 | * the polarity of the GPIO line. Any phandle flags must | |
141 | * be actively ignored. | |
142 | */ | |
143 | if (*flags & OF_GPIO_ACTIVE_LOW) { | |
144 | pr_warn("%s GPIO handle specifies active low - ignored\n", | |
145 | of_node_full_name(np)); | |
146 | *flags &= ~OF_GPIO_ACTIVE_LOW; | |
147 | } | |
148 | if (!of_property_read_bool(np, "enable-active-high")) | |
149 | *flags |= OF_GPIO_ACTIVE_LOW; | |
150 | } | |
151 | /* | |
152 | * Legacy open drain handling for fixed voltage regulators. | |
153 | */ | |
154 | if (IS_ENABLED(CONFIG_REGULATOR) && | |
155 | of_device_is_compatible(np, "reg-fixed-voltage") && | |
156 | of_property_read_bool(np, "gpio-open-drain")) { | |
157 | *flags |= (OF_GPIO_SINGLE_ENDED | OF_GPIO_OPEN_DRAIN); | |
158 | pr_info("%s uses legacy open drain flag - update the DTS if you can\n", | |
159 | of_node_full_name(np)); | |
160 | } | |
6953c57a LW |
161 | |
162 | /* | |
163 | * Legacy handling of SPI active high chip select. If we have a | |
164 | * property named "cs-gpios" we need to inspect the child node | |
165 | * to determine if the flags should have inverted semantics. | |
166 | */ | |
da7f1349 | 167 | if (IS_ENABLED(CONFIG_SPI_MASTER) && !strcmp(propname, "cs-gpios") && |
a71a81e7 | 168 | of_property_read_bool(np, "cs-gpios")) { |
6953c57a LW |
169 | struct device_node *child; |
170 | u32 cs; | |
171 | int ret; | |
172 | ||
173 | for_each_child_of_node(np, child) { | |
174 | ret = of_property_read_u32(child, "reg", &cs); | |
c1c04cea | 175 | if (ret) |
6953c57a LW |
176 | continue; |
177 | if (cs == index) { | |
178 | /* | |
179 | * SPI children have active low chip selects | |
180 | * by default. This can be specified negatively | |
181 | * by just omitting "spi-cs-high" in the | |
182 | * device node, or actively by tagging on | |
183 | * GPIO_ACTIVE_LOW as flag in the device | |
184 | * tree. If the line is simultaneously | |
185 | * tagged as active low in the device tree | |
186 | * and has the "spi-cs-high" set, we get a | |
187 | * conflict and the "spi-cs-high" flag will | |
188 | * take precedence. | |
189 | */ | |
7ce40277 | 190 | if (of_property_read_bool(child, "spi-cs-high")) { |
6953c57a LW |
191 | if (*flags & OF_GPIO_ACTIVE_LOW) { |
192 | pr_warn("%s GPIO handle specifies active low - ignored\n", | |
7ce40277 | 193 | of_node_full_name(child)); |
6953c57a LW |
194 | *flags &= ~OF_GPIO_ACTIVE_LOW; |
195 | } | |
196 | } else { | |
197 | if (!(*flags & OF_GPIO_ACTIVE_LOW)) | |
198 | pr_info("%s enforce active low on chipselect handle\n", | |
7ce40277 | 199 | of_node_full_name(child)); |
6953c57a LW |
200 | *flags |= OF_GPIO_ACTIVE_LOW; |
201 | } | |
89fea04c | 202 | of_node_put(child); |
6953c57a LW |
203 | break; |
204 | } | |
205 | } | |
206 | } | |
edc1ef3f MB |
207 | |
208 | /* Legacy handling of stmmac's active-low PHY reset line */ | |
209 | if (IS_ENABLED(CONFIG_STMMAC_ETH) && | |
210 | !strcmp(propname, "snps,reset-gpio") && | |
211 | of_property_read_bool(np, "snps,reset-active-low")) | |
212 | *flags |= OF_GPIO_ACTIVE_LOW; | |
a603a2b8 LW |
213 | } |
214 | ||
863fbf49 | 215 | /** |
af8b6375 | 216 | * of_get_named_gpiod_flags() - Get a GPIO descriptor and flags for GPIO API |
863fbf49 | 217 | * @np: device node to get GPIO from |
a6b09191 | 218 | * @propname: property name containing gpio specifier(s) |
863fbf49 | 219 | * @index: index of the GPIO |
b908b53d | 220 | * @flags: a flags pointer to fill in |
863fbf49 | 221 | * |
af8b6375 | 222 | * Returns GPIO descriptor to use with Linux GPIO API, or one of the errno |
b908b53d AV |
223 | * value on the error condition. If @flags is not NULL the function also fills |
224 | * in flags for the GPIO. | |
863fbf49 | 225 | */ |
c83d3c77 | 226 | static struct gpio_desc *of_get_named_gpiod_flags(struct device_node *np, |
af8b6375 | 227 | const char *propname, int index, enum of_gpio_flags *flags) |
863fbf49 | 228 | { |
762c2e46 MY |
229 | struct of_phandle_args gpiospec; |
230 | struct gpio_chip *chip; | |
231 | struct gpio_desc *desc; | |
64b60e09 | 232 | int ret; |
3d0f7cf0 | 233 | |
c11e6f0f SB |
234 | ret = of_parse_phandle_with_args_map(np, propname, "gpio", index, |
235 | &gpiospec); | |
64b60e09 | 236 | if (ret) { |
7eb6ce2f RH |
237 | pr_debug("%s: can't parse '%s' property of node '%pOF[%d]'\n", |
238 | __func__, propname, np, index); | |
af8b6375 | 239 | return ERR_PTR(ret); |
863fbf49 AV |
240 | } |
241 | ||
c7e9d398 | 242 | chip = of_find_gpiochip_by_xlate(&gpiospec); |
762c2e46 MY |
243 | if (!chip) { |
244 | desc = ERR_PTR(-EPROBE_DEFER); | |
245 | goto out; | |
246 | } | |
762c2e46 | 247 | |
99468c1a | 248 | desc = of_xlate_and_get_gpiod_flags(chip, &gpiospec, flags); |
762c2e46 MY |
249 | if (IS_ERR(desc)) |
250 | goto out; | |
863fbf49 | 251 | |
605f2d34 | 252 | if (flags) |
89a5e15b | 253 | of_gpio_flags_quirks(np, propname, flags, index); |
a603a2b8 | 254 | |
7eb6ce2f RH |
255 | pr_debug("%s: parsed '%s' property of node '%pOF[%d]' - status (%d)\n", |
256 | __func__, propname, np, index, | |
762c2e46 MY |
257 | PTR_ERR_OR_ZERO(desc)); |
258 | ||
259 | out: | |
260 | of_node_put(gpiospec.np); | |
261 | ||
262 | return desc; | |
863fbf49 | 263 | } |
863fbf49 | 264 | |
f01d9075 AC |
265 | int of_get_named_gpio_flags(struct device_node *np, const char *list_name, |
266 | int index, enum of_gpio_flags *flags) | |
267 | { | |
268 | struct gpio_desc *desc; | |
269 | ||
270 | desc = of_get_named_gpiod_flags(np, list_name, index, flags); | |
271 | ||
272 | if (IS_ERR(desc)) | |
273 | return PTR_ERR(desc); | |
274 | else | |
275 | return desc_to_gpio(desc); | |
276 | } | |
6d662455 | 277 | EXPORT_SYMBOL_GPL(of_get_named_gpio_flags); |
f01d9075 | 278 | |
f626d6df LW |
279 | /** |
280 | * gpiod_get_from_of_node() - obtain a GPIO from an OF node | |
281 | * @node: handle of the OF node | |
282 | * @propname: name of the DT property representing the GPIO | |
283 | * @index: index of the GPIO to obtain for the consumer | |
284 | * @dflags: GPIO initialization flags | |
285 | * @label: label to attach to the requested GPIO | |
286 | * | |
287 | * Returns: | |
288 | * On successful request the GPIO pin is configured in accordance with | |
289 | * provided @dflags. | |
290 | * | |
291 | * In case of error an ERR_PTR() is returned. | |
292 | */ | |
293 | struct gpio_desc *gpiod_get_from_of_node(struct device_node *node, | |
294 | const char *propname, int index, | |
295 | enum gpiod_flags dflags, | |
296 | const char *label) | |
297 | { | |
298 | unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT; | |
299 | struct gpio_desc *desc; | |
300 | enum of_gpio_flags flags; | |
301 | bool active_low = false; | |
302 | bool single_ended = false; | |
303 | bool open_drain = false; | |
304 | bool transitory = false; | |
305 | int ret; | |
306 | ||
307 | desc = of_get_named_gpiod_flags(node, propname, | |
308 | index, &flags); | |
309 | ||
310 | if (!desc || IS_ERR(desc)) { | |
311 | return desc; | |
312 | } | |
313 | ||
314 | active_low = flags & OF_GPIO_ACTIVE_LOW; | |
315 | single_ended = flags & OF_GPIO_SINGLE_ENDED; | |
316 | open_drain = flags & OF_GPIO_OPEN_DRAIN; | |
317 | transitory = flags & OF_GPIO_TRANSITORY; | |
318 | ||
319 | ret = gpiod_request(desc, label); | |
320 | if (ret == -EBUSY && (flags & GPIOD_FLAGS_BIT_NONEXCLUSIVE)) | |
321 | return desc; | |
322 | if (ret) | |
323 | return ERR_PTR(ret); | |
324 | ||
325 | if (active_low) | |
326 | lflags |= GPIO_ACTIVE_LOW; | |
327 | ||
328 | if (single_ended) { | |
329 | if (open_drain) | |
330 | lflags |= GPIO_OPEN_DRAIN; | |
331 | else | |
332 | lflags |= GPIO_OPEN_SOURCE; | |
333 | } | |
334 | ||
335 | if (transitory) | |
336 | lflags |= GPIO_TRANSITORY; | |
337 | ||
338 | ret = gpiod_configure_flags(desc, propname, lflags, dflags); | |
339 | if (ret < 0) { | |
340 | gpiod_put(desc); | |
341 | return ERR_PTR(ret); | |
342 | } | |
343 | ||
344 | return desc; | |
345 | } | |
6d662455 | 346 | EXPORT_SYMBOL_GPL(gpiod_get_from_of_node); |
f01d9075 | 347 | |
c8582339 LW |
348 | /* |
349 | * The SPI GPIO bindings happened before we managed to establish that GPIO | |
350 | * properties should be named "foo-gpios" so we have this special kludge for | |
351 | * them. | |
352 | */ | |
353 | static struct gpio_desc *of_find_spi_gpio(struct device *dev, const char *con_id, | |
354 | enum of_gpio_flags *of_flags) | |
355 | { | |
356 | char prop_name[32]; /* 32 is max size of property name */ | |
357 | struct device_node *np = dev->of_node; | |
358 | struct gpio_desc *desc; | |
359 | ||
360 | /* | |
361 | * Hopefully the compiler stubs the rest of the function if this | |
362 | * is false. | |
363 | */ | |
364 | if (!IS_ENABLED(CONFIG_SPI_MASTER)) | |
365 | return ERR_PTR(-ENOENT); | |
366 | ||
367 | /* Allow this specifically for "spi-gpio" devices */ | |
368 | if (!of_device_is_compatible(np, "spi-gpio") || !con_id) | |
369 | return ERR_PTR(-ENOENT); | |
370 | ||
371 | /* Will be "gpio-sck", "gpio-mosi" or "gpio-miso" */ | |
372 | snprintf(prop_name, sizeof(prop_name), "%s-%s", "gpio", con_id); | |
373 | ||
374 | desc = of_get_named_gpiod_flags(np, prop_name, 0, of_flags); | |
375 | return desc; | |
376 | } | |
377 | ||
e3023bf8 LW |
378 | /* |
379 | * The old Freescale bindings use simply "gpios" as name for the chip select | |
380 | * lines rather than "cs-gpios" like all other SPI hardware. Account for this | |
381 | * with a special quirk. | |
382 | */ | |
383 | static struct gpio_desc *of_find_spi_cs_gpio(struct device *dev, | |
384 | const char *con_id, | |
385 | unsigned int idx, | |
386 | unsigned long *flags) | |
387 | { | |
388 | struct device_node *np = dev->of_node; | |
389 | ||
390 | if (!IS_ENABLED(CONFIG_SPI_MASTER)) | |
391 | return ERR_PTR(-ENOENT); | |
392 | ||
393 | /* Allow this specifically for Freescale devices */ | |
394 | if (!of_device_is_compatible(np, "fsl,spi") && | |
395 | !of_device_is_compatible(np, "aeroflexgaisler,spictrl")) | |
396 | return ERR_PTR(-ENOENT); | |
397 | /* Allow only if asking for "cs-gpios" */ | |
398 | if (!con_id || strcmp(con_id, "cs")) | |
399 | return ERR_PTR(-ENOENT); | |
400 | ||
401 | /* | |
402 | * While all other SPI controllers use "cs-gpios" the Freescale | |
403 | * uses just "gpios" so translate to that when "cs-gpios" is | |
404 | * requested. | |
405 | */ | |
406 | return of_find_gpio(dev, NULL, idx, flags); | |
407 | } | |
408 | ||
6a537d48 LW |
409 | /* |
410 | * Some regulator bindings happened before we managed to establish that GPIO | |
411 | * properties should be named "foo-gpios" so we have this special kludge for | |
412 | * them. | |
413 | */ | |
414 | static struct gpio_desc *of_find_regulator_gpio(struct device *dev, const char *con_id, | |
415 | enum of_gpio_flags *of_flags) | |
416 | { | |
417 | /* These are the connection IDs we accept as legacy GPIO phandles */ | |
418 | const char *whitelist[] = { | |
419 | "wlf,ldoena", /* Arizona */ | |
420 | "wlf,ldo1ena", /* WM8994 */ | |
421 | "wlf,ldo2ena", /* WM8994 */ | |
422 | }; | |
423 | struct device_node *np = dev->of_node; | |
424 | struct gpio_desc *desc; | |
425 | int i; | |
426 | ||
427 | if (!IS_ENABLED(CONFIG_REGULATOR)) | |
428 | return ERR_PTR(-ENOENT); | |
429 | ||
430 | if (!con_id) | |
431 | return ERR_PTR(-ENOENT); | |
432 | ||
4b21f94a AS |
433 | i = match_string(whitelist, ARRAY_SIZE(whitelist), con_id); |
434 | if (i < 0) | |
6a537d48 LW |
435 | return ERR_PTR(-ENOENT); |
436 | ||
437 | desc = of_get_named_gpiod_flags(np, con_id, 0, of_flags); | |
438 | return desc; | |
439 | } | |
440 | ||
11c43bb0 DT |
441 | static struct gpio_desc *of_find_arizona_gpio(struct device *dev, |
442 | const char *con_id, | |
443 | enum of_gpio_flags *of_flags) | |
444 | { | |
445 | if (!IS_ENABLED(CONFIG_MFD_ARIZONA)) | |
446 | return ERR_PTR(-ENOENT); | |
447 | ||
448 | if (!con_id || strcmp(con_id, "wlf,reset")) | |
449 | return ERR_PTR(-ENOENT); | |
450 | ||
451 | return of_get_named_gpiod_flags(dev->of_node, con_id, 0, of_flags); | |
452 | } | |
453 | ||
ea713bc4 | 454 | struct gpio_desc *of_find_gpio(struct device *dev, const char *con_id, |
fed7026a | 455 | unsigned int idx, unsigned long *flags) |
ea713bc4 LW |
456 | { |
457 | char prop_name[32]; /* 32 is max size of property name */ | |
458 | enum of_gpio_flags of_flags; | |
459 | struct gpio_desc *desc; | |
460 | unsigned int i; | |
461 | ||
c8582339 | 462 | /* Try GPIO property "foo-gpios" and "foo-gpio" */ |
ea713bc4 LW |
463 | for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) { |
464 | if (con_id) | |
465 | snprintf(prop_name, sizeof(prop_name), "%s-%s", con_id, | |
466 | gpio_suffixes[i]); | |
467 | else | |
468 | snprintf(prop_name, sizeof(prop_name), "%s", | |
469 | gpio_suffixes[i]); | |
470 | ||
471 | desc = of_get_named_gpiod_flags(dev->of_node, prop_name, idx, | |
472 | &of_flags); | |
6662ae6a | 473 | |
1dea33e8 | 474 | if (!IS_ERR(desc) || PTR_ERR(desc) != -ENOENT) |
ea713bc4 LW |
475 | break; |
476 | } | |
477 | ||
1dea33e8 DT |
478 | if (IS_ERR(desc) && PTR_ERR(desc) == -ENOENT) { |
479 | /* Special handling for SPI GPIOs if used */ | |
c8582339 | 480 | desc = of_find_spi_gpio(dev, con_id, &of_flags); |
1dea33e8 DT |
481 | } |
482 | ||
483 | if (IS_ERR(desc) && PTR_ERR(desc) == -ENOENT) { | |
e3023bf8 LW |
484 | /* This quirk looks up flags and all */ |
485 | desc = of_find_spi_cs_gpio(dev, con_id, idx, flags); | |
486 | if (!IS_ERR(desc)) | |
487 | return desc; | |
488 | } | |
c8582339 | 489 | |
1dea33e8 DT |
490 | if (IS_ERR(desc) && PTR_ERR(desc) == -ENOENT) { |
491 | /* Special handling for regulator GPIOs if used */ | |
6a537d48 | 492 | desc = of_find_regulator_gpio(dev, con_id, &of_flags); |
1dea33e8 | 493 | } |
6a537d48 | 494 | |
11c43bb0 DT |
495 | if (IS_ERR(desc) && PTR_ERR(desc) == -ENOENT) |
496 | desc = of_find_arizona_gpio(dev, con_id, &of_flags); | |
497 | ||
ea713bc4 LW |
498 | if (IS_ERR(desc)) |
499 | return desc; | |
500 | ||
501 | if (of_flags & OF_GPIO_ACTIVE_LOW) | |
502 | *flags |= GPIO_ACTIVE_LOW; | |
503 | ||
504 | if (of_flags & OF_GPIO_SINGLE_ENDED) { | |
4c0facdd | 505 | if (of_flags & OF_GPIO_OPEN_DRAIN) |
ea713bc4 LW |
506 | *flags |= GPIO_OPEN_DRAIN; |
507 | else | |
508 | *flags |= GPIO_OPEN_SOURCE; | |
509 | } | |
510 | ||
e10f72bf AJ |
511 | if (of_flags & OF_GPIO_TRANSITORY) |
512 | *flags |= GPIO_TRANSITORY; | |
05f479bf | 513 | |
d449991c TP |
514 | if (of_flags & OF_GPIO_PULL_UP) |
515 | *flags |= GPIO_PULL_UP; | |
516 | if (of_flags & OF_GPIO_PULL_DOWN) | |
517 | *flags |= GPIO_PULL_DOWN; | |
518 | ||
ea713bc4 LW |
519 | return desc; |
520 | } | |
521 | ||
f625d460 | 522 | /** |
fd7337fd | 523 | * of_parse_own_gpio() - Get a GPIO hog descriptor, names and flags for GPIO API |
f625d460 | 524 | * @np: device node to get GPIO from |
be715343 | 525 | * @chip: GPIO chip whose hog is parsed |
a79fead5 | 526 | * @idx: Index of the GPIO to parse |
f625d460 | 527 | * @name: GPIO line name |
fed7026a AS |
528 | * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from |
529 | * of_find_gpio() or of_parse_own_gpio() | |
f625d460 BP |
530 | * @dflags: gpiod_flags - optional GPIO initialization flags |
531 | * | |
532 | * Returns GPIO descriptor to use with Linux GPIO API, or one of the errno | |
533 | * value on the error condition. | |
534 | */ | |
fd7337fd | 535 | static struct gpio_desc *of_parse_own_gpio(struct device_node *np, |
be715343 | 536 | struct gpio_chip *chip, |
a79fead5 | 537 | unsigned int idx, const char **name, |
fed7026a | 538 | unsigned long *lflags, |
fd7337fd | 539 | enum gpiod_flags *dflags) |
f625d460 BP |
540 | { |
541 | struct device_node *chip_np; | |
542 | enum of_gpio_flags xlate_flags; | |
be715343 MY |
543 | struct of_phandle_args gpiospec; |
544 | struct gpio_desc *desc; | |
a79fead5 | 545 | unsigned int i; |
f625d460 | 546 | u32 tmp; |
3f9547e1 | 547 | int ret; |
f625d460 | 548 | |
be715343 | 549 | chip_np = chip->of_node; |
f625d460 BP |
550 | if (!chip_np) |
551 | return ERR_PTR(-EINVAL); | |
552 | ||
553 | xlate_flags = 0; | |
2d6c06f5 | 554 | *lflags = GPIO_LOOKUP_FLAGS_DEFAULT; |
f625d460 BP |
555 | *dflags = 0; |
556 | ||
557 | ret = of_property_read_u32(chip_np, "#gpio-cells", &tmp); | |
558 | if (ret) | |
559 | return ERR_PTR(ret); | |
560 | ||
be715343 MY |
561 | gpiospec.np = chip_np; |
562 | gpiospec.args_count = tmp; | |
f625d460 | 563 | |
a79fead5 GU |
564 | for (i = 0; i < tmp; i++) { |
565 | ret = of_property_read_u32_index(np, "gpios", idx * tmp + i, | |
566 | &gpiospec.args[i]); | |
567 | if (ret) | |
568 | return ERR_PTR(ret); | |
569 | } | |
f625d460 | 570 | |
99468c1a | 571 | desc = of_xlate_and_get_gpiod_flags(chip, &gpiospec, &xlate_flags); |
be715343 MY |
572 | if (IS_ERR(desc)) |
573 | return desc; | |
f625d460 BP |
574 | |
575 | if (xlate_flags & OF_GPIO_ACTIVE_LOW) | |
576 | *lflags |= GPIO_ACTIVE_LOW; | |
e10f72bf AJ |
577 | if (xlate_flags & OF_GPIO_TRANSITORY) |
578 | *lflags |= GPIO_TRANSITORY; | |
f625d460 BP |
579 | |
580 | if (of_property_read_bool(np, "input")) | |
581 | *dflags |= GPIOD_IN; | |
582 | else if (of_property_read_bool(np, "output-low")) | |
583 | *dflags |= GPIOD_OUT_LOW; | |
584 | else if (of_property_read_bool(np, "output-high")) | |
585 | *dflags |= GPIOD_OUT_HIGH; | |
586 | else { | |
62cdcb6c RH |
587 | pr_warn("GPIO line %d (%pOFn): no hogging state specified, bailing out\n", |
588 | desc_to_gpio(desc), np); | |
f625d460 BP |
589 | return ERR_PTR(-EINVAL); |
590 | } | |
591 | ||
592 | if (name && of_property_read_string(np, "line-name", name)) | |
593 | *name = np->name; | |
594 | ||
be715343 | 595 | return desc; |
f625d460 BP |
596 | } |
597 | ||
598 | /** | |
fd7337fd | 599 | * of_gpiochip_scan_gpios - Scan gpio-controller for gpio definitions |
f625d460 BP |
600 | * @chip: gpio chip to act on |
601 | * | |
602 | * This is only used by of_gpiochip_add to request/set GPIO initial | |
603 | * configuration. | |
ead066e6 | 604 | * It returns error if it fails otherwise 0 on success. |
f625d460 | 605 | */ |
dfbd379b | 606 | static int of_gpiochip_scan_gpios(struct gpio_chip *chip) |
f625d460 BP |
607 | { |
608 | struct gpio_desc *desc = NULL; | |
609 | struct device_node *np; | |
610 | const char *name; | |
fed7026a | 611 | unsigned long lflags; |
f625d460 | 612 | enum gpiod_flags dflags; |
a79fead5 | 613 | unsigned int i; |
dfbd379b | 614 | int ret; |
f625d460 | 615 | |
d1279d94 | 616 | for_each_available_child_of_node(chip->of_node, np) { |
f625d460 BP |
617 | if (!of_property_read_bool(np, "gpio-hog")) |
618 | continue; | |
619 | ||
a79fead5 GU |
620 | for (i = 0;; i++) { |
621 | desc = of_parse_own_gpio(np, chip, i, &name, &lflags, | |
622 | &dflags); | |
623 | if (IS_ERR(desc)) | |
624 | break; | |
625 | ||
626 | ret = gpiod_hog(desc, name, lflags, dflags); | |
627 | if (ret < 0) { | |
628 | of_node_put(np); | |
629 | return ret; | |
630 | } | |
09e258af | 631 | } |
f625d460 | 632 | } |
dfbd379b LD |
633 | |
634 | return 0; | |
f625d460 BP |
635 | } |
636 | ||
863fbf49 | 637 | /** |
67049c50 | 638 | * of_gpio_simple_xlate - translate gpiospec to the GPIO number and flags |
a19e3da5 | 639 | * @gc: pointer to the gpio_chip structure |
67049c50 | 640 | * @gpiospec: GPIO specifier as found in the device tree |
b908b53d | 641 | * @flags: a flags pointer to fill in |
863fbf49 AV |
642 | * |
643 | * This is simple translation function, suitable for the most 1:1 mapped | |
67049c50 | 644 | * GPIO chips. This function performs only one sanity check: whether GPIO |
863fbf49 AV |
645 | * is less than ngpios (that is specified in the gpio_chip). |
646 | */ | |
b0c7e73b GU |
647 | static int of_gpio_simple_xlate(struct gpio_chip *gc, |
648 | const struct of_phandle_args *gpiospec, | |
649 | u32 *flags) | |
863fbf49 | 650 | { |
b908b53d AV |
651 | /* |
652 | * We're discouraging gpio_cells < 2, since that way you'll have to | |
20a8a968 | 653 | * write your own xlate function (that will have to retrieve the GPIO |
b908b53d AV |
654 | * number and the flags from a single gpio cell -- this is possible, |
655 | * but not recommended). | |
656 | */ | |
a19e3da5 | 657 | if (gc->of_gpio_n_cells < 2) { |
b908b53d AV |
658 | WARN_ON(1); |
659 | return -EINVAL; | |
660 | } | |
661 | ||
15c9a0ac GL |
662 | if (WARN_ON(gpiospec->args_count < gc->of_gpio_n_cells)) |
663 | return -EINVAL; | |
664 | ||
6270d830 | 665 | if (gpiospec->args[0] >= gc->ngpio) |
863fbf49 AV |
666 | return -EINVAL; |
667 | ||
b908b53d | 668 | if (flags) |
15c9a0ac | 669 | *flags = gpiospec->args[1]; |
b908b53d | 670 | |
15c9a0ac | 671 | return gpiospec->args[0]; |
863fbf49 | 672 | } |
863fbf49 | 673 | |
863fbf49 | 674 | /** |
3208b0f0 | 675 | * of_mm_gpiochip_add_data - Add memory mapped GPIO chip (bank) |
863fbf49 AV |
676 | * @np: device node of the GPIO chip |
677 | * @mm_gc: pointer to the of_mm_gpio_chip allocated structure | |
3208b0f0 | 678 | * @data: driver data to store in the struct gpio_chip |
863fbf49 AV |
679 | * |
680 | * To use this function you should allocate and fill mm_gc with: | |
681 | * | |
682 | * 1) In the gpio_chip structure: | |
683 | * - all the callbacks | |
a19e3da5 AV |
684 | * - of_gpio_n_cells |
685 | * - of_xlate callback (optional) | |
863fbf49 AV |
686 | * |
687 | * 3) In the of_mm_gpio_chip structure: | |
688 | * - save_regs callback (optional) | |
689 | * | |
690 | * If succeeded, this function will map bank's memory and will | |
691 | * do all necessary work for you. Then you'll able to use .regs | |
692 | * to manage GPIOs from the callbacks. | |
693 | */ | |
3208b0f0 LW |
694 | int of_mm_gpiochip_add_data(struct device_node *np, |
695 | struct of_mm_gpio_chip *mm_gc, | |
696 | void *data) | |
863fbf49 AV |
697 | { |
698 | int ret = -ENOMEM; | |
a19e3da5 | 699 | struct gpio_chip *gc = &mm_gc->gc; |
863fbf49 | 700 | |
7eb6ce2f | 701 | gc->label = kasprintf(GFP_KERNEL, "%pOF", np); |
863fbf49 AV |
702 | if (!gc->label) |
703 | goto err0; | |
704 | ||
705 | mm_gc->regs = of_iomap(np, 0); | |
706 | if (!mm_gc->regs) | |
707 | goto err1; | |
708 | ||
21451155 | 709 | gc->base = -1; |
863fbf49 | 710 | |
863fbf49 AV |
711 | if (mm_gc->save_regs) |
712 | mm_gc->save_regs(mm_gc); | |
713 | ||
a19e3da5 | 714 | mm_gc->gc.of_node = np; |
863fbf49 | 715 | |
3208b0f0 | 716 | ret = gpiochip_add_data(gc, data); |
863fbf49 AV |
717 | if (ret) |
718 | goto err2; | |
719 | ||
863fbf49 AV |
720 | return 0; |
721 | err2: | |
863fbf49 AV |
722 | iounmap(mm_gc->regs); |
723 | err1: | |
724 | kfree(gc->label); | |
725 | err0: | |
7eb6ce2f | 726 | pr_err("%pOF: GPIO chip registration failed with status %d\n", np, ret); |
863fbf49 AV |
727 | return ret; |
728 | } | |
6d662455 | 729 | EXPORT_SYMBOL_GPL(of_mm_gpiochip_add_data); |
594fa265 | 730 | |
d621e8ba RRD |
731 | /** |
732 | * of_mm_gpiochip_remove - Remove memory mapped GPIO chip (bank) | |
733 | * @mm_gc: pointer to the of_mm_gpio_chip allocated structure | |
734 | */ | |
735 | void of_mm_gpiochip_remove(struct of_mm_gpio_chip *mm_gc) | |
736 | { | |
737 | struct gpio_chip *gc = &mm_gc->gc; | |
738 | ||
739 | if (!mm_gc) | |
740 | return; | |
741 | ||
742 | gpiochip_remove(gc); | |
743 | iounmap(mm_gc->regs); | |
744 | kfree(gc->label); | |
745 | } | |
6d662455 | 746 | EXPORT_SYMBOL_GPL(of_mm_gpiochip_remove); |
d621e8ba | 747 | |
726cb3ba SB |
748 | static void of_gpiochip_init_valid_mask(struct gpio_chip *chip) |
749 | { | |
750 | int len, i; | |
751 | u32 start, count; | |
752 | struct device_node *np = chip->of_node; | |
753 | ||
754 | len = of_property_count_u32_elems(np, "gpio-reserved-ranges"); | |
755 | if (len < 0 || len % 2 != 0) | |
756 | return; | |
757 | ||
758 | for (i = 0; i < len; i += 2) { | |
759 | of_property_read_u32_index(np, "gpio-reserved-ranges", | |
760 | i, &start); | |
761 | of_property_read_u32_index(np, "gpio-reserved-ranges", | |
762 | i + 1, &count); | |
763 | if (start >= chip->ngpio || start + count >= chip->ngpio) | |
764 | continue; | |
765 | ||
766 | bitmap_clear(chip->valid_mask, start, count); | |
767 | } | |
768 | }; | |
769 | ||
f23f1516 | 770 | #ifdef CONFIG_PINCTRL |
28355f81 | 771 | static int of_gpiochip_add_pin_range(struct gpio_chip *chip) |
f23f1516 SH |
772 | { |
773 | struct device_node *np = chip->of_node; | |
f23f1516 | 774 | struct of_phandle_args pinspec; |
1e63d7b9 | 775 | struct pinctrl_dev *pctldev; |
f23f1516 | 776 | int index = 0, ret; |
586a87e6 CR |
777 | const char *name; |
778 | static const char group_names_propname[] = "gpio-ranges-group-names"; | |
779 | struct property *group_names; | |
f23f1516 SH |
780 | |
781 | if (!np) | |
28355f81 | 782 | return 0; |
f23f1516 | 783 | |
586a87e6 CR |
784 | group_names = of_find_property(np, group_names_propname, NULL); |
785 | ||
ad4e1a7c | 786 | for (;; index++) { |
d9fe0039 SW |
787 | ret = of_parse_phandle_with_fixed_args(np, "gpio-ranges", 3, |
788 | index, &pinspec); | |
f23f1516 SH |
789 | if (ret) |
790 | break; | |
791 | ||
1e63d7b9 | 792 | pctldev = of_pinctrl_get(pinspec.np); |
602cf638 | 793 | of_node_put(pinspec.np); |
1e63d7b9 | 794 | if (!pctldev) |
28355f81 | 795 | return -EPROBE_DEFER; |
f23f1516 | 796 | |
586a87e6 CR |
797 | if (pinspec.args[2]) { |
798 | if (group_names) { | |
72858602 | 799 | of_property_read_string_index(np, |
586a87e6 CR |
800 | group_names_propname, |
801 | index, &name); | |
802 | if (strlen(name)) { | |
7eb6ce2f RH |
803 | pr_err("%pOF: Group name of numeric GPIO ranges must be the empty string.\n", |
804 | np); | |
586a87e6 CR |
805 | break; |
806 | } | |
807 | } | |
808 | /* npins != 0: linear range */ | |
809 | ret = gpiochip_add_pin_range(chip, | |
810 | pinctrl_dev_get_devname(pctldev), | |
811 | pinspec.args[0], | |
812 | pinspec.args[1], | |
813 | pinspec.args[2]); | |
814 | if (ret) | |
28355f81 | 815 | return ret; |
586a87e6 CR |
816 | } else { |
817 | /* npins == 0: special range */ | |
818 | if (pinspec.args[1]) { | |
7eb6ce2f RH |
819 | pr_err("%pOF: Illegal gpio-range format.\n", |
820 | np); | |
586a87e6 CR |
821 | break; |
822 | } | |
823 | ||
824 | if (!group_names) { | |
7eb6ce2f RH |
825 | pr_err("%pOF: GPIO group range requested but no %s property.\n", |
826 | np, group_names_propname); | |
586a87e6 CR |
827 | break; |
828 | } | |
829 | ||
830 | ret = of_property_read_string_index(np, | |
831 | group_names_propname, | |
832 | index, &name); | |
833 | if (ret) | |
834 | break; | |
835 | ||
836 | if (!strlen(name)) { | |
7eb6ce2f RH |
837 | pr_err("%pOF: Group name of GPIO group range cannot be the empty string.\n", |
838 | np); | |
586a87e6 CR |
839 | break; |
840 | } | |
841 | ||
842 | ret = gpiochip_add_pingroup_range(chip, pctldev, | |
843 | pinspec.args[0], name); | |
844 | if (ret) | |
28355f81 | 845 | return ret; |
586a87e6 | 846 | } |
ad4e1a7c | 847 | } |
28355f81 TV |
848 | |
849 | return 0; | |
f23f1516 SH |
850 | } |
851 | ||
f23f1516 | 852 | #else |
28355f81 | 853 | static int of_gpiochip_add_pin_range(struct gpio_chip *chip) { return 0; } |
f23f1516 SH |
854 | #endif |
855 | ||
28355f81 | 856 | int of_gpiochip_add(struct gpio_chip *chip) |
391c970c | 857 | { |
f0d1ab05 | 858 | int ret; |
28355f81 | 859 | |
391c970c | 860 | if (!chip->of_node) |
28355f81 | 861 | return 0; |
391c970c AV |
862 | |
863 | if (!chip->of_xlate) { | |
864 | chip->of_gpio_n_cells = 2; | |
865 | chip->of_xlate = of_gpio_simple_xlate; | |
866 | } | |
867 | ||
1020dfd1 MY |
868 | if (chip->of_gpio_n_cells > MAX_PHANDLE_ARGS) |
869 | return -EINVAL; | |
870 | ||
726cb3ba SB |
871 | of_gpiochip_init_valid_mask(chip); |
872 | ||
f0d1ab05 LW |
873 | ret = of_gpiochip_add_pin_range(chip); |
874 | if (ret) | |
875 | return ret; | |
28355f81 | 876 | |
fd9c5531 LW |
877 | /* If the chip defines names itself, these take precedence */ |
878 | if (!chip->names) | |
82270335 CL |
879 | devprop_gpiochip_set_names(chip, |
880 | of_fwnode_handle(chip->of_node)); | |
fd9c5531 | 881 | |
391c970c | 882 | of_node_get(chip->of_node); |
f625d460 | 883 | |
f0d1ab05 LW |
884 | ret = of_gpiochip_scan_gpios(chip); |
885 | if (ret) { | |
f7299d44 GU |
886 | of_node_put(chip->of_node); |
887 | gpiochip_remove_pin_ranges(chip); | |
888 | } | |
889 | ||
f0d1ab05 | 890 | return ret; |
391c970c AV |
891 | } |
892 | ||
893 | void of_gpiochip_remove(struct gpio_chip *chip) | |
894 | { | |
e93fa3f2 | 895 | gpiochip_remove_pin_ranges(chip); |
8a691550 | 896 | of_node_put(chip->of_node); |
391c970c | 897 | } |