2 * Copyright (c) 2013 Google, Inc
4 * SPDX-License-Identifier: GPL-2.0+
13 #include <linux/ctype.h>
15 DECLARE_GLOBAL_DATA_PTR;
18 * gpio_to_device() - Convert global GPIO number to device, number
20 * Convert the GPIO number to an entry in the list of GPIOs
21 * or GPIO blocks registered with the GPIO controller. Returns
22 * entry on success, NULL on error.
24 * @gpio: The numeric representation of the GPIO
25 * @desc: Returns description (desc->flags will always be 0)
26 * @return 0 if found, -ENOENT if not found
28 static int gpio_to_device(unsigned int gpio, struct gpio_desc *desc)
30 struct gpio_dev_priv *uc_priv;
34 for (ret = uclass_first_device(UCLASS_GPIO, &dev);
36 ret = uclass_next_device(&dev)) {
37 uc_priv = dev->uclass_priv;
38 if (gpio >= uc_priv->gpio_base &&
39 gpio < uc_priv->gpio_base + uc_priv->gpio_count) {
41 desc->offset = gpio - uc_priv->gpio_base;
48 return ret ? ret : -ENOENT;
51 int gpio_lookup_name(const char *name, struct udevice **devp,
52 unsigned int *offsetp, unsigned int *gpiop)
54 struct gpio_dev_priv *uc_priv = NULL;
62 numeric = isdigit(*name) ? simple_strtoul(name, NULL, 10) : -1;
63 for (ret = uclass_first_device(UCLASS_GPIO, &dev);
65 ret = uclass_next_device(&dev)) {
68 uc_priv = dev->uclass_priv;
70 offset = numeric - uc_priv->gpio_base;
71 /* Allow GPIOs to be numbered from 0 */
72 if (offset >= 0 && offset < uc_priv->gpio_count)
76 len = uc_priv->bank_name ? strlen(uc_priv->bank_name) : 0;
78 if (!strncasecmp(name, uc_priv->bank_name, len)) {
79 if (!strict_strtoul(name + len, 10, &offset))
85 return ret ? ret : -EINVAL;
92 *gpiop = uc_priv->gpio_base + offset;
97 static int gpio_find_and_xlate(struct gpio_desc *desc,
98 struct fdtdec_phandle_args *args)
100 struct dm_gpio_ops *ops = gpio_get_ops(desc->dev);
102 /* Use the first argument as the offset by default */
103 if (args->args_count > 0)
104 desc->offset = args->args[0];
109 return ops->xlate ? ops->xlate(desc->dev, desc, args) : 0;
112 static int dm_gpio_request(struct gpio_desc *desc, const char *label)
114 struct udevice *dev = desc->dev;
115 struct gpio_dev_priv *uc_priv;
119 uc_priv = dev->uclass_priv;
120 if (uc_priv->name[desc->offset])
125 if (gpio_get_ops(dev)->request) {
126 ret = gpio_get_ops(dev)->request(dev, desc->offset, label);
132 uc_priv->name[desc->offset] = str;
137 static int dm_gpio_requestf(struct gpio_desc *desc, const char *fmt, ...)
143 vscnprintf(buf, sizeof(buf), fmt, args);
145 return dm_gpio_request(desc, buf);
149 * gpio_request() - [COMPAT] Request GPIO
151 * label: Name for the requested GPIO
153 * The label is copied and allocated so the caller does not need to keep
154 * the pointer around.
156 * This function implements the API that's compatible with current
157 * GPIO API used in U-Boot. The request is forwarded to particular
158 * GPIO driver. Returns 0 on success, negative value on error.
160 int gpio_request(unsigned gpio, const char *label)
162 struct gpio_desc desc;
165 ret = gpio_to_device(gpio, &desc);
169 return dm_gpio_request(&desc, label);
173 * gpio_requestf() - [COMPAT] Request GPIO
175 * @fmt: Format string for the requested GPIO
176 * @...: Arguments for the printf() format string
178 * This function implements the API that's compatible with current
179 * GPIO API used in U-Boot. The request is forwarded to particular
180 * GPIO driver. Returns 0 on success, negative value on error.
182 int gpio_requestf(unsigned gpio, const char *fmt, ...)
188 vscnprintf(buf, sizeof(buf), fmt, args);
190 return gpio_request(gpio, buf);
193 int gpio_request_one(unsigned int gpio, enum gpio_flags flags,
198 ret = gpio_request(gpio, label);
202 if (flags == GPIOFLAG_INPUT)
203 gpio_direction_input(gpio);
204 else if (flags == GPIOFLAG_OUTPUT_INIT_LOW)
205 gpio_direction_output(gpio, 0);
206 else if (flags == GPIOFLAG_OUTPUT_INIT_HIGH)
207 gpio_direction_output(gpio, 1);
212 int gpio_request_array(const struct gpio *gpios, int count)
217 for (i = 0; i < count; i++) {
218 ret = gpio_request_one(gpios[i].gpio, gpios[i].flags,
221 printf("Failed to request GPIO%d (%u of %u): %d\n",
222 gpios[i].gpio, i, count, ret);
230 gpio_free(gpios[i].gpio);
235 int _dm_gpio_free(struct udevice *dev, uint offset)
237 struct gpio_dev_priv *uc_priv;
240 uc_priv = dev->uclass_priv;
241 if (!uc_priv->name[offset])
243 if (gpio_get_ops(dev)->free) {
244 ret = gpio_get_ops(dev)->free(dev, offset);
249 free(uc_priv->name[offset]);
250 uc_priv->name[offset] = NULL;
255 int gpio_free_array(const struct gpio *gpios, int count)
260 for (i = 0; i < count; i++)
261 ret |= gpio_free(gpios[i].gpio);
267 * gpio_free() - [COMPAT] Relinquish GPIO
270 * This function implements the API that's compatible with current
271 * GPIO API used in U-Boot. The request is forwarded to particular
272 * GPIO driver. Returns 0 on success, negative value on error.
274 int gpio_free(unsigned gpio)
276 struct gpio_desc desc;
279 ret = gpio_to_device(gpio, &desc);
283 return _dm_gpio_free(desc.dev, desc.offset);
286 static int check_reserved(struct gpio_desc *desc, const char *func)
288 struct gpio_dev_priv *uc_priv = desc->dev->uclass_priv;
290 if (!uc_priv->name[desc->offset]) {
291 printf("%s: %s: error: gpio %s%d not reserved\n",
292 desc->dev->name, func,
293 uc_priv->bank_name ? uc_priv->bank_name : "",
302 * gpio_direction_input() - [COMPAT] Set GPIO direction to input
305 * This function implements the API that's compatible with current
306 * GPIO API used in U-Boot. The request is forwarded to particular
307 * GPIO driver. Returns 0 on success, negative value on error.
309 int gpio_direction_input(unsigned gpio)
311 struct gpio_desc desc;
314 ret = gpio_to_device(gpio, &desc);
317 ret = check_reserved(&desc, "dir_input");
321 return gpio_get_ops(desc.dev)->direction_input(desc.dev, desc.offset);
325 * gpio_direction_output() - [COMPAT] Set GPIO direction to output and set value
327 * value: Logical value to be set on the GPIO pin
329 * This function implements the API that's compatible with current
330 * GPIO API used in U-Boot. The request is forwarded to particular
331 * GPIO driver. Returns 0 on success, negative value on error.
333 int gpio_direction_output(unsigned gpio, int value)
335 struct gpio_desc desc;
338 ret = gpio_to_device(gpio, &desc);
341 ret = check_reserved(&desc, "dir_output");
345 return gpio_get_ops(desc.dev)->direction_output(desc.dev,
349 int dm_gpio_get_value(struct gpio_desc *desc)
354 ret = check_reserved(desc, "get_value");
358 value = gpio_get_ops(desc->dev)->get_value(desc->dev, desc->offset);
360 return desc->flags & GPIOD_ACTIVE_LOW ? !value : value;
363 int dm_gpio_set_value(struct gpio_desc *desc, int value)
367 ret = check_reserved(desc, "set_value");
371 if (desc->flags & GPIOD_ACTIVE_LOW)
373 gpio_get_ops(desc->dev)->set_value(desc->dev, desc->offset, value);
377 int dm_gpio_set_dir_flags(struct gpio_desc *desc, ulong flags)
379 struct udevice *dev = desc->dev;
380 struct dm_gpio_ops *ops = gpio_get_ops(dev);
383 ret = check_reserved(desc, "set_dir");
387 if (flags & GPIOD_IS_OUT) {
388 int value = flags & GPIOD_IS_OUT_ACTIVE ? 1 : 0;
390 if (flags & GPIOD_ACTIVE_LOW)
392 ret = ops->direction_output(dev, desc->offset, value);
393 } else if (flags & GPIOD_IS_IN) {
394 ret = ops->direction_input(dev, desc->offset);
399 * Update desc->flags here, so that GPIO_ACTIVE_LOW is honoured in
407 int dm_gpio_set_dir(struct gpio_desc *desc)
409 return dm_gpio_set_dir_flags(desc, desc->flags);
413 * gpio_get_value() - [COMPAT] Sample GPIO pin and return it's value
416 * This function implements the API that's compatible with current
417 * GPIO API used in U-Boot. The request is forwarded to particular
418 * GPIO driver. Returns the value of the GPIO pin, or negative value
421 int gpio_get_value(unsigned gpio)
425 struct gpio_desc desc;
427 ret = gpio_to_device(gpio, &desc);
430 return dm_gpio_get_value(&desc);
434 * gpio_set_value() - [COMPAT] Configure logical value on GPIO pin
436 * value: Logical value to be set on the GPIO pin.
438 * This function implements the API that's compatible with current
439 * GPIO API used in U-Boot. The request is forwarded to particular
440 * GPIO driver. Returns 0 on success, negative value on error.
442 int gpio_set_value(unsigned gpio, int value)
444 struct gpio_desc desc;
447 ret = gpio_to_device(gpio, &desc);
450 return dm_gpio_set_value(&desc, value);
453 const char *gpio_get_bank_info(struct udevice *dev, int *bit_count)
455 struct gpio_dev_priv *priv;
457 /* Must be called on an active device */
458 priv = dev->uclass_priv;
461 *bit_count = priv->gpio_count;
462 return priv->bank_name;
465 static const char * const gpio_function[GPIOF_COUNT] = {
473 int get_function(struct udevice *dev, int offset, bool skip_unused,
476 struct gpio_dev_priv *uc_priv = dev->uclass_priv;
477 struct dm_gpio_ops *ops = gpio_get_ops(dev);
479 BUILD_BUG_ON(GPIOF_COUNT != ARRAY_SIZE(gpio_function));
480 if (!device_active(dev))
482 if (offset < 0 || offset >= uc_priv->gpio_count)
485 *namep = uc_priv->name[offset];
486 if (skip_unused && !uc_priv->name[offset])
488 if (ops->get_function) {
491 ret = ops->get_function(dev, offset);
494 if (ret >= ARRAY_SIZE(gpio_function))
499 return GPIOF_UNKNOWN;
502 int gpio_get_function(struct udevice *dev, int offset, const char **namep)
504 return get_function(dev, offset, true, namep);
507 int gpio_get_raw_function(struct udevice *dev, int offset, const char **namep)
509 return get_function(dev, offset, false, namep);
512 int gpio_get_status(struct udevice *dev, int offset, char *buf, int buffsize)
514 struct dm_gpio_ops *ops = gpio_get_ops(dev);
515 struct gpio_dev_priv *priv;
521 BUILD_BUG_ON(GPIOF_COUNT != ARRAY_SIZE(gpio_function));
524 priv = dev->uclass_priv;
525 ret = gpio_get_raw_function(dev, offset, NULL);
529 len = snprintf(str, buffsize, "%s%d: %s",
530 priv->bank_name ? priv->bank_name : "",
531 offset, gpio_function[func]);
532 if (func == GPIOF_INPUT || func == GPIOF_OUTPUT ||
533 func == GPIOF_UNUSED) {
537 ret = ops->get_value(dev, offset);
540 used = gpio_get_function(dev, offset, &label) != GPIOF_UNUSED;
541 snprintf(str + len, buffsize - len, ": %d [%c]%s%s",
552 * get a number comprised of multiple GPIO values. gpio_num_array points to
553 * the array of gpio pin numbers to scan, terminated by -1.
555 unsigned gpio_get_values_as_int(const int *gpio_num_array)
558 unsigned bitmask = 1;
562 ((gpio = *gpio_num_array++) != -1)) {
563 if (gpio_get_value(gpio))
570 static int _gpio_request_by_name_nodev(const void *blob, int node,
571 const char *list_name, int index,
572 struct gpio_desc *desc, int flags,
575 struct fdtdec_phandle_args args;
580 ret = fdtdec_parse_phandle_with_args(blob, node, list_name,
581 "#gpio-cells", 0, index, &args);
583 debug("%s: fdtdec_parse_phandle_with_args failed\n", __func__);
587 ret = uclass_get_device_by_of_offset(UCLASS_GPIO, args.node,
590 debug("%s: uclass_get_device_by_of_offset failed\n", __func__);
593 ret = gpio_find_and_xlate(desc, &args);
595 debug("%s: gpio_find_and_xlate failed\n", __func__);
598 ret = dm_gpio_requestf(desc, add_index ? "%s.%s%d" : "%s.%s",
599 fdt_get_name(blob, node, NULL),
602 debug("%s: dm_gpio_requestf failed\n", __func__);
605 ret = dm_gpio_set_dir_flags(desc, flags | desc->flags);
607 debug("%s: dm_gpio_set_dir failed\n", __func__);
613 debug("%s: Node '%s', property '%s', failed to request GPIO index %d: %d\n",
614 __func__, fdt_get_name(blob, node, NULL), list_name, index, ret);
618 int gpio_request_by_name_nodev(const void *blob, int node,
619 const char *list_name, int index,
620 struct gpio_desc *desc, int flags)
622 return _gpio_request_by_name_nodev(blob, node, list_name, index, desc,
626 int gpio_request_by_name(struct udevice *dev, const char *list_name, int index,
627 struct gpio_desc *desc, int flags)
630 * This isn't ideal since we don't use dev->name in the debug()
631 * calls in gpio_request_by_name(), but we can do this until
632 * gpio_request_by_name_nodev() can be dropped.
634 return gpio_request_by_name_nodev(gd->fdt_blob, dev->of_offset,
635 list_name, index, desc, flags);
638 int gpio_request_list_by_name_nodev(const void *blob, int node,
639 const char *list_name,
640 struct gpio_desc *desc, int max_count,
646 for (count = 0; ; count++) {
647 if (count >= max_count) {
651 ret = _gpio_request_by_name_nodev(blob, node, list_name, count,
652 &desc[count], flags, true);
659 /* We ran out of GPIOs in the list */
663 gpio_free_list_nodev(desc, count - 1);
668 int gpio_request_list_by_name(struct udevice *dev, const char *list_name,
669 struct gpio_desc *desc, int max_count,
673 * This isn't ideal since we don't use dev->name in the debug()
674 * calls in gpio_request_by_name(), but we can do this until
675 * gpio_request_list_by_name_nodev() can be dropped.
677 return gpio_request_list_by_name_nodev(gd->fdt_blob, dev->of_offset,
678 list_name, desc, max_count,
682 int gpio_get_list_count(struct udevice *dev, const char *list_name)
686 ret = fdtdec_parse_phandle_with_args(gd->fdt_blob, dev->of_offset,
687 list_name, "#gpio-cells", 0, -1,
690 debug("%s: Node '%s', property '%s', GPIO count failed: %d\n",
691 __func__, dev->name, list_name, ret);
697 int dm_gpio_free(struct udevice *dev, struct gpio_desc *desc)
699 /* For now, we don't do any checking of dev */
700 return _dm_gpio_free(desc->dev, desc->offset);
703 int gpio_free_list(struct udevice *dev, struct gpio_desc *desc, int count)
707 /* For now, we don't do any checking of dev */
708 for (i = 0; i < count; i++)
709 dm_gpio_free(dev, &desc[i]);
714 int gpio_free_list_nodev(struct gpio_desc *desc, int count)
716 return gpio_free_list(NULL, desc, count);
719 /* We need to renumber the GPIOs when any driver is probed/removed */
720 static int gpio_renumber(struct udevice *removed_dev)
722 struct gpio_dev_priv *uc_priv;
728 ret = uclass_get(UCLASS_GPIO, &uc);
732 /* Ensure that we have a base for each bank */
734 uclass_foreach_dev(dev, uc) {
735 if (device_active(dev) && dev != removed_dev) {
736 uc_priv = dev->uclass_priv;
737 uc_priv->gpio_base = base;
738 base += uc_priv->gpio_count;
745 static int gpio_post_probe(struct udevice *dev)
747 struct gpio_dev_priv *uc_priv = dev->uclass_priv;
749 uc_priv->name = calloc(uc_priv->gpio_count, sizeof(char *));
753 return gpio_renumber(NULL);
756 static int gpio_pre_remove(struct udevice *dev)
758 struct gpio_dev_priv *uc_priv = dev->uclass_priv;
761 for (i = 0; i < uc_priv->gpio_count; i++) {
762 if (uc_priv->name[i])
763 free(uc_priv->name[i]);
767 return gpio_renumber(dev);
770 UCLASS_DRIVER(gpio) = {
773 .post_probe = gpio_post_probe,
774 .pre_remove = gpio_pre_remove,
775 .per_device_auto_alloc_size = sizeof(struct gpio_dev_priv),