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>
37 #include "musb_core.h"
40 struct omap2430_glue {
42 struct platform_device *musb;
45 #define glue_to_musb(g) platform_get_drvdata(g->musb)
47 static struct timer_list musb_idle_timer;
49 static void musb_do_idle(unsigned long _musb)
51 struct musb *musb = (void *)_musb;
53 #ifdef CONFIG_USB_MUSB_HDRC_HCD
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 #ifdef CONFIG_USB_MUSB_HDRC_HCD
73 case OTG_STATE_A_SUSPEND:
74 /* finish RESUME signaling? */
75 if (musb->port1_status & MUSB_PORT_STAT_RESUME) {
76 power = musb_readb(musb->mregs, MUSB_POWER);
77 power &= ~MUSB_POWER_RESUME;
78 DBG(1, "root port resume stopped, power %02x\n", power);
79 musb_writeb(musb->mregs, MUSB_POWER, power);
81 musb->port1_status &= ~(USB_PORT_STAT_SUSPEND
82 | MUSB_PORT_STAT_RESUME);
83 musb->port1_status |= USB_PORT_STAT_C_SUSPEND << 16;
84 usb_hcd_poll_rh_status(musb_to_hcd(musb));
85 /* NOTE: it might really be A_WAIT_BCON ... */
86 musb->xceiv->state = OTG_STATE_A_HOST;
90 #ifdef CONFIG_USB_MUSB_HDRC_HCD
91 case OTG_STATE_A_HOST:
92 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
93 if (devctl & MUSB_DEVCTL_BDEVICE)
94 musb->xceiv->state = OTG_STATE_B_IDLE;
96 musb->xceiv->state = OTG_STATE_A_WAIT_BCON;
101 spin_unlock_irqrestore(&musb->lock, flags);
105 static void omap2430_musb_try_idle(struct musb *musb, unsigned long timeout)
107 unsigned long default_timeout = jiffies + msecs_to_jiffies(3);
108 static unsigned long last_timer;
111 timeout = default_timeout;
113 /* Never idle if active, or when VBUS timeout is not set as host */
114 if (musb->is_active || ((musb->a_wait_bcon == 0)
115 && (musb->xceiv->state == OTG_STATE_A_WAIT_BCON))) {
116 DBG(4, "%s active, deleting timer\n", otg_state_string(musb));
117 del_timer(&musb_idle_timer);
118 last_timer = jiffies;
122 if (time_after(last_timer, timeout)) {
123 if (!timer_pending(&musb_idle_timer))
124 last_timer = timeout;
126 DBG(4, "Longer idle timer already pending, ignoring\n");
130 last_timer = timeout;
132 DBG(4, "%s inactive, for idle timer for %lu ms\n",
133 otg_state_string(musb),
134 (unsigned long)jiffies_to_msecs(timeout - jiffies));
135 mod_timer(&musb_idle_timer, timeout);
138 static void omap2430_musb_set_vbus(struct musb *musb, int is_on)
141 unsigned long timeout = jiffies + msecs_to_jiffies(1000);
143 /* HDRC controls CPEN, but beware current surges during device
144 * connect. They can trigger transient overcurrent conditions
145 * that must be ignored.
148 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
151 if (musb->xceiv->state == OTG_STATE_A_IDLE) {
152 /* start the session */
153 devctl |= MUSB_DEVCTL_SESSION;
154 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
156 * Wait for the musb to set as A device to enable the
159 while (musb_readb(musb->mregs, MUSB_DEVCTL) & 0x80) {
163 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 DBG(1, "VBUS %s, devctl %02x "
196 /* otg %3x conf %08x prcm %08x */ "\n",
197 otg_state_string(musb),
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);
220 l = musb_readl(musb->mregs, OTG_SYSCONFIG);
221 l |= ENABLEWAKEUP; /* enable wakeup */
222 musb_writel(musb->mregs, OTG_SYSCONFIG, l);
225 static inline void omap2430_low_level_init(struct musb *musb)
229 l = musb_readl(musb->mregs, OTG_SYSCONFIG);
230 l &= ~ENABLEWAKEUP; /* disable wakeup */
231 musb_writel(musb->mregs, OTG_SYSCONFIG, l);
233 l = musb_readl(musb->mregs, OTG_FORCESTDBY);
234 l &= ~ENABLEFORCE; /* disable MSTANDBY */
235 musb_writel(musb->mregs, OTG_FORCESTDBY, l);
238 /* blocking notifier support */
239 static int musb_otg_notifications(struct notifier_block *nb,
240 unsigned long event, void *unused)
242 struct musb *musb = container_of(nb, struct musb, nb);
243 struct device *dev = musb->controller;
244 struct musb_hdrc_platform_data *pdata = dev->platform_data;
245 struct omap_musb_board_data *data = pdata->board_data;
251 if (is_otg_enabled(musb)) {
252 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
253 if (musb->gadget_driver) {
254 otg_init(musb->xceiv);
256 if (data->interface_type ==
258 omap2430_musb_set_vbus(musb, 1);
263 otg_init(musb->xceiv);
264 if (data->interface_type ==
266 omap2430_musb_set_vbus(musb, 1);
271 DBG(4, "VBUS Connect\n");
273 otg_init(musb->xceiv);
277 DBG(4, "VBUS Disconnect\n");
279 if (data->interface_type == MUSB_INTERFACE_UTMI) {
280 if (musb->xceiv->set_vbus)
281 otg_set_vbus(musb->xceiv, 0);
283 otg_shutdown(musb->xceiv);
286 DBG(4, "ID float\n");
293 static int omap2430_musb_init(struct musb *musb)
296 struct device *dev = musb->controller;
297 struct musb_hdrc_platform_data *plat = dev->platform_data;
298 struct omap_musb_board_data *data = plat->board_data;
300 /* We require some kind of external transceiver, hooked
301 * up through ULPI. TWL4030-family PMICs include one,
302 * which needs a driver, drivers aren't always needed.
304 musb->xceiv = otg_get_transceiver();
306 pr_err("HS USB OTG: no transceiver configured\n");
310 omap2430_low_level_init(musb);
312 l = musb_readl(musb->mregs, OTG_SYSCONFIG);
313 l &= ~ENABLEWAKEUP; /* disable wakeup */
314 l &= ~NOSTDBY; /* remove possible nostdby */
315 l |= SMARTSTDBY; /* enable smart standby */
316 l &= ~AUTOIDLE; /* disable auto idle */
317 l &= ~NOIDLE; /* remove possible noidle */
318 l |= SMARTIDLE; /* enable smart idle */
320 * MUSB AUTOIDLE don't work in 3430.
321 * Workaround by Richard Woodruff/TI
323 if (!cpu_is_omap3430())
324 l |= AUTOIDLE; /* enable auto idle */
325 musb_writel(musb->mregs, OTG_SYSCONFIG, l);
327 l = musb_readl(musb->mregs, OTG_INTERFSEL);
329 if (data->interface_type == MUSB_INTERFACE_UTMI) {
330 /* OMAP4 uses Internal PHY GS70 which uses UTMI interface */
331 l &= ~ULPI_12PIN; /* Disable ULPI */
332 l |= UTMI_8BIT; /* Enable UTMI */
337 musb_writel(musb->mregs, OTG_INTERFSEL, l);
339 pr_debug("HS USB OTG: revision 0x%x, sysconfig 0x%02x, "
340 "sysstatus 0x%x, intrfsel 0x%x, simenable 0x%x\n",
341 musb_readl(musb->mregs, OTG_REVISION),
342 musb_readl(musb->mregs, OTG_SYSCONFIG),
343 musb_readl(musb->mregs, OTG_SYSSTATUS),
344 musb_readl(musb->mregs, OTG_INTERFSEL),
345 musb_readl(musb->mregs, OTG_SIMENABLE));
347 musb->nb.notifier_call = musb_otg_notifications;
348 status = otg_register_notifier(musb->xceiv, &musb->nb);
351 DBG(1, "notification register failed\n");
353 /* check whether cable is already connected */
354 if (musb->xceiv->state ==OTG_STATE_B_IDLE)
355 musb_otg_notifications(&musb->nb, 1,
356 musb->xceiv->gadget);
358 setup_timer(&musb_idle_timer, musb_do_idle, (unsigned long) musb);
363 static int omap2430_musb_exit(struct musb *musb)
365 del_timer_sync(&musb_idle_timer);
367 omap2430_low_level_exit(musb);
368 otg_put_transceiver(musb->xceiv);
373 static const struct musb_platform_ops omap2430_ops = {
374 .init = omap2430_musb_init,
375 .exit = omap2430_musb_exit,
377 .set_mode = omap2430_musb_set_mode,
378 .try_idle = omap2430_musb_try_idle,
380 .set_vbus = omap2430_musb_set_vbus,
383 static u64 omap2430_dmamask = DMA_BIT_MASK(32);
385 static int __init omap2430_probe(struct platform_device *pdev)
387 struct musb_hdrc_platform_data *pdata = pdev->dev.platform_data;
388 struct platform_device *musb;
389 struct omap2430_glue *glue;
394 glue = kzalloc(sizeof(*glue), GFP_KERNEL);
396 dev_err(&pdev->dev, "failed to allocate glue context\n");
400 musb = platform_device_alloc("musb-hdrc", -1);
402 dev_err(&pdev->dev, "failed to allocate musb device\n");
406 clk = clk_get(&pdev->dev, "ick");
408 dev_err(&pdev->dev, "failed to get clock\n");
413 ret = clk_enable(clk);
415 dev_err(&pdev->dev, "failed to enable clock\n");
419 musb->dev.parent = &pdev->dev;
420 musb->dev.dma_mask = &omap2430_dmamask;
421 musb->dev.coherent_dma_mask = omap2430_dmamask;
423 glue->dev = &pdev->dev;
427 pdata->platform_ops = &omap2430_ops;
429 platform_set_drvdata(pdev, glue);
431 ret = platform_device_add_resources(musb, pdev->resource,
432 pdev->num_resources);
434 dev_err(&pdev->dev, "failed to add resources\n");
438 ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
440 dev_err(&pdev->dev, "failed to add platform_data\n");
444 ret = platform_device_add(musb);
446 dev_err(&pdev->dev, "failed to register musb device\n");
459 platform_device_put(musb);
468 static int __exit omap2430_remove(struct platform_device *pdev)
470 struct omap2430_glue *glue = platform_get_drvdata(pdev);
472 platform_device_del(glue->musb);
473 platform_device_put(glue->musb);
474 clk_disable(glue->clk);
482 static void omap2430_save_context(struct musb *musb)
484 musb->context.otg_sysconfig = musb_readl(musb->mregs, OTG_SYSCONFIG);
485 musb->context.otg_forcestandby = musb_readl(musb->mregs, OTG_FORCESTDBY);
488 static void omap2430_restore_context(struct musb *musb)
490 musb_writel(musb->mregs, OTG_SYSCONFIG, musb->context.otg_sysconfig);
491 musb_writel(musb->mregs, OTG_FORCESTDBY, musb->context.otg_forcestandby);
494 static int omap2430_suspend(struct device *dev)
496 struct omap2430_glue *glue = dev_get_drvdata(dev);
497 struct musb *musb = glue_to_musb(glue);
499 omap2430_low_level_exit(musb);
500 otg_set_suspend(musb->xceiv, 1);
501 omap2430_save_context(musb);
502 clk_disable(glue->clk);
507 static int omap2430_resume(struct device *dev)
509 struct omap2430_glue *glue = dev_get_drvdata(dev);
510 struct musb *musb = glue_to_musb(glue);
513 ret = clk_enable(glue->clk);
515 dev_err(dev, "faled to enable clock\n");
519 omap2430_low_level_init(musb);
520 omap2430_restore_context(musb);
521 otg_set_suspend(musb->xceiv, 0);
526 static struct dev_pm_ops omap2430_pm_ops = {
527 .suspend = omap2430_suspend,
528 .resume = omap2430_resume,
531 #define DEV_PM_OPS (&omap2430_pm_ops)
533 #define DEV_PM_OPS NULL
536 static struct platform_driver omap2430_driver = {
537 .remove = __exit_p(omap2430_remove),
539 .name = "musb-omap2430",
544 MODULE_DESCRIPTION("OMAP2PLUS MUSB Glue Layer");
545 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
546 MODULE_LICENSE("GPL v2");
548 static int __init omap2430_init(void)
550 return platform_driver_probe(&omap2430_driver, omap2430_probe);
552 subsys_initcall(omap2430_init);
554 static void __exit omap2430_exit(void)
556 platform_driver_unregister(&omap2430_driver);
558 module_exit(omap2430_exit);