drivers/gpio/sandbox.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (c) 2011 The Chromium OS Authors.
   4  */
   5
   6 #include <common.h>
   7 #include <dm.h>
   8 #include <fdtdec.h>
   9 #include <log.h>
  10 #include <malloc.h>
  11 #include <acpi/acpi_device.h>
  12 #include <asm/gpio.h>
  13 #include <dm/acpi.h>
  14 #include <dm/device-internal.h>
  15 #include <dm/device_compat.h>
  16 #include <dm/lists.h>
  17 #include <dm/of.h>
  18 #include <dm/pinctrl.h>
  19 #include <dt-bindings/gpio/gpio.h>
  20 #include <dt-bindings/gpio/sandbox-gpio.h>
  21
  22
  23 struct gpio_state {
  24         const char *label;      /* label given by requester */
  25         ulong flags;            /* flags (GPIOD_...) */
  26 };
  27
  28 /* Access routines for GPIO info */
  29 static struct gpio_state *get_gpio_state(struct udevice *dev, uint offset)
  30 {
  31         struct gpio_dev_priv *uc_priv = dev_get_uclass_priv(dev);
  32         struct gpio_state *state = dev_get_priv(dev);
  33
  34         if (offset >= uc_priv->gpio_count) {
  35                 printf("sandbox_gpio: error: invalid gpio %u\n", offset);
  36                 return NULL;
  37         }
  38
  39         return &state[offset];
  40 }
  41
  42 /* Access routines for GPIO flags */
  43 static ulong *get_gpio_flags(struct udevice *dev, unsigned int offset)
  44 {
  45         struct gpio_state *state = get_gpio_state(dev, offset);
  46
  47         if (!state)
  48                 return NULL;
  49
  50         return &state->flags;
  51
  52 }
  53
  54 static int get_gpio_flag(struct udevice *dev, unsigned int offset, ulong flag)
  55 {
  56         return (*get_gpio_flags(dev, offset) & flag) != 0;
  57 }
  58
  59 static int set_gpio_flag(struct udevice *dev, unsigned int offset, ulong flag,
  60                          int value)
  61 {
  62         struct gpio_state *state = get_gpio_state(dev, offset);
  63
  64         if (value)
  65                 state->flags |= flag;
  66         else
  67                 state->flags &= ~flag;
  68
  69         return 0;
  70 }
  71
  72 /*
  73  * Back-channel sandbox-internal-only access to GPIO state
  74  */
  75
  76 int sandbox_gpio_get_value(struct udevice *dev, unsigned offset)
  77 {
  78         struct gpio_state *state = get_gpio_state(dev, offset);
  79
  80         if (get_gpio_flag(dev, offset, GPIOD_IS_OUT))
  81                 debug("sandbox_gpio: get_value on output gpio %u\n", offset);
  82
  83         return state->flags & GPIOD_EXT_HIGH ? true : false;
  84 }
  85
  86 int sandbox_gpio_set_value(struct udevice *dev, unsigned offset, int value)
  87 {
  88         set_gpio_flag(dev, offset, GPIOD_IS_OUT_ACTIVE | GPIOD_EXT_HIGH, value);
  89
  90         return 0;
  91 }
  92
  93 int sandbox_gpio_get_direction(struct udevice *dev, unsigned offset)
  94 {
  95         return get_gpio_flag(dev, offset, GPIOD_IS_OUT);
  96 }
  97
  98 int sandbox_gpio_set_direction(struct udevice *dev, unsigned offset, int output)
  99 {
 100         set_gpio_flag(dev, offset, GPIOD_IS_OUT, output);
 101         set_gpio_flag(dev, offset, GPIOD_IS_IN, !output);
 102
 103         return 0;
 104 }
 105
 106 ulong sandbox_gpio_get_flags(struct udevice *dev, uint offset)
 107 {
 108         ulong flags = *get_gpio_flags(dev, offset);
 109
 110         return flags & ~GPIOD_SANDBOX_MASK;
 111 }
 112
 113 int sandbox_gpio_set_flags(struct udevice *dev, uint offset, ulong flags)
 114 {
 115         struct gpio_state *state = get_gpio_state(dev, offset);
 116
 117         /*
 118          * We don't need to clear GPIOD_EXT_HIGH here to make the tests pass,
 119          * but this is handled in a future patch.
 120          */
 121         if (flags & GPIOD_IS_OUT_ACTIVE)
 122                 flags |= GPIOD_EXT_HIGH;
 123         state->flags = (state->flags & GPIOD_SANDBOX_MASK) | flags;
 124
 125         return 0;
 126 }
 127
 128 /*
 129  * These functions implement the public interface within U-Boot
 130  */
 131
 132 /* set GPIO port 'offset' as an input */
 133 static int sb_gpio_direction_input(struct udevice *dev, unsigned offset)
 134 {
 135         debug("%s: offset:%u\n", __func__, offset);
 136
 137         return sandbox_gpio_set_direction(dev, offset, 0);
 138 }
 139
 140 /* set GPIO port 'offset' as an output, with polarity 'value' */
 141 static int sb_gpio_direction_output(struct udevice *dev, unsigned offset,
 142                                     int value)
 143 {
 144         debug("%s: offset:%u, value = %d\n", __func__, offset, value);
 145
 146         return sandbox_gpio_set_direction(dev, offset, 1) |
 147                 sandbox_gpio_set_value(dev, offset, value);
 148 }
 149
 150 /* read GPIO IN value of port 'offset' */
 151 static int sb_gpio_get_value(struct udevice *dev, unsigned offset)
 152 {
 153         debug("%s: offset:%u\n", __func__, offset);
 154
 155         return sandbox_gpio_get_value(dev, offset);
 156 }
 157
 158 /* write GPIO OUT value to port 'offset' */
 159 static int sb_gpio_set_value(struct udevice *dev, unsigned offset, int value)
 160 {
 161         debug("%s: offset:%u, value = %d\n", __func__, offset, value);
 162
 163         if (!sandbox_gpio_get_direction(dev, offset)) {
 164                 printf("sandbox_gpio: error: set_value on input gpio %u\n",
 165                        offset);
 166                 return -1;
 167         }
 168
 169         return sandbox_gpio_set_value(dev, offset, value);
 170 }
 171
 172 static int sb_gpio_get_function(struct udevice *dev, unsigned offset)
 173 {
 174         if (get_gpio_flag(dev, offset, GPIOD_IS_OUT))
 175                 return GPIOF_OUTPUT;
 176         if (get_gpio_flag(dev, offset, GPIOD_IS_IN))
 177                 return GPIOF_INPUT;
 178
 179         return GPIOF_INPUT; /*GPIO is not configurated */
 180 }
 181
 182 static int sb_gpio_xlate(struct udevice *dev, struct gpio_desc *desc,
 183                          struct ofnode_phandle_args *args)
 184 {
 185         desc->offset = args->args[0];
 186         if (args->args_count < 2)
 187                 return 0;
 188         /* treat generic binding with gpio uclass */
 189         gpio_xlate_offs_flags(dev, desc, args);
 190
 191         /* sandbox test specific, not defined in gpio.h */
 192         if (args->args[1] & GPIO_IN)
 193                 desc->flags |= GPIOD_IS_IN;
 194
 195         if (args->args[1] & GPIO_OUT)
 196                 desc->flags |= GPIOD_IS_OUT;
 197
 198         if (args->args[1] & GPIO_OUT_ACTIVE)
 199                 desc->flags |= GPIOD_IS_OUT_ACTIVE;
 200
 201         return 0;
 202 }
 203
 204 static int sb_gpio_set_flags(struct udevice *dev, unsigned int offset,
 205                              ulong flags)
 206 {
 207         debug("%s: offset:%u, flags = %lx\n", __func__, offset, flags);
 208
 209         return sandbox_gpio_set_flags(dev, offset, flags);
 210 }
 211
 212 static int sb_gpio_get_flags(struct udevice *dev, uint offset, ulong *flagsp)
 213 {
 214         debug("%s: offset:%u\n", __func__, offset);
 215         *flagsp = *get_gpio_flags(dev, offset);
 216
 217         return 0;
 218 }
 219
 220 #if CONFIG_IS_ENABLED(ACPIGEN)
 221 static int sb_gpio_get_acpi(const struct gpio_desc *desc,
 222                             struct acpi_gpio *gpio)
 223 {
 224         int ret;
 225
 226         /* Note that gpio_get_acpi() zeroes *gpio before calling here */
 227         gpio->pin_count = 1;
 228         gpio->pins[0] = desc->offset;
 229         ret = acpi_device_scope(desc->dev, gpio->resource,
 230                                 sizeof(gpio->resource));
 231         if (ret)
 232                 return log_ret(ret);
 233
 234         /* All of these values are just used for testing */
 235         if (desc->flags & GPIOD_ACTIVE_LOW) {
 236                 gpio->pin0_addr = 0x80012 + desc->offset;
 237                 gpio->type = ACPI_GPIO_TYPE_INTERRUPT;
 238                 gpio->pull = ACPI_GPIO_PULL_DOWN;
 239                 gpio->interrupt_debounce_timeout = 4321;
 240
 241                 /* We use the GpioInt part */
 242                 gpio->irq.pin = desc->offset;
 243                 gpio->irq.polarity = ACPI_IRQ_ACTIVE_BOTH;
 244                 gpio->irq.shared = ACPI_IRQ_SHARED;
 245                 gpio->irq.wake = ACPI_IRQ_WAKE;
 246
 247                 /* The GpioIo part is only used for testing */
 248                 gpio->polarity = ACPI_GPIO_ACTIVE_LOW;
 249         } else {
 250                 gpio->pin0_addr = 0xc00dc + desc->offset;
 251                 gpio->type = ACPI_GPIO_TYPE_IO;
 252                 gpio->pull = ACPI_GPIO_PULL_UP;
 253                 gpio->interrupt_debounce_timeout = 0;
 254
 255                 /* The GpioInt part is not used */
 256
 257                 /* We use the GpioIo part */
 258                 gpio->output_drive_strength = 1234;
 259                 gpio->io_shared = true;
 260                 gpio->io_restrict = ACPI_GPIO_IO_RESTRICT_INPUT;
 261                 gpio->polarity = 0;
 262         }
 263
 264         return 0;
 265 }
 266
 267 static int sb_gpio_get_name(const struct udevice *dev, char *out_name)
 268 {
 269         return acpi_copy_name(out_name, "GPIO");
 270 }
 271
 272 struct acpi_ops gpio_sandbox_acpi_ops = {
 273         .get_name       = sb_gpio_get_name,
 274 };
 275 #endif /* ACPIGEN */
 276
 277 static const struct dm_gpio_ops gpio_sandbox_ops = {
 278         .direction_input        = sb_gpio_direction_input,
 279         .direction_output       = sb_gpio_direction_output,
 280         .get_value              = sb_gpio_get_value,
 281         .set_value              = sb_gpio_set_value,
 282         .get_function           = sb_gpio_get_function,
 283         .xlate                  = sb_gpio_xlate,
 284         .set_flags              = sb_gpio_set_flags,
 285         .get_flags              = sb_gpio_get_flags,
 286 #if CONFIG_IS_ENABLED(ACPIGEN)
 287         .get_acpi               = sb_gpio_get_acpi,
 288 #endif
 289 };
 290
 291 static int sandbox_gpio_of_to_plat(struct udevice *dev)
 292 {
 293         struct gpio_dev_priv *uc_priv = dev_get_uclass_priv(dev);
 294
 295         uc_priv->gpio_count = dev_read_u32_default(dev, "sandbox,gpio-count",
 296                                                    0);
 297         uc_priv->bank_name = dev_read_string(dev, "gpio-bank-name");
 298
 299         return 0;
 300 }
 301
 302 static int gpio_sandbox_probe(struct udevice *dev)
 303 {
 304         struct gpio_dev_priv *uc_priv = dev_get_uclass_priv(dev);
 305
 306         if (!dev_has_ofnode(dev))
 307                 /* Tell the uclass how many GPIOs we have */
 308                 uc_priv->gpio_count = CONFIG_SANDBOX_GPIO_COUNT;
 309
 310         dev_set_priv(dev,
 311                      calloc(sizeof(struct gpio_state), uc_priv->gpio_count));
 312
 313         return 0;
 314 }
 315
 316 static int gpio_sandbox_remove(struct udevice *dev)
 317 {
 318         free(dev_get_priv(dev));
 319
 320         return 0;
 321 }
 322
 323 static const struct udevice_id sandbox_gpio_ids[] = {
 324         { .compatible = "sandbox,gpio" },
 325         { }
 326 };
 327
 328 U_BOOT_DRIVER(sandbox_gpio) = {
 329         .name   = "sandbox_gpio",
 330         .id     = UCLASS_GPIO,
 331         .of_match = sandbox_gpio_ids,
 332         .of_to_plat = sandbox_gpio_of_to_plat,
 333         .probe  = gpio_sandbox_probe,
 334         .remove = gpio_sandbox_remove,
 335         .ops    = &gpio_sandbox_ops,
 336         ACPI_OPS_PTR(&gpio_sandbox_acpi_ops)
 337 };
 338
 339 DM_DRIVER_ALIAS(sandbox_gpio, sandbox_gpio_alias)
 340
 341 /* pincontrol: used only to check GPIO pin configuration (pinmux command) */
 342
 343 struct sb_pinctrl_priv {
 344         int pinctrl_ngpios;
 345         struct list_head gpio_dev;
 346 };
 347
 348 struct sb_gpio_bank {
 349         struct udevice *gpio_dev;
 350         struct list_head list;
 351 };
 352
 353 static int sb_populate_gpio_dev_list(struct udevice *dev)
 354 {
 355         struct sb_pinctrl_priv *priv = dev_get_priv(dev);
 356         struct udevice *gpio_dev;
 357         struct udevice *child;
 358         struct sb_gpio_bank *gpio_bank;
 359         int ret;
 360
 361         /*
 362          * parse pin-controller sub-nodes (ie gpio bank nodes) and fill
 363          * a list with all gpio device reference which belongs to the
 364          * current pin-controller. This list is used to find pin_name and
 365          * pin muxing
 366          */
 367         list_for_each_entry(child, &dev->child_head, sibling_node) {
 368                 ret = uclass_get_device_by_name(UCLASS_GPIO, child->name,
 369                                                 &gpio_dev);
 370                 if (ret < 0)
 371                         continue;
 372
 373                 gpio_bank = malloc(sizeof(*gpio_bank));
 374                 if (!gpio_bank) {
 375                         dev_err(dev, "Not enough memory\n");
 376                         return -ENOMEM;
 377                 }
 378
 379                 gpio_bank->gpio_dev = gpio_dev;
 380                 list_add_tail(&gpio_bank->list, &priv->gpio_dev);
 381         }
 382
 383         return 0;
 384 }
 385
 386 static int sb_pinctrl_get_pins_count(struct udevice *dev)
 387 {
 388         struct sb_pinctrl_priv *priv = dev_get_priv(dev);
 389         struct gpio_dev_priv *uc_priv;
 390         struct sb_gpio_bank *gpio_bank;
 391
 392         /*
 393          * if get_pins_count has already been executed once on this
 394          * pin-controller, no need to run it again
 395          */
 396         if (priv->pinctrl_ngpios)
 397                 return priv->pinctrl_ngpios;
 398
 399         if (list_empty(&priv->gpio_dev))
 400                 sb_populate_gpio_dev_list(dev);
 401         /*
 402          * walk through all banks to retrieve the pin-controller
 403          * pins number
 404          */
 405         list_for_each_entry(gpio_bank, &priv->gpio_dev, list) {
 406                 uc_priv = dev_get_uclass_priv(gpio_bank->gpio_dev);
 407
 408                 priv->pinctrl_ngpios += uc_priv->gpio_count;
 409         }
 410
 411         return priv->pinctrl_ngpios;
 412 }
 413
 414 static struct udevice *sb_pinctrl_get_gpio_dev(struct udevice *dev,
 415                                                unsigned int selector,
 416                                                unsigned int *idx)
 417 {
 418         struct sb_pinctrl_priv *priv = dev_get_priv(dev);
 419         struct sb_gpio_bank *gpio_bank;
 420         struct gpio_dev_priv *uc_priv;
 421         int pin_count = 0;
 422
 423         if (list_empty(&priv->gpio_dev))
 424                 sb_populate_gpio_dev_list(dev);
 425
 426         /* look up for the bank which owns the requested pin */
 427         list_for_each_entry(gpio_bank, &priv->gpio_dev, list) {
 428                 uc_priv = dev_get_uclass_priv(gpio_bank->gpio_dev);
 429
 430                 if (selector < (pin_count + uc_priv->gpio_count)) {
 431                         /*
 432                          * we found the bank, convert pin selector to
 433                          * gpio bank index
 434                          */
 435                         *idx = selector - pin_count;
 436
 437                         return gpio_bank->gpio_dev;
 438                 }
 439                 pin_count += uc_priv->gpio_count;
 440         }
 441
 442         return NULL;
 443 }
 444
 445 static const char *sb_pinctrl_get_pin_name(struct udevice *dev,
 446                                            unsigned int selector)
 447 {
 448         struct gpio_dev_priv *uc_priv;
 449         struct udevice *gpio_dev;
 450         unsigned int gpio_idx;
 451         static char pin_name[PINNAME_SIZE];
 452
 453         /* look up for the bank which owns the requested pin */
 454         gpio_dev = sb_pinctrl_get_gpio_dev(dev, selector, &gpio_idx);
 455         if (!gpio_dev) {
 456                 snprintf(pin_name, PINNAME_SIZE, "Error");
 457         } else {
 458                 uc_priv = dev_get_uclass_priv(gpio_dev);
 459
 460                 snprintf(pin_name, PINNAME_SIZE, "%s%d",
 461                          uc_priv->bank_name,
 462                          gpio_idx);
 463         }
 464
 465         return pin_name;
 466 }
 467
 468 static char *get_flags_string(ulong flags)
 469 {
 470         if (flags & GPIOD_OPEN_DRAIN)
 471                 return "drive-open-drain";
 472         if (flags & GPIOD_OPEN_SOURCE)
 473                 return "drive-open-source";
 474         if (flags & GPIOD_PULL_UP)
 475                 return "bias-pull-up";
 476         if (flags & GPIOD_PULL_DOWN)
 477                 return "bias-pull-down";
 478         return ".";
 479 }
 480
 481 static int sb_pinctrl_get_pin_muxing(struct udevice *dev,
 482                                      unsigned int selector,
 483                                      char *buf, int size)
 484 {
 485         struct udevice *gpio_dev;
 486         unsigned int gpio_idx;
 487         ulong flags;
 488         int function;
 489
 490         /* look up for the bank which owns the requested pin */
 491         gpio_dev = sb_pinctrl_get_gpio_dev(dev, selector, &gpio_idx);
 492         if (!gpio_dev) {
 493                 snprintf(buf, size, "Error");
 494         } else {
 495                 function = sb_gpio_get_function(gpio_dev, gpio_idx);
 496                 flags = *get_gpio_flags(gpio_dev, gpio_idx);
 497
 498                 snprintf(buf, size, "gpio %s %s",
 499                          function == GPIOF_OUTPUT ? "output" : "input",
 500                          get_flags_string(flags));
 501         }
 502
 503         return 0;
 504 }
 505
 506 #if CONFIG_IS_ENABLED(ACPIGEN)
 507 static int sb_pinctrl_get_name(const struct udevice *dev, char *out_name)
 508 {
 509         return acpi_copy_name(out_name, "PINC");
 510 }
 511 #endif
 512
 513 static int sandbox_pinctrl_probe(struct udevice *dev)
 514 {
 515         struct sb_pinctrl_priv *priv = dev_get_priv(dev);
 516
 517         INIT_LIST_HEAD(&priv->gpio_dev);
 518
 519         return 0;
 520 }
 521
 522 static struct pinctrl_ops sandbox_pinctrl_gpio_ops = {
 523         .get_pin_name           = sb_pinctrl_get_pin_name,
 524         .get_pins_count         = sb_pinctrl_get_pins_count,
 525         .get_pin_muxing         = sb_pinctrl_get_pin_muxing,
 526 };
 527
 528 #if CONFIG_IS_ENABLED(ACPIGEN)
 529 struct acpi_ops pinctrl_sandbox_acpi_ops = {
 530         .get_name       = sb_pinctrl_get_name,
 531 };
 532 #endif
 533
 534 static const struct udevice_id sandbox_pinctrl_gpio_match[] = {
 535         { .compatible = "sandbox,pinctrl-gpio" },
 536         { /* sentinel */ }
 537 };
 538
 539 U_BOOT_DRIVER(sandbox_pinctrl_gpio) = {
 540         .name = "sandbox_pinctrl_gpio",
 541         .id = UCLASS_PINCTRL,
 542         .of_match = sandbox_pinctrl_gpio_match,
 543         .ops = &sandbox_pinctrl_gpio_ops,
 544         .bind = dm_scan_fdt_dev,
 545         .probe = sandbox_pinctrl_probe,
 546         .priv_auto      = sizeof(struct sb_pinctrl_priv),
 547         ACPI_OPS_PTR(&pinctrl_sandbox_acpi_ops)
 548 };