blob: 4384d07115d15e4e19297fbb0aec01a91dab71e5 [file] [log] [blame]
Felipe Balbi54ab2b02009-10-14 11:44:14 +03001/*
Anand Gadiyar4792a152010-11-21 23:23:42 +05302 * ehci-omap.c - driver for USBHOST on OMAP3/4 processors
Felipe Balbi54ab2b02009-10-14 11:44:14 +03003 *
Anand Gadiyar4792a152010-11-21 23:23:42 +05304 * Bus Glue for the EHCI controllers in OMAP3/4
5 * Tested on several OMAP3 boards, and OMAP4 Pandaboard
Felipe Balbi54ab2b02009-10-14 11:44:14 +03006 *
Roger Quadrosdcd64062013-03-12 12:44:41 +02007 * Copyright (C) 2007-2013 Texas Instruments, Inc.
Felipe Balbi54ab2b02009-10-14 11:44:14 +03008 * Author: Vikram Pandita <vikram.pandita@ti.com>
Anand Gadiyar4792a152010-11-21 23:23:42 +05309 * Author: Anand Gadiyar <gadiyar@ti.com>
Keshava Munegowda19403162011-03-01 20:08:21 +053010 * Author: Keshava Munegowda <keshava_mgowda@ti.com>
Roger Quadrosdcd64062013-03-12 12:44:41 +020011 * Author: Roger Quadros <rogerq@ti.com>
Felipe Balbi54ab2b02009-10-14 11:44:14 +030012 *
13 * Copyright (C) 2009 Nokia Corporation
14 * Contact: Felipe Balbi <felipe.balbi@nokia.com>
15 *
16 * Based on "ehci-fsl.c" and "ehci-au1xxx.c" ehci glue layers
17 *
18 * This program is free software; you can redistribute it and/or modify
19 * it under the terms of the GNU General Public License as published by
20 * the Free Software Foundation; either version 2 of the License, or
21 * (at your option) any later version.
22 *
23 * This program is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
27 *
28 * You should have received a copy of the GNU General Public License
29 * along with this program; if not, write to the Free Software
30 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
31 *
Felipe Balbi54ab2b02009-10-14 11:44:14 +030032 */
33
Alan Stern54a419662013-03-12 12:44:39 +020034#include <linux/kernel.h>
35#include <linux/module.h>
36#include <linux/io.h>
Felipe Balbi54ab2b02009-10-14 11:44:14 +030037#include <linux/platform_device.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090038#include <linux/slab.h>
Ajay Kumar Gupta5aa4af22010-07-08 14:03:02 +053039#include <linux/usb/ulpi.h>
Keshava Munegowda6c984b02011-10-11 13:22:11 +053040#include <linux/pm_runtime.h>
Keshava Munegowda1fcb57d2012-03-19 12:12:47 +053041#include <linux/gpio.h>
Anand Gadiyar354ab852012-06-05 15:34:27 +030042#include <linux/clk.h>
Alan Stern54a419662013-03-12 12:44:39 +020043#include <linux/usb.h>
44#include <linux/usb/hcd.h>
Roger Quadrosa1ae0af2013-03-12 12:44:48 +020045#include <linux/of.h>
46#include <linux/dma-mapping.h>
Alan Stern54a419662013-03-12 12:44:39 +020047
48#include "ehci.h"
Felipe Balbi54ab2b02009-10-14 11:44:14 +030049
Felipe Balbie8c4a7a2012-10-24 14:26:19 -070050#include <linux/platform_data/usb-omap.h>
51
Felipe Balbi54ab2b02009-10-14 11:44:14 +030052/* EHCI Register Set */
Anand Gadiyar572538d2010-05-06 20:09:48 +053053#define EHCI_INSNREG04 (0xA0)
54#define EHCI_INSNREG04_DISABLE_UNSUSPEND (1 << 5)
Felipe Balbi54ab2b02009-10-14 11:44:14 +030055#define EHCI_INSNREG05_ULPI (0xA4)
56#define EHCI_INSNREG05_ULPI_CONTROL_SHIFT 31
57#define EHCI_INSNREG05_ULPI_PORTSEL_SHIFT 24
58#define EHCI_INSNREG05_ULPI_OPSEL_SHIFT 22
59#define EHCI_INSNREG05_ULPI_REGADD_SHIFT 16
60#define EHCI_INSNREG05_ULPI_EXTREGADD_SHIFT 8
61#define EHCI_INSNREG05_ULPI_WRDATA_SHIFT 0
62
Alan Stern54a419662013-03-12 12:44:39 +020063#define DRIVER_DESC "OMAP-EHCI Host Controller driver"
Felipe Balbi54ab2b02009-10-14 11:44:14 +030064
Alan Stern54a419662013-03-12 12:44:39 +020065static const char hcd_name[] = "ehci-omap";
66
67/*-------------------------------------------------------------------------*/
Keshava Munegowda19403162011-03-01 20:08:21 +053068
Roger Quadrosdcd64062013-03-12 12:44:41 +020069struct omap_hcd {
70 struct usb_phy *phy[OMAP3_HS_USB_PORTS]; /* one PHY for each port */
71 int nports;
72};
Keshava Munegowda19403162011-03-01 20:08:21 +053073
74static inline void ehci_write(void __iomem *base, u32 reg, u32 val)
Felipe Balbi54ab2b02009-10-14 11:44:14 +030075{
76 __raw_writel(val, base + reg);
77}
78
Keshava Munegowda19403162011-03-01 20:08:21 +053079static inline u32 ehci_read(void __iomem *base, u32 reg)
Felipe Balbi54ab2b02009-10-14 11:44:14 +030080{
81 return __raw_readl(base + reg);
82}
83
Felipe Balbi54ab2b02009-10-14 11:44:14 +030084/* configure so an HC device and id are always provided */
85/* always called with process context; sleeping is OK */
86
Alan Stern54a419662013-03-12 12:44:39 +020087static struct hc_driver __read_mostly ehci_omap_hc_driver;
88
89static const struct ehci_driver_overrides ehci_omap_overrides __initdata = {
Roger Quadrosdcd64062013-03-12 12:44:41 +020090 .extra_priv_size = sizeof(struct omap_hcd),
Alan Stern54a419662013-03-12 12:44:39 +020091};
92
Felipe Balbi54ab2b02009-10-14 11:44:14 +030093/**
94 * ehci_hcd_omap_probe - initialize TI-based HCDs
95 *
96 * Allocates basic resources for this USB host controller, and
97 * then invokes the start() method for the HCD associated with it
98 * through the hotplug entry's driver_data.
99 */
100static int ehci_hcd_omap_probe(struct platform_device *pdev)
101{
Roger Quadrosdcd64062013-03-12 12:44:41 +0200102 struct device *dev = &pdev->dev;
103 struct usbhs_omap_platform_data *pdata = dev->platform_data;
104 struct resource *res;
105 struct usb_hcd *hcd;
106 void __iomem *regs;
107 int ret = -ENODEV;
108 int irq;
109 int i;
Roger Quadrosdcd64062013-03-12 12:44:41 +0200110 struct omap_hcd *omap;
Felipe Balbi54ab2b02009-10-14 11:44:14 +0300111
112 if (usb_disabled())
Keshava Munegowda19403162011-03-01 20:08:21 +0530113 return -ENODEV;
Felipe Balbi54ab2b02009-10-14 11:44:14 +0300114
Keshava Munegowda19403162011-03-01 20:08:21 +0530115 if (!dev->parent) {
116 dev_err(dev, "Missing parent device\n");
117 return -ENODEV;
Felipe Balbi54ab2b02009-10-14 11:44:14 +0300118 }
119
Roger Quadrosa1ae0af2013-03-12 12:44:48 +0200120 /* For DT boot, get platform data from parent. i.e. usbhshost */
121 if (dev->of_node) {
122 pdata = dev->parent->platform_data;
123 dev->platform_data = pdata;
124 }
125
126 if (!pdata) {
127 dev_err(dev, "Missing platform data\n");
128 return -ENODEV;
129 }
130
Roger Quadros34142112013-03-12 12:44:45 +0200131 irq = platform_get_irq(pdev, 0);
Keshava Munegowda19403162011-03-01 20:08:21 +0530132 if (irq < 0) {
133 dev_err(dev, "EHCI irq failed\n");
134 return -ENODEV;
135 }
136
Roger Quadros34142112013-03-12 12:44:45 +0200137 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
Roger Quadros18c2bb12013-03-12 12:44:40 +0200138 regs = devm_ioremap_resource(dev, res);
139 if (IS_ERR(regs))
140 return PTR_ERR(regs);
Keshava Munegowda19403162011-03-01 20:08:21 +0530141
Roger Quadrosa1ae0af2013-03-12 12:44:48 +0200142 /*
143 * Right now device-tree probed devices don't get dma_mask set.
144 * Since shared usb code relies on it, set it here for now.
145 * Once we have dma capability bindings this can go away.
146 */
Stephen Warren3b9561e2013-05-07 16:53:52 -0600147 if (!dev->dma_mask)
148 dev->dma_mask = &dev->coherent_dma_mask;
149 if (!dev->coherent_dma_mask)
150 dev->coherent_dma_mask = DMA_BIT_MASK(32);
Roger Quadrosa1ae0af2013-03-12 12:44:48 +0200151
Keshava Munegowda19403162011-03-01 20:08:21 +0530152 hcd = usb_create_hcd(&ehci_omap_hc_driver, dev,
153 dev_name(dev));
Felipe Balbi54ab2b02009-10-14 11:44:14 +0300154 if (!hcd) {
Roger Quadros18c2bb12013-03-12 12:44:40 +0200155 dev_err(dev, "Failed to create HCD\n");
156 return -ENOMEM;
Felipe Balbi54ab2b02009-10-14 11:44:14 +0300157 }
158
Felipe Balbi54ab2b02009-10-14 11:44:14 +0300159 hcd->rsrc_start = res->start;
160 hcd->rsrc_len = resource_size(res);
Keshava Munegowda19403162011-03-01 20:08:21 +0530161 hcd->regs = regs;
Roger Quadros413fd1e2013-03-13 15:16:03 +0200162 hcd_to_ehci(hcd)->caps = regs;
Felipe Balbi54ab2b02009-10-14 11:44:14 +0300163
Roger Quadrosdcd64062013-03-12 12:44:41 +0200164 omap = (struct omap_hcd *)hcd_to_ehci(hcd)->priv;
165 omap->nports = pdata->nports;
166
167 platform_set_drvdata(pdev, hcd);
168
169 /* get the PHY devices if needed */
170 for (i = 0 ; i < omap->nports ; i++) {
171 struct usb_phy *phy;
172
Roger Quadrosdcd64062013-03-12 12:44:41 +0200173 /* get the PHY device */
Roger Quadrosa1ae0af2013-03-12 12:44:48 +0200174 if (dev->of_node)
175 phy = devm_usb_get_phy_by_phandle(dev, "phys", i);
176 else
177 phy = devm_usb_get_phy_dev(dev, i);
Roger Quadros2bef64b2013-04-17 11:24:25 +0300178 if (IS_ERR(phy)) {
Roger Quadrosa2f450c2013-03-12 12:44:49 +0200179 /* Don't bail out if PHY is not absolutely necessary */
180 if (pdata->port_mode[i] != OMAP_EHCI_PORT_MODE_PHY)
181 continue;
182
Roger Quadros2bef64b2013-04-17 11:24:25 +0300183 ret = PTR_ERR(phy);
Roger Quadrosdcd64062013-03-12 12:44:41 +0200184 dev_err(dev, "Can't get PHY device for port %d: %d\n",
185 i, ret);
186 goto err_phy;
187 }
188
189 omap->phy[i] = phy;
Roger Quadros4e5c9e62013-06-14 16:52:07 +0300190
191 if (pdata->port_mode[i] == OMAP_EHCI_PORT_MODE_PHY) {
192 usb_phy_init(omap->phy[i]);
193 /* bring PHY out of suspend */
194 usb_phy_set_suspend(omap->phy[i], 0);
195 }
Roger Quadrosdcd64062013-03-12 12:44:41 +0200196 }
197
Keshava Munegowda6c984b02011-10-11 13:22:11 +0530198 pm_runtime_enable(dev);
199 pm_runtime_get_sync(dev);
Felipe Balbi54ab2b02009-10-14 11:44:14 +0300200
Keshava Munegowda19403162011-03-01 20:08:21 +0530201 /*
202 * An undocumented "feature" in the OMAP3 EHCI controller,
203 * causes suspended ports to be taken out of suspend when
204 * the USBCMD.Run/Stop bit is cleared (for example when
205 * we do ehci_bus_suspend).
206 * This breaks suspend-resume if the root-hub is allowed
207 * to suspend. Writing 1 to this undocumented register bit
208 * disables this feature and restores normal behavior.
209 */
210 ehci_write(regs, EHCI_INSNREG04,
211 EHCI_INSNREG04_DISABLE_UNSUSPEND);
212
Russ Dill3aa2ae72012-05-04 04:24:47 -0700213 ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
214 if (ret) {
215 dev_err(dev, "failed to add hcd with err %d\n", ret);
Russ Dill984e9742012-06-21 03:44:31 -0700216 goto err_pm_runtime;
Russ Dill3aa2ae72012-05-04 04:24:47 -0700217 }
218
Roger Quadros49f09212013-03-13 15:14:43 +0200219 /*
Roger Quadros4e5c9e62013-06-14 16:52:07 +0300220 * Bring PHYs out of reset for non PHY modes.
Roger Quadros49f09212013-03-13 15:14:43 +0200221 * Even though HSIC mode is a PHY-less mode, the reset
222 * line exists between the chips and can be modelled
223 * as a PHY device for reset control.
224 */
225 for (i = 0; i < omap->nports; i++) {
Roger Quadros4e5c9e62013-06-14 16:52:07 +0300226 if (!omap->phy[i] ||
227 pdata->port_mode[i] == OMAP_EHCI_PORT_MODE_PHY)
Roger Quadros49f09212013-03-13 15:14:43 +0200228 continue;
229
230 usb_phy_init(omap->phy[i]);
231 /* bring PHY out of suspend */
232 usb_phy_set_suspend(omap->phy[i], 0);
233 }
Anand Gadiyar354ab852012-06-05 15:34:27 +0300234
Felipe Balbi54ab2b02009-10-14 11:44:14 +0300235 return 0;
236
Russ Dill984e9742012-06-21 03:44:31 -0700237err_pm_runtime:
Keshava Munegowda6c984b02011-10-11 13:22:11 +0530238 pm_runtime_put_sync(dev);
Roger Quadrosdcd64062013-03-12 12:44:41 +0200239
240err_phy:
241 for (i = 0; i < omap->nports; i++) {
242 if (omap->phy[i])
243 usb_phy_shutdown(omap->phy[i]);
244 }
245
Russ Dill984e9742012-06-21 03:44:31 -0700246 usb_put_hcd(hcd);
Felipe Balbi54ab2b02009-10-14 11:44:14 +0300247
Felipe Balbi54ab2b02009-10-14 11:44:14 +0300248 return ret;
249}
250
Felipe Balbi54ab2b02009-10-14 11:44:14 +0300251
252/**
253 * ehci_hcd_omap_remove - shutdown processing for EHCI HCDs
254 * @pdev: USB Host Controller being removed
255 *
256 * Reverses the effect of usb_ehci_hcd_omap_probe(), first invoking
257 * the HCD's stop() method. It is always called from a thread
258 * context, normally "rmmod", "apmd", or something similar.
259 */
260static int ehci_hcd_omap_remove(struct platform_device *pdev)
261{
Roger Quadrosdcd64062013-03-12 12:44:41 +0200262 struct device *dev = &pdev->dev;
263 struct usb_hcd *hcd = dev_get_drvdata(dev);
264 struct omap_hcd *omap = (struct omap_hcd *)hcd_to_ehci(hcd)->priv;
265 int i;
Felipe Balbi54ab2b02009-10-14 11:44:14 +0300266
267 usb_remove_hcd(hcd);
Anand Gadiyar354ab852012-06-05 15:34:27 +0300268
Roger Quadrosdcd64062013-03-12 12:44:41 +0200269 for (i = 0; i < omap->nports; i++) {
270 if (omap->phy[i])
271 usb_phy_shutdown(omap->phy[i]);
272 }
273
274 usb_put_hcd(hcd);
Keshava Munegowda6c984b02011-10-11 13:22:11 +0530275 pm_runtime_put_sync(dev);
276 pm_runtime_disable(dev);
277
Felipe Balbi54ab2b02009-10-14 11:44:14 +0300278 return 0;
279}
280
Roger Quadrosa1ae0af2013-03-12 12:44:48 +0200281static const struct of_device_id omap_ehci_dt_ids[] = {
282 { .compatible = "ti,ehci-omap" },
283 { }
284};
285
286MODULE_DEVICE_TABLE(of, omap_ehci_dt_ids);
287
Felipe Balbi54ab2b02009-10-14 11:44:14 +0300288static struct platform_driver ehci_hcd_omap_driver = {
289 .probe = ehci_hcd_omap_probe,
290 .remove = ehci_hcd_omap_remove,
Roger Quadrosaaf6b522013-07-22 15:04:50 +0300291 .shutdown = usb_hcd_platform_shutdown,
Felipe Balbi54ab2b02009-10-14 11:44:14 +0300292 /*.suspend = ehci_hcd_omap_suspend, */
293 /*.resume = ehci_hcd_omap_resume, */
294 .driver = {
Alan Stern54a419662013-03-12 12:44:39 +0200295 .name = hcd_name,
Sachin Kamatbe4b08c2013-05-21 17:17:15 +0530296 .of_match_table = omap_ehci_dt_ids,
Felipe Balbi54ab2b02009-10-14 11:44:14 +0300297 }
298};
299
300/*-------------------------------------------------------------------------*/
301
Alan Stern54a419662013-03-12 12:44:39 +0200302static int __init ehci_omap_init(void)
303{
304 if (usb_disabled())
305 return -ENODEV;
Felipe Balbi54ab2b02009-10-14 11:44:14 +0300306
Alan Stern54a419662013-03-12 12:44:39 +0200307 pr_info("%s: " DRIVER_DESC "\n", hcd_name);
Felipe Balbi54ab2b02009-10-14 11:44:14 +0300308
Alan Stern54a419662013-03-12 12:44:39 +0200309 ehci_init_driver(&ehci_omap_hc_driver, &ehci_omap_overrides);
310 return platform_driver_register(&ehci_hcd_omap_driver);
311}
312module_init(ehci_omap_init);
Felipe Balbi54ab2b02009-10-14 11:44:14 +0300313
Alan Stern54a419662013-03-12 12:44:39 +0200314static void __exit ehci_omap_cleanup(void)
315{
316 platform_driver_unregister(&ehci_hcd_omap_driver);
317}
318module_exit(ehci_omap_cleanup);
Felipe Balbi54ab2b02009-10-14 11:44:14 +0300319
Roger Quadros04753522013-02-14 17:08:09 +0200320MODULE_ALIAS("platform:ehci-omap");
Felipe Balbi54ab2b02009-10-14 11:44:14 +0300321MODULE_AUTHOR("Texas Instruments, Inc.");
322MODULE_AUTHOR("Felipe Balbi <felipe.balbi@nokia.com>");
Roger Quadrosa1ae0af2013-03-12 12:44:48 +0200323MODULE_AUTHOR("Roger Quadros <rogerq@ti.com>");
Felipe Balbi54ab2b02009-10-14 11:44:14 +0300324
Alan Stern54a419662013-03-12 12:44:39 +0200325MODULE_DESCRIPTION(DRIVER_DESC);
326MODULE_LICENSE("GPL");