diff mbox

USB: EHCI: make ehci-spear a separate driver

Message ID 1363868099-32240-1-git-send-email-manjunath.goudar@linaro.org
State New
Headers show

Commit Message

manjunath.goudar@linaro.org March 21, 2013, 12:14 p.m. UTC
Separate the SPEAr host controller driver from ehci-hcd host code
so that it can be built as a separate driver module.
This work is part of enabling multi-platform kernels on ARM;
however, note that other changes are still needed before SPEAr can be
booted with a multi-platform kernel.

With the infrastructure added by Alan Stern in patch 3e0232039
"USB: EHCI: prepare to make ehci-hcd a library module", we can
avoid this problem by turning a bus glue into a separate
module, as we do here for the SPEAr bus glue.

In V3:
 -Detail commit message added here,why this patch is required.
 -Eliminated the ehci_spear_setup routine beacuse hcd registers
  directly setting in spear_ehci_hcd_drv_probe function.
 -Eliminate spear_overrides struct.
 -Eliminate struct spear_ehci,to enable SPEAr uses struct clk *usbh_clk in
  clk_prepare_enable.
 -Eliminate separate spear_ehci structure allocation.

In V2:
Replaced spear as SPEAr everywhere, leaving functions/variables/config options.

Signed-off-by: Manjunath Goudar <manjunath.goudar@linaro.org>
Signed-off-by: Deepak Saxena <dsaxena@linaro.org>
Acked-by: Viresh Kumar <viresh.linux@gmail.com>
Acked-by: Arnd Bergmann <arnd@arndb.de>
Cc: Greg KH <greg@kroah.com>
Cc: Alan Stern <stern@rowland.harvard.edu>
Cc: Shiraz Hashim <shiraz.hashim@st.com>
Cc: linux-usb@vger.kernel.org
Cc: spear-devel@list.st.com
---
 drivers/usb/host/Kconfig      |    8 ++++
 drivers/usb/host/Makefile     |    1 +
 drivers/usb/host/ehci-hcd.c   |    6 +--
 drivers/usb/host/ehci-spear.c |  104 +++++++++++++++--------------------------
 4 files changed, 48 insertions(+), 71 deletions(-)

Comments

manjunath.goudar@linaro.org March 22, 2013, 7:31 a.m. UTC | #1
On 21 March 2013 17:44, Manjunath Goudar <manjunath.goudar@linaro.org>wrote:

