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/platform_device.h> 34 #include <linux/dma-mapping.h> 35 #include <linux/pm_runtime.h> 36 #include <linux/err.h> 37 #include <linux/usb/musb-omap.h> 38 39 #include "musb_core.h" 40 #include "omap2430.h" 41 42 struct omap2430_glue { 43 struct device *dev; 44 struct platform_device *musb; 45 enum omap_musb_vbus_id_status status; 46 struct work_struct omap_musb_mailbox_work; 47 }; 48 #define glue_to_musb(g) platform_get_drvdata(g->musb) 49 50 struct omap2430_glue *_glue; 51 52 static struct timer_list musb_idle_timer; 53 54 static void musb_do_idle(unsigned long _musb) 55 { 56 struct musb *musb = (void *)_musb; 57 unsigned long flags; 58 u8 power; 59 u8 devctl; 60 61 spin_lock_irqsave(&musb->lock, flags); 62 63 switch (musb->xceiv->state) { 64 case OTG_STATE_A_WAIT_BCON: 65 66 devctl = musb_readb(musb->mregs, MUSB_DEVCTL); 67 if (devctl & MUSB_DEVCTL_BDEVICE) { 68 musb->xceiv->state = OTG_STATE_B_IDLE; 69 MUSB_DEV_MODE(musb); 70 } else { 71 musb->xceiv->state = OTG_STATE_A_IDLE; 72 MUSB_HST_MODE(musb); 73 } 74 break; 75 case OTG_STATE_A_SUSPEND: 76 /* finish RESUME signaling? */ 77 if (musb->port1_status & MUSB_PORT_STAT_RESUME) { 78 power = musb_readb(musb->mregs, MUSB_POWER); 79 power &= ~MUSB_POWER_RESUME; 80 dev_dbg(musb->controller, "root port resume stopped, power %02x\n", power); 81 musb_writeb(musb->mregs, MUSB_POWER, power); 82 musb->is_active = 1; 83 musb->port1_status &= ~(USB_PORT_STAT_SUSPEND 84 | MUSB_PORT_STAT_RESUME); 85 musb->port1_status |= USB_PORT_STAT_C_SUSPEND << 16; 86 usb_hcd_poll_rh_status(musb_to_hcd(musb)); 87 /* NOTE: it might really be A_WAIT_BCON ... */ 88 musb->xceiv->state = OTG_STATE_A_HOST; 89 } 90 break; 91 case OTG_STATE_A_HOST: 92 devctl = musb_readb(musb->mregs, MUSB_DEVCTL); 93 if (devctl & MUSB_DEVCTL_BDEVICE) 94 musb->xceiv->state = OTG_STATE_B_IDLE; 95 else 96 musb->xceiv->state = OTG_STATE_A_WAIT_BCON; 97 default: 98 break; 99 } 100 spin_unlock_irqrestore(&musb->lock, flags); 101 } 102 103 104 static void omap2430_musb_try_idle(struct musb *musb, unsigned long timeout) 105 { 106 unsigned long default_timeout = jiffies + msecs_to_jiffies(3); 107 static unsigned long last_timer; 108 109 if (timeout == 0) 110 timeout = default_timeout; 111 112 /* Never idle if active, or when VBUS timeout is not set as host */ 113 if (musb->is_active || ((musb->a_wait_bcon == 0) 114 && (musb->xceiv->state == OTG_STATE_A_WAIT_BCON))) { 115 dev_dbg(musb->controller, "%s active, deleting timer\n", 116 otg_state_string(musb->xceiv->state)); 117 del_timer(&musb_idle_timer); 118 last_timer = jiffies; 119 return; 120 } 121 122 if (time_after(last_timer, timeout)) { 123 if (!timer_pending(&musb_idle_timer)) 124 last_timer = timeout; 125 else { 126 dev_dbg(musb->controller, "Longer idle timer already pending, ignoring\n"); 127 return; 128 } 129 } 130 last_timer = timeout; 131 132 dev_dbg(musb->controller, "%s inactive, for idle timer for %lu ms\n", 133 otg_state_string(musb->xceiv->state), 134 (unsigned long)jiffies_to_msecs(timeout - jiffies)); 135 mod_timer(&musb_idle_timer, timeout); 136 } 137 138 static void omap2430_musb_set_vbus(struct musb *musb, int is_on) 139 { 140 struct usb_otg *otg = musb->xceiv->otg; 141 u8 devctl; 142 unsigned long timeout = jiffies + msecs_to_jiffies(1000); 143 int ret = 1; 144 /* HDRC controls CPEN, but beware current surges during device 145 * connect. They can trigger transient overcurrent conditions 146 * that must be ignored. 147 */ 148 149 devctl = musb_readb(musb->mregs, MUSB_DEVCTL); 150 151 if (is_on) { 152 if (musb->xceiv->state == OTG_STATE_A_IDLE) { 153 /* start the session */ 154 devctl |= MUSB_DEVCTL_SESSION; 155 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl); 156 /* 157 * Wait for the musb to set as A device to enable the 158 * VBUS 159 */ 160 while (musb_readb(musb->mregs, MUSB_DEVCTL) & 0x80) { 161 162 cpu_relax(); 163 164 if (time_after(jiffies, timeout)) { 165 dev_err(musb->controller, 166 "configured as A device timeout"); 167 ret = -EINVAL; 168 break; 169 } 170 } 171 172 if (ret && otg->set_vbus) 173 otg_set_vbus(otg, 1); 174 } else { 175 musb->is_active = 1; 176 otg->default_a = 1; 177 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE; 178 devctl |= MUSB_DEVCTL_SESSION; 179 MUSB_HST_MODE(musb); 180 } 181 } else { 182 musb->is_active = 0; 183 184 /* NOTE: we're skipping A_WAIT_VFALL -> A_IDLE and 185 * jumping right to B_IDLE... 186 */ 187 188 otg->default_a = 0; 189 musb->xceiv->state = OTG_STATE_B_IDLE; 190 devctl &= ~MUSB_DEVCTL_SESSION; 191 192 MUSB_DEV_MODE(musb); 193 } 194 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl); 195 196 dev_dbg(musb->controller, "VBUS %s, devctl %02x " 197 /* otg %3x conf %08x prcm %08x */ "\n", 198 otg_state_string(musb->xceiv->state), 199 musb_readb(musb->mregs, MUSB_DEVCTL)); 200 } 201 202 static int omap2430_musb_set_mode(struct musb *musb, u8 musb_mode) 203 { 204 u8 devctl = musb_readb(musb->mregs, MUSB_DEVCTL); 205 206 devctl |= MUSB_DEVCTL_SESSION; 207 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl); 208 209 return 0; 210 } 211 212 static inline void omap2430_low_level_exit(struct musb *musb) 213 { 214 u32 l; 215 216 /* in any role */ 217 l = musb_readl(musb->mregs, OTG_FORCESTDBY); 218 l |= ENABLEFORCE; /* enable MSTANDBY */ 219 musb_writel(musb->mregs, OTG_FORCESTDBY, l); 220 } 221 222 static inline void omap2430_low_level_init(struct musb *musb) 223 { 224 u32 l; 225 226 l = musb_readl(musb->mregs, OTG_FORCESTDBY); 227 l &= ~ENABLEFORCE; /* disable MSTANDBY */ 228 musb_writel(musb->mregs, OTG_FORCESTDBY, l); 229 } 230 231 void omap_musb_mailbox(enum omap_musb_vbus_id_status status) 232 { 233 struct omap2430_glue *glue = _glue; 234 struct musb *musb = glue_to_musb(glue); 235 236 glue->status = status; 237 if (!musb) { 238 dev_err(glue->dev, "musb core is not yet ready\n"); 239 return; 240 } 241 242 schedule_work(&glue->omap_musb_mailbox_work); 243 } 244 EXPORT_SYMBOL_GPL(omap_musb_mailbox); 245 246 static void omap_musb_set_mailbox(struct omap2430_glue *glue) 247 { 248 struct musb *musb = glue_to_musb(glue); 249 struct device *dev = musb->controller; 250 struct musb_hdrc_platform_data *pdata = dev->platform_data; 251 struct omap_musb_board_data *data = pdata->board_data; 252 struct usb_otg *otg = musb->xceiv->otg; 253 254 switch (glue->status) { 255 case OMAP_MUSB_ID_GROUND: 256 dev_dbg(dev, "ID GND\n"); 257 258 otg->default_a = true; 259 musb->xceiv->state = OTG_STATE_A_IDLE; 260 musb->xceiv->last_event = USB_EVENT_ID; 261 if (!is_otg_enabled(musb) || musb->gadget_driver) { 262 pm_runtime_get_sync(dev); 263 usb_phy_init(musb->xceiv); 264 omap2430_musb_set_vbus(musb, 1); 265 } 266 break; 267 268 case OMAP_MUSB_VBUS_VALID: 269 dev_dbg(dev, "VBUS Connect\n"); 270 271 otg->default_a = false; 272 musb->xceiv->state = OTG_STATE_B_IDLE; 273 musb->xceiv->last_event = USB_EVENT_VBUS; 274 if (musb->gadget_driver) 275 pm_runtime_get_sync(dev); 276 usb_phy_init(musb->xceiv); 277 break; 278 279 case OMAP_MUSB_ID_FLOAT: 280 case OMAP_MUSB_VBUS_OFF: 281 dev_dbg(dev, "VBUS Disconnect\n"); 282 283 musb->xceiv->last_event = USB_EVENT_NONE; 284 if (is_otg_enabled(musb) || is_peripheral_enabled(musb)) 285 if (musb->gadget_driver) { 286 pm_runtime_mark_last_busy(dev); 287 pm_runtime_put_autosuspend(dev); 288 } 289 290 if (data->interface_type == MUSB_INTERFACE_UTMI) { 291 if (musb->xceiv->otg->set_vbus) 292 otg_set_vbus(musb->xceiv->otg, 0); 293 } 294 usb_phy_shutdown(musb->xceiv); 295 break; 296 default: 297 dev_dbg(dev, "ID float\n"); 298 } 299 } 300 301 302 static void omap_musb_mailbox_work(struct work_struct *mailbox_work) 303 { 304 struct omap2430_glue *glue = container_of(mailbox_work, 305 struct omap2430_glue, omap_musb_mailbox_work); 306 omap_musb_set_mailbox(glue); 307 } 308 309 static int omap2430_musb_init(struct musb *musb) 310 { 311 u32 l; 312 int status = 0; 313 struct device *dev = musb->controller; 314 struct omap2430_glue *glue = dev_get_drvdata(dev->parent); 315 struct musb_hdrc_platform_data *plat = dev->platform_data; 316 struct omap_musb_board_data *data = plat->board_data; 317 318 /* We require some kind of external transceiver, hooked 319 * up through ULPI. TWL4030-family PMICs include one, 320 * which needs a driver, drivers aren't always needed. 321 */ 322 musb->xceiv = devm_usb_get_phy(dev, USB_PHY_TYPE_USB2); 323 if (IS_ERR_OR_NULL(musb->xceiv)) { 324 pr_err("HS USB OTG: no transceiver configured\n"); 325 return -ENODEV; 326 } 327 328 status = pm_runtime_get_sync(dev); 329 if (status < 0) { 330 dev_err(dev, "pm_runtime_get_sync FAILED %d\n", status); 331 goto err1; 332 } 333 334 l = musb_readl(musb->mregs, OTG_INTERFSEL); 335 336 if (data->interface_type == MUSB_INTERFACE_UTMI) { 337 /* OMAP4 uses Internal PHY GS70 which uses UTMI interface */ 338 l &= ~ULPI_12PIN; /* Disable ULPI */ 339 l |= UTMI_8BIT; /* Enable UTMI */ 340 } else { 341 l |= ULPI_12PIN; 342 } 343 344 musb_writel(musb->mregs, OTG_INTERFSEL, l); 345 346 pr_debug("HS USB OTG: revision 0x%x, sysconfig 0x%02x, " 347 "sysstatus 0x%x, intrfsel 0x%x, simenable 0x%x\n", 348 musb_readl(musb->mregs, OTG_REVISION), 349 musb_readl(musb->mregs, OTG_SYSCONFIG), 350 musb_readl(musb->mregs, OTG_SYSSTATUS), 351 musb_readl(musb->mregs, OTG_INTERFSEL), 352 musb_readl(musb->mregs, OTG_SIMENABLE)); 353 354 setup_timer(&musb_idle_timer, musb_do_idle, (unsigned long) musb); 355 356 if (glue->status != OMAP_MUSB_UNKNOWN) 357 omap_musb_set_mailbox(glue); 358 359 pm_runtime_put_noidle(musb->controller); 360 return 0; 361 362 err1: 363 return status; 364 } 365 366 static void omap2430_musb_enable(struct musb *musb) 367 { 368 u8 devctl; 369 unsigned long timeout = jiffies + msecs_to_jiffies(1000); 370 struct device *dev = musb->controller; 371 struct omap2430_glue *glue = dev_get_drvdata(dev->parent); 372 struct musb_hdrc_platform_data *pdata = dev->platform_data; 373 struct omap_musb_board_data *data = pdata->board_data; 374 375 switch (glue->status) { 376 377 case OMAP_MUSB_ID_GROUND: 378 usb_phy_init(musb->xceiv); 379 if (data->interface_type != MUSB_INTERFACE_UTMI) 380 break; 381 devctl = musb_readb(musb->mregs, MUSB_DEVCTL); 382 /* start the session */ 383 devctl |= MUSB_DEVCTL_SESSION; 384 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl); 385 while (musb_readb(musb->mregs, MUSB_DEVCTL) & 386 MUSB_DEVCTL_BDEVICE) { 387 cpu_relax(); 388 389 if (time_after(jiffies, timeout)) { 390 dev_err(dev, "configured as A device timeout"); 391 break; 392 } 393 } 394 break; 395 396 case OMAP_MUSB_VBUS_VALID: 397 usb_phy_init(musb->xceiv); 398 break; 399 400 default: 401 break; 402 } 403 } 404 405 static void omap2430_musb_disable(struct musb *musb) 406 { 407 struct device *dev = musb->controller; 408 struct omap2430_glue *glue = dev_get_drvdata(dev->parent); 409 410 if (glue->status != OMAP_MUSB_UNKNOWN) 411 usb_phy_shutdown(musb->xceiv); 412 } 413 414 static int omap2430_musb_exit(struct musb *musb) 415 { 416 del_timer_sync(&musb_idle_timer); 417 418 omap2430_low_level_exit(musb); 419 420 return 0; 421 } 422 423 static const struct musb_platform_ops omap2430_ops = { 424 .init = omap2430_musb_init, 425 .exit = omap2430_musb_exit, 426 427 .set_mode = omap2430_musb_set_mode, 428 .try_idle = omap2430_musb_try_idle, 429 430 .set_vbus = omap2430_musb_set_vbus, 431 432 .enable = omap2430_musb_enable, 433 .disable = omap2430_musb_disable, 434 }; 435 436 static u64 omap2430_dmamask = DMA_BIT_MASK(32); 437 438 static int __devinit omap2430_probe(struct platform_device *pdev) 439 { 440 struct musb_hdrc_platform_data *pdata = pdev->dev.platform_data; 441 struct platform_device *musb; 442 struct omap2430_glue *glue; 443 int ret = -ENOMEM; 444 445 glue = devm_kzalloc(&pdev->dev, sizeof(*glue), GFP_KERNEL); 446 if (!glue) { 447 dev_err(&pdev->dev, "failed to allocate glue context\n"); 448 goto err0; 449 } 450 451 musb = platform_device_alloc("musb-hdrc", -1); 452 if (!musb) { 453 dev_err(&pdev->dev, "failed to allocate musb device\n"); 454 goto err0; 455 } 456 457 musb->dev.parent = &pdev->dev; 458 musb->dev.dma_mask = &omap2430_dmamask; 459 musb->dev.coherent_dma_mask = omap2430_dmamask; 460 461 glue->dev = &pdev->dev; 462 glue->musb = musb; 463 glue->status = OMAP_MUSB_UNKNOWN; 464 465 pdata->platform_ops = &omap2430_ops; 466 467 platform_set_drvdata(pdev, glue); 468 469 /* 470 * REVISIT if we ever have two instances of the wrapper, we will be 471 * in big trouble 472 */ 473 _glue = glue; 474 475 INIT_WORK(&glue->omap_musb_mailbox_work, omap_musb_mailbox_work); 476 477 ret = platform_device_add_resources(musb, pdev->resource, 478 pdev->num_resources); 479 if (ret) { 480 dev_err(&pdev->dev, "failed to add resources\n"); 481 goto err1; 482 } 483 484 ret = platform_device_add_data(musb, pdata, sizeof(*pdata)); 485 if (ret) { 486 dev_err(&pdev->dev, "failed to add platform_data\n"); 487 goto err1; 488 } 489 490 pm_runtime_enable(&pdev->dev); 491 492 ret = platform_device_add(musb); 493 if (ret) { 494 dev_err(&pdev->dev, "failed to register musb device\n"); 495 goto err1; 496 } 497 498 return 0; 499 500 err1: 501 platform_device_put(musb); 502 503 err0: 504 return ret; 505 } 506 507 static int __devexit omap2430_remove(struct platform_device *pdev) 508 { 509 struct omap2430_glue *glue = platform_get_drvdata(pdev); 510 511 cancel_work_sync(&glue->omap_musb_mailbox_work); 512 platform_device_del(glue->musb); 513 platform_device_put(glue->musb); 514 515 return 0; 516 } 517 518 #ifdef CONFIG_PM 519 520 static int omap2430_runtime_suspend(struct device *dev) 521 { 522 struct omap2430_glue *glue = dev_get_drvdata(dev); 523 struct musb *musb = glue_to_musb(glue); 524 525 if (musb) { 526 musb->context.otg_interfsel = musb_readl(musb->mregs, 527 OTG_INTERFSEL); 528 529 omap2430_low_level_exit(musb); 530 usb_phy_set_suspend(musb->xceiv, 1); 531 } 532 533 return 0; 534 } 535 536 static int omap2430_runtime_resume(struct device *dev) 537 { 538 struct omap2430_glue *glue = dev_get_drvdata(dev); 539 struct musb *musb = glue_to_musb(glue); 540 541 if (musb) { 542 omap2430_low_level_init(musb); 543 musb_writel(musb->mregs, OTG_INTERFSEL, 544 musb->context.otg_interfsel); 545 546 usb_phy_set_suspend(musb->xceiv, 0); 547 } 548 549 return 0; 550 } 551 552 static struct dev_pm_ops omap2430_pm_ops = { 553 .runtime_suspend = omap2430_runtime_suspend, 554 .runtime_resume = omap2430_runtime_resume, 555 }; 556 557 #define DEV_PM_OPS (&omap2430_pm_ops) 558 #else 559 #define DEV_PM_OPS NULL 560 #endif 561 562 static struct platform_driver omap2430_driver = { 563 .probe = omap2430_probe, 564 .remove = __devexit_p(omap2430_remove), 565 .driver = { 566 .name = "musb-omap2430", 567 .pm = DEV_PM_OPS, 568 }, 569 }; 570 571 MODULE_DESCRIPTION("OMAP2PLUS MUSB Glue Layer"); 572 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>"); 573 MODULE_LICENSE("GPL v2"); 574 575 static int __init omap2430_init(void) 576 { 577 return platform_driver_register(&omap2430_driver); 578 } 579 subsys_initcall(omap2430_init); 580 581 static void __exit omap2430_exit(void) 582 { 583 platform_driver_unregister(&omap2430_driver); 584 } 585 module_exit(omap2430_exit); 586