usb: ehci: add rockchip relinquishing port quirk support
[firefly-linux-kernel-4.4.55.git] / drivers / usb / host / xhci-plat.c
index df90fe51b4aa2d406b8b2f8bfa591c410df89a35..0f50c1cdea5a5af5aeabef413362e17f4c67e618 100644 (file)
  * version 2 as published by the Free Software Foundation.
  */
 
-#include <linux/platform_device.h>
+#include <linux/clk.h>
+#include <linux/dma-mapping.h>
 #include <linux/module.h>
+#include <linux/of.h>
+#include <linux/platform_device.h>
+#include <linux/usb/phy.h>
 #include <linux/slab.h>
+#include <linux/usb/xhci_pdriver.h>
+#include <linux/acpi.h>
 
 #include "xhci.h"
+#include "xhci-mvebu.h"
+#include "xhci-rcar.h"
+
+static struct hc_driver __read_mostly xhci_plat_hc_driver;
+
+static int xhci_plat_setup(struct usb_hcd *hcd);
+static int xhci_plat_start(struct usb_hcd *hcd);
+
+static const struct xhci_driver_overrides xhci_plat_overrides __initconst = {
+       .extra_priv_size = sizeof(struct xhci_hcd),
+       .reset = xhci_plat_setup,
+       .start = xhci_plat_start,
+};
 
 static void xhci_plat_quirks(struct device *dev, struct xhci_hcd *xhci)
 {
+       struct usb_xhci_pdata *pdata = dev_get_platdata(dev);
+
        /*
         * As of now platform drivers don't provide MSI support so we ensure
         * here that the generic code does not try to make a pci_dev from our
         * dev struct in order to setup MSI
         */
-       xhci->quirks |= XHCI_BROKEN_MSI;
+       xhci->quirks |= XHCI_PLAT;
+
+       /*
+        * On some xHCI controllers (e.g. Rockchip SoCs), it need an
+        * extraordinary delay to wait for xHCI enter the Halted state
+        * after the Run/Stop (R/S) bit is cleared to '0'.
+        */
+       if (pdata && pdata->xhci_slow_suspend)
+               xhci->quirks |= XHCI_SLOW_SUSPEND;
 }
 
 /* called during probe() after chip reset completes */
 static int xhci_plat_setup(struct usb_hcd *hcd)
 {
+       struct device_node *of_node = hcd->self.controller->of_node;
+       int ret;
+
+       if (of_device_is_compatible(of_node, "renesas,xhci-r8a7790") ||
+           of_device_is_compatible(of_node, "renesas,xhci-r8a7791")) {
+               ret = xhci_rcar_init_quirk(hcd);
+               if (ret)
+                       return ret;
+       }
+
        return xhci_gen_setup(hcd, xhci_plat_quirks);
 }
 
-static const struct hc_driver xhci_plat_xhci_driver = {
-       .description =          "xhci-hcd",
-       .product_desc =         "xHCI Host Controller",
-       .hcd_priv_size =        sizeof(struct xhci_hcd *),
-
-       /*
-        * generic hardware linkage
-        */
-       .irq =                  xhci_irq,
-       .flags =                HCD_MEMORY | HCD_USB3 | HCD_SHARED,
-
-       /*
-        * basic lifecycle operations
-        */
-       .reset =                xhci_plat_setup,
-       .start =                xhci_run,
-       .stop =                 xhci_stop,
-       .shutdown =             xhci_shutdown,
-
-       /*
-        * managing i/o requests and associated device resources
-        */
-       .urb_enqueue =          xhci_urb_enqueue,
-       .urb_dequeue =          xhci_urb_dequeue,
-       .alloc_dev =            xhci_alloc_dev,
-       .free_dev =             xhci_free_dev,
-       .alloc_streams =        xhci_alloc_streams,
-       .free_streams =         xhci_free_streams,
-       .add_endpoint =         xhci_add_endpoint,
-       .drop_endpoint =        xhci_drop_endpoint,
-       .endpoint_reset =       xhci_endpoint_reset,
-       .check_bandwidth =      xhci_check_bandwidth,
-       .reset_bandwidth =      xhci_reset_bandwidth,
-       .address_device =       xhci_address_device,
-       .update_hub_device =    xhci_update_hub_device,
-       .reset_device =         xhci_discover_or_reset_device,
+static int xhci_plat_start(struct usb_hcd *hcd)
+{
+       struct device_node *of_node = hcd->self.controller->of_node;
 
-       /*
-        * scheduling support
-        */
-       .get_frame_number =     xhci_get_frame,
+       if (of_device_is_compatible(of_node, "renesas,xhci-r8a7790") ||
+           of_device_is_compatible(of_node, "renesas,xhci-r8a7791"))
+               xhci_rcar_start(hcd);
 
-       /* Root hub support */
-       .hub_control =          xhci_hub_control,
-       .hub_status_data =      xhci_hub_status_data,
-       .bus_suspend =          xhci_bus_suspend,
-       .bus_resume =           xhci_bus_resume,
-};
+       return xhci_run(hcd);
+}
 
 static int xhci_plat_probe(struct platform_device *pdev)
 {
+       struct device_node      *node = pdev->dev.of_node;
+       struct usb_xhci_pdata   *pdata = dev_get_platdata(&pdev->dev);
        const struct hc_driver  *driver;
        struct xhci_hcd         *xhci;
        struct resource         *res;
        struct usb_hcd          *hcd;
+       struct clk              *clk;
        int                     ret;
        int                     irq;
 
        if (usb_disabled())
                return -ENODEV;
 
-       driver = &xhci_plat_xhci_driver;
+       driver = &xhci_plat_hc_driver;
 
        irq = platform_get_irq(pdev, 0);
        if (irq < 0)
                return -ENODEV;
 
-       res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
-       if (!res)
-               return -ENODEV;
+       /* Try to set 64-bit DMA first */
+       if (WARN_ON(!pdev->dev.dma_mask))
+               /* Platform did not initialize dma_mask */
+               ret = dma_coerce_mask_and_coherent(&pdev->dev,
+                                                  DMA_BIT_MASK(64));
+       else
+               ret = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64));
+
+       /* If seting 64-bit DMA mask fails, fall back to 32-bit DMA mask */
+       if (ret) {
+               ret = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
+               if (ret)
+                       return ret;
+       }
 
        hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev));
        if (!hcd)
                return -ENOMEM;
 
