1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * Copyright (C) 2005-2007 by Texas Instruments 4 * Some code has been taken from tusb6010.c 5 * Copyrights for that are attributable to: 6 * Copyright (C) 2006 Nokia Corporation 7 * Tony Lindgren <tony@atomide.com> 8 * 9 * This file is part of the Inventra Controller Driver for Linux. 10 */ 11 #include <linux/module.h> 12 #include <linux/kernel.h> 13 #include <linux/sched.h> 14 #include <linux/init.h> 15 #include <linux/list.h> 16 #include <linux/io.h> 17 #include <linux/of.h> 18 #include <linux/of_irq.h> 19 #include <linux/platform_device.h> 20 #include <linux/dma-mapping.h> 21 #include <linux/pm_runtime.h> 22 #include <linux/err.h> 23 #include <linux/delay.h> 24 #include <linux/usb/musb.h> 25 #include <linux/phy/omap_control_phy.h> 26 #include <linux/of_platform.h> 27 28 #include "musb_core.h" 29 #include "omap2430.h" 30 31 struct omap2430_glue { 32 struct device *dev; 33 struct platform_device *musb; 34 enum musb_vbus_id_status status; 35 struct work_struct omap_musb_mailbox_work; 36 struct device *control_otghs; 37 unsigned int is_runtime_suspended:1; 38 unsigned int needs_resume:1; 39 unsigned int phy_suspended:1; 40 }; 41 #define glue_to_musb(g) platform_get_drvdata(g->musb) 42 43 static struct omap2430_glue *_glue; 44 45 static inline void omap2430_low_level_exit(struct musb *musb) 46 { 47 u32 l; 48 49 /* in any role */ 50 l = musb_readl(musb->mregs, OTG_FORCESTDBY); 51 l |= ENABLEFORCE; /* enable MSTANDBY */ 52 musb_writel(musb->mregs, OTG_FORCESTDBY, l); 53 } 54 55 static inline void omap2430_low_level_init(struct musb *musb) 56 { 57 u32 l; 58 59 l = musb_readl(musb->mregs, OTG_FORCESTDBY); 60 l &= ~ENABLEFORCE; /* disable MSTANDBY */ 61 musb_writel(musb->mregs, OTG_FORCESTDBY, l); 62 } 63 64 static int omap2430_musb_mailbox(enum musb_vbus_id_status status) 65 { 66 struct omap2430_glue *glue = _glue; 67 68 if (!glue) { 69 pr_err("%s: musb core is not yet initialized\n", __func__); 70 return -EPROBE_DEFER; 71 } 72 glue->status = status; 73 74 if (!glue_to_musb(glue)) { 75 pr_err("%s: musb core is not yet ready\n", __func__); 76 return -EPROBE_DEFER; 77 } 78 79 schedule_work(&glue->omap_musb_mailbox_work); 80 81 return 0; 82 } 83 84 /* 85 * HDRC controls CPEN, but beware current surges during device connect. 86 * They can trigger transient overcurrent conditions that must be ignored. 87 * 88 * Note that we're skipping A_WAIT_VFALL -> A_IDLE and jumping right to B_IDLE 89 * as set by musb_set_peripheral(). 90 */ 91 static void omap_musb_set_mailbox(struct omap2430_glue *glue) 92 { 93 struct musb *musb = glue_to_musb(glue); 94 int error; 95 96 pm_runtime_get_sync(musb->controller); 97 98 dev_dbg(musb->controller, "VBUS %s, devctl %02x\n", 99 usb_otg_state_string(musb->xceiv->otg->state), 100 musb_readb(musb->mregs, MUSB_DEVCTL)); 101 102 switch (glue->status) { 103 case MUSB_ID_GROUND: 104 dev_dbg(musb->controller, "ID GND\n"); 105 switch (musb->xceiv->otg->state) { 106 case OTG_STATE_A_IDLE: 107 error = musb_set_host(musb); 108 if (error) 109 break; 110 musb->xceiv->otg->state = OTG_STATE_A_WAIT_VRISE; 111 fallthrough; 112 case OTG_STATE_A_WAIT_VRISE: 113 case OTG_STATE_A_WAIT_BCON: 114 case OTG_STATE_A_HOST: 115 /* 116 * On multiple ID ground interrupts just keep enabling 117 * VBUS. At least cpcap VBUS shuts down otherwise. 118 */ 119 otg_set_vbus(musb->xceiv->otg, 1); 120 break; 121 default: 122 musb->xceiv->otg->state = OTG_STATE_A_IDLE; 123 musb->xceiv->last_event = USB_EVENT_ID; 124 if (musb->gadget_driver) { 125 omap_control_usb_set_mode(glue->control_otghs, 126 USB_MODE_HOST); 127 otg_set_vbus(musb->xceiv->otg, 1); 128 } 129 break; 130 } 131 break; 132 133 case MUSB_VBUS_VALID: 134 dev_dbg(musb->controller, "VBUS Connect\n"); 135 136 musb->xceiv->otg->state = OTG_STATE_B_IDLE; 137 musb->xceiv->last_event = USB_EVENT_VBUS; 138 omap_control_usb_set_mode(glue->control_otghs, USB_MODE_DEVICE); 139 break; 140 141 case MUSB_ID_FLOAT: 142 case MUSB_VBUS_OFF: 143 dev_dbg(musb->controller, "VBUS Disconnect\n"); 144 145 musb->xceiv->last_event = USB_EVENT_NONE; 146 musb_set_peripheral(musb); 147 otg_set_vbus(musb->xceiv->otg, 0); 148 omap_control_usb_set_mode(glue->control_otghs, 149 USB_MODE_DISCONNECT); 150 break; 151 default: 152 dev_dbg(musb->controller, "ID float\n"); 153 } 154 pm_runtime_mark_last_busy(musb->controller); 155 pm_runtime_put_autosuspend(musb->controller); 156 atomic_notifier_call_chain(&musb->xceiv->notifier, 157 musb->xceiv->last_event, NULL); 158 } 159 160 161 static void omap_musb_mailbox_work(struct work_struct *mailbox_work) 162 { 163 struct omap2430_glue *glue = container_of(mailbox_work, 164 struct omap2430_glue, omap_musb_mailbox_work); 165 166 omap_musb_set_mailbox(glue); 167 } 168 169 static irqreturn_t omap2430_musb_interrupt(int irq, void *__hci) 170 { 171 unsigned long flags; 172 irqreturn_t retval = IRQ_NONE; 173 struct musb *musb = __hci; 174 175 spin_lock_irqsave(&musb->lock, flags); 176 177 musb->int_usb = musb_readb(musb->mregs, MUSB_INTRUSB); 178 musb->int_tx = musb_readw(musb->mregs, MUSB_INTRTX); 179 musb->int_rx = musb_readw(musb->mregs, MUSB_INTRRX); 180 181 if (musb->int_usb || musb->int_tx || musb->int_rx) 182 retval = musb_interrupt(musb); 183 184 spin_unlock_irqrestore(&musb->lock, flags); 185 186 return retval; 187 } 188 189 static int omap2430_musb_init(struct musb *musb) 190 { 191 u32 l; 192 int status = 0; 193 struct device *dev = musb->controller; 194 struct musb_hdrc_platform_data *plat = dev_get_platdata(dev); 195 struct omap_musb_board_data *data = plat->board_data; 196 197 /* We require some kind of external transceiver, hooked 198 * up through ULPI. TWL4030-family PMICs include one, 199 * which needs a driver, drivers aren't always needed. 200 */ 201 musb->phy = devm_phy_get(dev->parent, "usb2-phy"); 202 203 /* We can't totally remove musb->xceiv as of now because 204 * musb core uses xceiv.state and xceiv.otg. Once we have 205 * a separate state machine to handle otg, these can be moved 206 * out of xceiv and then we can start using the generic PHY 207 * framework 208 */ 209 musb->xceiv = devm_usb_get_phy_by_phandle(dev->parent, "usb-phy", 0); 210 211 if (IS_ERR(musb->xceiv)) { 212 status = PTR_ERR(musb->xceiv); 213 214 if (status == -ENXIO) 215 return status; 216 217 dev_dbg(dev, "HS USB OTG: no transceiver configured\n"); 218 return -EPROBE_DEFER; 219 } 220 221 if (IS_ERR(musb->phy)) { 222 dev_err(dev, "HS USB OTG: no PHY configured\n"); 223 return PTR_ERR(musb->phy); 224 } 225 musb->isr = omap2430_musb_interrupt; 226 phy_init(musb->phy); 227 phy_power_on(musb->phy); 228 229 l = musb_readl(musb->mregs, OTG_INTERFSEL); 230 231 if (data->interface_type == MUSB_INTERFACE_UTMI) { 232 /* OMAP4 uses Internal PHY GS70 which uses UTMI interface */ 233 l &= ~ULPI_12PIN; /* Disable ULPI */ 234 l |= UTMI_8BIT; /* Enable UTMI */ 235 } else { 236 l |= ULPI_12PIN; 237 } 238 239 musb_writel(musb->mregs, OTG_INTERFSEL, l); 240 241 dev_dbg(dev, "HS USB OTG: revision 0x%x, sysconfig 0x%02x, " 242 "sysstatus 0x%x, intrfsel 0x%x, simenable 0x%x\n", 243 musb_readl(musb->mregs, OTG_REVISION), 244 musb_readl(musb->mregs, OTG_SYSCONFIG), 245 musb_readl(musb->mregs, OTG_SYSSTATUS), 246 musb_readl(musb->mregs, OTG_INTERFSEL), 247 musb_readl(musb->mregs, OTG_SIMENABLE)); 248 249 return 0; 250 } 251 252 static void omap2430_musb_enable(struct musb *musb) 253 { 254 struct device *dev = musb->controller; 255 struct omap2430_glue *glue = dev_get_drvdata(dev->parent); 256 257 if (glue->status == MUSB_UNKNOWN) 258 glue->status = MUSB_VBUS_OFF; 259 omap_musb_set_mailbox(glue); 260 } 261 262 static void omap2430_musb_disable(struct musb *musb) 263 { 264 struct device *dev = musb->controller; 265 struct omap2430_glue *glue = dev_get_drvdata(dev->parent); 266 267 if (glue->status != MUSB_UNKNOWN) 268 omap_control_usb_set_mode(glue->control_otghs, 269 USB_MODE_DISCONNECT); 270 } 271 272 static int omap2430_musb_exit(struct musb *musb) 273 { 274 struct device *dev = musb->controller; 275 struct omap2430_glue *glue = dev_get_drvdata(dev->parent); 276 277 omap2430_low_level_exit(musb); 278 phy_power_off(musb->phy); 279 phy_exit(musb->phy); 280 musb->phy = NULL; 281 cancel_work_sync(&glue->omap_musb_mailbox_work); 282 283 return 0; 284 } 285 286 static const struct musb_platform_ops omap2430_ops = { 287 .quirks = MUSB_DMA_INVENTRA, 288 #ifdef CONFIG_USB_INVENTRA_DMA 289 .dma_init = musbhs_dma_controller_create, 290 .dma_exit = musbhs_dma_controller_destroy, 291 #endif 292 .init = omap2430_musb_init, 293 .exit = omap2430_musb_exit, 294 295 .enable = omap2430_musb_enable, 296 .disable = omap2430_musb_disable, 297 298 .phy_callback = omap2430_musb_mailbox, 299 }; 300 301 static u64 omap2430_dmamask = DMA_BIT_MASK(32); 302 303 static int omap2430_probe(struct platform_device *pdev) 304 { 305 struct musb_hdrc_platform_data *pdata = dev_get_platdata(&pdev->dev); 306 struct omap_musb_board_data *data; 307 struct platform_device *musb; 308 struct omap2430_glue *glue; 309 struct device_node *np = pdev->dev.of_node; 310 struct musb_hdrc_config *config; 311 struct device_node *control_node; 312 struct platform_device *control_pdev; 313 int ret = -ENOMEM, val; 314 bool populate_irqs = false; 315 316 if (!np) 317 return -ENODEV; 318 319 glue = devm_kzalloc(&pdev->dev, sizeof(*glue), GFP_KERNEL); 320 if (!glue) 321 goto err0; 322 323 musb = platform_device_alloc("musb-hdrc", PLATFORM_DEVID_AUTO); 324 if (!musb) { 325 dev_err(&pdev->dev, "failed to allocate musb device\n"); 326 goto err0; 327 } 328 329 musb->dev.parent = &pdev->dev; 330 musb->dev.dma_mask = &omap2430_dmamask; 331 musb->dev.coherent_dma_mask = omap2430_dmamask; 332 333 /* 334 * Legacy SoCs using omap_device get confused if node is moved 335 * because of interconnect properties mixed into the node. 336 */ 337 if (of_get_property(np, "ti,hwmods", NULL)) { 338 dev_warn(&pdev->dev, "please update to probe with ti-sysc\n"); 339 populate_irqs = true; 340 } else { 341 device_set_of_node_from_dev(&musb->dev, &pdev->dev); 342 } 343 of_node_put(np); 344 345 glue->dev = &pdev->dev; 346 glue->musb = musb; 347 glue->status = MUSB_UNKNOWN; 348 glue->control_otghs = ERR_PTR(-ENODEV); 349 350 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL); 351 if (!pdata) 352 goto err2; 353 354 data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL); 355 if (!data) 356 goto err2; 357 358 config = devm_kzalloc(&pdev->dev, sizeof(*config), GFP_KERNEL); 359 if (!config) 360 goto err2; 361 362 of_property_read_u32(np, "mode", (u32 *)&pdata->mode); 363 of_property_read_u32(np, "interface-type", 364 (u32 *)&data->interface_type); 365 of_property_read_u32(np, "num-eps", (u32 *)&config->num_eps); 366 of_property_read_u32(np, "ram-bits", (u32 *)&config->ram_bits); 367 of_property_read_u32(np, "power", (u32 *)&pdata->power); 368 369 ret = of_property_read_u32(np, "multipoint", &val); 370 if (!ret && val) 371 config->multipoint = true; 372 373 pdata->board_data = data; 374 pdata->config = config; 375 376 control_node = of_parse_phandle(np, "ctrl-module", 0); 377 if (control_node) { 378 control_pdev = of_find_device_by_node(control_node); 379 of_node_put(control_node); 380 if (!control_pdev) { 381 dev_err(&pdev->dev, "Failed to get control device\n"); 382 ret = -EINVAL; 383 goto err2; 384 } 385 glue->control_otghs = &control_pdev->dev; 386 } 387 388 pdata->platform_ops = &omap2430_ops; 389 390 platform_set_drvdata(pdev, glue); 391 392 /* 393 * REVISIT if we ever have two instances of the wrapper, we will be 394 * in big trouble 395 */ 396 _glue = glue; 397 398 INIT_WORK(&glue->omap_musb_mailbox_work, omap_musb_mailbox_work); 399 400 ret = platform_device_add_resources(musb, pdev->resource, pdev->num_resources); 401 if (ret) { 402 dev_err(&pdev->dev, "failed to add resources\n"); 403 goto err2; 404 } 405 406 if (populate_irqs) { 407 struct resource musb_res[3]; 408 struct resource *res; 409 int i = 0; 410 411 memset(musb_res, 0, sizeof(*musb_res) * ARRAY_SIZE(musb_res)); 412 413 res = platform_get_resource(pdev, IORESOURCE_MEM, 0); 414 if (!res) 415 goto err2; 416 417 musb_res[i].start = res->start; 418 musb_res[i].end = res->end; 419 musb_res[i].flags = res->flags; 420 musb_res[i].name = res->name; 421 i++; 422 423 ret = of_irq_get_byname(np, "mc"); 424 if (ret > 0) { 425 musb_res[i].start = ret; 426 musb_res[i].flags = IORESOURCE_IRQ; 427 musb_res[i].name = "mc"; 428 i++; 429 } 430 431 ret = of_irq_get_byname(np, "dma"); 432 if (ret > 0) { 433 musb_res[i].start = ret; 434 musb_res[i].flags = IORESOURCE_IRQ; 435 musb_res[i].name = "dma"; 436 i++; 437 } 438 439 ret = platform_device_add_resources(musb, musb_res, i); 440 if (ret) { 441 dev_err(&pdev->dev, "failed to add IRQ resources\n"); 442 goto err2; 443 } 444 } 445 446 ret = platform_device_add_data(musb, pdata, sizeof(*pdata)); 447 if (ret) { 448 dev_err(&pdev->dev, "failed to add platform_data\n"); 449 goto err2; 450 } 451 452 pm_runtime_enable(glue->dev); 453 454 ret = platform_device_add(musb); 455 if (ret) { 456 dev_err(&pdev->dev, "failed to register musb device\n"); 457 goto err3; 458 } 459 460 return 0; 461 462 err3: 463 pm_runtime_disable(glue->dev); 464 465 err2: 466 platform_device_put(musb); 467 468 err0: 469 return ret; 470 } 471 472 static int omap2430_remove(struct platform_device *pdev) 473 { 474 struct omap2430_glue *glue = platform_get_drvdata(pdev); 475 476 platform_device_unregister(glue->musb); 477 pm_runtime_disable(glue->dev); 478 479 return 0; 480 } 481 482 #ifdef CONFIG_PM 483 484 static int omap2430_runtime_suspend(struct device *dev) 485 { 486 struct omap2430_glue *glue = dev_get_drvdata(dev); 487 struct musb *musb = glue_to_musb(glue); 488 489 if (!musb) 490 return 0; 491 492 musb->context.otg_interfsel = musb_readl(musb->mregs, 493 OTG_INTERFSEL); 494 495 omap2430_low_level_exit(musb); 496 497 if (!glue->phy_suspended) { 498 phy_power_off(musb->phy); 499 phy_exit(musb->phy); 500 } 501 502 glue->is_runtime_suspended = 1; 503 504 return 0; 505 } 506 507 static int omap2430_runtime_resume(struct device *dev) 508 { 509 struct omap2430_glue *glue = dev_get_drvdata(dev); 510 struct musb *musb = glue_to_musb(glue); 511 512 if (!musb) 513 return 0; 514 515 if (!glue->phy_suspended) { 516 phy_init(musb->phy); 517 phy_power_on(musb->phy); 518 } 519 520 omap2430_low_level_init(musb); 521 musb_writel(musb->mregs, OTG_INTERFSEL, 522 musb->context.otg_interfsel); 523 524 /* Wait for musb to get oriented. Otherwise we can get babble */ 525 usleep_range(200000, 250000); 526 527 glue->is_runtime_suspended = 0; 528 529 return 0; 530 } 531 532 /* I2C and SPI PHYs need to be suspended before the glue layer */ 533 static int omap2430_suspend(struct device *dev) 534 { 535 struct omap2430_glue *glue = dev_get_drvdata(dev); 536 struct musb *musb = glue_to_musb(glue); 537 538 phy_power_off(musb->phy); 539 phy_exit(musb->phy); 540 glue->phy_suspended = 1; 541 542 return 0; 543 } 544 545 /* Glue layer needs to be suspended after musb_suspend() */ 546 static int omap2430_suspend_late(struct device *dev) 547 { 548 struct omap2430_glue *glue = dev_get_drvdata(dev); 549 550 if (glue->is_runtime_suspended) 551 return 0; 552 553 glue->needs_resume = 1; 554 555 return omap2430_runtime_suspend(dev); 556 } 557 558 static int omap2430_resume_early(struct device *dev) 559 { 560 struct omap2430_glue *glue = dev_get_drvdata(dev); 561 562 if (!glue->needs_resume) 563 return 0; 564 565 glue->needs_resume = 0; 566 567 return omap2430_runtime_resume(dev); 568 } 569 570 static int omap2430_resume(struct device *dev) 571 { 572 struct omap2430_glue *glue = dev_get_drvdata(dev); 573 struct musb *musb = glue_to_musb(glue); 574 575 phy_init(musb->phy); 576 phy_power_on(musb->phy); 577 glue->phy_suspended = 0; 578 579 return 0; 580 } 581 582 static const struct dev_pm_ops omap2430_pm_ops = { 583 .runtime_suspend = omap2430_runtime_suspend, 584 .runtime_resume = omap2430_runtime_resume, 585 .suspend = omap2430_suspend, 586 .suspend_late = omap2430_suspend_late, 587 .resume_early = omap2430_resume_early, 588 .resume = omap2430_resume, 589 }; 590 591 #define DEV_PM_OPS (&omap2430_pm_ops) 592 #else 593 #define DEV_PM_OPS NULL 594 #endif 595 596 #ifdef CONFIG_OF 597 static const struct of_device_id omap2430_id_table[] = { 598 { 599 .compatible = "ti,omap4-musb" 600 }, 601 { 602 .compatible = "ti,omap3-musb" 603 }, 604 {}, 605 }; 606 MODULE_DEVICE_TABLE(of, omap2430_id_table); 607 #endif 608 609 static struct platform_driver omap2430_driver = { 610 .probe = omap2430_probe, 611 .remove = omap2430_remove, 612 .driver = { 613 .name = "musb-omap2430", 614 .pm = DEV_PM_OPS, 615 .of_match_table = of_match_ptr(omap2430_id_table), 616 }, 617 }; 618 619 module_platform_driver(omap2430_driver); 620 621 MODULE_DESCRIPTION("OMAP2PLUS MUSB Glue Layer"); 622 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>"); 623 MODULE_LICENSE("GPL v2"); 624