[mirror_ubuntu-artful-kernel.git] / drivers / usb / host / ehci-msm.c

/* ehci-msm.c - HSUSB Host Controller Driver Implementation
 *
 * Copyright (c) 2008-2011, Code Aurora Forum. All rights reserved.
 *
 * Partly derived from ehci-fsl.c and ehci-hcd.c
 * Copyright (c) 2000-2004 by David Brownell
 * Copyright (c) 2005 MontaVista Software
 *
 * All source code in this file is licensed under the following license except
 * where indicated.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 as published
 * by the Free Software Foundation.
 *
 * 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, you can find it at http://www.fsf.org
 */

#include <linux/clk.h>
#include <linux/err.h>
#include <linux/io.h>
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/platform_device.h>
#include <linux/pm_runtime.h>
#include <linux/usb/otg.h>
#include <linux/usb/msm_hsusb_hw.h>
#include <linux/usb.h>
#include <linux/usb/hcd.h>
#include <linux/acpi.h>

#include "ehci.h"

#define MSM_USB_BASE (hcd->regs)

#define DRIVER_DESC "Qualcomm On-Chip EHCI Host Controller"

static const char hcd_name[] = "ehci-msm";
static struct hc_driver __read_mostly msm_hc_driver;

static int ehci_msm_reset(struct usb_hcd *hcd)
{
	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
	int retval;

	ehci->caps = USB_CAPLENGTH;
	hcd->has_tt = 1;

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

	/* select ULPI phy and clear other status/control bits in PORTSC */
	writel(PORTSC_PTS_ULPI, USB_PORTSC);
	/* bursts of unspecified length. */
	writel(0, USB_AHBBURST);
	/* Use the AHB transactor, allow posted data writes */
	writel(0x8, USB_AHBMODE);
	/* Disable streaming mode and select host mode */
	writel(0x13, USB_USBMODE);
	/* Disable ULPI_TX_PKT_EN_CLR_FIX which is valid only for HSIC */
	writel(readl(USB_GENCONFIG_2) & ~ULPI_TX_PKT_EN_CLR_FIX, USB_GENCONFIG_2);

	return 0;
}

static int ehci_msm_probe(struct platform_device *pdev)
{
	struct usb_hcd *hcd;
	struct resource *res;
	struct usb_phy *phy;
	int ret;

	dev_dbg(&pdev->dev, "ehci_msm proble\n");

	hcd = usb_create_hcd(&msm_hc_driver, &pdev->dev, dev_name(&pdev->dev));
	if (!hcd) {
		dev_err(&pdev->dev, "Unable to create HCD\n");
		return  -ENOMEM;
	}

	ret = platform_get_irq(pdev, 0);
	if (ret < 0) {
		dev_err(&pdev->dev, "Unable to get IRQ resource\n");
		goto put_hcd;
	}
	hcd->irq = ret;

	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	if (!res) {
		dev_err(&pdev->dev, "Unable to get memory resource\n");
		ret = -ENODEV;
		goto put_hcd;
	}

	hcd->rsrc_start = res->start;
	hcd->rsrc_len = resource_size(res);
	hcd->regs = devm_ioremap(&pdev->dev, hcd->rsrc_start, hcd->rsrc_len);
	if (!hcd->regs) {
		dev_err(&pdev->dev, "ioremap failed\n");
		ret = -ENOMEM;
		goto put_hcd;
	}

	/*
	 * If there is an OTG driver, let it take care of PHY initialization,
	 * clock management, powering up VBUS, mapping of registers address
	 * space and power management.
	 */
	if (pdev->dev.of_node)
		phy = devm_usb_get_phy_by_phandle(&pdev->dev, "usb-phy", 0);
	else
		phy = devm_usb_get_phy(&pdev->dev, USB_PHY_TYPE_USB2);

	if (IS_ERR(phy)) {
		if (PTR_ERR(phy) == -EPROBE_DEFER) {
			dev_err(&pdev->dev, "unable to find transceiver\n");
			ret = -EPROBE_DEFER;
			goto put_hcd;
		}
		phy = NULL;
	}

	hcd->usb_phy = phy;
	device_init_wakeup(&pdev->dev, 1);

	if (phy && phy->otg) {
		/*
		 * MSM OTG driver takes care of adding the HCD and
		 * placing hardware into low power mode via runtime PM.
		 */
		ret = otg_set_host(phy->otg, &hcd->self);
		if (ret < 0) {
			dev_err(&pdev->dev, "unable to register with transceiver\n");
			goto put_hcd;
		}

		pm_runtime_no_callbacks(&pdev->dev);
		pm_runtime_enable(&pdev->dev);
	} else {
		ret = usb_add_hcd(hcd, hcd->irq, IRQF_SHARED);
		if (ret)
			goto put_hcd;
	}

	return 0;

put_hcd:
	usb_put_hcd(hcd);

	return ret;
}