> Separate the SPEAr host controller driver from ehci-hcd host code
> so that it can be built as a separate driver module.
> This work is part of enabling multi-platform kernels on ARM;
> however, note that other changes are still needed before SPEAr can be
> booted with a multi-platform kernel.
>
> With the infrastructure added by Alan Stern in patch 3e0232039
> "USB: EHCI: prepare to make ehci-hcd a library module", we can
> avoid this problem by turning a bus glue into a separate
> module, as we do here for the SPEAr bus glue.
>
> In V3:
>  -Detail commit message added here,why this patch is required.
>  -Eliminated the ehci_spear_setup routine beacuse hcd registers
>   directly setting in spear_ehci_hcd_drv_probe function.
>  -Eliminate spear_overrides struct.
>  -Eliminate struct spear_ehci,to enable SPEAr uses struct clk *usbh_clk in
>   clk_prepare_enable.
>  -Eliminate separate spear_ehci structure allocation.
>
> In V2:
> Replaced spear as SPEAr everywhere, leaving functions/variables/config
> options.
>
> Signed-off-by: Manjunath Goudar <manjunath.goudar@linaro.org>
> Signed-off-by: Deepak Saxena <dsaxena@linaro.org>
> Acked-by: Viresh Kumar <viresh.linux@gmail.com>
> Acked-by: Arnd Bergmann <arnd@arndb.de>
> Cc: Greg KH <greg@kroah.com>
> Cc: Alan Stern <stern@rowland.harvard.edu>
> Cc: Shiraz Hashim <shiraz.hashim@st.com>
> Cc: linux-usb@vger.kernel.org
> Cc: spear-devel@list.st.com
> ---
>  drivers/usb/host/Kconfig      |    8 ++++
>  drivers/usb/host/Makefile     |    1 +
>  drivers/usb/host/ehci-hcd.c   |    6 +--
>  drivers/usb/host/ehci-spear.c |  104
> +++++++++++++++--------------------------
>  4 files changed, 48 insertions(+), 71 deletions(-)
>
> diff --git a/drivers/usb/host/Kconfig b/drivers/usb/host/Kconfig
> index c59a112..cd4fdac 100644
> --- a/drivers/usb/host/Kconfig
> +++ b/drivers/usb/host/Kconfig
> @@ -162,6 +162,14 @@ config USB_EHCI_HCD_OMAP
>           Enables support for the on-chip EHCI controller on
>           OMAP3 and later chips.
>
> +config USB_EHCI_HCD_SPEAR
> +        tristate "Support for ST SPEAr on-chip EHCI USB controller"
> +        depends on USB_EHCI_HCD && PLAT_SPEAR
> +        default y
> +        ---help---
> +          Enables support for the on-chip EHCI controller on
> +          ST SPEAr chips.
> +
>  config USB_EHCI_MSM
>         bool "Support for MSM on-chip EHCI USB controller"
>         depends on USB_EHCI_HCD && ARCH_MSM
> diff --git a/drivers/usb/host/Makefile b/drivers/usb/host/Makefile
> index 001fbff..8da680d 100644
> --- a/drivers/usb/host/Makefile
> +++ b/drivers/usb/host/Makefile
> @@ -27,6 +27,7 @@ obj-$(CONFIG_USB_EHCI_HCD)    += ehci-hcd.o
>  obj-$(CONFIG_USB_EHCI_PCI)     += ehci-pci.o
>  obj-$(CONFIG_USB_EHCI_HCD_PLATFORM)    += ehci-platform.o
>  obj-$(CONFIG_USB_EHCI_MXC)     += ehci-mxc.o
> +obj-$(CONFIG_USB_EHCI_HCD_SPEAR)       += ehci-spear.o
>
>  obj-$(CONFIG_USB_OXU210HP_HCD) += oxu210hp-hcd.o
>  obj-$(CONFIG_USB_ISP116X_HCD)  += isp116x-hcd.o
> diff --git a/drivers/usb/host/ehci-hcd.c b/drivers/usb/host/ehci-hcd.c
> index b416a3f..c4afd86 100644
> --- a/drivers/usb/host/ehci-hcd.c
> +++ b/drivers/usb/host/ehci-hcd.c
> @@ -1297,11 +1297,6 @@ MODULE_LICENSE ("GPL");
>  #define        PLATFORM_DRIVER         vt8500_ehci_driver
>  #endif
>
> -#ifdef CONFIG_PLAT_SPEAR
> -#include "ehci-spear.c"
> -#define PLATFORM_DRIVER                spear_ehci_hcd_driver
> -#endif
> -
>  #ifdef CONFIG_USB_EHCI_MSM
>  #include "ehci-msm.c"
>  #define PLATFORM_DRIVER                ehci_msm_driver
> @@ -1346,6 +1341,7 @@ MODULE_LICENSE ("GPL");
>         !IS_ENABLED(CONFIG_USB_EHCI_HCD_PLATFORM) && \
>         !IS_ENABLED(CONFIG_USB_CHIPIDEA_HOST) && \
>         !IS_ENABLED(CONFIG_USB_EHCI_MXC) && \
> +       !IS_ENABLED(CONFIG_PLAT_SPEAR) && \
>         !defined(PLATFORM_DRIVER) && \
>         !defined(PS3_SYSTEM_BUS_DRIVER) && \
>         !defined(OF_PLATFORM_DRIVER) && \
> diff --git a/drivers/usb/host/ehci-spear.c b/drivers/usb/host/ehci-spear.c
> index 466c1bb..74ec5a1 100644
> --- a/drivers/usb/host/ehci-spear.c
> +++ b/drivers/usb/host/ehci-spear.c
> @@ -1,5 +1,5 @@
>  /*
> -* Driver for EHCI HCD on SPEAR SOC
> +* Driver for EHCI HCD on SPEAr SOC
>  *
>  * Copyright (C) 2010 ST Micro Electronics,
>  * Deepak Sikri <deepak.sikri@st.com>
> @@ -12,71 +12,26 @@
>  */
>
>  #include <linux/clk.h>
> +#include <linux/dma-mapping.h>
> +#include <linux/io.h>
>  #include <linux/jiffies.h>
> +#include <linux/kernel.h>
> +#include <linux/module.h>
>  #include <linux/of.h>
>  #include <linux/platform_device.h>
>  #include <linux/pm.h>
> +#include <linux/usb.h>
> +#include <linux/usb/hcd.h>
>
> -struct spear_ehci {
> -       struct ehci_hcd ehci;
> -       struct clk *clk;
> -};
> +#include "ehci.h"
>
> -#define to_spear_ehci(hcd)     (struct spear_ehci *)hcd_to_ehci(hcd)
> +#define DRIVER_DESC "EHCI SPEAr driver"
>
> -static void spear_start_ehci(struct spear_ehci *ehci)
> -{
> -       clk_prepare_enable(ehci->clk);
> -}
> +static const char hcd_name[] = "SPEAr-ehci";
>
> -static void spear_stop_ehci(struct spear_ehci *ehci)
> -{
> -       clk_disable_unprepare(ehci->clk);
> -}
> +struct clk *usbh_clk;
>
> -static int ehci_spear_setup(struct usb_hcd *hcd)
> -{
> -       struct ehci_hcd *ehci = hcd_to_ehci(hcd);
> -
> -       /* registers start at offset 0x0 */
> -       ehci->caps = hcd->regs;
> -
> -       return ehci_setup(hcd);
> -}
> -
> -static const struct hc_driver ehci_spear_hc_driver = {
> -       .description                    = hcd_name,
> -       .product_desc                   = "SPEAr EHCI",
> -       .hcd_priv_size                  = sizeof(struct spear_ehci),
> -
> -       /* generic hardware linkage */
> -       .irq                            = ehci_irq,
> -       .flags                          = HCD_MEMORY | HCD_USB2,
> -
> -       /* basic lifecycle operations */
> -       .reset                          = ehci_spear_setup,
> -       .start                          = ehci_run,
> -       .stop                           = ehci_stop,
> -       .shutdown                       = ehci_shutdown,
> -
> -       /* managing i/o requests and associated device resources */
> -       .urb_enqueue                    = ehci_urb_enqueue,
> -       .urb_dequeue                    = ehci_urb_dequeue,
> -       .endpoint_disable               = ehci_endpoint_disable,
> -       .endpoint_reset                 = ehci_endpoint_reset,
> -
> -       /* scheduling support */
> -       .get_frame_number               = ehci_get_frame,
> -
> -       /* root hub support */
> -       .hub_status_data                = ehci_hub_status_data,
> -       .hub_control                    = ehci_hub_control,
> -       .bus_suspend                    = ehci_bus_suspend,
> -       .bus_resume                     = ehci_bus_resume,
> -       .relinquish_port                = ehci_relinquish_port,
> -       .port_handed_over               = ehci_port_handed_over,
> -       .clear_tt_buffer_complete       = ehci_clear_tt_buffer_complete,
> -};
> +static struct hc_driver __read_mostly ehci_spear_hc_driver;
>
>  #ifdef CONFIG_PM
>  static int ehci_spear_drv_suspend(struct device *dev)
> @@ -104,9 +59,7 @@ static u64 spear_ehci_dma_mask = DMA_BIT_MASK(32);
>  static int spear_ehci_hcd_drv_probe(struct platform_device *pdev)
>  {
>         struct usb_hcd *hcd ;
> -       struct spear_ehci *ehci;
>         struct resource *res;
> -       struct clk *usbh_clk;
>         const struct hc_driver *driver = &ehci_spear_hc_driver;
>         int irq, retval;
>
> @@ -161,10 +114,8 @@ static int spear_ehci_hcd_drv_probe(struct
> platform_device *pdev)
>                 goto err_put_hcd;
>         }
>
> -       ehci = (struct spear_ehci *)hcd_to_ehci(hcd);
> -       ehci->clk = usbh_clk;
> +       clk_prepare_enable(usbh_clk);
>
> -       spear_start_ehci(ehci);
>         retval = usb_add_hcd(hcd, irq, IRQF_SHARED);
>         if (retval)
>                 goto err_stop_ehci;
> @@ -172,7 +123,7 @@ static int spear_ehci_hcd_drv_probe(struct
> platform_device *pdev)
>         return retval;
>
>  err_stop_ehci:
> -       spear_stop_ehci(ehci);
> +       clk_disable_unprepare(usbh_clk);
>  err_put_hcd:
>         usb_put_hcd(hcd);
>  fail:
> @@ -184,7 +135,6 @@ fail:
>  static int spear_ehci_hcd_drv_remove(struct platform_device *pdev)
>  {
>         struct usb_hcd *hcd = platform_get_drvdata(pdev);
> -       struct spear_ehci *ehci_p = to_spear_ehci(hcd);
>
>         if (!hcd)
>                 return 0;
> @@ -192,8 +142,9 @@ static int spear_ehci_hcd_drv_remove(struct
> platform_device *pdev)
>                 BUG();
>         usb_remove_hcd(hcd);
>
> -       if (ehci_p->clk)
> -               spear_stop_ehci(ehci_p);
> +       if (usbh_clk)
> +               clk_disable_unprepare(usbh_clk);
> +
>         usb_put_hcd(hcd);
>
>         return 0;
> @@ -216,4 +167,25 @@ static struct platform_driver spear_ehci_hcd_driver =
> {
>         }
>  };
>
> +static int __init ehci_spear_init(void)
> +{
> +       if (usb_disabled())
> +               return -ENODEV;
> +
> +       pr_info("%s: " DRIVER_DESC "\n", hcd_name);
> +
> +       ehci_init_driver(&ehci_spear_hc_driver, NULL);
> +       return platform_driver_register(&spear_ehci_hcd_driver);
> +}
> +module_init(ehci_spear_init);
> +
> +static void __exit ehci_spear_cleanup(void)
> +{
> +       platform_driver_unregister(&spear_ehci_hcd_driver);
> +}
> +module_exit(ehci_spear_cleanup);
> +
> +MODULE_DESCRIPTION(DRIVER_DESC);
>  MODULE_ALIAS("platform:spear-ehci");
> +MODULE_AUTHOR("Deepak Sikri");
> +MODULE_LICENSE("GPL");
> --
> 1.7.9.5
>
>

