drivers/amba/bus.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  *  linux/arch/arm/common/amba.c
   4  *
   5  *  Copyright (C) 2003 Deep Blue Solutions Ltd, All Rights Reserved.
   6  */
   7 #include <linux/module.h>
   8 #include <linux/init.h>
   9 #include <linux/device.h>
  10 #include <linux/string.h>
  11 #include <linux/slab.h>
  12 #include <linux/io.h>
  13 #include <linux/pm.h>
  14 #include <linux/pm_runtime.h>
  15 #include <linux/pm_domain.h>
  16 #include <linux/amba/bus.h>
  17 #include <linux/sizes.h>
  18 #include <linux/limits.h>
  19 #include <linux/clk/clk-conf.h>
  20 #include <linux/platform_device.h>
  21 #include <linux/reset.h>
  22 #include <linux/of_irq.h>
  23 #include <linux/of_device.h>
  24 #include <linux/acpi.h>
  25 #include <linux/iommu.h>
  26 #include <linux/dma-map-ops.h>
  27
  28 #define to_amba_driver(d)       container_of(d, struct amba_driver, drv)
  29
  30 /* called on periphid match and class 0x9 coresight device. */
  31 static int
  32 amba_cs_uci_id_match(const struct amba_id *table, struct amba_device *dev)
  33 {
  34         int ret = 0;
  35         struct amba_cs_uci_id *uci;
  36
  37         uci = table->data;
  38
  39         /* no table data or zero mask - return match on periphid */
  40         if (!uci || (uci->devarch_mask == 0))
  41                 return 1;
  42
  43         /* test against read devtype and masked devarch value */
  44         ret = (dev->uci.devtype == uci->devtype) &&
  45                 ((dev->uci.devarch & uci->devarch_mask) == uci->devarch);
  46         return ret;
  47 }
  48
  49 static const struct amba_id *
  50 amba_lookup(const struct amba_id *table, struct amba_device *dev)
  51 {
  52         while (table->mask) {
  53                 if (((dev->periphid & table->mask) == table->id) &&
  54                         ((dev->cid != CORESIGHT_CID) ||
  55                          (amba_cs_uci_id_match(table, dev))))
  56                         return table;
  57                 table++;
  58         }
  59         return NULL;
  60 }
  61
  62 static int amba_get_enable_pclk(struct amba_device *pcdev)
  63 {
  64         int ret;
  65
  66         pcdev->pclk = clk_get(&pcdev->dev, "apb_pclk");
  67         if (IS_ERR(pcdev->pclk))
  68                 return PTR_ERR(pcdev->pclk);
  69
  70         ret = clk_prepare_enable(pcdev->pclk);
  71         if (ret)
  72                 clk_put(pcdev->pclk);
  73
  74         return ret;
  75 }
  76
  77 static void amba_put_disable_pclk(struct amba_device *pcdev)
  78 {
  79         clk_disable_unprepare(pcdev->pclk);
  80         clk_put(pcdev->pclk);
  81 }
  82
  83
  84 static ssize_t driver_override_show(struct device *_dev,
  85                                     struct device_attribute *attr, char *buf)
  86 {
  87         struct amba_device *dev = to_amba_device(_dev);
  88         ssize_t len;
  89
  90         device_lock(_dev);
  91         len = sprintf(buf, "%s\n", dev->driver_override);
  92         device_unlock(_dev);
  93         return len;
  94 }
  95
  96 static ssize_t driver_override_store(struct device *_dev,
  97                                      struct device_attribute *attr,
  98                                      const char *buf, size_t count)
  99 {
 100         struct amba_device *dev = to_amba_device(_dev);
 101         int ret;
 102
 103         ret = driver_set_override(_dev, &dev->driver_override, buf, count);
 104         if (ret)
 105                 return ret;
 106
 107         return count;
 108 }
 109 static DEVICE_ATTR_RW(driver_override);
 110
 111 #define amba_attr_func(name,fmt,arg...)                                 \
 112 static ssize_t name##_show(struct device *_dev,                         \
 113                            struct device_attribute *attr, char *buf)    \
 114 {                                                                       \
 115         struct amba_device *dev = to_amba_device(_dev);                 \
 116         return sprintf(buf, fmt, arg);                                  \
 117 }                                                                       \
 118 static DEVICE_ATTR_RO(name)
 119
 120 amba_attr_func(id, "%08x\n", dev->periphid);
 121 amba_attr_func(resource, "\t%016llx\t%016llx\t%016lx\n",
 122          (unsigned long long)dev->res.start, (unsigned long long)dev->res.end,
 123          dev->res.flags);
 124
 125 static struct attribute *amba_dev_attrs[] = {
 126         &dev_attr_id.attr,
 127         &dev_attr_resource.attr,
 128         &dev_attr_driver_override.attr,
 129         NULL,
 130 };
 131 ATTRIBUTE_GROUPS(amba_dev);
 132
 133 static int amba_read_periphid(struct amba_device *dev)
 134 {
 135         struct reset_control *rstc;
 136         u32 size, pid, cid;
 137         void __iomem *tmp;
 138         int i, ret;
 139
 140         ret = dev_pm_domain_attach(&dev->dev, true);
 141         if (ret) {
 142                 dev_dbg(&dev->dev, "can't get PM domain: %d\n", ret);
 143                 goto err_out;
 144         }
 145
 146         ret = amba_get_enable_pclk(dev);
 147         if (ret) {
 148                 dev_dbg(&dev->dev, "can't get pclk: %d\n", ret);
 149                 goto err_pm;
 150         }
 151
 152         /*
 153          * Find reset control(s) of the amba bus and de-assert them.
 154          */
 155         rstc = of_reset_control_array_get_optional_shared(dev->dev.of_node);
 156         if (IS_ERR(rstc)) {
 157                 ret = PTR_ERR(rstc);
 158                 if (ret != -EPROBE_DEFER)
 159                         dev_err(&dev->dev, "can't get reset: %d\n", ret);
 160                 goto err_clk;
 161         }
 162         reset_control_deassert(rstc);
 163         reset_control_put(rstc);
 164
 165         size = resource_size(&dev->res);
 166         tmp = ioremap(dev->res.start, size);
 167         if (!tmp) {
 168                 ret = -ENOMEM;
 169                 goto err_clk;
 170         }
 171
 172         /*
 173          * Read pid and cid based on size of resource
 174          * they are located at end of region
 175          */
 176         for (pid = 0, i = 0; i < 4; i++)
 177                 pid |= (readl(tmp + size - 0x20 + 4 * i) & 255) << (i * 8);
 178         for (cid = 0, i = 0; i < 4; i++)
 179                 cid |= (readl(tmp + size - 0x10 + 4 * i) & 255) << (i * 8);
 180
 181         if (cid == CORESIGHT_CID) {
 182                 /* set the base to the start of the last 4k block */
 183                 void __iomem *csbase = tmp + size - 4096;
 184
 185                 dev->uci.devarch = readl(csbase + UCI_REG_DEVARCH_OFFSET);
 186                 dev->uci.devtype = readl(csbase + UCI_REG_DEVTYPE_OFFSET) & 0xff;
 187         }
 188
 189         if (cid == AMBA_CID || cid == CORESIGHT_CID) {
 190                 dev->periphid = pid;
 191                 dev->cid = cid;
 192         }
 193
 194         if (!dev->periphid)
 195                 ret = -ENODEV;
 196
 197         iounmap(tmp);
 198
 199 err_clk:
 200         amba_put_disable_pclk(dev);
 201 err_pm:
 202         dev_pm_domain_detach(&dev->dev, true);
 203 err_out:
 204         return ret;
 205 }
 206
 207 static int amba_match(struct device *dev, struct device_driver *drv)
 208 {
 209         struct amba_device *pcdev = to_amba_device(dev);
 210         struct amba_driver *pcdrv = to_amba_driver(drv);
 211
 212         if (!pcdev->periphid) {
 213                 int ret = amba_read_periphid(pcdev);
 214
 215                 /*
 216                  * Returning any error other than -EPROBE_DEFER from bus match
 217                  * can cause driver registration failure. So, if there's a
 218                  * permanent failure in reading pid and cid, simply map it to
 219                  * -EPROBE_DEFER.
 220                  */
 221                 if (ret)
 222                         return -EPROBE_DEFER;
 223                 dev_set_uevent_suppress(dev, false);
 224                 kobject_uevent(&dev->kobj, KOBJ_ADD);
 225         }
 226
 227         /* When driver_override is set, only bind to the matching driver */
 228         if (pcdev->driver_override)
 229                 return !strcmp(pcdev->driver_override, drv->name);
 230
 231         return amba_lookup(pcdrv->id_table, pcdev) != NULL;
 232 }
 233
 234 static int amba_uevent(struct device *dev, struct kobj_uevent_env *env)
 235 {
 236         struct amba_device *pcdev = to_amba_device(dev);
 237         int retval = 0;
 238
 239         retval = add_uevent_var(env, "AMBA_ID=%08x", pcdev->periphid);
 240         if (retval)
 241                 return retval;
 242
 243         retval = add_uevent_var(env, "MODALIAS=amba:d%08X", pcdev->periphid);
 244         return retval;
 245 }
 246
 247 static int of_amba_device_decode_irq(struct amba_device *dev)
 248 {
 249         struct device_node *node = dev->dev.of_node;
 250         int i, irq = 0;
 251
 252         if (IS_ENABLED(CONFIG_OF_IRQ) && node) {
 253                 /* Decode the IRQs and address ranges */
 254                 for (i = 0; i < AMBA_NR_IRQS; i++) {
 255                         irq = of_irq_get(node, i);
 256                         if (irq < 0) {
 257                                 if (irq == -EPROBE_DEFER)
 258                                         return irq;
 259                                 irq = 0;
 260                         }
 261
 262                         dev->irq[i] = irq;
 263                 }
 264         }
 265
 266         return 0;
 267 }
 268
 269 /*
 270  * These are the device model conversion veneers; they convert the
 271  * device model structures to our more specific structures.
 272  */
 273 static int amba_probe(struct device *dev)
 274 {
 275         struct amba_device *pcdev = to_amba_device(dev);
 276         struct amba_driver *pcdrv = to_amba_driver(dev->driver);
 277         const struct amba_id *id = amba_lookup(pcdrv->id_table, pcdev);
 278         int ret;
 279
 280         do {
 281                 ret = of_amba_device_decode_irq(pcdev);
 282                 if (ret)
 283                         break;
 284
 285                 ret = of_clk_set_defaults(dev->of_node, false);
 286                 if (ret < 0)
 287                         break;
 288
 289                 ret = dev_pm_domain_attach(dev, true);
 290                 if (ret)
 291                         break;
 292
 293                 ret = amba_get_enable_pclk(pcdev);
 294                 if (ret) {
 295                         dev_pm_domain_detach(dev, true);
 296                         break;
 297                 }
 298
 299                 pm_runtime_get_noresume(dev);
 300                 pm_runtime_set_active(dev);
 301                 pm_runtime_enable(dev);
 302
 303                 ret = pcdrv->probe(pcdev, id);
 304                 if (ret == 0)
 305                         break;
 306
 307                 pm_runtime_disable(dev);
 308                 pm_runtime_set_suspended(dev);
 309                 pm_runtime_put_noidle(dev);
 310
 311                 amba_put_disable_pclk(pcdev);
 312                 dev_pm_domain_detach(dev, true);
 313         } while (0);
 314
 315         return ret;
 316 }
 317
 318 static void amba_remove(struct device *dev)
 319 {
 320         struct amba_device *pcdev = to_amba_device(dev);
 321         struct amba_driver *drv = to_amba_driver(dev->driver);
 322
 323         pm_runtime_get_sync(dev);
 324         if (drv->remove)
 325                 drv->remove(pcdev);
 326         pm_runtime_put_noidle(dev);
 327
 328         /* Undo the runtime PM settings in amba_probe() */
 329         pm_runtime_disable(dev);
 330         pm_runtime_set_suspended(dev);
 331         pm_runtime_put_noidle(dev);
 332
 333         amba_put_disable_pclk(pcdev);
 334         dev_pm_domain_detach(dev, true);
 335 }
 336
 337 static void amba_shutdown(struct device *dev)
 338 {
 339         struct amba_driver *drv;
 340
 341         if (!dev->driver)
 342                 return;
 343
 344         drv = to_amba_driver(dev->driver);
 345         if (drv->shutdown)
 346                 drv->shutdown(to_amba_device(dev));
 347 }
 348
 349 static int amba_dma_configure(struct device *dev)
 350 {
 351         struct amba_driver *drv = to_amba_driver(dev->driver);
 352         enum dev_dma_attr attr;
 353         int ret = 0;
 354
 355         if (dev->of_node) {
 356                 ret = of_dma_configure(dev, dev->of_node, true);
 357         } else if (has_acpi_companion(dev)) {
 358                 attr = acpi_get_dma_attr(to_acpi_device_node(dev->fwnode));
 359                 ret = acpi_dma_configure(dev, attr);
 360         }
 361
 362         if (!ret && !drv->driver_managed_dma) {
 363                 ret = iommu_device_use_default_domain(dev);
 364                 if (ret)
 365                         arch_teardown_dma_ops(dev);
 366         }
 367
 368         return ret;
 369 }
 370
 371 static void amba_dma_cleanup(struct device *dev)
 372 {
 373         struct amba_driver *drv = to_amba_driver(dev->driver);
 374
 375         if (!drv->driver_managed_dma)
 376                 iommu_device_unuse_default_domain(dev);
 377 }
 378
 379 #ifdef CONFIG_PM
 380 /*
 381  * Hooks to provide runtime PM of the pclk (bus clock).  It is safe to
 382  * enable/disable the bus clock at runtime PM suspend/resume as this
 383  * does not result in loss of context.
 384  */
 385 static int amba_pm_runtime_suspend(struct device *dev)
 386 {
 387         struct amba_device *pcdev = to_amba_device(dev);
 388         int ret = pm_generic_runtime_suspend(dev);
 389
 390         if (ret == 0 && dev->driver) {
 391                 if (pm_runtime_is_irq_safe(dev))
 392                         clk_disable(pcdev->pclk);
 393                 else
 394                         clk_disable_unprepare(pcdev->pclk);
 395         }
 396
 397         return ret;
 398 }
 399
 400 static int amba_pm_runtime_resume(struct device *dev)
 401 {
 402         struct amba_device *pcdev = to_amba_device(dev);
 403         int ret;
 404
 405         if (dev->driver) {
 406                 if (pm_runtime_is_irq_safe(dev))
 407                         ret = clk_enable(pcdev->pclk);
 408                 else
 409                         ret = clk_prepare_enable(pcdev->pclk);
 410                 /* Failure is probably fatal to the system, but... */
 411                 if (ret)
 412                         return ret;
 413         }
 414
 415         return pm_generic_runtime_resume(dev);
 416 }
 417 #endif /* CONFIG_PM */
 418
 419 static const struct dev_pm_ops amba_pm = {
 420         .suspend        = pm_generic_suspend,
 421         .resume         = pm_generic_resume,
 422         .freeze         = pm_generic_freeze,
 423         .thaw           = pm_generic_thaw,
 424         .poweroff       = pm_generic_poweroff,
 425         .restore        = pm_generic_restore,
 426         SET_RUNTIME_PM_OPS(
 427                 amba_pm_runtime_suspend,
 428                 amba_pm_runtime_resume,
 429                 NULL
 430         )
 431 };
 432
 433 /*
 434  * Primecells are part of the Advanced Microcontroller Bus Architecture,
 435  * so we call the bus "amba".
 436  * DMA configuration for platform and AMBA bus is same. So here we reuse
 437  * platform's DMA config routine.
 438  */
 439 struct bus_type amba_bustype = {
 440         .name           = "amba",
 441         .dev_groups     = amba_dev_groups,
 442         .match          = amba_match,
 443         .uevent         = amba_uevent,
 444         .probe          = amba_probe,
 445         .remove         = amba_remove,
 446         .shutdown       = amba_shutdown,
 447         .dma_configure  = amba_dma_configure,
 448         .dma_cleanup    = amba_dma_cleanup,
 449         .pm             = &amba_pm,
 450 };
 451 EXPORT_SYMBOL_GPL(amba_bustype);
 452
 453 static int __init amba_init(void)
 454 {
 455         return bus_register(&amba_bustype);
 456 }
 457
 458 postcore_initcall(amba_init);
 459
 460 static int amba_proxy_probe(struct amba_device *adev,
 461                             const struct amba_id *id)
 462 {
 463         WARN(1, "Stub driver should never match any device.\n");
 464         return -ENODEV;
 465 }
 466
 467 static const struct amba_id amba_stub_drv_ids[] = {
 468         { 0, 0 },
 469 };
 470
 471 static struct amba_driver amba_proxy_drv = {
 472         .drv = {
 473                 .name = "amba-proxy",
 474         },
 475         .probe = amba_proxy_probe,
 476         .id_table = amba_stub_drv_ids,
 477 };
 478
 479 static int __init amba_stub_drv_init(void)
 480 {
 481         if (!IS_ENABLED(CONFIG_MODULES))
 482                 return 0;
 483
 484         /*
 485          * The amba_match() function will get called only if there is at least
 486          * one amba driver registered. If all amba drivers are modules and are
 487          * only loaded based on uevents, then we'll hit a chicken-and-egg
 488          * situation where amba_match() is waiting on drivers and drivers are
 489          * waiting on amba_match(). So, register a stub driver to make sure
 490          * amba_match() is called even if no amba driver has been registered.
 491          */
 492         return amba_driver_register(&amba_proxy_drv);
 493 }
 494 late_initcall_sync(amba_stub_drv_init);
 495
 496 /**
 497  *      amba_driver_register - register an AMBA device driver
 498  *      @drv: amba device driver structure
 499  *
 500  *      Register an AMBA device driver with the Linux device model
 501  *      core.  If devices pre-exist, the drivers probe function will
 502  *      be called.
 503  */
 504 int amba_driver_register(struct amba_driver *drv)
 505 {
 506         if (!drv->probe)
 507                 return -EINVAL;
 508
 509         drv->drv.bus = &amba_bustype;
 510
 511         return driver_register(&drv->drv);
 512 }
 513 EXPORT_SYMBOL(amba_driver_register);
 514
 515 /**
 516  *      amba_driver_unregister - remove an AMBA device driver
 517  *      @drv: AMBA device driver structure to remove
 518  *
 519  *      Unregister an AMBA device driver from the Linux device
 520  *      model.  The device model will call the drivers remove function
 521  *      for each device the device driver is currently handling.
 522  */
 523 void amba_driver_unregister(struct amba_driver *drv)
 524 {
 525         driver_unregister(&drv->drv);
 526 }
 527 EXPORT_SYMBOL(amba_driver_unregister);
 528
 529 static void amba_device_release(struct device *dev)
 530 {
 531         struct amba_device *d = to_amba_device(dev);
 532
 533         if (d->res.parent)
 534                 release_resource(&d->res);
 535         kfree(d);
 536 }
 537
 538 /**
 539  *      amba_device_add - add a previously allocated AMBA device structure
 540  *      @dev: AMBA device allocated by amba_device_alloc
 541  *      @parent: resource parent for this devices resources
 542  *
 543  *      Claim the resource, and read the device cell ID if not already
 544  *      initialized.  Register the AMBA device with the Linux device
 545  *      manager.
 546  */
 547 int amba_device_add(struct amba_device *dev, struct resource *parent)
 548 {
 549         int ret;
 550
 551         ret = request_resource(parent, &dev->res);
 552         if (ret)
 553                 return ret;
 554
 555         /* If primecell ID isn't hard-coded, figure it out */
 556         if (!dev->periphid) {
 557                 /*
 558                  * AMBA device uevents require reading its pid and cid
 559                  * registers.  To do this, the device must be on, clocked and
 560                  * out of reset.  However in some cases those resources might
 561                  * not yet be available.  If that's the case, we suppress the
 562                  * generation of uevents until we can read the pid and cid
 563                  * registers.  See also amba_match().
 564                  */
 565                 if (amba_read_periphid(dev))
 566                         dev_set_uevent_suppress(&dev->dev, true);
 567         }
 568
 569         ret = device_add(&dev->dev);
 570         if (ret)
 571                 release_resource(&dev->res);
 572
 573         return ret;
 574 }
 575 EXPORT_SYMBOL_GPL(amba_device_add);
 576
 577 static void amba_device_initialize(struct amba_device *dev, const char *name)
 578 {
 579         device_initialize(&dev->dev);
 580         if (name)
 581                 dev_set_name(&dev->dev, "%s", name);
 582         dev->dev.release = amba_device_release;
 583         dev->dev.bus = &amba_bustype;
 584         dev->dev.dma_mask = &dev->dev.coherent_dma_mask;
 585         dev->dev.dma_parms = &dev->dma_parms;
 586         dev->res.name = dev_name(&dev->dev);
 587 }
 588
 589 /**
 590  *      amba_device_alloc - allocate an AMBA device
 591  *      @name: sysfs name of the AMBA device
 592  *      @base: base of AMBA device
 593  *      @size: size of AMBA device
 594  *
 595  *      Allocate and initialize an AMBA device structure.  Returns %NULL
 596  *      on failure.
 597  */
 598 struct amba_device *amba_device_alloc(const char *name, resource_size_t base,
 599         size_t size)
 600 {
 601         struct amba_device *dev;
 602
 603         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
 604         if (dev) {
 605                 amba_device_initialize(dev, name);
 606                 dev->res.start = base;
 607                 dev->res.end = base + size - 1;
 608                 dev->res.flags = IORESOURCE_MEM;
 609         }
 610
 611         return dev;
 612 }
 613 EXPORT_SYMBOL_GPL(amba_device_alloc);
 614
 615 /**
 616  *      amba_device_register - register an AMBA device
 617  *      @dev: AMBA device to register
 618  *      @parent: parent memory resource
 619  *
 620  *      Setup the AMBA device, reading the cell ID if present.
 621  *      Claim the resource, and register the AMBA device with
 622  *      the Linux device manager.
 623  */
 624 int amba_device_register(struct amba_device *dev, struct resource *parent)
 625 {
 626         amba_device_initialize(dev, dev->dev.init_name);
 627         dev->dev.init_name = NULL;
 628
 629         return amba_device_add(dev, parent);
 630 }
 631 EXPORT_SYMBOL(amba_device_register);
 632
 633 /**
 634  *      amba_device_put - put an AMBA device
 635  *      @dev: AMBA device to put
 636  */
 637 void amba_device_put(struct amba_device *dev)
 638 {
 639         put_device(&dev->dev);
 640 }
 641 EXPORT_SYMBOL_GPL(amba_device_put);
 642
 643 /**
 644  *      amba_device_unregister - unregister an AMBA device
 645  *      @dev: AMBA device to remove
 646  *
 647  *      Remove the specified AMBA device from the Linux device
 648  *      manager.  All files associated with this object will be
 649  *      destroyed, and device drivers notified that the device has
 650  *      been removed.  The AMBA device's resources including
 651  *      the amba_device structure will be freed once all
 652  *      references to it have been dropped.
 653  */
 654 void amba_device_unregister(struct amba_device *dev)
 655 {
 656         device_unregister(&dev->dev);
 657 }
 658 EXPORT_SYMBOL(amba_device_unregister);
 659
 660 /**
 661  *      amba_request_regions - request all mem regions associated with device
 662  *      @dev: amba_device structure for device
 663  *      @name: name, or NULL to use driver name
 664  */
 665 int amba_request_regions(struct amba_device *dev, const char *name)
 666 {
 667         int ret = 0;
 668         u32 size;
 669
 670         if (!name)
 671                 name = dev->dev.driver->name;
 672
 673         size = resource_size(&dev->res);
 674
 675         if (!request_mem_region(dev->res.start, size, name))
 676                 ret = -EBUSY;
 677
 678         return ret;
 679 }
 680 EXPORT_SYMBOL(amba_request_regions);
 681
 682 /**
 683  *      amba_release_regions - release mem regions associated with device
 684  *      @dev: amba_device structure for device
 685  *
 686  *      Release regions claimed by a successful call to amba_request_regions.
 687  */
 688 void amba_release_regions(struct amba_device *dev)
 689 {
 690         u32 size;
 691
 692         size = resource_size(&dev->res);
 693         release_mem_region(dev->res.start, size);
 694 }
 695 EXPORT_SYMBOL(amba_release_regions);