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