1 // SPDX-License-Identifier: GPL-2.0
3 * xhci-plat.c - xHCI host controller driver platform Bus Glue.
5 * Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com
6 * Author: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
8 * A lot of code borrowed from the Linux xHCI driver.
11 #include <linux/clk.h>
12 #include <linux/dma-mapping.h>
13 #include <linux/module.h>
14 #include <linux/pci.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>
23 #include "xhci-plat.h"
24 #include "xhci-mvebu.h"
25 #include "xhci-rcar.h"
27 static struct hc_driver __read_mostly xhci_plat_hc_driver;
29 static int xhci_plat_setup(struct usb_hcd *hcd);
30 static int xhci_plat_start(struct usb_hcd *hcd);
32 static const struct xhci_driver_overrides xhci_plat_overrides __initconst = {
33 .extra_priv_size = sizeof(struct xhci_plat_priv),
34 .reset = xhci_plat_setup,
35 .start = xhci_plat_start,
38 static void xhci_priv_plat_start(struct usb_hcd *hcd)
40 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
43 priv->plat_start(hcd);
46 static int xhci_priv_init_quirk(struct usb_hcd *hcd)
48 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
50 if (!priv->init_quirk)
53 return priv->init_quirk(hcd);
56 static int xhci_priv_resume_quirk(struct usb_hcd *hcd)
58 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
60 if (!priv->resume_quirk)
63 return priv->resume_quirk(hcd);
66 static void xhci_plat_quirks(struct device *dev, struct xhci_hcd *xhci)
69 * As of now platform drivers don't provide MSI support so we ensure
70 * here that the generic code does not try to make a pci_dev from our
71 * dev struct in order to setup MSI
73 xhci->quirks |= XHCI_PLAT;
76 /* called during probe() after chip reset completes */
77 static int xhci_plat_setup(struct usb_hcd *hcd)
82 ret = xhci_priv_init_quirk(hcd);
86 return xhci_gen_setup(hcd, xhci_plat_quirks);
89 static int xhci_plat_start(struct usb_hcd *hcd)
91 xhci_priv_plat_start(hcd);
96 static const struct xhci_plat_priv xhci_plat_marvell_armada = {
97 .init_quirk = xhci_mvebu_mbus_init_quirk,
100 static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen2 = {
101 .firmware_name = XHCI_RCAR_FIRMWARE_NAME_V1,
102 .init_quirk = xhci_rcar_init_quirk,
103 .plat_start = xhci_rcar_start,
104 .resume_quirk = xhci_rcar_resume_quirk,
107 static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen3 = {
108 .firmware_name = XHCI_RCAR_FIRMWARE_NAME_V3,
109 .init_quirk = xhci_rcar_init_quirk,
110 .plat_start = xhci_rcar_start,
111 .resume_quirk = xhci_rcar_resume_quirk,
114 static const struct of_device_id usb_xhci_of_match[] = {
116 .compatible = "generic-xhci",
118 .compatible = "xhci-platform",
120 .compatible = "marvell,armada-375-xhci",
121 .data = &xhci_plat_marvell_armada,
123 .compatible = "marvell,armada-380-xhci",
124 .data = &xhci_plat_marvell_armada,
126 .compatible = "renesas,xhci-r8a7790",
127 .data = &xhci_plat_renesas_rcar_gen2,
129 .compatible = "renesas,xhci-r8a7791",
130 .data = &xhci_plat_renesas_rcar_gen2,
132 .compatible = "renesas,xhci-r8a7793",
133 .data = &xhci_plat_renesas_rcar_gen2,
135 .compatible = "renesas,xhci-r8a7795",
136 .data = &xhci_plat_renesas_rcar_gen3,
138 .compatible = "renesas,xhci-r8a7796",
139 .data = &xhci_plat_renesas_rcar_gen3,
141 .compatible = "renesas,rcar-gen2-xhci",
142 .data = &xhci_plat_renesas_rcar_gen2,
144 .compatible = "renesas,rcar-gen3-xhci",
145 .data = &xhci_plat_renesas_rcar_gen3,
149 MODULE_DEVICE_TABLE(of, usb_xhci_of_match);
152 static int xhci_plat_probe(struct platform_device *pdev)
154 const struct xhci_plat_priv *priv_match;
155 const struct hc_driver *driver;
156 struct device *sysdev;
157 struct xhci_hcd *xhci;
158 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 clks so it is not an error if the
232 * clock do not exist.
234 reg_clk = devm_clk_get(&pdev->dev, "reg");
235 if (!IS_ERR(reg_clk)) {
236 ret = clk_prepare_enable(reg_clk);
239 } else if (PTR_ERR(reg_clk) == -EPROBE_DEFER) {
244 clk = devm_clk_get(&pdev->dev, NULL);
246 ret = clk_prepare_enable(clk);
248 goto disable_reg_clk;
249 } else if (PTR_ERR(clk) == -EPROBE_DEFER) {
251 goto disable_reg_clk;
254 xhci = hcd_to_xhci(hcd);
255 priv_match = of_device_get_match_data(&pdev->dev);
257 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
259 /* Just copy data for now */
264 device_wakeup_enable(hcd->self.controller);
267 xhci->reg_clk = reg_clk;
268 xhci->main_hcd = hcd;
269 xhci->shared_hcd = __usb_create_hcd(driver, sysdev, &pdev->dev,
270 dev_name(&pdev->dev), hcd);
271 if (!xhci->shared_hcd) {
276 if (device_property_read_bool(sysdev, "usb2-lpm-disable"))
277 xhci->quirks |= XHCI_HW_LPM_DISABLE;
279 if (device_property_read_bool(sysdev, "usb3-lpm-capable"))
280 xhci->quirks |= XHCI_LPM_SUPPORT;
282 if (device_property_read_bool(&pdev->dev, "quirk-broken-port-ped"))
283 xhci->quirks |= XHCI_BROKEN_PORT_PED;
285 /* imod_interval is the interrupt moderation value in nanoseconds. */
286 xhci->imod_interval = 40000;
287 device_property_read_u32(sysdev, "imod-interval-ns",
288 &xhci->imod_interval);
290 hcd->usb_phy = devm_usb_get_phy_by_phandle(sysdev, "usb-phy", 0);
291 if (IS_ERR(hcd->usb_phy)) {
292 ret = PTR_ERR(hcd->usb_phy);
293 if (ret == -EPROBE_DEFER)
297 ret = usb_phy_init(hcd->usb_phy);
300 hcd->skip_phy_initialization = 1;
303 ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
305 goto disable_usb_phy;
307 if (HCC_MAX_PSA(xhci->hcc_params) >= 4)
308 xhci->shared_hcd->can_do_streams = 1;
310 ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
312 goto dealloc_usb2_hcd;
314 device_enable_async_suspend(&pdev->dev);
315 pm_runtime_put_noidle(&pdev->dev);
318 * Prevent runtime pm from being on as default, users should enable
319 * runtime pm using power/control in sysfs.
321 pm_runtime_forbid(&pdev->dev);
330 usb_phy_shutdown(hcd->usb_phy);
333 usb_put_hcd(xhci->shared_hcd);
336 clk_disable_unprepare(clk);
339 clk_disable_unprepare(reg_clk);
345 pm_runtime_put_noidle(&pdev->dev);
346 pm_runtime_disable(&pdev->dev);
351 static int xhci_plat_remove(struct platform_device *dev)
353 struct usb_hcd *hcd = platform_get_drvdata(dev);
354 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
355 struct clk *clk = xhci->clk;
356 struct clk *reg_clk = xhci->reg_clk;
358 xhci->xhc_state |= XHCI_STATE_REMOVING;
360 usb_remove_hcd(xhci->shared_hcd);
361 usb_phy_shutdown(hcd->usb_phy);
364 usb_put_hcd(xhci->shared_hcd);
366 clk_disable_unprepare(clk);
367 clk_disable_unprepare(reg_clk);
370 pm_runtime_set_suspended(&dev->dev);
371 pm_runtime_disable(&dev->dev);
376 static int __maybe_unused xhci_plat_suspend(struct device *dev)
378 struct usb_hcd *hcd = dev_get_drvdata(dev);
379 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
382 * xhci_suspend() needs `do_wakeup` to know whether host is allowed
383 * to do wakeup during suspend. Since xhci_plat_suspend is currently
384 * only designed for system suspend, device_may_wakeup() is enough
385 * to dertermine whether host is allowed to do wakeup. Need to
386 * reconsider this when xhci_plat_suspend enlarges its scope, e.g.,
387 * also applies to runtime suspend.
389 return xhci_suspend(xhci, device_may_wakeup(dev));
392 static int __maybe_unused xhci_plat_resume(struct device *dev)
394 struct usb_hcd *hcd = dev_get_drvdata(dev);
395 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
398 ret = xhci_priv_resume_quirk(hcd);
402 return xhci_resume(xhci, 0);
405 static int __maybe_unused xhci_plat_runtime_suspend(struct device *dev)
407 struct usb_hcd *hcd = dev_get_drvdata(dev);
408 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
410 return xhci_suspend(xhci, true);
413 static int __maybe_unused xhci_plat_runtime_resume(struct device *dev)
415 struct usb_hcd *hcd = dev_get_drvdata(dev);
416 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
418 return xhci_resume(xhci, 0);
421 static const struct dev_pm_ops xhci_plat_pm_ops = {
422 SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume)
424 SET_RUNTIME_PM_OPS(xhci_plat_runtime_suspend,
425 xhci_plat_runtime_resume,
429 static const struct acpi_device_id usb_xhci_acpi_match[] = {
430 /* XHCI-compliant USB Controller */
434 MODULE_DEVICE_TABLE(acpi, usb_xhci_acpi_match);
436 static struct platform_driver usb_xhci_driver = {
437 .probe = xhci_plat_probe,
438 .remove = xhci_plat_remove,
441 .pm = &xhci_plat_pm_ops,
442 .of_match_table = of_match_ptr(usb_xhci_of_match),
443 .acpi_match_table = ACPI_PTR(usb_xhci_acpi_match),
446 MODULE_ALIAS("platform:xhci-hcd");
448 static int __init xhci_plat_init(void)
450 xhci_init_driver(&xhci_plat_hc_driver, &xhci_plat_overrides);
451 return platform_driver_register(&usb_xhci_driver);
453 module_init(xhci_plat_init);
455 static void __exit xhci_plat_exit(void)
457 platform_driver_unregister(&usb_xhci_driver);
459 module_exit(xhci_plat_exit);
461 MODULE_DESCRIPTION("xHCI Platform Host Controller Driver");
462 MODULE_LICENSE("GPL");