[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/mxc_ehci.h>

#include <asm/mach-types.h>

#define ULPI_VIEWPORT_OFFSET	0x170

struct ehci_mxc_priv {
	struct clk *usbclk, *ahbclk, *phy1clk;
	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;

	dbg_hcs_params(ehci, "reset");
	dbg_hcc_params(ehci, "reset");

	/* cache this readonly data; minimize chip reads */
	ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);

	hcd->has_tt = 1;

	retval = ehci_halt(ehci);
	if (retval)
		return retval;

	/* data structure init */
	retval = ehci_init(hcd);
	if (retval)
		return retval;

	ehci->sbrn = 0x20;

	ehci_reset(ehci);

	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, "usb");
	if (IS_ERR(priv->usbclk)) {
		ret = PTR_ERR(priv->usbclk);
		goto err_clk;
	}
	clk_enable(priv->usbclk);

	if (!cpu_is_mx35() && !cpu_is_mx25()) {
		priv->ahbclk = clk_get(dev, "usb_ahb");
		if (IS_ERR(priv->ahbclk)) {
			ret = PTR_ERR(priv->ahbclk);
			goto err_clk_ahb;
		}
		clk_enable(priv->ahbclk);
	}

	/* "dr" device has its own clock on i.MX51 */
	if (cpu_is_mx51() && (pdev->id == 0)) {
		priv->phy1clk = clk_get(dev, "usb_phy1");
		if (IS_ERR(priv->phy1clk)) {
			ret = PTR_ERR(priv->phy1clk);
			goto err_clk_phy;
		}
		clk_enable(priv->phy1clk);
	}


	/* 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 = otg_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, 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_DISABLED | 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 = otg_io_read(pdata->otg, ULPI_OTG_CTRL);
			flags |= ULPI_OTG_CTRL_CHRGVBUS;
			ret = otg_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->phy1clk) {
		clk_disable(priv->phy1clk);
		clk_put(priv->phy1clk);
	}
err_clk_phy:
	if (priv->ahbclk) {
		clk_disable(priv->ahbclk);
		clk_put(priv->ahbclk);
	}
err_clk_ahb:
	clk_disable(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)
		otg_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(priv->usbclk);
	clk_put(priv->usbclk);
	if (priv->ahbclk) {
		clk_disable(priv->ahbclk);
		clk_put(priv->ahbclk);
	}
	if (priv->phy1clk) {
		clk_disable(priv->phy1clk);
		clk_put(priv->phy1clk);
	}

	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 DM	26
	27	#include <mach/mxc_ehci.h>
	28
a464dc4d APR	29	#include <asm/mach-types.h>
a464dc4d APR	30
7e8d5cd9	31	#define ULPI_VIEWPORT_OFFSET 0x170
7e8d5cd9 DM	32
7e8d5cd9 DM	33	struct ehci_mxc_priv {
711669e5	34	struct clk usbclk, ahbclk, *phy1clk;
7e8d5cd9 DM	35	struct usb_hcd *hcd;
	36	};
	37
	38	/* called during probe() after chip reset completes */
	39	static int ehci_mxc_setup(struct usb_hcd *hcd)
	40	{
	41	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
	42	int retval;
	43
7e8d5cd9 DM	44	dbg_hcs_params(ehci, "reset");
	45	dbg_hcc_params(ehci, "reset");
	46
	47	/* cache this readonly data; minimize chip reads */
	48	ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
	49
65fd4272 MC	50	hcd->has_tt = 1;
65fd4272 MC	51
7e8d5cd9 DM	52	retval = ehci_halt(ehci);
	53	if (retval)
	54	return retval;
	55
	56	/* data structure init */
	57	retval = ehci_init(hcd);
	58	if (retval)
	59	return retval;
	60
7e8d5cd9 DM	61	ehci->sbrn = 0x20;
	62
	63	ehci_reset(ehci);
	64
	65	ehci_port_power(ehci, 0);
	66	return 0;
	67	}
	68
	69	static const struct hc_driver ehci_mxc_hc_driver = {
	70	.description = hcd_name,
	71	.product_desc = "Freescale On-Chip EHCI Host Controller",
	72	.hcd_priv_size = sizeof(struct ehci_hcd),
	73
	74	/*
	75	* generic hardware linkage
	76	*/
	77	.irq = ehci_irq,
	78	.flags = HCD_USB2 \| HCD_MEMORY,
	79
	80	/*
	81	* basic lifecycle operations
	82	*/
	83	.reset = ehci_mxc_setup,
	84	.start = ehci_run,
	85	.stop = ehci_stop,
	86	.shutdown = ehci_shutdown,
	87
	88	/*
	89	* managing i/o requests and associated device resources
	90	*/
	91	.urb_enqueue = ehci_urb_enqueue,
	92	.urb_dequeue = ehci_urb_dequeue,
	93	.endpoint_disable = ehci_endpoint_disable,
b48d7f50	94	.endpoint_reset = ehci_endpoint_reset,
7e8d5cd9 DM	95
	96	/*
	97	* scheduling support
	98	*/
	99	.get_frame_number = ehci_get_frame,
	100
	101	/*
	102	* root hub support
	103	*/
	104	.hub_status_data = ehci_hub_status_data,
	105	.hub_control = ehci_hub_control,
	106	.bus_suspend = ehci_bus_suspend,
	107	.bus_resume = ehci_bus_resume,
	108	.relinquish_port = ehci_relinquish_port,
	109	.port_handed_over = ehci_port_handed_over,
b48d7f50 PM	110
b48d7f50 PM	111	.clear_tt_buffer_complete = ehci_clear_tt_buffer_complete,
7e8d5cd9 DM	112	};
	113
	114	static int ehci_mxc_drv_probe(struct platform_device *pdev)
	115	{
	116	struct mxc_usbh_platform_data *pdata = pdev->dev.platform_data;
	117	struct usb_hcd *hcd;
	118	struct resource *res;
724c8525	119	int irq, ret;
a464dc4d	120	unsigned int flags;
7e8d5cd9 DM	121	struct ehci_mxc_priv *priv;
7e8d5cd9 DM	122	struct device *dev = &pdev->dev;
0247a7bc	123	struct ehci_hcd *ehci;
7e8d5cd9 DM	124
	125	dev_info(&pdev->dev, "initializing i.MX USB Controller\n");
	126
	127	if (!pdata) {
	128	dev_err(dev, "No platform data given, bailing out.\n");
	129	return -EINVAL;
	130	}
	131
	132	irq = platform_get_irq(pdev, 0);
	133
	134	hcd = usb_create_hcd(&ehci_mxc_hc_driver, dev, dev_name(dev));
	135	if (!hcd)
	136	return -ENOMEM;
	137
	138	priv = kzalloc(sizeof(*priv), GFP_KERNEL);
	139	if (!priv) {
	140	ret = -ENOMEM;
	141	goto err_alloc;
	142	}
	143
	144	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	145	if (!res) {
	146	dev_err(dev, "Found HC with no register addr. Check setup!\n");
	147	ret = -ENODEV;
	148	goto err_get_resource;
	149	}
	150
	151	hcd->rsrc_start = res->start;
	152	hcd->rsrc_len = resource_size(res);
	153
	154	if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
	155	dev_dbg(dev, "controller already in use\n");
	156	ret = -EBUSY;
	157	goto err_request_mem;
	158	}
	159
	160	hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
	161	if (!hcd->regs) {
	162	dev_err(dev, "error mapping memory\n");
	163	ret = -EFAULT;
	164	goto err_ioremap;
	165	}
	166
	167	/* enable clocks */
	168	priv->usbclk = clk_get(dev, "usb");
	169	if (IS_ERR(priv->usbclk)) {
	170	ret = PTR_ERR(priv->usbclk);
	171	goto err_clk;
	172	}
	173	clk_enable(priv->usbclk);
	174
