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