2 * Copyright (C) 2005-2007 by Texas Instruments
3 * Some code has been taken from tusb6010.c
4 * Copyrights for that are attributable to:
5 * Copyright (C) 2006 Nokia Corporation
6 * Tony Lindgren <tony@atomide.com>
8 * This file is part of the Inventra Controller Driver for Linux.
10 * The Inventra Controller Driver for Linux is free software; you
11 * can redistribute it and/or modify it under the terms of the GNU
12 * General Public License version 2 as published by the Free Software
15 * The Inventra Controller Driver for Linux is distributed in
16 * the hope that it will be useful, but WITHOUT ANY WARRANTY;
17 * without even the implied warranty of MERCHANTABILITY or
18 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
19 * License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with The Inventra Controller Driver for Linux ; if not,
23 * write to the Free Software Foundation, Inc., 59 Temple Place,
24 * Suite 330, Boston, MA 02111-1307 USA
27 #include <linux/module.h>
28 #include <linux/kernel.h>
29 #include <linux/sched.h>
30 #include <linux/init.h>
31 #include <linux/list.h>
32 #include <linux/clk.h>
34 #include <linux/platform_device.h>
35 #include <linux/dma-mapping.h>
36 #include <linux/pm_runtime.h>
37 #include <linux/err.h>
38 #include <linux/delay.h>
40 #include "musb_core.h"
43 struct omap2430_glue {
45 struct platform_device *musb;
47 #define glue_to_musb(g) platform_get_drvdata(g->musb)
49 static struct timer_list musb_idle_timer;
51 static void musb_do_idle(unsigned long _musb)
53 struct musb *musb = (void *)_musb;
58 spin_lock_irqsave(&musb->lock, flags);
60 switch (musb->xceiv->state) {
61 case OTG_STATE_A_WAIT_BCON:
63 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
64 if (devctl & MUSB_DEVCTL_BDEVICE) {
65 musb->xceiv->state = OTG_STATE_B_IDLE;
68 musb->xceiv->state = OTG_STATE_A_IDLE;
72 case OTG_STATE_A_SUSPEND:
73 /* finish RESUME signaling? */
74 if (musb->port1_status & MUSB_PORT_STAT_RESUME) {
75 power = musb_readb(musb->mregs, MUSB_POWER);
76 power &= ~MUSB_POWER_RESUME;
77 dev_dbg(musb->controller, "root port resume stopped, power %02x\n", power);
78 musb_writeb(musb->mregs, MUSB_POWER, power);
80 musb->port1_status &= ~(USB_PORT_STAT_SUSPEND
81 | MUSB_PORT_STAT_RESUME);
82 musb->port1_status |= USB_PORT_STAT_C_SUSPEND << 16;
83 usb_hcd_poll_rh_status(musb_to_hcd(musb));
84 /* NOTE: it might really be A_WAIT_BCON ... */
85 musb->xceiv->state = OTG_STATE_A_HOST;
88 case OTG_STATE_A_HOST:
89 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
90 if (devctl & MUSB_DEVCTL_BDEVICE)
91 musb->xceiv->state = OTG_STATE_B_IDLE;
93 musb->xceiv->state = OTG_STATE_A_WAIT_BCON;
97 spin_unlock_irqrestore(&musb->lock, flags);
101 static void omap2430_musb_try_idle(struct musb *musb, unsigned long timeout)
103 unsigned long default_timeout = jiffies + msecs_to_jiffies(3);
104 static unsigned long last_timer;
107 timeout = default_timeout;
109 /* Never idle if active, or when VBUS timeout is not set as host */
110 if (musb->is_active || ((musb->a_wait_bcon == 0)
111 && (musb->xceiv->state == OTG_STATE_A_WAIT_BCON))) {
112 dev_dbg(musb->controller, "%s active, deleting timer\n",
113 otg_state_string(musb->xceiv->state));
114 del_timer(&musb_idle_timer);
115 last_timer = jiffies;
119 if (time_after(last_timer, timeout)) {
120 if (!timer_pending(&musb_idle_timer))
121 last_timer = timeout;
123 dev_dbg(musb->controller, "Longer idle timer already pending, ignoring\n");
127 last_timer = timeout;
129 dev_dbg(musb->controller, "%s inactive, for idle timer for %lu ms\n",
130 otg_state_string(musb->xceiv->state),
131 (unsigned long)jiffies_to_msecs(timeout - jiffies));
132 mod_timer(&musb_idle_timer, timeout);
135 static void omap2430_musb_set_vbus(struct musb *musb, int is_on)
138 unsigned long timeout = jiffies + msecs_to_jiffies(1000);
140 /* HDRC controls CPEN, but beware current surges during device
141 * connect. They can trigger transient overcurrent conditions
142 * that must be ignored.
145 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
148 if (musb->xceiv->state == OTG_STATE_A_IDLE) {
150 /* start the session */
151 devctl |= MUSB_DEVCTL_SESSION;
152 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
154 * Wait for the musb to set as A device to enable the
157 while (musb_readb(musb->mregs, MUSB_DEVCTL) & 0x80) {
162 if (time_after(jiffies, timeout)
164 dev_err(musb->controller,
165 "configured as A device timeout");
171 if (ret && musb->xceiv->set_vbus)
172 otg_set_vbus(musb->xceiv, 1);
175 musb->xceiv->default_a = 1;
176 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
177 devctl |= MUSB_DEVCTL_SESSION;
183 /* NOTE: we're skipping A_WAIT_VFALL -> A_IDLE and
184 * jumping right to B_IDLE...
187 musb->xceiv->default_a = 0;
188 musb->xceiv->state = OTG_STATE_B_IDLE;
189 devctl &= ~MUSB_DEVCTL_SESSION;
193 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
195 dev_dbg(musb->controller, "VBUS %s, devctl %02x "
196 /* otg %3x conf %08x prcm %08x */ "\n",
197 otg_state_string(musb->xceiv->state),
198 musb_readb(musb->mregs, MUSB_DEVCTL));
201 static int omap2430_musb_set_mode(struct musb *musb, u8 musb_mode)
203 u8 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
205 devctl |= MUSB_DEVCTL_SESSION;
206 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
211 static inline void omap2430_low_level_exit(struct musb *musb)
216 l = musb_readl(musb->mregs, OTG_FORCESTDBY);
217 l |= ENABLEFORCE; /* enable MSTANDBY */
218 musb_writel(musb->mregs, OTG_FORCESTDBY, l);
221 static inline void omap2430_low_level_init(struct musb *musb)
225 l = musb_readl(musb->mregs, OTG_FORCESTDBY);
226 l &= ~ENABLEFORCE; /* disable MSTANDBY */
227 musb_writel(musb->mregs, OTG_FORCESTDBY, l);
230 /* blocking notifier support */
231 static int musb_otg_notifications(struct notifier_block *nb,
232 unsigned long event, void *unused)
234 struct musb *musb = container_of(nb, struct musb, nb);
235 struct device *dev = musb->controller;
236 struct musb_hdrc_platform_data *pdata = dev->platform_data;
237 struct omap_musb_board_data *data = pdata->board_data;
241 dev_dbg(musb->controller, "ID GND\n");
243 if (is_otg_enabled(musb)) {
244 if (musb->gadget_driver) {
245 pm_runtime_get_sync(musb->controller);
246 otg_init(musb->xceiv);
247 omap2430_musb_set_vbus(musb, 1);
250 pm_runtime_get_sync(musb->controller);
251 otg_init(musb->xceiv);
252 omap2430_musb_set_vbus(musb, 1);
257 dev_dbg(musb->controller, "VBUS Connect\n");
259 if (musb->gadget_driver)
260 pm_runtime_get_sync(musb->controller);
261 otg_init(musb->xceiv);
265 dev_dbg(musb->controller, "VBUS Disconnect\n");
267 if (is_otg_enabled(musb) || is_peripheral_enabled(musb))
268 if (musb->gadget_driver) {
269 omap2430_musb_set_vbus(musb, 0);
271 pm_runtime_mark_last_busy(musb->controller);
272 pm_runtime_put_autosuspend(musb->controller);
275 if (data->interface_type == MUSB_INTERFACE_UTMI) {
276 if (musb->xceiv->set_vbus)
277 otg_set_vbus(musb->xceiv, 0);
279 otg_shutdown(musb->xceiv);
282 dev_dbg(musb->controller, "ID float\n");
289 static int omap2430_musb_init(struct musb *musb)
293 struct device *dev = musb->controller;
294 struct musb_hdrc_platform_data *plat = dev->platform_data;
295 struct omap_musb_board_data *data = plat->board_data;
297 /* We require some kind of external transceiver, hooked
298 * up through ULPI. TWL4030-family PMICs include one,
299 * which needs a driver, drivers aren't always needed.
301 musb->xceiv = otg_get_transceiver();
303 pr_err("HS USB OTG: no transceiver configured\n");
307 status = pm_runtime_get_sync(dev);
309 dev_err(dev, "pm_runtime_get_sync FAILED %d\n", status);
313 l = musb_readl(musb->mregs, OTG_INTERFSEL);
315 if (data->interface_type == MUSB_INTERFACE_UTMI) {
316 /* OMAP4 uses Internal PHY GS70 which uses UTMI interface */
317 l &= ~ULPI_12PIN; /* Disable ULPI */
318 l |= UTMI_8BIT; /* Enable UTMI */
323 musb_writel(musb->mregs, OTG_INTERFSEL, l);
325 pr_debug("HS USB OTG: revision 0x%x, sysconfig 0x%02x, "
326 "sysstatus 0x%x, intrfsel 0x%x, simenable 0x%x\n",
327 musb_readl(musb->mregs, OTG_REVISION),
328 musb_readl(musb->mregs, OTG_SYSCONFIG),
329 musb_readl(musb->mregs, OTG_SYSSTATUS),
330 musb_readl(musb->mregs, OTG_INTERFSEL),
331 musb_readl(musb->mregs, OTG_SIMENABLE));
333 musb->nb.notifier_call = musb_otg_notifications;
334 status = otg_register_notifier(musb->xceiv, &musb->nb);
337 dev_dbg(musb->controller, "notification register failed\n");
339 setup_timer(&musb_idle_timer, musb_do_idle, (unsigned long) musb);
344 pm_runtime_disable(dev);
348 static void omap2430_musb_enable(struct musb *musb)
351 unsigned long timeout = jiffies + msecs_to_jiffies(1000);
352 struct device *dev = musb->controller;
353 struct musb_hdrc_platform_data *pdata = dev->platform_data;
354 struct omap_musb_board_data *data = pdata->board_data;
356 switch (musb->xceiv->last_event) {
359 otg_init(musb->xceiv);
360 if (data->interface_type == MUSB_INTERFACE_UTMI) {
361 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
362 /* start the session */
363 devctl |= MUSB_DEVCTL_SESSION;
364 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
365 while (musb_readb(musb->mregs, MUSB_DEVCTL) &
366 MUSB_DEVCTL_BDEVICE) {
369 if (time_after(jiffies, timeout)) {
370 dev_err(musb->controller,
371 "configured as A device timeout");
379 otg_init(musb->xceiv);
387 static void omap2430_musb_disable(struct musb *musb)
389 if (musb->xceiv->last_event)
390 otg_shutdown(musb->xceiv);
393 static int omap2430_musb_exit(struct musb *musb)
395 del_timer_sync(&musb_idle_timer);
397 omap2430_low_level_exit(musb);
398 otg_put_transceiver(musb->xceiv);
403 static const struct musb_platform_ops omap2430_ops = {
404 .init = omap2430_musb_init,
405 .exit = omap2430_musb_exit,
407 .set_mode = omap2430_musb_set_mode,
408 .try_idle = omap2430_musb_try_idle,
410 .set_vbus = omap2430_musb_set_vbus,
412 .enable = omap2430_musb_enable,
413 .disable = omap2430_musb_disable,
416 static u64 omap2430_dmamask = DMA_BIT_MASK(32);
418 static int __init omap2430_probe(struct platform_device *pdev)
420 struct musb_hdrc_platform_data *pdata = pdev->dev.platform_data;
421 struct platform_device *musb;
422 struct omap2430_glue *glue;
425 glue = kzalloc(sizeof(*glue), GFP_KERNEL);
427 dev_err(&pdev->dev, "failed to allocate glue context\n");
431 musb = platform_device_alloc("musb-hdrc", -1);
433 dev_err(&pdev->dev, "failed to allocate musb device\n");
437 musb->dev.parent = &pdev->dev;
438 musb->dev.dma_mask = &omap2430_dmamask;
439 musb->dev.coherent_dma_mask = omap2430_dmamask;
441 glue->dev = &pdev->dev;
444 pdata->platform_ops = &omap2430_ops;
446 platform_set_drvdata(pdev, glue);
448 ret = platform_device_add_resources(musb, pdev->resource,
449 pdev->num_resources);
451 dev_err(&pdev->dev, "failed to add resources\n");
455 ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
457 dev_err(&pdev->dev, "failed to add platform_data\n");
461 pm_runtime_enable(&pdev->dev);
463 ret = platform_device_add(musb);
465 dev_err(&pdev->dev, "failed to register musb device\n");
472 platform_device_put(musb);
481 static int __exit omap2430_remove(struct platform_device *pdev)
483 struct omap2430_glue *glue = platform_get_drvdata(pdev);
485 platform_device_del(glue->musb);
486 platform_device_put(glue->musb);
487 pm_runtime_put(&pdev->dev);
488 pm_runtime_disable(&pdev->dev);
496 static int omap2430_runtime_suspend(struct device *dev)
498 struct omap2430_glue *glue = dev_get_drvdata(dev);
499 struct musb *musb = glue_to_musb(glue);
501 musb->context.otg_interfsel = musb_readl(musb->mregs,
504 omap2430_low_level_exit(musb);
505 otg_set_suspend(musb->xceiv, 1);
510 static int omap2430_runtime_resume(struct device *dev)
512 struct omap2430_glue *glue = dev_get_drvdata(dev);
513 struct musb *musb = glue_to_musb(glue);
515 omap2430_low_level_init(musb);
516 if (musb->context.otg_interfsel != 0)
517 musb_writel(musb->mregs, OTG_INTERFSEL,
518 musb->context.otg_interfsel);
520 otg_set_suspend(musb->xceiv, 0);
525 static struct dev_pm_ops omap2430_pm_ops = {
526 .runtime_suspend = omap2430_runtime_suspend,
527 .runtime_resume = omap2430_runtime_resume,
530 #define DEV_PM_OPS (&omap2430_pm_ops)
532 #define DEV_PM_OPS NULL
535 static struct platform_driver omap2430_driver = {
536 .remove = __exit_p(omap2430_remove),
538 .name = "musb-omap2430",
543 MODULE_DESCRIPTION("OMAP2PLUS MUSB Glue Layer");
544 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
545 MODULE_LICENSE("GPL v2");
547 static int __init omap2430_init(void)
549 return platform_driver_probe(&omap2430_driver, omap2430_probe);
551 subsys_initcall(omap2430_init);
553 static void __exit omap2430_exit(void)
555 platform_driver_unregister(&omap2430_driver);
557 module_exit(omap2430_exit);