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