usb: ohci: backport ohci-platform.c driver from kernel-3.18
authorlyz <lyz@rock-chips.com>
Wed, 24 Dec 2014 06:45:38 +0000 (14:45 +0800)
committerHuang, Tao <huangtao@rock-chips.com>
Wed, 24 Dec 2014 10:50:05 +0000 (18:50 +0800)
drivers/usb/host/Makefile
drivers/usb/host/ohci-hcd.c
drivers/usb/host/ohci-platform.c
drivers/usb/host/ohci.h

index 14b0259379b0920f0d8ffa6586bab6fca1811964..fbf2d93a752c686851420cee25312eafb39c70c8 100644 (file)
@@ -40,6 +40,7 @@ obj-$(CONFIG_USB_OXU210HP_HCD)        += oxu210hp-hcd.o
 obj-$(CONFIG_USB_ISP116X_HCD)  += isp116x-hcd.o
 obj-$(CONFIG_USB_ISP1362_HCD)  += isp1362-hcd.o
 obj-$(CONFIG_USB_OHCI_HCD)     += ohci-hcd.o
+obj-$(CONFIG_USB_OHCI_HCD_PLATFORM) += ohci-platform.o
 obj-$(CONFIG_USB_UHCI_HCD)     += uhci-hcd.o
 obj-$(CONFIG_USB_FHCI_HCD)     += fhci.o
 obj-$(CONFIG_USB_XHCI_HCD)     += xhci-hcd.o
index 11aed62fcc7bed22e9b2892ebecee5cb04b524e9..1e48a7f451b09713eb186949cc68830d19e241dd 100644 (file)
@@ -774,6 +774,32 @@ retry:
        return 0;
 }
 
+/* ohci_setup routine for generic controller initialization */
+
+int ohci_setup(struct usb_hcd *hcd)
+{
+       struct ohci_hcd         *ohci = hcd_to_ohci(hcd);
+
+       ohci_hcd_init(ohci);
+
+       return ohci_init(ohci);
+}
+EXPORT_SYMBOL_GPL(ohci_setup);
+
+/* ohci_start routine for generic controller start of all OHCI bus glue */
+static int ohci_start(struct usb_hcd *hcd)
+{
+       struct ohci_hcd         *ohci = hcd_to_ohci(hcd);
+       int     ret;
+
+       ret = ohci_run(ohci);
+       if (ret < 0) {
+               ohci_err(ohci, "can't start\n");
+               ohci_stop(hcd);
+       }
+       return ret;
+}
+
 /*-------------------------------------------------------------------------*/
 
 /* an interrupt happens */
@@ -1019,7 +1045,7 @@ static int ohci_restart (struct ohci_hcd *ohci)
 
 #ifdef CONFIG_PM
 
-static int __maybe_unused ohci_suspend(struct usb_hcd *hcd, bool do_wakeup)
+int __maybe_unused ohci_suspend(struct usb_hcd *hcd, bool do_wakeup)
 {
        struct ohci_hcd *ohci = hcd_to_ohci (hcd);
        unsigned long   flags;
@@ -1039,7 +1065,7 @@ static int __maybe_unused ohci_suspend(struct usb_hcd *hcd, bool do_wakeup)
 }
 
 
-static int __maybe_unused ohci_resume(struct usb_hcd *hcd, bool hibernated)
+int __maybe_unused ohci_resume(struct usb_hcd *hcd, bool hibernated)
 {
        struct ohci_hcd         *ohci = hcd_to_ohci(hcd);
        int                     port;
@@ -1089,6 +1115,70 @@ static int __maybe_unused ohci_resume(struct usb_hcd *hcd, bool hibernated)
 }
 
 #endif
