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
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.h>
40 #include <linux/phy/omap_control_phy.h>
41 #include <linux/of_platform.h>
43 #include "musb_core.h"
46 struct omap2430_glue {
48 struct platform_device *musb;
49 enum musb_vbus_id_status status;
50 struct work_struct omap_musb_mailbox_work;
51 struct device *control_otghs;
53 #define glue_to_musb(g) platform_get_drvdata(g->musb)
55 static struct omap2430_glue *_glue;
57 static struct timer_list musb_idle_timer;
59 static void musb_do_idle(unsigned long _musb)
61 struct musb *musb = (void *)_musb;
66 spin_lock_irqsave(&musb->lock, flags);
68 switch (musb->xceiv->otg->state) {
69 case OTG_STATE_A_WAIT_BCON:
71 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
72 if (devctl & MUSB_DEVCTL_BDEVICE) {
73 musb->xceiv->otg->state = OTG_STATE_B_IDLE;
76 musb->xceiv->otg->state = OTG_STATE_A_IDLE;
80 case OTG_STATE_A_SUSPEND:
81 /* finish RESUME signaling? */
82 if (musb->port1_status & MUSB_PORT_STAT_RESUME) {
83 power = musb_readb(musb->mregs, MUSB_POWER);
84 power &= ~MUSB_POWER_RESUME;
85 dev_dbg(musb->controller, "root port resume stopped, power %02x\n", power);
86 musb_writeb(musb->mregs, MUSB_POWER, power);
88 musb->port1_status &= ~(USB_PORT_STAT_SUSPEND
89 | MUSB_PORT_STAT_RESUME);
90 musb->port1_status |= USB_PORT_STAT_C_SUSPEND << 16;
91 usb_hcd_poll_rh_status(musb->hcd);
92 /* NOTE: it might really be A_WAIT_BCON ... */
93 musb->xceiv->otg->state = OTG_STATE_A_HOST;
96 case OTG_STATE_A_HOST:
97 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
98 if (devctl & MUSB_DEVCTL_BDEVICE)
99 musb->xceiv->otg->state = OTG_STATE_B_IDLE;
101 musb->xceiv->otg->state = OTG_STATE_A_WAIT_BCON;
105 spin_unlock_irqrestore(&musb->lock, flags);
109 static void omap2430_musb_try_idle(struct musb *musb, unsigned long timeout)
111 unsigned long default_timeout = jiffies + msecs_to_jiffies(3);
112 static unsigned long last_timer;
115 timeout = default_timeout;
117 /* Never idle if active, or when VBUS timeout is not set as host */
118 if (musb->is_active || ((musb->a_wait_bcon == 0)
119 && (musb->xceiv->otg->state == OTG_STATE_A_WAIT_BCON))) {
120 dev_dbg(musb->controller, "%s active, deleting timer\n",
121 usb_otg_state_string(musb->xceiv->otg->state));
122 del_timer(&musb_idle_timer);
123 last_timer = jiffies;
127 if (time_after(last_timer, timeout)) {
128 if (!timer_pending(&musb_idle_timer))
129 last_timer = timeout;
131 dev_dbg(musb->controller, "Longer idle timer already pending, ignoring\n");
135 last_timer = timeout;
137 dev_dbg(musb->controller, "%s inactive, for idle timer for %lu ms\n",
138 usb_otg_state_string(musb->xceiv->otg->state),
139 (unsigned long)jiffies_to_msecs(timeout - jiffies));
140 mod_timer(&musb_idle_timer, timeout);
143 static void omap2430_musb_set_vbus(struct musb *musb, int is_on)
145 struct usb_otg *otg = musb->xceiv->otg;
147 unsigned long timeout = jiffies + msecs_to_jiffies(1000);
148 /* HDRC controls CPEN, but beware current surges during device
149 * connect. They can trigger transient overcurrent conditions
150 * that must be ignored.
153 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
156 if (musb->xceiv->otg->state == OTG_STATE_A_IDLE) {
158 /* start the session */
159 devctl |= MUSB_DEVCTL_SESSION;
160 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
162 * Wait for the musb to set as A device to enable the
165 while (musb_readb(musb->mregs, MUSB_DEVCTL) &
166 MUSB_DEVCTL_BDEVICE) {
171 if (time_after(jiffies, timeout)
173 dev_err(musb->controller,
174 "configured as A device timeout");
179 otg_set_vbus(otg, 1);
183 musb->xceiv->otg->state = OTG_STATE_A_WAIT_VRISE;
184 devctl |= MUSB_DEVCTL_SESSION;
190 /* NOTE: we're skipping A_WAIT_VFALL -> A_IDLE and
191 * jumping right to B_IDLE...
195 musb->xceiv->otg->state = OTG_STATE_B_IDLE;
196 devctl &= ~MUSB_DEVCTL_SESSION;
200 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
202 dev_dbg(musb->controller, "VBUS %s, devctl %02x "
203 /* otg %3x conf %08x prcm %08x */ "\n",
204 usb_otg_state_string(musb->xceiv->otg->state),
205 musb_readb(musb->mregs, MUSB_DEVCTL));
208 static int omap2430_musb_set_mode(struct musb *musb, u8 musb_mode)
210 u8 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
212 devctl |= MUSB_DEVCTL_SESSION;
213 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
218 static inline void omap2430_low_level_exit(struct musb *musb)
223 l = musb_readl(musb->mregs, OTG_FORCESTDBY);
224 l |= ENABLEFORCE; /* enable MSTANDBY */
225 musb_writel(musb->mregs, OTG_FORCESTDBY, l);
228 static inline void omap2430_low_level_init(struct musb *musb)
232 l = musb_readl(musb->mregs, OTG_FORCESTDBY);
233 l &= ~ENABLEFORCE; /* disable MSTANDBY */
234 musb_writel(musb->mregs, OTG_FORCESTDBY, l);
237 static void omap2430_musb_mailbox(enum musb_vbus_id_status status)
239 struct omap2430_glue *glue = _glue;
242 pr_err("%s: musb core is not yet initialized\n", __func__);
245 glue->status = status;
247 if (!glue_to_musb(glue)) {
248 pr_err("%s: musb core is not yet ready\n", __func__);
252 schedule_work(&glue->omap_musb_mailbox_work);
255 static void omap_musb_set_mailbox(struct omap2430_glue *glue)
257 struct musb *musb = glue_to_musb(glue);
258 struct device *dev = musb->controller;
259 struct musb_hdrc_platform_data *pdata = dev_get_platdata(dev);
260 struct omap_musb_board_data *data = pdata->board_data;
261 struct usb_otg *otg = musb->xceiv->otg;
263 switch (glue->status) {
265 dev_dbg(dev, "ID GND\n");
267 otg->default_a = true;
268 musb->xceiv->otg->state = OTG_STATE_A_IDLE;
269 musb->xceiv->last_event = USB_EVENT_ID;
270 if (musb->gadget_driver) {
271 pm_runtime_get_sync(dev);
272 omap_control_usb_set_mode(glue->control_otghs,
274 omap2430_musb_set_vbus(musb, 1);
278 case MUSB_VBUS_VALID:
279 dev_dbg(dev, "VBUS Connect\n");
281 otg->default_a = false;
282 musb->xceiv->otg->state = OTG_STATE_B_IDLE;
283 musb->xceiv->last_event = USB_EVENT_VBUS;
284 if (musb->gadget_driver)
285 pm_runtime_get_sync(dev);
286 omap_control_usb_set_mode(glue->control_otghs, USB_MODE_DEVICE);
291 dev_dbg(dev, "VBUS Disconnect\n");
293 musb->xceiv->last_event = USB_EVENT_NONE;
294 if (musb->gadget_driver) {
295 omap2430_musb_set_vbus(musb, 0);
296 pm_runtime_mark_last_busy(dev);
297 pm_runtime_put_autosuspend(dev);
300 if (data->interface_type == MUSB_INTERFACE_UTMI)
301 otg_set_vbus(musb->xceiv->otg, 0);
303 omap_control_usb_set_mode(glue->control_otghs,
304 USB_MODE_DISCONNECT);
307 dev_dbg(dev, "ID float\n");
310 atomic_notifier_call_chain(&musb->xceiv->notifier,
311 musb->xceiv->last_event, NULL);
315 static void omap_musb_mailbox_work(struct work_struct *mailbox_work)
317 struct omap2430_glue *glue = container_of(mailbox_work,
318 struct omap2430_glue, omap_musb_mailbox_work);
319 struct musb *musb = glue_to_musb(glue);
320 struct device *dev = musb->controller;
322 pm_runtime_get_sync(dev);
323 omap_musb_set_mailbox(glue);
324 pm_runtime_mark_last_busy(dev);
325 pm_runtime_put_autosuspend(dev);
328 static irqreturn_t omap2430_musb_interrupt(int irq, void *__hci)
331 irqreturn_t retval = IRQ_NONE;
332 struct musb *musb = __hci;
334 spin_lock_irqsave(&musb->lock, flags);
336 musb->int_usb = musb_readb(musb->mregs, MUSB_INTRUSB);
337 musb->int_tx = musb_readw(musb->mregs, MUSB_INTRTX);
338 musb->int_rx = musb_readw(musb->mregs, MUSB_INTRRX);
340 if (musb->int_usb || musb->int_tx || musb->int_rx)
341 retval = musb_interrupt(musb);
343 spin_unlock_irqrestore(&musb->lock, flags);
348 static int omap2430_musb_init(struct musb *musb)
352 struct device *dev = musb->controller;
353 struct omap2430_glue *glue = dev_get_drvdata(dev->parent);
354 struct musb_hdrc_platform_data *plat = dev_get_platdata(dev);
355 struct omap_musb_board_data *data = plat->board_data;
357 /* We require some kind of external transceiver, hooked
358 * up through ULPI. TWL4030-family PMICs include one,
359 * which needs a driver, drivers aren't always needed.
361 if (dev->parent->of_node) {
362 musb->phy = devm_phy_get(dev->parent, "usb2-phy");
364 /* We can't totally remove musb->xceiv as of now because
365 * musb core uses xceiv.state and xceiv.otg. Once we have
366 * a separate state machine to handle otg, these can be moved
367 * out of xceiv and then we can start using the generic PHY
370 musb->xceiv = devm_usb_get_phy_by_phandle(dev->parent,
373 musb->xceiv = devm_usb_get_phy_dev(dev, 0);
374 musb->phy = devm_phy_get(dev, "usb");
377 if (IS_ERR(musb->xceiv)) {
378 status = PTR_ERR(musb->xceiv);
380 if (status == -ENXIO)
383 pr_err("HS USB OTG: no transceiver configured\n");
384 return -EPROBE_DEFER;
387 if (IS_ERR(musb->phy)) {
388 pr_err("HS USB OTG: no PHY configured\n");
389 return PTR_ERR(musb->phy);
391 musb->isr = omap2430_musb_interrupt;
394 * Enable runtime PM for musb parent (this driver). We can't
395 * do it earlier as struct musb is not yet allocated and we
396 * need to touch the musb registers for runtime PM.
398 pm_runtime_enable(glue->dev);
399 status = pm_runtime_get_sync(glue->dev);
403 status = pm_runtime_get_sync(dev);
405 dev_err(dev, "pm_runtime_get_sync FAILED %d\n", status);
406 pm_runtime_put_sync(glue->dev);
410 l = musb_readl(musb->mregs, OTG_INTERFSEL);
412 if (data->interface_type == MUSB_INTERFACE_UTMI) {
413 /* OMAP4 uses Internal PHY GS70 which uses UTMI interface */
414 l &= ~ULPI_12PIN; /* Disable ULPI */
415 l |= UTMI_8BIT; /* Enable UTMI */
420 musb_writel(musb->mregs, OTG_INTERFSEL, l);
422 pr_debug("HS USB OTG: revision 0x%x, sysconfig 0x%02x, "
423 "sysstatus 0x%x, intrfsel 0x%x, simenable 0x%x\n",
424 musb_readl(musb->mregs, OTG_REVISION),
425 musb_readl(musb->mregs, OTG_SYSCONFIG),
426 musb_readl(musb->mregs, OTG_SYSSTATUS),
427 musb_readl(musb->mregs, OTG_INTERFSEL),
428 musb_readl(musb->mregs, OTG_SIMENABLE));
430 setup_timer(&musb_idle_timer, musb_do_idle, (unsigned long) musb);
432 if (glue->status != MUSB_UNKNOWN)
433 omap_musb_set_mailbox(glue);
436 phy_power_on(musb->phy);
438 pm_runtime_put_noidle(musb->controller);
439 pm_runtime_put_noidle(glue->dev);
446 static void omap2430_musb_enable(struct musb *musb)
449 unsigned long timeout = jiffies + msecs_to_jiffies(1000);
450 struct device *dev = musb->controller;
451 struct omap2430_glue *glue = dev_get_drvdata(dev->parent);
452 struct musb_hdrc_platform_data *pdata = dev_get_platdata(dev);
453 struct omap_musb_board_data *data = pdata->board_data;
455 switch (glue->status) {
458 omap_control_usb_set_mode(glue->control_otghs, USB_MODE_HOST);
459 if (data->interface_type != MUSB_INTERFACE_UTMI)
461 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
462 /* start the session */
463 devctl |= MUSB_DEVCTL_SESSION;
464 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
465 while (musb_readb(musb->mregs, MUSB_DEVCTL) &
466 MUSB_DEVCTL_BDEVICE) {
469 if (time_after(jiffies, timeout)) {
470 dev_err(dev, "configured as A device timeout");
476 case MUSB_VBUS_VALID:
477 omap_control_usb_set_mode(glue->control_otghs, USB_MODE_DEVICE);
485 static void omap2430_musb_disable(struct musb *musb)
487 struct device *dev = musb->controller;
488 struct omap2430_glue *glue = dev_get_drvdata(dev->parent);
490 if (glue->status != MUSB_UNKNOWN)
491 omap_control_usb_set_mode(glue->control_otghs,
492 USB_MODE_DISCONNECT);
495 static int omap2430_musb_exit(struct musb *musb)
497 del_timer_sync(&musb_idle_timer);
499 omap2430_low_level_exit(musb);
500 phy_power_off(musb->phy);
506 static const struct musb_platform_ops omap2430_ops = {
507 .quirks = MUSB_DMA_INVENTRA,
508 #ifdef CONFIG_USB_INVENTRA_DMA
509 .dma_init = musbhs_dma_controller_create,
510 .dma_exit = musbhs_dma_controller_destroy,
512 .init = omap2430_musb_init,
513 .exit = omap2430_musb_exit,
515 .set_mode = omap2430_musb_set_mode,
516 .try_idle = omap2430_musb_try_idle,
518 .set_vbus = omap2430_musb_set_vbus,
520 .enable = omap2430_musb_enable,
521 .disable = omap2430_musb_disable,
523 .phy_callback = omap2430_musb_mailbox,
526 static u64 omap2430_dmamask = DMA_BIT_MASK(32);
528 static int omap2430_probe(struct platform_device *pdev)
530 struct resource musb_resources[3];
531 struct musb_hdrc_platform_data *pdata = dev_get_platdata(&pdev->dev);
532 struct omap_musb_board_data *data;
533 struct platform_device *musb;
534 struct omap2430_glue *glue;
535 struct device_node *np = pdev->dev.of_node;
536 struct musb_hdrc_config *config;
537 int ret = -ENOMEM, val;
539 glue = devm_kzalloc(&pdev->dev, sizeof(*glue), GFP_KERNEL);
543 musb = platform_device_alloc("musb-hdrc", PLATFORM_DEVID_AUTO);
545 dev_err(&pdev->dev, "failed to allocate musb device\n");
549 musb->dev.parent = &pdev->dev;
550 musb->dev.dma_mask = &omap2430_dmamask;
551 musb->dev.coherent_dma_mask = omap2430_dmamask;
553 glue->dev = &pdev->dev;
555 glue->status = MUSB_UNKNOWN;
556 glue->control_otghs = ERR_PTR(-ENODEV);
559 struct device_node *control_node;
560 struct platform_device *control_pdev;
562 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
566 data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
570 config = devm_kzalloc(&pdev->dev, sizeof(*config), GFP_KERNEL);
574 of_property_read_u32(np, "mode", (u32 *)&pdata->mode);
575 of_property_read_u32(np, "interface-type",
576 (u32 *)&data->interface_type);
577 of_property_read_u32(np, "num-eps", (u32 *)&config->num_eps);
578 of_property_read_u32(np, "ram-bits", (u32 *)&config->ram_bits);
579 of_property_read_u32(np, "power", (u32 *)&pdata->power);
581 ret = of_property_read_u32(np, "multipoint", &val);
583 config->multipoint = true;
585 pdata->board_data = data;
586 pdata->config = config;
588 control_node = of_parse_phandle(np, "ctrl-module", 0);
590 control_pdev = of_find_device_by_node(control_node);
592 dev_err(&pdev->dev, "Failed to get control device\n");
596 glue->control_otghs = &control_pdev->dev;
599 pdata->platform_ops = &omap2430_ops;
601 platform_set_drvdata(pdev, glue);
604 * REVISIT if we ever have two instances of the wrapper, we will be
609 INIT_WORK(&glue->omap_musb_mailbox_work, omap_musb_mailbox_work);
611 memset(musb_resources, 0x00, sizeof(*musb_resources) *
612 ARRAY_SIZE(musb_resources));
614 musb_resources[0].name = pdev->resource[0].name;
615 musb_resources[0].start = pdev->resource[0].start;
616 musb_resources[0].end = pdev->resource[0].end;
617 musb_resources[0].flags = pdev->resource[0].flags;
619 musb_resources[1].name = pdev->resource[1].name;
620 musb_resources[1].start = pdev->resource[1].start;
621 musb_resources[1].end = pdev->resource[1].end;
622 musb_resources[1].flags = pdev->resource[1].flags;
624 musb_resources[2].name = pdev->resource[2].name;
625 musb_resources[2].start = pdev->resource[2].start;
626 musb_resources[2].end = pdev->resource[2].end;
627 musb_resources[2].flags = pdev->resource[2].flags;
629 ret = platform_device_add_resources(musb, musb_resources,
630 ARRAY_SIZE(musb_resources));
632 dev_err(&pdev->dev, "failed to add resources\n");
636 ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
638 dev_err(&pdev->dev, "failed to add platform_data\n");
643 * Note that we cannot enable PM runtime yet for this
644 * driver as we need struct musb initialized first.
645 * See omap2430_musb_init above.
648 ret = platform_device_add(musb);
650 dev_err(&pdev->dev, "failed to register musb device\n");
657 platform_device_put(musb);
663 static int omap2430_remove(struct platform_device *pdev)
665 struct omap2430_glue *glue = platform_get_drvdata(pdev);
667 pm_runtime_get_sync(glue->dev);
668 cancel_work_sync(&glue->omap_musb_mailbox_work);
669 platform_device_unregister(glue->musb);
670 pm_runtime_put_sync(glue->dev);
671 pm_runtime_disable(glue->dev);
678 static int omap2430_runtime_suspend(struct device *dev)
680 struct omap2430_glue *glue = dev_get_drvdata(dev);
681 struct musb *musb = glue_to_musb(glue);
684 musb->context.otg_interfsel = musb_readl(musb->mregs,
687 omap2430_low_level_exit(musb);
693 static int omap2430_runtime_resume(struct device *dev)
695 struct omap2430_glue *glue = dev_get_drvdata(dev);
696 struct musb *musb = glue_to_musb(glue);
699 return -EPROBE_DEFER;
701 omap2430_low_level_init(musb);
702 musb_writel(musb->mregs, OTG_INTERFSEL,
703 musb->context.otg_interfsel);
708 static struct dev_pm_ops omap2430_pm_ops = {
709 .runtime_suspend = omap2430_runtime_suspend,
710 .runtime_resume = omap2430_runtime_resume,
713 #define DEV_PM_OPS (&omap2430_pm_ops)
715 #define DEV_PM_OPS NULL
719 static const struct of_device_id omap2430_id_table[] = {
721 .compatible = "ti,omap4-musb"
724 .compatible = "ti,omap3-musb"
728 MODULE_DEVICE_TABLE(of, omap2430_id_table);
731 static struct platform_driver omap2430_driver = {
732 .probe = omap2430_probe,
733 .remove = omap2430_remove,
735 .name = "musb-omap2430",
737 .of_match_table = of_match_ptr(omap2430_id_table),
741 MODULE_DESCRIPTION("OMAP2PLUS MUSB Glue Layer");
743 MODULE_LICENSE("GPL v2");
745 static int __init omap2430_init(void)
747 return platform_driver_register(&omap2430_driver);
749 subsys_initcall(omap2430_init);
751 static void __exit omap2430_exit(void)
753 platform_driver_unregister(&omap2430_driver);
755 module_exit(omap2430_exit);