static int ehci_msm_remove(struct platform_device *pdev)
{
	struct usb_hcd *hcd = platform_get_drvdata(pdev);

	device_init_wakeup(&pdev->dev, 0);
	pm_runtime_disable(&pdev->dev);
	pm_runtime_set_suspended(&pdev->dev);

	if (hcd->usb_phy && hcd->usb_phy->otg)
		otg_set_host(hcd->usb_phy->otg, NULL);
	else
		usb_remove_hcd(hcd);

	usb_put_hcd(hcd);

	return 0;
}

#ifdef CONFIG_PM
static int ehci_msm_pm_suspend(struct device *dev)
{
	struct usb_hcd *hcd = dev_get_drvdata(dev);
	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
	bool do_wakeup = device_may_wakeup(dev);

	dev_dbg(dev, "ehci-msm PM suspend\n");

	/* Only call ehci_suspend if ehci_setup has been done */
	if (ehci->sbrn)
		return ehci_suspend(hcd, do_wakeup);

	return 0;
}

static int ehci_msm_pm_resume(struct device *dev)
{
	struct usb_hcd *hcd = dev_get_drvdata(dev);
	struct ehci_hcd *ehci = hcd_to_ehci(hcd);

	dev_dbg(dev, "ehci-msm PM resume\n");

	/* Only call ehci_resume if ehci_setup has been done */
	if (ehci->sbrn)
		ehci_resume(hcd, false);

	return 0;
}

#else
#define ehci_msm_pm_suspend	NULL
#define ehci_msm_pm_resume	NULL
#endif

static const struct dev_pm_ops ehci_msm_dev_pm_ops = {
	.suspend         = ehci_msm_pm_suspend,
	.resume          = ehci_msm_pm_resume,
};

static const struct acpi_device_id msm_ehci_acpi_ids[] = {
	{ "QCOM8040", 0 },
	{ }
};
MODULE_DEVICE_TABLE(acpi, msm_ehci_acpi_ids);

static const struct of_device_id msm_ehci_dt_match[] = {
	{ .compatible = "qcom,ehci-host", },
	{}
};
MODULE_DEVICE_TABLE(of, msm_ehci_dt_match);

static struct platform_driver ehci_msm_driver = {
	.probe	= ehci_msm_probe,
	.remove	= ehci_msm_remove,
	.shutdown = usb_hcd_platform_shutdown,
	.driver = {
		   .name = "msm_hsusb_host",
		   .pm = &ehci_msm_dev_pm_ops,
		   .of_match_table = msm_ehci_dt_match,
		   .acpi_match_table = ACPI_PTR(msm_ehci_acpi_ids),
	},
};

static const struct ehci_driver_overrides msm_overrides __initconst = {
	.reset = ehci_msm_reset,
};

static int __init ehci_msm_init(void)
{
	if (usb_disabled())
		return -ENODEV;

	pr_info("%s: " DRIVER_DESC "\n", hcd_name);
	ehci_init_driver(&msm_hc_driver, &msm_overrides);
	return platform_driver_register(&ehci_msm_driver);
}
module_init(ehci_msm_init);

static void __exit ehci_msm_cleanup(void)
{
	platform_driver_unregister(&ehci_msm_driver);
}
module_exit(ehci_msm_cleanup);

MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_ALIAS("platform:msm-ehci");
MODULE_LICENSE("GPL");
Commit	Line	Data
b0848aea PK	1	/* ehci-msm.c - HSUSB Host Controller Driver Implementation
b0848aea PK	2	*
18f53461	3	* Copyright (c) 2008-2011, Code Aurora Forum. All rights reserved.
b0848aea PK	4	*
	5	* Partly derived from ehci-fsl.c and ehci-hcd.c
	6	* Copyright (c) 2000-2004 by David Brownell
	7	* Copyright (c) 2005 MontaVista Software
	8	*
	9	* All source code in this file is licensed under the following license except
	10	* where indicated.
	11	*
	12	* This program is free software; you can redistribute it and/or modify it
	13	* under the terms of the GNU General Public License version 2 as published
	14	* by the Free Software Foundation.
	15	*
	16	* This program is distributed in the hope that it will be useful,
	17	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	18	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
	19	*
	20	* See the GNU General Public License for more details.
	21	* You should have received a copy of the GNU General Public License
	22	* along with this program; if not, you can find it at http://www.fsf.org
	23	*/
	24
b0848aea PK	25	#include <linux/clk.h>
b0848aea PK	26	#include <linux/err.h>
8c68e84f MG	27	#include <linux/io.h>
	28	#include <linux/kernel.h>
	29	#include <linux/module.h>
	30	#include <linux/platform_device.h>
8bb6a164	31	#include <linux/pm_runtime.h>
b0848aea PK	32	#include <linux/usb/otg.h>
b0848aea PK	33	#include <linux/usb/msm_hsusb_hw.h>
8c68e84f MG	34	#include <linux/usb.h>
8c68e84f MG	35	#include <linux/usb/hcd.h>
f13f0e65	36	#include <linux/acpi.h>
8c68e84f MG	37
8c68e84f MG	38	#include "ehci.h"
b0848aea PK	39
	40	#define MSM_USB_BASE (hcd->regs)
	41
8c68e84f MG	42	#define DRIVER_DESC "Qualcomm On-Chip EHCI Host Controller"
	43
	44	static const char hcd_name[] = "ehci-msm";
	45	static struct hc_driver __read_mostly msm_hc_driver;
b0848aea	46
b0848aea PK	47	static int ehci_msm_reset(struct usb_hcd *hcd)
	48	{
	49	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
	50	int retval;
	51
	52	ehci->caps = USB_CAPLENGTH;
b0848aea	53	hcd->has_tt = 1;
b0848aea	54
2cb30bb1	55	retval = ehci_setup(hcd);
b0848aea PK	56	if (retval)
	57	return retval;
	58
e8f55b91 JP	59	/* select ULPI phy and clear other status/control bits in PORTSC */
e8f55b91 JP	60	writel(PORTSC_PTS_ULPI, USB_PORTSC);
b0848aea PK	61	/* bursts of unspecified length. */
b0848aea PK	62	writel(0, USB_AHBBURST);
c56a2b2b AG	63	/* Use the AHB transactor, allow posted data writes */
c56a2b2b AG	64	writel(0x8, USB_AHBMODE);
b0848aea PK	65	/* Disable streaming mode and select host mode */
b0848aea PK	66	writel(0x13, USB_USBMODE);
132f5005 JP	67	/* Disable ULPI_TX_PKT_EN_CLR_FIX which is valid only for HSIC */
132f5005 JP	68	writel(readl(USB_GENCONFIG_2) & ~ULPI_TX_PKT_EN_CLR_FIX, USB_GENCONFIG_2);
b0848aea	69
b0848aea PK	70	return 0;
	71	}
	72
