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,bcm7445-xhci", 135 .data = &xhci_plat_brcm, 136 }, 137 {}, 138 }; 139 MODULE_DEVICE_TABLE(of, usb_xhci_of_match); 140 #endif 141 142 int xhci_plat_probe(struct platform_device *pdev, struct device *sysdev, const struct xhci_plat_priv *priv_match) 143 { 144 const struct hc_driver *driver; 145 struct device *tmpdev; 146 struct xhci_hcd *xhci; 147 struct resource *res; 148 struct usb_hcd *hcd, *usb3_hcd; 149 int ret; 150 int irq; 151 struct xhci_plat_priv *priv = NULL; 152 bool of_match; 153 154 if (usb_disabled()) 155 return -ENODEV; 156 157 driver = &xhci_plat_hc_driver; 158 159 irq = platform_get_irq(pdev, 0); 160 if (irq < 0) 161 return irq; 162 163 if (!sysdev) 164 sysdev = &pdev->dev; 165 166 ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(64)); 167 if (ret) 168 return ret; 169 170 pm_runtime_set_active(&pdev->dev); 171 pm_runtime_enable(&pdev->dev); 172 pm_runtime_get_noresume(&pdev->dev); 173 174 hcd = __usb_create_hcd(driver, sysdev, &pdev->dev, 175 dev_name(&pdev->dev), NULL); 176 if (!hcd) { 177 ret = -ENOMEM; 178 goto disable_runtime; 179 } 180 181 hcd->regs = devm_platform_get_and_ioremap_resource(pdev, 0, &res); 182 if (IS_ERR(hcd->regs)) { 183 ret = PTR_ERR(hcd->regs); 184 goto put_hcd; 185 } 186 187 hcd->rsrc_start = res->start; 188 hcd->rsrc_len = resource_size(res); 189 190 xhci = hcd_to_xhci(hcd); 191 192 xhci->allow_single_roothub = 1; 193 194 /* 195 * Not all platforms have clks so it is not an error if the 196 * clock do not exist. 197 */ 198 xhci->reg_clk = devm_clk_get_optional(&pdev->dev, "reg"); 199 if (IS_ERR(xhci->reg_clk)) { 200 ret = PTR_ERR(xhci->reg_clk); 201 goto put_hcd; 202 } 203 204 xhci->clk = devm_clk_get_optional(&pdev->dev, NULL); 205 if (IS_ERR(xhci->clk)) { 206 ret = PTR_ERR(xhci->clk); 207 goto put_hcd; 208 } 209 210 xhci->reset = devm_reset_control_array_get_optional_shared(&pdev->dev); 211 if (IS_ERR(xhci->reset)) { 212 ret = PTR_ERR(xhci->reset); 213 goto put_hcd; 214 } 215 216 ret = reset_control_deassert(xhci->reset); 217 if (ret) 218 goto put_hcd; 219 220 ret = clk_prepare_enable(xhci->reg_clk); 221 if (ret) 222 goto err_reset; 223 224 ret = clk_prepare_enable(xhci->clk); 225 if (ret) 226 goto disable_reg_clk; 227 228 if (priv_match) { 229 priv = hcd_to_xhci_priv(hcd); 230 /* Just copy data for now */ 231 *priv = *priv_match; 232 } 233 234 device_set_wakeup_capable(&pdev->dev, true); 235 236 xhci->main_hcd = hcd; 237 238 /* imod_interval is the interrupt moderation value in nanoseconds. */ 239 xhci->imod_interval = 40000; 240 241 /* Iterate over all parent nodes for finding quirks */ 242 for (tmpdev = &pdev->dev; tmpdev; tmpdev = tmpdev->parent) { 243 244 if (device_property_read_bool(tmpdev, "usb2-lpm-disable")) 245 xhci->quirks |= XHCI_HW_LPM_DISABLE; 246 247 if (device_property_read_bool(tmpdev, "usb3-lpm-capable")) 248 xhci->quirks |= XHCI_LPM_SUPPORT; 249 250 if (device_property_read_bool(tmpdev, "quirk-broken-port-ped")) 251 xhci->quirks |= XHCI_BROKEN_PORT_PED; 252 253 device_property_read_u32(tmpdev, "imod-interval-ns", 254 &xhci->imod_interval); 255 } 256 257 /* 258 * Drivers such as dwc3 manages PHYs themself (and rely on driver name 259 * matching for the xhci platform device). 260 */ 261 of_match = of_match_device(pdev->dev.driver->of_match_table, &pdev->dev); 262 if (of_match) { 263 hcd->usb_phy = devm_usb_get_phy_by_phandle(sysdev, "usb-phy", 0); 264 if (IS_ERR(hcd->usb_phy)) { 265 ret = PTR_ERR(hcd->usb_phy); 266 if (ret == -EPROBE_DEFER) 267 goto disable_clk; 268 hcd->usb_phy = NULL; 269 } else { 270 ret = usb_phy_init(hcd->usb_phy); 271 if (ret) 272 goto disable_clk; 273 } 274 } 275 276 hcd->tpl_support = of_usb_host_tpl_support(sysdev->of_node); 277 278 if (priv && (priv->quirks & XHCI_SKIP_PHY_INIT)) 279 hcd->skip_phy_initialization = 1; 280 281 if (priv && (priv->quirks & XHCI_SG_TRB_CACHE_SIZE_QUIRK)) 282 xhci->quirks |= XHCI_SG_TRB_CACHE_SIZE_QUIRK; 283 284 ret = usb_add_hcd(hcd, irq, IRQF_SHARED); 285 if (ret) 286 goto disable_usb_phy; 287 288 if (!xhci_has_one_roothub(xhci)) { 289 xhci->shared_hcd = __usb_create_hcd(driver, sysdev, &pdev->dev, 290 dev_name(&pdev->dev), hcd); 291 if (!xhci->shared_hcd) { 292 ret = -ENOMEM; 293 goto dealloc_usb2_hcd; 294 } 295 296 if (of_match) { 297 xhci->shared_hcd->usb_phy = devm_usb_get_phy_by_phandle(sysdev, 298 "usb-phy", 1); 299 if (IS_ERR(xhci->shared_hcd->usb_phy)) { 300 xhci->shared_hcd->usb_phy = NULL; 301 } else { 302 ret = usb_phy_init(xhci->shared_hcd->usb_phy); 303 if (ret) 304 dev_err(sysdev, "%s init usb3phy fail (ret=%d)\n", 305 __func__, ret); 306 } 307 } 308 309 xhci->shared_hcd->tpl_support = hcd->tpl_support; 310 } 311 312 usb3_hcd = xhci_get_usb3_hcd(xhci); 313 if (usb3_hcd && HCC_MAX_PSA(xhci->hcc_params) >= 4) 314 usb3_hcd->can_do_streams = 1; 315 316 if (xhci->shared_hcd) { 317 ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED); 318 if (ret) 319 goto put_usb3_hcd; 320 } 321 322 device_enable_async_suspend(&pdev->dev); 323 pm_runtime_put_noidle(&pdev->dev); 324 325 /* 326 * Prevent runtime pm from being on as default, users should enable 327 * runtime pm using power/control in sysfs. 328 */ 329 pm_runtime_forbid(&pdev->dev); 330 331 return 0; 332 333 334 put_usb3_hcd: 335 usb_put_hcd(xhci->shared_hcd); 336 337 dealloc_usb2_hcd: 338 usb_remove_hcd(hcd); 339 340 disable_usb_phy: 341 usb_phy_shutdown(hcd->usb_phy); 342 343 disable_clk: 344 clk_disable_unprepare(xhci->clk); 345 346 disable_reg_clk: 347 clk_disable_unprepare(xhci->reg_clk); 348 349 err_reset: 350 reset_control_assert(xhci->reset); 351 352 put_hcd: 353 usb_put_hcd(hcd); 354 355 disable_runtime: 356 pm_runtime_put_noidle(&pdev->dev); 357 pm_runtime_disable(&pdev->dev); 358 359 return ret; 360 } 361 EXPORT_SYMBOL_GPL(xhci_plat_probe); 362 363 static int xhci_generic_plat_probe(struct platform_device *pdev) 364 { 365 const struct xhci_plat_priv *priv_match; 366 struct device *sysdev; 367 int ret; 368 369 /* 370 * sysdev must point to a device that is known to the system firmware 371 * or PCI hardware. We handle these three cases here: 372 * 1. xhci_plat comes from firmware 373 * 2. xhci_plat is child of a device from firmware (dwc3-plat) 374 * 3. xhci_plat is grandchild of a pci device (dwc3-pci) 375 */ 376 for (sysdev = &pdev->dev; sysdev; sysdev = sysdev->parent) { 377 if (is_of_node(sysdev->fwnode) || 378 is_acpi_device_node(sysdev->fwnode)) 379 break; 380 else if (dev_is_pci(sysdev)) 381 break; 382 } 383 384 if (!sysdev) 385 sysdev = &pdev->dev; 386 387 if (WARN_ON(!sysdev->dma_mask)) { 388 /* Platform did not initialize dma_mask */ 389 ret = dma_coerce_mask_and_coherent(sysdev, DMA_BIT_MASK(64)); 390 if (ret) 391 return ret; 392 } 393 394 if (pdev->dev.of_node) 395 priv_match = of_device_get_match_data(&pdev->dev); 396 else 397 priv_match = dev_get_platdata(&pdev->dev); 398 399 return xhci_plat_probe(pdev, sysdev, priv_match); 400 } 401 402 void xhci_plat_remove(struct platform_device *dev) 403 { 404 struct usb_hcd *hcd = platform_get_drvdata(dev); 405 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 406 struct clk *clk = xhci->clk; 407 struct clk *reg_clk = xhci->reg_clk; 408 struct usb_hcd *shared_hcd = xhci->shared_hcd; 409 410 xhci->xhc_state |= XHCI_STATE_REMOVING; 411 pm_runtime_get_sync(&dev->dev); 412 413 if (shared_hcd) { 414 usb_remove_hcd(shared_hcd); 415 xhci->shared_hcd = NULL; 416 } 417 418 usb_phy_shutdown(hcd->usb_phy); 419 420 usb_remove_hcd(hcd); 421 422 if (shared_hcd) 423 usb_put_hcd(shared_hcd); 424 425 clk_disable_unprepare(clk); 426 clk_disable_unprepare(reg_clk); 427 reset_control_assert(xhci->reset); 428 usb_put_hcd(hcd); 429 430 pm_runtime_disable(&dev->dev); 431 pm_runtime_put_noidle(&dev->dev); 432 pm_runtime_set_suspended(&dev->dev); 433 } 434 EXPORT_SYMBOL_GPL(xhci_plat_remove); 435 436 static int __maybe_unused xhci_plat_suspend(struct device *dev) 437 { 438 struct usb_hcd *hcd = dev_get_drvdata(dev); 439 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 440 int ret; 441 442 if (pm_runtime_suspended(dev)) 443 pm_runtime_resume(dev); 444 445 ret = xhci_priv_suspend_quirk(hcd); 446 if (ret) 447 return ret; 448 /* 449 * xhci_suspend() needs `do_wakeup` to know whether host is allowed 450 * to do wakeup during suspend. 451 */ 452 ret = xhci_suspend(xhci, device_may_wakeup(dev)); 453 if (ret) 454 return ret; 455 456 if (!device_may_wakeup(dev) && (xhci->quirks & XHCI_SUSPEND_RESUME_CLKS)) { 457 clk_disable_unprepare(xhci->clk); 458 clk_disable_unprepare(xhci->reg_clk); 459 } 460 461 return 0; 462 } 463 464 static int __maybe_unused xhci_plat_resume(struct device *dev) 465 { 466 struct usb_hcd *hcd = dev_get_drvdata(dev); 467 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 468 int ret; 469 470 if (!device_may_wakeup(dev) && (xhci->quirks & XHCI_SUSPEND_RESUME_CLKS)) { 471 ret = clk_prepare_enable(xhci->clk); 472 if (ret) 473 return ret; 474 475 ret = clk_prepare_enable(xhci->reg_clk); 476 if (ret) { 477 clk_disable_unprepare(xhci->clk); 478 return ret; 479 } 480 } 481 482 ret = xhci_priv_resume_quirk(hcd); 483 if (ret) 484 goto disable_clks; 485 486 ret = xhci_resume(xhci, PMSG_RESUME); 487 if (ret) 488 goto disable_clks; 489 490 pm_runtime_disable(dev); 491 pm_runtime_set_active(dev); 492 pm_runtime_enable(dev); 493 494 return 0; 495 496 disable_clks: 497 if (!device_may_wakeup(dev) && (xhci->quirks & XHCI_SUSPEND_RESUME_CLKS)) { 498 clk_disable_unprepare(xhci->clk); 499 clk_disable_unprepare(xhci->reg_clk); 500 } 501 502 return ret; 503 } 504 505 static int __maybe_unused xhci_plat_runtime_suspend(struct device *dev) 506 { 507 struct usb_hcd *hcd = dev_get_drvdata(dev); 508 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 509 int ret; 510 511 ret = xhci_priv_suspend_quirk(hcd); 512 if (ret) 513 return ret; 514 515 return xhci_suspend(xhci, true); 516 } 517 518 static int __maybe_unused xhci_plat_runtime_resume(struct device *dev) 519 { 520 struct usb_hcd *hcd = dev_get_drvdata(dev); 521 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 522 523 return xhci_resume(xhci, PMSG_AUTO_RESUME); 524 } 525 526 const struct dev_pm_ops xhci_plat_pm_ops = { 527 SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume) 528 529 SET_RUNTIME_PM_OPS(xhci_plat_runtime_suspend, 530 xhci_plat_runtime_resume, 531 NULL) 532 }; 533 EXPORT_SYMBOL_GPL(xhci_plat_pm_ops); 534 535 #ifdef CONFIG_ACPI 536 static const struct acpi_device_id usb_xhci_acpi_match[] = { 537 /* XHCI-compliant USB Controller */ 538 { "PNP0D10", }, 539 { } 540 }; 541 MODULE_DEVICE_TABLE(acpi, usb_xhci_acpi_match); 542 #endif 543 544 static struct platform_driver usb_generic_xhci_driver = { 545 .probe = xhci_generic_plat_probe, 546 .remove_new = xhci_plat_remove, 547 .shutdown = usb_hcd_platform_shutdown, 548 .driver = { 549 .name = "xhci-hcd", 550 .pm = &xhci_plat_pm_ops, 551 .of_match_table = of_match_ptr(usb_xhci_of_match), 552 .acpi_match_table = ACPI_PTR(usb_xhci_acpi_match), 553 }, 554 }; 555 MODULE_ALIAS("platform:xhci-hcd"); 556 557 static int __init xhci_plat_init(void) 558 { 559 xhci_init_driver(&xhci_plat_hc_driver, &xhci_plat_overrides); 560 return platform_driver_register(&usb_generic_xhci_driver); 561 } 562 module_init(xhci_plat_init); 563 564 static void __exit xhci_plat_exit(void) 565 { 566 platform_driver_unregister(&usb_generic_xhci_driver); 567 } 568 module_exit(xhci_plat_exit); 569 570 MODULE_DESCRIPTION("xHCI Platform Host Controller Driver"); 571 MODULE_LICENSE("GPL"); 572