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