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