4ea0af02	175	if (!cpu_is_mx35() && !cpu_is_mx25()) {
7e8d5cd9 DM	176	priv->ahbclk = clk_get(dev, "usb_ahb");
	177	if (IS_ERR(priv->ahbclk)) {
	178	ret = PTR_ERR(priv->ahbclk);
	179	goto err_clk_ahb;
	180	}
	181	clk_enable(priv->ahbclk);
	182	}
	183
3bb8029a EB	184	/* "dr" device has its own clock on i.MX51 */
3bb8029a EB	185	if (cpu_is_mx51() && (pdev->id == 0)) {
711669e5 APR	186	priv->phy1clk = clk_get(dev, "usb_phy1");
	187	if (IS_ERR(priv->phy1clk)) {
	188	ret = PTR_ERR(priv->phy1clk);
	189	goto err_clk_phy;
	190	}
	191	clk_enable(priv->phy1clk);
	192	}
	193
	194
	195	/* call platform specific init function */
	196	if (pdata->init) {
	197	ret = pdata->init(pdev);
	198	if (ret) {
	199	dev_err(dev, "platform init failed\n");
	200	goto err_init;
	201	}
	202	/* platforms need some time to settle changed IO settings */
	203	mdelay(10);
	204	}
	205
0247a7bc FE	206	ehci = hcd_to_ehci(hcd);
	207
	208	/* EHCI registers start at offset 0x100 */
	209	ehci->caps = hcd->regs + 0x100;
	210	ehci->regs = hcd->regs + 0x100 +
