1/* ehci-msm.c - HSUSB Host Controller Driver Implementation
  2 *
  3 * Copyright (c) 2008-2011, Code Aurora Forum. All rights reserved.
  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
 25#include <linux/clk.h>
 26#include <linux/err.h>
 27#include <linux/io.h>
 28#include <linux/kernel.h>
 29#include <linux/module.h>
 30#include <linux/platform_device.h>
 31#include <linux/pm_runtime.h>
 32#include <linux/usb/otg.h>
 33#include <linux/usb/msm_hsusb_hw.h>
 34#include <linux/usb.h>
 35#include <linux/usb/hcd.h>
 36#include <linux/acpi.h>
 37
 38#include "ehci.h"
 39
 40#define MSM_USB_BASE (hcd->regs)
 41
 42#define DRIVER_DESC "Qualcomm On-Chip EHCI Host Controller"
 43
 44static const char hcd_name[] = "ehci-msm";
 45static struct hc_driver __read_mostly msm_hc_driver;
 46
 47static 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;
 53	hcd->has_tt = 1;
 54
 55	retval = ehci_setup(hcd);
 56	if (retval)
 57		return retval;
 58
 59	/* select ULPI phy and clear other status/control bits in PORTSC */
 60	writel(PORTSC_PTS_ULPI, USB_PORTSC);
 61	/* bursts of unspecified length. */
 62	writel(0, USB_AHBBURST);
 63	/* Use the AHB transactor, allow posted data writes */
 64	writel(0x8, USB_AHBMODE);
 65	/* Disable streaming mode and select host mode */
 66	writel(0x13, USB_USBMODE);
 67	/* Disable ULPI_TX_PKT_EN_CLR_FIX which is valid only for HSIC */
 68	writel(readl(USB_GENCONFIG_2) & ~ULPI_TX_PKT_EN_CLR_FIX, USB_GENCONFIG_2);
 69
 70	return 0;
 71}
 72
 73static int ehci_msm_probe(struct platform_device *pdev)
 74{
 75	struct usb_hcd *hcd;
 76	struct resource *res;
 77	struct usb_phy *phy;
 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
 88	ret = platform_get_irq(pdev, 0);
 89	if (ret < 0) {
 90		dev_err(&pdev->dev, "Unable to get IRQ resource\n");
 91		goto put_hcd;
 92	}
 93	hcd->irq = ret;
 94
 95	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 96	if (!res) {
 97		dev_err(&pdev->dev, "Unable to get memory resource\n");
 98		ret = -ENODEV;
 99		goto put_hcd;
100	}
101
102	hcd->rsrc_start = res->start;
103	hcd->rsrc_len = resource_size(res);
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	}
110
111	/*
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.
115	 */
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
121	if (IS_ERR(phy)) {
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;
128	}
129
130	hcd->usb_phy = phy;
131	device_init_wakeup(&pdev->dev, 1);
132
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	}
151
152	return 0;
153
154put_hcd:
155	usb_put_hcd(hcd);
156
157	return ret;
158}
159
160static int ehci_msm_remove(struct platform_device *pdev)
161{
162	struct usb_hcd *hcd = platform_get_drvdata(pdev);
163
164	device_init_wakeup(&pdev->dev, 0);
165	pm_runtime_disable(&pdev->dev);
166	pm_runtime_set_suspended(&pdev->dev);
167
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);
172
173	usb_put_hcd(hcd);
174
175	return 0;
176}
177
178#ifdef CONFIG_PM
179static int ehci_msm_pm_suspend(struct device *dev)
180{
181	struct usb_hcd *hcd = dev_get_drvdata(dev);
182	bool do_wakeup = device_may_wakeup(dev);
183
184	dev_dbg(dev, "ehci-msm PM suspend\n");
185
186	return ehci_suspend(hcd, do_wakeup);
187}
188
189static int ehci_msm_pm_resume(struct device *dev)
190{
191	struct usb_hcd *hcd = dev_get_drvdata(dev);
192
193	dev_dbg(dev, "ehci-msm PM resume\n");
194	ehci_resume(hcd, false);
195
196	return 0;
197}
198#else
199#define ehci_msm_pm_suspend	NULL
200#define ehci_msm_pm_resume	NULL
201#endif
202
203static const struct dev_pm_ops ehci_msm_dev_pm_ops = {
204	.suspend         = ehci_msm_pm_suspend,
205	.resume          = ehci_msm_pm_resume,
206};
207
208static const struct acpi_device_id msm_ehci_acpi_ids[] = {
209	{ "QCOM8040", 0 },
210	{ }
211};
212MODULE_DEVICE_TABLE(acpi, msm_ehci_acpi_ids);
213
214static const struct of_device_id msm_ehci_dt_match[] = {
215	{ .compatible = "qcom,ehci-host", },
216	{}
217};
218MODULE_DEVICE_TABLE(of, msm_ehci_dt_match);
219
220static struct platform_driver ehci_msm_driver = {
221	.probe	= ehci_msm_probe,
222	.remove	= ehci_msm_remove,
223	.shutdown = usb_hcd_platform_shutdown,
224	.driver = {
225		   .name = "msm_hsusb_host",
226		   .pm = &ehci_msm_dev_pm_ops,
227		   .of_match_table = msm_ehci_dt_match,
228		   .acpi_match_table = ACPI_PTR(msm_ehci_acpi_ids),
229	},
230};
231
232static const struct ehci_driver_overrides msm_overrides __initdata = {
233	.reset = ehci_msm_reset,
234};
235
236static int __init ehci_msm_init(void)
237{
238	if (usb_disabled())
239		return -ENODEV;
240
241	pr_info("%s: " DRIVER_DESC "\n", hcd_name);
242	ehci_init_driver(&msm_hc_driver, &msm_overrides);
243	return platform_driver_register(&ehci_msm_driver);
244}
245module_init(ehci_msm_init);
246
247static void __exit ehci_msm_cleanup(void)
248{
249	platform_driver_unregister(&ehci_msm_driver);
250}
251module_exit(ehci_msm_cleanup);
252
253MODULE_DESCRIPTION(DRIVER_DESC);
254MODULE_ALIAS("platform:msm-ehci");
255MODULE_LICENSE("GPL");