[deliverable/linux.git] / drivers / usb / host / ehci-mxc.c

/*
 * Copyright (c) 2008 Sascha Hauer <s.hauer@pengutronix.de>, Pengutronix
 * Copyright (c) 2009 Daniel Mack <daniel@caiaq.de>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#include <linux/platform_device.h>
#include <linux/clk.h>
#include <linux/delay.h>
#include <linux/usb/otg.h>
#include <linux/usb/ulpi.h>
#include <linux/slab.h>

#include <mach/hardware.h>
#include <linux/platform_data/usb-ehci-mxc.h>

#include <asm/mach-types.h>

#define ULPI_VIEWPORT_OFFSET	0x170

struct ehci_mxc_priv {
	struct clk *usbclk, *ahbclk, *phyclk;
	struct usb_hcd *hcd;
};

/* called during probe() after chip reset completes */
static int ehci_mxc_setup(struct usb_hcd *hcd)
{
	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
	int retval;

	hcd->has_tt = 1;

	retval = ehci_setup(hcd);
	if (retval)
		return retval;

	ehci_port_power(ehci, 0);
	return 0;
}

static const struct hc_driver ehci_mxc_hc_driver = {
	.description = hcd_name,
	.product_desc = "Freescale On-Chip EHCI Host Controller",
	.hcd_priv_size = sizeof(struct ehci_hcd),

	/*
	 * generic hardware linkage
	 */
	.irq = ehci_irq,
	.flags = HCD_USB2 | HCD_MEMORY,

	/*
	 * basic lifecycle operations
	 */
	.reset = ehci_mxc_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 int ehci_mxc_drv_probe(struct platform_device *pdev)
{
	struct mxc_usbh_platform_data *pdata = pdev->dev.platform_data;
	struct usb_hcd *hcd;
	struct resource *res;
	int irq, ret;
	unsigned int flags;
	struct ehci_mxc_priv *priv;
	struct device *dev = &pdev->dev;
	struct ehci_hcd *ehci;

	dev_info(&pdev->dev, "initializing i.MX USB Controller\n");

	if (!pdata) {
		dev_err(dev, "No platform data given, bailing out.\n");
		return -EINVAL;
	}

	irq = platform_get_irq(pdev, 0);

	hcd = usb_create_hcd(&ehci_mxc_hc_driver, dev, dev_name(dev));
	if (!hcd)
		return -ENOMEM;

	priv = kzalloc(sizeof(*priv), GFP_KERNEL);
	if (!priv) {
		ret = -ENOMEM;
		goto err_alloc;
	}

	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	if (!res) {
		dev_err(dev, "Found HC with no register addr. Check setup!\n");
		ret = -ENODEV;
		goto err_get_resource;
	}

	hcd->rsrc_start = res->start;
	hcd->rsrc_len = resource_size(res);

	if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
		dev_dbg(dev, "controller already in use\n");
		ret = -EBUSY;
		goto err_request_mem;
	}

	hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
	if (!hcd->regs) {
		dev_err(dev, "error mapping memory\n");
		ret = -EFAULT;
		goto err_ioremap;
	}

	/* enable clocks */
	priv->usbclk = clk_get(dev, "ipg");
	if (IS_ERR(priv->usbclk)) {
		ret = PTR_ERR(priv->usbclk);
		goto err_clk;
	}
	clk_prepare_enable(priv->usbclk);

	priv->ahbclk = clk_get(dev, "ahb");
	if (IS_ERR(priv->ahbclk)) {
		ret = PTR_ERR(priv->ahbclk);
		goto err_clk_ahb;
	}
	clk_prepare_enable(priv->ahbclk);

	/* "dr" device has its own clock on i.MX51 */
	priv->phyclk = clk_get(dev, "phy");
	if (IS_ERR(priv->phyclk))
		priv->phyclk = NULL;
	if (priv->phyclk)
		clk_prepare_enable(priv->phyclk);


	/* call platform specific init function */
	if (pdata->init) {
		ret = pdata->init(pdev);
		if (ret) {
			dev_err(dev, "platform init failed\n");
			goto err_init;
		}
		/* platforms need some time to settle changed IO settings */
		mdelay(10);
	}

	ehci = hcd_to_ehci(hcd);

	/* EHCI registers start at offset 0x100 */
	ehci->caps = hcd->regs + 0x100;
	ehci->regs = hcd->regs + 0x100 +
		HC_LENGTH(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));

	/* set up the PORTSCx register */
	ehci_writel(ehci, pdata->portsc, &ehci->regs->port_status[0]);

	/* is this really needed? */
	msleep(10);

	/* Initialize the transceiver */
	if (pdata->otg) {
		pdata->otg->io_priv = hcd->regs + ULPI_VIEWPORT_OFFSET;
		ret = usb_phy_init(pdata->otg);
		if (ret) {
			dev_err(dev, "unable to init transceiver, probably missing\n");
			ret = -ENODEV;
			goto err_add;
		}
		ret = otg_set_vbus(pdata->otg->otg, 1);
		if (ret) {
			dev_err(dev, "unable to enable vbus on transceiver\n");
			goto err_add;
		}
	}

	priv->hcd = hcd;
	platform_set_drvdata(pdev, priv);

	ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
	if (ret)
		goto err_add;

	if (pdata->otg) {
		/*
		 * efikamx and efikasb have some hardware bug which is
		 * preventing usb to work unless CHRGVBUS is set.
		 * It's in violation of USB specs
		 */
		if (machine_is_mx51_efikamx() || machine_is_mx51_efikasb()) {
			flags = usb_phy_io_read(pdata->otg,
							ULPI_OTG_CTRL);
			flags |= ULPI_OTG_CTRL_CHRGVBUS;
			ret = usb_phy_io_write(pdata->otg, flags,
							ULPI_OTG_CTRL);
			if (ret) {
				dev_err(dev, "unable to set CHRVBUS\n");
				goto err_add;
			}
		}
	}

	return 0;

