1 /* 2 * xhci-plat.c - xHCI host controller driver platform Bus Glue. 3 * 4 * Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com 5 * Author: Sebastian Andrzej Siewior <bigeasy@linutronix.de> 6 * 7 * A lot of code borrowed from the Linux xHCI driver. 8 * 9 * This program is free software; you can redistribute it and/or 10 * modify it under the terms of the GNU General Public License 11 * version 2 as published by the Free Software Foundation. 12 */ 13 14 #include <linux/clk.h> 15 #include <linux/dma-mapping.h> 16 #include <linux/module.h> 17 #include <linux/pci.h> 18 #include <linux/of.h> 19 #include <linux/platform_device.h> 20 #include <linux/usb/phy.h> 21 #include <linux/slab.h> 22 #include <linux/acpi.h> 23 24 #include "xhci.h" 25 #include "xhci-plat.h" 26 #include "xhci-mvebu.h" 27 #include "xhci-rcar.h" 28 29 static struct hc_driver __read_mostly xhci_plat_hc_driver; 30 31 static int xhci_plat_setup(struct usb_hcd *hcd); 32 static int xhci_plat_start(struct usb_hcd *hcd); 33 34 static const struct xhci_driver_overrides xhci_plat_overrides __initconst = { 35 .extra_priv_size = sizeof(struct xhci_plat_priv), 36 .reset = xhci_plat_setup, 37 .start = xhci_plat_start, 38 }; 39 40 static void xhci_priv_plat_start(struct usb_hcd *hcd) 41 { 42 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd); 43 44 if (priv->plat_start) 45 priv->plat_start(hcd); 46 } 47 48 static int xhci_priv_init_quirk(struct usb_hcd *hcd) 49 { 50 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd); 51 52 if (!priv->init_quirk) 53 return 0; 54 55 return priv->init_quirk(hcd); 56 } 57 58 static int xhci_priv_resume_quirk(struct usb_hcd *hcd) 59 { 60 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd); 61 62 if (!priv->resume_quirk) 63 return 0; 64 65 return priv->resume_quirk(hcd); 66 } 67 68 static void xhci_plat_quirks(struct device *dev, struct xhci_hcd *xhci) 69 { 70 /* 71 * As of now platform drivers don't provide MSI support so we ensure 72 * here that the generic code does not try to make a pci_dev from our 73 * dev struct in order to setup MSI 74 */ 75 xhci->quirks |= XHCI_PLAT; 76 } 77 78 /* called during probe() after chip reset completes */ 79 static int xhci_plat_setup(struct usb_hcd *hcd) 80 { 81 int ret; 82 83 84 ret = xhci_priv_init_quirk(hcd); 85 if (ret) 86 return ret; 87 88 return xhci_gen_setup(hcd, xhci_plat_quirks); 89 } 90 91 static int xhci_plat_start(struct usb_hcd *hcd) 92 { 93 xhci_priv_plat_start(hcd); 94 return xhci_run(hcd); 95 } 96 97 #ifdef CONFIG_OF 98 static const struct xhci_plat_priv xhci_plat_marvell_armada = { 99 .init_quirk = xhci_mvebu_mbus_init_quirk, 100 }; 101 102 static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen2 = { 103 .firmware_name = XHCI_RCAR_FIRMWARE_NAME_V1, 104 .init_quirk = xhci_rcar_init_quirk, 105 .plat_start = xhci_rcar_start, 106 .resume_quirk = xhci_rcar_resume_quirk, 107 }; 108 109 static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen3 = { 110 .init_quirk = xhci_rcar_init_quirk, 111 .plat_start = xhci_rcar_start, 112 .resume_quirk = xhci_rcar_resume_quirk, 113 }; 114 115 static const struct of_device_id usb_xhci_of_match[] = { 116 { 117 .compatible = "generic-xhci", 118 }, { 119 .compatible = "xhci-platform", 120 }, { 121 .compatible = "marvell,armada-375-xhci", 122 .data = &xhci_plat_marvell_armada, 123 }, { 124 .compatible = "marvell,armada-380-xhci", 125 .data = &xhci_plat_marvell_armada, 126 }, { 127 .compatible = "renesas,xhci-r8a7790", 128 .data = &xhci_plat_renesas_rcar_gen2, 129 }, { 130 .compatible = "renesas,xhci-r8a7791", 131 .data = &xhci_plat_renesas_rcar_gen2, 132 }, { 133 .compatible = "renesas,xhci-r8a7793", 134 .data = &xhci_plat_renesas_rcar_gen2, 135 }, { 136 .compatible = "renesas,xhci-r8a7795", 137 .data = &xhci_plat_renesas_rcar_gen3, 138 }, { 139 .compatible = "renesas,xhci-r8a7796", 140 .data = &xhci_plat_renesas_rcar_gen3, 141 }, { 142 .compatible = "renesas,rcar-gen2-xhci", 143 .data = &xhci_plat_renesas_rcar_gen2, 144 }, { 145 .compatible = "renesas,rcar-gen3-xhci", 146 .data = &xhci_plat_renesas_rcar_gen3, 147 }, 148 {}, 149 }; 150 MODULE_DEVICE_TABLE(of, usb_xhci_of_match); 151 #endif 152 153 static int xhci_plat_probe(struct platform_device *pdev) 154 { 155 const struct of_device_id *match; 156 const struct hc_driver *driver; 157 struct device *sysdev; 158 struct xhci_hcd *xhci; 159 struct resource *res; 160 struct usb_hcd *hcd; 161 struct clk *clk; 162 int ret; 163 int irq; 164 165 if (usb_disabled()) 166 return -ENODEV; 167 168 driver = &xhci_plat_hc_driver; 169 170 irq = platform_get_irq(pdev, 0); 171 if (irq < 0) 172 return irq; 173 174 /* 175 * sysdev must point to a device that is known to the system firmware 176 * or PCI hardware. We handle these three cases here: 177 * 1. xhci_plat comes from firmware 178 * 2. xhci_plat is child of a device from firmware (dwc3-plat) 179 * 3. xhci_plat is grandchild of a pci device (dwc3-pci) 180 */ 181 sysdev = &pdev->dev; 182 if (sysdev->parent && !sysdev->of_node && sysdev->parent->of_node) 183 sysdev = sysdev->parent; 184 #ifdef CONFIG_PCI 185 else if (sysdev->parent && sysdev->parent->parent && 186 sysdev->parent->parent->bus == &pci_bus_type) 187 sysdev = sysdev->parent->parent; 188 #endif 189 190 /* Try to set 64-bit DMA first */ 191 if (WARN_ON(!sysdev->dma_mask)) 192 /* Platform did not initialize dma_mask */ 193 ret = dma_coerce_mask_and_coherent(sysdev, 194 DMA_BIT_MASK(64)); 195 else 196 ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(64)); 197 198 /* If seting 64-bit DMA mask fails, fall back to 32-bit DMA mask */ 199 if (ret) { 200 ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(32)); 201 if (ret) 202 return ret; 203 } 204 205 pm_runtime_set_active(&pdev->dev); 206 pm_runtime_enable(&pdev->dev); 207 pm_runtime_get_noresume(&pdev->dev); 208 209 hcd = __usb_create_hcd(driver, sysdev, &pdev->dev, 210 dev_name(&pdev->dev), NULL); 211 if (!hcd) { 212 ret = -ENOMEM; 213 goto disable_runtime; 214 } 215 216 res = platform_get_resource(pdev, IORESOURCE_MEM, 0); 217 hcd->regs = devm_ioremap_resource(&pdev->dev, res); 218 if (IS_ERR(hcd->regs)) { 219 ret = PTR_ERR(hcd->regs); 220 goto put_hcd; 221 } 222 223 hcd->rsrc_start = res->start; 224 hcd->rsrc_len = resource_size(res); 225 226 /* 227 * Not all platforms have a clk so it is not an error if the 228 * clock does not exists. 229 */ 230 clk = devm_clk_get(&pdev->dev, NULL); 231 if (!IS_ERR(clk)) { 232 ret = clk_prepare_enable(clk); 233 if (ret) 234 goto put_hcd; 235 } else if (PTR_ERR(clk) == -EPROBE_DEFER) { 236 ret = -EPROBE_DEFER; 237 goto put_hcd; 238 } 239 240 xhci = hcd_to_xhci(hcd); 241 match = of_match_node(usb_xhci_of_match, pdev->dev.of_node); 242 if (match) { 243 const struct xhci_plat_priv *priv_match = match->data; 244 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd); 245 246 /* Just copy data for now */ 247 if (priv_match) 248 *priv = *priv_match; 249 } 250 251 device_wakeup_enable(hcd->self.controller); 252 253 xhci->clk = clk; 254 xhci->main_hcd = hcd; 255 xhci->shared_hcd = __usb_create_hcd(driver, sysdev, &pdev->dev, 256 dev_name(&pdev->dev), hcd); 257 if (!xhci->shared_hcd) { 258 ret = -ENOMEM; 259 goto disable_clk; 260 } 261 262 if (device_property_read_bool(sysdev, "usb3-lpm-capable")) 263 xhci->quirks |= XHCI_LPM_SUPPORT; 264 265 if (device_property_read_bool(&pdev->dev, "quirk-broken-port-ped")) 266 xhci->quirks |= XHCI_BROKEN_PORT_PED; 267 268 hcd->usb_phy = devm_usb_get_phy_by_phandle(sysdev, "usb-phy", 0); 269 if (IS_ERR(hcd->usb_phy)) { 270 ret = PTR_ERR(hcd->usb_phy); 271 if (ret == -EPROBE_DEFER) 272 goto put_usb3_hcd; 273 hcd->usb_phy = NULL; 274 } else { 275 ret = usb_phy_init(hcd->usb_phy); 276 if (ret) 277 goto put_usb3_hcd; 278 } 279 280 ret = usb_add_hcd(hcd, irq, IRQF_SHARED); 281 if (ret) 282 goto disable_usb_phy; 283 284 if (HCC_MAX_PSA(xhci->hcc_params) >= 4) 285 xhci->shared_hcd->can_do_streams = 1; 286 287 ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED); 288 if (ret) 289 goto dealloc_usb2_hcd; 290 291 device_enable_async_suspend(&pdev->dev); 292 pm_runtime_put_noidle(&pdev->dev); 293 294 /* 295 * Prevent runtime pm from being on as default, users should enable 296 * runtime pm using power/control in sysfs. 297 */ 298 pm_runtime_forbid(&pdev->dev); 299 300 return 0; 301 302 303 dealloc_usb2_hcd: 304 usb_remove_hcd(hcd); 305 306 disable_usb_phy: 307 usb_phy_shutdown(hcd->usb_phy); 308 309 put_usb3_hcd: 310 usb_put_hcd(xhci->shared_hcd); 311 312 disable_clk: 313 if (!IS_ERR(clk)) 314 clk_disable_unprepare(clk); 315 316 put_hcd: 317 usb_put_hcd(hcd); 318 319 disable_runtime: 320 pm_runtime_put_noidle(&pdev->dev); 321 pm_runtime_disable(&pdev->dev); 322 323 return ret; 324 } 325 326 static int xhci_plat_remove(struct platform_device *dev) 327 { 328 struct usb_hcd *hcd = platform_get_drvdata(dev); 329 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 330 struct clk *clk = xhci->clk; 331 332 xhci->xhc_state |= XHCI_STATE_REMOVING; 333 334 usb_remove_hcd(xhci->shared_hcd); 335 usb_phy_shutdown(hcd->usb_phy); 336 337 usb_remove_hcd(hcd); 338 usb_put_hcd(xhci->shared_hcd); 339 340 if (!IS_ERR(clk)) 341 clk_disable_unprepare(clk); 342 usb_put_hcd(hcd); 343 344 pm_runtime_set_suspended(&dev->dev); 345 pm_runtime_disable(&dev->dev); 346 347 return 0; 348 } 349 350 static int __maybe_unused xhci_plat_suspend(struct device *dev) 351 { 352 struct usb_hcd *hcd = dev_get_drvdata(dev); 353 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 354 int ret; 355 356 /* 357 * xhci_suspend() needs `do_wakeup` to know whether host is allowed 358 * to do wakeup during suspend. Since xhci_plat_suspend is currently 359 * only designed for system suspend, device_may_wakeup() is enough 360 * to dertermine whether host is allowed to do wakeup. Need to 361 * reconsider this when xhci_plat_suspend enlarges its scope, e.g., 362 * also applies to runtime suspend. 363 */ 364 ret = xhci_suspend(xhci, device_may_wakeup(dev)); 365 366 if (!device_may_wakeup(dev) && !IS_ERR(xhci->clk)) 367 clk_disable_unprepare(xhci->clk); 368 369 return ret; 370 } 371 372 static int __maybe_unused xhci_plat_resume(struct device *dev) 373 { 374 struct usb_hcd *hcd = dev_get_drvdata(dev); 375 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 376 int ret; 377 378 if (!device_may_wakeup(dev) && !IS_ERR(xhci->clk)) 379 clk_prepare_enable(xhci->clk); 380 381 ret = xhci_priv_resume_quirk(hcd); 382 if (ret) 383 return ret; 384 385 return xhci_resume(xhci, 0); 386 } 387 388 static int __maybe_unused xhci_plat_runtime_suspend(struct device *dev) 389 { 390 struct usb_hcd *hcd = dev_get_drvdata(dev); 391 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 392 393 return xhci_suspend(xhci, true); 394 } 395 396 static int __maybe_unused xhci_plat_runtime_resume(struct device *dev) 397 { 398 struct usb_hcd *hcd = dev_get_drvdata(dev); 399 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 400 401 return xhci_resume(xhci, 0); 402 } 403 404 static const struct dev_pm_ops xhci_plat_pm_ops = { 405 SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume) 406 407 SET_RUNTIME_PM_OPS(xhci_plat_runtime_suspend, 408 xhci_plat_runtime_resume, 409 NULL) 410 }; 411 412 static const struct acpi_device_id usb_xhci_acpi_match[] = { 413 /* XHCI-compliant USB Controller */ 414 { "PNP0D10", }, 415 { } 416 }; 417 MODULE_DEVICE_TABLE(acpi, usb_xhci_acpi_match); 418 419 static struct platform_driver usb_xhci_driver = { 420 .probe = xhci_plat_probe, 421 .remove = xhci_plat_remove, 422 .shutdown = usb_hcd_platform_shutdown, 423 .driver = { 424 .name = "xhci-hcd", 425 .pm = &xhci_plat_pm_ops, 426 .of_match_table = of_match_ptr(usb_xhci_of_match), 427 .acpi_match_table = ACPI_PTR(usb_xhci_acpi_match), 428 }, 429 }; 430 MODULE_ALIAS("platform:xhci-hcd"); 431 432 static int __init xhci_plat_init(void) 433 { 434 xhci_init_driver(&xhci_plat_hc_driver, &xhci_plat_overrides); 435 return platform_driver_register(&usb_xhci_driver); 436 } 437 module_init(xhci_plat_init); 438 439 static void __exit xhci_plat_exit(void) 440 { 441 platform_driver_unregister(&usb_xhci_driver); 442 } 443 module_exit(xhci_plat_exit); 444 445 MODULE_DESCRIPTION("xHCI Platform Host Controller Driver"); 446 MODULE_LICENSE("GPL"); 447