1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * xhci-plat.c - xHCI host controller driver platform Bus Glue. 4 * 5 * Copyright (C) 2012 Texas Instruments Incorporated - https://www.ti.com 6 * Author: Sebastian Andrzej Siewior <bigeasy@linutronix.de> 7 * 8 * A lot of code borrowed from the Linux xHCI driver. 9 */ 10 11 #include <linux/clk.h> 12 #include <linux/dma-mapping.h> 13 #include <linux/module.h> 14 #include <linux/pci.h> 15 #include <linux/of.h> 16 #include <linux/of_device.h> 17 #include <linux/platform_device.h> 18 #include <linux/usb/phy.h> 19 #include <linux/slab.h> 20 #include <linux/acpi.h> 21 #include <linux/usb/of.h> 22 #include <linux/reset.h> 23 24 #include "xhci.h" 25 #include "xhci-plat.h" 26 #include "xhci-mvebu.h" 27 28 static struct hc_driver __read_mostly xhci_plat_hc_driver; 29 30 static int xhci_plat_setup(struct usb_hcd *hcd); 31 static int xhci_plat_start(struct usb_hcd *hcd); 32 33 static const struct xhci_driver_overrides xhci_plat_overrides __initconst = { 34 .extra_priv_size = sizeof(struct xhci_plat_priv), 35 .reset = xhci_plat_setup, 36 .start = xhci_plat_start, 37 }; 38 39 static void xhci_priv_plat_start(struct usb_hcd *hcd) 40 { 41 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd); 42 43 if (priv->plat_start) 44 priv->plat_start(hcd); 45 } 46 47 static int xhci_priv_init_quirk(struct usb_hcd *hcd) 48 { 49 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd); 50 51 if (!priv->init_quirk) 52 return 0; 53 54 return priv->init_quirk(hcd); 55 } 56 57 static int xhci_priv_suspend_quirk(struct usb_hcd *hcd) 58 { 59 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd); 60 61 if (!priv->suspend_quirk) 62 return 0; 63 64 return priv->suspend_quirk(hcd); 65 } 66 67 static int xhci_priv_resume_quirk(struct usb_hcd *hcd) 68 { 69 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd); 70 71 if (!priv->resume_quirk) 72 return 0; 73 74 return priv->resume_quirk(hcd); 75 } 76 77 static void xhci_plat_quirks(struct device *dev, struct xhci_hcd *xhci) 78 { 79 struct xhci_plat_priv *priv = xhci_to_priv(xhci); 80 81 xhci->quirks |= priv->quirks; 82 } 83 84 /* called during probe() after chip reset completes */ 85 static int xhci_plat_setup(struct usb_hcd *hcd) 86 { 87 int ret; 88 89 90 ret = xhci_priv_init_quirk(hcd); 91 if (ret) 92 return ret; 93 94 return xhci_gen_setup(hcd, xhci_plat_quirks); 95 } 96 97 static int xhci_plat_start(struct usb_hcd *hcd) 98 { 99 xhci_priv_plat_start(hcd); 100 return xhci_run(hcd); 101 } 102 103 #ifdef CONFIG_OF 104 static const struct xhci_plat_priv xhci_plat_marvell_armada = { 105 .init_quirk = xhci_mvebu_mbus_init_quirk, 106 }; 107 108 static const struct xhci_plat_priv xhci_plat_marvell_armada3700 = { 109 .init_quirk = xhci_mvebu_a3700_init_quirk, 110 }; 111 112 static const struct xhci_plat_priv xhci_plat_brcm = { 113 .quirks = XHCI_RESET_ON_RESUME | XHCI_SUSPEND_RESUME_CLKS, 114 }; 115 116 static const struct of_device_id usb_xhci_of_match[] = { 117 { 118 .compatible = "generic-xhci", 119 }, { 120 .compatible = "xhci-platform", 121 }, { 122 .compatible = "marvell,armada-375-xhci", 123 .data = &xhci_plat_marvell_armada, 124 }, { 125 .compatible = "marvell,armada-380-xhci", 126 .data = &xhci_plat_marvell_armada, 127 }, { 128 .compatible = "marvell,armada3700-xhci", 129 .data = &xhci_plat_marvell_armada3700, 130 }, { 131 .compatible = "brcm,xhci-brcm-v2", 132 .data = &xhci_plat_brcm, 133 }, { 134 .compatible = "brcm,bcm2711-xhci", 135 .data = &xhci_plat_brcm, 136 }, { 137 .compatible = "brcm,bcm7445-xhci", 138 .data = &xhci_plat_brcm, 139 }, 140 {}, 141 }; 142 MODULE_DEVICE_TABLE(of, usb_xhci_of_match); 143 #endif 144 145 int xhci_plat_probe(struct platform_device *pdev, struct device *sysdev, const struct xhci_plat_priv *priv_match) 146 { 147 const struct hc_driver *driver; 148 struct device *tmpdev; 149 struct xhci_hcd *xhci; 150 struct resource *res; 151 struct usb_hcd *hcd, *usb3_hcd; 152 int ret; 153 int irq; 154 struct xhci_plat_priv *priv = NULL; 155 bool of_match; 156 157 if (usb_disabled()) 158 return -ENODEV; 159 160 driver = &xhci_plat_hc_driver; 161 162 irq = platform_get_irq(pdev, 0); 163 if (irq < 0) 164 return irq; 165 166 if (!sysdev) 167 sysdev = &pdev->dev; 168 169 ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(64)); 170 if (ret) 171 return ret; 172 173 pm_runtime_set_active(&pdev->dev); 174 pm_runtime_enable(&pdev->dev); 175 pm_runtime_get_noresume(&pdev->dev); 176 177 hcd = __usb_create_hcd(driver, sysdev, &pdev->dev, 178 dev_name(&pdev->dev), NULL); 179 if (!hcd) { 180 ret = -ENOMEM; 181 goto disable_runtime; 182 } 183 184 hcd->regs = devm_platform_get_and_ioremap_resource(pdev, 0, &res); 185 if (IS_ERR(hcd->regs)) { 186 ret = PTR_ERR(hcd->regs); 187 goto put_hcd; 188 } 189 190 hcd->rsrc_start = res->start; 191 hcd->rsrc_len = resource_size(res); 192 193 xhci = hcd_to_xhci(hcd); 194 195 xhci->allow_single_roothub = 1; 196 197 /* 198 * Not all platforms have clks so it is not an error if the 199 * clock do not exist. 200 */ 201 xhci->reg_clk = devm_clk_get_optional(&pdev->dev, "reg"); 202 if (IS_ERR(xhci->reg_clk)) { 203 ret = PTR_ERR(xhci->reg_clk); 204 goto put_hcd; 205 } 206 207 xhci->clk = devm_clk_get_optional(&pdev->dev, NULL); 208 if (IS_ERR(xhci->clk)) { 209 ret = PTR_ERR(xhci->clk); 210 goto put_hcd; 211 } 212 213 xhci->reset = devm_reset_control_array_get_optional_shared(&pdev->dev); 214 if (IS_ERR(xhci->reset)) { 215 ret = PTR_ERR(xhci->reset); 216 goto put_hcd; 217 } 218 219 ret = reset_control_deassert(xhci->reset); 220 if (ret) 221 goto put_hcd; 222 223 ret = clk_prepare_enable(xhci->reg_clk); 224 if (ret) 225 goto err_reset; 226 227 ret = clk_prepare_enable(xhci->clk); 228 if (ret) 229 goto disable_reg_clk; 230 231 if (priv_match) { 232 priv = hcd_to_xhci_priv(hcd); 233 /* Just copy data for now */ 234 *priv = *priv_match; 235 } 236 237 device_set_wakeup_capable(&pdev->dev, true); 238 239 xhci->main_hcd = hcd; 240 241 /* imod_interval is the interrupt moderation value in nanoseconds. */ 242 xhci->imod_interval = 40000; 243 244 /* Iterate over all parent nodes for finding quirks */ 245 for (tmpdev = &pdev->dev; tmpdev; tmpdev = tmpdev->parent) { 246 247 if (device_property_read_bool(tmpdev, "usb2-lpm-disable")) 248 xhci->quirks |= XHCI_HW_LPM_DISABLE; 249 250 if (device_property_read_bool(tmpdev, "usb3-lpm-capable")) 251 xhci->quirks |= XHCI_LPM_SUPPORT; 252 253 if (device_property_read_bool(tmpdev, "quirk-broken-port-ped")) 254 xhci->quirks |= XHCI_BROKEN_PORT_PED; 255 256 if (device_property_read_bool(tmpdev, "xhci-sg-trb-cache-size-quirk")) 257 xhci->quirks |= XHCI_SG_TRB_CACHE_SIZE_QUIRK; 258 259 if (device_property_read_bool(tmpdev, "write-64-hi-lo-quirk")) 260 xhci->quirks |= XHCI_WRITE_64_HI_LO; 261 262 if (device_property_read_bool(tmpdev, "xhci-missing-cas-quirk")) 263 xhci->quirks |= XHCI_MISSING_CAS; 264 265 if (device_property_read_bool(tmpdev, "xhci-skip-phy-init-quirk")) 266 xhci->quirks |= XHCI_SKIP_PHY_INIT; 267 268 device_property_read_u32(tmpdev, "imod-interval-ns", 269 &xhci->imod_interval); 270 } 271 272 /* 273 * Drivers such as dwc3 manages PHYs themself (and rely on driver name 274 * matching for the xhci platform device). 275 */ 276 of_match = of_match_device(pdev->dev.driver->of_match_table, &pdev->dev); 277 if (of_match) { 278 hcd->usb_phy = devm_usb_get_phy_by_phandle(sysdev, "usb-phy", 0); 279 if (IS_ERR(hcd->usb_phy)) { 280 ret = PTR_ERR(hcd->usb_phy); 281 if (ret == -EPROBE_DEFER) 282 goto disable_clk; 283 hcd->usb_phy = NULL; 284 } else { 285 ret = usb_phy_init(hcd->usb_phy); 286 if (ret) 287 goto disable_clk; 288 } 289 } 290 291 hcd->tpl_support = of_usb_host_tpl_support(sysdev->of_node); 292 293 if (priv && (priv->quirks & XHCI_SKIP_PHY_INIT)) 294 hcd->skip_phy_initialization = 1; 295 296 if (priv && (priv->quirks & XHCI_SG_TRB_CACHE_SIZE_QUIRK)) 297 xhci->quirks |= XHCI_SG_TRB_CACHE_SIZE_QUIRK; 298 299 ret = usb_add_hcd(hcd, irq, IRQF_SHARED); 300 if (ret) 301 goto disable_usb_phy; 302 303 if (!xhci_has_one_roothub(xhci)) { 304 xhci->shared_hcd = __usb_create_hcd(driver, sysdev, &pdev->dev, 305 dev_name(&pdev->dev), hcd); 306 if (!xhci->shared_hcd) { 307 ret = -ENOMEM; 308 goto dealloc_usb2_hcd; 309 } 310 311 if (of_match) { 312 xhci->shared_hcd->usb_phy = devm_usb_get_phy_by_phandle(sysdev, 313 "usb-phy", 1); 314 if (IS_ERR(xhci->shared_hcd->usb_phy)) { 315 xhci->shared_hcd->usb_phy = NULL; 316 } else { 317 ret = usb_phy_init(xhci->shared_hcd->usb_phy); 318 if (ret) 319 dev_err(sysdev, "%s init usb3phy fail (ret=%d)\n", 320 __func__, ret); 321 } 322 } 323 324 xhci->shared_hcd->tpl_support = hcd->tpl_support; 325 } 326 327 usb3_hcd = xhci_get_usb3_hcd(xhci); 328 if (usb3_hcd && HCC_MAX_PSA(xhci->hcc_params) >= 4) 329 usb3_hcd->can_do_streams = 1; 330 331 if (xhci->shared_hcd) { 332 ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED); 333 if (ret) 334 goto put_usb3_hcd; 335 } 336 337 device_enable_async_suspend(&pdev->dev); 338 pm_runtime_put_noidle(&pdev->dev); 339 340 /* 341 * Prevent runtime pm from being on as default, users should enable 342 * runtime pm using power/control in sysfs. 343 */ 344 pm_runtime_forbid(&pdev->dev); 345 346 return 0; 347 348 349 put_usb3_hcd: 350 usb_put_hcd(xhci->shared_hcd); 351 352 dealloc_usb2_hcd: 353 usb_remove_hcd(hcd); 354 355 disable_usb_phy: 356 usb_phy_shutdown(hcd->usb_phy); 357 358 disable_clk: 359 clk_disable_unprepare(xhci->clk); 360 361 disable_reg_clk: 362 clk_disable_unprepare(xhci->reg_clk); 363 364 err_reset: 365 reset_control_assert(xhci->reset); 366 367 put_hcd: 368 usb_put_hcd(hcd); 369 370 disable_runtime: 371 pm_runtime_put_noidle(&pdev->dev); 372 pm_runtime_disable(&pdev->dev); 373 374 return ret; 375 } 376 EXPORT_SYMBOL_GPL(xhci_plat_probe); 377 378 static int xhci_generic_plat_probe(struct platform_device *pdev) 379 { 380 const struct xhci_plat_priv *priv_match; 381 struct device *sysdev; 382 int ret; 383 384 /* 385 * sysdev must point to a device that is known to the system firmware 386 * or PCI hardware. We handle these three cases here: 387 * 1. xhci_plat comes from firmware 388 * 2. xhci_plat is child of a device from firmware (dwc3-plat) 389 * 3. xhci_plat is grandchild of a pci device (dwc3-pci) 390 */ 391 for (sysdev = &pdev->dev; sysdev; sysdev = sysdev->parent) { 392 if (is_of_node(sysdev->fwnode) || 393 is_acpi_device_node(sysdev->fwnode)) 394 break; 395 else if (dev_is_pci(sysdev)) 396 break; 397 } 398 399 if (!sysdev) 400 sysdev = &pdev->dev; 401 402 if (WARN_ON(!sysdev->dma_mask)) { 403 /* Platform did not initialize dma_mask */ 404 ret = dma_coerce_mask_and_coherent(sysdev, DMA_BIT_MASK(64)); 405 if (ret) 406 return ret; 407 } 408 409 if (pdev->dev.of_node) 410 priv_match = of_device_get_match_data(&pdev->dev); 411 else 412 priv_match = dev_get_platdata(&pdev->dev); 413 414 return xhci_plat_probe(pdev, sysdev, priv_match); 415 } 416 417 void xhci_plat_remove(struct platform_device *dev) 418 { 419 struct usb_hcd *hcd = platform_get_drvdata(dev); 420 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 421 struct clk *clk = xhci->clk; 422 struct clk *reg_clk = xhci->reg_clk; 423 struct usb_hcd *shared_hcd = xhci->shared_hcd; 424 425 xhci->xhc_state |= XHCI_STATE_REMOVING; 426 pm_runtime_get_sync(&dev->dev); 427 428 if (shared_hcd) { 429 usb_remove_hcd(shared_hcd); 430 xhci->shared_hcd = NULL; 431 } 432 433 usb_phy_shutdown(hcd->usb_phy); 434 435 usb_remove_hcd(hcd); 436 437 if (shared_hcd) 438 usb_put_hcd(shared_hcd); 439 440 clk_disable_unprepare(clk); 441 clk_disable_unprepare(reg_clk); 442 reset_control_assert(xhci->reset); 443 usb_put_hcd(hcd); 444 445 pm_runtime_disable(&dev->dev); 446 pm_runtime_put_noidle(&dev->dev); 447 pm_runtime_set_suspended(&dev->dev); 448 } 449 EXPORT_SYMBOL_GPL(xhci_plat_remove); 450 451 static int xhci_plat_suspend(struct device *dev) 452 { 453 struct usb_hcd *hcd = dev_get_drvdata(dev); 454 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 455 int ret; 456 457 if (pm_runtime_suspended(dev)) 458 pm_runtime_resume(dev); 459 460 ret = xhci_priv_suspend_quirk(hcd); 461 if (ret) 462 return ret; 463 /* 464 * xhci_suspend() needs `do_wakeup` to know whether host is allowed 465 * to do wakeup during suspend. 466 */ 467 ret = xhci_suspend(xhci, device_may_wakeup(dev)); 468 if (ret) 469 return ret; 470 471 if (!device_may_wakeup(dev) && (xhci->quirks & XHCI_SUSPEND_RESUME_CLKS)) { 472 clk_disable_unprepare(xhci->clk); 473 clk_disable_unprepare(xhci->reg_clk); 474 } 475 476 return 0; 477 } 478 479 static int xhci_plat_resume_common(struct device *dev, struct pm_message pmsg) 480 { 481 struct usb_hcd *hcd = dev_get_drvdata(dev); 482 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 483 int ret; 484 485 if (!device_may_wakeup(dev) && (xhci->quirks & XHCI_SUSPEND_RESUME_CLKS)) { 486 ret = clk_prepare_enable(xhci->clk); 487 if (ret) 488 return ret; 489 490 ret = clk_prepare_enable(xhci->reg_clk); 491 if (ret) { 492 clk_disable_unprepare(xhci->clk); 493 return ret; 494 } 495 } 496 497 ret = xhci_priv_resume_quirk(hcd); 498 if (ret) 499 goto disable_clks; 500 501 ret = xhci_resume(xhci, pmsg); 502 if (ret) 503 goto disable_clks; 504 505 pm_runtime_disable(dev); 506 pm_runtime_set_active(dev); 507 pm_runtime_enable(dev); 508 509 return 0; 510 511 disable_clks: 512 if (!device_may_wakeup(dev) && (xhci->quirks & XHCI_SUSPEND_RESUME_CLKS)) { 513 clk_disable_unprepare(xhci->clk); 514 clk_disable_unprepare(xhci->reg_clk); 515 } 516 517 return ret; 518 } 519 520 static int xhci_plat_resume(struct device *dev) 521 { 522 return xhci_plat_resume_common(dev, PMSG_RESUME); 523 } 524 525 static int xhci_plat_restore(struct device *dev) 526 { 527 return xhci_plat_resume_common(dev, PMSG_RESTORE); 528 } 529 530 static int __maybe_unused xhci_plat_runtime_suspend(struct device *dev) 531 { 532 struct usb_hcd *hcd = dev_get_drvdata(dev); 533 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 534 int ret; 535 536 ret = xhci_priv_suspend_quirk(hcd); 537 if (ret) 538 return ret; 539 540 return xhci_suspend(xhci, true); 541 } 542 543 static int __maybe_unused xhci_plat_runtime_resume(struct device *dev) 544 { 545 struct usb_hcd *hcd = dev_get_drvdata(dev); 546 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 547 548 return xhci_resume(xhci, PMSG_AUTO_RESUME); 549 } 550 551 const struct dev_pm_ops xhci_plat_pm_ops = { 552 .suspend = pm_sleep_ptr(xhci_plat_suspend), 553 .resume = pm_sleep_ptr(xhci_plat_resume), 554 .freeze = pm_sleep_ptr(xhci_plat_suspend), 555 .thaw = pm_sleep_ptr(xhci_plat_resume), 556 .poweroff = pm_sleep_ptr(xhci_plat_suspend), 557 .restore = pm_sleep_ptr(xhci_plat_restore), 558 559 SET_RUNTIME_PM_OPS(xhci_plat_runtime_suspend, 560 xhci_plat_runtime_resume, 561 NULL) 562 }; 563 EXPORT_SYMBOL_GPL(xhci_plat_pm_ops); 564 565 #ifdef CONFIG_ACPI 566 static const struct acpi_device_id usb_xhci_acpi_match[] = { 567 /* XHCI-compliant USB Controller */ 568 { "PNP0D10", }, 569 { } 570 }; 571 MODULE_DEVICE_TABLE(acpi, usb_xhci_acpi_match); 572 #endif 573 574 static struct platform_driver usb_generic_xhci_driver = { 575 .probe = xhci_generic_plat_probe, 576 .remove_new = xhci_plat_remove, 577 .shutdown = usb_hcd_platform_shutdown, 578 .driver = { 579 .name = "xhci-hcd", 580 .pm = &xhci_plat_pm_ops, 581 .of_match_table = of_match_ptr(usb_xhci_of_match), 582 .acpi_match_table = ACPI_PTR(usb_xhci_acpi_match), 583 }, 584 }; 585 MODULE_ALIAS("platform:xhci-hcd"); 586 587 static int __init xhci_plat_init(void) 588 { 589 xhci_init_driver(&xhci_plat_hc_driver, &xhci_plat_overrides); 590 return platform_driver_register(&usb_generic_xhci_driver); 591 } 592 module_init(xhci_plat_init); 593 594 static void __exit xhci_plat_exit(void) 595 { 596 platform_driver_unregister(&usb_generic_xhci_driver); 597 } 598 module_exit(xhci_plat_exit); 599 600 MODULE_DESCRIPTION("xHCI Platform Host Controller Driver"); 601 MODULE_LICENSE("GPL"); 602