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 * SPDX-License-Identifier: GPL-2.0
13 #include <linux/module.h>
14 #include <linux/kernel.h>
15 #include <linux/sched.h>
16 #include <linux/init.h>
17 #include <linux/list.h>
19 #include <linux/platform_device.h>
20 #include <linux/dma-mapping.h>
21 #include <linux/pm_runtime.h>
22 #include <linux/err.h>
23 #include <linux/usb/musb-omap.h>
26 #include <asm/omap_common.h>
27 #include <asm/omap_musb.h>
30 #include "linux-compat.h"
33 #include "musb_core.h"
37 struct omap2430_glue {
39 struct platform_device *musb;
40 enum omap_musb_vbus_id_status status;
41 struct work_struct omap_musb_mailbox_work;
43 #define glue_to_musb(g) platform_get_drvdata(g->musb)
45 struct omap2430_glue *_glue;
47 static struct timer_list musb_idle_timer;
49 static void musb_do_idle(unsigned long _musb)
51 struct musb *musb = (void *)_musb;
56 spin_lock_irqsave(&musb->lock, flags);
58 switch (musb->xceiv->state) {
59 case OTG_STATE_A_WAIT_BCON:
61 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
62 if (devctl & MUSB_DEVCTL_BDEVICE) {
63 musb->xceiv->state = OTG_STATE_B_IDLE;
66 musb->xceiv->state = OTG_STATE_A_IDLE;
70 case OTG_STATE_A_SUSPEND:
71 /* finish RESUME signaling? */
72 if (musb->port1_status & MUSB_PORT_STAT_RESUME) {
73 power = musb_readb(musb->mregs, MUSB_POWER);
74 power &= ~MUSB_POWER_RESUME;
75 dev_dbg(musb->controller, "root port resume stopped, power %02x\n", power);
76 musb_writeb(musb->mregs, MUSB_POWER, power);
78 musb->port1_status &= ~(USB_PORT_STAT_SUSPEND
79 | MUSB_PORT_STAT_RESUME);
80 musb->port1_status |= USB_PORT_STAT_C_SUSPEND << 16;
81 usb_hcd_poll_rh_status(musb_to_hcd(musb));
82 /* NOTE: it might really be A_WAIT_BCON ... */
83 musb->xceiv->state = OTG_STATE_A_HOST;
86 case OTG_STATE_A_HOST:
87 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
88 if (devctl & MUSB_DEVCTL_BDEVICE)
89 musb->xceiv->state = OTG_STATE_B_IDLE;
91 musb->xceiv->state = OTG_STATE_A_WAIT_BCON;
95 spin_unlock_irqrestore(&musb->lock, flags);
99 static void omap2430_musb_try_idle(struct musb *musb, unsigned long timeout)
101 unsigned long default_timeout = jiffies + msecs_to_jiffies(3);
102 static unsigned long last_timer;
105 timeout = default_timeout;
107 /* Never idle if active, or when VBUS timeout is not set as host */
108 if (musb->is_active || ((musb->a_wait_bcon == 0)
109 && (musb->xceiv->state == OTG_STATE_A_WAIT_BCON))) {
110 dev_dbg(musb->controller, "%s active, deleting timer\n",
111 otg_state_string(musb->xceiv->state));
112 del_timer(&musb_idle_timer);
113 last_timer = jiffies;
117 if (time_after(last_timer, timeout)) {
118 if (!timer_pending(&musb_idle_timer))
119 last_timer = timeout;
121 dev_dbg(musb->controller, "Longer idle timer already pending, ignoring\n");
125 last_timer = timeout;
127 dev_dbg(musb->controller, "%s inactive, for idle timer for %lu ms\n",
128 otg_state_string(musb->xceiv->state),
129 (unsigned long)jiffies_to_msecs(timeout - jiffies));
130 mod_timer(&musb_idle_timer, timeout);
133 static void omap2430_musb_set_vbus(struct musb *musb, int is_on)
135 struct usb_otg *otg = musb->xceiv->otg;
137 unsigned long timeout = jiffies + msecs_to_jiffies(1000);
139 /* HDRC controls CPEN, but beware current surges during device
140 * connect. They can trigger transient overcurrent conditions
141 * that must be ignored.
144 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
147 if (musb->xceiv->state == OTG_STATE_A_IDLE) {
148 /* start the session */
149 devctl |= MUSB_DEVCTL_SESSION;
150 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
152 * Wait for the musb to set as A device to enable the
155 while (musb_readb(musb->mregs, MUSB_DEVCTL) & 0x80) {
159 if (time_after(jiffies, timeout)) {
160 dev_err(musb->controller,
161 "configured as A device timeout");
167 if (ret && otg->set_vbus)
168 otg_set_vbus(otg, 1);
172 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
173 devctl |= MUSB_DEVCTL_SESSION;
179 /* NOTE: we're skipping A_WAIT_VFALL -> A_IDLE and
180 * jumping right to B_IDLE...
184 musb->xceiv->state = OTG_STATE_B_IDLE;
185 devctl &= ~MUSB_DEVCTL_SESSION;
189 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
191 dev_dbg(musb->controller, "VBUS %s, devctl %02x "
192 /* otg %3x conf %08x prcm %08x */ "\n",
193 otg_state_string(musb->xceiv->state),
194 musb_readb(musb->mregs, MUSB_DEVCTL));
197 static int omap2430_musb_set_mode(struct musb *musb, u8 musb_mode)
199 u8 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
201 devctl |= MUSB_DEVCTL_SESSION;
202 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
208 static inline void omap2430_low_level_exit(struct musb *musb)
213 l = musb_readl(musb->mregs, OTG_FORCESTDBY);
214 l |= ENABLEFORCE; /* enable MSTANDBY */
215 musb_writel(musb->mregs, OTG_FORCESTDBY, l);
218 static inline void omap2430_low_level_init(struct musb *musb)
222 l = musb_readl(musb->mregs, OTG_FORCESTDBY);
223 l &= ~ENABLEFORCE; /* disable MSTANDBY */
224 musb_writel(musb->mregs, OTG_FORCESTDBY, l);
228 void omap_musb_mailbox(enum omap_musb_vbus_id_status status)
230 struct omap2430_glue *glue = _glue;
231 struct musb *musb = glue_to_musb(glue);
233 glue->status = status;
235 dev_err(glue->dev, "musb core is not yet ready\n");
239 schedule_work(&glue->omap_musb_mailbox_work);
241 EXPORT_SYMBOL_GPL(omap_musb_mailbox);
243 static void omap_musb_set_mailbox(struct omap2430_glue *glue)
245 struct musb *musb = glue_to_musb(glue);
246 struct device *dev = musb->controller;
247 struct musb_hdrc_platform_data *pdata = dev->platform_data;
248 struct omap_musb_board_data *data = pdata->board_data;
249 struct usb_otg *otg = musb->xceiv->otg;
251 switch (glue->status) {
252 case OMAP_MUSB_ID_GROUND:
253 dev_dbg(dev, "ID GND\n");
255 otg->default_a = true;
256 musb->xceiv->state = OTG_STATE_A_IDLE;
257 musb->xceiv->last_event = USB_EVENT_ID;
258 if (!is_otg_enabled(musb) || musb->gadget_driver) {
259 pm_runtime_get_sync(dev);
260 usb_phy_init(musb->xceiv);
261 omap2430_musb_set_vbus(musb, 1);
265 case OMAP_MUSB_VBUS_VALID:
266 dev_dbg(dev, "VBUS Connect\n");
268 otg->default_a = false;
269 musb->xceiv->state = OTG_STATE_B_IDLE;
270 musb->xceiv->last_event = USB_EVENT_VBUS;
271 if (musb->gadget_driver)
272 pm_runtime_get_sync(dev);
273 usb_phy_init(musb->xceiv);
276 case OMAP_MUSB_ID_FLOAT:
277 case OMAP_MUSB_VBUS_OFF:
278 dev_dbg(dev, "VBUS Disconnect\n");
280 musb->xceiv->last_event = USB_EVENT_NONE;
281 if (is_otg_enabled(musb) || is_peripheral_enabled(musb))
282 if (musb->gadget_driver) {
283 pm_runtime_mark_last_busy(dev);
284 pm_runtime_put_autosuspend(dev);
287 if (data->interface_type == MUSB_INTERFACE_UTMI) {
288 if (musb->xceiv->otg->set_vbus)
289 otg_set_vbus(musb->xceiv->otg, 0);
291 usb_phy_shutdown(musb->xceiv);
294 dev_dbg(dev, "ID float\n");
299 static void omap_musb_mailbox_work(struct work_struct *mailbox_work)
301 struct omap2430_glue *glue = container_of(mailbox_work,
302 struct omap2430_glue, omap_musb_mailbox_work);
303 omap_musb_set_mailbox(glue);
307 static int omap2430_musb_init(struct musb *musb)
311 unsigned long int start;
313 struct device *dev = musb->controller;
314 struct omap2430_glue *glue = dev_get_drvdata(dev->parent);
315 struct musb_hdrc_platform_data *plat = dev->platform_data;
316 struct omap_musb_board_data *data = plat->board_data;
318 struct omap_musb_board_data *data =
319 (struct omap_musb_board_data *)musb->controller;
322 /* Reset the controller */
323 musb_writel(musb->mregs, OTG_SYSCONFIG, SOFTRST);
325 start = get_timer(0);
328 l = musb_readl(musb->mregs, OTG_SYSCONFIG);
329 if ((l & SOFTRST) == 0)
332 if (get_timer(start) > (CONFIG_SYS_HZ / 1000)) {
333 dev_err(musb->controller, "MUSB reset is taking too long\n");
339 /* We require some kind of external transceiver, hooked
340 * up through ULPI. TWL4030-family PMICs include one,
341 * which needs a driver, drivers aren't always needed.
343 musb->xceiv = devm_usb_get_phy(dev, USB_PHY_TYPE_USB2);
344 if (IS_ERR_OR_NULL(musb->xceiv)) {
345 pr_err("HS USB OTG: no transceiver configured\n");
349 status = pm_runtime_get_sync(dev);
351 dev_err(dev, "pm_runtime_get_sync FAILED %d\n", status);
356 l = musb_readl(musb->mregs, OTG_INTERFSEL);
358 if (data->interface_type == MUSB_INTERFACE_UTMI) {
359 /* OMAP4 uses Internal PHY GS70 which uses UTMI interface */
360 l &= ~ULPI_12PIN; /* Disable ULPI */
361 l |= UTMI_8BIT; /* Enable UTMI */
366 musb_writel(musb->mregs, OTG_INTERFSEL, l);
368 pr_debug("HS USB OTG: revision 0x%x, sysconfig 0x%02x, "
369 "sysstatus 0x%x, intrfsel 0x%x, simenable 0x%x\n",
370 musb_readl(musb->mregs, OTG_REVISION),
371 musb_readl(musb->mregs, OTG_SYSCONFIG),
372 musb_readl(musb->mregs, OTG_SYSSTATUS),
373 musb_readl(musb->mregs, OTG_INTERFSEL),
374 musb_readl(musb->mregs, OTG_SIMENABLE));
377 setup_timer(&musb_idle_timer, musb_do_idle, (unsigned long) musb);
379 if (glue->status != OMAP_MUSB_UNKNOWN)
380 omap_musb_set_mailbox(glue);
382 pm_runtime_put_noidle(musb->controller);
391 static void omap2430_musb_enable(struct musb *musb)
393 static int omap2430_musb_enable(struct musb *musb)
398 unsigned long timeout = jiffies + msecs_to_jiffies(1000);
399 struct device *dev = musb->controller;
400 struct omap2430_glue *glue = dev_get_drvdata(dev->parent);
401 struct musb_hdrc_platform_data *pdata = dev->platform_data;
402 struct omap_musb_board_data *data = pdata->board_data;
404 switch (glue->status) {
406 case OMAP_MUSB_ID_GROUND:
407 usb_phy_init(musb->xceiv);
408 if (data->interface_type != MUSB_INTERFACE_UTMI)
410 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
411 /* start the session */
412 devctl |= MUSB_DEVCTL_SESSION;
413 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
414 while (musb_readb(musb->mregs, MUSB_DEVCTL) &
415 MUSB_DEVCTL_BDEVICE) {
418 if (time_after(jiffies, timeout)) {
419 dev_err(dev, "configured as A device timeout");
425 case OMAP_MUSB_VBUS_VALID:
426 usb_phy_init(musb->xceiv);
433 #ifdef CONFIG_TWL4030_USB
434 if (twl4030_usb_ulpi_init()) {
435 serial_printf("ERROR: %s Could not initialize PHY\n",
436 __PRETTY_FUNCTION__);
440 #ifdef CONFIG_TWL6030_POWER
441 twl6030_usb_device_settings();
444 #ifdef CONFIG_OMAP44XX
445 u32 *usbotghs_control = (u32 *)((*ctrl)->control_usbotghs_ctrl);
446 *usbotghs_control = USBOTGHS_CONTROL_AVALID |
447 USBOTGHS_CONTROL_VBUSVALID | USBOTGHS_CONTROL_IDDIG;
454 static void omap2430_musb_disable(struct musb *musb)
457 struct device *dev = musb->controller;
458 struct omap2430_glue *glue = dev_get_drvdata(dev->parent);
460 if (glue->status != OMAP_MUSB_UNKNOWN)
461 usb_phy_shutdown(musb->xceiv);
465 static int omap2430_musb_exit(struct musb *musb)
467 del_timer_sync(&musb_idle_timer);
469 omap2430_low_level_exit(musb);
475 static const struct musb_platform_ops omap2430_ops = {
477 const struct musb_platform_ops omap2430_ops = {
479 .init = omap2430_musb_init,
480 .exit = omap2430_musb_exit,
483 .set_mode = omap2430_musb_set_mode,
484 .try_idle = omap2430_musb_try_idle,
486 .set_vbus = omap2430_musb_set_vbus,
489 .enable = omap2430_musb_enable,
490 .disable = omap2430_musb_disable,
494 static u64 omap2430_dmamask = DMA_BIT_MASK(32);
496 static int __devinit omap2430_probe(struct platform_device *pdev)
498 struct musb_hdrc_platform_data *pdata = pdev->dev.platform_data;
499 struct platform_device *musb;
500 struct omap2430_glue *glue;
503 glue = devm_kzalloc(&pdev->dev, sizeof(*glue), GFP_KERNEL);
505 dev_err(&pdev->dev, "failed to allocate glue context\n");
509 musb = platform_device_alloc("musb-hdrc", -1);
511 dev_err(&pdev->dev, "failed to allocate musb device\n");
515 musb->dev.parent = &pdev->dev;
516 musb->dev.dma_mask = &omap2430_dmamask;
517 musb->dev.coherent_dma_mask = omap2430_dmamask;
519 glue->dev = &pdev->dev;
521 glue->status = OMAP_MUSB_UNKNOWN;
523 pdata->platform_ops = &omap2430_ops;
525 platform_set_drvdata(pdev, glue);
528 * REVISIT if we ever have two instances of the wrapper, we will be
533 INIT_WORK(&glue->omap_musb_mailbox_work, omap_musb_mailbox_work);
535 ret = platform_device_add_resources(musb, pdev->resource,
536 pdev->num_resources);
538 dev_err(&pdev->dev, "failed to add resources\n");
542 ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
544 dev_err(&pdev->dev, "failed to add platform_data\n");
548 pm_runtime_enable(&pdev->dev);
550 ret = platform_device_add(musb);
552 dev_err(&pdev->dev, "failed to register musb device\n");
559 platform_device_put(musb);
565 static int __devexit omap2430_remove(struct platform_device *pdev)
567 struct omap2430_glue *glue = platform_get_drvdata(pdev);
569 cancel_work_sync(&glue->omap_musb_mailbox_work);
570 platform_device_del(glue->musb);
571 platform_device_put(glue->musb);
578 static int omap2430_runtime_suspend(struct device *dev)
580 struct omap2430_glue *glue = dev_get_drvdata(dev);
581 struct musb *musb = glue_to_musb(glue);
584 musb->context.otg_interfsel = musb_readl(musb->mregs,
587 omap2430_low_level_exit(musb);
588 usb_phy_set_suspend(musb->xceiv, 1);
594 static int omap2430_runtime_resume(struct device *dev)
596 struct omap2430_glue *glue = dev_get_drvdata(dev);
597 struct musb *musb = glue_to_musb(glue);
600 omap2430_low_level_init(musb);
601 musb_writel(musb->mregs, OTG_INTERFSEL,
602 musb->context.otg_interfsel);
604 usb_phy_set_suspend(musb->xceiv, 0);
610 static struct dev_pm_ops omap2430_pm_ops = {
611 .runtime_suspend = omap2430_runtime_suspend,
612 .runtime_resume = omap2430_runtime_resume,
615 #define DEV_PM_OPS (&omap2430_pm_ops)
617 #define DEV_PM_OPS NULL
620 static struct platform_driver omap2430_driver = {
621 .probe = omap2430_probe,
622 .remove = __devexit_p(omap2430_remove),
624 .name = "musb-omap2430",
629 MODULE_DESCRIPTION("OMAP2PLUS MUSB Glue Layer");
630 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
631 MODULE_LICENSE("GPL v2");
633 static int __init omap2430_init(void)
635 return platform_driver_register(&omap2430_driver);
637 subsys_initcall(omap2430_init);
639 static void __exit omap2430_exit(void)
641 platform_driver_unregister(&omap2430_driver);
643 module_exit(omap2430_exit);