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 .quirks = XHCI_RESET_ON_RESUME, 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 (xhci->quirks & XHCI_SKIP_PHY_INIT)) 295 hcd->skip_phy_initialization = 1; 296 297 if (priv && (priv->quirks & XHCI_SG_TRB_CACHE_SIZE_QUIRK)) 298 xhci->quirks |= XHCI_SG_TRB_CACHE_SIZE_QUIRK; 299 300 ret = usb_add_hcd(hcd, irq, IRQF_SHARED); 301 if (ret) 302 goto disable_usb_phy; 303 304 if (!xhci_has_one_roothub(xhci)) { 305 xhci->shared_hcd = __usb_create_hcd(driver, sysdev, &pdev->dev, 306 dev_name(&pdev->dev), hcd); 307 if (!xhci->shared_hcd) { 308 ret = -ENOMEM; 309 goto dealloc_usb2_hcd; 310 } 311 312 if (of_match) { 313 xhci->shared_hcd->usb_phy = devm_usb_get_phy_by_phandle(sysdev, 314 "usb-phy", 1); 315 if (IS_ERR(xhci->shared_hcd->usb_phy)) { 316 xhci->shared_hcd->usb_phy = NULL; 317 } else { 318 ret = usb_phy_init(xhci->shared_hcd->usb_phy); 319 if (ret) 320 dev_err(sysdev, "%s init usb3phy fail (ret=%d)\n", 321 __func__, ret); 322 } 323 } 324 325 xhci->shared_hcd->tpl_support = hcd->tpl_support; 326 } 327 328 usb3_hcd = xhci_get_usb3_hcd(xhci); 329 if (usb3_hcd && HCC_MAX_PSA(xhci->hcc_params) >= 4) 330 usb3_hcd->can_do_streams = 1; 331 332 if (xhci->shared_hcd) { 333 xhci->shared_hcd->rsrc_start = hcd->rsrc_start; 334 xhci->shared_hcd->rsrc_len = hcd->rsrc_len; 335 ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED); 336 if (ret) 337 goto put_usb3_hcd; 338 } 339 340 device_enable_async_suspend(&pdev->dev); 341 pm_runtime_put_noidle(&pdev->dev); 342 343 /* 344 * Prevent runtime pm from being on as default, users should enable 345 * runtime pm using power/control in sysfs. 346 */ 347 pm_runtime_forbid(&pdev->dev); 348 349 return 0; 350 351 352 put_usb3_hcd: 353 usb_put_hcd(xhci->shared_hcd); 354 355 dealloc_usb2_hcd: 356 usb_remove_hcd(hcd); 357 358 disable_usb_phy: 359 usb_phy_shutdown(hcd->usb_phy); 360 361 disable_clk: 362 clk_disable_unprepare(xhci->clk); 363 364 disable_reg_clk: 365 clk_disable_unprepare(xhci->reg_clk); 366 367 err_reset: 368 reset_control_assert(xhci->reset); 369 370 put_hcd: 371 usb_put_hcd(hcd); 372 373 disable_runtime: 374 pm_runtime_put_noidle(&pdev->dev); 375 pm_runtime_disable(&pdev->dev); 376 377 return ret; 378 } 379 EXPORT_SYMBOL_GPL(xhci_plat_probe); 380 381 static int xhci_generic_plat_probe(struct platform_device *pdev) 382 { 383 const struct xhci_plat_priv *priv_match; 384 struct device *sysdev; 385 int ret; 386 387 /* 388 * sysdev must point to a device that is known to the system firmware 389 * or PCI hardware. We handle these three cases here: 390 * 1. xhci_plat comes from firmware 391 * 2. xhci_plat is child of a device from firmware (dwc3-plat) 392 * 3. xhci_plat is grandchild of a pci device (dwc3-pci) 393 */ 394 for (sysdev = &pdev->dev; sysdev; sysdev = sysdev->parent) { 395 if (is_of_node(sysdev->fwnode) || 396 is_acpi_device_node(sysdev->fwnode)) 397 break; 398 else if (dev_is_pci(sysdev)) 399 break; 400 } 401 402 if (!sysdev) 403 sysdev = &pdev->dev; 404 405 if (WARN_ON(!sysdev->dma_mask)) { 406 /* Platform did not initialize dma_mask */ 407 ret = dma_coerce_mask_and_coherent(sysdev, DMA_BIT_MASK(64)); 408 if (ret) 409 return ret; 410 } 411 412 if (pdev->dev.of_node) 413 priv_match = of_device_get_match_data(&pdev->dev); 414 else 415 priv_match = dev_get_platdata(&pdev->dev); 416 417 return xhci_plat_probe(pdev, sysdev, priv_match); 418 } 419 420 void xhci_plat_remove(struct platform_device *dev) 421 { 422 struct usb_hcd *hcd = platform_get_drvdata(dev); 423 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 424 struct clk *clk = xhci->clk; 425 struct clk *reg_clk = xhci->reg_clk; 426 struct usb_hcd *shared_hcd = xhci->shared_hcd; 427 428 xhci->xhc_state |= XHCI_STATE_REMOVING; 429 pm_runtime_get_sync(&dev->dev); 430 431 if (shared_hcd) { 432 usb_remove_hcd(shared_hcd); 433 xhci->shared_hcd = NULL; 434 } 435 436 usb_phy_shutdown(hcd->usb_phy); 437 438 usb_remove_hcd(hcd); 439 440 if (shared_hcd) 441 usb_put_hcd(shared_hcd); 442 443 clk_disable_unprepare(clk); 444 clk_disable_unprepare(reg_clk); 445 reset_control_assert(xhci->reset); 446 usb_put_hcd(hcd); 447 448 pm_runtime_disable(&dev->dev); 449 pm_runtime_put_noidle(&dev->dev); 450 pm_runtime_set_suspended(&dev->dev); 451 } 452 EXPORT_SYMBOL_GPL(xhci_plat_remove); 453 454 static int xhci_plat_suspend(struct device *dev) 455 { 456 struct usb_hcd *hcd = dev_get_drvdata(dev); 457 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 458 int ret; 459 460 if (pm_runtime_suspended(dev)) 461 pm_runtime_resume(dev); 462 463 ret = xhci_priv_suspend_quirk(hcd); 464 if (ret) 465 return ret; 466 /* 467 * xhci_suspend() needs `do_wakeup` to know whether host is allowed 468 * to do wakeup during suspend. 469 */ 470 ret = xhci_suspend(xhci, device_may_wakeup(dev)); 471 if (ret) 472 return ret; 473 474 if (!device_may_wakeup(dev) && (xhci->quirks & XHCI_SUSPEND_RESUME_CLKS)) { 475 clk_disable_unprepare(xhci->clk); 476 clk_disable_unprepare(xhci->reg_clk); 477 } 478 479 return 0; 480 } 481 482 static int xhci_plat_resume_common(struct device *dev, bool power_lost) 483 { 484 struct usb_hcd *hcd = dev_get_drvdata(dev); 485 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd); 486 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 487 int ret; 488 489 if (!device_may_wakeup(dev) && (xhci->quirks & XHCI_SUSPEND_RESUME_CLKS)) { 490 ret = clk_prepare_enable(xhci->clk); 491 if (ret) 492 return ret; 493 494 ret = clk_prepare_enable(xhci->reg_clk); 495 if (ret) { 496 clk_disable_unprepare(xhci->clk); 497 return ret; 498 } 499 } 500 501 ret = xhci_priv_resume_quirk(hcd); 502 if (ret) 503 goto disable_clks; 504 505 ret = xhci_resume(xhci, power_lost || priv->power_lost, false); 506 if (ret) 507 goto disable_clks; 508 509 pm_runtime_disable(dev); 510 pm_runtime_set_active(dev); 511 pm_runtime_enable(dev); 512 513 return 0; 514 515 disable_clks: 516 if (!device_may_wakeup(dev) && (xhci->quirks & XHCI_SUSPEND_RESUME_CLKS)) { 517 clk_disable_unprepare(xhci->clk); 518 clk_disable_unprepare(xhci->reg_clk); 519 } 520 521 return ret; 522 } 523 524 static int xhci_plat_resume(struct device *dev) 525 { 526 return xhci_plat_resume_common(dev, false); 527 } 528 529 static int xhci_plat_restore(struct device *dev) 530 { 531 return xhci_plat_resume_common(dev, true); 532 } 533 534 static int __maybe_unused xhci_plat_runtime_suspend(struct device *dev) 535 { 536 struct usb_hcd *hcd = dev_get_drvdata(dev); 537 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 538 int ret; 539 540 ret = xhci_priv_suspend_quirk(hcd); 541 if (ret) 542 return ret; 543 544 return xhci_suspend(xhci, true); 545 } 546 547 static int __maybe_unused xhci_plat_runtime_resume(struct device *dev) 548 { 549 struct usb_hcd *hcd = dev_get_drvdata(dev); 550 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 551 552 return xhci_resume(xhci, false, true); 553 } 554 555 const struct dev_pm_ops xhci_plat_pm_ops = { 556 .suspend = pm_sleep_ptr(xhci_plat_suspend), 557 .resume = pm_sleep_ptr(xhci_plat_resume), 558 .freeze = pm_sleep_ptr(xhci_plat_suspend), 559 .thaw = pm_sleep_ptr(xhci_plat_resume), 560 .poweroff = pm_sleep_ptr(xhci_plat_suspend), 561 .restore = pm_sleep_ptr(xhci_plat_restore), 562 563 SET_RUNTIME_PM_OPS(xhci_plat_runtime_suspend, 564 xhci_plat_runtime_resume, 565 NULL) 566 }; 567 EXPORT_SYMBOL_GPL(xhci_plat_pm_ops); 568 569 #ifdef CONFIG_ACPI 570 static const struct acpi_device_id usb_xhci_acpi_match[] = { 571 /* XHCI-compliant USB Controller */ 572 { "PNP0D10", }, 573 { "PNP0D15", }, 574 { } 575 }; 576 MODULE_DEVICE_TABLE(acpi, usb_xhci_acpi_match); 577 #endif 578 579 static struct platform_driver usb_generic_xhci_driver = { 580 .probe = xhci_generic_plat_probe, 581 .remove = xhci_plat_remove, 582 .shutdown = usb_hcd_platform_shutdown, 583 .driver = { 584 .name = "xhci-hcd", 585 .pm = &xhci_plat_pm_ops, 586 .of_match_table = of_match_ptr(usb_xhci_of_match), 587 .acpi_match_table = ACPI_PTR(usb_xhci_acpi_match), 588 }, 589 }; 590 MODULE_ALIAS("platform:xhci-hcd"); 591 592 static int __init xhci_plat_init(void) 593 { 594 xhci_init_driver(&xhci_plat_hc_driver, &xhci_plat_overrides); 595 return platform_driver_register(&usb_generic_xhci_driver); 596 } 597 module_init(xhci_plat_init); 598 599 static void __exit xhci_plat_exit(void) 600 { 601 platform_driver_unregister(&usb_generic_xhci_driver); 602 } 603 module_exit(xhci_plat_exit); 604 605 MODULE_DESCRIPTION("xHCI Platform Host Controller Driver"); 606 MODULE_LICENSE("GPL"); 607