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