common: Drop log.h from common header
[pandora-u-boot.git] / drivers / gpio / sandbox.c
index 19d2db0..98b7fa4 100644 (file)
@@ -1,65 +1,52 @@
+// SPDX-License-Identifier: GPL-2.0+
 /*
  * Copyright (c) 2011 The Chromium OS Authors.
- * See file CREDITS for list of people who contributed to this
- * project.
- *
- * 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.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
- * MA 02111-1307 USA
  */
 
 #include <common.h>
+#include <dm.h>
+#include <fdtdec.h>
+#include <log.h>
+#include <malloc.h>
 #include <asm/gpio.h>
+#include <dm/device_compat.h>
+#include <dm/lists.h>
+#include <dm/of.h>
+#include <dm/pinctrl.h>
+#include <dt-bindings/gpio/gpio.h>
+#include <dt-bindings/gpio/sandbox-gpio.h>
 
-/* Flags for each GPIO */
-#define GPIOF_OUTPUT   (1 << 0)        /* Currently set as an output */
-#define GPIOF_HIGH     (1 << 1)        /* Currently set high */
-#define GPIOF_RESERVED (1 << 2)        /* Is in use / requested */
 
 struct gpio_state {
        const char *label;      /* label given by requester */
-       u8 flags;               /* flags (GPIOF_...) */
+       ulong dir_flags;        /* dir_flags (GPIOD_...) */
 };
 