Hi Arnd,

Can you review and let me know if any modification is required above patch.

Thanks
Manjunath Goudar
diff mbox

Patch

diff --git a/drivers/usb/host/Kconfig b/drivers/usb/host/Kconfig
index c59a112..cd4fdac 100644
--- a/drivers/usb/host/Kconfig
+++ b/drivers/usb/host/Kconfig
@@ -162,6 +162,14 @@  config USB_EHCI_HCD_OMAP
 	  Enables support for the on-chip EHCI controller on
 	  OMAP3 and later chips.
 
+config USB_EHCI_HCD_SPEAR
+        tristate "Support for ST SPEAr on-chip EHCI USB controller"
+        depends on USB_EHCI_HCD && PLAT_SPEAR
+        default y
+        ---help---
+          Enables support for the on-chip EHCI controller on
+          ST SPEAr chips.
+
 config USB_EHCI_MSM
 	bool "Support for MSM on-chip EHCI USB controller"
 	depends on USB_EHCI_HCD && ARCH_MSM
diff --git a/drivers/usb/host/Makefile b/drivers/usb/host/Makefile
index 001fbff..8da680d 100644
--- a/drivers/usb/host/Makefile
+++ b/drivers/usb/host/Makefile
@@ -27,6 +27,7 @@  obj-$(CONFIG_USB_EHCI_HCD)	+= ehci-hcd.o
 obj-$(CONFIG_USB_EHCI_PCI)	+= ehci-pci.o
 obj-$(CONFIG_USB_EHCI_HCD_PLATFORM)	+= ehci-platform.o
 obj-$(CONFIG_USB_EHCI_MXC)	+= ehci-mxc.o