c430131a	211	HC_LENGTH(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
0247a7bc FE	212
	213	/* set up the PORTSCx register */
	214	ehci_writel(ehci, pdata->portsc, &ehci->regs->port_status[0]);
	215
	216	/* is this really needed? */
	217	msleep(10);
	218
7e8d5cd9 DM	219	/* Initialize the transceiver */
	220	if (pdata->otg) {
	221	pdata->otg->io_priv = hcd->regs + ULPI_VIEWPORT_OFFSET;
4c9715de WS	222	ret = otg_init(pdata->otg);
	223	if (ret) {
	224	dev_err(dev, "unable to init transceiver, probably missing\n");
	225	ret = -ENODEV;
	226	goto err_add;
	227	}
	228	ret = otg_set_vbus(pdata->otg, 1);
	229	if (ret) {
7e8d5cd9	230	dev_err(dev, "unable to enable vbus on transceiver\n");
4c9715de WS	231	goto err_add;
4c9715de WS	232	}
7e8d5cd9 DM	233	}
	234
	235	priv->hcd = hcd;
	236	platform_set_drvdata(pdev, priv);
	237
	238	ret = usb_add_hcd(hcd, irq, IRQF_DISABLED \| IRQF_SHARED);
	239	if (ret)
	240	goto err_add;
	241
a464dc4d APR	242	if (pdata->otg) {
	243	/*
	244	* efikamx and efikasb have some hardware bug which is
	245	* preventing usb to work unless CHRGVBUS is set.
	246	* It's in violation of USB specs
	247	*/
	248	if (machine_is_mx51_efikamx() \|\| machine_is_mx51_efikasb()) {
	249	flags = otg_io_read(pdata->otg, ULPI_OTG_CTRL);
	250	flags \|= ULPI_OTG_CTRL_CHRGVBUS;
	251	ret = otg_io_write(pdata->otg, flags, ULPI_OTG_CTRL);
	252	if (ret) {
	253	dev_err(dev, "unable to set CHRVBUS\n");
	254	goto err_add;
	255	}
	256	}
	257	}
	258
7e8d5cd9 DM	259	return 0;
	260
	261	err_add:
	262	if (pdata && pdata->exit)
	263	pdata->exit(pdev);
	264	err_init:
711669e5 APR	265	if (priv->phy1clk) {
	266	clk_disable(priv->phy1clk);
	267	clk_put(priv->phy1clk);
	268	}
	269	err_clk_phy:
7e8d5cd9 DM	270	if (priv->ahbclk) {
	271	clk_disable(priv->ahbclk);
	272	clk_put(priv->ahbclk);
	273	}
	274	err_clk_ahb:
	275	clk_disable(priv->usbclk);
	276	clk_put(priv->usbclk);
	277	err_clk:
	278	iounmap(hcd->regs);
	279	err_ioremap:
	280	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
	281	err_request_mem:
	282	err_get_resource:
	283	kfree(priv);
	284	err_alloc:
	285	usb_put_hcd(hcd);
	286	return ret;
	287	}
	288
	289	static int __exit ehci_mxc_drv_remove(struct platform_device *pdev)
	290	{
	291	struct mxc_usbh_platform_data *pdata = pdev->dev.platform_data;
	292	struct ehci_mxc_priv *priv = platform_get_drvdata(pdev);
	293	struct usb_hcd *hcd = priv->hcd;
	294
	295	if (pdata && pdata->exit)
	296	pdata->exit(pdev);
	297
	298	if (pdata->otg)
	299	otg_shutdown(pdata->otg);
	300
	301	usb_remove_hcd(hcd);
	302	iounmap(hcd->regs);
	303	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
	304	usb_put_hcd(hcd);
	305	platform_set_drvdata(pdev, NULL);
	306
	307	clk_disable(priv->usbclk);
	308	clk_put(priv->usbclk);
	309	if (priv->ahbclk) {
	310	clk_disable(priv->ahbclk);
	311	clk_put(priv->ahbclk);
	312	}
711669e5 APR	313	if (priv->phy1clk) {
	314	clk_disable(priv->phy1clk);
	315	clk_put(priv->phy1clk);
	316	}
7e8d5cd9 DM	317
	318	kfree(priv);
	319
	320	return 0;
	321	}
	322
	323	static void ehci_mxc_drv_shutdown(struct platform_device *pdev)
	324	{
	325	struct ehci_mxc_priv *priv = platform_get_drvdata(pdev);
	326	struct usb_hcd *hcd = priv->hcd;
	327
	328	if (hcd->driver->shutdown)
	329	hcd->driver->shutdown(hcd);
	330	}
	331
	332	MODULE_ALIAS("platform:mxc-ehci");
	333
	334	static struct platform_driver ehci_mxc_driver = {
	335	.probe = ehci_mxc_drv_probe,
	336	.remove = __exit_p(ehci_mxc_drv_remove),
	337	.shutdown = ehci_mxc_drv_shutdown,
	338	.driver = {
	339	.name = "mxc-ehci",
	340	},
	341	};