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
  23 #include "xhci.h"
  24 #include "xhci-mvebu.h"
  25 #include "xhci-rcar.h"
  26
  27 static struct hc_driver __read_mostly xhci_plat_hc_driver;
  28
  29 static int xhci_plat_setup(struct usb_hcd *hcd);
  30 static int xhci_plat_start(struct usb_hcd *hcd);
  31
  32 static const struct xhci_driver_overrides xhci_plat_overrides __initconst = {
  33         .extra_priv_size = sizeof(struct xhci_hcd),
  34         .reset = xhci_plat_setup,
  35         .start = xhci_plat_start,
  36 };
  37
  38 static void xhci_plat_quirks(struct device *dev, struct xhci_hcd *xhci)
  39 {
  40         /*
  41          * As of now platform drivers don't provide MSI support so we ensure
  42          * here that the generic code does not try to make a pci_dev from our
  43          * dev struct in order to setup MSI
  44          */
  45         xhci->quirks |= XHCI_PLAT;
  46 }
  47
  48 /* called during probe() after chip reset completes */
  49 static int xhci_plat_setup(struct usb_hcd *hcd)
  50 {
  51         struct device_node *of_node = hcd->self.controller->of_node;
  52         int ret;
  53
  54         if (of_device_is_compatible(of_node, "renesas,xhci-r8a7790") ||
  55             of_device_is_compatible(of_node, "renesas,xhci-r8a7791")) {
  56                 ret = xhci_rcar_init_quirk(hcd);
  57                 if (ret)
  58                         return ret;
  59         }
  60
  61         return xhci_gen_setup(hcd, xhci_plat_quirks);
  62 }
  63
  64 static int xhci_plat_start(struct usb_hcd *hcd)
  65 {
  66         struct device_node *of_node = hcd->self.controller->of_node;
  67
  68         if (of_device_is_compatible(of_node, "renesas,xhci-r8a7790") ||
  69             of_device_is_compatible(of_node, "renesas,xhci-r8a7791"))
  70                 xhci_rcar_start(hcd);
  71
  72         return xhci_run(hcd);
  73 }
  74
  75 static int xhci_plat_probe(struct platform_device *pdev)
  76 {
  77         struct device_node      *node = pdev->dev.of_node;
  78         struct usb_xhci_pdata   *pdata = dev_get_platdata(&pdev->dev);
  79         const struct hc_driver  *driver;
  80         struct xhci_hcd         *xhci;
  81         struct resource         *res;
  82         struct usb_hcd          *hcd;
  83         struct clk              *clk;
  84         int                     ret;
  85         int                     irq;
  86
  87         if (usb_disabled())
  88                 return -ENODEV;
  89
  90         driver = &xhci_plat_hc_driver;
  91
  92         irq = platform_get_irq(pdev, 0);
  93         if (irq < 0)
  94                 return -ENODEV;
  95
  96         /* Initialize dma_mask and coherent_dma_mask to 32-bits */
  97         ret = dma_set_coherent_mask(&pdev->dev, DMA_BIT_MASK(32));
  98         if (ret)
  99                 return ret;
 100         if (!pdev->dev.dma_mask)
 101                 pdev->dev.dma_mask = &pdev->dev.coherent_dma_mask;
 102         else
 103                 dma_set_mask(&pdev->dev, DMA_BIT_MASK(32));
 104
 105         hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev));
 106         if (!hcd)
 107                 return -ENOMEM;
 108
 109         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 110         hcd->regs = devm_ioremap_resource(&pdev->dev, res);
 111         if (IS_ERR(hcd->regs)) {
 112                 ret = PTR_ERR(hcd->regs);
 113                 goto put_hcd;
 114         }
 115
 116         hcd->rsrc_start = res->start;
 117         hcd->rsrc_len = resource_size(res);
 118
 119         /*
 120          * Not all platforms have a clk so it is not an error if the
 121          * clock does not exists.
 122          */
 123         clk = devm_clk_get(&pdev->dev, NULL);
 124         if (!IS_ERR(clk)) {
 125                 ret = clk_prepare_enable(clk);
 126                 if (ret)
 127                         goto put_hcd;
 128         }
 129
 130         if (of_device_is_compatible(pdev->dev.of_node,
 131                                     "marvell,armada-375-xhci") ||
 132             of_device_is_compatible(pdev->dev.of_node,
 133                                     "marvell,armada-380-xhci")) {
 134                 ret = xhci_mvebu_mbus_init_quirk(pdev);
 135                 if (ret)
 136                         goto disable_clk;
 137         }
 138
 139         device_wakeup_enable(hcd->self.controller);
 140
 141         xhci = hcd_to_xhci(hcd);
 142         xhci->clk = clk;
 143         xhci->shared_hcd = usb_create_shared_hcd(driver, &pdev->dev,
 144                         dev_name(&pdev->dev), hcd);
 145         if (!xhci->shared_hcd) {
 146                 ret = -ENOMEM;
 147                 goto disable_clk;
 148         }
 149
 150         if ((node && of_property_read_bool(node, "usb3-lpm-capable")) ||
 151                         (pdata && pdata->usb3_lpm_capable))
 152                 xhci->quirks |= XHCI_LPM_SUPPORT;
 153
 154         if (HCC_MAX_PSA(xhci->hcc_params) >= 4)
 155                 xhci->shared_hcd->can_do_streams = 1;
 156
 157         hcd->usb_phy = devm_usb_get_phy_by_phandle(&pdev->dev, "usb-phy", 0);
 158         if (IS_ERR(hcd->usb_phy)) {
 159                 ret = PTR_ERR(hcd->usb_phy);
 160                 if (ret == -EPROBE_DEFER)
 161                         goto put_usb3_hcd;
 162                 hcd->usb_phy = NULL;
 163         } else {
 164                 ret = usb_phy_init(hcd->usb_phy);
 165                 if (ret)
 166                         goto put_usb3_hcd;
 167         }
 168
 169         ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
 170         if (ret)
 171                 goto disable_usb_phy;
 172
 173         ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
 174         if (ret)
 175                 goto dealloc_usb2_hcd;
 176
 177         return 0;
 178
 179
 180 dealloc_usb2_hcd:
 181         usb_remove_hcd(hcd);
 182
 183 disable_usb_phy:
 184         usb_phy_shutdown(hcd->usb_phy);
 185
 186 put_usb3_hcd:
 187         usb_put_hcd(xhci->shared_hcd);
 188
 189 disable_clk:
 190         if (!IS_ERR(clk))
 191                 clk_disable_unprepare(clk);
 192
 193 put_hcd:
 194         usb_put_hcd(hcd);
 195
 196         return ret;
 197 }
 198
 199 static int xhci_plat_remove(struct platform_device *dev)
 200 {
 201         struct usb_hcd  *hcd = platform_get_drvdata(dev);
 202         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 203         struct clk *clk = xhci->clk;
 204
 205         usb_remove_hcd(xhci->shared_hcd);
 206         usb_phy_shutdown(hcd->usb_phy);
 207
 208         usb_remove_hcd(hcd);
 209         usb_put_hcd(xhci->shared_hcd);
 210
 211         if (!IS_ERR(clk))
 212                 clk_disable_unprepare(clk);
 213         usb_put_hcd(hcd);
 214
 215         return 0;
 216 }
 217
 218 #ifdef CONFIG_PM_SLEEP
 219 static int xhci_plat_suspend(struct device *dev)
 220 {
 221         struct usb_hcd  *hcd = dev_get_drvdata(dev);
 222         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 223
 224         /*
 225          * xhci_suspend() needs `do_wakeup` to know whether host is allowed
 226          * to do wakeup during suspend. Since xhci_plat_suspend is currently
 227          * only designed for system suspend, device_may_wakeup() is enough
 228          * to dertermine whether host is allowed to do wakeup. Need to
 229          * reconsider this when xhci_plat_suspend enlarges its scope, e.g.,
 230          * also applies to runtime suspend.
 231          */
 232         return xhci_suspend(xhci, device_may_wakeup(dev));
 233 }
 234
 235 static int xhci_plat_resume(struct device *dev)
 236 {
 237         struct usb_hcd  *hcd = dev_get_drvdata(dev);
 238         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 239
 240         return xhci_resume(xhci, 0);
 241 }
 242
 243 static const struct dev_pm_ops xhci_plat_pm_ops = {
 244         SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume)
 245 };
 246 #define DEV_PM_OPS      (&xhci_plat_pm_ops)
 247 #else
 248 #define DEV_PM_OPS      NULL
 249 #endif /* CONFIG_PM */
 250
 251 #ifdef CONFIG_OF
 252 static const struct of_device_id usb_xhci_of_match[] = {
 253         { .compatible = "generic-xhci" },
 254         { .compatible = "xhci-platform" },
 255         { .compatible = "marvell,armada-375-xhci"},
 256         { .compatible = "marvell,armada-380-xhci"},
 257         { .compatible = "renesas,xhci-r8a7790"},
 258         { .compatible = "renesas,xhci-r8a7791"},
 259         { },
 260 };
 261 MODULE_DEVICE_TABLE(of, usb_xhci_of_match);
 262 #endif
 263
 264 static struct platform_driver usb_xhci_driver = {
 265         .probe  = xhci_plat_probe,
 266         .remove = xhci_plat_remove,
 267         .driver = {
 268                 .name = "xhci-hcd",
 269                 .pm = DEV_PM_OPS,
 270                 .of_match_table = of_match_ptr(usb_xhci_of_match),
 271         },
 272 };
 273 MODULE_ALIAS("platform:xhci-hcd");
 274
 275 static int __init xhci_plat_init(void)
 276 {
 277         xhci_init_driver(&xhci_plat_hc_driver, &xhci_plat_overrides);
 278         return platform_driver_register(&usb_xhci_driver);
 279 }
 280 module_init(xhci_plat_init);
 281
 282 static void __exit xhci_plat_exit(void)
 283 {
 284         platform_driver_unregister(&usb_xhci_driver);
 285 }
 286 module_exit(xhci_plat_exit);
 287
 288 MODULE_DESCRIPTION("xHCI Platform Host Controller Driver");
 289 MODULE_LICENSE("GPL");