gpio: remove the open_drain API and ops
[oweals/u-boot.git] / drivers / gpio / gpio-uclass.c
index 4efda311a49e81c8470a23d88f62a09b07f0f5bc..2515df4e7c7dfa21fbd4f9552e028a0a89a2e8ba 100644 (file)
@@ -1,15 +1,19 @@
+// SPDX-License-Identifier: GPL-2.0+
 /*
  * Copyright (c) 2013 Google, Inc
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
 #include <common.h>
 #include <dm.h>
+#include <dm/device-internal.h>
+#include <dm/lists.h>
+#include <dm/uclass-internal.h>
+#include <dt-bindings/gpio/gpio.h>
 #include <errno.h>
 #include <fdtdec.h>
 #include <malloc.h>
 #include <asm/gpio.h>
+#include <linux/bug.h>
 #include <linux/ctype.h>
 
 DECLARE_GLOBAL_DATA_PTR;
@@ -66,7 +70,7 @@ int dm_gpio_lookup_name(const char *name, struct gpio_desc *desc)
                if (numeric != -1) {
                        offset = numeric - uc_priv->gpio_base;
                        /* Allow GPIOs to be numbered from 0 */
-                       if (offset >= 0 && offset < uc_priv->gpio_count)
+                       if (offset < uc_priv->gpio_count)
                                break;
                }
 
@@ -112,21 +116,157 @@ int gpio_lookup_name(const char *name, struct udevice **devp,
        return 0;
 }
 
+int gpio_xlate_offs_flags(struct udevice *dev, struct gpio_desc *desc,
+                         struct ofnode_phandle_args *args)
+{
+       if (args->args_count < 1)
+               return -EINVAL;
+
+       desc->offset = args->args[0];
+
+       if (args->args_count < 2)
+               return 0;
+
+       if (args->args[1] & GPIO_ACTIVE_LOW)
+               desc->flags = GPIOD_ACTIVE_LOW;
+
+       return 0;
+}
+
 static int gpio_find_and_xlate(struct gpio_desc *desc,
-                              struct fdtdec_phandle_args *args)
+                              struct ofnode_phandle_args *args)
 {
        struct dm_gpio_ops *ops = gpio_get_ops(desc->dev);
 
-       /* Use the first argument as the offset by default */
-       if (args->args_count > 0)
-               desc->offset = args->args[0];
+       if (ops->xlate)
+               return ops->xlate(desc->dev, desc, args);
        else
-               desc->offset = -1;
-       desc->flags = 0;
+               return gpio_xlate_offs_flags(desc->dev, desc, args);
+}
+
+#if defined(CONFIG_GPIO_HOG)
+
+struct gpio_hog_priv {
+       struct gpio_desc gpiod;
+};
+
+struct gpio_hog_data {
+       int gpiod_flags;
+       int value;
+       u32 val[2];
+};
+
+static int gpio_hog_ofdata_to_platdata(struct udevice *dev)
+{
+       struct gpio_hog_data *plat = dev_get_platdata(dev);
+       const char *nodename;
+       int ret;
+
+       plat->value = 0;
+       if (dev_read_bool(dev, "input")) {
+               plat->gpiod_flags = GPIOD_IS_IN;
+       } else if (dev_read_bool(dev, "output-high")) {
+               plat->value = 1;
+               plat->gpiod_flags = GPIOD_IS_OUT;
+       } else if (dev_read_bool(dev, "output-low")) {
+               plat->gpiod_flags = GPIOD_IS_OUT;
+       } else {
+               printf("%s: missing gpio-hog state.\n", __func__);
+               return -EINVAL;
+       }
+       ret = dev_read_u32_array(dev, "gpios", plat->val, 2);
+       if (ret) {
+               printf("%s: wrong gpios property, 2 values needed %d\n",
+                      __func__, ret);
+               return ret;
+       }
+       nodename = dev_read_string(dev, "line-name");
+       if (nodename)
+               device_set_name(dev, nodename);
+
+       return 0;
+}
+
+static int gpio_hog_probe(struct udevice *dev)
+{
+       struct gpio_hog_data *plat = dev_get_platdata(dev);
+       struct gpio_hog_priv *priv = dev_get_priv(dev);
+       int ret;
+
+       ret = gpio_dev_request_index(dev->parent, dev->name, "gpio-hog",
+                                    plat->val[0], plat->gpiod_flags,
+                                    plat->val[1], &priv->gpiod);
+       if (ret < 0) {
+               debug("%s: node %s could not get gpio.\n", __func__,
+                     dev->name);
+               return ret;
+       }
+
+       if (plat->gpiod_flags == GPIOD_IS_OUT) {
+               ret = dm_gpio_set_value(&priv->gpiod, plat->value);
+               if (ret < 0) {
+                       debug("%s: node %s could not set gpio.\n", __func__,
+                             dev->name);
+                       return ret;
+               }
+       }
+
+       return 0;
+}
+
+int gpio_hog_probe_all(void)
+{
+       struct udevice *dev;
+       int ret;
+       int retval = 0;
+
+       for (uclass_first_device(UCLASS_NOP, &dev);
+            dev;
+            uclass_find_next_device(&dev)) {
+               if (dev->driver == DM_GET_DRIVER(gpio_hog)) {
+                       ret = device_probe(dev);
+                       if (ret) {
+                               printf("Failed to probe device %s err: %d\n",
+                                      dev->name, ret);
+                               retval = ret;
+                       }
+               }
+       }
+
+       return retval;
+}
+
+int gpio_hog_lookup_name(const char *name, struct gpio_desc **desc)
+{
+       struct udevice *dev;
+
+       *desc = NULL;
+       gpio_hog_probe_all();
+       if (!uclass_get_device_by_name(UCLASS_NOP, name, &dev)) {
+               struct gpio_hog_priv *priv = dev_get_priv(dev);
+
+               *desc = &priv->gpiod;
+               return 0;
+       }
 
-       return ops->xlate ? ops->xlate(desc->dev, desc, args) : 0;
+       return -ENODEV;
 }
 