+       res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
+       hcd->regs = devm_ioremap_resource(&pdev->dev, res);
+       if (IS_ERR(hcd->regs)) {
+               ret = PTR_ERR(hcd->regs);
+               goto put_hcd;
+       }
+
        hcd->rsrc_start = res->start;
        hcd->rsrc_len = resource_size(res);
 
-       if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len,
-                               driver->description)) {
-               dev_dbg(&pdev->dev, "controller already in use\n");
-               ret = -EBUSY;
+       /*
+        * Not all platforms have a clk so it is not an error if the
+        * clock does not exists.
+        */
+       clk = devm_clk_get(&pdev->dev, NULL);
+       if (!IS_ERR(clk)) {
+               ret = clk_prepare_enable(clk);
+               if (ret)
+                       goto put_hcd;
+       } else if (PTR_ERR(clk) == -EPROBE_DEFER) {
+               ret = -EPROBE_DEFER;
                goto put_hcd;
        }
 
-       hcd->regs = ioremap_nocache(hcd->rsrc_start, hcd->rsrc_len);
-       if (!hcd->regs) {
-               dev_dbg(&pdev->dev, "error mapping memory\n");
-               ret = -EFAULT;
-               goto release_mem_region;
+       if (of_device_is_compatible(pdev->dev.of_node,
+                                   "marvell,armada-375-xhci") ||
+           of_device_is_compatible(pdev->dev.of_node,
+                                   "marvell,armada-380-xhci")) {
+               ret = xhci_mvebu_mbus_init_quirk(pdev);
+               if (ret)
+                       goto disable_clk;
        }
 
-       ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
-       if (ret)
-               goto unmap_registers;
+       device_wakeup_enable(hcd->self.controller);
 
-       /* USB 2.0 roothub is stored in the platform_device now. */
-       hcd = dev_get_drvdata(&pdev->dev);
        xhci = hcd_to_xhci(hcd);
+       xhci->clk = clk;
+       xhci->main_hcd = hcd;
        xhci->shared_hcd = usb_create_shared_hcd(driver, &pdev->dev,
                        dev_name(&pdev->dev), hcd);
        if (!xhci->shared_hcd) {
                ret = -ENOMEM;
-               goto dealloc_usb2_hcd;
+               goto disable_clk;
        }
 
-       /*
-        * Set the xHCI pointer before xhci_plat_setup() (aka hcd_driver.reset)
-        * is called by usb_add_hcd().
-        */
-       *((struct xhci_hcd **) xhci->shared_hcd->hcd_priv) = xhci;
+       if ((node && of_property_read_bool(node, "usb3-lpm-capable")) ||
+                       (pdata && pdata->usb3_lpm_capable))
+               xhci->quirks |= XHCI_LPM_SUPPORT;
+
+       if (pdata && pdata->usb3_disable_autosuspend)
+               xhci->quirks |= XHCI_DIS_AUTOSUSPEND;
+
+       xhci->shared_hcd->usb_phy = devm_usb_get_phy(&pdev->dev,
+                                                    USB_PHY_TYPE_USB3);
+       if (IS_ERR(xhci->shared_hcd->usb_phy)) {
+               ret = PTR_ERR(xhci->shared_hcd->usb_phy);
+               if (ret == -EPROBE_DEFER)
+                       goto put_usb3_hcd;
+               xhci->shared_hcd->usb_phy = NULL;
+       }
+
+       hcd->usb_phy = devm_usb_get_phy_by_phandle(&pdev->dev, "usb-phy", 0);
+       if (IS_ERR(hcd->usb_phy)) {
+               ret = PTR_ERR(hcd->usb_phy);
+               if (ret == -EPROBE_DEFER)
+                       goto put_usb3_hcd;
+               hcd->usb_phy = NULL;
+       } else {
+               ret = usb_phy_init(hcd->usb_phy);
+               if (ret)
+                       goto put_usb3_hcd;
+       }
+
+       ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
+       if (ret)
+               goto disable_usb_phy;
 
        ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
        if (ret)
-               goto put_usb3_hcd;
+               goto dealloc_usb2_hcd;
+
+       if (HCC_MAX_PSA(xhci->hcc_params) >= 4)
+               xhci->shared_hcd->can_do_streams = 1;
 
        return 0;
 
-put_usb3_hcd:
-       usb_put_hcd(xhci->shared_hcd);
 
 dealloc_usb2_hcd:
        usb_remove_hcd(hcd);
 
-unmap_registers:
-       iounmap(hcd->regs);
+disable_usb_phy:
+       usb_phy_shutdown(hcd->usb_phy);
 
-release_mem_region:
-       release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
+put_usb3_hcd:
+       usb_put_hcd(xhci->shared_hcd);
+
+disable_clk:
+       if (!IS_ERR(clk))
+               clk_disable_unprepare(clk);
 
 put_hcd:
        usb_put_hcd(hcd);
@@ -173,33 +233,99 @@ static int xhci_plat_remove(struct platform_device *dev)
 {
        struct usb_hcd  *hcd = platform_get_drvdata(dev);
        struct xhci_hcd *xhci = hcd_to_xhci(hcd);
+       struct clk *clk = xhci->clk;
 
        usb_remove_hcd(xhci->shared_hcd);
-       usb_put_hcd(xhci->shared_hcd);
+       usb_phy_shutdown(hcd->usb_phy);
 
        usb_remove_hcd(hcd);
-       iounmap(hcd->regs);
+       usb_put_hcd(xhci->shared_hcd);
+
+       if (!IS_ERR(clk))
+               clk_disable_unprepare(clk);
        usb_put_hcd(hcd);
-       kfree(xhci);
 
        return 0;
 }
 
+#ifdef CONFIG_PM_SLEEP
+static int xhci_plat_suspend(struct device *dev)
+{
+       struct usb_hcd  *hcd = dev_get_drvdata(dev);
+       struct xhci_hcd *xhci = hcd_to_xhci(hcd);
+
+       /*
+        * xhci_suspend() needs `do_wakeup` to know whether host is allowed
+        * to do wakeup during suspend. Since xhci_plat_suspend is currently
+        * only designed for system suspend, device_may_wakeup() is enough
+        * to dertermine whether host is allowed to do wakeup. Need to
+        * reconsider this when xhci_plat_suspend enlarges its scope, e.g.,
+        * also applies to runtime suspend.
+        */
+       return xhci_suspend(xhci, device_may_wakeup(dev));
+}
+
+static int xhci_plat_resume(struct device *dev)
+{
+       struct usb_hcd  *hcd = dev_get_drvdata(dev);
+       struct xhci_hcd *xhci = hcd_to_xhci(hcd);
+
+       return xhci_resume(xhci, 0);
+}
+
+static const struct dev_pm_ops xhci_plat_pm_ops = {
+       SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume)
+};
+#define DEV_PM_OPS     (&xhci_plat_pm_ops)
+#else
+#define DEV_PM_OPS     NULL
+#endif /* CONFIG_PM */
+
+#ifdef CONFIG_OF
+static const struct of_device_id usb_xhci_of_match[] = {
+       { .compatible = "generic-xhci" },
+       { .compatible = "xhci-platform" },
+       { .compatible = "marvell,armada-375-xhci"},
+       { .compatible = "marvell,armada-380-xhci"},
+       { .compatible = "renesas,xhci-r8a7790"},
+       { .compatible = "renesas,xhci-r8a7791"},
+       { },
+};
+MODULE_DEVICE_TABLE(of, usb_xhci_of_match);
+#endif
+
+static const struct acpi_device_id usb_xhci_acpi_match[] = {
+       /* XHCI-compliant USB Controller */
+       { "PNP0D10", },
+       { }
+};
+MODULE_DEVICE_TABLE(acpi, usb_xhci_acpi_match);
+
 static struct platform_driver usb_xhci_driver = {
        .probe  = xhci_plat_probe,
        .remove = xhci_plat_remove,
+       .shutdown = usb_hcd_platform_shutdown,
        .driver = {
                .name = "xhci-hcd",
+               .pm = DEV_PM_OPS,
+               .of_match_table = of_match_ptr(usb_xhci_of_match),
+               .acpi_match_table = ACPI_PTR(usb_xhci_acpi_match),
        },
 };
 MODULE_ALIAS("platform:xhci-hcd");
 
-int xhci_register_plat(void)
+static int __init xhci_plat_init(void)
 {
+       xhci_init_driver(&xhci_plat_hc_driver, &xhci_plat_overrides);
        return platform_driver_register(&usb_xhci_driver);
 }
+module_init(xhci_plat_init);
 
-void xhci_unregister_plat(void)
+static void __exit xhci_plat_exit(void)
 {
        platform_driver_unregister(&usb_xhci_driver);
 }
+module_exit(xhci_plat_exit);
+
+MODULE_DESCRIPTION("xHCI Platform Host Controller Driver");
+MODULE_LICENSE("GPL");