+obj-$(CONFIG_USB_EHCI_HCD_SPEAR)	+= ehci-spear.o
 
 obj-$(CONFIG_USB_OXU210HP_HCD)	+= oxu210hp-hcd.o
 obj-$(CONFIG_USB_ISP116X_HCD)	+= isp116x-hcd.o
diff --git a/drivers/usb/host/ehci-hcd.c b/drivers/usb/host/ehci-hcd.c
index b416a3f..c4afd86 100644
--- a/drivers/usb/host/ehci-hcd.c
+++ b/drivers/usb/host/ehci-hcd.c
@@ -1297,11 +1297,6 @@  MODULE_LICENSE ("GPL");
 #define	PLATFORM_DRIVER		vt8500_ehci_driver
 #endif
 
-#ifdef CONFIG_PLAT_SPEAR
-#include "ehci-spear.c"
-#define PLATFORM_DRIVER		spear_ehci_hcd_driver
-#endif
-
 #ifdef CONFIG_USB_EHCI_MSM
 #include "ehci-msm.c"
 #define PLATFORM_DRIVER		ehci_msm_driver
@@ -1346,6 +1341,7 @@  MODULE_LICENSE ("GPL");
 	!IS_ENABLED(CONFIG_USB_EHCI_HCD_PLATFORM) && \
 	!IS_ENABLED(CONFIG_USB_CHIPIDEA_HOST) && \
 	!IS_ENABLED(CONFIG_USB_EHCI_MXC) && \