err_add:
	if (pdata && pdata->exit)
		pdata->exit(pdev);
err_init:
	if (priv->phyclk) {
		clk_disable_unprepare(priv->phyclk);
		clk_put(priv->phyclk);
	}

	clk_disable_unprepare(priv->ahbclk);
	clk_put(priv->ahbclk);
err_clk_ahb:
	clk_disable_unprepare(priv->usbclk);
	clk_put(priv->usbclk);
err_clk:
	iounmap(hcd->regs);
err_ioremap:
	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
err_request_mem:
err_get_resource:
	kfree(priv);
err_alloc:
	usb_put_hcd(hcd);
	return ret;
}

static int __exit ehci_mxc_drv_remove(struct platform_device *pdev)
{
	struct mxc_usbh_platform_data *pdata = pdev->dev.platform_data;
	struct ehci_mxc_priv *priv = platform_get_drvdata(pdev);
	struct usb_hcd *hcd = priv->hcd;

	if (pdata && pdata->exit)
		pdata->exit(pdev);

	if (pdata->otg)
		usb_phy_shutdown(pdata->otg);

	usb_remove_hcd(hcd);
	iounmap(hcd->regs);
	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
	usb_put_hcd(hcd);
	platform_set_drvdata(pdev, NULL);

	clk_disable_unprepare(priv->usbclk);
	clk_put(priv->usbclk);
	clk_disable_unprepare(priv->ahbclk);
	clk_put(priv->ahbclk);

	if (priv->phyclk) {
		clk_disable_unprepare(priv->phyclk);
		clk_put(priv->phyclk);
	}

	kfree(priv);

	return 0;
}

static void ehci_mxc_drv_shutdown(struct platform_device *pdev)
{
	struct ehci_mxc_priv *priv = platform_get_drvdata(pdev);
	struct usb_hcd *hcd = priv->hcd;

	if (hcd->driver->shutdown)
		hcd->driver->shutdown(hcd);
}

MODULE_ALIAS("platform:mxc-ehci");

