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_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         int ret;
 145
 146         debug("%s: offset:%u, value = %d\n", __func__, offset, value);
 147
 148         ret = sandbox_gpio_set_direction(dev, offset, 1);
 149         if (ret)
 150                 return ret;
 151         ret = set_gpio_flag(dev, offset, GPIOD_IS_OUT_ACTIVE | GPIOD_EXT_HIGH,
 152                             value);
 153         if (ret)
 154                 return ret;
 155
 156         return 0;
 157 }
 158
 159 /* read GPIO IN value of port 'offset' */
 160 static int sb_gpio_get_value(struct udevice *dev, unsigned offset)
 161 {
 162         debug("%s: offset:%u\n", __func__, offset);
 163
 164         return sandbox_gpio_get_value(dev, offset);
 165 }
 166
 167 /* write GPIO OUT value to port 'offset' */
 168 static int sb_gpio_set_value(struct udevice *dev, unsigned offset, int value)
 169 {
 170         int ret;
 171
 172         debug("%s: offset:%u, value = %d\n", __func__, offset, value);
 173
 174         if (!sandbox_gpio_get_direction(dev, offset)) {
 175                 printf("sandbox_gpio: error: set_value on input gpio %u\n",
 176                        offset);
 177                 return -1;
 178         }
 179
 180         ret = set_gpio_flag(dev, offset, GPIOD_IS_OUT_ACTIVE | GPIOD_EXT_HIGH,
 181                             value);
 182         if (ret)
 183                 return ret;
 184
 185         return 0;
 186 }
 187
 188 static int sb_gpio_get_function(struct udevice *dev, unsigned offset)
 189 {
 190         if (get_gpio_flag(dev, offset, GPIOD_IS_OUT))
 191                 return GPIOF_OUTPUT;
 192         if (get_gpio_flag(dev, offset, GPIOD_IS_IN))
 193                 return GPIOF_INPUT;
 194
 195         return GPIOF_INPUT; /*GPIO is not configurated */
 196 }
 197
 198 static int sb_gpio_xlate(struct udevice *dev, struct gpio_desc *desc,
 199                          struct ofnode_phandle_args *args)
 200 {
 201         desc->offset = args->args[0];
 202         if (args->args_count < 2)
 203                 return 0;
 204         /* treat generic binding with gpio uclass */
 205         gpio_xlate_offs_flags(dev, desc, args);
 206
 207         /* sandbox test specific, not defined in gpio.h */
 208         if (args->args[1] & GPIO_IN)
 209                 desc->flags |= GPIOD_IS_IN;
 210
 211         if (args->args[1] & GPIO_OUT)
 212                 desc->flags |= GPIOD_IS_OUT;
 213
 214         if (args->args[1] & GPIO_OUT_ACTIVE)
 215                 desc->flags |= GPIOD_IS_OUT_ACTIVE;
 216
 217         return 0;
 218 }
 219
 220 static int sb_gpio_set_flags(struct udevice *dev, unsigned int offset,
 221                              ulong flags)
 222 {
 223         debug("%s: offset:%u, flags = %lx\n", __func__, offset, flags);
 224
 225         return sandbox_gpio_set_flags(dev, offset, flags);
 226 }
 227
 228 static int sb_gpio_get_flags(struct udevice *dev, uint offset, ulong *flagsp)
 229 {
 230         debug("%s: offset:%u\n", __func__, offset);
 231         *flagsp = *get_gpio_flags(dev, offset);
 232
 233         return 0;
 234 }
 235
 236 #if CONFIG_IS_ENABLED(ACPIGEN)
 237 static int sb_gpio_get_acpi(const struct gpio_desc *desc,
 238                             struct acpi_gpio *gpio)
 239 {
 240         int ret;
 241
 242         /* Note that gpio_get_acpi() zeroes *gpio before calling here */
 243         gpio->pin_count = 1;
 244         gpio->pins[0] = desc->offset;
 245         ret = acpi_device_scope(desc->dev, gpio->resource,
 246                                 sizeof(gpio->resource));
 247         if (ret)
 248                 return log_ret(ret);
 249
 250         /* All of these values are just used for testing */
 251         if (desc->flags & GPIOD_ACTIVE_LOW) {
 252                 gpio->pin0_addr = 0x80012 + desc->offset;
 253                 gpio->type = ACPI_GPIO_TYPE_INTERRUPT;
 254                 gpio->pull = ACPI_GPIO_PULL_DOWN;
 255                 gpio->interrupt_debounce_timeout = 4321;
 256
 257                 /* We use the GpioInt part */
 258                 gpio->irq.pin = desc->offset;
 259                 gpio->irq.polarity = ACPI_IRQ_ACTIVE_BOTH;
 260                 gpio->irq.shared = ACPI_IRQ_SHARED;
 261                 gpio->irq.wake = ACPI_IRQ_WAKE;
 262
 263                 /* The GpioIo part is only used for testing */
 264                 gpio->polarity = ACPI_GPIO_ACTIVE_LOW;
 265         } else {
 266                 gpio->pin0_addr = 0xc00dc + desc->offset;
 267                 gpio->type = ACPI_GPIO_TYPE_IO;
 268                 gpio->pull = ACPI_GPIO_PULL_UP;
 269                 gpio->interrupt_debounce_timeout = 0;
 270
 271                 /* The GpioInt part is not used */
 272
 273                 /* We use the GpioIo part */
 274                 gpio->output_drive_strength = 1234;
 275                 gpio->io_shared = true;
 276                 gpio->io_restrict = ACPI_GPIO_IO_RESTRICT_INPUT;
 277                 gpio->polarity = 0;
 278         }
 279
 280         return 0;
 281 }
 282
 283 static int sb_gpio_get_name(const struct udevice *dev, char *out_name)
 284 {
 285         return acpi_copy_name(out_name, "GPIO");
 286 }
 287
 288 struct acpi_ops gpio_sandbox_acpi_ops = {
 289         .get_name       = sb_gpio_get_name,
 290 };
 291 #endif /* ACPIGEN */
 292
 293 static const struct dm_gpio_ops gpio_sandbox_ops = {
 294         .direction_input        = sb_gpio_direction_input,
 295         .direction_output       = sb_gpio_direction_output,
 296         .get_value              = sb_gpio_get_value,
 297         .set_value              = sb_gpio_set_value,
 298         .get_function           = sb_gpio_get_function,
 299         .xlate                  = sb_gpio_xlate,
 300         .set_flags              = sb_gpio_set_flags,
 301         .get_flags              = sb_gpio_get_flags,
 302 #if CONFIG_IS_ENABLED(ACPIGEN)
 303         .get_acpi               = sb_gpio_get_acpi,
 304 #endif
 305 };
 306
 307 static int sandbox_gpio_of_to_plat(struct udevice *dev)
 308 {
 309         struct gpio_dev_priv *uc_priv = dev_get_uclass_priv(dev);
 310
 311         uc_priv->gpio_count = dev_read_u32_default(dev, "sandbox,gpio-count",
 312                                                    0);
 313         uc_priv->bank_name = dev_read_string(dev, "gpio-bank-name");
 314
 315         return 0;
 316 }
 317
 318 static int gpio_sandbox_probe(struct udevice *dev)
 319 {
 320         struct gpio_dev_priv *uc_priv = dev_get_uclass_priv(dev);
 321
 322         if (!dev_has_ofnode(dev))
 323                 /* Tell the uclass how many GPIOs we have */
 324                 uc_priv->gpio_count = CONFIG_SANDBOX_GPIO_COUNT;
 325
 326         dev_set_priv(dev,
 327                      calloc(sizeof(struct gpio_state), uc_priv->gpio_count));
 328
 329         return 0;
 330 }
 331
 332 static int gpio_sandbox_remove(struct udevice *dev)
 333 {
 334         free(dev_get_priv(dev));
 335
 336         return 0;
 337 }
 338
 339 static const struct udevice_id sandbox_gpio_ids[] = {
 340         { .compatible = "sandbox,gpio" },
 341         { }
 342 };
 343
 344 U_BOOT_DRIVER(sandbox_gpio) = {
 345         .name   = "sandbox_gpio",
 346         .id     = UCLASS_GPIO,
 347         .of_match = sandbox_gpio_ids,
 348         .of_to_plat = sandbox_gpio_of_to_plat,
 349         .probe  = gpio_sandbox_probe,
 350         .remove = gpio_sandbox_remove,
 351         .ops    = &gpio_sandbox_ops,
 352         ACPI_OPS_PTR(&gpio_sandbox_acpi_ops)
 353 };
 354
 355 DM_DRIVER_ALIAS(sandbox_gpio, sandbox_gpio_alias)
 356
 357 /* pincontrol: used only to check GPIO pin configuration (pinmux command) */
 358
 359 struct sb_pinctrl_priv {
 360         int pinctrl_ngpios;
 361         struct list_head gpio_dev;
 362 };
 363
 364 struct sb_gpio_bank {
 365         struct udevice *gpio_dev;
 366         struct list_head list;
 367 };
 368
 369 static int sb_populate_gpio_dev_list(struct udevice *dev)
 370 {
 371         struct sb_pinctrl_priv *priv = dev_get_priv(dev);
 372         struct udevice *gpio_dev;
 373         struct udevice *child;
 374         struct sb_gpio_bank *gpio_bank;
 375         int ret;
 376
 377         /*
 378          * parse pin-controller sub-nodes (ie gpio bank nodes) and fill
 379          * a list with all gpio device reference which belongs to the
 380          * current pin-controller. This list is used to find pin_name and
 381          * pin muxing
 382          */
 383         list_for_each_entry(child, &dev->child_head, sibling_node) {
 384                 ret = uclass_get_device_by_name(UCLASS_GPIO, child->name,
 385                                                 &gpio_dev);
 386                 if (ret < 0)
 387                         continue;
 388
 389                 gpio_bank = malloc(sizeof(*gpio_bank));
 390                 if (!gpio_bank) {
 391                         dev_err(dev, "Not enough memory\n");
 392                         return -ENOMEM;
 393                 }
 394
 395                 gpio_bank->gpio_dev = gpio_dev;
 396                 list_add_tail(&gpio_bank->list, &priv->gpio_dev);
 397         }
 398
 399         return 0;
 400 }
 401
 402 static int sb_pinctrl_get_pins_count(struct udevice *dev)
 403 {
 404         struct sb_pinctrl_priv *priv = dev_get_priv(dev);
 405         struct gpio_dev_priv *uc_priv;
 406         struct sb_gpio_bank *gpio_bank;
 407
 408         /*
 409          * if get_pins_count has already been executed once on this
 410          * pin-controller, no need to run it again
 411          */
 412         if (priv->pinctrl_ngpios)
 413                 return priv->pinctrl_ngpios;
 414
 415         if (list_empty(&priv->gpio_dev))
 416                 sb_populate_gpio_dev_list(dev);
 417         /*
 418          * walk through all banks to retrieve the pin-controller
 419          * pins number
 420          */
 421         list_for_each_entry(gpio_bank, &priv->gpio_dev, list) {
 422                 uc_priv = dev_get_uclass_priv(gpio_bank->gpio_dev);
 423
 424                 priv->pinctrl_ngpios += uc_priv->gpio_count;
 425         }
 426
 427         return priv->pinctrl_ngpios;
 428 }
 429
 430 static struct udevice *sb_pinctrl_get_gpio_dev(struct udevice *dev,
 431                                                unsigned int selector,
 432                                                unsigned int *idx)
 433 {
 434         struct sb_pinctrl_priv *priv = dev_get_priv(dev);
 435         struct sb_gpio_bank *gpio_bank;
 436         struct gpio_dev_priv *uc_priv;
 437         int pin_count = 0;
 438
 439         if (list_empty(&priv->gpio_dev))
 440                 sb_populate_gpio_dev_list(dev);
 441
 442         /* look up for the bank which owns the requested pin */
 443         list_for_each_entry(gpio_bank, &priv->gpio_dev, list) {
 444                 uc_priv = dev_get_uclass_priv(gpio_bank->gpio_dev);
 445
 446                 if (selector < (pin_count + uc_priv->gpio_count)) {
 447                         /*
 448                          * we found the bank, convert pin selector to
 449                          * gpio bank index
 450                          */
 451                         *idx = selector - pin_count;
 452
 453                         return gpio_bank->gpio_dev;
 454                 }
 455                 pin_count += uc_priv->gpio_count;
 456         }
 457
 458         return NULL;
 459 }
 460
 461 static const char *sb_pinctrl_get_pin_name(struct udevice *dev,
 462                                            unsigned int selector)
 463 {
 464         struct gpio_dev_priv *uc_priv;
 465         struct udevice *gpio_dev;
 466         unsigned int gpio_idx;
 467         static char pin_name[PINNAME_SIZE];
 468
 469         /* look up for the bank which owns the requested pin */
 470         gpio_dev = sb_pinctrl_get_gpio_dev(dev, selector, &gpio_idx);
 471         if (!gpio_dev) {
 472                 snprintf(pin_name, PINNAME_SIZE, "Error");
 473         } else {
 474                 uc_priv = dev_get_uclass_priv(gpio_dev);
 475
 476                 snprintf(pin_name, PINNAME_SIZE, "%s%d",
 477                          uc_priv->bank_name,
 478                          gpio_idx);
 479         }
 480
 481         return pin_name;
 482 }
 483
 484 static char *get_flags_string(ulong flags)
 485 {
 486         if (flags & GPIOD_OPEN_DRAIN)
 487                 return "drive-open-drain";
 488         if (flags & GPIOD_OPEN_SOURCE)
 489                 return "drive-open-source";
 490         if (flags & GPIOD_PULL_UP)
 491                 return "bias-pull-up";
 492         if (flags & GPIOD_PULL_DOWN)
 493                 return "bias-pull-down";
 494         return ".";
 495 }
 496
 497 static int sb_pinctrl_get_pin_muxing(struct udevice *dev,
 498                                      unsigned int selector,
 499                                      char *buf, int size)
 500 {
 501         struct udevice *gpio_dev;
 502         unsigned int gpio_idx;
 503         ulong flags;
 504         int function;
 505
 506         /* look up for the bank which owns the requested pin */
 507         gpio_dev = sb_pinctrl_get_gpio_dev(dev, selector, &gpio_idx);
 508         if (!gpio_dev) {
 509                 snprintf(buf, size, "Error");
 510         } else {
 511                 function = sb_gpio_get_function(gpio_dev, gpio_idx);
 512                 flags = *get_gpio_flags(gpio_dev, gpio_idx);
 513
 514                 snprintf(buf, size, "gpio %s %s",
 515                          function == GPIOF_OUTPUT ? "output" : "input",
 516                          get_flags_string(flags));
 517         }
 518
 519         return 0;
 520 }
 521
 522 #if CONFIG_IS_ENABLED(ACPIGEN)
 523 static int sb_pinctrl_get_name(const struct udevice *dev, char *out_name)
 524 {
 525         return acpi_copy_name(out_name, "PINC");
 526 }
 527 #endif
 528
 529 static int sandbox_pinctrl_probe(struct udevice *dev)
 530 {
 531         struct sb_pinctrl_priv *priv = dev_get_priv(dev);
 532
 533         INIT_LIST_HEAD(&priv->gpio_dev);
 534
 535         return 0;
 536 }
 537
 538 static struct pinctrl_ops sandbox_pinctrl_gpio_ops = {
 539         .get_pin_name           = sb_pinctrl_get_pin_name,
 540         .get_pins_count         = sb_pinctrl_get_pins_count,
 541         .get_pin_muxing         = sb_pinctrl_get_pin_muxing,
 542 };
 543
 544 #if CONFIG_IS_ENABLED(ACPIGEN)
 545 struct acpi_ops pinctrl_sandbox_acpi_ops = {
 546         .get_name       = sb_pinctrl_get_name,
 547 };
 548 #endif
 549
 550 static const struct udevice_id sandbox_pinctrl_gpio_match[] = {
 551         { .compatible = "sandbox,pinctrl-gpio" },
 552         { /* sentinel */ }
 553 };
 554
 555 U_BOOT_DRIVER(sandbox_pinctrl_gpio) = {
 556         .name = "sandbox_pinctrl_gpio",
 557         .id = UCLASS_PINCTRL,
 558         .of_match = sandbox_pinctrl_gpio_match,
 559         .ops = &sandbox_pinctrl_gpio_ops,
 560         .bind = dm_scan_fdt_dev,
 561         .probe = sandbox_pinctrl_probe,
 562         .priv_auto      = sizeof(struct sb_pinctrl_priv),
 563         ACPI_OPS_PTR(&pinctrl_sandbox_acpi_ops)
 564 };