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/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 omap_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->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->state = OTG_STATE_B_IDLE;
76 musb->xceiv->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->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->state = OTG_STATE_B_IDLE;
101 musb->xceiv->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->state == OTG_STATE_A_WAIT_BCON))) {
120 dev_dbg(musb->controller, "%s active, deleting timer\n",
121 usb_otg_state_string(musb->xceiv->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->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->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) & 0x80) {
170 if (time_after(jiffies, timeout)
172 dev_err(musb->controller,
173 "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 usb_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;
241 pr_err("%s: musb core is not yet initialized\n", __func__);
244 glue->status = status;
246 if (!glue_to_musb(glue)) {
247 pr_err("%s: musb core is not yet ready\n", __func__);
251 schedule_work(&glue->omap_musb_mailbox_work);
253 EXPORT_SYMBOL_GPL(omap_musb_mailbox);
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) {
264 case OMAP_MUSB_ID_GROUND:
265 dev_dbg(dev, "ID GND\n");
267 otg->default_a = true;
268 musb->xceiv->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 OMAP_MUSB_VBUS_VALID:
279 dev_dbg(dev, "VBUS Connect\n");
281 otg->default_a = false;
282 musb->xceiv->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);
289 case OMAP_MUSB_ID_FLOAT:
290 case OMAP_MUSB_VBUS_OFF:
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 omap_musb_set_mailbox(glue);
322 static irqreturn_t omap2430_musb_interrupt(int irq, void *__hci)
325 irqreturn_t retval = IRQ_NONE;
326 struct musb *musb = __hci;
328 spin_lock_irqsave(&musb->lock, flags);
330 musb->int_usb = musb_readb(musb->mregs, MUSB_INTRUSB);
331 musb->int_tx = musb_readw(musb->mregs, MUSB_INTRTX);
332 musb->int_rx = musb_readw(musb->mregs, MUSB_INTRRX);
334 if (musb->int_usb || musb->int_tx || musb->int_rx)
335 retval = musb_interrupt(musb);
337 spin_unlock_irqrestore(&musb->lock, flags);
342 static int omap2430_musb_init(struct musb *musb)
346 struct device *dev = musb->controller;
347 struct omap2430_glue *glue = dev_get_drvdata(dev->parent);
348 struct musb_hdrc_platform_data *plat = dev_get_platdata(dev);
349 struct omap_musb_board_data *data = plat->board_data;
351 /* We require some kind of external transceiver, hooked
352 * up through ULPI. TWL4030-family PMICs include one,
353 * which needs a driver, drivers aren't always needed.
355 if (dev->parent->of_node) {
356 musb->phy = devm_phy_get(dev->parent, "usb2-phy");
358 /* We can't totally remove musb->xceiv as of now because
359 * musb core uses xceiv.state and xceiv.otg. Once we have
360 * a separate state machine to handle otg, these can be moved
361 * out of xceiv and then we can start using the generic PHY
364 musb->xceiv = devm_usb_get_phy_by_phandle(dev->parent,
367 musb->xceiv = devm_usb_get_phy_dev(dev, 0);
368 musb->phy = devm_phy_get(dev, "usb");
371 if (IS_ERR(musb->xceiv)) {
372 status = PTR_ERR(musb->xceiv);
374 if (status == -ENXIO)
377 pr_err("HS USB OTG: no transceiver configured\n");
378 return -EPROBE_DEFER;
381 if (IS_ERR(musb->phy)) {
382 pr_err("HS USB OTG: no PHY configured\n");
383 return PTR_ERR(musb->phy);
385 musb->isr = omap2430_musb_interrupt;
387 status = pm_runtime_get_sync(dev);
389 dev_err(dev, "pm_runtime_get_sync FAILED %d\n", status);
393 l = musb_readl(musb->mregs, OTG_INTERFSEL);
395 if (data->interface_type == MUSB_INTERFACE_UTMI) {
396 /* OMAP4 uses Internal PHY GS70 which uses UTMI interface */
397 l &= ~ULPI_12PIN; /* Disable ULPI */
398 l |= UTMI_8BIT; /* Enable UTMI */
403 musb_writel(musb->mregs, OTG_INTERFSEL, l);
405 pr_debug("HS USB OTG: revision 0x%x, sysconfig 0x%02x, "
406 "sysstatus 0x%x, intrfsel 0x%x, simenable 0x%x\n",
407 musb_readl(musb->mregs, OTG_REVISION),
408 musb_readl(musb->mregs, OTG_SYSCONFIG),
409 musb_readl(musb->mregs, OTG_SYSSTATUS),
410 musb_readl(musb->mregs, OTG_INTERFSEL),
411 musb_readl(musb->mregs, OTG_SIMENABLE));
413 setup_timer(&musb_idle_timer, musb_do_idle, (unsigned long) musb);
415 if (glue->status != OMAP_MUSB_UNKNOWN)
416 omap_musb_set_mailbox(glue);
420 pm_runtime_put_noidle(musb->controller);
427 static void omap2430_musb_enable(struct musb *musb)
430 unsigned long timeout = jiffies + msecs_to_jiffies(1000);
431 struct device *dev = musb->controller;
432 struct omap2430_glue *glue = dev_get_drvdata(dev->parent);
433 struct musb_hdrc_platform_data *pdata = dev_get_platdata(dev);
434 struct omap_musb_board_data *data = pdata->board_data;
436 switch (glue->status) {
438 case OMAP_MUSB_ID_GROUND:
439 omap_control_usb_set_mode(glue->control_otghs, USB_MODE_HOST);
440 if (data->interface_type != MUSB_INTERFACE_UTMI)
442 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
443 /* start the session */
444 devctl |= MUSB_DEVCTL_SESSION;
445 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
446 while (musb_readb(musb->mregs, MUSB_DEVCTL) &
447 MUSB_DEVCTL_BDEVICE) {
450 if (time_after(jiffies, timeout)) {
451 dev_err(dev, "configured as A device timeout");
457 case OMAP_MUSB_VBUS_VALID:
458 omap_control_usb_set_mode(glue->control_otghs, USB_MODE_DEVICE);
466 static void omap2430_musb_disable(struct musb *musb)
468 struct device *dev = musb->controller;
469 struct omap2430_glue *glue = dev_get_drvdata(dev->parent);
471 if (glue->status != OMAP_MUSB_UNKNOWN)
472 omap_control_usb_set_mode(glue->control_otghs,
473 USB_MODE_DISCONNECT);
476 static int omap2430_musb_exit(struct musb *musb)
478 del_timer_sync(&musb_idle_timer);
480 omap2430_low_level_exit(musb);
486 static const struct musb_platform_ops omap2430_ops = {
487 .init = omap2430_musb_init,
488 .exit = omap2430_musb_exit,
490 .set_mode = omap2430_musb_set_mode,
491 .try_idle = omap2430_musb_try_idle,
493 .set_vbus = omap2430_musb_set_vbus,
495 .enable = omap2430_musb_enable,
496 .disable = omap2430_musb_disable,
499 static u64 omap2430_dmamask = DMA_BIT_MASK(32);
501 static int omap2430_probe(struct platform_device *pdev)
503 struct resource musb_resources[3];
504 struct musb_hdrc_platform_data *pdata = dev_get_platdata(&pdev->dev);
505 struct omap_musb_board_data *data;
506 struct platform_device *musb;
507 struct omap2430_glue *glue;
508 struct device_node *np = pdev->dev.of_node;
509 struct musb_hdrc_config *config;
512 glue = devm_kzalloc(&pdev->dev, sizeof(*glue), GFP_KERNEL);
514 dev_err(&pdev->dev, "failed to allocate glue context\n");
518 musb = platform_device_alloc("musb-hdrc", PLATFORM_DEVID_AUTO);
520 dev_err(&pdev->dev, "failed to allocate musb device\n");
524 musb->dev.parent = &pdev->dev;
525 musb->dev.dma_mask = &omap2430_dmamask;
526 musb->dev.coherent_dma_mask = omap2430_dmamask;
528 glue->dev = &pdev->dev;
530 glue->status = OMAP_MUSB_UNKNOWN;
531 glue->control_otghs = ERR_PTR(-ENODEV);
534 struct device_node *control_node;
535 struct platform_device *control_pdev;
537 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
540 "failed to allocate musb platform data\n");
544 data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
547 "failed to allocate musb board data\n");
551 config = devm_kzalloc(&pdev->dev, sizeof(*config), GFP_KERNEL);
554 "failed to allocate musb hdrc config\n");
558 of_property_read_u32(np, "mode", (u32 *)&pdata->mode);
559 of_property_read_u32(np, "interface-type",
560 (u32 *)&data->interface_type);
561 of_property_read_u32(np, "num-eps", (u32 *)&config->num_eps);
562 of_property_read_u32(np, "ram-bits", (u32 *)&config->ram_bits);
563 of_property_read_u32(np, "power", (u32 *)&pdata->power);
564 config->multipoint = of_property_read_bool(np, "multipoint");
566 pdata->board_data = data;
567 pdata->config = config;
569 control_node = of_parse_phandle(np, "ctrl-module", 0);
571 control_pdev = of_find_device_by_node(control_node);
573 dev_err(&pdev->dev, "Failed to get control device\n");
577 glue->control_otghs = &control_pdev->dev;
580 pdata->platform_ops = &omap2430_ops;
582 platform_set_drvdata(pdev, glue);
585 * REVISIT if we ever have two instances of the wrapper, we will be
590 INIT_WORK(&glue->omap_musb_mailbox_work, omap_musb_mailbox_work);
592 memset(musb_resources, 0x00, sizeof(*musb_resources) *
593 ARRAY_SIZE(musb_resources));
595 musb_resources[0].name = pdev->resource[0].name;
596 musb_resources[0].start = pdev->resource[0].start;
597 musb_resources[0].end = pdev->resource[0].end;
598 musb_resources[0].flags = pdev->resource[0].flags;
600 musb_resources[1].name = pdev->resource[1].name;
601 musb_resources[1].start = pdev->resource[1].start;
602 musb_resources[1].end = pdev->resource[1].end;
603 musb_resources[1].flags = pdev->resource[1].flags;
605 musb_resources[2].name = pdev->resource[2].name;
606 musb_resources[2].start = pdev->resource[2].start;
607 musb_resources[2].end = pdev->resource[2].end;
608 musb_resources[2].flags = pdev->resource[2].flags;
610 ret = platform_device_add_resources(musb, musb_resources,
611 ARRAY_SIZE(musb_resources));
613 dev_err(&pdev->dev, "failed to add resources\n");
617 ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
619 dev_err(&pdev->dev, "failed to add platform_data\n");
623 pm_runtime_enable(&pdev->dev);
625 ret = platform_device_add(musb);
627 dev_err(&pdev->dev, "failed to register musb device\n");
634 platform_device_put(musb);
640 static int omap2430_remove(struct platform_device *pdev)
642 struct omap2430_glue *glue = platform_get_drvdata(pdev);
644 cancel_work_sync(&glue->omap_musb_mailbox_work);
645 platform_device_unregister(glue->musb);
652 static int omap2430_runtime_suspend(struct device *dev)
654 struct omap2430_glue *glue = dev_get_drvdata(dev);
655 struct musb *musb = glue_to_musb(glue);
658 musb->context.otg_interfsel = musb_readl(musb->mregs,
661 omap2430_low_level_exit(musb);
667 static int omap2430_runtime_resume(struct device *dev)
669 struct omap2430_glue *glue = dev_get_drvdata(dev);
670 struct musb *musb = glue_to_musb(glue);
673 omap2430_low_level_init(musb);
674 musb_writel(musb->mregs, OTG_INTERFSEL,
675 musb->context.otg_interfsel);
681 static struct dev_pm_ops omap2430_pm_ops = {
682 .runtime_suspend = omap2430_runtime_suspend,
683 .runtime_resume = omap2430_runtime_resume,
686 #define DEV_PM_OPS (&omap2430_pm_ops)
688 #define DEV_PM_OPS NULL
692 static const struct of_device_id omap2430_id_table[] = {
694 .compatible = "ti,omap4-musb"
697 .compatible = "ti,omap3-musb"
701 MODULE_DEVICE_TABLE(of, omap2430_id_table);
704 static struct platform_driver omap2430_driver = {
705 .probe = omap2430_probe,
706 .remove = omap2430_remove,
708 .name = "musb-omap2430",
710 .of_match_table = of_match_ptr(omap2430_id_table),
714 MODULE_DESCRIPTION("OMAP2PLUS MUSB Glue Layer");
715 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
716 MODULE_LICENSE("GPL v2");
718 static int __init omap2430_init(void)
720 return platform_driver_register(&omap2430_driver);
722 subsys_initcall(omap2430_init);
724 static void __exit omap2430_exit(void)
726 platform_driver_unregister(&omap2430_driver);
728 module_exit(omap2430_exit);