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