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