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>
18 #include <linux/platform_device.h>
19 #include <linux/usb/phy.h>
20 #include <linux/slab.h>
21 #include <linux/usb/xhci_pdriver.h>
22 #include <linux/acpi.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_hcd),
35 .reset = xhci_plat_setup,
36 .start = xhci_plat_start,
39 static void xhci_plat_quirks(struct device *dev, struct xhci_hcd *xhci)
41 struct usb_xhci_pdata *pdata = dev_get_platdata(dev);
44 * As of now platform drivers don't provide MSI support so we ensure
45 * here that the generic code does not try to make a pci_dev from our
46 * dev struct in order to setup MSI
48 xhci->quirks |= XHCI_PLAT;
51 * On some xHCI controllers (e.g. Rockchip SoCs), it need an
52 * extraordinary delay to wait for xHCI enter the Halted state
53 * after the Run/Stop (R/S) bit is cleared to '0'.
55 if (pdata && pdata->xhci_slow_suspend)
56 xhci->quirks |= XHCI_SLOW_SUSPEND;
59 /* called during probe() after chip reset completes */
60 static int xhci_plat_setup(struct usb_hcd *hcd)
62 struct device_node *of_node = hcd->self.controller->of_node;
65 if (of_device_is_compatible(of_node, "renesas,xhci-r8a7790") ||
66 of_device_is_compatible(of_node, "renesas,xhci-r8a7791")) {
67 ret = xhci_rcar_init_quirk(hcd);
72 return xhci_gen_setup(hcd, xhci_plat_quirks);
75 static int xhci_plat_start(struct usb_hcd *hcd)
77 struct device_node *of_node = hcd->self.controller->of_node;
79 if (of_device_is_compatible(of_node, "renesas,xhci-r8a7790") ||
80 of_device_is_compatible(of_node, "renesas,xhci-r8a7791"))
86 static int xhci_plat_probe(struct platform_device *pdev)
88 struct device_node *node = pdev->dev.of_node;
89 struct usb_xhci_pdata *pdata = dev_get_platdata(&pdev->dev);
90 const struct hc_driver *driver;
91 struct xhci_hcd *xhci;
101 driver = &xhci_plat_hc_driver;
103 irq = platform_get_irq(pdev, 0);
107 /* Try to set 64-bit DMA first */
108 if (WARN_ON(!pdev->dev.dma_mask))
109 /* Platform did not initialize dma_mask */
110 ret = dma_coerce_mask_and_coherent(&pdev->dev,
113 ret = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64));
115 /* If seting 64-bit DMA mask fails, fall back to 32-bit DMA mask */
117 ret = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
122 hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev));
126 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
127 hcd->regs = devm_ioremap_resource(&pdev->dev, res);
128 if (IS_ERR(hcd->regs)) {
129 ret = PTR_ERR(hcd->regs);
133 hcd->rsrc_start = res->start;
134 hcd->rsrc_len = resource_size(res);
137 * Not all platforms have a clk so it is not an error if the
138 * clock does not exists.
140 clk = devm_clk_get(&pdev->dev, NULL);
142 ret = clk_prepare_enable(clk);
145 } else if (PTR_ERR(clk) == -EPROBE_DEFER) {
150 if (of_device_is_compatible(pdev->dev.of_node,
151 "marvell,armada-375-xhci") ||
152 of_device_is_compatible(pdev->dev.of_node,
153 "marvell,armada-380-xhci")) {
154 ret = xhci_mvebu_mbus_init_quirk(pdev);
159 device_wakeup_enable(hcd->self.controller);
161 xhci = hcd_to_xhci(hcd);
163 xhci->main_hcd = hcd;
164 xhci->shared_hcd = usb_create_shared_hcd(driver, &pdev->dev,
165 dev_name(&pdev->dev), hcd);
166 if (!xhci->shared_hcd) {
171 if ((node && of_property_read_bool(node, "usb3-lpm-capable")) ||
172 (pdata && pdata->usb3_lpm_capable))
173 xhci->quirks |= XHCI_LPM_SUPPORT;
175 if (HCC_MAX_PSA(xhci->hcc_params) >= 4)
176 xhci->shared_hcd->can_do_streams = 1;
178 hcd->usb_phy = devm_usb_get_phy_by_phandle(&pdev->dev, "usb-phy", 0);
179 if (IS_ERR(hcd->usb_phy)) {
180 ret = PTR_ERR(hcd->usb_phy);
181 if (ret == -EPROBE_DEFER)
185 ret = usb_phy_init(hcd->usb_phy);
190 ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
192 goto disable_usb_phy;
194 ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
196 goto dealloc_usb2_hcd;
205 usb_phy_shutdown(hcd->usb_phy);
208 usb_put_hcd(xhci->shared_hcd);
212 clk_disable_unprepare(clk);
220 static int xhci_plat_remove(struct platform_device *dev)
222 struct usb_hcd *hcd = platform_get_drvdata(dev);
223 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
224 struct clk *clk = xhci->clk;
226 usb_remove_hcd(xhci->shared_hcd);
227 usb_phy_shutdown(hcd->usb_phy);
230 usb_put_hcd(xhci->shared_hcd);
233 clk_disable_unprepare(clk);
239 #ifdef CONFIG_PM_SLEEP
240 static int xhci_plat_suspend(struct device *dev)
242 struct usb_hcd *hcd = dev_get_drvdata(dev);
243 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
246 * xhci_suspend() needs `do_wakeup` to know whether host is allowed
247 * to do wakeup during suspend. Since xhci_plat_suspend is currently
248 * only designed for system suspend, device_may_wakeup() is enough
249 * to dertermine whether host is allowed to do wakeup. Need to
250 * reconsider this when xhci_plat_suspend enlarges its scope, e.g.,
251 * also applies to runtime suspend.
253 return xhci_suspend(xhci, device_may_wakeup(dev));
256 static int xhci_plat_resume(struct device *dev)
258 struct usb_hcd *hcd = dev_get_drvdata(dev);
259 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
261 return xhci_resume(xhci, 0);
264 static const struct dev_pm_ops xhci_plat_pm_ops = {
265 SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume)
267 #define DEV_PM_OPS (&xhci_plat_pm_ops)
269 #define DEV_PM_OPS NULL
270 #endif /* CONFIG_PM */
273 static const struct of_device_id usb_xhci_of_match[] = {
274 { .compatible = "generic-xhci" },
275 { .compatible = "xhci-platform" },
276 { .compatible = "marvell,armada-375-xhci"},
277 { .compatible = "marvell,armada-380-xhci"},
278 { .compatible = "renesas,xhci-r8a7790"},
279 { .compatible = "renesas,xhci-r8a7791"},
282 MODULE_DEVICE_TABLE(of, usb_xhci_of_match);
285 static const struct acpi_device_id usb_xhci_acpi_match[] = {
286 /* XHCI-compliant USB Controller */
290 MODULE_DEVICE_TABLE(acpi, usb_xhci_acpi_match);
292 static struct platform_driver usb_xhci_driver = {
293 .probe = xhci_plat_probe,
294 .remove = xhci_plat_remove,
295 .shutdown = usb_hcd_platform_shutdown,
299 .of_match_table = of_match_ptr(usb_xhci_of_match),
300 .acpi_match_table = ACPI_PTR(usb_xhci_acpi_match),
303 MODULE_ALIAS("platform:xhci-hcd");
305 static int __init xhci_plat_init(void)
307 xhci_init_driver(&xhci_plat_hc_driver, &xhci_plat_overrides);
308 return platform_driver_register(&usb_xhci_driver);
310 module_init(xhci_plat_init);
312 static void __exit xhci_plat_exit(void)
314 platform_driver_unregister(&usb_xhci_driver);
316 module_exit(xhci_plat_exit);
318 MODULE_DESCRIPTION("xHCI Platform Host Controller Driver");
319 MODULE_LICENSE("GPL");