+/*-------------------------------------------------------------------------*/
+
+/*
+ * Generic structure: This gets copied for platform drivers so that
+ * individual entries can be overridden as needed.
+ */
+
+static const struct hc_driver ohci_hc_driver = {
+       .description =          hcd_name,
+       .product_desc =         "OHCI Host Controller",
+       .hcd_priv_size =        sizeof(struct ohci_hcd),
+
+       /*
+        * generic hardware linkage
+       */
+       .irq =                  ohci_irq,
+       .flags =                HCD_MEMORY | HCD_USB11,
+
+       /*
+       * basic lifecycle operations
+       */
+       .reset =                ohci_setup,
+       .start =                ohci_start,
+       .stop =                 ohci_stop,
+       .shutdown =             ohci_shutdown,
+
+       /*
+        * managing i/o requests and associated device resources
+       */
+       .urb_enqueue =          ohci_urb_enqueue,
+       .urb_dequeue =          ohci_urb_dequeue,
+       .endpoint_disable =     ohci_endpoint_disable,
+
+       /*
+       * scheduling support
+       */
+       .get_frame_number =     ohci_get_frame,
+
+       /*
+       * root hub support
+       */
+       .hub_status_data =      ohci_hub_status_data,
+       .hub_control =          ohci_hub_control,
+#ifdef CONFIG_PM
+       .bus_suspend =          ohci_bus_suspend,
+       .bus_resume =           ohci_bus_resume,
+#endif
+       .start_port_reset =     ohci_start_port_reset,
+};
+
+void ohci_init_driver(struct hc_driver *drv,
+               const struct ohci_driver_overrides *over)
+{
+       /* Copy the generic table to drv and then apply the overrides */
+       *drv = ohci_hc_driver;
+
+       if (over) {
+               drv->product_desc = over->product_desc;
+               drv->hcd_priv_size += over->extra_priv_size;
+               if (over->reset)
+                       drv->reset = over->reset;
+       }
+}
+EXPORT_SYMBOL_GPL(ohci_init_driver);
 
 /*-------------------------------------------------------------------------*/
 
@@ -1196,11 +1286,6 @@ MODULE_LICENSE ("GPL");
 #define PLATFORM_DRIVER                ohci_hcd_rk_driver
 #endif
 
