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