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