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