2 * xhci-plat.c - xHCI host controller driver platform Bus Glue.
4 * Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com
5 * Author: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
7 * A lot of code borrowed from the Linux xHCI driver.
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.
14 #include <linux/clk.h>
15 #include <linux/dma-mapping.h>
16 #include <linux/module.h>
17 #include <linux/pci.h>
19 #include <linux/platform_device.h>
20 #include <linux/usb/phy.h>
21 #include <linux/slab.h>
22 #include <linux/acpi.h>
25 #include "xhci-plat.h"
26 #include "xhci-mvebu.h"
27 #include "xhci-rcar.h"
29 static struct hc_driver __read_mostly xhci_plat_hc_driver;
31 static int xhci_plat_setup(struct usb_hcd *hcd);
32 static int xhci_plat_start(struct usb_hcd *hcd);
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,
40 static void xhci_priv_plat_start(struct usb_hcd *hcd)
42 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
45 priv->plat_start(hcd);
48 static int xhci_priv_init_quirk(struct usb_hcd *hcd)
50 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
52 if (!priv->init_quirk)
55 return priv->init_quirk(hcd);
58 static int xhci_priv_resume_quirk(struct usb_hcd *hcd)
60 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
62 if (!priv->resume_quirk)
65 return priv->resume_quirk(hcd);
68 static void xhci_plat_quirks(struct device *dev, struct xhci_hcd *xhci)
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
75 xhci->quirks |= XHCI_PLAT;
78 /* called during probe() after chip reset completes */
79 static int xhci_plat_setup(struct usb_hcd *hcd)
84 ret = xhci_priv_init_quirk(hcd);
88 return xhci_gen_setup(hcd, xhci_plat_quirks);
91 static int xhci_plat_start(struct usb_hcd *hcd)
93 xhci_priv_plat_start(hcd);
98 static const struct xhci_plat_priv xhci_plat_marvell_armada = {
99 .init_quirk = xhci_mvebu_mbus_init_quirk,
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,
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,
115 static const struct of_device_id usb_xhci_of_match[] = {
117 .compatible = "generic-xhci",
119 .compatible = "xhci-platform",
121 .compatible = "marvell,armada-375-xhci",
122 .data = &xhci_plat_marvell_armada,
124 .compatible = "marvell,armada-380-xhci",
125 .data = &xhci_plat_marvell_armada,
127 .compatible = "renesas,xhci-r8a7790",
128 .data = &xhci_plat_renesas_rcar_gen2,
130 .compatible = "renesas,xhci-r8a7791",
131 .data = &xhci_plat_renesas_rcar_gen2,
133 .compatible = "renesas,xhci-r8a7793",
134 .data = &xhci_plat_renesas_rcar_gen2,
136 .compatible = "renesas,xhci-r8a7795",
137 .data = &xhci_plat_renesas_rcar_gen3,
139 .compatible = "renesas,xhci-r8a7796",
140 .data = &xhci_plat_renesas_rcar_gen3,
142 .compatible = "renesas,rcar-gen2-xhci",
143 .data = &xhci_plat_renesas_rcar_gen2,
145 .compatible = "renesas,rcar-gen3-xhci",
146 .data = &xhci_plat_renesas_rcar_gen3,
150 MODULE_DEVICE_TABLE(of, usb_xhci_of_match);
153 static int xhci_plat_probe(struct platform_device *pdev)
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;
168 driver = &xhci_plat_hc_driver;
170 irq = platform_get_irq(pdev, 0);
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)
181 for (sysdev = &pdev->dev; sysdev; sysdev = sysdev->parent) {
182 if (is_of_node(sysdev->fwnode) ||
183 is_acpi_device_node(sysdev->fwnode))
186 else if (sysdev->bus == &pci_bus_type)
194 /* Try to set 64-bit DMA first */
195 if (WARN_ON(!sysdev->dma_mask))
196 /* Platform did not initialize dma_mask */
197 ret = dma_coerce_mask_and_coherent(sysdev,
200 ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(64));
202 /* If seting 64-bit DMA mask fails, fall back to 32-bit DMA mask */
204 ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(32));
209 pm_runtime_set_active(&pdev->dev);
210 pm_runtime_enable(&pdev->dev);
211 pm_runtime_get_noresume(&pdev->dev);
213 hcd = __usb_create_hcd(driver, sysdev, &pdev->dev,
214 dev_name(&pdev->dev), NULL);
217 goto disable_runtime;
220 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
221 hcd->regs = devm_ioremap_resource(&pdev->dev, res);
222 if (IS_ERR(hcd->regs)) {
223 ret = PTR_ERR(hcd->regs);
227 hcd->rsrc_start = res->start;
228 hcd->rsrc_len = resource_size(res);
231 * Not all platforms have a clk so it is not an error if the
232 * clock does not exists.
234 clk = devm_clk_get(&pdev->dev, NULL);
236 ret = clk_prepare_enable(clk);
239 } else if (PTR_ERR(clk) == -EPROBE_DEFER) {
244 xhci = hcd_to_xhci(hcd);
245 match = of_match_node(usb_xhci_of_match, pdev->dev.of_node);
247 const struct xhci_plat_priv *priv_match = match->data;
248 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
250 /* Just copy data for now */
255 device_wakeup_enable(hcd->self.controller);
258 xhci->main_hcd = hcd;
259 xhci->shared_hcd = __usb_create_hcd(driver, sysdev, &pdev->dev,
260 dev_name(&pdev->dev), hcd);
261 if (!xhci->shared_hcd) {
266 if (device_property_read_bool(sysdev, "usb3-lpm-capable"))
267 xhci->quirks |= XHCI_LPM_SUPPORT;
269 if (device_property_read_bool(&pdev->dev, "quirk-broken-port-ped"))
270 xhci->quirks |= XHCI_BROKEN_PORT_PED;
272 hcd->usb_phy = devm_usb_get_phy_by_phandle(sysdev, "usb-phy", 0);
273 if (IS_ERR(hcd->usb_phy)) {
274 ret = PTR_ERR(hcd->usb_phy);
275 if (ret == -EPROBE_DEFER)
279 ret = usb_phy_init(hcd->usb_phy);
284 ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
286 goto disable_usb_phy;
288 if (HCC_MAX_PSA(xhci->hcc_params) >= 4)
289 xhci->shared_hcd->can_do_streams = 1;
291 ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
293 goto dealloc_usb2_hcd;
295 device_enable_async_suspend(&pdev->dev);
296 pm_runtime_put_noidle(&pdev->dev);
299 * Prevent runtime pm from being on as default, users should enable
300 * runtime pm using power/control in sysfs.
302 pm_runtime_forbid(&pdev->dev);
311 usb_phy_shutdown(hcd->usb_phy);
314 usb_put_hcd(xhci->shared_hcd);
318 clk_disable_unprepare(clk);
324 pm_runtime_put_noidle(&pdev->dev);
325 pm_runtime_disable(&pdev->dev);
330 static int xhci_plat_remove(struct platform_device *dev)
332 struct usb_hcd *hcd = platform_get_drvdata(dev);
333 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
334 struct clk *clk = xhci->clk;
335 struct usb_hcd *shared_hcd = xhci->shared_hcd;
337 pm_runtime_get_sync(&dev->dev);
338 xhci->xhc_state |= XHCI_STATE_REMOVING;
340 usb_remove_hcd(shared_hcd);
341 xhci->shared_hcd = NULL;
342 usb_phy_shutdown(hcd->usb_phy);
345 usb_put_hcd(shared_hcd);
348 clk_disable_unprepare(clk);
351 pm_runtime_disable(&dev->dev);
352 pm_runtime_put_noidle(&dev->dev);
353 pm_runtime_set_suspended(&dev->dev);
358 static int __maybe_unused xhci_plat_suspend(struct device *dev)
360 struct usb_hcd *hcd = dev_get_drvdata(dev);
361 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
364 * xhci_suspend() needs `do_wakeup` to know whether host is allowed
365 * to do wakeup during suspend. Since xhci_plat_suspend is currently
366 * only designed for system suspend, device_may_wakeup() is enough
367 * to dertermine whether host is allowed to do wakeup. Need to
368 * reconsider this when xhci_plat_suspend enlarges its scope, e.g.,
369 * also applies to runtime suspend.
371 return xhci_suspend(xhci, device_may_wakeup(dev));
374 static int __maybe_unused xhci_plat_resume(struct device *dev)
376 struct usb_hcd *hcd = dev_get_drvdata(dev);
377 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
380 ret = xhci_priv_resume_quirk(hcd);
384 return xhci_resume(xhci, 0);
387 static int __maybe_unused xhci_plat_runtime_suspend(struct device *dev)
389 struct usb_hcd *hcd = dev_get_drvdata(dev);
390 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
392 return xhci_suspend(xhci, true);
395 static int __maybe_unused xhci_plat_runtime_resume(struct device *dev)
397 struct usb_hcd *hcd = dev_get_drvdata(dev);
398 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
400 return xhci_resume(xhci, 0);
403 static const struct dev_pm_ops xhci_plat_pm_ops = {
404 SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume)
406 SET_RUNTIME_PM_OPS(xhci_plat_runtime_suspend,
407 xhci_plat_runtime_resume,
411 static const struct acpi_device_id usb_xhci_acpi_match[] = {
412 /* XHCI-compliant USB Controller */
416 MODULE_DEVICE_TABLE(acpi, usb_xhci_acpi_match);
418 static struct platform_driver usb_xhci_driver = {
419 .probe = xhci_plat_probe,
420 .remove = xhci_plat_remove,
421 .shutdown = usb_hcd_platform_shutdown,
424 .pm = &xhci_plat_pm_ops,
425 .of_match_table = of_match_ptr(usb_xhci_of_match),
426 .acpi_match_table = ACPI_PTR(usb_xhci_acpi_match),
429 MODULE_ALIAS("platform:xhci-hcd");
431 static int __init xhci_plat_init(void)
433 xhci_init_driver(&xhci_plat_hc_driver, &xhci_plat_overrides);
434 return platform_driver_register(&usb_xhci_driver);
436 module_init(xhci_plat_init);
438 static void __exit xhci_plat_exit(void)
440 platform_driver_unregister(&usb_xhci_driver);
442 module_exit(xhci_plat_exit);
444 MODULE_DESCRIPTION("xHCI Platform Host Controller Driver");
445 MODULE_LICENSE("GPL");