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