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