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