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         .init_quirk = xhci_rcar_init_quirk,
 109         .plat_start = xhci_rcar_start,
 110         .resume_quirk = xhci_rcar_resume_quirk,
 111 };
 112
 113 static const struct of_device_id usb_xhci_of_match[] = {
 114         {
 115                 .compatible = "generic-xhci",
 116         }, {
 117                 .compatible = "xhci-platform",
 118         }, {
 119                 .compatible = "marvell,armada-375-xhci",
 120                 .data = &xhci_plat_marvell_armada,
 121         }, {
 122                 .compatible = "marvell,armada-380-xhci",
 123                 .data = &xhci_plat_marvell_armada,
 124         }, {
 125                 .compatible = "renesas,xhci-r8a7790",
 126                 .data = &xhci_plat_renesas_rcar_gen2,
 127         }, {
 128                 .compatible = "renesas,xhci-r8a7791",
 129                 .data = &xhci_plat_renesas_rcar_gen2,
 130         }, {
 131                 .compatible = "renesas,xhci-r8a7793",
 132                 .data = &xhci_plat_renesas_rcar_gen2,
 133         }, {
 134                 .compatible = "renesas,xhci-r8a7795",
 135                 .data = &xhci_plat_renesas_rcar_gen3,
 136         }, {
 137                 .compatible = "renesas,xhci-r8a7796",
 138                 .data = &xhci_plat_renesas_rcar_gen3,
 139         }, {
 140                 .compatible = "renesas,rcar-gen2-xhci",
 141                 .data = &xhci_plat_renesas_rcar_gen2,
 142         }, {
 143                 .compatible = "renesas,rcar-gen3-xhci",
 144                 .data = &xhci_plat_renesas_rcar_gen3,
 145         },
 146         {},
 147 };
 148 MODULE_DEVICE_TABLE(of, usb_xhci_of_match);
 149 #endif
 150
 151 static int xhci_plat_probe(struct platform_device *pdev)
 152 {
 153         const struct xhci_plat_priv *priv_match;
 154         const struct hc_driver  *driver;
 155         struct device           *sysdev;
 156         struct xhci_hcd         *xhci;
 157         struct resource         *res;
 158         struct usb_hcd          *hcd;
 159         struct clk              *clk;
 160         int                     ret;
 161         int                     irq;
 162
 163         if (usb_disabled())
 164                 return -ENODEV;
 165
 166         driver = &xhci_plat_hc_driver;
 167
 168         irq = platform_get_irq(pdev, 0);
 169         if (irq < 0)
 170                 return irq;
 171
 172         /*
 173          * sysdev must point to a device that is known to the system firmware
 174          * or PCI hardware. We handle these three cases here:
 175          * 1. xhci_plat comes from firmware
 176          * 2. xhci_plat is child of a device from firmware (dwc3-plat)
 177          * 3. xhci_plat is grandchild of a pci device (dwc3-pci)
 178          */
 179         for (sysdev = &pdev->dev; sysdev; sysdev = sysdev->parent) {
 180                 if (is_of_node(sysdev->fwnode) ||
 181                         is_acpi_device_node(sysdev->fwnode))
 182                         break;
 183 #ifdef CONFIG_PCI
 184                 else if (sysdev->bus == &pci_bus_type)
 185                         break;
 186 #endif
 187         }
 188
 189         if (!sysdev)
 190                 sysdev = &pdev->dev;
 191
 192         /* Try to set 64-bit DMA first */
 193         if (WARN_ON(!sysdev->dma_mask))
 194                 /* Platform did not initialize dma_mask */
 195                 ret = dma_coerce_mask_and_coherent(sysdev,
 196                                                    DMA_BIT_MASK(64));
 197         else
 198                 ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(64));
 199
 200         /* If seting 64-bit DMA mask fails, fall back to 32-bit DMA mask */
 201         if (ret) {
 202                 ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(32));
 203                 if (ret)
 204                         return ret;
 205         }
 206
 207         pm_runtime_set_active(&pdev->dev);
 208         pm_runtime_enable(&pdev->dev);
 209         pm_runtime_get_noresume(&pdev->dev);
 210
 211         hcd = __usb_create_hcd(driver, sysdev, &pdev->dev,
 212                                dev_name(&pdev->dev), NULL);
 213         if (!hcd) {
 214                 ret = -ENOMEM;
 215                 goto disable_runtime;
 216         }
 217
 218         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 219         hcd->regs = devm_ioremap_resource(&pdev->dev, res);
 220         if (IS_ERR(hcd->regs)) {
 221                 ret = PTR_ERR(hcd->regs);
 222                 goto put_hcd;
 223         }
 224
 225         hcd->rsrc_start = res->start;
 226         hcd->rsrc_len = resource_size(res);
 227
 228         /*
 229          * Not all platforms have a clk so it is not an error if the
 230          * clock does not exists.
 231          */
 232         clk = devm_clk_get(&pdev->dev, NULL);
 233         if (!IS_ERR(clk)) {
 234                 ret = clk_prepare_enable(clk);
 235                 if (ret)
 236                         goto put_hcd;
 237         } else if (PTR_ERR(clk) == -EPROBE_DEFER) {
 238                 ret = -EPROBE_DEFER;
 239                 goto put_hcd;
 240         }
 241
 242         xhci = hcd_to_xhci(hcd);
 243         priv_match = of_device_get_match_data(&pdev->dev);
 244         if (priv_match) {
 245                 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
 246
 247                 /* Just copy data for now */
 248                 if (priv_match)
 249                         *priv = *priv_match;
 250         }
 251
 252         device_wakeup_enable(hcd->self.controller);
 253
 254         xhci->clk = clk;
 255         xhci->main_hcd = hcd;
 256         xhci->shared_hcd = __usb_create_hcd(driver, sysdev, &pdev->dev,
 257                         dev_name(&pdev->dev), hcd);
 258         if (!xhci->shared_hcd) {
 259                 ret = -ENOMEM;
 260                 goto disable_clk;
 261         }
 262
 263         if (device_property_read_bool(sysdev, "usb2-lpm-disable"))
 264                 xhci->quirks |= XHCI_HW_LPM_DISABLE;
 265
 266         if (device_property_read_bool(sysdev, "usb3-lpm-capable"))
 267                 xhci->quirks |= XHCI_LPM_SUPPORT;
 268
 269         if (device_property_read_bool(&pdev->dev, "quirk-broken-port-ped"))
 270                 xhci->quirks |= XHCI_BROKEN_PORT_PED;
 271
 272         hcd->usb_phy = devm_usb_get_phy_by_phandle(sysdev, "usb-phy", 0);
 273         if (IS_ERR(hcd->usb_phy)) {
 274                 ret = PTR_ERR(hcd->usb_phy);
 275                 if (ret == -EPROBE_DEFER)
 276                         goto put_usb3_hcd;
 277                 hcd->usb_phy = NULL;
 278         } else {
 279                 ret = usb_phy_init(hcd->usb_phy);
 280                 if (ret)
 281                         goto put_usb3_hcd;
 282         }
 283
 284         ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
 285         if (ret)
 286                 goto disable_usb_phy;
 287
 288         if (HCC_MAX_PSA(xhci->hcc_params) >= 4)
 289                 xhci->shared_hcd->can_do_streams = 1;
 290
 291         ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
 292         if (ret)
 293                 goto dealloc_usb2_hcd;
 294
 295         device_enable_async_suspend(&pdev->dev);
 296         pm_runtime_put_noidle(&pdev->dev);
 297
 298         /*
 299          * Prevent runtime pm from being on as default, users should enable
 300          * runtime pm using power/control in sysfs.
 301          */
 302         pm_runtime_forbid(&pdev->dev);
 303
 304         return 0;
 305
 306
 307 dealloc_usb2_hcd:
 308         usb_remove_hcd(hcd);
 309
 310 disable_usb_phy:
 311         usb_phy_shutdown(hcd->usb_phy);
 312
 313 put_usb3_hcd:
 314         usb_put_hcd(xhci->shared_hcd);
 315
 316 disable_clk:
 317         if (!IS_ERR(clk))
 318                 clk_disable_unprepare(clk);
 319
 320 put_hcd:
 321         usb_put_hcd(hcd);
 322
 323 disable_runtime:
 324         pm_runtime_put_noidle(&pdev->dev);
 325         pm_runtime_disable(&pdev->dev);
 326
 327         return ret;
 328 }
 329
 330 static int xhci_plat_remove(struct platform_device *dev)
 331 {
 332         struct usb_hcd  *hcd = platform_get_drvdata(dev);
 333         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 334         struct clk *clk = xhci->clk;
 335
 336         xhci->xhc_state |= XHCI_STATE_REMOVING;
 337
 338         usb_remove_hcd(xhci->shared_hcd);
 339         usb_phy_shutdown(hcd->usb_phy);
 340
 341         usb_remove_hcd(hcd);
 342         usb_put_hcd(xhci->shared_hcd);
 343
 344         if (!IS_ERR(clk))
 345                 clk_disable_unprepare(clk);
 346         usb_put_hcd(hcd);
 347
 348         pm_runtime_set_suspended(&dev->dev);
 349         pm_runtime_disable(&dev->dev);
 350
 351         return 0;
 352 }
 353
 354 static int __maybe_unused xhci_plat_suspend(struct device *dev)
 355 {
 356         struct usb_hcd  *hcd = dev_get_drvdata(dev);
 357         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 358         int ret;
 359
 360         /*
 361          * xhci_suspend() needs `do_wakeup` to know whether host is allowed
 362          * to do wakeup during suspend. Since xhci_plat_suspend is currently
 363          * only designed for system suspend, device_may_wakeup() is enough
 364          * to dertermine whether host is allowed to do wakeup. Need to
 365          * reconsider this when xhci_plat_suspend enlarges its scope, e.g.,
 366          * also applies to runtime suspend.
 367          */
 368         ret = xhci_suspend(xhci, device_may_wakeup(dev));
 369
 370         if (!device_may_wakeup(dev) && !IS_ERR(xhci->clk))
 371                 clk_disable_unprepare(xhci->clk);
 372
 373         return ret;
 374 }
 375
 376 static int __maybe_unused xhci_plat_resume(struct device *dev)
 377 {
 378         struct usb_hcd  *hcd = dev_get_drvdata(dev);
 379         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 380         int ret;
 381
 382         if (!device_may_wakeup(dev) && !IS_ERR(xhci->clk))
 383                 clk_prepare_enable(xhci->clk);
 384
 385         ret = xhci_priv_resume_quirk(hcd);
 386         if (ret)
 387                 return ret;
 388
 389         return xhci_resume(xhci, 0);
 390 }
 391
 392 static int __maybe_unused xhci_plat_runtime_suspend(struct device *dev)
 393 {
 394         struct usb_hcd  *hcd = dev_get_drvdata(dev);
 395         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 396
 397         return xhci_suspend(xhci, true);
 398 }
 399
 400 static int __maybe_unused xhci_plat_runtime_resume(struct device *dev)
 401 {
 402         struct usb_hcd  *hcd = dev_get_drvdata(dev);
 403         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 404
 405         return xhci_resume(xhci, 0);
 406 }
 407
 408 static const struct dev_pm_ops xhci_plat_pm_ops = {
 409         SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume)
 410
 411         SET_RUNTIME_PM_OPS(xhci_plat_runtime_suspend,
 412                            xhci_plat_runtime_resume,
 413                            NULL)
 414 };
 415
 416 static const struct acpi_device_id usb_xhci_acpi_match[] = {
 417         /* XHCI-compliant USB Controller */
 418         { "PNP0D10", },
 419         { }
 420 };
 421 MODULE_DEVICE_TABLE(acpi, usb_xhci_acpi_match);
 422
 423 static struct platform_driver usb_xhci_driver = {
 424         .probe  = xhci_plat_probe,
 425         .remove = xhci_plat_remove,
 426         .shutdown       = usb_hcd_platform_shutdown,
 427         .driver = {
 428                 .name = "xhci-hcd",
 429                 .pm = &xhci_plat_pm_ops,
 430                 .of_match_table = of_match_ptr(usb_xhci_of_match),
 431                 .acpi_match_table = ACPI_PTR(usb_xhci_acpi_match),
 432         },
 433 };
 434 MODULE_ALIAS("platform:xhci-hcd");
 435
 436 static int __init xhci_plat_init(void)
 437 {
 438         xhci_init_driver(&xhci_plat_hc_driver, &xhci_plat_overrides);
 439         return platform_driver_register(&usb_xhci_driver);
 440 }
 441 module_init(xhci_plat_init);
 442
 443 static void __exit xhci_plat_exit(void)
 444 {
 445         platform_driver_unregister(&usb_xhci_driver);
 446 }
 447 module_exit(xhci_plat_exit);
 448
 449 MODULE_DESCRIPTION("xHCI Platform Host Controller Driver");
 450 MODULE_LICENSE("GPL");