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>
21 #include <linux/usb/of.h>
24 #include "xhci-plat.h"
25 #include "xhci-mvebu.h"
26 #include "xhci-rcar.h"
28 static struct hc_driver __read_mostly xhci_plat_hc_driver
;
30 static int xhci_plat_setup(struct usb_hcd
*hcd
);
31 static int xhci_plat_start(struct usb_hcd
*hcd
);
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
,
39 static void xhci_priv_plat_start(struct usb_hcd
*hcd
)
41 struct xhci_plat_priv
*priv
= hcd_to_xhci_priv(hcd
);
44 priv
->plat_start(hcd
);
47 static int xhci_priv_init_quirk(struct usb_hcd
*hcd
)
49 struct xhci_plat_priv
*priv
= hcd_to_xhci_priv(hcd
);
51 if (!priv
->init_quirk
)
54 return priv
->init_quirk(hcd
);
57 static int xhci_priv_resume_quirk(struct usb_hcd
*hcd
)
59 struct xhci_plat_priv
*priv
= hcd_to_xhci_priv(hcd
);
61 if (!priv
->resume_quirk
)
64 return priv
->resume_quirk(hcd
);
67 static void xhci_plat_quirks(struct device
*dev
, struct xhci_hcd
*xhci
)
69 struct xhci_plat_priv
*priv
= xhci_to_priv(xhci
);
72 * As of now platform drivers don't provide MSI support so we ensure
73 * here that the generic code does not try to make a pci_dev from our
74 * dev struct in order to setup MSI
76 xhci
->quirks
|= XHCI_PLAT
| priv
->quirks
;
79 /* called during probe() after chip reset completes */
80 static int xhci_plat_setup(struct usb_hcd
*hcd
)
85 ret
= xhci_priv_init_quirk(hcd
);
89 return xhci_gen_setup(hcd
, xhci_plat_quirks
);
92 static int xhci_plat_start(struct usb_hcd
*hcd
)
94 xhci_priv_plat_start(hcd
);
99 static const struct xhci_plat_priv xhci_plat_marvell_armada
= {
100 .init_quirk
= xhci_mvebu_mbus_init_quirk
,
103 static const struct xhci_plat_priv xhci_plat_marvell_armada3700
= {
104 .init_quirk
= xhci_mvebu_a3700_init_quirk
,
107 static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen2
= {
108 SET_XHCI_PLAT_PRIV_FOR_RCAR(XHCI_RCAR_FIRMWARE_NAME_V1
)
111 static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen3
= {
112 SET_XHCI_PLAT_PRIV_FOR_RCAR(XHCI_RCAR_FIRMWARE_NAME_V3
)
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
= "marvell,armada3700-xhci",
128 .data
= &xhci_plat_marvell_armada3700
,
130 .compatible
= "renesas,xhci-r8a7790",
131 .data
= &xhci_plat_renesas_rcar_gen2
,
133 .compatible
= "renesas,xhci-r8a7791",
134 .data
= &xhci_plat_renesas_rcar_gen2
,
136 .compatible
= "renesas,xhci-r8a7793",
137 .data
= &xhci_plat_renesas_rcar_gen2
,
139 .compatible
= "renesas,xhci-r8a7795",
140 .data
= &xhci_plat_renesas_rcar_gen3
,
142 .compatible
= "renesas,xhci-r8a7796",
143 .data
= &xhci_plat_renesas_rcar_gen3
,
145 .compatible
= "renesas,rcar-gen2-xhci",
146 .data
= &xhci_plat_renesas_rcar_gen2
,
148 .compatible
= "renesas,rcar-gen3-xhci",
149 .data
= &xhci_plat_renesas_rcar_gen3
,
153 MODULE_DEVICE_TABLE(of
, usb_xhci_of_match
);
156 static int xhci_plat_probe(struct platform_device
*pdev
)
158 const struct xhci_plat_priv
*priv_match
;
159 const struct hc_driver
*driver
;
160 struct device
*sysdev
, *tmpdev
;
161 struct xhci_hcd
*xhci
;
162 struct resource
*res
;
170 driver
= &xhci_plat_hc_driver
;
172 irq
= platform_get_irq(pdev
, 0);
177 * sysdev must point to a device that is known to the system firmware
178 * or PCI hardware. We handle these three cases here:
179 * 1. xhci_plat comes from firmware
180 * 2. xhci_plat is child of a device from firmware (dwc3-plat)
181 * 3. xhci_plat is grandchild of a pci device (dwc3-pci)
183 for (sysdev
= &pdev
->dev
; sysdev
; sysdev
= sysdev
->parent
) {
184 if (is_of_node(sysdev
->fwnode
) ||
185 is_acpi_device_node(sysdev
->fwnode
))
188 else if (sysdev
->bus
== &pci_bus_type
)
196 /* Try to set 64-bit DMA first */
197 if (WARN_ON(!sysdev
->dma_mask
))
198 /* Platform did not initialize dma_mask */
199 ret
= dma_coerce_mask_and_coherent(sysdev
,
202 ret
= dma_set_mask_and_coherent(sysdev
, DMA_BIT_MASK(64));
204 /* If seting 64-bit DMA mask fails, fall back to 32-bit DMA mask */
206 ret
= dma_set_mask_and_coherent(sysdev
, DMA_BIT_MASK(32));
211 pm_runtime_set_active(&pdev
->dev
);
212 pm_runtime_enable(&pdev
->dev
);
213 pm_runtime_get_noresume(&pdev
->dev
);
215 hcd
= __usb_create_hcd(driver
, sysdev
, &pdev
->dev
,
216 dev_name(&pdev
->dev
), NULL
);
219 goto disable_runtime
;
222 hcd
->regs
= devm_platform_get_and_ioremap_resource(pdev
, 0, &res
);
223 if (IS_ERR(hcd
->regs
)) {
224 ret
= PTR_ERR(hcd
->regs
);
228 hcd
->rsrc_start
= res
->start
;
229 hcd
->rsrc_len
= resource_size(res
);
231 xhci
= hcd_to_xhci(hcd
);
234 * Not all platforms have clks so it is not an error if the
235 * clock do not exist.
237 xhci
->reg_clk
= devm_clk_get_optional(&pdev
->dev
, "reg");
238 if (IS_ERR(xhci
->reg_clk
)) {
239 ret
= PTR_ERR(xhci
->reg_clk
);
243 ret
= clk_prepare_enable(xhci
->reg_clk
);
247 xhci
->clk
= devm_clk_get_optional(&pdev
->dev
, NULL
);
248 if (IS_ERR(xhci
->clk
)) {
249 ret
= PTR_ERR(xhci
->clk
);
250 goto disable_reg_clk
;
253 ret
= clk_prepare_enable(xhci
->clk
);
255 goto disable_reg_clk
;
257 priv_match
= of_device_get_match_data(&pdev
->dev
);
259 struct xhci_plat_priv
*priv
= hcd_to_xhci_priv(hcd
);
261 /* Just copy data for now */
266 device_wakeup_enable(hcd
->self
.controller
);
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 /* imod_interval is the interrupt moderation value in nanoseconds. */
277 xhci
->imod_interval
= 40000;
279 /* Iterate over all parent nodes for finding quirks */
280 for (tmpdev
= &pdev
->dev
; tmpdev
; tmpdev
= tmpdev
->parent
) {
282 if (device_property_read_bool(tmpdev
, "usb2-lpm-disable"))
283 xhci
->quirks
|= XHCI_HW_LPM_DISABLE
;
285 if (device_property_read_bool(tmpdev
, "usb3-lpm-capable"))
286 xhci
->quirks
|= XHCI_LPM_SUPPORT
;
288 if (device_property_read_bool(tmpdev
, "quirk-broken-port-ped"))
289 xhci
->quirks
|= XHCI_BROKEN_PORT_PED
;
291 device_property_read_u32(tmpdev
, "imod-interval-ns",
292 &xhci
->imod_interval
);
295 hcd
->usb_phy
= devm_usb_get_phy_by_phandle(sysdev
, "usb-phy", 0);
296 if (IS_ERR(hcd
->usb_phy
)) {
297 ret
= PTR_ERR(hcd
->usb_phy
);
298 if (ret
== -EPROBE_DEFER
)
302 ret
= usb_phy_init(hcd
->usb_phy
);
307 hcd
->tpl_support
= of_usb_host_tpl_support(sysdev
->of_node
);
308 xhci
->shared_hcd
->tpl_support
= hcd
->tpl_support
;
309 ret
= usb_add_hcd(hcd
, irq
, IRQF_SHARED
);
311 goto disable_usb_phy
;
313 if (HCC_MAX_PSA(xhci
->hcc_params
) >= 4)
314 xhci
->shared_hcd
->can_do_streams
= 1;
316 ret
= usb_add_hcd(xhci
->shared_hcd
, irq
, IRQF_SHARED
);
318 goto dealloc_usb2_hcd
;
320 device_enable_async_suspend(&pdev
->dev
);
321 pm_runtime_put_noidle(&pdev
->dev
);
324 * Prevent runtime pm from being on as default, users should enable
325 * runtime pm using power/control in sysfs.
327 pm_runtime_forbid(&pdev
->dev
);
336 usb_phy_shutdown(hcd
->usb_phy
);
339 usb_put_hcd(xhci
->shared_hcd
);
342 clk_disable_unprepare(xhci
->clk
);
345 clk_disable_unprepare(xhci
->reg_clk
);
351 pm_runtime_put_noidle(&pdev
->dev
);
352 pm_runtime_disable(&pdev
->dev
);
357 static int xhci_plat_remove(struct platform_device
*dev
)
359 struct usb_hcd
*hcd
= platform_get_drvdata(dev
);
360 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
361 struct clk
*clk
= xhci
->clk
;
362 struct clk
*reg_clk
= xhci
->reg_clk
;
363 struct usb_hcd
*shared_hcd
= xhci
->shared_hcd
;
365 pm_runtime_get_sync(&dev
->dev
);
366 xhci
->xhc_state
|= XHCI_STATE_REMOVING
;
368 usb_remove_hcd(shared_hcd
);
369 xhci
->shared_hcd
= NULL
;
370 usb_phy_shutdown(hcd
->usb_phy
);
373 usb_put_hcd(shared_hcd
);
375 clk_disable_unprepare(clk
);
376 clk_disable_unprepare(reg_clk
);
379 pm_runtime_disable(&dev
->dev
);
380 pm_runtime_put_noidle(&dev
->dev
);
381 pm_runtime_set_suspended(&dev
->dev
);
386 static int __maybe_unused
xhci_plat_suspend(struct device
*dev
)
388 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
389 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
392 * xhci_suspend() needs `do_wakeup` to know whether host is allowed
393 * to do wakeup during suspend. Since xhci_plat_suspend is currently
394 * only designed for system suspend, device_may_wakeup() is enough
395 * to dertermine whether host is allowed to do wakeup. Need to
396 * reconsider this when xhci_plat_suspend enlarges its scope, e.g.,
397 * also applies to runtime suspend.
399 return xhci_suspend(xhci
, device_may_wakeup(dev
));
402 static int __maybe_unused
xhci_plat_resume(struct device
*dev
)
404 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
405 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
408 ret
= xhci_priv_resume_quirk(hcd
);
412 return xhci_resume(xhci
, 0);
415 static int __maybe_unused
xhci_plat_runtime_suspend(struct device
*dev
)
417 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
418 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
420 return xhci_suspend(xhci
, true);
423 static int __maybe_unused
xhci_plat_runtime_resume(struct device
*dev
)
425 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
426 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
428 return xhci_resume(xhci
, 0);
431 static const struct dev_pm_ops xhci_plat_pm_ops
= {
432 SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend
, xhci_plat_resume
)
434 SET_RUNTIME_PM_OPS(xhci_plat_runtime_suspend
,
435 xhci_plat_runtime_resume
,
439 static const struct acpi_device_id usb_xhci_acpi_match
[] = {
440 /* XHCI-compliant USB Controller */
444 MODULE_DEVICE_TABLE(acpi
, usb_xhci_acpi_match
);
446 static struct platform_driver usb_xhci_driver
= {
447 .probe
= xhci_plat_probe
,
448 .remove
= xhci_plat_remove
,
449 .shutdown
= usb_hcd_platform_shutdown
,
452 .pm
= &xhci_plat_pm_ops
,
453 .of_match_table
= of_match_ptr(usb_xhci_of_match
),
454 .acpi_match_table
= ACPI_PTR(usb_xhci_acpi_match
),
457 MODULE_ALIAS("platform:xhci-hcd");
459 static int __init
xhci_plat_init(void)
461 xhci_init_driver(&xhci_plat_hc_driver
, &xhci_plat_overrides
);
462 return platform_driver_register(&usb_xhci_driver
);
464 module_init(xhci_plat_init
);
466 static void __exit
xhci_plat_exit(void)
468 platform_driver_unregister(&usb_xhci_driver
);
470 module_exit(xhci_plat_exit
);
472 MODULE_DESCRIPTION("xHCI Platform Host Controller Driver");
473 MODULE_LICENSE("GPL");