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