+	!IS_ENABLED(CONFIG_PLAT_SPEAR) && \
 	!defined(PLATFORM_DRIVER) && \
 	!defined(PS3_SYSTEM_BUS_DRIVER) && \
 	!defined(OF_PLATFORM_DRIVER) && \
diff --git a/drivers/usb/host/ehci-spear.c b/drivers/usb/host/ehci-spear.c
index 466c1bb..74ec5a1 100644
--- a/drivers/usb/host/ehci-spear.c
+++ b/drivers/usb/host/ehci-spear.c
@@ -1,5 +1,5 @@ 
 /*
-* Driver for EHCI HCD on SPEAR SOC
+* Driver for EHCI HCD on SPEAr SOC
 *
 * Copyright (C) 2010 ST Micro Electronics,
 * Deepak Sikri <deepak.sikri@st.com>
@@ -12,71 +12,26 @@ 
 */
 
 #include <linux/clk.h>
+#include <linux/dma-mapping.h>
+#include <linux/io.h>
 #include <linux/jiffies.h>
+#include <linux/kernel.h>
+#include <linux/module.h>
 #include <linux/of.h>
 #include <linux/platform_device.h>
 #include <linux/pm.h>
+#include <linux/usb.h>
+#include <linux/usb/hcd.h>
 
-struct spear_ehci {
-	struct ehci_hcd ehci;
-	struct clk *clk;
-};
+#include "ehci.h"
 
-#define to_spear_ehci(hcd)	(struct spear_ehci *)hcd_to_ehci(hcd)
+#define DRIVER_DESC "EHCI SPEAr driver"
 
-static void spear_start_ehci(struct spear_ehci *ehci)
-{
-	clk_prepare_enable(ehci->clk);
-}
+static const char hcd_name[] = "SPEAr-ehci";
 
-static void spear_stop_ehci(struct spear_ehci *ehci)
-{
-	clk_disable_unprepare(ehci->clk);
-}
+struct clk *usbh_clk;
 
