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         .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         /* Try to set 64-bit DMA first */
  97         if (WARN_ON(!pdev->dev.dma_mask))
  98                 /* Platform did not initialize dma_mask */
  99                 ret = dma_coerce_mask_and_coherent(&pdev->dev,
 100                                                    DMA_BIT_MASK(64));
 101         else
 102                 ret = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64));
 103
 104         /* If seting 64-bit DMA mask fails, fall back to 32-bit DMA mask */
 105         if (ret) {
 106                 ret = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
 107                 if (ret)
 108                         return ret;
 109         }
 110
 111         hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev));
 112         if (!hcd)
 113                 return -ENOMEM;
 114
 115         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 116         hcd->regs = devm_ioremap_resource(&pdev->dev, res);
 117         if (IS_ERR(hcd->regs)) {
 118                 ret = PTR_ERR(hcd->regs);
 119                 goto put_hcd;
 120         }
 121
 122         hcd->rsrc_start = res->start;
 123         hcd->rsrc_len = resource_size(res);
 124
 125         /*
 126          * Not all platforms have a clk so it is not an error if the
 127          * clock does not exists.
 128          */
 129         clk = devm_clk_get(&pdev->dev, NULL);
 130         if (!IS_ERR(clk)) {
 131                 ret = clk_prepare_enable(clk);
 132                 if (ret)
 133                         goto put_hcd;
 134         }
 135
 136         if (of_device_is_compatible(pdev->dev.of_node,
 137                                     "marvell,armada-375-xhci") ||
 138             of_device_is_compatible(pdev->dev.of_node,
 139                                     "marvell,armada-380-xhci")) {
 140                 ret = xhci_mvebu_mbus_init_quirk(pdev);
 141                 if (ret)
 142                         goto disable_clk;
 143         }
 144
 145         device_wakeup_enable(hcd->self.controller);
 146
 147         xhci = hcd_to_xhci(hcd);
 148         xhci->clk = clk;
 149         xhci->main_hcd = hcd;
 150         xhci->shared_hcd = usb_create_shared_hcd(driver, &pdev->dev,
 151                         dev_name(&pdev->dev), hcd);
 152         if (!xhci->shared_hcd) {
 153                 ret = -ENOMEM;
 154                 goto disable_clk;
 155         }
 156
 157         if ((node && of_property_read_bool(node, "usb3-lpm-capable")) ||
 158                         (pdata && pdata->usb3_lpm_capable))
 159                 xhci->quirks |= XHCI_LPM_SUPPORT;
 160
 161         if (HCC_MAX_PSA(xhci->hcc_params) >= 4)
 162                 xhci->shared_hcd->can_do_streams = 1;
 163
 164         hcd->usb_phy = devm_usb_get_phy_by_phandle(&pdev->dev, "usb-phy", 0);
 165         if (IS_ERR(hcd->usb_phy)) {
 166                 ret = PTR_ERR(hcd->usb_phy);
 167                 if (ret == -EPROBE_DEFER)
 168                         goto put_usb3_hcd;
 169                 hcd->usb_phy = NULL;
 170         } else {
 171                 ret = usb_phy_init(hcd->usb_phy);
 172                 if (ret)
 173                         goto put_usb3_hcd;
 174         }
 175
 176         ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
 177         if (ret)
 178                 goto disable_usb_phy;
 179
 180         ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
 181         if (ret)
 182                 goto dealloc_usb2_hcd;
 183
 184         return 0;
 185
 186
 187 dealloc_usb2_hcd:
 188         usb_remove_hcd(hcd);
 189
 190 disable_usb_phy:
 191         usb_phy_shutdown(hcd->usb_phy);
 192
 193 put_usb3_hcd:
 194         usb_put_hcd(xhci->shared_hcd);
 195
 196 disable_clk:
 197         if (!IS_ERR(clk))
 198                 clk_disable_unprepare(clk);
 199
 200 put_hcd:
 201         usb_put_hcd(hcd);
 202
 203         return ret;
 204 }
 205
 206 static int xhci_plat_remove(struct platform_device *dev)
 207 {
 208         struct usb_hcd  *hcd = platform_get_drvdata(dev);
 209         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 210         struct clk *clk = xhci->clk;
 211
 212         usb_remove_hcd(xhci->shared_hcd);
 213         usb_phy_shutdown(hcd->usb_phy);
 214
 215         usb_remove_hcd(hcd);
 216         usb_put_hcd(xhci->shared_hcd);
 217
 218         if (!IS_ERR(clk))
 219                 clk_disable_unprepare(clk);
 220         usb_put_hcd(hcd);
 221
 222         return 0;
 223 }
 224
 225 #ifdef CONFIG_PM_SLEEP
 226 static int xhci_plat_suspend(struct device *dev)
 227 {
 228         struct usb_hcd  *hcd = dev_get_drvdata(dev);
 229         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 230
 231         /*
 232          * xhci_suspend() needs `do_wakeup` to know whether host is allowed
 233          * to do wakeup during suspend. Since xhci_plat_suspend is currently
 234          * only designed for system suspend, device_may_wakeup() is enough
 235          * to dertermine whether host is allowed to do wakeup. Need to
 236          * reconsider this when xhci_plat_suspend enlarges its scope, e.g.,
 237          * also applies to runtime suspend.
 238          */
 239         return xhci_suspend(xhci, device_may_wakeup(dev));
 240 }
 241
 242 static int xhci_plat_resume(struct device *dev)
 243 {
 244         struct usb_hcd  *hcd = dev_get_drvdata(dev);
 245         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 246
 247         return xhci_resume(xhci, 0);
 248 }
 249
 250 static const struct dev_pm_ops xhci_plat_pm_ops = {
 251         SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume)
 252 };
 253 #define DEV_PM_OPS      (&xhci_plat_pm_ops)
 254 #else
 255 #define DEV_PM_OPS      NULL
 256 #endif /* CONFIG_PM */
 257
 258 #ifdef CONFIG_OF
 259 static const struct of_device_id usb_xhci_of_match[] = {
 260         { .compatible = "generic-xhci" },
 261         { .compatible = "xhci-platform" },
 262         { .compatible = "marvell,armada-375-xhci"},
 263         { .compatible = "marvell,armada-380-xhci"},
 264         { .compatible = "renesas,xhci-r8a7790"},
 265         { .compatible = "renesas,xhci-r8a7791"},
 266         { },
 267 };
 268 MODULE_DEVICE_TABLE(of, usb_xhci_of_match);
 269 #endif
 270
 271 static const struct acpi_device_id usb_xhci_acpi_match[] = {
 272         /* XHCI-compliant USB Controller */
 273         { "PNP0D10", },
 274         { }
 275 };
 276 MODULE_DEVICE_TABLE(acpi, usb_xhci_acpi_match);
 277
 278 static struct platform_driver usb_xhci_driver = {
 279         .probe  = xhci_plat_probe,
 280         .remove = xhci_plat_remove,
 281         .driver = {
 282                 .name = "xhci-hcd",
 283                 .pm = DEV_PM_OPS,
 284                 .of_match_table = of_match_ptr(usb_xhci_of_match),
 285                 .acpi_match_table = ACPI_PTR(usb_xhci_acpi_match),
 286         },
 287 };
 288 MODULE_ALIAS("platform:xhci-hcd");
 289
 290 static int __init xhci_plat_init(void)
 291 {
 292         xhci_init_driver(&xhci_plat_hc_driver, &xhci_plat_overrides);
 293         return platform_driver_register(&usb_xhci_driver);
 294 }
 295 module_init(xhci_plat_init);
 296
 297 static void __exit xhci_plat_exit(void)
 298 {
 299         platform_driver_unregister(&usb_xhci_driver);
 300 }
 301 module_exit(xhci_plat_exit);
 302
 303 MODULE_DESCRIPTION("xHCI Platform Host Controller Driver");
 304 MODULE_LICENSE("GPL");