static struct platform_driver ehci_mxc_driver = {
	.probe = ehci_mxc_drv_probe,
	.remove = __exit_p(ehci_mxc_drv_remove),
	.shutdown = ehci_mxc_drv_shutdown,
	.driver = {
		   .name = "mxc-ehci",
	},
};
Commit	Line	Data
7e8d5cd9 DM	1	/*
	2	* Copyright (c) 2008 Sascha Hauer <s.hauer@pengutronix.de>, Pengutronix
	3	* Copyright (c) 2009 Daniel Mack <daniel@caiaq.de>
	4	*
	5	* This program is free software; you can redistribute it and/or modify it
	6	* under the terms of the GNU General Public License as published by the
	7	* Free Software Foundation; either version 2 of the License, or (at your
	8	* option) any later version.
	9	*
	10	* This program is distributed in the hope that it will be useful, but
	11	* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
	12	* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
	13	* for more details.
	14	*
	15	* You should have received a copy of the GNU General Public License
	16	* along with this program; if not, write to the Free Software Foundation,
	17	* Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	18	*/
	19
	20	#include <linux/platform_device.h>
	21	#include <linux/clk.h>
	22	#include <linux/delay.h>
	23	#include <linux/usb/otg.h>
a464dc4d	24	#include <linux/usb/ulpi.h>
5a0e3ad6	25	#include <linux/slab.h>
7e8d5cd9	26
03a1d6bf	27	#include <mach/hardware.h>
82906b13	28	#include <linux/platform_data/usb-ehci-mxc.h>
7e8d5cd9	29
a464dc4d APR	30	#include <asm/mach-types.h>
a464dc4d APR	31
7e8d5cd9	32	#define ULPI_VIEWPORT_OFFSET 0x170
7e8d5cd9 DM	33
7e8d5cd9 DM	34	struct ehci_mxc_priv {
c943740c	35	struct clk usbclk, ahbclk, *phyclk;
7e8d5cd9 DM	36	struct usb_hcd *hcd;
	37	};
	38
	39	/* called during probe() after chip reset completes */
	40	static int ehci_mxc_setup(struct usb_hcd *hcd)
	41	{
	42	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
	43	int retval;
	44
65fd4272 MC	45	hcd->has_tt = 1;
65fd4272 MC	46
1a49e2ac	47	retval = ehci_setup(hcd);
7e8d5cd9 DM	48	if (retval)
	49	return retval;
	50
7e8d5cd9 DM	51	ehci_port_power(ehci, 0);
	52	return 0;
	53	}
	54
	55	static const struct hc_driver ehci_mxc_hc_driver = {
	56	.description = hcd_name,
	57	.product_desc = "Freescale On-Chip EHCI Host Controller",
	58	.hcd_priv_size = sizeof(struct ehci_hcd),
	59
	60	/*
	61	* generic hardware linkage
	62	*/
	63	.irq = ehci_irq,
	64	.flags = HCD_USB2 \| HCD_MEMORY,
	65
	66	/*
	67	* basic lifecycle operations
	68	*/
	69	.reset = ehci_mxc_setup,
	70	.start = ehci_run,
	71	.stop = ehci_stop,
	72	.shutdown = ehci_shutdown,
	73
	74	/*
	75	* managing i/o requests and associated device resources
	76	*/
	77	.urb_enqueue = ehci_urb_enqueue,
	78	.urb_dequeue = ehci_urb_dequeue,
	79	.endpoint_disable = ehci_endpoint_disable,
b48d7f50	80	.endpoint_reset = ehci_endpoint_reset,
7e8d5cd9 DM	81
	82	/*
	83	* scheduling support
	84	*/
	85	.get_frame_number = ehci_get_frame,
	86
	87	/*
	88	* root hub support
	89	*/
	90	.hub_status_data = ehci_hub_status_data,
	91	.hub_control = ehci_hub_control,
	92	.bus_suspend = ehci_bus_suspend,
	93	.bus_resume = ehci_bus_resume,
	94	.relinquish_port = ehci_relinquish_port,
	95	.port_handed_over = ehci_port_handed_over,
b48d7f50 PM	96
b48d7f50 PM	97	.clear_tt_buffer_complete = ehci_clear_tt_buffer_complete,
7e8d5cd9 DM	98	};
	99
	100	static int ehci_mxc_drv_probe(struct platform_device *pdev)
	101	{
	102	struct mxc_usbh_platform_data *pdata = pdev->dev.platform_data;
	103	struct usb_hcd *hcd;
	104	struct resource *res;
724c8525	105	int irq, ret;
a464dc4d	106	unsigned int flags;
7e8d5cd9 DM	107	struct ehci_mxc_priv *priv;
7e8d5cd9 DM	108	struct device *dev = &pdev->dev;
0247a7bc	109	struct ehci_hcd *ehci;
7e8d5cd9 DM	110
	111	dev_info(&pdev->dev, "initializing i.MX USB Controller\n");
	112
	113	if (!pdata) {
	114	dev_err(dev, "No platform data given, bailing out.\n");
	115	return -EINVAL;
	116	}
	117
	118	irq = platform_get_irq(pdev, 0);
	119
	120	hcd = usb_create_hcd(&ehci_mxc_hc_driver, dev, dev_name(dev));
	121	if (!hcd)
	122	return -ENOMEM;
	123
	124	priv = kzalloc(sizeof(*priv), GFP_KERNEL);
	125	if (!priv) {
	126	ret = -ENOMEM;
	127	goto err_alloc;
	128	}
	129
	130	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	131	if (!res) {
	132	dev_err(dev, "Found HC with no register addr. Check setup!\n");
	133	ret = -ENODEV;
	134	goto err_get_resource;
	135	}
	136
	137	hcd->rsrc_start = res->start;
	138	hcd->rsrc_len = resource_size(res);
	139
	140	if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
	141	dev_dbg(dev, "controller already in use\n");
	142	ret = -EBUSY;
	143	goto err_request_mem;
	144	}
	145
	146	hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
	147	if (!hcd->regs) {
	148	dev_err(dev, "error mapping memory\n");
	149	ret = -EFAULT;
	150	goto err_ioremap;
	151	}
	152
	153	/* enable clocks */
