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 #include <linux/reset.h>
  23
  24 #include "xhci.h"
  25 #include "xhci-plat.h"
  26 #include "xhci-mvebu.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_init_quirk(struct usb_hcd *hcd)
  48 {
  49         struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
  50
  51         if (!priv->init_quirk)
  52                 return 0;
  53
  54         return priv->init_quirk(hcd);
  55 }
  56
  57 static int xhci_priv_suspend_quirk(struct usb_hcd *hcd)
  58 {
  59         struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
  60
  61         if (!priv->suspend_quirk)
  62                 return 0;
  63
  64         return priv->suspend_quirk(hcd);
  65 }
  66
  67 static int xhci_priv_resume_quirk(struct usb_hcd *hcd)
  68 {
  69         struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
  70
  71         if (!priv->resume_quirk)
  72                 return 0;
  73
  74         return priv->resume_quirk(hcd);
  75 }
  76
  77 static void xhci_plat_quirks(struct device *dev, struct xhci_hcd *xhci)
  78 {
  79         struct xhci_plat_priv *priv = xhci_to_priv(xhci);
  80
  81         xhci->quirks |= priv->quirks;
  82 }
  83
  84 /* called during probe() after chip reset completes */
  85 static int xhci_plat_setup(struct usb_hcd *hcd)
  86 {
  87         int ret;
  88
  89
  90         ret = xhci_priv_init_quirk(hcd);
  91         if (ret)
  92                 return ret;
  93
  94         return xhci_gen_setup(hcd, xhci_plat_quirks);
  95 }
  96
  97 static int xhci_plat_start(struct usb_hcd *hcd)
  98 {
  99         xhci_priv_plat_start(hcd);
 100         return xhci_run(hcd);
 101 }
 102
 103 #ifdef CONFIG_OF
 104 static const struct xhci_plat_priv xhci_plat_marvell_armada = {
 105         .init_quirk = xhci_mvebu_mbus_init_quirk,
 106 };
 107
 108 static const struct xhci_plat_priv xhci_plat_marvell_armada3700 = {
 109         .init_quirk = xhci_mvebu_a3700_init_quirk,
 110 };
 111
 112 static const struct xhci_plat_priv xhci_plat_brcm = {
 113         .quirks = XHCI_RESET_ON_RESUME | XHCI_SUSPEND_RESUME_CLKS,
 114 };
 115
 116 static const struct of_device_id usb_xhci_of_match[] = {
 117         {
 118                 .compatible = "generic-xhci",
 119         }, {
 120                 .compatible = "xhci-platform",
 121         }, {
 122                 .compatible = "marvell,armada-375-xhci",
 123                 .data = &xhci_plat_marvell_armada,
 124         }, {
 125                 .compatible = "marvell,armada-380-xhci",
 126                 .data = &xhci_plat_marvell_armada,
 127         }, {
 128                 .compatible = "marvell,armada3700-xhci",
 129                 .data = &xhci_plat_marvell_armada3700,
 130         }, {
 131                 .compatible = "brcm,xhci-brcm-v2",
 132                 .data = &xhci_plat_brcm,
 133         }, {
 134                 .compatible = "brcm,bcm7445-xhci",
 135                 .data = &xhci_plat_brcm,
 136         },
 137         {},
 138 };
 139 MODULE_DEVICE_TABLE(of, usb_xhci_of_match);
 140 #endif
 141
 142 int xhci_plat_probe(struct platform_device *pdev, struct device *sysdev, const struct xhci_plat_priv *priv_match)
 143 {
 144         const struct hc_driver  *driver;
 145         struct device           *tmpdev;
 146         struct xhci_hcd         *xhci;
 147         struct resource         *res;
 148         struct usb_hcd          *hcd, *usb3_hcd;
 149         int                     ret;
 150         int                     irq;
 151         struct xhci_plat_priv   *priv = NULL;
 152         bool                    of_match;
 153
 154         if (usb_disabled())
 155                 return -ENODEV;
 156
 157         driver = &xhci_plat_hc_driver;
 158
 159         irq = platform_get_irq(pdev, 0);
 160         if (irq < 0)
 161                 return irq;
 162
 163         if (!sysdev)
 164                 sysdev = &pdev->dev;
 165
 166         ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(64));
 167         if (ret)
 168                 return ret;
 169
 170         pm_runtime_set_active(&pdev->dev);
 171         pm_runtime_enable(&pdev->dev);
 172         pm_runtime_get_noresume(&pdev->dev);
 173
 174         hcd = __usb_create_hcd(driver, sysdev, &pdev->dev,
 175                                dev_name(&pdev->dev), NULL);
 176         if (!hcd) {
 177                 ret = -ENOMEM;
 178                 goto disable_runtime;
 179         }
 180
 181         hcd->regs = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
 182         if (IS_ERR(hcd->regs)) {
 183                 ret = PTR_ERR(hcd->regs);
 184                 goto put_hcd;
 185         }
 186
 187         hcd->rsrc_start = res->start;
 188         hcd->rsrc_len = resource_size(res);
 189
 190         xhci = hcd_to_xhci(hcd);
 191
 192         xhci->allow_single_roothub = 1;
 193
 194         /*
 195          * Not all platforms have clks so it is not an error if the
 196          * clock do not exist.
 197          */
 198         xhci->reg_clk = devm_clk_get_optional(&pdev->dev, "reg");
 199         if (IS_ERR(xhci->reg_clk)) {
 200                 ret = PTR_ERR(xhci->reg_clk);
 201                 goto put_hcd;
 202         }
 203
 204         xhci->clk = devm_clk_get_optional(&pdev->dev, NULL);
 205         if (IS_ERR(xhci->clk)) {
 206                 ret = PTR_ERR(xhci->clk);
 207                 goto put_hcd;
 208         }
 209
 210         xhci->reset = devm_reset_control_array_get_optional_shared(&pdev->dev);
 211         if (IS_ERR(xhci->reset)) {
 212                 ret = PTR_ERR(xhci->reset);
 213                 goto put_hcd;
 214         }
 215
 216         ret = reset_control_deassert(xhci->reset);
 217         if (ret)
 218                 goto put_hcd;
 219
 220         ret = clk_prepare_enable(xhci->reg_clk);
 221         if (ret)
 222                 goto err_reset;
 223
 224         ret = clk_prepare_enable(xhci->clk);
 225         if (ret)
 226                 goto disable_reg_clk;
 227
 228         if (priv_match) {
 229                 priv = hcd_to_xhci_priv(hcd);
 230                 /* Just copy data for now */
 231                 *priv = *priv_match;
 232         }
 233
 234         device_set_wakeup_capable(&pdev->dev, true);
 235
 236         xhci->main_hcd = hcd;
 237
 238         /* imod_interval is the interrupt moderation value in nanoseconds. */
 239         xhci->imod_interval = 40000;
 240
 241         /* Iterate over all parent nodes for finding quirks */
 242         for (tmpdev = &pdev->dev; tmpdev; tmpdev = tmpdev->parent) {
 243
 244                 if (device_property_read_bool(tmpdev, "usb2-lpm-disable"))
 245                         xhci->quirks |= XHCI_HW_LPM_DISABLE;
 246
 247                 if (device_property_read_bool(tmpdev, "usb3-lpm-capable"))
 248                         xhci->quirks |= XHCI_LPM_SUPPORT;
 249
 250                 if (device_property_read_bool(tmpdev, "quirk-broken-port-ped"))
 251                         xhci->quirks |= XHCI_BROKEN_PORT_PED;
 252
 253                 if (device_property_read_bool(tmpdev, "xhci-sg-trb-cache-size-quirk"))
 254                         xhci->quirks |= XHCI_SG_TRB_CACHE_SIZE_QUIRK;
 255
 256                 device_property_read_u32(tmpdev, "imod-interval-ns",
 257                                          &xhci->imod_interval);
 258         }
 259
 260         /*
 261          * Drivers such as dwc3 manages PHYs themself (and rely on driver name
 262          * matching for the xhci platform device).
 263          */
 264         of_match = of_match_device(pdev->dev.driver->of_match_table, &pdev->dev);
 265         if (of_match) {
 266                 hcd->usb_phy = devm_usb_get_phy_by_phandle(sysdev, "usb-phy", 0);
 267                 if (IS_ERR(hcd->usb_phy)) {
 268                         ret = PTR_ERR(hcd->usb_phy);
 269                         if (ret == -EPROBE_DEFER)
 270                                 goto disable_clk;
 271                         hcd->usb_phy = NULL;
 272                 } else {
 273                         ret = usb_phy_init(hcd->usb_phy);
 274                         if (ret)
 275                                 goto disable_clk;
 276                 }
 277         }
 278
 279         hcd->tpl_support = of_usb_host_tpl_support(sysdev->of_node);
 280
 281         if (priv && (priv->quirks & XHCI_SKIP_PHY_INIT))
 282                 hcd->skip_phy_initialization = 1;
 283
 284         if (priv && (priv->quirks & XHCI_SG_TRB_CACHE_SIZE_QUIRK))
 285                 xhci->quirks |= XHCI_SG_TRB_CACHE_SIZE_QUIRK;
 286
 287         ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
 288         if (ret)
 289                 goto disable_usb_phy;
 290
 291         if (!xhci_has_one_roothub(xhci)) {
 292                 xhci->shared_hcd = __usb_create_hcd(driver, sysdev, &pdev->dev,
 293                                                     dev_name(&pdev->dev), hcd);
 294                 if (!xhci->shared_hcd) {
 295                         ret = -ENOMEM;
 296                         goto dealloc_usb2_hcd;
 297                 }
 298
 299                 if (of_match) {
 300                         xhci->shared_hcd->usb_phy = devm_usb_get_phy_by_phandle(sysdev,
 301                                                                                 "usb-phy", 1);
 302                         if (IS_ERR(xhci->shared_hcd->usb_phy)) {
 303                                 xhci->shared_hcd->usb_phy = NULL;
 304                         } else {
 305                                 ret = usb_phy_init(xhci->shared_hcd->usb_phy);
 306                                 if (ret)
 307                                         dev_err(sysdev, "%s init usb3phy fail (ret=%d)\n",
 308                                                 __func__, ret);
 309                         }
 310                 }
 311
 312                 xhci->shared_hcd->tpl_support = hcd->tpl_support;
 313         }
 314
 315         usb3_hcd = xhci_get_usb3_hcd(xhci);
 316         if (usb3_hcd && HCC_MAX_PSA(xhci->hcc_params) >= 4)
 317                 usb3_hcd->can_do_streams = 1;
 318
 319         if (xhci->shared_hcd) {
 320                 ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
 321                 if (ret)
 322                         goto put_usb3_hcd;
 323         }
 324
 325         device_enable_async_suspend(&pdev->dev);
 326         pm_runtime_put_noidle(&pdev->dev);
 327
 328         /*
 329          * Prevent runtime pm from being on as default, users should enable
 330          * runtime pm using power/control in sysfs.
 331          */
 332         pm_runtime_forbid(&pdev->dev);
 333
 334         return 0;
 335
 336
 337 put_usb3_hcd:
 338         usb_put_hcd(xhci->shared_hcd);
 339
 340 dealloc_usb2_hcd:
 341         usb_remove_hcd(hcd);
 342
 343 disable_usb_phy:
 344         usb_phy_shutdown(hcd->usb_phy);
 345
 346 disable_clk:
 347         clk_disable_unprepare(xhci->clk);
 348
 349 disable_reg_clk:
 350         clk_disable_unprepare(xhci->reg_clk);
 351
 352 err_reset:
 353         reset_control_assert(xhci->reset);
 354
 355 put_hcd:
 356         usb_put_hcd(hcd);
 357
 358 disable_runtime:
 359         pm_runtime_put_noidle(&pdev->dev);
 360         pm_runtime_disable(&pdev->dev);
 361
 362         return ret;
 363 }
 364 EXPORT_SYMBOL_GPL(xhci_plat_probe);
 365
 366 static int xhci_generic_plat_probe(struct platform_device *pdev)
 367 {
 368         const struct xhci_plat_priv *priv_match;
 369         struct device *sysdev;
 370         int ret;
 371
 372         /*
 373          * sysdev must point to a device that is known to the system firmware
 374          * or PCI hardware. We handle these three cases here:
 375          * 1. xhci_plat comes from firmware
 376          * 2. xhci_plat is child of a device from firmware (dwc3-plat)
 377          * 3. xhci_plat is grandchild of a pci device (dwc3-pci)
 378          */
 379         for (sysdev = &pdev->dev; sysdev; sysdev = sysdev->parent) {
 380                 if (is_of_node(sysdev->fwnode) ||
 381                         is_acpi_device_node(sysdev->fwnode))
 382                         break;
 383                 else if (dev_is_pci(sysdev))
 384                         break;
 385         }
 386
 387         if (!sysdev)
 388                 sysdev = &pdev->dev;
 389
 390         if (WARN_ON(!sysdev->dma_mask)) {
 391                 /* Platform did not initialize dma_mask */
 392                 ret = dma_coerce_mask_and_coherent(sysdev, DMA_BIT_MASK(64));
 393                 if (ret)
 394                         return ret;
 395         }
 396
 397         if (pdev->dev.of_node)
 398                 priv_match = of_device_get_match_data(&pdev->dev);
 399         else
 400                 priv_match = dev_get_platdata(&pdev->dev);
 401
 402         return xhci_plat_probe(pdev, sysdev, priv_match);
 403 }
 404
 405 void 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         xhci->xhc_state |= XHCI_STATE_REMOVING;
 414         pm_runtime_get_sync(&dev->dev);
 415
 416         if (shared_hcd) {
 417                 usb_remove_hcd(shared_hcd);
 418                 xhci->shared_hcd = NULL;
 419         }
 420
 421         usb_phy_shutdown(hcd->usb_phy);
 422
 423         usb_remove_hcd(hcd);
 424
 425         if (shared_hcd)
 426                 usb_put_hcd(shared_hcd);
 427
 428         clk_disable_unprepare(clk);
 429         clk_disable_unprepare(reg_clk);
 430         reset_control_assert(xhci->reset);
 431         usb_put_hcd(hcd);
 432
 433         pm_runtime_disable(&dev->dev);
 434         pm_runtime_put_noidle(&dev->dev);
 435         pm_runtime_set_suspended(&dev->dev);
 436 }
 437 EXPORT_SYMBOL_GPL(xhci_plat_remove);
 438
 439 static int xhci_plat_suspend(struct device *dev)
 440 {
 441         struct usb_hcd  *hcd = dev_get_drvdata(dev);
 442         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 443         int ret;
 444
 445         if (pm_runtime_suspended(dev))
 446                 pm_runtime_resume(dev);
 447
 448         ret = xhci_priv_suspend_quirk(hcd);
 449         if (ret)
 450                 return ret;
 451         /*
 452          * xhci_suspend() needs `do_wakeup` to know whether host is allowed
 453          * to do wakeup during suspend.
 454          */
 455         ret = xhci_suspend(xhci, device_may_wakeup(dev));
 456         if (ret)
 457                 return ret;
 458
 459         if (!device_may_wakeup(dev) && (xhci->quirks & XHCI_SUSPEND_RESUME_CLKS)) {
 460                 clk_disable_unprepare(xhci->clk);
 461                 clk_disable_unprepare(xhci->reg_clk);
 462         }
 463
 464         return 0;
 465 }
 466
 467 static int xhci_plat_resume_common(struct device *dev, struct pm_message pmsg)
 468 {
 469         struct usb_hcd  *hcd = dev_get_drvdata(dev);
 470         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 471         int ret;
 472
 473         if (!device_may_wakeup(dev) && (xhci->quirks & XHCI_SUSPEND_RESUME_CLKS)) {
 474                 ret = clk_prepare_enable(xhci->clk);
 475                 if (ret)
 476                         return ret;
 477
 478                 ret = clk_prepare_enable(xhci->reg_clk);
 479                 if (ret) {
 480                         clk_disable_unprepare(xhci->clk);
 481                         return ret;
 482                 }
 483         }
 484
 485         ret = xhci_priv_resume_quirk(hcd);
 486         if (ret)
 487                 goto disable_clks;
 488
 489         ret = xhci_resume(xhci, pmsg);
 490         if (ret)
 491                 goto disable_clks;
 492
 493         pm_runtime_disable(dev);
 494         pm_runtime_set_active(dev);
 495         pm_runtime_enable(dev);
 496
 497         return 0;
 498
 499 disable_clks:
 500         if (!device_may_wakeup(dev) && (xhci->quirks & XHCI_SUSPEND_RESUME_CLKS)) {
 501                 clk_disable_unprepare(xhci->clk);
 502                 clk_disable_unprepare(xhci->reg_clk);
 503         }
 504
 505         return ret;
 506 }
 507
 508 static int xhci_plat_resume(struct device *dev)
 509 {
 510         return xhci_plat_resume_common(dev, PMSG_RESUME);
 511 }
 512
 513 static int xhci_plat_restore(struct device *dev)
 514 {
 515         return xhci_plat_resume_common(dev, PMSG_RESTORE);
 516 }
 517
 518 static int __maybe_unused xhci_plat_runtime_suspend(struct device *dev)
 519 {
 520         struct usb_hcd  *hcd = dev_get_drvdata(dev);
 521         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 522         int ret;
 523
 524         ret = xhci_priv_suspend_quirk(hcd);
 525         if (ret)
 526                 return ret;
 527
 528         return xhci_suspend(xhci, true);
 529 }
 530
 531 static int __maybe_unused xhci_plat_runtime_resume(struct device *dev)
 532 {
 533         struct usb_hcd  *hcd = dev_get_drvdata(dev);
 534         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 535
 536         return xhci_resume(xhci, PMSG_AUTO_RESUME);
 537 }
 538
 539 const struct dev_pm_ops xhci_plat_pm_ops = {
 540         .suspend = pm_sleep_ptr(xhci_plat_suspend),
 541         .resume = pm_sleep_ptr(xhci_plat_resume),
 542         .freeze = pm_sleep_ptr(xhci_plat_suspend),
 543         .thaw = pm_sleep_ptr(xhci_plat_resume),
 544         .poweroff = pm_sleep_ptr(xhci_plat_suspend),
 545         .restore = pm_sleep_ptr(xhci_plat_restore),
 546
 547         SET_RUNTIME_PM_OPS(xhci_plat_runtime_suspend,
 548                            xhci_plat_runtime_resume,
 549                            NULL)
 550 };
 551 EXPORT_SYMBOL_GPL(xhci_plat_pm_ops);
 552
 553 #ifdef CONFIG_ACPI
 554 static const struct acpi_device_id usb_xhci_acpi_match[] = {
 555         /* XHCI-compliant USB Controller */
 556         { "PNP0D10", },
 557         { }
 558 };
 559 MODULE_DEVICE_TABLE(acpi, usb_xhci_acpi_match);
 560 #endif
 561
 562 static struct platform_driver usb_generic_xhci_driver = {
 563         .probe  = xhci_generic_plat_probe,
 564         .remove_new = xhci_plat_remove,
 565         .shutdown = usb_hcd_platform_shutdown,
 566         .driver = {
 567                 .name = "xhci-hcd",
 568                 .pm = &xhci_plat_pm_ops,
 569                 .of_match_table = of_match_ptr(usb_xhci_of_match),
 570                 .acpi_match_table = ACPI_PTR(usb_xhci_acpi_match),
 571         },
 572 };
 573 MODULE_ALIAS("platform:xhci-hcd");
 574
 575 static int __init xhci_plat_init(void)
 576 {
 577         xhci_init_driver(&xhci_plat_hc_driver, &xhci_plat_overrides);
 578         return platform_driver_register(&usb_generic_xhci_driver);
 579 }
 580 module_init(xhci_plat_init);
 581
 582 static void __exit xhci_plat_exit(void)
 583 {
 584         platform_driver_unregister(&usb_generic_xhci_driver);
 585 }
 586 module_exit(xhci_plat_exit);
 587
 588 MODULE_DESCRIPTION("xHCI Platform Host Controller Driver");
 589 MODULE_LICENSE("GPL");