+U_BOOT_DRIVER(gpio_hog) = {
+       .name   = "gpio_hog",
+       .id     = UCLASS_NOP,
+       .ofdata_to_platdata = gpio_hog_ofdata_to_platdata,
+       .probe = gpio_hog_probe,
+       .priv_auto_alloc_size = sizeof(struct gpio_hog_priv),
+       .platdata_auto_alloc_size = sizeof(struct gpio_hog_data),
+};
+#else
+int gpio_hog_lookup_name(const char *name, struct gpio_desc **desc)
+{
+       return 0;
+}
+#endif
+
 int dm_gpio_request(struct gpio_desc *desc, const char *label)
 {
        struct udevice *dev = desc->dev;
@@ -154,6 +294,7 @@ int dm_gpio_request(struct gpio_desc *desc, const char *label)
 
 static int dm_gpio_requestf(struct gpio_desc *desc, const char *fmt, ...)
 {
+#if !defined(CONFIG_SPL_BUILD) || !CONFIG_IS_ENABLED(USE_TINY_PRINTF)
        va_list args;
        char buf[40];
 
@@ -161,6 +302,9 @@ static int dm_gpio_requestf(struct gpio_desc *desc, const char *fmt, ...)
        vscnprintf(buf, sizeof(buf), fmt, args);
        va_end(args);
        return dm_gpio_request(desc, buf);
+#else
+       return dm_gpio_request(desc, fmt);
+#endif
 }
 
 /**
@@ -199,6 +343,7 @@ int gpio_request(unsigned gpio, const char *label)
  */
 int gpio_requestf(unsigned gpio, const char *fmt, ...)
 {
+#if !defined(CONFIG_SPL_BUILD) || !CONFIG_IS_ENABLED(USE_TINY_PRINTF)
        va_list args;
        char buf[40];
 
@@ -206,6 +351,9 @@ int gpio_requestf(unsigned gpio, const char *fmt, ...)
        vscnprintf(buf, sizeof(buf), fmt, args);
        va_end(args);
        return gpio_request(gpio, buf);
+#else
+       return gpio_request(gpio, fmt);
+#endif
 }
 
 int _dm_gpio_free(struct udevice *dev, uint offset)
@@ -216,8 +364,8 @@ int _dm_gpio_free(struct udevice *dev, uint offset)
        uc_priv = dev_get_uclass_priv(dev);
        if (!uc_priv->name[offset])
                return -ENXIO;
-       if (gpio_get_ops(dev)->free) {
-               ret = gpio_get_ops(dev)->free(dev, offset);
+       if (gpio_get_ops(dev)->rfree) {
+               ret = gpio_get_ops(dev)->rfree(dev, offset);
                if (ret)
                        return ret;
        }
@@ -248,10 +396,14 @@ int gpio_free(unsigned gpio)
        return _dm_gpio_free(desc.dev, desc.offset);
 }
 
-static int check_reserved(struct gpio_desc *desc, const char *func)
+static int check_reserved(const struct gpio_desc *desc, const char *func)
 {
-       struct gpio_dev_priv *uc_priv = dev_get_uclass_priv(desc->dev);
+       struct gpio_dev_priv *uc_priv;
 
+       if (!dm_gpio_is_valid(desc))
+               return -ENOENT;
+
+       uc_priv = dev_get_uclass_priv(desc->dev);
        if (!uc_priv->name[desc->offset]) {
                printf("%s: %s: error: gpio %s%d not reserved\n",
                       desc->dev->name, func,
@@ -311,7 +463,7 @@ int gpio_direction_output(unsigned gpio, int value)
                                                        desc.offset, value);
 }
 
-int dm_gpio_get_value(struct gpio_desc *desc)
+int dm_gpio_get_value(const struct gpio_desc *desc)
 {
        int value;
        int ret;
@@ -325,7 +477,7 @@ int dm_gpio_get_value(struct gpio_desc *desc)
        return desc->flags & GPIOD_ACTIVE_LOW ? !value : value;
 }
 
-int dm_gpio_set_value(struct gpio_desc *desc, int value)
+int dm_gpio_set_value(const struct gpio_desc *desc, int value)
 {
        int ret;
 
@@ -435,8 +587,8 @@ static const char * const gpio_function[GPIOF_COUNT] = {
        "func",
 };
 
-int get_function(struct udevice *dev, int offset, bool skip_unused,
-                const char **namep)
+static int get_function(struct udevice *dev, int offset, bool skip_unused,
+                       const char **namep)
 {
        struct gpio_dev_priv *uc_priv = dev_get_uclass_priv(dev);
        struct dm_gpio_ops *ops = gpio_get_ops(dev);
@@ -564,37 +716,84 @@ int gpio_get_values_as_int(const int *gpio_list)
        return vector;
 }
 
-static int _gpio_request_by_name_nodev(const void *blob, int node,
-                                      const char *list_name, int index,
-                                      struct gpio_desc *desc, int flags,
-                                      bool add_index)
+int dm_gpio_get_values_as_int(const struct gpio_desc *desc_list, int count)
 {
-       struct fdtdec_phandle_args args;
-       int ret;
+       unsigned bitmask = 1;
+       unsigned vector = 0;
+       int ret, i;
 
-       desc->dev = NULL;
-       desc->offset = 0;
-       ret = fdtdec_parse_phandle_with_args(blob, node, list_name,
-                                            "#gpio-cells", 0, index, &args);
-       if (ret) {
-               debug("%s: fdtdec_parse_phandle_with_args failed\n", __func__);
-               goto err;
+       for (i = 0; i < count; i++) {
+               ret = dm_gpio_get_value(&desc_list[i]);
+               if (ret < 0)
+                       return ret;
+               else if (ret)
+                       vector |= bitmask;
+               bitmask <<= 1;
        }
 
-       ret = uclass_get_device_by_of_offset(UCLASS_GPIO, args.node,
-                                            &desc->dev);
-       if (ret) {
-               debug("%s: uclass_get_device_by_of_offset failed\n", __func__);
+       return vector;
+}
+
+/**
+ * gpio_request_tail: common work for requesting a gpio.
+ *
+ * ret:                return value from previous work in function which calls
+ *             this function.
+ *             This seems bogus (why calling this function instead not
+ *             calling it and end caller function instead?).
+ *             Because on error in caller function we want to set some
+ *             default values in gpio desc and have a common error
+ *             debug message, which provides this function.
+ * nodename:   Name of node for which gpio gets requested
+ *             used for gpio label name.
+ * args:       pointer to output arguments structure
+ * list_name:  Name of GPIO list
+ *             used for gpio label name.
+ * index:      gpio index in gpio list
+ *             used for gpio label name.
+ * desc:       pointer to gpio descriptor, filled from this
+ *             function.
+ * flags:      gpio flags to use.
+ * add_index:  should index added to gpio label name
+ * gpio_dev:   pointer to gpio device from which the gpio
+ *             will be requested. If NULL try to get the
+ *             gpio device with uclass_get_device_by_ofnode()
+ *
+ * return:     In error case this function sets default values in
+ *             gpio descriptor, also emmits a debug message.
+ *             On success it returns 0 else the error code from
+ *             function calls, or the error code passed through
+ *             ret to this function.
+ *
+ */
+static int gpio_request_tail(int ret, const char *nodename,
+                            struct ofnode_phandle_args *args,
+                            const char *list_name, int index,
+                            struct gpio_desc *desc, int flags,
+                            bool add_index, struct udevice *gpio_dev)
+{
+       desc->dev = gpio_dev;
+       desc->offset = 0;
+       desc->flags = 0;
+       if (ret)
                goto err;
+
+       if (!desc->dev) {
+               ret = uclass_get_device_by_ofnode(UCLASS_GPIO, args->node,
+                                                 &desc->dev);
+               if (ret) {
+                       debug("%s: uclass_get_device_by_ofnode failed\n",
+                             __func__);
+                       goto err;
+               }
        }
-       ret = gpio_find_and_xlate(desc, &args);
+       ret = gpio_find_and_xlate(desc, args);
        if (ret) {
                debug("%s: gpio_find_and_xlate failed\n", __func__);
                goto err;
        }
        ret = dm_gpio_requestf(desc, add_index ? "%s.%s%d" : "%s.%s",
-                              fdt_get_name(blob, node, NULL),
-                              list_name, index);
+                              nodename, list_name, index);
        if (ret) {
                debug("%s: dm_gpio_requestf failed\n", __func__);
                goto err;
@@ -608,32 +807,46 @@ static int _gpio_request_by_name_nodev(const void *blob, int node,
        return 0;
 err:
        debug("%s: Node '%s', property '%s', failed to request GPIO index %d: %d\n",
-             __func__, fdt_get_name(blob, node, NULL), list_name, index, ret);
+             __func__, nodename, list_name, index, ret);
        return ret;
 }
 
-int gpio_request_by_name_nodev(const void *blob, int node,
-                              const char *list_name, int index,
+static int _gpio_request_by_name_nodev(ofnode node, const char *list_name,
+                                      int index, struct gpio_desc *desc,
+                                      int flags, bool add_index)
+{
+       struct ofnode_phandle_args args;
+       int ret;
+
+       ret = ofnode_parse_phandle_with_args(node, list_name, "#gpio-cells", 0,
+                                            index, &args);
+
+       return gpio_request_tail(ret, ofnode_get_name(node), &args, list_name,
+                                index, desc, flags, add_index, NULL);
+}
+
+int gpio_request_by_name_nodev(ofnode node, const char *list_name, int index,
                               struct gpio_desc *desc, int flags)
 {
-       return _gpio_request_by_name_nodev(blob, node, list_name, index, desc,
-                                          flags, index > 0);
+       return _gpio_request_by_name_nodev(node, list_name, index, desc, flags,
+                                          index > 0);
 }
 
-int gpio_request_by_name(struct udevice *dev,  const char *list_name, int index,
+int gpio_request_by_name(struct udevice *dev, const char *list_name, int index,
                         struct gpio_desc *desc, int flags)
 {
-       /*
-        * This isn't ideal since we don't use dev->name in the debug()
-        * calls in gpio_request_by_name(), but we can do this until
-        * gpio_request_by_name_nodev() can be dropped.
-        */
-       return gpio_request_by_name_nodev(gd->fdt_blob, dev->of_offset,
-                                         list_name, index, desc, flags);
+       struct ofnode_phandle_args args;
+       ofnode node;
+       int ret;
+
+       ret = dev_read_phandle_with_args(dev, list_name, "#gpio-cells", 0,
+                                        index, &args);
+       node = dev_ofnode(dev);
+       return gpio_request_tail(ret, ofnode_get_name(node), &args, list_name,
+                                index, desc, flags, index > 0, NULL);
 }
 
-int gpio_request_list_by_name_nodev(const void *blob, int node,
-                                   const char *list_name,
+int gpio_request_list_by_name_nodev(ofnode node, const char *list_name,
                                    struct gpio_desc *desc, int max_count,
                                    int flags)
 {
@@ -641,7 +854,7 @@ int gpio_request_list_by_name_nodev(const void *blob, int node,
        int ret;
 
        for (count = 0; count < max_count; count++) {
-               ret = _gpio_request_by_name_nodev(blob, node, list_name, count,
+               ret = _gpio_request_by_name_nodev(node, list_name, count,
                                                  &desc[count], flags, true);
                if (ret == -ENOENT)
                        break;
@@ -667,16 +880,15 @@ int gpio_request_list_by_name(struct udevice *dev, const char *list_name,
         * calls in gpio_request_by_name(), but we can do this until
         * gpio_request_list_by_name_nodev() can be dropped.
         */
-       return gpio_request_list_by_name_nodev(gd->fdt_blob, dev->of_offset,
-                                              list_name, desc, max_count,
-                                              flags);
+       return gpio_request_list_by_name_nodev(dev_ofnode(dev), list_name, desc,
+                                              max_count, flags);
 }
 
 int gpio_get_list_count(struct udevice *dev, const char *list_name)
 {
        int ret;
 
-       ret = fdtdec_parse_phandle_with_args(gd->fdt_blob, dev->of_offset,
+       ret = fdtdec_parse_phandle_with_args(gd->fdt_blob, dev_of_offset(dev),
                                             list_name, "#gpio-cells", 0, -1,
                                             NULL);
        if (ret) {
@@ -735,7 +947,7 @@ static int gpio_renumber(struct udevice *removed_dev)
        return 0;
 }
 
-int gpio_get_number(struct gpio_desc *desc)
+int gpio_get_number(const struct gpio_desc *desc)
 {
        struct udevice *dev = desc->dev;
        struct gpio_dev_priv *uc_priv;
@@ -772,11 +984,76 @@ static int gpio_pre_remove(struct udevice *dev)
        return gpio_renumber(dev);
 }
 
+int gpio_dev_request_index(struct udevice *dev, const char *nodename,
+                          char *list_name, int index, int flags,
+                          int dtflags, struct gpio_desc *desc)
+{
+       struct ofnode_phandle_args args;
+
+       args.node =  ofnode_null();
+       args.args_count = 2;
+       args.args[0] = index;
+       args.args[1] = dtflags;
+
+       return gpio_request_tail(0, nodename, &args, list_name, index, desc,
+                                flags, 0, dev);
+}
+
+static int gpio_post_bind(struct udevice *dev)
+{
+       struct udevice *child;
+       ofnode node;
+
+#if defined(CONFIG_NEEDS_MANUAL_RELOC)
+       struct dm_gpio_ops *ops = (struct dm_gpio_ops *)device_get_ops(dev);
+       static int reloc_done;
+
+       if (!reloc_done) {
+               if (ops->request)
+                       ops->request += gd->reloc_off;
+               if (ops->rfree)
+                       ops->rfree += gd->reloc_off;
+               if (ops->direction_input)
+                       ops->direction_input += gd->reloc_off;
+               if (ops->direction_output)
+                       ops->direction_output += gd->reloc_off;
+               if (ops->get_value)
+                       ops->get_value += gd->reloc_off;
+               if (ops->set_value)
+                       ops->set_value += gd->reloc_off;
+               if (ops->get_function)
+                       ops->get_function += gd->reloc_off;
+               if (ops->xlate)
+                       ops->xlate += gd->reloc_off;
+
+               reloc_done++;
+       }
+#endif
+
+       if (IS_ENABLED(CONFIG_GPIO_HOG)) {
+               dev_for_each_subnode(node, dev) {
+                       if (ofnode_read_bool(node, "gpio-hog")) {
+                               const char *name = ofnode_get_name(node);
+                               int ret;
+
+                               ret = device_bind_driver_to_node(dev,
+                                                                "gpio_hog",
+                                                                name, node,
+                                                                &child);
+                               if (ret)
+                                       return ret;
+                       }
+               }
+       }
+       return 0;
+}
+
 UCLASS_DRIVER(gpio) = {
        .id             = UCLASS_GPIO,
        .name           = "gpio",
        .flags          = DM_UC_FLAG_SEQ_ALIAS,
        .post_probe     = gpio_post_probe,
+       .post_bind      = gpio_post_bind,
        .pre_remove     = gpio_pre_remove,
        .per_device_auto_alloc_size = sizeof(struct gpio_dev_priv),
 };