-#ifdef CONFIG_USB_OHCI_HCD_PLATFORM
-#include "ohci-platform.c"
-#define PLATFORM_DRIVER                ohci_platform_driver
-#endif
-
 static int __init ohci_hcd_mod_init(void)
 {
        int retval = 0;
index c3e7287f792170028f89cd65192fda0ac5a3d915..2f66ad536aa62105b27949914906279c91dac690 100644 (file)
@@ -3,6 +3,7 @@
  *
  * Copyright 2007 Michael Buesch <m@bues.ch>
  * Copyright 2011-2012 Hauke Mehrtens <hauke@hauke-m.de>
+ * Copyright 2014 Hans de Goede <hdegoede@redhat.com>
  *
  * Derived from the OCHI-SSB driver
  * Derived from the OHCI-PCI driver
  *
  * Licensed under the GNU/GPL. See COPYING for details.
  */
+
+#include <linux/clk.h>
+#include <linux/dma-mapping.h>
+#include <linux/hrtimer.h>
+#include <linux/io.h>
+#include <linux/kernel.h>
+#include <linux/module.h>
 #include <linux/err.h>
+#include <linux/phy/phy.h>
 #include <linux/platform_device.h>
+#include <linux/reset.h>
 #include <linux/usb/ohci_pdriver.h>
+#include <linux/usb.h>
+#include <linux/usb/hcd.h>
 
-static int ohci_platform_reset(struct usb_hcd *hcd)
-{
-       struct platform_device *pdev = to_platform_device(hcd->self.controller);
-       struct usb_ohci_pdata *pdata = pdev->dev.platform_data;
-       struct ohci_hcd *ohci = hcd_to_ohci(hcd);
-       int err;
+#include "ohci.h"
 
-       if (pdata->big_endian_desc)
-               ohci->flags |= OHCI_QUIRK_BE_DESC;
-       if (pdata->big_endian_mmio)
-               ohci->flags |= OHCI_QUIRK_BE_MMIO;
-       if (pdata->no_big_frame_no)
-               ohci->flags |= OHCI_QUIRK_FRAME_NO;
+#define DRIVER_DESC "OHCI generic platform driver"
+#define OHCI_MAX_CLKS 3
+#define hcd_to_ohci_priv(h) ((struct ohci_platform_priv *)hcd_to_ohci(h)->priv)
 
-       ohci_hcd_init(ohci);
+struct ohci_platform_priv {
+       struct clk *clks[OHCI_MAX_CLKS];
+       struct reset_control *rst;
+       struct phy *phy;
+};
 
-       if (pdata->num_ports)
-               ohci->num_ports = pdata->num_ports;
+static const char hcd_name[] = "ohci-platform";
 
-       err = ohci_init(ohci);
+static int ohci_platform_power_on(struct platform_device *dev)
+{
+       struct usb_hcd *hcd = platform_get_drvdata(dev);
+       struct ohci_platform_priv *priv = hcd_to_ohci_priv(hcd);
+       int clk, ret;
 
-       return err;
-}
+       for (clk = 0; clk < OHCI_MAX_CLKS && priv->clks[clk]; clk++) {
+               ret = clk_prepare_enable(priv->clks[clk]);
+               if (ret)
+                       goto err_disable_clks;
+       }
 
-static int ohci_platform_start(struct usb_hcd *hcd)
-{
-       struct ohci_hcd *ohci = hcd_to_ohci(hcd);
-       int err;
+       if (priv->phy) {
+               ret = phy_init(priv->phy);
+               if (ret)
+                       goto err_disable_clks;
 
-       err = ohci_run(ohci);
-       if (err < 0) {
-               ohci_err(ohci, "can't start\n");
-               ohci_stop(hcd);
+               ret = phy_power_on(priv->phy);
+               if (ret)
+                       goto err_exit_phy;
        }
 
-       return err;
-}
+       return 0;
+
+err_exit_phy:
+       phy_exit(priv->phy);
+err_disable_clks:
+       while (--clk >= 0)
+               clk_disable_unprepare(priv->clks[clk]);
 
-static const struct hc_driver ohci_platform_hc_driver = {
-       .description            = hcd_name,
-       .product_desc           = "Generic Platform OHCI Controller",
-       .hcd_priv_size          = sizeof(struct ohci_hcd),
+       return ret;
+}
 
-       .irq                    = ohci_irq,
-       .flags                  = HCD_MEMORY | HCD_USB11,
+static void ohci_platform_power_off(struct platform_device *dev)
+{
+       struct usb_hcd *hcd = platform_get_drvdata(dev);
+       struct ohci_platform_priv *priv = hcd_to_ohci_priv(hcd);
+       int clk;
 
-       .reset                  = ohci_platform_reset,
-       .start                  = ohci_platform_start,
-       .stop                   = ohci_stop,
-       .shutdown               = ohci_shutdown,
+       if (priv->phy) {
+               phy_power_off(priv->phy);
+               phy_exit(priv->phy);
+       }
 
-       .urb_enqueue            = ohci_urb_enqueue,
-       .urb_dequeue            = ohci_urb_dequeue,
-       .endpoint_disable       = ohci_endpoint_disable,
+       for (clk = OHCI_MAX_CLKS - 1; clk >= 0; clk--)
+               if (priv->clks[clk])
+                       clk_disable_unprepare(priv->clks[clk]);
+}
 
-       .get_frame_number       = ohci_get_frame,
+static struct hc_driver __read_mostly ohci_platform_hc_driver;
 
-       .hub_status_data        = ohci_hub_status_data,
-       .hub_control            = ohci_hub_control,
-#ifdef CONFIG_PM
-       .bus_suspend            = ohci_bus_suspend,
-       .bus_resume             = ohci_bus_resume,
-#endif
+static const struct ohci_driver_overrides platform_overrides __initconst = {
+       .product_desc =         "Generic Platform OHCI controller",
+       .extra_priv_size =      sizeof(struct ohci_platform_priv),
+};
 
-       .start_port_reset       = ohci_start_port_reset,
+static struct usb_ohci_pdata ohci_platform_defaults = {
+       .power_on =             ohci_platform_power_on,
+       .power_suspend =        ohci_platform_power_off,
+       .power_off =            ohci_platform_power_off,
 };
 
 static int ohci_platform_probe(struct platform_device *dev)
 {
        struct usb_hcd *hcd;
        struct resource *res_mem;
-       struct usb_ohci_pdata *pdata = dev->dev.platform_data;
-       int irq;
-       int err = -ENOMEM;
-
-       if (!pdata) {
-               WARN_ON(1);
-               return -ENODEV;
-       }
+       struct usb_ohci_pdata *pdata = dev_get_platdata(&dev->dev);
+       struct ohci_platform_priv *priv;
+       struct ohci_hcd *ohci;
+       int err, irq, clk = 0;
 
        if (usb_disabled())
                return -ENODEV;
 
+       /*
+        * Use reasonable defaults so platforms don't have to provide these
+        * with DT probing on ARM.
+        */
+       if (!pdata)
+               pdata = &ohci_platform_defaults;
+
+       err = dma_coerce_mask_and_coherent(&dev->dev, DMA_BIT_MASK(32));
+       if (err)
+               return err;
+
        irq = platform_get_irq(dev, 0);
        if (irq < 0) {
                dev_err(&dev->dev, "no irq provided");
                return irq;
        }
 
-       res_mem = platform_get_resource(dev, IORESOURCE_MEM, 0);
-       if (!res_mem) {
-               dev_err(&dev->dev, "no memory resource provided");
-               return -ENXIO;
+       hcd = usb_create_hcd(&ohci_platform_hc_driver, &dev->dev,
+                       dev_name(&dev->dev));
+       if (!hcd)
+               return -ENOMEM;
+
+       platform_set_drvdata(dev, hcd);
+       dev->dev.platform_data = pdata;
+       priv = hcd_to_ohci_priv(hcd);
+       ohci = hcd_to_ohci(hcd);
+
+       if (pdata == &ohci_platform_defaults && dev->dev.of_node) {
+               if (of_property_read_bool(dev->dev.of_node, "big-endian-regs"))
+                       ohci->flags |= OHCI_QUIRK_BE_MMIO;
+
+               if (of_property_read_bool(dev->dev.of_node, "big-endian-desc"))
+                       ohci->flags |= OHCI_QUIRK_BE_DESC;
+
+               if (of_property_read_bool(dev->dev.of_node, "big-endian"))
+                       ohci->flags |= OHCI_QUIRK_BE_MMIO | OHCI_QUIRK_BE_DESC;
+
+               if (of_property_read_bool(dev->dev.of_node, "no-big-frame-no"))
+                       ohci->flags |= OHCI_QUIRK_FRAME_NO;
+
+               of_property_read_u32(dev->dev.of_node, "num-ports",
+                                    &ohci->num_ports);
+
+               priv->phy = devm_phy_get(&dev->dev, "usb");
+               if (IS_ERR(priv->phy)) {
+                       err = PTR_ERR(priv->phy);
+                       if (err == -EPROBE_DEFER)
+                               goto err_put_hcd;
+                       priv->phy = NULL;
+               }
+
+               for (clk = 0; clk < OHCI_MAX_CLKS; clk++) {
+                       priv->clks[clk] = of_clk_get(dev->dev.of_node, clk);
+                       if (IS_ERR(priv->clks[clk])) {
+                               err = PTR_ERR(priv->clks[clk]);
+                               if (err == -EPROBE_DEFER)
+                                       goto err_put_clks;
+                               priv->clks[clk] = NULL;
+                               break;
+                       }
+               }
+
+       }
+
+       priv->rst = devm_reset_control_get(&dev->dev, NULL);
+       if (IS_ERR(priv->rst)) {
+               err = PTR_ERR(priv->rst);
+               if (err == -EPROBE_DEFER)
+                       goto err_put_clks;
+               priv->rst = NULL;
+       } else {
+               err = reset_control_deassert(priv->rst);
+               if (err)
+                       goto err_put_clks;
+       }
+
+       if (pdata->big_endian_desc)
+               ohci->flags |= OHCI_QUIRK_BE_DESC;
+       if (pdata->big_endian_mmio)
+               ohci->flags |= OHCI_QUIRK_BE_MMIO;
+       if (pdata->no_big_frame_no)
+               ohci->flags |= OHCI_QUIRK_FRAME_NO;
+       if (pdata->num_ports)
+               ohci->num_ports = pdata->num_ports;
+
+#ifndef CONFIG_USB_OHCI_BIG_ENDIAN_MMIO
+       if (ohci->flags & OHCI_QUIRK_BE_MMIO) {
+               dev_err(&dev->dev,
+                       "Error: CONFIG_USB_OHCI_BIG_ENDIAN_MMIO not set\n");
+               err = -EINVAL;
+               goto err_reset;
        }
+#endif
+#ifndef CONFIG_USB_OHCI_BIG_ENDIAN_DESC
+       if (ohci->flags & OHCI_QUIRK_BE_DESC) {
+               dev_err(&dev->dev,
+                       "Error: CONFIG_USB_OHCI_BIG_ENDIAN_DESC not set\n");
+               err = -EINVAL;
+               goto err_reset;
+       }
+#endif
 
        if (pdata->power_on) {
                err = pdata->power_on(dev);
                if (err < 0)
-                       return err;
+                       goto err_reset;
        }
 
-       hcd = usb_create_hcd(&ohci_platform_hc_driver, &dev->dev,
-                       dev_name(&dev->dev));
-       if (!hcd) {
-               err = -ENOMEM;
+       res_mem = platform_get_resource(dev, IORESOURCE_MEM, 0);
+       hcd->regs = devm_ioremap_resource(&dev->dev, res_mem);
+       if (IS_ERR(hcd->regs)) {
+               err = PTR_ERR(hcd->regs);
                goto err_power;
        }
-
        hcd->rsrc_start = res_mem->start;
        hcd->rsrc_len = resource_size(res_mem);
 
-       hcd->regs = devm_ioremap_resource(&dev->dev, res_mem);
-       if (IS_ERR(hcd->regs)) {
-               err = PTR_ERR(hcd->regs);
-               goto err_put_hcd;
-       }
        err = usb_add_hcd(hcd, irq, IRQF_SHARED);
        if (err)
-               goto err_put_hcd;
+               goto err_power;
+
+       device_wakeup_enable(hcd->self.controller);
 
        platform_set_drvdata(dev, hcd);
 
        return err;
 
-err_put_hcd:
-       usb_put_hcd(hcd);
 err_power:
        if (pdata->power_off)
                pdata->power_off(dev);
+err_reset:
+       if (priv->rst)
+               reset_control_assert(priv->rst);
+err_put_clks:
+       while (--clk >= 0)
+               clk_put(priv->clks[clk]);
+err_put_hcd:
+       if (pdata == &ohci_platform_defaults)
+               dev->dev.platform_data = NULL;
+
+       usb_put_hcd(hcd);
 
        return err;
 }
@@ -153,36 +265,53 @@ err_power:
 static int ohci_platform_remove(struct platform_device *dev)
 {
        struct usb_hcd *hcd = platform_get_drvdata(dev);
-       struct usb_ohci_pdata *pdata = dev->dev.platform_data;
+       struct usb_ohci_pdata *pdata = dev_get_platdata(&dev->dev);
+       struct ohci_platform_priv *priv = hcd_to_ohci_priv(hcd);
+       int clk;
 
        usb_remove_hcd(hcd);
-       usb_put_hcd(hcd);
-       platform_set_drvdata(dev, NULL);
 
        if (pdata->power_off)
                pdata->power_off(dev);
 
+       if (priv->rst)
+               reset_control_assert(priv->rst);
+
+       for (clk = 0; clk < OHCI_MAX_CLKS && priv->clks[clk]; clk++)
+               clk_put(priv->clks[clk]);
+
+       usb_put_hcd(hcd);
+
+       if (pdata == &ohci_platform_defaults)
+               dev->dev.platform_data = NULL;
+
        return 0;
 }
 
-#ifdef CONFIG_PM
-
+#ifdef CONFIG_PM_SLEEP
 static int ohci_platform_suspend(struct device *dev)
 {
+       struct usb_hcd *hcd = dev_get_drvdata(dev);
        struct usb_ohci_pdata *pdata = dev->platform_data;
        struct platform_device *pdev =
                container_of(dev, struct platform_device, dev);
+       bool do_wakeup = device_may_wakeup(dev);
+       int ret;
+
+       ret = ohci_suspend(hcd, do_wakeup);
+       if (ret)
+               return ret;
 
        if (pdata->power_suspend)
                pdata->power_suspend(pdev);
 
-       return 0;
+       return ret;
 }
 
 static int ohci_platform_resume(struct device *dev)
 {
        struct usb_hcd *hcd = dev_get_drvdata(dev);
-       struct usb_ohci_pdata *pdata = dev->platform_data;
+       struct usb_ohci_pdata *pdata = dev_get_platdata(dev);
        struct platform_device *pdev =
                container_of(dev, struct platform_device, dev);
 
@@ -195,11 +324,13 @@ static int ohci_platform_resume(struct device *dev)
        ohci_resume(hcd, false);
        return 0;
 }
+#endif /* CONFIG_PM_SLEEP */
 
-#else /* !CONFIG_PM */
-#define ohci_platform_suspend  NULL
-#define ohci_platform_resume   NULL
-#endif /* CONFIG_PM */
+static const struct of_device_id ohci_platform_ids[] = {
+       { .compatible = "generic-ohci", },
+       { }
+};
+MODULE_DEVICE_TABLE(of, ohci_platform_ids);
 
 static const struct platform_device_id ohci_platform_table[] = {
        { "ohci-platform", 0 },
@@ -207,10 +338,8 @@ static const struct platform_device_id ohci_platform_table[] = {
 };
 MODULE_DEVICE_TABLE(platform, ohci_platform_table);
 
-static const struct dev_pm_ops ohci_platform_pm_ops = {
-       .suspend        = ohci_platform_suspend,
-       .resume         = ohci_platform_resume,
-};
+static SIMPLE_DEV_PM_OPS(ohci_platform_pm_ops, ohci_platform_suspend,
+       ohci_platform_resume);
 
 static struct platform_driver ohci_platform_driver = {
        .id_table       = ohci_platform_table,
@@ -218,8 +347,31 @@ static struct platform_driver ohci_platform_driver = {
        .remove         = ohci_platform_remove,
        .shutdown       = usb_hcd_platform_shutdown,
        .driver         = {
-               .owner  = THIS_MODULE,
                .name   = "ohci-platform",
                .pm     = &ohci_platform_pm_ops,
+               .of_match_table = ohci_platform_ids,
        }
 };
+
+static int __init ohci_platform_init(void)
+{
+       if (usb_disabled())
+               return -ENODEV;
+
+       pr_info("%s: " DRIVER_DESC "\n", hcd_name);
+
+       ohci_init_driver(&ohci_platform_hc_driver, &platform_overrides);
+       return platform_driver_register(&ohci_platform_driver);
+}
+module_init(ohci_platform_init);
+
+static void __exit ohci_platform_cleanup(void)
+{
+       platform_driver_unregister(&ohci_platform_driver);
+}
+module_exit(ohci_platform_cleanup);
+
+MODULE_DESCRIPTION(DRIVER_DESC);
+MODULE_AUTHOR("Hauke Mehrtens");
+MODULE_AUTHOR("Alan Stern");
+MODULE_LICENSE("GPL");
index f2521f3185d2dc7b51c5cf3a9a5c7bb0aeb6e79e..535bb961182c449ba727f6cfac61be3e69253bfb 100644 (file)
@@ -423,6 +423,10 @@ struct ohci_hcd {
        struct dentry           *debug_periodic;
        struct dentry           *debug_registers;
 #endif
+
+       /* platform-specific data -- must come last */
+       unsigned long           priv[0] __aligned(sizeof(s64));
+
 };
 
 #ifdef CONFIG_PCI
@@ -720,3 +724,19 @@ static inline u32 roothub_status (struct ohci_hcd *hc)
        { return ohci_readl (hc, &hc->regs->roothub.status); }
 static inline u32 roothub_portstatus (struct ohci_hcd *hc, int i)
        { return read_roothub (hc, portstatus [i], 0xffe0fce0); }
+
+/* Declarations of things exported for use by ohci platform drivers */
+
+struct ohci_driver_overrides {
+       const char      *product_desc;
+       size_t          extra_priv_size;
+       int             (*reset)(struct usb_hcd *hcd);
+};
+
+extern void    ohci_init_driver(struct hc_driver *drv,
+                               const struct ohci_driver_overrides *over);
+extern int     ohci_setup(struct usb_hcd *hcd);
+#ifdef CONFIG_PM
+extern int     ohci_suspend(struct usb_hcd *hcd, bool do_wakeup);
+extern int     ohci_resume(struct usb_hcd *hcd, bool hibernated);
+#endif