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/slab.h>
  20 #include <linux/usb/xhci_pdriver.h>
  21
  22 #include "xhci.h"
  23 #include "xhci-mvebu.h"
  24
  25 static void xhci_plat_quirks(struct device *dev, struct xhci_hcd *xhci)
  26 {
  27         /*
  28          * As of now platform drivers don't provide MSI support so we ensure
  29          * here that the generic code does not try to make a pci_dev from our
  30          * dev struct in order to setup MSI
  31          */
  32         xhci->quirks |= XHCI_PLAT;
  33 }
  34
  35 /* called during probe() after chip reset completes */
  36 static int xhci_plat_setup(struct usb_hcd *hcd)
  37 {
  38         return xhci_gen_setup(hcd, xhci_plat_quirks);
  39 }
  40
  41 static int xhci_plat_start(struct usb_hcd *hcd)
  42 {
  43         return xhci_run(hcd);
  44 }
  45
  46 static const struct hc_driver xhci_plat_xhci_driver = {
  47         .description =          "xhci-hcd",
  48         .product_desc =         "xHCI Host Controller",
  49         .hcd_priv_size =        sizeof(struct xhci_hcd *),
  50
  51         /*
  52          * generic hardware linkage
  53          */
  54         .irq =                  xhci_irq,
  55         .flags =                HCD_MEMORY | HCD_USB3 | HCD_SHARED,
  56
  57         /*
  58          * basic lifecycle operations
  59          */
  60         .reset =                xhci_plat_setup,
  61         .start =                xhci_plat_start,
  62         .stop =                 xhci_stop,
  63         .shutdown =             xhci_shutdown,
  64
  65         /*
  66          * managing i/o requests and associated device resources
  67          */
  68         .urb_enqueue =          xhci_urb_enqueue,
  69         .urb_dequeue =          xhci_urb_dequeue,
  70         .alloc_dev =            xhci_alloc_dev,
  71         .free_dev =             xhci_free_dev,
  72         .alloc_streams =        xhci_alloc_streams,
  73         .free_streams =         xhci_free_streams,
  74         .add_endpoint =         xhci_add_endpoint,
  75         .drop_endpoint =        xhci_drop_endpoint,
  76         .endpoint_reset =       xhci_endpoint_reset,
  77         .check_bandwidth =      xhci_check_bandwidth,
  78         .reset_bandwidth =      xhci_reset_bandwidth,
  79         .address_device =       xhci_address_device,
  80         .enable_device =        xhci_enable_device,
  81         .update_hub_device =    xhci_update_hub_device,
  82         .reset_device =         xhci_discover_or_reset_device,
  83
  84         /*
  85          * scheduling support
  86          */
  87         .get_frame_number =     xhci_get_frame,
  88
  89         /* Root hub support */
  90         .hub_control =          xhci_hub_control,
  91         .hub_status_data =      xhci_hub_status_data,
  92         .bus_suspend =          xhci_bus_suspend,
  93         .bus_resume =           xhci_bus_resume,
  94
  95         .enable_usb3_lpm_timeout =      xhci_enable_usb3_lpm_timeout,
  96         .disable_usb3_lpm_timeout =     xhci_disable_usb3_lpm_timeout,
  97 };
  98
  99 static int xhci_plat_probe(struct platform_device *pdev)
 100 {
 101         struct device_node      *node = pdev->dev.of_node;
 102         struct usb_xhci_pdata   *pdata = dev_get_platdata(&pdev->dev);
 103         const struct hc_driver  *driver;
 104         struct xhci_hcd         *xhci;
 105         struct resource         *res;
 106         struct usb_hcd          *hcd;
 107         struct clk              *clk;
 108         int                     ret;
 109         int                     irq;
 110
 111         if (usb_disabled())
 112                 return -ENODEV;
 113
 114         driver = &xhci_plat_xhci_driver;
 115
 116         irq = platform_get_irq(pdev, 0);
 117         if (irq < 0)
 118                 return -ENODEV;
 119
 120         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 121         if (!res)
 122                 return -ENODEV;
 123
 124         if (of_device_is_compatible(pdev->dev.of_node,
 125                                     "marvell,armada-375-xhci") ||
 126             of_device_is_compatible(pdev->dev.of_node,
 127                                     "marvell,armada-380-xhci")) {
 128                 ret = xhci_mvebu_mbus_init_quirk(pdev);
 129                 if (ret)
 130                         return ret;
 131         }
 132
 133         /* Initialize dma_mask and coherent_dma_mask to 32-bits */
 134         ret = dma_set_coherent_mask(&pdev->dev, DMA_BIT_MASK(32));
 135         if (ret)
 136                 return ret;
 137         if (!pdev->dev.dma_mask)
 138                 pdev->dev.dma_mask = &pdev->dev.coherent_dma_mask;
 139         else
 140                 dma_set_mask(&pdev->dev, DMA_BIT_MASK(32));
 141
 142         hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev));
 143         if (!hcd)
 144                 return -ENOMEM;
 145
 146         hcd->rsrc_start = res->start;
 147         hcd->rsrc_len = resource_size(res);
 148
 149         if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len,
 150                                 driver->description)) {
 151                 dev_dbg(&pdev->dev, "controller already in use\n");
 152                 ret = -EBUSY;
 153                 goto put_hcd;
 154         }
 155
 156         hcd->regs = ioremap_nocache(hcd->rsrc_start, hcd->rsrc_len);
 157         if (!hcd->regs) {
 158                 dev_dbg(&pdev->dev, "error mapping memory\n");
 159                 ret = -EFAULT;
 160                 goto release_mem_region;
 161         }
 162
 163         /*
 164          * Not all platforms have a clk so it is not an error if the
 165          * clock does not exists.
 166          */
 167         clk = devm_clk_get(&pdev->dev, NULL);
 168         if (!IS_ERR(clk)) {
 169                 ret = clk_prepare_enable(clk);
 170                 if (ret)
 171                         goto unmap_registers;
 172         }
 173
 174         ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
 175         if (ret)
 176                 goto disable_clk;
 177
 178         device_wakeup_enable(hcd->self.controller);
 179
 180         /* USB 2.0 roothub is stored in the platform_device now. */
 181         hcd = platform_get_drvdata(pdev);
 182         xhci = hcd_to_xhci(hcd);
 183         xhci->clk = clk;
 184         xhci->shared_hcd = usb_create_shared_hcd(driver, &pdev->dev,
 185                         dev_name(&pdev->dev), hcd);
 186         if (!xhci->shared_hcd) {
 187                 ret = -ENOMEM;
 188                 goto dealloc_usb2_hcd;
 189         }
 190
 191         if ((node && of_property_read_bool(node, "usb3-lpm-capable")) ||
 192                         (pdata && pdata->usb3_lpm_capable))
 193                 xhci->quirks |= XHCI_LPM_SUPPORT;
 194         /*
 195          * Set the xHCI pointer before xhci_plat_setup() (aka hcd_driver.reset)
 196          * is called by usb_add_hcd().
 197          */
 198         *((struct xhci_hcd **) xhci->shared_hcd->hcd_priv) = xhci;
 199
 200         ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
 201         if (ret)
 202                 goto put_usb3_hcd;
 203
 204         return 0;
 205
 206 put_usb3_hcd:
 207         usb_put_hcd(xhci->shared_hcd);
 208
 209 dealloc_usb2_hcd:
 210         usb_remove_hcd(hcd);
 211
 212 disable_clk:
 213         if (!IS_ERR(clk))
 214                 clk_disable_unprepare(clk);
 215
 216 unmap_registers:
 217         iounmap(hcd->regs);
 218
 219 release_mem_region:
 220         release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
 221
 222 put_hcd:
 223         usb_put_hcd(hcd);
 224
 225         return ret;
 226 }
 227
 228 static int xhci_plat_remove(struct platform_device *dev)
 229 {
 230         struct usb_hcd  *hcd = platform_get_drvdata(dev);
 231         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 232         struct clk *clk = xhci->clk;
 233
 234         usb_remove_hcd(xhci->shared_hcd);
 235         usb_put_hcd(xhci->shared_hcd);
 236
 237         usb_remove_hcd(hcd);
 238         if (!IS_ERR(clk))
 239                 clk_disable_unprepare(clk);
 240         iounmap(hcd->regs);
 241         release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
 242         usb_put_hcd(hcd);
 243         kfree(xhci);
 244
 245         return 0;
 246 }
 247
 248 #ifdef CONFIG_PM_SLEEP
 249 static int xhci_plat_suspend(struct device *dev)
 250 {
 251         struct usb_hcd  *hcd = dev_get_drvdata(dev);
 252         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 253
 254         /*
 255          * xhci_suspend() needs `do_wakeup` to know whether host is allowed
 256          * to do wakeup during suspend. Since xhci_plat_suspend is currently
 257          * only designed for system suspend, device_may_wakeup() is enough
 258          * to dertermine whether host is allowed to do wakeup. Need to
 259          * reconsider this when xhci_plat_suspend enlarges its scope, e.g.,
 260          * also applies to runtime suspend.
 261          */
 262         return xhci_suspend(xhci, device_may_wakeup(dev));
 263 }
 264
 265 static int xhci_plat_resume(struct device *dev)
 266 {
 267         struct usb_hcd  *hcd = dev_get_drvdata(dev);
 268         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 269
 270         return xhci_resume(xhci, 0);
 271 }
 272
 273 static const struct dev_pm_ops xhci_plat_pm_ops = {
 274         SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume)
 275 };
 276 #define DEV_PM_OPS      (&xhci_plat_pm_ops)
 277 #else
 278 #define DEV_PM_OPS      NULL
 279 #endif /* CONFIG_PM */
 280
 281 #ifdef CONFIG_OF
 282 static const struct of_device_id usb_xhci_of_match[] = {
 283         { .compatible = "generic-xhci" },
 284         { .compatible = "xhci-platform" },
 285         { .compatible = "marvell,armada-375-xhci"},
 286         { .compatible = "marvell,armada-380-xhci"},
 287         { },
 288 };
 289 MODULE_DEVICE_TABLE(of, usb_xhci_of_match);
 290 #endif
 291
 292 static struct platform_driver usb_xhci_driver = {
 293         .probe  = xhci_plat_probe,
 294         .remove = xhci_plat_remove,
 295         .driver = {
 296                 .name = "xhci-hcd",
 297                 .pm = DEV_PM_OPS,
 298                 .of_match_table = of_match_ptr(usb_xhci_of_match),
 299         },
 300 };
 301 MODULE_ALIAS("platform:xhci-hcd");
 302
 303 int xhci_register_plat(void)
 304 {
 305         return platform_driver_register(&usb_xhci_driver);
 306 }
 307
 308 void xhci_unregister_plat(void)
 309 {
 310         platform_driver_unregister(&usb_xhci_driver);
 311 }