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>
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>
39 #include <linux/usb/musb-omap.h>
40 #include <linux/usb/omap_control_usb.h>
42 #include "musb_core.h"
45 struct omap2430_glue {
47 struct platform_device *musb;
48 enum omap_musb_vbus_id_status status;
49 struct work_struct omap_musb_mailbox_work;
50 struct device *control_otghs;
52 #define glue_to_musb(g) platform_get_drvdata(g->musb)
54 struct omap2430_glue *_glue;
56 static struct timer_list musb_idle_timer;
58 static void musb_do_idle(unsigned long _musb)
60 struct musb *musb = (void *)_musb;
65 spin_lock_irqsave(&musb->lock, flags);
67 switch (musb->xceiv->state) {
68 case OTG_STATE_A_WAIT_BCON:
70 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
71 if (devctl & MUSB_DEVCTL_BDEVICE) {
72 musb->xceiv->state = OTG_STATE_B_IDLE;
75 musb->xceiv->state = OTG_STATE_A_IDLE;
79 case OTG_STATE_A_SUSPEND:
80 /* finish RESUME signaling? */
81 if (musb->port1_status & MUSB_PORT_STAT_RESUME) {
82 power = musb_readb(musb->mregs, MUSB_POWER);
83 power &= ~MUSB_POWER_RESUME;
84 dev_dbg(musb->controller, "root port resume stopped, power %02x\n", power);
85 musb_writeb(musb->mregs, MUSB_POWER, power);
87 musb->port1_status &= ~(USB_PORT_STAT_SUSPEND
88 | MUSB_PORT_STAT_RESUME);
89 musb->port1_status |= USB_PORT_STAT_C_SUSPEND << 16;
90 usb_hcd_poll_rh_status(musb_to_hcd(musb));
91 /* NOTE: it might really be A_WAIT_BCON ... */
92 musb->xceiv->state = OTG_STATE_A_HOST;
95 case OTG_STATE_A_HOST:
96 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
97 if (devctl & MUSB_DEVCTL_BDEVICE)
98 musb->xceiv->state = OTG_STATE_B_IDLE;
100 musb->xceiv->state = OTG_STATE_A_WAIT_BCON;
104 spin_unlock_irqrestore(&musb->lock, flags);
108 static void omap2430_musb_try_idle(struct musb *musb, unsigned long timeout)
110 unsigned long default_timeout = jiffies + msecs_to_jiffies(3);
111 static unsigned long last_timer;
114 timeout = default_timeout;
116 /* Never idle if active, or when VBUS timeout is not set as host */
117 if (musb->is_active || ((musb->a_wait_bcon == 0)
118 && (musb->xceiv->state == OTG_STATE_A_WAIT_BCON))) {
119 dev_dbg(musb->controller, "%s active, deleting timer\n",
120 otg_state_string(musb->xceiv->state));
121 del_timer(&musb_idle_timer);
122 last_timer = jiffies;
126 if (time_after(last_timer, timeout)) {
127 if (!timer_pending(&musb_idle_timer))
128 last_timer = timeout;
130 dev_dbg(musb->controller, "Longer idle timer already pending, ignoring\n");
134 last_timer = timeout;
136 dev_dbg(musb->controller, "%s inactive, for idle timer for %lu ms\n",
137 otg_state_string(musb->xceiv->state),
138 (unsigned long)jiffies_to_msecs(timeout - jiffies));
139 mod_timer(&musb_idle_timer, timeout);
142 static void omap2430_musb_set_vbus(struct musb *musb, int is_on)
144 struct usb_otg *otg = musb->xceiv->otg;
146 unsigned long timeout = jiffies + msecs_to_jiffies(1000);
147 /* HDRC controls CPEN, but beware current surges during device
148 * connect. They can trigger transient overcurrent conditions
149 * that must be ignored.
152 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
155 if (musb->xceiv->state == OTG_STATE_A_IDLE) {
157 /* start the session */
158 devctl |= MUSB_DEVCTL_SESSION;
159 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
161 * Wait for the musb to set as A device to enable the
164 while (musb_readb(musb->mregs, MUSB_DEVCTL) & 0x80) {
169 if (time_after(jiffies, timeout)
171 dev_err(musb->controller,
172 "configured as A device timeout");
178 otg_set_vbus(otg, 1);
182 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
183 devctl |= MUSB_DEVCTL_SESSION;
189 /* NOTE: we're skipping A_WAIT_VFALL -> A_IDLE and
190 * jumping right to B_IDLE...
194 musb->xceiv->state = OTG_STATE_B_IDLE;
195 devctl &= ~MUSB_DEVCTL_SESSION;
199 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
201 dev_dbg(musb->controller, "VBUS %s, devctl %02x "
202 /* otg %3x conf %08x prcm %08x */ "\n",
203 otg_state_string(musb->xceiv->state),
204 musb_readb(musb->mregs, MUSB_DEVCTL));
207 static int omap2430_musb_set_mode(struct musb *musb, u8 musb_mode)
209 u8 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
211 devctl |= MUSB_DEVCTL_SESSION;
212 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
217 static inline void omap2430_low_level_exit(struct musb *musb)
222 l = musb_readl(musb->mregs, OTG_FORCESTDBY);
223 l |= ENABLEFORCE; /* enable MSTANDBY */
224 musb_writel(musb->mregs, OTG_FORCESTDBY, l);
227 static inline void omap2430_low_level_init(struct musb *musb)
231 l = musb_readl(musb->mregs, OTG_FORCESTDBY);
232 l &= ~ENABLEFORCE; /* disable MSTANDBY */
233 musb_writel(musb->mregs, OTG_FORCESTDBY, l);
236 void omap_musb_mailbox(enum omap_musb_vbus_id_status status)
238 struct omap2430_glue *glue = _glue;
240 if (glue && glue_to_musb(glue)) {
241 glue->status = status;
243 pr_err("%s: musb core is not yet ready\n", __func__);
247 schedule_work(&glue->omap_musb_mailbox_work);
249 EXPORT_SYMBOL_GPL(omap_musb_mailbox);
251 static void omap_musb_set_mailbox(struct omap2430_glue *glue)
253 struct musb *musb = glue_to_musb(glue);
254 struct device *dev = musb->controller;
255 struct musb_hdrc_platform_data *pdata = dev->platform_data;
256 struct omap_musb_board_data *data = pdata->board_data;
257 struct usb_otg *otg = musb->xceiv->otg;
259 switch (glue->status) {
260 case OMAP_MUSB_ID_GROUND:
261 dev_dbg(dev, "ID GND\n");
263 otg->default_a = true;
264 musb->xceiv->state = OTG_STATE_A_IDLE;
265 musb->xceiv->last_event = USB_EVENT_ID;
266 if (musb->gadget_driver) {
267 pm_runtime_get_sync(dev);
268 omap_control_usb_set_mode(glue->control_otghs,
270 omap2430_musb_set_vbus(musb, 1);
274 case OMAP_MUSB_VBUS_VALID:
275 dev_dbg(dev, "VBUS Connect\n");
277 otg->default_a = false;
278 musb->xceiv->state = OTG_STATE_B_IDLE;
279 musb->xceiv->last_event = USB_EVENT_VBUS;
280 if (musb->gadget_driver)
281 pm_runtime_get_sync(dev);
282 omap_control_usb_set_mode(glue->control_otghs, USB_MODE_DEVICE);
285 case OMAP_MUSB_ID_FLOAT:
286 case OMAP_MUSB_VBUS_OFF:
287 dev_dbg(dev, "VBUS Disconnect\n");
289 musb->xceiv->last_event = USB_EVENT_NONE;
290 if (musb->gadget_driver) {
291 pm_runtime_mark_last_busy(dev);
292 pm_runtime_put_autosuspend(dev);
295 if (data->interface_type == MUSB_INTERFACE_UTMI) {
296 if (musb->xceiv->otg->set_vbus)
297 otg_set_vbus(musb->xceiv->otg, 0);
299 omap_control_usb_set_mode(glue->control_otghs,
300 USB_MODE_DISCONNECT);
303 dev_dbg(dev, "ID float\n");
308 static void omap_musb_mailbox_work(struct work_struct *mailbox_work)
310 struct omap2430_glue *glue = container_of(mailbox_work,
311 struct omap2430_glue, omap_musb_mailbox_work);
312 omap_musb_set_mailbox(glue);
315 static irqreturn_t omap2430_musb_interrupt(int irq, void *__hci)
318 irqreturn_t retval = IRQ_NONE;
319 struct musb *musb = __hci;
321 spin_lock_irqsave(&musb->lock, flags);
323 musb->int_usb = musb_readb(musb->mregs, MUSB_INTRUSB);
324 musb->int_tx = musb_readw(musb->mregs, MUSB_INTRTX);
325 musb->int_rx = musb_readw(musb->mregs, MUSB_INTRRX);
327 if (musb->int_usb || musb->int_tx || musb->int_rx)
328 retval = musb_interrupt(musb);
330 spin_unlock_irqrestore(&musb->lock, flags);
335 static int omap2430_musb_init(struct musb *musb)
339 struct device *dev = musb->controller;
340 struct omap2430_glue *glue = dev_get_drvdata(dev->parent);
341 struct musb_hdrc_platform_data *plat = dev->platform_data;
342 struct omap_musb_board_data *data = plat->board_data;
344 /* We require some kind of external transceiver, hooked
345 * up through ULPI. TWL4030-family PMICs include one,
346 * which needs a driver, drivers aren't always needed.
348 if (dev->parent->of_node)
349 musb->xceiv = devm_usb_get_phy_by_phandle(dev->parent,
352 musb->xceiv = devm_usb_get_phy_dev(dev, 0);
354 if (IS_ERR_OR_NULL(musb->xceiv)) {
355 pr_err("HS USB OTG: no transceiver configured\n");
356 return -EPROBE_DEFER;
359 musb->isr = omap2430_musb_interrupt;
361 status = pm_runtime_get_sync(dev);
363 dev_err(dev, "pm_runtime_get_sync FAILED %d\n", status);
367 l = musb_readl(musb->mregs, OTG_INTERFSEL);
369 if (data->interface_type == MUSB_INTERFACE_UTMI) {
370 /* OMAP4 uses Internal PHY GS70 which uses UTMI interface */
371 l &= ~ULPI_12PIN; /* Disable ULPI */
372 l |= UTMI_8BIT; /* Enable UTMI */
377 musb_writel(musb->mregs, OTG_INTERFSEL, l);
379 pr_debug("HS USB OTG: revision 0x%x, sysconfig 0x%02x, "
380 "sysstatus 0x%x, intrfsel 0x%x, simenable 0x%x\n",
381 musb_readl(musb->mregs, OTG_REVISION),
382 musb_readl(musb->mregs, OTG_SYSCONFIG),
383 musb_readl(musb->mregs, OTG_SYSSTATUS),
384 musb_readl(musb->mregs, OTG_INTERFSEL),
385 musb_readl(musb->mregs, OTG_SIMENABLE));
387 setup_timer(&musb_idle_timer, musb_do_idle, (unsigned long) musb);
389 if (glue->status != OMAP_MUSB_UNKNOWN)
390 omap_musb_set_mailbox(glue);
392 pm_runtime_put_noidle(musb->controller);
399 static void omap2430_musb_enable(struct musb *musb)
402 unsigned long timeout = jiffies + msecs_to_jiffies(1000);
403 struct device *dev = musb->controller;
404 struct omap2430_glue *glue = dev_get_drvdata(dev->parent);
405 struct musb_hdrc_platform_data *pdata = dev->platform_data;
406 struct omap_musb_board_data *data = pdata->board_data;
408 switch (glue->status) {
410 case OMAP_MUSB_ID_GROUND:
411 omap_control_usb_set_mode(glue->control_otghs, USB_MODE_HOST);
412 if (data->interface_type != MUSB_INTERFACE_UTMI)
414 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
415 /* start the session */
416 devctl |= MUSB_DEVCTL_SESSION;
417 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
418 while (musb_readb(musb->mregs, MUSB_DEVCTL) &
419 MUSB_DEVCTL_BDEVICE) {
422 if (time_after(jiffies, timeout)) {
423 dev_err(dev, "configured as A device timeout");
429 case OMAP_MUSB_VBUS_VALID:
430 omap_control_usb_set_mode(glue->control_otghs, USB_MODE_DEVICE);
438 static void omap2430_musb_disable(struct musb *musb)
440 struct device *dev = musb->controller;
441 struct omap2430_glue *glue = dev_get_drvdata(dev->parent);
443 if (glue->status != OMAP_MUSB_UNKNOWN)
444 omap_control_usb_set_mode(glue->control_otghs,
445 USB_MODE_DISCONNECT);
448 static int omap2430_musb_exit(struct musb *musb)
450 del_timer_sync(&musb_idle_timer);
452 omap2430_low_level_exit(musb);
457 static const struct musb_platform_ops omap2430_ops = {
458 .init = omap2430_musb_init,
459 .exit = omap2430_musb_exit,
461 .set_mode = omap2430_musb_set_mode,
462 .try_idle = omap2430_musb_try_idle,
464 .set_vbus = omap2430_musb_set_vbus,
466 .enable = omap2430_musb_enable,
467 .disable = omap2430_musb_disable,
470 static u64 omap2430_dmamask = DMA_BIT_MASK(32);
472 static int omap2430_probe(struct platform_device *pdev)
474 struct musb_hdrc_platform_data *pdata = pdev->dev.platform_data;
475 struct omap_musb_board_data *data;
476 struct platform_device *musb;
477 struct omap2430_glue *glue;
478 struct device_node *np = pdev->dev.of_node;
479 struct musb_hdrc_config *config;
482 glue = devm_kzalloc(&pdev->dev, sizeof(*glue), GFP_KERNEL);
484 dev_err(&pdev->dev, "failed to allocate glue context\n");
488 musb = platform_device_alloc("musb-hdrc", PLATFORM_DEVID_AUTO);
490 dev_err(&pdev->dev, "failed to allocate musb device\n");
494 musb->dev.parent = &pdev->dev;
495 musb->dev.dma_mask = &omap2430_dmamask;
496 musb->dev.coherent_dma_mask = omap2430_dmamask;
498 glue->dev = &pdev->dev;
500 glue->status = OMAP_MUSB_UNKNOWN;
503 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
506 "failed to allocate musb platfrom data\n");
510 data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
513 "failed to allocate musb board data\n");
517 config = devm_kzalloc(&pdev->dev, sizeof(*config), GFP_KERNEL);
520 "failed to allocate musb hdrc config\n");
524 of_property_read_u32(np, "mode", (u32 *)&pdata->mode);
525 of_property_read_u32(np, "interface_type",
526 (u32 *)&data->interface_type);
527 of_property_read_u32(np, "num_eps", (u32 *)&config->num_eps);
528 of_property_read_u32(np, "ram_bits", (u32 *)&config->ram_bits);
529 of_property_read_u32(np, "power", (u32 *)&pdata->power);
530 config->multipoint = of_property_read_bool(np, "multipoint");
531 pdata->has_mailbox = of_property_read_bool(np,
534 pdata->board_data = data;
535 pdata->config = config;
538 if (pdata->has_mailbox) {
539 glue->control_otghs = omap_get_control_dev();
540 if (IS_ERR(glue->control_otghs)) {
541 dev_vdbg(&pdev->dev, "Failed to get control device\n");
545 glue->control_otghs = ERR_PTR(-ENODEV);
547 pdata->platform_ops = &omap2430_ops;
549 platform_set_drvdata(pdev, glue);
552 * REVISIT if we ever have two instances of the wrapper, we will be
557 INIT_WORK(&glue->omap_musb_mailbox_work, omap_musb_mailbox_work);
559 ret = platform_device_add_resources(musb, pdev->resource,
560 pdev->num_resources);
562 dev_err(&pdev->dev, "failed to add resources\n");
566 ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
568 dev_err(&pdev->dev, "failed to add platform_data\n");
572 pm_runtime_enable(&pdev->dev);
574 ret = platform_device_add(musb);
576 dev_err(&pdev->dev, "failed to register musb device\n");
583 platform_device_put(musb);
589 static int omap2430_remove(struct platform_device *pdev)
591 struct omap2430_glue *glue = platform_get_drvdata(pdev);
593 cancel_work_sync(&glue->omap_musb_mailbox_work);
594 platform_device_unregister(glue->musb);
601 static int omap2430_runtime_suspend(struct device *dev)
603 struct omap2430_glue *glue = dev_get_drvdata(dev);
604 struct musb *musb = glue_to_musb(glue);
607 musb->context.otg_interfsel = musb_readl(musb->mregs,
610 omap2430_low_level_exit(musb);
611 usb_phy_set_suspend(musb->xceiv, 1);
617 static int omap2430_runtime_resume(struct device *dev)
619 struct omap2430_glue *glue = dev_get_drvdata(dev);
620 struct musb *musb = glue_to_musb(glue);
623 omap2430_low_level_init(musb);
624 musb_writel(musb->mregs, OTG_INTERFSEL,
625 musb->context.otg_interfsel);
627 usb_phy_set_suspend(musb->xceiv, 0);
633 static struct dev_pm_ops omap2430_pm_ops = {
634 .runtime_suspend = omap2430_runtime_suspend,
635 .runtime_resume = omap2430_runtime_resume,
638 #define DEV_PM_OPS (&omap2430_pm_ops)
640 #define DEV_PM_OPS NULL
644 static const struct of_device_id omap2430_id_table[] = {
646 .compatible = "ti,omap4-musb"
649 .compatible = "ti,omap3-musb"
653 MODULE_DEVICE_TABLE(of, omap2430_id_table);
656 static struct platform_driver omap2430_driver = {
657 .probe = omap2430_probe,
658 .remove = omap2430_remove,
660 .name = "musb-omap2430",
662 .of_match_table = of_match_ptr(omap2430_id_table),
666 MODULE_DESCRIPTION("OMAP2PLUS MUSB Glue Layer");
667 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
668 MODULE_LICENSE("GPL v2");
670 static int __init omap2430_init(void)
672 return platform_driver_register(&omap2430_driver);
674 subsys_initcall(omap2430_init);
676 static void __exit omap2430_exit(void)
678 platform_driver_unregister(&omap2430_driver);
680 module_exit(omap2430_exit);