1 /* 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> 7 * 8 * This file is part of the Inventra Controller Driver for Linux. 9 * 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 13 * Foundation. 14 * 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. 20 * 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 25 * 26 */ 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> 32 #include <linux/io.h> 33 #include <linux/of.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> 41 42 #include "musb_core.h" 43 #include "omap2430.h" 44 45 struct omap2430_glue { 46 struct device *dev; 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; 51 }; 52 #define glue_to_musb(g) platform_get_drvdata(g->musb) 53 54 struct omap2430_glue *_glue; 55 56 static struct timer_list musb_idle_timer; 57 58 static void musb_do_idle(unsigned long _musb) 59 { 60 struct musb *musb = (void *)_musb; 61 unsigned long flags; 62 u8 power; 63 u8 devctl; 64 65 spin_lock_irqsave(&musb->lock, flags); 66 67 switch (musb->xceiv->state) { 68 case OTG_STATE_A_WAIT_BCON: 69 70 devctl = musb_readb(musb->mregs, MUSB_DEVCTL); 71 if (devctl & MUSB_DEVCTL_BDEVICE) { 72 musb->xceiv->state = OTG_STATE_B_IDLE; 73 MUSB_DEV_MODE(musb); 74 } else { 75 musb->xceiv->state = OTG_STATE_A_IDLE; 76 MUSB_HST_MODE(musb); 77 } 78 break; 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); 86 musb->is_active = 1; 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; 93 } 94 break; 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; 99 else 100 musb->xceiv->state = OTG_STATE_A_WAIT_BCON; 101 default: 102 break; 103 } 104 spin_unlock_irqrestore(&musb->lock, flags); 105 } 106 107 108 static void omap2430_musb_try_idle(struct musb *musb, unsigned long timeout) 109 { 110 unsigned long default_timeout = jiffies + msecs_to_jiffies(3); 111 static unsigned long last_timer; 112 113 if (timeout == 0) 114 timeout = default_timeout; 115 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; 123 return; 124 } 125 126 if (time_after(last_timer, timeout)) { 127 if (!timer_pending(&musb_idle_timer)) 128 last_timer = timeout; 129 else { 130 dev_dbg(musb->controller, "Longer idle timer already pending, ignoring\n"); 131 return; 132 } 133 } 134 last_timer = timeout; 135 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); 140 } 141 142 static void omap2430_musb_set_vbus(struct musb *musb, int is_on) 143 { 144 struct usb_otg *otg = musb->xceiv->otg; 145 u8 devctl; 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. 150 */ 151 152 devctl = musb_readb(musb->mregs, MUSB_DEVCTL); 153 154 if (is_on) { 155 if (musb->xceiv->state == OTG_STATE_A_IDLE) { 156 int loops = 100; 157 /* start the session */ 158 devctl |= MUSB_DEVCTL_SESSION; 159 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl); 160 /* 161 * Wait for the musb to set as A device to enable the 162 * VBUS 163 */ 164 while (musb_readb(musb->mregs, MUSB_DEVCTL) & 0x80) { 165 166 mdelay(5); 167 cpu_relax(); 168 169 if (time_after(jiffies, timeout) 170 || loops-- <= 0) { 171 dev_err(musb->controller, 172 "configured as A device timeout"); 173 break; 174 } 175 } 176 177 if (otg->set_vbus) 178 otg_set_vbus(otg, 1); 179 } else { 180 musb->is_active = 1; 181 otg->default_a = 1; 182 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE; 183 devctl |= MUSB_DEVCTL_SESSION; 184 MUSB_HST_MODE(musb); 185 } 186 } else { 187 musb->is_active = 0; 188 189 /* NOTE: we're skipping A_WAIT_VFALL -> A_IDLE and 190 * jumping right to B_IDLE... 191 */ 192 193 otg->default_a = 0; 194 musb->xceiv->state = OTG_STATE_B_IDLE; 195 devctl &= ~MUSB_DEVCTL_SESSION; 196 197 MUSB_DEV_MODE(musb); 198 } 199 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl); 200 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)); 205 } 206 207 static int omap2430_musb_set_mode(struct musb *musb, u8 musb_mode) 208 { 209 u8 devctl = musb_readb(musb->mregs, MUSB_DEVCTL); 210 211 devctl |= MUSB_DEVCTL_SESSION; 212 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl); 213 214 return 0; 215 } 216 217 static inline void omap2430_low_level_exit(struct musb *musb) 218 { 219 u32 l; 220 221 /* in any role */ 222 l = musb_readl(musb->mregs, OTG_FORCESTDBY); 223 l |= ENABLEFORCE; /* enable MSTANDBY */ 224 musb_writel(musb->mregs, OTG_FORCESTDBY, l); 225 } 226 227 static inline void omap2430_low_level_init(struct musb *musb) 228 { 229 u32 l; 230 231 l = musb_readl(musb->mregs, OTG_FORCESTDBY); 232 l &= ~ENABLEFORCE; /* disable MSTANDBY */ 233 musb_writel(musb->mregs, OTG_FORCESTDBY, l); 234 } 235 236 void omap_musb_mailbox(enum omap_musb_vbus_id_status status) 237 { 238 struct omap2430_glue *glue = _glue; 239 240 if (glue && glue_to_musb(glue)) { 241 glue->status = status; 242 } else { 243 pr_err("%s: musb core is not yet ready\n", __func__); 244 return; 245 } 246 247 schedule_work(&glue->omap_musb_mailbox_work); 248 } 249 EXPORT_SYMBOL_GPL(omap_musb_mailbox); 250 251 static void omap_musb_set_mailbox(struct omap2430_glue *glue) 252 { 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; 258 259 switch (glue->status) { 260 case OMAP_MUSB_ID_GROUND: 261 dev_dbg(dev, "ID GND\n"); 262 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, 269 USB_MODE_HOST); 270 omap2430_musb_set_vbus(musb, 1); 271 } 272 break; 273 274 case OMAP_MUSB_VBUS_VALID: 275 dev_dbg(dev, "VBUS Connect\n"); 276 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); 283 break; 284 285 case OMAP_MUSB_ID_FLOAT: 286 case OMAP_MUSB_VBUS_OFF: 287 dev_dbg(dev, "VBUS Disconnect\n"); 288 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); 293 } 294 295 if (data->interface_type == MUSB_INTERFACE_UTMI) { 296 if (musb->xceiv->otg->set_vbus) 297 otg_set_vbus(musb->xceiv->otg, 0); 298 } 299 omap_control_usb_set_mode(glue->control_otghs, 300 USB_MODE_DISCONNECT); 301 break; 302 default: 303 dev_dbg(dev, "ID float\n"); 304 } 305 } 306 307 308 static void omap_musb_mailbox_work(struct work_struct *mailbox_work) 309 { 310 struct omap2430_glue *glue = container_of(mailbox_work, 311 struct omap2430_glue, omap_musb_mailbox_work); 312 omap_musb_set_mailbox(glue); 313 } 314 315 static irqreturn_t omap2430_musb_interrupt(int irq, void *__hci) 316 { 317 unsigned long flags; 318 irqreturn_t retval = IRQ_NONE; 319 struct musb *musb = __hci; 320 321 spin_lock_irqsave(&musb->lock, flags); 322 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); 326 327 if (musb->int_usb || musb->int_tx || musb->int_rx) 328 retval = musb_interrupt(musb); 329 330 spin_unlock_irqrestore(&musb->lock, flags); 331 332 return retval; 333 } 334 335 static int omap2430_musb_init(struct musb *musb) 336 { 337 u32 l; 338 int status = 0; 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; 343 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. 347 */ 348 if (dev->parent->of_node) 349 musb->xceiv = devm_usb_get_phy_by_phandle(dev->parent, 350 "usb-phy", 0); 351 else 352 musb->xceiv = devm_usb_get_phy_dev(dev, 0); 353 354 if (IS_ERR_OR_NULL(musb->xceiv)) { 355 pr_err("HS USB OTG: no transceiver configured\n"); 356 return -EPROBE_DEFER; 357 } 358 359 musb->isr = omap2430_musb_interrupt; 360 361 status = pm_runtime_get_sync(dev); 362 if (status < 0) { 363 dev_err(dev, "pm_runtime_get_sync FAILED %d\n", status); 364 goto err1; 365 } 366 367 l = musb_readl(musb->mregs, OTG_INTERFSEL); 368 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 */ 373 } else { 374 l |= ULPI_12PIN; 375 } 376 377 musb_writel(musb->mregs, OTG_INTERFSEL, l); 378 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)); 386 387 setup_timer(&musb_idle_timer, musb_do_idle, (unsigned long) musb); 388 389 if (glue->status != OMAP_MUSB_UNKNOWN) 390 omap_musb_set_mailbox(glue); 391 392 pm_runtime_put_noidle(musb->controller); 393 return 0; 394 395 err1: 396 return status; 397 } 398 399 static void omap2430_musb_enable(struct musb *musb) 400 { 401 u8 devctl; 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; 407 408 switch (glue->status) { 409 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) 413 break; 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) { 420 cpu_relax(); 421 422 if (time_after(jiffies, timeout)) { 423 dev_err(dev, "configured as A device timeout"); 424 break; 425 } 426 } 427 break; 428 429 case OMAP_MUSB_VBUS_VALID: 430 omap_control_usb_set_mode(glue->control_otghs, USB_MODE_DEVICE); 431 break; 432 433 default: 434 break; 435 } 436 } 437 438 static void omap2430_musb_disable(struct musb *musb) 439 { 440 struct device *dev = musb->controller; 441 struct omap2430_glue *glue = dev_get_drvdata(dev->parent); 442 443 if (glue->status != OMAP_MUSB_UNKNOWN) 444 omap_control_usb_set_mode(glue->control_otghs, 445 USB_MODE_DISCONNECT); 446 } 447 448 static int omap2430_musb_exit(struct musb *musb) 449 { 450 del_timer_sync(&musb_idle_timer); 451 452 omap2430_low_level_exit(musb); 453 454 return 0; 455 } 456 457 static const struct musb_platform_ops omap2430_ops = { 458 .init = omap2430_musb_init, 459 .exit = omap2430_musb_exit, 460 461 .set_mode = omap2430_musb_set_mode, 462 .try_idle = omap2430_musb_try_idle, 463 464 .set_vbus = omap2430_musb_set_vbus, 465 466 .enable = omap2430_musb_enable, 467 .disable = omap2430_musb_disable, 468 }; 469 470 static u64 omap2430_dmamask = DMA_BIT_MASK(32); 471 472 static int omap2430_probe(struct platform_device *pdev) 473 { 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; 480 int ret = -ENOMEM; 481 482 glue = devm_kzalloc(&pdev->dev, sizeof(*glue), GFP_KERNEL); 483 if (!glue) { 484 dev_err(&pdev->dev, "failed to allocate glue context\n"); 485 goto err0; 486 } 487 488 musb = platform_device_alloc("musb-hdrc", PLATFORM_DEVID_AUTO); 489 if (!musb) { 490 dev_err(&pdev->dev, "failed to allocate musb device\n"); 491 goto err0; 492 } 493 494 musb->dev.parent = &pdev->dev; 495 musb->dev.dma_mask = &omap2430_dmamask; 496 musb->dev.coherent_dma_mask = omap2430_dmamask; 497 498 glue->dev = &pdev->dev; 499 glue->musb = musb; 500 glue->status = OMAP_MUSB_UNKNOWN; 501 502 if (np) { 503 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL); 504 if (!pdata) { 505 dev_err(&pdev->dev, 506 "failed to allocate musb platfrom data\n"); 507 goto err2; 508 } 509 510 data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL); 511 if (!data) { 512 dev_err(&pdev->dev, 513 "failed to allocate musb board data\n"); 514 goto err2; 515 } 516 517 config = devm_kzalloc(&pdev->dev, sizeof(*config), GFP_KERNEL); 518 if (!config) { 519 dev_err(&pdev->dev, 520 "failed to allocate musb hdrc config\n"); 521 goto err2; 522 } 523 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, 532 "ti,has-mailbox"); 533 534 pdata->board_data = data; 535 pdata->config = config; 536 } 537 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"); 542 return -ENODEV; 543 } 544 } else { 545 glue->control_otghs = ERR_PTR(-ENODEV); 546 } 547 pdata->platform_ops = &omap2430_ops; 548 549 platform_set_drvdata(pdev, glue); 550 551 /* 552 * REVISIT if we ever have two instances of the wrapper, we will be 553 * in big trouble 554 */ 555 _glue = glue; 556 557 INIT_WORK(&glue->omap_musb_mailbox_work, omap_musb_mailbox_work); 558 559 ret = platform_device_add_resources(musb, pdev->resource, 560 pdev->num_resources); 561 if (ret) { 562 dev_err(&pdev->dev, "failed to add resources\n"); 563 goto err2; 564 } 565 566 ret = platform_device_add_data(musb, pdata, sizeof(*pdata)); 567 if (ret) { 568 dev_err(&pdev->dev, "failed to add platform_data\n"); 569 goto err2; 570 } 571 572 pm_runtime_enable(&pdev->dev); 573 574 ret = platform_device_add(musb); 575 if (ret) { 576 dev_err(&pdev->dev, "failed to register musb device\n"); 577 goto err2; 578 } 579 580 return 0; 581 582 err2: 583 platform_device_put(musb); 584 585 err0: 586 return ret; 587 } 588 589 static int omap2430_remove(struct platform_device *pdev) 590 { 591 struct omap2430_glue *glue = platform_get_drvdata(pdev); 592 593 cancel_work_sync(&glue->omap_musb_mailbox_work); 594 platform_device_unregister(glue->musb); 595 596 return 0; 597 } 598 599 #ifdef CONFIG_PM 600 601 static int omap2430_runtime_suspend(struct device *dev) 602 { 603 struct omap2430_glue *glue = dev_get_drvdata(dev); 604 struct musb *musb = glue_to_musb(glue); 605 606 if (musb) { 607 musb->context.otg_interfsel = musb_readl(musb->mregs, 608 OTG_INTERFSEL); 609 610 omap2430_low_level_exit(musb); 611 usb_phy_set_suspend(musb->xceiv, 1); 612 } 613 614 return 0; 615 } 616 617 static int omap2430_runtime_resume(struct device *dev) 618 { 619 struct omap2430_glue *glue = dev_get_drvdata(dev); 620 struct musb *musb = glue_to_musb(glue); 621 622 if (musb) { 623 omap2430_low_level_init(musb); 624 musb_writel(musb->mregs, OTG_INTERFSEL, 625 musb->context.otg_interfsel); 626 627 usb_phy_set_suspend(musb->xceiv, 0); 628 } 629 630 return 0; 631 } 632 633 static struct dev_pm_ops omap2430_pm_ops = { 634 .runtime_suspend = omap2430_runtime_suspend, 635 .runtime_resume = omap2430_runtime_resume, 636 }; 637 638 #define DEV_PM_OPS (&omap2430_pm_ops) 639 #else 640 #define DEV_PM_OPS NULL 641 #endif 642 643 #ifdef CONFIG_OF 644 static const struct of_device_id omap2430_id_table[] = { 645 { 646 .compatible = "ti,omap4-musb" 647 }, 648 { 649 .compatible = "ti,omap3-musb" 650 }, 651 {}, 652 }; 653 MODULE_DEVICE_TABLE(of, omap2430_id_table); 654 #endif 655 656 static struct platform_driver omap2430_driver = { 657 .probe = omap2430_probe, 658 .remove = omap2430_remove, 659 .driver = { 660 .name = "musb-omap2430", 661 .pm = DEV_PM_OPS, 662 .of_match_table = of_match_ptr(omap2430_id_table), 663 }, 664 }; 665 666 MODULE_DESCRIPTION("OMAP2PLUS MUSB Glue Layer"); 667 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>"); 668 MODULE_LICENSE("GPL v2"); 669 670 static int __init omap2430_init(void) 671 { 672 return platform_driver_register(&omap2430_driver); 673 } 674 subsys_initcall(omap2430_init); 675 676 static void __exit omap2430_exit(void) 677 { 678 platform_driver_unregister(&omap2430_driver); 679 } 680 module_exit(omap2430_exit); 681