c943740c	154	priv->usbclk = clk_get(dev, "ipg");
7e8d5cd9 DM	155	if (IS_ERR(priv->usbclk)) {
	156	ret = PTR_ERR(priv->usbclk);
	157	goto err_clk;
	158	}
198ad2ce	159	clk_prepare_enable(priv->usbclk);
7e8d5cd9	160
c943740c SH	161	priv->ahbclk = clk_get(dev, "ahb");
	162	if (IS_ERR(priv->ahbclk)) {
	163	ret = PTR_ERR(priv->ahbclk);
	164	goto err_clk_ahb;
7e8d5cd9	165	}
c943740c	166	clk_prepare_enable(priv->ahbclk);
7e8d5cd9	167
3bb8029a	168	/* "dr" device has its own clock on i.MX51 */
c943740c SH	169	priv->phyclk = clk_get(dev, "phy");
	170	if (IS_ERR(priv->phyclk))
	171	priv->phyclk = NULL;
	172	if (priv->phyclk)
	173	clk_prepare_enable(priv->phyclk);
711669e5 APR	174
	175
	176	/* call platform specific init function */
	177	if (pdata->init) {
	178	ret = pdata->init(pdev);
	179	if (ret) {
	180	dev_err(dev, "platform init failed\n");
	181	goto err_init;
	182	}
	183	/* platforms need some time to settle changed IO settings */
	184	mdelay(10);
	185	}
	186
0247a7bc FE	187	ehci = hcd_to_ehci(hcd);
	188
	189	/* EHCI registers start at offset 0x100 */
	190	ehci->caps = hcd->regs + 0x100;
	191	ehci->regs = hcd->regs + 0x100 +