b0848aea PK	73	static int ehci_msm_probe(struct platform_device *pdev)
	74	{
	75	struct usb_hcd *hcd;
	76	struct resource *res;
e4f0da05	77	struct usb_phy *phy;
b0848aea PK	78	int ret;
	79
	80	dev_dbg(&pdev->dev, "ehci_msm proble\n");
	81
	82	hcd = usb_create_hcd(&msm_hc_driver, &pdev->dev, dev_name(&pdev->dev));
	83	if (!hcd) {
	84	dev_err(&pdev->dev, "Unable to create HCD\n");
	85	return -ENOMEM;
	86	}
	87
0c43e9d8 AH	88	ret = platform_get_irq(pdev, 0);
0c43e9d8 AH	89	if (ret < 0) {
b0848aea	90	dev_err(&pdev->dev, "Unable to get IRQ resource\n");
b0848aea PK	91	goto put_hcd;
b0848aea PK	92	}
0c43e9d8	93	hcd->irq = ret;
b0848aea PK	94
b0848aea PK	95	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
bb304b71 II	96	if (!res) {
	97	dev_err(&pdev->dev, "Unable to get memory resource\n");
	98	ret = -ENODEV;
b0848aea PK	99	goto put_hcd;
b0848aea PK	100	}
bb304b71	101
e507bf57 VB	102	hcd->rsrc_start = res->start;
e507bf57 VB	103	hcd->rsrc_len = resource_size(res);
bb304b71 II	104	hcd->regs = devm_ioremap(&pdev->dev, hcd->rsrc_start, hcd->rsrc_len);
	105	if (!hcd->regs) {
	106	dev_err(&pdev->dev, "ioremap failed\n");
	107	ret = -ENOMEM;
	108	goto put_hcd;
	109	}
b0848aea PK	110
b0848aea PK	111	/*
c4398ef6 JP	112	* If there is an OTG driver, let it take care of PHY initialization,
	113	* clock management, powering up VBUS, mapping of registers address
	114	* space and power management.
b0848aea	115	*/
0fc924bd II	116	if (pdev->dev.of_node)
	117	phy = devm_usb_get_phy_by_phandle(&pdev->dev, "usb-phy", 0);
	118	else
	119	phy = devm_usb_get_phy(&pdev->dev, USB_PHY_TYPE_USB2);
	120
e299bd93	121	if (IS_ERR(phy)) {
c4398ef6 JP	122	if (PTR_ERR(phy) == -EPROBE_DEFER) {
	123	dev_err(&pdev->dev, "unable to find transceiver\n");
	124	ret = -EPROBE_DEFER;
	125	goto put_hcd;
	126	}
	127	phy = NULL;
b0848aea PK	128	}
b0848aea PK	129
3d46e73d	130	hcd->usb_phy = phy;
b0848aea	131	device_init_wakeup(&pdev->dev, 1);
8bb6a164	132
c4398ef6 JP	133	if (phy && phy->otg) {
	134	/*
	135	* MSM OTG driver takes care of adding the HCD and
	136	* placing hardware into low power mode via runtime PM.
	137	*/
	138	ret = otg_set_host(phy->otg, &hcd->self);
	139	if (ret < 0) {
	140	dev_err(&pdev->dev, "unable to register with transceiver\n");
	141	goto put_hcd;
	142	}
	143
	144	pm_runtime_no_callbacks(&pdev->dev);
	145	pm_runtime_enable(&pdev->dev);
	146	} else {
	147	ret = usb_add_hcd(hcd, hcd->irq, IRQF_SHARED);
	148	if (ret)
	149	goto put_hcd;
	150	}
8c68e84f	151
b0848aea PK	152	return 0;
b0848aea PK	153
b0848aea PK	154	put_hcd:
	155	usb_put_hcd(hcd);
	156
	157	return ret;
	158	}
	159
fb4e98ab	160	static int ehci_msm_remove(struct platform_device *pdev)
b0848aea PK	161	{
	162	struct usb_hcd *hcd = platform_get_drvdata(pdev);
	163
	164	device_init_wakeup(&pdev->dev, 0);
8bb6a164 PK	165	pm_runtime_disable(&pdev->dev);
8bb6a164 PK	166	pm_runtime_set_suspended(&pdev->dev);
b0848aea	167
c4398ef6 JP	168	if (hcd->usb_phy && hcd->usb_phy->otg)
	169	otg_set_host(hcd->usb_phy->otg, NULL);
	170	else
	171	usb_remove_hcd(hcd);
8c68e84f	172
b0848aea PK	173	usb_put_hcd(hcd);
	174
	175	return 0;
	176	}
	177
