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.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;
56 #define glue_to_musb(g) platform_get_drvdata(g->musb)
58 static struct omap2430_glue *_glue;
60 static void omap2430_musb_set_vbus(struct musb *musb, int is_on)
62 struct usb_otg *otg = musb->xceiv->otg;
64 unsigned long timeout = jiffies + msecs_to_jiffies(1000);
65 /* HDRC controls CPEN, but beware current surges during device
66 * connect. They can trigger transient overcurrent conditions
67 * that must be ignored.
70 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
73 if (musb->xceiv->otg->state == OTG_STATE_A_IDLE) {
75 /* start the session */
76 devctl |= MUSB_DEVCTL_SESSION;
77 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
79 * Wait for the musb to set as A device to enable the
82 while (musb_readb(musb->mregs, MUSB_DEVCTL) &
83 MUSB_DEVCTL_BDEVICE) {
88 if (time_after(jiffies, timeout)
90 dev_err(musb->controller,
91 "configured as A device timeout");
100 musb->xceiv->otg->state = OTG_STATE_A_WAIT_VRISE;
101 devctl |= MUSB_DEVCTL_SESSION;
107 /* NOTE: we're skipping A_WAIT_VFALL -> A_IDLE and
108 * jumping right to B_IDLE...
112 musb->xceiv->otg->state = OTG_STATE_B_IDLE;
113 devctl &= ~MUSB_DEVCTL_SESSION;
117 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
119 dev_dbg(musb->controller, "VBUS %s, devctl %02x "
120 /* otg %3x conf %08x prcm %08x */ "\n",
121 usb_otg_state_string(musb->xceiv->otg->state),
122 musb_readb(musb->mregs, MUSB_DEVCTL));
125 static inline void omap2430_low_level_exit(struct musb *musb)
130 l = musb_readl(musb->mregs, OTG_FORCESTDBY);
131 l |= ENABLEFORCE; /* enable MSTANDBY */
132 musb_writel(musb->mregs, OTG_FORCESTDBY, l);
135 static inline void omap2430_low_level_init(struct musb *musb)
139 l = musb_readl(musb->mregs, OTG_FORCESTDBY);
140 l &= ~ENABLEFORCE; /* disable MSTANDBY */
141 musb_writel(musb->mregs, OTG_FORCESTDBY, l);
145 * We can get multiple cable events so we need to keep track
146 * of the power state. Only keep power enabled if USB cable is
147 * connected and a gadget is started.
149 static void omap2430_set_power(struct musb *musb, bool enabled, bool cable)
151 struct device *dev = musb->controller;
152 struct omap2430_glue *glue = dev_get_drvdata(dev->parent);
156 if (glue->enabled != enabled)
157 glue->enabled = enabled;
159 if (glue->cable_connected != cable)
160 glue->cable_connected = cable;
162 power_up = glue->enabled && glue->cable_connected;
163 if (power_up == glue->powered) {
164 dev_warn(musb->controller, "power state already %i\n",
169 glue->powered = power_up;
172 res = pm_runtime_get_sync(musb->controller);
174 dev_err(musb->controller, "could not enable: %i", res);
175 glue->powered = false;
178 pm_runtime_mark_last_busy(musb->controller);
179 pm_runtime_put_autosuspend(musb->controller);
183 static int omap2430_musb_mailbox(enum musb_vbus_id_status status)
185 struct omap2430_glue *glue = _glue;
188 pr_err("%s: musb core is not yet initialized\n", __func__);
189 return -EPROBE_DEFER;
191 glue->status = status;
193 if (!glue_to_musb(glue)) {
194 pr_err("%s: musb core is not yet ready\n", __func__);
195 return -EPROBE_DEFER;
198 schedule_work(&glue->omap_musb_mailbox_work);
203 static void omap_musb_set_mailbox(struct omap2430_glue *glue)
205 struct musb *musb = glue_to_musb(glue);
206 struct device *dev = musb->controller;
207 struct musb_hdrc_platform_data *pdata = dev_get_platdata(dev);
208 struct omap_musb_board_data *data = pdata->board_data;
209 struct usb_otg *otg = musb->xceiv->otg;
210 bool cable_connected;
212 cable_connected = ((glue->status == MUSB_ID_GROUND) ||
213 (glue->status == MUSB_VBUS_VALID));
216 omap2430_set_power(musb, glue->enabled, cable_connected);
218 switch (glue->status) {
220 dev_dbg(dev, "ID GND\n");
222 otg->default_a = true;
223 musb->xceiv->otg->state = OTG_STATE_A_IDLE;
224 musb->xceiv->last_event = USB_EVENT_ID;
225 if (musb->gadget_driver) {
226 omap_control_usb_set_mode(glue->control_otghs,
228 omap2430_musb_set_vbus(musb, 1);
232 case MUSB_VBUS_VALID:
233 dev_dbg(dev, "VBUS Connect\n");
235 otg->default_a = false;
236 musb->xceiv->otg->state = OTG_STATE_B_IDLE;
237 musb->xceiv->last_event = USB_EVENT_VBUS;
238 omap_control_usb_set_mode(glue->control_otghs, USB_MODE_DEVICE);
243 dev_dbg(dev, "VBUS Disconnect\n");
245 musb->xceiv->last_event = USB_EVENT_NONE;
246 if (musb->gadget_driver)
247 omap2430_musb_set_vbus(musb, 0);
249 if (data->interface_type == MUSB_INTERFACE_UTMI)
250 otg_set_vbus(musb->xceiv->otg, 0);
252 omap_control_usb_set_mode(glue->control_otghs,
253 USB_MODE_DISCONNECT);
256 dev_dbg(dev, "ID float\n");
259 if (!cable_connected)
260 omap2430_set_power(musb, glue->enabled, cable_connected);
262 atomic_notifier_call_chain(&musb->xceiv->notifier,
263 musb->xceiv->last_event, NULL);
267 static void omap_musb_mailbox_work(struct work_struct *mailbox_work)
269 struct omap2430_glue *glue = container_of(mailbox_work,
270 struct omap2430_glue, omap_musb_mailbox_work);
271 struct musb *musb = glue_to_musb(glue);
272 struct device *dev = musb->controller;
274 pm_runtime_get_sync(dev);
275 omap_musb_set_mailbox(glue);
276 pm_runtime_mark_last_busy(dev);
277 pm_runtime_put_autosuspend(dev);
280 static irqreturn_t omap2430_musb_interrupt(int irq, void *__hci)
283 irqreturn_t retval = IRQ_NONE;
284 struct musb *musb = __hci;
286 spin_lock_irqsave(&musb->lock, flags);
288 musb->int_usb = musb_readb(musb->mregs, MUSB_INTRUSB);
289 musb->int_tx = musb_readw(musb->mregs, MUSB_INTRTX);
290 musb->int_rx = musb_readw(musb->mregs, MUSB_INTRRX);
292 if (musb->int_usb || musb->int_tx || musb->int_rx)
293 retval = musb_interrupt(musb);
295 spin_unlock_irqrestore(&musb->lock, flags);
300 static int omap2430_musb_init(struct musb *musb)
304 struct device *dev = musb->controller;
305 struct omap2430_glue *glue = dev_get_drvdata(dev->parent);
306 struct musb_hdrc_platform_data *plat = dev_get_platdata(dev);
307 struct omap_musb_board_data *data = plat->board_data;
309 /* We require some kind of external transceiver, hooked
310 * up through ULPI. TWL4030-family PMICs include one,
311 * which needs a driver, drivers aren't always needed.
313 if (dev->parent->of_node) {
314 musb->phy = devm_phy_get(dev->parent, "usb2-phy");
316 /* We can't totally remove musb->xceiv as of now because
317 * musb core uses xceiv.state and xceiv.otg. Once we have
318 * a separate state machine to handle otg, these can be moved
319 * out of xceiv and then we can start using the generic PHY
322 musb->xceiv = devm_usb_get_phy_by_phandle(dev->parent,
325 musb->xceiv = devm_usb_get_phy_dev(dev, 0);
326 musb->phy = devm_phy_get(dev, "usb");
329 if (IS_ERR(musb->xceiv)) {
330 status = PTR_ERR(musb->xceiv);
332 if (status == -ENXIO)
335 pr_err("HS USB OTG: no transceiver configured\n");
336 return -EPROBE_DEFER;
339 if (IS_ERR(musb->phy)) {
340 pr_err("HS USB OTG: no PHY configured\n");
341 return PTR_ERR(musb->phy);
343 musb->isr = omap2430_musb_interrupt;
347 * Enable runtime PM for musb parent (this driver). We can't
348 * do it earlier as struct musb is not yet allocated and we
349 * need to touch the musb registers for runtime PM.
351 pm_runtime_enable(glue->dev);
352 status = pm_runtime_get_sync(glue->dev);
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));
376 if (glue->status != MUSB_UNKNOWN)
377 omap_musb_set_mailbox(glue);
379 pm_runtime_put(glue->dev);
386 static void omap2430_musb_enable(struct musb *musb)
389 unsigned long timeout = jiffies + msecs_to_jiffies(1000);
390 struct device *dev = musb->controller;
391 struct omap2430_glue *glue = dev_get_drvdata(dev->parent);
392 struct musb_hdrc_platform_data *pdata = dev_get_platdata(dev);
393 struct omap_musb_board_data *data = pdata->board_data;
395 if (!WARN_ON(!musb->phy))
396 phy_power_on(musb->phy);
398 omap2430_set_power(musb, true, glue->cable_connected);
400 switch (glue->status) {
403 omap_control_usb_set_mode(glue->control_otghs, USB_MODE_HOST);
404 if (data->interface_type != MUSB_INTERFACE_UTMI)
406 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
407 /* start the session */
408 devctl |= MUSB_DEVCTL_SESSION;
409 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
410 while (musb_readb(musb->mregs, MUSB_DEVCTL) &
411 MUSB_DEVCTL_BDEVICE) {
414 if (time_after(jiffies, timeout)) {
415 dev_err(dev, "configured as A device timeout");
421 case MUSB_VBUS_VALID:
422 omap_control_usb_set_mode(glue->control_otghs, USB_MODE_DEVICE);
430 static void omap2430_musb_disable(struct musb *musb)
432 struct device *dev = musb->controller;
433 struct omap2430_glue *glue = dev_get_drvdata(dev->parent);
435 if (!WARN_ON(!musb->phy))
436 phy_power_off(musb->phy);
438 if (glue->status != MUSB_UNKNOWN)
439 omap_control_usb_set_mode(glue->control_otghs,
440 USB_MODE_DISCONNECT);
442 omap2430_set_power(musb, false, glue->cable_connected);
445 static int omap2430_musb_exit(struct musb *musb)
447 struct device *dev = musb->controller;
448 struct omap2430_glue *glue = dev_get_drvdata(dev->parent);
450 omap2430_low_level_exit(musb);
453 cancel_work_sync(&glue->omap_musb_mailbox_work);
458 static const struct musb_platform_ops omap2430_ops = {
459 .quirks = MUSB_DMA_INVENTRA,
460 #ifdef CONFIG_USB_INVENTRA_DMA
461 .dma_init = musbhs_dma_controller_create,
462 .dma_exit = musbhs_dma_controller_destroy,
464 .init = omap2430_musb_init,
465 .exit = omap2430_musb_exit,
467 .set_vbus = omap2430_musb_set_vbus,
469 .enable = omap2430_musb_enable,
470 .disable = omap2430_musb_disable,
472 .phy_callback = omap2430_musb_mailbox,
475 static u64 omap2430_dmamask = DMA_BIT_MASK(32);
477 static int omap2430_probe(struct platform_device *pdev)
479 struct resource musb_resources[3];
480 struct musb_hdrc_platform_data *pdata = dev_get_platdata(&pdev->dev);
481 struct omap_musb_board_data *data;
482 struct platform_device *musb;
483 struct omap2430_glue *glue;
484 struct device_node *np = pdev->dev.of_node;
485 struct musb_hdrc_config *config;
486 int ret = -ENOMEM, val;
488 glue = devm_kzalloc(&pdev->dev, sizeof(*glue), GFP_KERNEL);
492 musb = platform_device_alloc("musb-hdrc", PLATFORM_DEVID_AUTO);
494 dev_err(&pdev->dev, "failed to allocate musb device\n");
498 musb->dev.parent = &pdev->dev;
499 musb->dev.dma_mask = &omap2430_dmamask;
500 musb->dev.coherent_dma_mask = omap2430_dmamask;
502 glue->dev = &pdev->dev;
504 glue->status = MUSB_UNKNOWN;
505 glue->control_otghs = ERR_PTR(-ENODEV);
508 struct device_node *control_node;
509 struct platform_device *control_pdev;
511 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
515 data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
519 config = devm_kzalloc(&pdev->dev, sizeof(*config), GFP_KERNEL);
523 of_property_read_u32(np, "mode", (u32 *)&pdata->mode);
524 of_property_read_u32(np, "interface-type",
525 (u32 *)&data->interface_type);
526 of_property_read_u32(np, "num-eps", (u32 *)&config->num_eps);
527 of_property_read_u32(np, "ram-bits", (u32 *)&config->ram_bits);
528 of_property_read_u32(np, "power", (u32 *)&pdata->power);
530 ret = of_property_read_u32(np, "multipoint", &val);
532 config->multipoint = true;
534 pdata->board_data = data;
535 pdata->config = config;
537 control_node = of_parse_phandle(np, "ctrl-module", 0);
539 control_pdev = of_find_device_by_node(control_node);
541 dev_err(&pdev->dev, "Failed to get control device\n");
545 glue->control_otghs = &control_pdev->dev;
548 pdata->platform_ops = &omap2430_ops;
550 platform_set_drvdata(pdev, glue);
553 * REVISIT if we ever have two instances of the wrapper, we will be
558 INIT_WORK(&glue->omap_musb_mailbox_work, omap_musb_mailbox_work);
560 memset(musb_resources, 0x00, sizeof(*musb_resources) *
561 ARRAY_SIZE(musb_resources));
563 musb_resources[0].name = pdev->resource[0].name;
564 musb_resources[0].start = pdev->resource[0].start;
565 musb_resources[0].end = pdev->resource[0].end;
566 musb_resources[0].flags = pdev->resource[0].flags;
568 musb_resources[1].name = pdev->resource[1].name;
569 musb_resources[1].start = pdev->resource[1].start;
570 musb_resources[1].end = pdev->resource[1].end;
571 musb_resources[1].flags = pdev->resource[1].flags;
573 musb_resources[2].name = pdev->resource[2].name;
574 musb_resources[2].start = pdev->resource[2].start;
575 musb_resources[2].end = pdev->resource[2].end;
576 musb_resources[2].flags = pdev->resource[2].flags;
578 ret = platform_device_add_resources(musb, musb_resources,
579 ARRAY_SIZE(musb_resources));
581 dev_err(&pdev->dev, "failed to add resources\n");
585 ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
587 dev_err(&pdev->dev, "failed to add platform_data\n");
592 * Note that we cannot enable PM runtime yet for this
593 * driver as we need struct musb initialized first.
594 * See omap2430_musb_init above.
597 ret = platform_device_add(musb);
599 dev_err(&pdev->dev, "failed to register musb device\n");
606 platform_device_put(musb);
612 static int omap2430_remove(struct platform_device *pdev)
614 struct omap2430_glue *glue = platform_get_drvdata(pdev);
615 struct musb *musb = glue_to_musb(glue);
617 pm_runtime_get_sync(glue->dev);
618 platform_device_unregister(glue->musb);
619 omap2430_set_power(musb, false, false);
620 pm_runtime_put_sync(glue->dev);
621 pm_runtime_disable(glue->dev);
628 static int omap2430_runtime_suspend(struct device *dev)
630 struct omap2430_glue *glue = dev_get_drvdata(dev);
631 struct musb *musb = glue_to_musb(glue);
636 musb->context.otg_interfsel = musb_readl(musb->mregs,
639 omap2430_low_level_exit(musb);
644 static int omap2430_runtime_resume(struct device *dev)
646 struct omap2430_glue *glue = dev_get_drvdata(dev);
647 struct musb *musb = glue_to_musb(glue);
652 omap2430_low_level_init(musb);
653 musb_writel(musb->mregs, OTG_INTERFSEL,
654 musb->context.otg_interfsel);
659 static struct dev_pm_ops omap2430_pm_ops = {
660 .runtime_suspend = omap2430_runtime_suspend,
661 .runtime_resume = omap2430_runtime_resume,
664 #define DEV_PM_OPS (&omap2430_pm_ops)
666 #define DEV_PM_OPS NULL
670 static const struct of_device_id omap2430_id_table[] = {
672 .compatible = "ti,omap4-musb"
675 .compatible = "ti,omap3-musb"
679 MODULE_DEVICE_TABLE(of, omap2430_id_table);
682 static struct platform_driver omap2430_driver = {
683 .probe = omap2430_probe,
684 .remove = omap2430_remove,
686 .name = "musb-omap2430",
688 .of_match_table = of_match_ptr(omap2430_id_table),
692 MODULE_DESCRIPTION("OMAP2PLUS MUSB Glue Layer");
693 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
694 MODULE_LICENSE("GPL v2");
696 static int __init omap2430_init(void)
698 return platform_driver_register(&omap2430_driver);
700 subsys_initcall(omap2430_init);
702 static void __exit omap2430_exit(void)
704 platform_driver_unregister(&omap2430_driver);
706 module_exit(omap2430_exit);