c430131a	192	HC_LENGTH(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
0247a7bc FE	193
	194	/* set up the PORTSCx register */
	195	ehci_writel(ehci, pdata->portsc, &ehci->regs->port_status[0]);
	196
	197	/* is this really needed? */
	198	msleep(10);
	199
7e8d5cd9 DM	200	/* Initialize the transceiver */
	201	if (pdata->otg) {
	202	pdata->otg->io_priv = hcd->regs + ULPI_VIEWPORT_OFFSET;
b96d3b08	203	ret = usb_phy_init(pdata->otg);
4c9715de WS	204	if (ret) {
	205	dev_err(dev, "unable to init transceiver, probably missing\n");
	206	ret = -ENODEV;
	207	goto err_add;
	208	}
6e13c650	209	ret = otg_set_vbus(pdata->otg->otg, 1);
4c9715de	210	if (ret) {
7e8d5cd9	211	dev_err(dev, "unable to enable vbus on transceiver\n");
4c9715de WS	212	goto err_add;
4c9715de WS	213	}
7e8d5cd9 DM	214	}
	215
	216	priv->hcd = hcd;
	217	platform_set_drvdata(pdev, priv);
	218
b5dd18d8	219	ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
7e8d5cd9 DM	220	if (ret)
	221	goto err_add;
	222
a464dc4d APR	223	if (pdata->otg) {
	224	/*
	225	* efikamx and efikasb have some hardware bug which is
	226	* preventing usb to work unless CHRGVBUS is set.
	227	* It's in violation of USB specs
	228	*/
	229	if (machine_is_mx51_efikamx() \|\| machine_is_mx51_efikasb()) {
b96d3b08 HK	230	flags = usb_phy_io_read(pdata->otg,
b96d3b08 HK	231	ULPI_OTG_CTRL);
a464dc4d	232	flags \|= ULPI_OTG_CTRL_CHRGVBUS;
b96d3b08 HK	233	ret = usb_phy_io_write(pdata->otg, flags,
b96d3b08 HK	234	ULPI_OTG_CTRL);
a464dc4d APR	235	if (ret) {
	236	dev_err(dev, "unable to set CHRVBUS\n");
	237	goto err_add;
	238	}
	239	}
	240	}
	241
7e8d5cd9 DM	242	return 0;
	243
	244	err_add:
	245	if (pdata && pdata->exit)
	246	pdata->exit(pdev);
	247	err_init:
c943740c SH	248	if (priv->phyclk) {
	249	clk_disable_unprepare(priv->phyclk);
	250	clk_put(priv->phyclk);
7e8d5cd9	251	}
c943740c SH	252
	253	clk_disable_unprepare(priv->ahbclk);
	254	clk_put(priv->ahbclk);
7e8d5cd9	255	err_clk_ahb:
198ad2ce	256	clk_disable_unprepare(priv->usbclk);
7e8d5cd9 DM	257	clk_put(priv->usbclk);
	258	err_clk:
	259	iounmap(hcd->regs);
	260	err_ioremap:
	261	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
	262	err_request_mem:
	263	err_get_resource:
	264	kfree(priv);
	265	err_alloc:
	266	usb_put_hcd(hcd);
	267	return ret;
	268	}
	269
	270	static int __exit ehci_mxc_drv_remove(struct platform_device *pdev)
	271	{
	272	struct mxc_usbh_platform_data *pdata = pdev->dev.platform_data;
	273	struct ehci_mxc_priv *priv = platform_get_drvdata(pdev);
	274	struct usb_hcd *hcd = priv->hcd;
	275
	276	if (pdata && pdata->exit)
	277	pdata->exit(pdev);
	278
	279	if (pdata->otg)
b96d3b08	280	usb_phy_shutdown(pdata->otg);
7e8d5cd9 DM	281
	282	usb_remove_hcd(hcd);
	283	iounmap(hcd->regs);
	284	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
	285	usb_put_hcd(hcd);
	286	platform_set_drvdata(pdev, NULL);
	287
198ad2ce	288	clk_disable_unprepare(priv->usbclk);
7e8d5cd9	289	clk_put(priv->usbclk);
c943740c SH	290	clk_disable_unprepare(priv->ahbclk);
	291	clk_put(priv->ahbclk);
	292
	293	if (priv->phyclk) {
	294	clk_disable_unprepare(priv->phyclk);
	295	clk_put(priv->phyclk);
711669e5	296	}
7e8d5cd9 DM	297
	298	kfree(priv);
	299
	300	return 0;
	301	}
	302
	303	static void ehci_mxc_drv_shutdown(struct platform_device *pdev)
	304	{
	305	struct ehci_mxc_priv *priv = platform_get_drvdata(pdev);
	306	struct usb_hcd *hcd = priv->hcd;
	307
	308	if (hcd->driver->shutdown)
	309	hcd->driver->shutdown(hcd);
	310	}
	311
	312	MODULE_ALIAS("platform:mxc-ehci");
	313
	314	static struct platform_driver ehci_mxc_driver = {
	315	.probe = ehci_mxc_drv_probe,
	316	.remove = __exit_p(ehci_mxc_drv_remove),
	317	.shutdown = ehci_mxc_drv_shutdown,
	318	.driver = {
	319	.name = "mxc-ehci",
	320	},
	321	};