8bb6a164 PK	178	#ifdef CONFIG_PM
	179	static int ehci_msm_pm_suspend(struct device *dev)
	180	{
	181	struct usb_hcd *hcd = dev_get_drvdata(dev);
815c9d6a	182	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
c5cf9212	183	bool do_wakeup = device_may_wakeup(dev);
8bb6a164 PK	184
	185	dev_dbg(dev, "ehci-msm PM suspend\n");
	186
815c9d6a AG	187	/* Only call ehci_suspend if ehci_setup has been done */
	188	if (ehci->sbrn)
	189	return ehci_suspend(hcd, do_wakeup);
	190
	191	return 0;
8bb6a164 PK	192	}
	193
	194	static int ehci_msm_pm_resume(struct device *dev)
	195	{
	196	struct usb_hcd *hcd = dev_get_drvdata(dev);
815c9d6a	197	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
8bb6a164 PK	198
8bb6a164 PK	199	dev_dbg(dev, "ehci-msm PM resume\n");
815c9d6a AG	200
	201	/* Only call ehci_resume if ehci_setup has been done */
	202	if (ehci->sbrn)
	203	ehci_resume(hcd, false);
8bb6a164 PK	204
	205	return 0;
	206	}
815c9d6a	207
8bb6a164 PK	208	#else
	209	#define ehci_msm_pm_suspend NULL
	210	#define ehci_msm_pm_resume NULL
	211	#endif
	212
	213	static const struct dev_pm_ops ehci_msm_dev_pm_ops = {
	214	.suspend = ehci_msm_pm_suspend,
	215	.resume = ehci_msm_pm_resume,
	216	};
	217
f13f0e65 JP	218	static const struct acpi_device_id msm_ehci_acpi_ids[] = {
	219	{ "QCOM8040", 0 },
	220	{ }
	221	};
	222	MODULE_DEVICE_TABLE(acpi, msm_ehci_acpi_ids);
	223
3587fb3b	224	static const struct of_device_id msm_ehci_dt_match[] = {
0fc924bd II	225	{ .compatible = "qcom,ehci-host", },
	226	{}
	227	};
	228	MODULE_DEVICE_TABLE(of, msm_ehci_dt_match);
	229
b0848aea PK	230	static struct platform_driver ehci_msm_driver = {
b0848aea PK	231	.probe = ehci_msm_probe,
7690417d	232	.remove = ehci_msm_remove,
4bb3cad7	233	.shutdown = usb_hcd_platform_shutdown,
b0848aea PK	234	.driver = {
b0848aea PK	235	.name = "msm_hsusb_host",
8bb6a164	236	.pm = &ehci_msm_dev_pm_ops,
0fc924bd	237	.of_match_table = msm_ehci_dt_match,
f13f0e65	238	.acpi_match_table = ACPI_PTR(msm_ehci_acpi_ids),
b0848aea PK	239	},
b0848aea PK	240	};
8c68e84f	241
edc8c54b	242	static const struct ehci_driver_overrides msm_overrides __initconst = {
8c68e84f MG	243	.reset = ehci_msm_reset,
	244	};
	245
	246	static int __init ehci_msm_init(void)
	247	{
	248	if (usb_disabled())
	249	return -ENODEV;
	250
	251	pr_info("%s: " DRIVER_DESC "\n", hcd_name);
	252	ehci_init_driver(&msm_hc_driver, &msm_overrides);
	253	return platform_driver_register(&ehci_msm_driver);
	254	}
	255	module_init(ehci_msm_init);
	256
	257	static void __exit ehci_msm_cleanup(void)
	258	{
	259	platform_driver_unregister(&ehci_msm_driver);
	260	}
	261	module_exit(ehci_msm_cleanup);
	262
	263	MODULE_DESCRIPTION(DRIVER_DESC);
	264	MODULE_ALIAS("platform:msm-ehci");
	265	MODULE_LICENSE("GPL");