drivers/usb/host/xhci-plat.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * xhci-plat.c - xHCI host controller driver platform Bus Glue.
   4  *
   5  * Copyright (C) 2012 Texas Instruments Incorporated - https://www.ti.com
   6  * Author: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
   7  *
   8  * A lot of code borrowed from the Linux xHCI driver.
   9  */
  10
  11 #include <linux/clk.h>
  12 #include <linux/dma-mapping.h>
  13 #include <linux/module.h>
  14 #include <linux/pci.h>
  15 #include <linux/of.h>
  16 #include <linux/of_device.h>
  17 #include <linux/platform_device.h>
  18 #include <linux/usb/phy.h>
  19 #include <linux/slab.h>
  20 #include <linux/acpi.h>
  21 #include <linux/usb/of.h>
  22
  23 #include "xhci.h"
  24 #include "xhci-plat.h"
  25 #include "xhci-mvebu.h"
  26 #include "xhci-rcar.h"
  27
  28 static struct hc_driver __read_mostly xhci_plat_hc_driver;
  29
  30 static int xhci_plat_setup(struct usb_hcd *hcd);
  31 static int xhci_plat_start(struct usb_hcd *hcd);
  32
  33 static const struct xhci_driver_overrides xhci_plat_overrides __initconst = {
  34         .extra_priv_size = sizeof(struct xhci_plat_priv),
  35         .reset = xhci_plat_setup,
  36         .start = xhci_plat_start,
  37 };
  38
  39 static void xhci_priv_plat_start(struct usb_hcd *hcd)
  40 {
  41         struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
  42
  43         if (priv->plat_start)
  44                 priv->plat_start(hcd);
  45 }
  46
  47 static int xhci_priv_plat_setup(struct usb_hcd *hcd)
  48 {
  49         struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
  50
  51         if (!priv->plat_setup)
  52                 return 0;
  53
  54         return priv->plat_setup(hcd);
  55 }
  56
  57 static int xhci_priv_init_quirk(struct usb_hcd *hcd)
  58 {
  59         struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
  60
  61         if (!priv->init_quirk)
  62                 return 0;
  63
  64         return priv->init_quirk(hcd);
  65 }
  66
  67 static int xhci_priv_suspend_quirk(struct usb_hcd *hcd)
  68 {
  69         struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
  70
  71         if (!priv->suspend_quirk)
  72                 return 0;
  73
  74         return priv->suspend_quirk(hcd);
  75 }
  76
  77 static int xhci_priv_resume_quirk(struct usb_hcd *hcd)
  78 {
  79         struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
  80
  81         if (!priv->resume_quirk)
  82                 return 0;
  83
  84         return priv->resume_quirk(hcd);
  85 }
  86
  87 static void xhci_plat_quirks(struct device *dev, struct xhci_hcd *xhci)
  88 {
  89         struct xhci_plat_priv *priv = xhci_to_priv(xhci);
  90
  91         /*
  92          * As of now platform drivers don't provide MSI support so we ensure
  93          * here that the generic code does not try to make a pci_dev from our
  94          * dev struct in order to setup MSI
  95          */
  96         xhci->quirks |= XHCI_PLAT | priv->quirks;
  97 }
  98
  99 /* called during probe() after chip reset completes */
 100 static int xhci_plat_setup(struct usb_hcd *hcd)
 101 {
 102         int ret;
 103
 104
 105         ret = xhci_priv_init_quirk(hcd);
 106         if (ret)
 107                 return ret;
 108
 109         return xhci_gen_setup(hcd, xhci_plat_quirks);
 110 }
 111
 112 static int xhci_plat_start(struct usb_hcd *hcd)
 113 {
 114         xhci_priv_plat_start(hcd);
 115         return xhci_run(hcd);
 116 }
 117
 118 #ifdef CONFIG_OF
 119 static const struct xhci_plat_priv xhci_plat_marvell_armada = {
 120         .init_quirk = xhci_mvebu_mbus_init_quirk,
 121 };
 122
 123 static const struct xhci_plat_priv xhci_plat_marvell_armada3700 = {
 124         .plat_setup = xhci_mvebu_a3700_plat_setup,
 125         .init_quirk = xhci_mvebu_a3700_init_quirk,
 126 };
 127
 128 static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen2 = {
 129         SET_XHCI_PLAT_PRIV_FOR_RCAR(XHCI_RCAR_FIRMWARE_NAME_V1)
 130 };
 131
 132 static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen3 = {
 133         SET_XHCI_PLAT_PRIV_FOR_RCAR(XHCI_RCAR_FIRMWARE_NAME_V3)
 134 };
 135
 136 static const struct xhci_plat_priv xhci_plat_brcm = {
 137         .quirks = XHCI_RESET_ON_RESUME,
 138 };
 139
 140 static const struct of_device_id usb_xhci_of_match[] = {
 141         {
 142                 .compatible = "generic-xhci",
 143         }, {
 144                 .compatible = "xhci-platform",
 145         }, {
 146                 .compatible = "marvell,armada-375-xhci",
 147                 .data = &xhci_plat_marvell_armada,
 148         }, {
 149                 .compatible = "marvell,armada-380-xhci",
 150                 .data = &xhci_plat_marvell_armada,
 151         }, {
 152                 .compatible = "marvell,armada3700-xhci",
 153                 .data = &xhci_plat_marvell_armada3700,
 154         }, {
 155                 .compatible = "renesas,xhci-r8a7790",
 156                 .data = &xhci_plat_renesas_rcar_gen2,
 157         }, {
 158                 .compatible = "renesas,xhci-r8a7791",
 159                 .data = &xhci_plat_renesas_rcar_gen2,
 160         }, {
 161                 .compatible = "renesas,xhci-r8a7793",
 162                 .data = &xhci_plat_renesas_rcar_gen2,
 163         }, {
 164                 .compatible = "renesas,xhci-r8a7795",
 165                 .data = &xhci_plat_renesas_rcar_gen3,
 166         }, {
 167                 .compatible = "renesas,xhci-r8a7796",
 168                 .data = &xhci_plat_renesas_rcar_gen3,
 169         }, {
 170                 .compatible = "renesas,rcar-gen2-xhci",
 171                 .data = &xhci_plat_renesas_rcar_gen2,
 172         }, {
 173                 .compatible = "renesas,rcar-gen3-xhci",
 174                 .data = &xhci_plat_renesas_rcar_gen3,
 175         }, {
 176                 .compatible = "brcm,xhci-brcm-v2",
 177                 .data = &xhci_plat_brcm,
 178         }, {
 179                 .compatible = "brcm,bcm7445-xhci",
 180                 .data = &xhci_plat_brcm,
 181         },
 182         {},
 183 };
 184 MODULE_DEVICE_TABLE(of, usb_xhci_of_match);
 185 #endif
 186
 187 static int xhci_plat_probe(struct platform_device *pdev)
 188 {
 189         const struct xhci_plat_priv *priv_match;
 190         const struct hc_driver  *driver;
 191         struct device           *sysdev, *tmpdev;
 192         struct xhci_hcd         *xhci;
 193         struct resource         *res;
 194         struct usb_hcd          *hcd;
 195         int                     ret;
 196         int                     irq;
 197         struct xhci_plat_priv   *priv = NULL;
 198
 199
 200         if (usb_disabled())
 201                 return -ENODEV;
 202
 203         driver = &xhci_plat_hc_driver;
 204
 205         irq = platform_get_irq(pdev, 0);
 206         if (irq < 0)
 207                 return irq;
 208
 209         /*
 210          * sysdev must point to a device that is known to the system firmware
 211          * or PCI hardware. We handle these three cases here:
 212          * 1. xhci_plat comes from firmware
 213          * 2. xhci_plat is child of a device from firmware (dwc3-plat)
 214          * 3. xhci_plat is grandchild of a pci device (dwc3-pci)
 215          */
 216         for (sysdev = &pdev->dev; sysdev; sysdev = sysdev->parent) {
 217                 if (is_of_node(sysdev->fwnode) ||
 218                         is_acpi_device_node(sysdev->fwnode))
 219                         break;
 220 #ifdef CONFIG_PCI
 221                 else if (sysdev->bus == &pci_bus_type)
 222                         break;
 223 #endif
 224         }
 225
 226         if (!sysdev)
 227                 sysdev = &pdev->dev;
 228
 229         /* Try to set 64-bit DMA first */
 230         if (WARN_ON(!sysdev->dma_mask))
 231                 /* Platform did not initialize dma_mask */
 232                 ret = dma_coerce_mask_and_coherent(sysdev,
 233                                                    DMA_BIT_MASK(64));
 234         else
 235                 ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(64));
 236
 237         /* If seting 64-bit DMA mask fails, fall back to 32-bit DMA mask */
 238         if (ret) {
 239                 ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(32));
 240                 if (ret)
 241                         return ret;
 242         }
 243
 244         pm_runtime_set_active(&pdev->dev);
 245         pm_runtime_enable(&pdev->dev);
 246         pm_runtime_get_noresume(&pdev->dev);
 247
 248         hcd = __usb_create_hcd(driver, sysdev, &pdev->dev,
 249                                dev_name(&pdev->dev), NULL);
 250         if (!hcd) {
 251                 ret = -ENOMEM;
 252                 goto disable_runtime;
 253         }
 254
 255         hcd->regs = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
 256         if (IS_ERR(hcd->regs)) {
 257                 ret = PTR_ERR(hcd->regs);
 258                 goto put_hcd;
 259         }
 260
 261         hcd->rsrc_start = res->start;
 262         hcd->rsrc_len = resource_size(res);
 263
 264         xhci = hcd_to_xhci(hcd);
 265
 266         /*
 267          * Not all platforms have clks so it is not an error if the
 268          * clock do not exist.
 269          */
 270         xhci->reg_clk = devm_clk_get_optional(&pdev->dev, "reg");
 271         if (IS_ERR(xhci->reg_clk)) {
 272                 ret = PTR_ERR(xhci->reg_clk);
 273                 goto put_hcd;
 274         }
 275
 276         ret = clk_prepare_enable(xhci->reg_clk);
 277         if (ret)
 278                 goto put_hcd;
 279
 280         xhci->clk = devm_clk_get_optional(&pdev->dev, NULL);
 281         if (IS_ERR(xhci->clk)) {
 282                 ret = PTR_ERR(xhci->clk);
 283                 goto disable_reg_clk;
 284         }
 285
 286         ret = clk_prepare_enable(xhci->clk);
 287         if (ret)
 288                 goto disable_reg_clk;
 289
 290         if (pdev->dev.of_node)
 291                 priv_match = of_device_get_match_data(&pdev->dev);
 292         else
 293                 priv_match = dev_get_platdata(&pdev->dev);
 294
 295         if (priv_match) {
 296                 priv = hcd_to_xhci_priv(hcd);
 297                 /* Just copy data for now */
 298                 *priv = *priv_match;
 299         }
 300
 301         device_set_wakeup_capable(&pdev->dev, true);
 302
 303         xhci->main_hcd = hcd;
 304         xhci->shared_hcd = __usb_create_hcd(driver, sysdev, &pdev->dev,
 305                         dev_name(&pdev->dev), hcd);
 306         if (!xhci->shared_hcd) {
 307                 ret = -ENOMEM;
 308                 goto disable_clk;
 309         }
 310
 311         /* imod_interval is the interrupt moderation value in nanoseconds. */
 312         xhci->imod_interval = 40000;
 313
 314         /* Iterate over all parent nodes for finding quirks */
 315         for (tmpdev = &pdev->dev; tmpdev; tmpdev = tmpdev->parent) {
 316
 317                 if (device_property_read_bool(tmpdev, "usb2-lpm-disable"))
 318                         xhci->quirks |= XHCI_HW_LPM_DISABLE;
 319
 320                 if (device_property_read_bool(tmpdev, "usb3-lpm-capable"))
 321                         xhci->quirks |= XHCI_LPM_SUPPORT;
 322
 323                 if (device_property_read_bool(tmpdev, "quirk-broken-port-ped"))
 324                         xhci->quirks |= XHCI_BROKEN_PORT_PED;
 325
 326                 device_property_read_u32(tmpdev, "imod-interval-ns",
 327                                          &xhci->imod_interval);
 328         }
 329
 330         hcd->usb_phy = devm_usb_get_phy_by_phandle(sysdev, "usb-phy", 0);
 331         if (IS_ERR(hcd->usb_phy)) {
 332                 ret = PTR_ERR(hcd->usb_phy);
 333                 if (ret == -EPROBE_DEFER)
 334                         goto put_usb3_hcd;
 335                 hcd->usb_phy = NULL;
 336         } else {
 337                 ret = usb_phy_init(hcd->usb_phy);
 338                 if (ret)
 339                         goto put_usb3_hcd;
 340         }
 341
 342         hcd->tpl_support = of_usb_host_tpl_support(sysdev->of_node);
 343         xhci->shared_hcd->tpl_support = hcd->tpl_support;
 344
 345         if (priv) {
 346                 ret = xhci_priv_plat_setup(hcd);
 347                 if (ret)
 348                         goto disable_usb_phy;
 349         }
 350
 351         if ((xhci->quirks & XHCI_SKIP_PHY_INIT) || (priv && (priv->quirks & XHCI_SKIP_PHY_INIT)))
 352                 hcd->skip_phy_initialization = 1;
 353
 354         if (priv && (priv->quirks & XHCI_SG_TRB_CACHE_SIZE_QUIRK))
 355                 xhci->quirks |= XHCI_SG_TRB_CACHE_SIZE_QUIRK;
 356
 357         ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
 358         if (ret)
 359                 goto disable_usb_phy;
 360
 361         if (HCC_MAX_PSA(xhci->hcc_params) >= 4)
 362                 xhci->shared_hcd->can_do_streams = 1;
 363
 364         ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
 365         if (ret)
 366                 goto dealloc_usb2_hcd;
 367
 368         device_enable_async_suspend(&pdev->dev);
 369         pm_runtime_put_noidle(&pdev->dev);
 370
 371         /*
 372          * Prevent runtime pm from being on as default, users should enable
 373          * runtime pm using power/control in sysfs.
 374          */
 375         pm_runtime_forbid(&pdev->dev);
 376
 377         return 0;
 378
 379
 380 dealloc_usb2_hcd:
 381         usb_remove_hcd(hcd);
 382
 383 disable_usb_phy:
 384         usb_phy_shutdown(hcd->usb_phy);
 385
 386 put_usb3_hcd:
 387         usb_put_hcd(xhci->shared_hcd);
 388
 389 disable_clk:
 390         clk_disable_unprepare(xhci->clk);
 391
 392 disable_reg_clk:
 393         clk_disable_unprepare(xhci->reg_clk);
 394
 395 put_hcd:
 396         usb_put_hcd(hcd);
 397
 398 disable_runtime:
 399         pm_runtime_put_noidle(&pdev->dev);
 400         pm_runtime_disable(&pdev->dev);
 401
 402         return ret;
 403 }
 404
 405 static int xhci_plat_remove(struct platform_device *dev)
 406 {
 407         struct usb_hcd  *hcd = platform_get_drvdata(dev);
 408         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 409         struct clk *clk = xhci->clk;
 410         struct clk *reg_clk = xhci->reg_clk;
 411         struct usb_hcd *shared_hcd = xhci->shared_hcd;
 412
 413         pm_runtime_get_sync(&dev->dev);
 414         xhci->xhc_state |= XHCI_STATE_REMOVING;
 415
 416         usb_remove_hcd(shared_hcd);
 417         xhci->shared_hcd = NULL;
 418         usb_phy_shutdown(hcd->usb_phy);
 419
 420         usb_remove_hcd(hcd);
 421         usb_put_hcd(shared_hcd);
 422
 423         clk_disable_unprepare(clk);
 424         clk_disable_unprepare(reg_clk);
 425         usb_put_hcd(hcd);
 426
 427         pm_runtime_disable(&dev->dev);
 428         pm_runtime_put_noidle(&dev->dev);
 429         pm_runtime_set_suspended(&dev->dev);
 430
 431         return 0;
 432 }
 433
 434 static int __maybe_unused xhci_plat_suspend(struct device *dev)
 435 {
 436         struct usb_hcd  *hcd = dev_get_drvdata(dev);
 437         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 438         int ret;
 439
 440         if (pm_runtime_suspended(dev))
 441                 pm_runtime_resume(dev);
 442
 443         ret = xhci_priv_suspend_quirk(hcd);
 444         if (ret)
 445                 return ret;
 446         /*
 447          * xhci_suspend() needs `do_wakeup` to know whether host is allowed
 448          * to do wakeup during suspend.
 449          */
 450         return xhci_suspend(xhci, device_may_wakeup(dev));
 451 }
 452
 453 static int __maybe_unused xhci_plat_resume(struct device *dev)
 454 {
 455         struct usb_hcd  *hcd = dev_get_drvdata(dev);
 456         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 457         int ret;
 458
 459         ret = xhci_priv_resume_quirk(hcd);
 460         if (ret)
 461                 return ret;
 462
 463         ret = xhci_resume(xhci, 0);
 464         if (ret)
 465                 return ret;
 466
 467         pm_runtime_disable(dev);
 468         pm_runtime_set_active(dev);
 469         pm_runtime_enable(dev);
 470
 471         return 0;
 472 }
 473
 474 static int __maybe_unused xhci_plat_runtime_suspend(struct device *dev)
 475 {
 476         struct usb_hcd  *hcd = dev_get_drvdata(dev);
 477         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 478         int ret;
 479
 480         ret = xhci_priv_suspend_quirk(hcd);
 481         if (ret)
 482                 return ret;
 483
 484         return xhci_suspend(xhci, true);
 485 }
 486
 487 static int __maybe_unused xhci_plat_runtime_resume(struct device *dev)
 488 {
 489         struct usb_hcd  *hcd = dev_get_drvdata(dev);
 490         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 491
 492         return xhci_resume(xhci, 0);
 493 }
 494
 495 static const struct dev_pm_ops xhci_plat_pm_ops = {
 496         SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume)
 497
 498         SET_RUNTIME_PM_OPS(xhci_plat_runtime_suspend,
 499                            xhci_plat_runtime_resume,
 500                            NULL)
 501 };
 502
 503 #ifdef CONFIG_ACPI
 504 static const struct acpi_device_id usb_xhci_acpi_match[] = {
 505         /* XHCI-compliant USB Controller */
 506         { "PNP0D10", },
 507         { }
 508 };
 509 MODULE_DEVICE_TABLE(acpi, usb_xhci_acpi_match);
 510 #endif
 511
 512 static struct platform_driver usb_xhci_driver = {
 513         .probe  = xhci_plat_probe,
 514         .remove = xhci_plat_remove,
 515         .shutdown = usb_hcd_platform_shutdown,
 516         .driver = {
 517                 .name = "xhci-hcd",
 518                 .pm = &xhci_plat_pm_ops,
 519                 .of_match_table = of_match_ptr(usb_xhci_of_match),
 520                 .acpi_match_table = ACPI_PTR(usb_xhci_acpi_match),
 521         },
 522 };
 523 MODULE_ALIAS("platform:xhci-hcd");
 524
 525 static int __init xhci_plat_init(void)
 526 {
 527         xhci_init_driver(&xhci_plat_hc_driver, &xhci_plat_overrides);
 528         return platform_driver_register(&usb_xhci_driver);
 529 }
 530 module_init(xhci_plat_init);
 531
 532 static void __exit xhci_plat_exit(void)
 533 {
 534         platform_driver_unregister(&usb_xhci_driver);
 535 }
 536 module_exit(xhci_plat_exit);
 537
 538 MODULE_DESCRIPTION("xHCI Platform Host Controller Driver");
 539 MODULE_LICENSE("GPL");