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