drivers/usb/host/xhci-plat.c

   1 /*
   2  * xhci-plat.c - xHCI host controller driver platform Bus Glue.
   3  *
   4  * Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com
   5  * Author: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
   6  *
   7  * A lot of code borrowed from the Linux xHCI driver.
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License
  11  * version 2 as published by the Free Software Foundation.
  12  */
  13
  14 #include <linux/clk.h>
  15 #include <linux/dma-mapping.h>
  16 #include <linux/module.h>
  17 #include <linux/pci.h>
  18 #include <linux/of.h>
  19 #include <linux/platform_device.h>
  20 #include <linux/usb/phy.h>
  21 #include <linux/slab.h>
  22 #include <linux/acpi.h>
  23
  24 #include "xhci.h"
  25 #include "xhci-plat.h"
  26 #include "xhci-mvebu.h"
  27 #include "xhci-rcar.h"
  28
  29 static struct hc_driver __read_mostly xhci_plat_hc_driver;
  30
  31 static int xhci_plat_setup(struct usb_hcd *hcd);
  32 static int xhci_plat_start(struct usb_hcd *hcd);
  33
  34 static const struct xhci_driver_overrides xhci_plat_overrides __initconst = {
  35         .extra_priv_size = sizeof(struct xhci_plat_priv),
  36         .reset = xhci_plat_setup,
  37         .start = xhci_plat_start,
  38 };
  39
  40 static void xhci_priv_plat_start(struct usb_hcd *hcd)
  41 {
  42         struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
  43
  44         if (priv->plat_start)
  45                 priv->plat_start(hcd);
  46 }
  47
  48 static int xhci_priv_init_quirk(struct usb_hcd *hcd)
  49 {
  50         struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
  51
  52         if (!priv->init_quirk)
  53                 return 0;
  54
  55         return priv->init_quirk(hcd);
  56 }
  57
  58 static int xhci_priv_resume_quirk(struct usb_hcd *hcd)
  59 {
  60         struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
  61
  62         if (!priv->resume_quirk)
  63                 return 0;
  64
  65         return priv->resume_quirk(hcd);
  66 }
  67
  68 static void xhci_plat_quirks(struct device *dev, struct xhci_hcd *xhci)
  69 {
  70         /*
  71          * As of now platform drivers don't provide MSI support so we ensure
  72          * here that the generic code does not try to make a pci_dev from our
  73          * dev struct in order to setup MSI
  74          */
  75         xhci->quirks |= XHCI_PLAT;
  76 }
  77
  78 /* called during probe() after chip reset completes */
  79 static int xhci_plat_setup(struct usb_hcd *hcd)
  80 {
  81         int ret;
  82
  83
  84         ret = xhci_priv_init_quirk(hcd);
  85         if (ret)
  86                 return ret;
  87
  88         return xhci_gen_setup(hcd, xhci_plat_quirks);
  89 }
  90
  91 static int xhci_plat_start(struct usb_hcd *hcd)
  92 {
  93         xhci_priv_plat_start(hcd);
  94         return xhci_run(hcd);
  95 }
  96
  97 #ifdef CONFIG_OF
  98 static const struct xhci_plat_priv xhci_plat_marvell_armada = {
  99         .init_quirk = xhci_mvebu_mbus_init_quirk,
 100 };
 101
 102 static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen2 = {
 103         .firmware_name = XHCI_RCAR_FIRMWARE_NAME_V1,
 104         .init_quirk = xhci_rcar_init_quirk,
 105         .plat_start = xhci_rcar_start,
 106         .resume_quirk = xhci_rcar_resume_quirk,
 107 };
 108
 109 static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen3 = {
 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 of_device_id *match;
 156         const struct hc_driver  *driver;
 157         struct device           *sysdev;
 158         struct xhci_hcd         *xhci;
 159         struct resource         *res;
 160         struct usb_hcd          *hcd;
 161         struct clk              *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 a clk so it is not an error if the
 232          * clock does not exists.
 233          */
 234         clk = devm_clk_get(&pdev->dev, NULL);
 235         if (!IS_ERR(clk)) {
 236                 ret = clk_prepare_enable(clk);
 237                 if (ret)
 238                         goto put_hcd;
 239         } else if (PTR_ERR(clk) == -EPROBE_DEFER) {
 240                 ret = -EPROBE_DEFER;
 241                 goto put_hcd;
 242         }
 243
 244         xhci = hcd_to_xhci(hcd);
 245         match = of_match_node(usb_xhci_of_match, pdev->dev.of_node);
 246         if (match) {
 247                 const struct xhci_plat_priv *priv_match = match->data;
 248                 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
 249
 250                 /* Just copy data for now */
 251                 if (priv_match)
 252                         *priv = *priv_match;
 253         }
 254
 255         device_wakeup_enable(hcd->self.controller);
 256
 257         xhci->clk = clk;
 258         xhci->main_hcd = hcd;
 259         xhci->shared_hcd = __usb_create_hcd(driver, sysdev, &pdev->dev,
 260                         dev_name(&pdev->dev), hcd);
 261         if (!xhci->shared_hcd) {
 262                 ret = -ENOMEM;
 263                 goto disable_clk;
 264         }
 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");