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