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/of.h>
  18 #include <linux/platform_device.h>
  19 #include <linux/usb/phy.h>
  20 #include <linux/slab.h>
  21 #include <linux/usb/xhci_pdriver.h>
  22 #include <linux/acpi.h>
  23
  24 #include "xhci.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_hcd),
  35         .reset = xhci_plat_setup,
  36         .start = xhci_plat_start,
  37 };
  38
  39 static void xhci_plat_quirks(struct device *dev, struct xhci_hcd *xhci)
  40 {
  41         struct usb_xhci_pdata *pdata = dev_get_platdata(dev);
  42
  43         /*
  44          * As of now platform drivers don't provide MSI support so we ensure
  45          * here that the generic code does not try to make a pci_dev from our
  46          * dev struct in order to setup MSI
  47          */
  48         xhci->quirks |= XHCI_PLAT;
  49
  50         /*
  51          * On some xHCI controllers (e.g. Rockchip SoCs), it need an
  52          * extraordinary delay to wait for xHCI enter the Halted state
  53          * after the Run/Stop (R/S) bit is cleared to '0'.
  54          */
  55         if (pdata && pdata->xhci_slow_suspend)
  56                 xhci->quirks |= XHCI_SLOW_SUSPEND;
  57 }
  58
  59 /* called during probe() after chip reset completes */
  60 static int xhci_plat_setup(struct usb_hcd *hcd)
  61 {
  62         struct device_node *of_node = hcd->self.controller->of_node;
  63         int ret;
  64
  65         if (of_device_is_compatible(of_node, "renesas,xhci-r8a7790") ||
  66             of_device_is_compatible(of_node, "renesas,xhci-r8a7791")) {
  67                 ret = xhci_rcar_init_quirk(hcd);
  68                 if (ret)
  69                         return ret;
  70         }
  71
  72         return xhci_gen_setup(hcd, xhci_plat_quirks);
  73 }
  74
  75 static int xhci_plat_start(struct usb_hcd *hcd)
  76 {
  77         struct device_node *of_node = hcd->self.controller->of_node;
  78
  79         if (of_device_is_compatible(of_node, "renesas,xhci-r8a7790") ||
  80             of_device_is_compatible(of_node, "renesas,xhci-r8a7791"))
  81                 xhci_rcar_start(hcd);
  82
  83         return xhci_run(hcd);
  84 }
  85
  86 static int xhci_plat_probe(struct platform_device *pdev)
  87 {
  88         struct device_node      *node = pdev->dev.of_node;
  89         struct usb_xhci_pdata   *pdata = dev_get_platdata(&pdev->dev);
  90         const struct hc_driver  *driver;
  91         struct xhci_hcd         *xhci;
  92         struct resource         *res;
  93         struct usb_hcd          *hcd;
  94         struct clk              *clk;
  95         int                     ret;
  96         int                     irq;
  97
  98         if (usb_disabled())
  99                 return -ENODEV;
 100
 101         driver = &xhci_plat_hc_driver;
 102
 103         irq = platform_get_irq(pdev, 0);
 104         if (irq < 0)
 105                 return -ENODEV;
 106
 107         /* Try to set 64-bit DMA first */
 108         if (WARN_ON(!pdev->dev.dma_mask))
 109                 /* Platform did not initialize dma_mask */
 110                 ret = dma_coerce_mask_and_coherent(&pdev->dev,
 111                                                    DMA_BIT_MASK(64));
 112         else
 113                 ret = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64));
 114
 115         /* If seting 64-bit DMA mask fails, fall back to 32-bit DMA mask */
 116         if (ret) {
 117                 ret = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
 118                 if (ret)
 119                         return ret;
 120         }
 121
 122         hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev));
 123         if (!hcd)
 124                 return -ENOMEM;
 125
 126         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 127         hcd->regs = devm_ioremap_resource(&pdev->dev, res);
 128         if (IS_ERR(hcd->regs)) {
 129                 ret = PTR_ERR(hcd->regs);
 130                 goto put_hcd;
 131         }
 132
 133         hcd->rsrc_start = res->start;
 134         hcd->rsrc_len = resource_size(res);
 135
 136         /*
 137          * Not all platforms have a clk so it is not an error if the
 138          * clock does not exists.
 139          */
 140         clk = devm_clk_get(&pdev->dev, NULL);
 141         if (!IS_ERR(clk)) {
 142                 ret = clk_prepare_enable(clk);
 143                 if (ret)
 144                         goto put_hcd;
 145         } else if (PTR_ERR(clk) == -EPROBE_DEFER) {
 146                 ret = -EPROBE_DEFER;
 147                 goto put_hcd;
 148         }
 149
 150         if (of_device_is_compatible(pdev->dev.of_node,
 151                                     "marvell,armada-375-xhci") ||
 152             of_device_is_compatible(pdev->dev.of_node,
 153                                     "marvell,armada-380-xhci")) {
 154                 ret = xhci_mvebu_mbus_init_quirk(pdev);
 155                 if (ret)
 156                         goto disable_clk;
 157         }
 158
 159         device_wakeup_enable(hcd->self.controller);
 160
 161         xhci = hcd_to_xhci(hcd);
 162         xhci->clk = clk;
 163         xhci->main_hcd = hcd;
 164         xhci->shared_hcd = usb_create_shared_hcd(driver, &pdev->dev,
 165                         dev_name(&pdev->dev), hcd);
 166         if (!xhci->shared_hcd) {
 167                 ret = -ENOMEM;
 168                 goto disable_clk;
 169         }
 170
 171         if ((node && of_property_read_bool(node, "usb3-lpm-capable")) ||
 172                         (pdata && pdata->usb3_lpm_capable))
 173                 xhci->quirks |= XHCI_LPM_SUPPORT;
 174
 175         if (pdata && pdata->usb3_disable_autosuspend)
 176                 xhci->quirks |= XHCI_DIS_AUTOSUSPEND;
 177
 178         xhci->shared_hcd->usb_phy = devm_usb_get_phy(&pdev->dev,
 179                                                      USB_PHY_TYPE_USB3);
 180         if (IS_ERR(xhci->shared_hcd->usb_phy)) {
 181                 ret = PTR_ERR(xhci->shared_hcd->usb_phy);
 182                 if (ret == -EPROBE_DEFER)
 183                         goto put_usb3_hcd;
 184                 xhci->shared_hcd->usb_phy = NULL;
 185         }
 186
 187         hcd->usb_phy = devm_usb_get_phy_by_phandle(&pdev->dev, "usb-phy", 0);
 188         if (IS_ERR(hcd->usb_phy)) {
 189                 ret = PTR_ERR(hcd->usb_phy);
 190                 if (ret == -EPROBE_DEFER)
 191                         goto put_usb3_hcd;
 192                 hcd->usb_phy = NULL;
 193         } else {
 194                 ret = usb_phy_init(hcd->usb_phy);
 195                 if (ret)
 196                         goto put_usb3_hcd;
 197         }
 198
 199         ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
 200         if (ret)
 201                 goto disable_usb_phy;
 202
 203         if (HCC_MAX_PSA(xhci->hcc_params) >= 4)
 204                 xhci->shared_hcd->can_do_streams = 1;
 205
 206         ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
 207         if (ret)
 208                 goto dealloc_usb2_hcd;
 209
 210         if (HCC_MAX_PSA(xhci->hcc_params) >= 4)
 211                 xhci->shared_hcd->can_do_streams = 1;
 212
 213         return 0;
 214
 215
 216 dealloc_usb2_hcd:
 217         usb_remove_hcd(hcd);
 218
 219 disable_usb_phy:
 220         usb_phy_shutdown(hcd->usb_phy);
 221
 222 put_usb3_hcd:
 223         usb_put_hcd(xhci->shared_hcd);
 224
 225 disable_clk:
 226         if (!IS_ERR(clk))
 227                 clk_disable_unprepare(clk);
 228
 229 put_hcd:
 230         usb_put_hcd(hcd);
 231
 232         return ret;
 233 }
 234
 235 static int xhci_plat_remove(struct platform_device *dev)
 236 {
 237         struct usb_hcd  *hcd = platform_get_drvdata(dev);
 238         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 239         struct clk *clk = xhci->clk;
 240
 241         xhci->xhc_state |= XHCI_STATE_REMOVING;
 242
 243         usb_remove_hcd(xhci->shared_hcd);
 244         usb_phy_shutdown(hcd->usb_phy);
 245
 246         usb_remove_hcd(hcd);
 247         usb_put_hcd(xhci->shared_hcd);
 248
 249         if (!IS_ERR(clk))
 250                 clk_disable_unprepare(clk);
 251         usb_put_hcd(hcd);
 252
 253         return 0;
 254 }
 255
 256 #ifdef CONFIG_PM_SLEEP
 257 static int xhci_plat_suspend(struct device *dev)
 258 {
 259         struct usb_hcd  *hcd = dev_get_drvdata(dev);
 260         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 261
 262         /*
 263          * xhci_suspend() needs `do_wakeup` to know whether host is allowed
 264          * to do wakeup during suspend. Since xhci_plat_suspend is currently
 265          * only designed for system suspend, device_may_wakeup() is enough
 266          * to dertermine whether host is allowed to do wakeup. Need to
 267          * reconsider this when xhci_plat_suspend enlarges its scope, e.g.,
 268          * also applies to runtime suspend.
 269          */
 270         return xhci_suspend(xhci, device_may_wakeup(dev));
 271 }
 272
 273 static int xhci_plat_resume(struct device *dev)
 274 {
 275         struct usb_hcd  *hcd = dev_get_drvdata(dev);
 276         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 277
 278         return xhci_resume(xhci, 0);
 279 }
 280
 281 static const struct dev_pm_ops xhci_plat_pm_ops = {
 282         SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume)
 283 };
 284 #define DEV_PM_OPS      (&xhci_plat_pm_ops)
 285 #else
 286 #define DEV_PM_OPS      NULL
 287 #endif /* CONFIG_PM */
 288
 289 #ifdef CONFIG_OF
 290 static const struct of_device_id usb_xhci_of_match[] = {
 291         { .compatible = "generic-xhci" },
 292         { .compatible = "xhci-platform" },
 293         { .compatible = "marvell,armada-375-xhci"},
 294         { .compatible = "marvell,armada-380-xhci"},
 295         { .compatible = "renesas,xhci-r8a7790"},
 296         { .compatible = "renesas,xhci-r8a7791"},
 297         { },
 298 };
 299 MODULE_DEVICE_TABLE(of, usb_xhci_of_match);
 300 #endif
 301
 302 static const struct acpi_device_id usb_xhci_acpi_match[] = {
 303         /* XHCI-compliant USB Controller */
 304         { "PNP0D10", },
 305         { }
 306 };
 307 MODULE_DEVICE_TABLE(acpi, usb_xhci_acpi_match);
 308
 309 static struct platform_driver usb_xhci_driver = {
 310         .probe  = xhci_plat_probe,
 311         .remove = xhci_plat_remove,
 312         .shutdown = usb_hcd_platform_shutdown,
 313         .driver = {
 314                 .name = "xhci-hcd",
 315                 .pm = DEV_PM_OPS,
 316                 .of_match_table = of_match_ptr(usb_xhci_of_match),
 317                 .acpi_match_table = ACPI_PTR(usb_xhci_acpi_match),
 318         },
 319 };
 320 MODULE_ALIAS("platform:xhci-hcd");
 321
 322 static int __init xhci_plat_init(void)
 323 {
 324         xhci_init_driver(&xhci_plat_hc_driver, &xhci_plat_overrides);
 325         return platform_driver_register(&usb_xhci_driver);
 326 }
 327 module_init(xhci_plat_init);
 328
 329 static void __exit xhci_plat_exit(void)
 330 {
 331         platform_driver_unregister(&usb_xhci_driver);
 332 }
 333 module_exit(xhci_plat_exit);
 334
 335 MODULE_DESCRIPTION("xHCI Platform Host Controller Driver");
 336 MODULE_LICENSE("GPL");