-/*
- * State of GPIOs
- * TODO: Put this into sandbox state
- */
-static struct gpio_state state[CONFIG_SANDBOX_GPIO_COUNT];
-
-/* Access routines for GPIO state */
-static u8 *get_gpio_flags(unsigned gp)
+/* Access routines for GPIO dir flags */
+static ulong *get_gpio_dir_flags(struct udevice *dev, unsigned int offset)
 {
-       /* assert()'s could be disabled, so make sure we handle that */
-       assert(gp < ARRAY_SIZE(state));
-       if (gp >= ARRAY_SIZE(state)) {
-               static u8 invalid_flags;
-               printf("sandbox_gpio: error: invalid gpio %u\n", gp);
-               return &invalid_flags;
+       struct gpio_dev_priv *uc_priv = dev_get_uclass_priv(dev);
+       struct gpio_state *state = dev_get_priv(dev);
+
+       if (offset >= uc_priv->gpio_count) {
+               static ulong invalid_dir_flags;
+               printf("sandbox_gpio: error: invalid gpio %u\n", offset);
+               return &invalid_dir_flags;
        }
 
-       return &state[gp].flags;
+       return &state[offset].dir_flags;
+
 }
 
-static int get_gpio_flag(unsigned gp, int flag)
+static int get_gpio_flag(struct udevice *dev, unsigned int offset, ulong flag)
 {
-       return (*get_gpio_flags(gp) & flag) != 0;
+       return (*get_gpio_dir_flags(dev, offset) & flag) != 0;
 }
 
-static int set_gpio_flag(unsigned gp, int flag, int value)
+static int set_gpio_flag(struct udevice *dev, unsigned int offset, ulong flag,
+                        int value)
 {
-       u8 *gpio = get_gpio_flags(gp);
+       ulong *gpio = get_gpio_dir_flags(dev, offset);
 
        if (value)
                *gpio |= flag;
@@ -69,141 +56,395 @@ static int set_gpio_flag(unsigned gp, int flag, int value)
        return 0;
 }
 
-static int check_reserved(unsigned gpio, const char *func)
-{
-       if (!get_gpio_flag(gpio, GPIOF_RESERVED)) {
-               printf("sandbox_gpio: %s: error: gpio %u not reserved\n",
-                       func, gpio);
-               return -1;
-       }
-
-       return 0;
-}
-
 /*
  * Back-channel sandbox-internal-only access to GPIO state
  */
 
-int sandbox_gpio_get_value(unsigned gp)
+int sandbox_gpio_get_value(struct udevice *dev, unsigned offset)
 {
-       if (get_gpio_flag(gp, GPIOF_OUTPUT))
-               debug("sandbox_gpio: get_value on output gpio %u\n", gp);
-       return get_gpio_flag(gp, GPIOF_HIGH);
+       if (get_gpio_flag(dev, offset, GPIOD_IS_OUT))
+               debug("sandbox_gpio: get_value on output gpio %u\n", offset);
+       return get_gpio_flag(dev, offset, GPIOD_IS_OUT_ACTIVE);
 }
 
-int sandbox_gpio_set_value(unsigned gp, int value)
+int sandbox_gpio_set_value(struct udevice *dev, unsigned offset, int value)
 {
-       return set_gpio_flag(gp, GPIOF_HIGH, value);
+       return set_gpio_flag(dev, offset, GPIOD_IS_OUT_ACTIVE, value);
 }
 
-int sandbox_gpio_get_direction(unsigned gp)
+int sandbox_gpio_get_direction(struct udevice *dev, unsigned offset)
 {
-       return get_gpio_flag(gp, GPIOF_OUTPUT);
+       return get_gpio_flag(dev, offset, GPIOD_IS_OUT);
 }
 
-int sandbox_gpio_set_direction(unsigned gp, int output)
+int sandbox_gpio_set_direction(struct udevice *dev, unsigned offset, int output)
 {
-       return set_gpio_flag(gp, GPIOF_OUTPUT, output);
+       set_gpio_flag(dev, offset, GPIOD_IS_OUT, output);
+       set_gpio_flag(dev, offset, GPIOD_IS_IN, !(output));
+
+       return 0;
+}
+
+ulong sandbox_gpio_get_dir_flags(struct udevice *dev, unsigned int offset)
+{
+       return *get_gpio_dir_flags(dev, offset);
+}
+
+int sandbox_gpio_set_dir_flags(struct udevice *dev, unsigned int offset,
+                              ulong flags)
+{
+       *get_gpio_dir_flags(dev, offset) = flags;
+
+       return 0;
 }
 
 /*
  * These functions implement the public interface within U-Boot
  */
 
-/* set GPIO port 'gp' as an input */
-int gpio_direction_input(unsigned gp)
+/* set GPIO port 'offset' as an input */
+static int sb_gpio_direction_input(struct udevice *dev, unsigned offset)
 {
-       debug("%s: gp:%u\n", __func__, gp);
+       debug("%s: offset:%u\n", __func__, offset);
 
-       if (check_reserved(gp, __func__))
-               return -1;
+       return sandbox_gpio_set_direction(dev, offset, 0);
+}
 
-       return sandbox_gpio_set_direction(gp, 0);
+/* set GPIO port 'offset' as an output, with polarity 'value' */
+static int sb_gpio_direction_output(struct udevice *dev, unsigned offset,
+                                   int value)
+{
+       debug("%s: offset:%u, value = %d\n", __func__, offset, value);
+
+       return sandbox_gpio_set_direction(dev, offset, 1) |
+               sandbox_gpio_set_value(dev, offset, value);
 }
 
-/* set GPIO port 'gp' as an output, with polarity 'value' */
-int gpio_direction_output(unsigned gp, int value)
+/* read GPIO IN value of port 'offset' */
+static int sb_gpio_get_value(struct udevice *dev, unsigned offset)
 {
-       debug("%s: gp:%u, value = %d\n", __func__, gp, value);
+       debug("%s: offset:%u\n", __func__, offset);
 
-       if (check_reserved(gp, __func__))
+       return sandbox_gpio_get_value(dev, offset);
+}
+
+/* write GPIO OUT value to port 'offset' */
+static int sb_gpio_set_value(struct udevice *dev, unsigned offset, int value)
+{
+       debug("%s: offset:%u, value = %d\n", __func__, offset, value);
+
+       if (!sandbox_gpio_get_direction(dev, offset)) {
+               printf("sandbox_gpio: error: set_value on input gpio %u\n",
+                      offset);
                return -1;
+       }
 
-       return sandbox_gpio_set_direction(gp, 1) |
-               sandbox_gpio_set_value(gp, value);
+       return sandbox_gpio_set_value(dev, offset, value);
 }
 
-/* read GPIO IN value of port 'gp' */
-int gpio_get_value(unsigned gp)
+static int sb_gpio_get_function(struct udevice *dev, unsigned offset)
 {
-       debug("%s: gp:%u\n", __func__, gp);
+       if (get_gpio_flag(dev, offset, GPIOD_IS_OUT))
+               return GPIOF_OUTPUT;
+       if (get_gpio_flag(dev, offset, GPIOD_IS_IN))
+               return GPIOF_INPUT;
 
-       if (check_reserved(gp, __func__))
-               return -1;
+       return GPIOF_INPUT; /*GPIO is not configurated */
+}
 
-       return sandbox_gpio_get_value(gp);
+static int sb_gpio_xlate(struct udevice *dev, struct gpio_desc *desc,
+                        struct ofnode_phandle_args *args)
+{
+       desc->offset = args->args[0];
+       if (args->args_count < 2)
+               return 0;
+       /* treat generic binding with gpio uclass */
+       gpio_xlate_offs_flags(dev, desc, args);
+
+       /* sandbox test specific, not defined in gpio.h */
+       if (args->args[1] & GPIO_IN)
+               desc->flags |= GPIOD_IS_IN;
+
+       if (args->args[1] & GPIO_OUT)
+               desc->flags |= GPIOD_IS_OUT;
+
+       if (args->args[1] & GPIO_OUT_ACTIVE)
+               desc->flags |= GPIOD_IS_OUT_ACTIVE;
+
+       return 0;
 }
 
-/* write GPIO OUT value to port 'gp' */
-int gpio_set_value(unsigned gp, int value)
+static int sb_gpio_set_dir_flags(struct udevice *dev, unsigned int offset,
+                                ulong flags)
 {
-       debug("%s: gp:%u, value = %d\n", __func__, gp, value);
+       ulong *dir_flags;
 
-       if (check_reserved(gp, __func__))
-               return -1;
+       debug("%s: offset:%u, dir_flags = %lx\n", __func__, offset, flags);
 
-       if (!sandbox_gpio_get_direction(gp)) {
-               printf("sandbox_gpio: error: set_value on input gpio %u\n", gp);
-               return -1;
-       }
+       dir_flags = get_gpio_dir_flags(dev, offset);
 
-       return sandbox_gpio_set_value(gp, value);
+       *dir_flags = flags;
+
+       return 0;
 }
 
-int gpio_request(unsigned gp, const char *label)
+static int sb_gpio_get_dir_flags(struct udevice *dev, unsigned int offset,
+                                ulong *flags)
 {
-       debug("%s: gp:%u, label:%s\n", __func__, gp, label);
+       debug("%s: offset:%u\n", __func__, offset);
+       *flags = *get_gpio_dir_flags(dev, offset);
 
-       if (gp >= ARRAY_SIZE(state)) {
-               printf("sandbox_gpio: error: invalid gpio %u\n", gp);
-               return -1;
-       }
+       return 0;
+}
 
-       if (get_gpio_flag(gp, GPIOF_RESERVED)) {
-               printf("sandbox_gpio: error: gpio %u already reserved\n", gp);
-               return -1;
+static const struct dm_gpio_ops gpio_sandbox_ops = {
+       .direction_input        = sb_gpio_direction_input,
+       .direction_output       = sb_gpio_direction_output,
+       .get_value              = sb_gpio_get_value,
+       .set_value              = sb_gpio_set_value,
+       .get_function           = sb_gpio_get_function,
+       .xlate                  = sb_gpio_xlate,
+       .set_dir_flags          = sb_gpio_set_dir_flags,
+       .get_dir_flags          = sb_gpio_get_dir_flags,
+};
+
+static int sandbox_gpio_ofdata_to_platdata(struct udevice *dev)
+{
+       struct gpio_dev_priv *uc_priv = dev_get_uclass_priv(dev);
+
+       uc_priv->gpio_count = dev_read_u32_default(dev, "sandbox,gpio-count",
+                                                  0);
+       uc_priv->bank_name = dev_read_string(dev, "gpio-bank-name");
+
+       return 0;
+}
+
+static int gpio_sandbox_probe(struct udevice *dev)
+{
+       struct gpio_dev_priv *uc_priv = dev_get_uclass_priv(dev);
+
+       if (!dev_of_valid(dev))
+               /* Tell the uclass how many GPIOs we have */
+               uc_priv->gpio_count = CONFIG_SANDBOX_GPIO_COUNT;
+
+       dev->priv = calloc(sizeof(struct gpio_state), uc_priv->gpio_count);
+
+       return 0;
+}
+
+static int gpio_sandbox_remove(struct udevice *dev)
+{
+       free(dev->priv);
+
+       return 0;
+}
+
+static const struct udevice_id sandbox_gpio_ids[] = {
+       { .compatible = "sandbox,gpio" },
+       { }
+};
+
+U_BOOT_DRIVER(gpio_sandbox) = {
+       .name   = "gpio_sandbox",
+       .id     = UCLASS_GPIO,
+       .of_match = sandbox_gpio_ids,
+       .ofdata_to_platdata = sandbox_gpio_ofdata_to_platdata,
+       .probe  = gpio_sandbox_probe,
+       .remove = gpio_sandbox_remove,
+       .ops    = &gpio_sandbox_ops,
+};
+
+/* pincontrol: used only to check GPIO pin configuration (pinmux command) */
+
+struct sb_pinctrl_priv {
+       int pinctrl_ngpios;
+       struct list_head gpio_dev;
+};
+
+struct sb_gpio_bank {
+       struct udevice *gpio_dev;
+       struct list_head list;
+};
+
+static int sb_populate_gpio_dev_list(struct udevice *dev)
+{
+       struct sb_pinctrl_priv *priv = dev_get_priv(dev);
+       struct udevice *gpio_dev;
+       struct udevice *child;
+       struct sb_gpio_bank *gpio_bank;
+       int ret;
+
+       /*
+        * parse pin-controller sub-nodes (ie gpio bank nodes) and fill
+        * a list with all gpio device reference which belongs to the
+        * current pin-controller. This list is used to find pin_name and
+        * pin muxing
+        */
+       list_for_each_entry(child, &dev->child_head, sibling_node) {
+               ret = uclass_get_device_by_name(UCLASS_GPIO, child->name,
+                                               &gpio_dev);
+               if (ret < 0)
+                       continue;
+
+               gpio_bank = malloc(sizeof(*gpio_bank));
+               if (!gpio_bank) {
+                       dev_err(dev, "Not enough memory\n");
+                       return -ENOMEM;
+               }
+
+               gpio_bank->gpio_dev = gpio_dev;
+               list_add_tail(&gpio_bank->list, &priv->gpio_dev);
        }
 
-       state[gp].label = label;
-       return set_gpio_flag(gp, GPIOF_RESERVED, 1);
+       return 0;
 }
 
-int gpio_free(unsigned gp)
+static int sb_pinctrl_get_pins_count(struct udevice *dev)
 {
-       debug("%s: gp:%u\n", __func__, gp);
+       struct sb_pinctrl_priv *priv = dev_get_priv(dev);
+       struct gpio_dev_priv *uc_priv;
+       struct sb_gpio_bank *gpio_bank;
+
+       /*
+        * if get_pins_count has already been executed once on this
+        * pin-controller, no need to run it again
+        */
+       if (priv->pinctrl_ngpios)
+               return priv->pinctrl_ngpios;
+
+       if (list_empty(&priv->gpio_dev))
+               sb_populate_gpio_dev_list(dev);
+       /*
+        * walk through all banks to retrieve the pin-controller
+        * pins number
+        */
+       list_for_each_entry(gpio_bank, &priv->gpio_dev, list) {
+               uc_priv = dev_get_uclass_priv(gpio_bank->gpio_dev);
+
+               priv->pinctrl_ngpios += uc_priv->gpio_count;
+       }
 
-       if (check_reserved(gp, __func__))
-               return -1;
+       return priv->pinctrl_ngpios;
+}
+
+static struct udevice *sb_pinctrl_get_gpio_dev(struct udevice *dev,
+                                              unsigned int selector,
+                                              unsigned int *idx)
+{
+       struct sb_pinctrl_priv *priv = dev_get_priv(dev);
+       struct sb_gpio_bank *gpio_bank;
+       struct gpio_dev_priv *uc_priv;
+       int pin_count = 0;
+
+       if (list_empty(&priv->gpio_dev))
+               sb_populate_gpio_dev_list(dev);
+
+       /* look up for the bank which owns the requested pin */
+       list_for_each_entry(gpio_bank, &priv->gpio_dev, list) {
+               uc_priv = dev_get_uclass_priv(gpio_bank->gpio_dev);
+
+               if (selector < (pin_count + uc_priv->gpio_count)) {
+                       /*
+                        * we found the bank, convert pin selector to
+                        * gpio bank index
+                        */
+                       *idx = selector - pin_count;
+
+                       return gpio_bank->gpio_dev;
+               }
+               pin_count += uc_priv->gpio_count;
+       }
 
-       state[gp].label = NULL;
-       return set_gpio_flag(gp, GPIOF_RESERVED, 0);
+       return NULL;
 }
 
-/* Display GPIO information */
-void gpio_info(void)
+static const char *sb_pinctrl_get_pin_name(struct udevice *dev,
+                                          unsigned int selector)
 {
-       unsigned gpio;
+       struct gpio_dev_priv *uc_priv;
+       struct udevice *gpio_dev;
+       unsigned int gpio_idx;
+       static char pin_name[PINNAME_SIZE];
+
+       /* look up for the bank which owns the requested pin */
+       gpio_dev = sb_pinctrl_get_gpio_dev(dev, selector, &gpio_idx);
+       if (!gpio_dev) {
+               snprintf(pin_name, PINNAME_SIZE, "Error");
+       } else {
+               uc_priv = dev_get_uclass_priv(gpio_dev);
+
+               snprintf(pin_name, PINNAME_SIZE, "%s%d",
+                        uc_priv->bank_name,
+                        gpio_idx);
+       }
 
-       puts("Sandbox GPIOs\n");
+       return pin_name;
+}
 
-       for (gpio = 0; gpio < ARRAY_SIZE(state); ++gpio) {
-               const char *label = state[gpio].label;
+static char *get_dir_flags_string(ulong flags)
+{
+       if (flags & GPIOD_OPEN_DRAIN)
+               return "drive-open-drain";
+       if (flags & GPIOD_OPEN_SOURCE)
+               return "drive-open-source";
+       if (flags & GPIOD_PULL_UP)
+               return "bias-pull-up";
+       if (flags & GPIOD_PULL_DOWN)
+               return "bias-pull-down";
+       return ".";
+}
 
-               printf("%4d: %s: %d [%c] %s\n",
-                       gpio,
-                       sandbox_gpio_get_direction(gpio) ? "out" : " in",
-                       sandbox_gpio_get_value(gpio),
-                       get_gpio_flag(gpio, GPIOF_RESERVED) ? 'x' : ' ',
-                       label ? label : "");
+static int sb_pinctrl_get_pin_muxing(struct udevice *dev,
+                                    unsigned int selector,
+                                    char *buf, int size)
+{
+       struct udevice *gpio_dev;
+       unsigned int gpio_idx;
+       ulong dir_flags;
+       int function;
+
+       /* look up for the bank which owns the requested pin */
+       gpio_dev = sb_pinctrl_get_gpio_dev(dev, selector, &gpio_idx);
+       if (!gpio_dev) {
+               snprintf(buf, size, "Error");
+       } else {
+               function = sb_gpio_get_function(gpio_dev, gpio_idx);
+               dir_flags = *get_gpio_dir_flags(gpio_dev, gpio_idx);
+
+               snprintf(buf, size, "gpio %s %s",
+                        function == GPIOF_OUTPUT ? "output" : "input",
+                        get_dir_flags_string(dir_flags));
        }
+
+       return 0;
+}
+
+static int sandbox_pinctrl_probe(struct udevice *dev)
+{
+       struct sb_pinctrl_priv *priv = dev_get_priv(dev);
+
+       INIT_LIST_HEAD(&priv->gpio_dev);
+
+       return 0;
 }
+
+static struct pinctrl_ops sandbox_pinctrl_gpio_ops = {
+       .get_pin_name           = sb_pinctrl_get_pin_name,
+       .get_pins_count         = sb_pinctrl_get_pins_count,
+       .get_pin_muxing         = sb_pinctrl_get_pin_muxing,
+};
+
+static const struct udevice_id sandbox_pinctrl_gpio_match[] = {
+       { .compatible = "sandbox,pinctrl-gpio" },
+       { /* sentinel */ }
+};
+
+U_BOOT_DRIVER(sandbox_pinctrl_gpio) = {
+       .name = "sandbox_pinctrl_gpio",
+       .id = UCLASS_PINCTRL,
+       .of_match = sandbox_pinctrl_gpio_match,
+       .ops = &sandbox_pinctrl_gpio_ops,
+       .bind = dm_scan_fdt_dev,
+       .probe = sandbox_pinctrl_probe,
+       .priv_auto_alloc_size   = sizeof(struct sb_pinctrl_priv),
+};