-static int ehci_spear_setup(struct usb_hcd *hcd)
-{
-	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
-
-	/* registers start at offset 0x0 */
-	ehci->caps = hcd->regs;
-
-	return ehci_setup(hcd);
-}
-
-static const struct hc_driver ehci_spear_hc_driver = {
-	.description			= hcd_name,
-	.product_desc			= "SPEAr EHCI",
-	.hcd_priv_size			= sizeof(struct spear_ehci),
-
-	/* generic hardware linkage */
-	.irq				= ehci_irq,
-	.flags				= HCD_MEMORY | HCD_USB2,
-
-	/* basic lifecycle operations */
-	.reset				= ehci_spear_setup,
-	.start				= ehci_run,
-	.stop				= ehci_stop,
-	.shutdown			= ehci_shutdown,
-
-	/* managing i/o requests and associated device resources */
-	.urb_enqueue			= ehci_urb_enqueue,
-	.urb_dequeue			= ehci_urb_dequeue,
-	.endpoint_disable		= ehci_endpoint_disable,
-	.endpoint_reset			= ehci_endpoint_reset,
-
-	/* scheduling support */
-	.get_frame_number		= ehci_get_frame,
-
-	/* root hub support */
-	.hub_status_data		= ehci_hub_status_data,
-	.hub_control			= ehci_hub_control,
-	.bus_suspend			= ehci_bus_suspend,
-	.bus_resume			= ehci_bus_resume,
-	.relinquish_port		= ehci_relinquish_port,
-	.port_handed_over		= ehci_port_handed_over,
-	.clear_tt_buffer_complete	= ehci_clear_tt_buffer_complete,
-};
+static struct hc_driver __read_mostly ehci_spear_hc_driver;
 
 #ifdef CONFIG_PM
 static int ehci_spear_drv_suspend(struct device *dev)
@@ -104,9 +59,7 @@  static u64 spear_ehci_dma_mask = DMA_BIT_MASK(32);
 static int spear_ehci_hcd_drv_probe(struct platform_device *pdev)
 {
 	struct usb_hcd *hcd ;
-	struct spear_ehci *ehci;
 	struct resource *res;
-	struct clk *usbh_clk;
 	const struct hc_driver *driver = &ehci_spear_hc_driver;
 	int irq, retval;
 
@@ -161,10 +114,8 @@  static int spear_ehci_hcd_drv_probe(struct platform_device *pdev)
 		goto err_put_hcd;
 	}
 
-	ehci = (struct spear_ehci *)hcd_to_ehci(hcd);
-	ehci->clk = usbh_clk;
+	clk_prepare_enable(usbh_clk);
 
-	spear_start_ehci(ehci);
 	retval = usb_add_hcd(hcd, irq, IRQF_SHARED);
 	if (retval)
 		goto err_stop_ehci;
@@ -172,7 +123,7 @@  static int spear_ehci_hcd_drv_probe(struct platform_device *pdev)
 	return retval;
 
 err_stop_ehci:
-	spear_stop_ehci(ehci);
+	clk_disable_unprepare(usbh_clk);
 err_put_hcd:
 	usb_put_hcd(hcd);
 fail:
@@ -184,7 +135,6 @@  fail:
 static int spear_ehci_hcd_drv_remove(struct platform_device *pdev)
 {
 	struct usb_hcd *hcd = platform_get_drvdata(pdev);
-	struct spear_ehci *ehci_p = to_spear_ehci(hcd);
 
 	if (!hcd)
 		return 0;
@@ -192,8 +142,9 @@  static int spear_ehci_hcd_drv_remove(struct platform_device *pdev)
 		BUG();
 	usb_remove_hcd(hcd);
 
-	if (ehci_p->clk)
-		spear_stop_ehci(ehci_p);
+	if (usbh_clk)
+		clk_disable_unprepare(usbh_clk);
+
 	usb_put_hcd(hcd);
 
 	return 0;
@@ -216,4 +167,25 @@  static struct platform_driver spear_ehci_hcd_driver = {
 	}
 };
 
+static int __init ehci_spear_init(void)
+{
+	if (usb_disabled())
+		return -ENODEV;
+
+	pr_info("%s: " DRIVER_DESC "\n", hcd_name);
+
+	ehci_init_driver(&ehci_spear_hc_driver, NULL);
+	return platform_driver_register(&spear_ehci_hcd_driver);
+}
+module_init(ehci_spear_init);
+
+static void __exit ehci_spear_cleanup(void)
+{
+	platform_driver_unregister(&spear_ehci_hcd_driver);
+}
+module_exit(ehci_spear_cleanup);
+
+MODULE_DESCRIPTION(DRIVER_DESC);
 MODULE_ALIAS("platform:spear-ehci");
+MODULE_AUTHOR("Deepak Sikri");
+MODULE_LICENSE("GPL");