Linux 4.16.11
[linux/fpc-iii.git] / drivers / usb / host / xhci-plat.c
blobc435df29cdb8fd8596173ad22cdbbc0d06b4c40e
1 // SPDX-License-Identifier: GPL-2.0
2 /*
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.
9 */
11 #include <linux/clk.h>
12 #include <linux/dma-mapping.h>
13 #include <linux/module.h>
14 #include <linux/pci.h>
15 #include <linux/of.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>
22 #include "xhci.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);
42 if (priv->plat_start)
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)
51 return 0;
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)
61 return 0;
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)
79 int ret;
82 ret = xhci_priv_init_quirk(hcd);
83 if (ret)
84 return ret;
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);
92 return xhci_run(hcd);
95 #ifdef CONFIG_OF
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 .init_quirk = xhci_rcar_init_quirk,
109 .plat_start = xhci_rcar_start,
110 .resume_quirk = xhci_rcar_resume_quirk,
113 static const struct of_device_id usb_xhci_of_match[] = {
115 .compatible = "generic-xhci",
116 }, {
117 .compatible = "xhci-platform",
118 }, {
119 .compatible = "marvell,armada-375-xhci",
120 .data = &xhci_plat_marvell_armada,
121 }, {
122 .compatible = "marvell,armada-380-xhci",
123 .data = &xhci_plat_marvell_armada,
124 }, {
125 .compatible = "renesas,xhci-r8a7790",
126 .data = &xhci_plat_renesas_rcar_gen2,
127 }, {
128 .compatible = "renesas,xhci-r8a7791",
129 .data = &xhci_plat_renesas_rcar_gen2,
130 }, {
131 .compatible = "renesas,xhci-r8a7793",
132 .data = &xhci_plat_renesas_rcar_gen2,
133 }, {
134 .compatible = "renesas,xhci-r8a7795",
135 .data = &xhci_plat_renesas_rcar_gen3,
136 }, {
137 .compatible = "renesas,xhci-r8a7796",
138 .data = &xhci_plat_renesas_rcar_gen3,
139 }, {
140 .compatible = "renesas,rcar-gen2-xhci",
141 .data = &xhci_plat_renesas_rcar_gen2,
142 }, {
143 .compatible = "renesas,rcar-gen3-xhci",
144 .data = &xhci_plat_renesas_rcar_gen3,
148 MODULE_DEVICE_TABLE(of, usb_xhci_of_match);
149 #endif
151 static int xhci_plat_probe(struct platform_device *pdev)
153 const struct xhci_plat_priv *priv_match;
154 const struct hc_driver *driver;
155 struct device *sysdev;
156 struct xhci_hcd *xhci;
157 struct resource *res;
158 struct usb_hcd *hcd;
159 struct clk *clk;
160 int ret;
161 int irq;
163 if (usb_disabled())
164 return -ENODEV;
166 driver = &xhci_plat_hc_driver;
168 irq = platform_get_irq(pdev, 0);
169 if (irq < 0)
170 return irq;
173 * sysdev must point to a device that is known to the system firmware
174 * or PCI hardware. We handle these three cases here:
175 * 1. xhci_plat comes from firmware
176 * 2. xhci_plat is child of a device from firmware (dwc3-plat)
177 * 3. xhci_plat is grandchild of a pci device (dwc3-pci)
179 for (sysdev = &pdev->dev; sysdev; sysdev = sysdev->parent) {
180 if (is_of_node(sysdev->fwnode) ||
181 is_acpi_device_node(sysdev->fwnode))
182 break;
183 #ifdef CONFIG_PCI
184 else if (sysdev->bus == &pci_bus_type)
185 break;
186 #endif
189 if (!sysdev)
190 sysdev = &pdev->dev;
192 /* Try to set 64-bit DMA first */
193 if (WARN_ON(!sysdev->dma_mask))
194 /* Platform did not initialize dma_mask */
195 ret = dma_coerce_mask_and_coherent(sysdev,
196 DMA_BIT_MASK(64));
197 else
198 ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(64));
200 /* If seting 64-bit DMA mask fails, fall back to 32-bit DMA mask */
201 if (ret) {
202 ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(32));
203 if (ret)
204 return ret;
207 pm_runtime_set_active(&pdev->dev);
208 pm_runtime_enable(&pdev->dev);
209 pm_runtime_get_noresume(&pdev->dev);
211 hcd = __usb_create_hcd(driver, sysdev, &pdev->dev,
212 dev_name(&pdev->dev), NULL);
213 if (!hcd) {
214 ret = -ENOMEM;
215 goto disable_runtime;
218 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
219 hcd->regs = devm_ioremap_resource(&pdev->dev, res);
220 if (IS_ERR(hcd->regs)) {
221 ret = PTR_ERR(hcd->regs);
222 goto put_hcd;
225 hcd->rsrc_start = res->start;
226 hcd->rsrc_len = resource_size(res);
229 * Not all platforms have a clk so it is not an error if the
230 * clock does not exists.
232 clk = devm_clk_get(&pdev->dev, NULL);
233 if (!IS_ERR(clk)) {
234 ret = clk_prepare_enable(clk);
235 if (ret)
236 goto put_hcd;
237 } else if (PTR_ERR(clk) == -EPROBE_DEFER) {
238 ret = -EPROBE_DEFER;
239 goto put_hcd;
242 xhci = hcd_to_xhci(hcd);
243 priv_match = of_device_get_match_data(&pdev->dev);
244 if (priv_match) {
245 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
247 /* Just copy data for now */
248 if (priv_match)
249 *priv = *priv_match;
252 device_wakeup_enable(hcd->self.controller);
254 xhci->clk = clk;
255 xhci->main_hcd = hcd;
256 xhci->shared_hcd = __usb_create_hcd(driver, sysdev, &pdev->dev,
257 dev_name(&pdev->dev), hcd);
258 if (!xhci->shared_hcd) {
259 ret = -ENOMEM;
260 goto disable_clk;
263 if (device_property_read_bool(sysdev, "usb2-lpm-disable"))
264 xhci->quirks |= XHCI_HW_LPM_DISABLE;
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 /* imod_interval is the interrupt moderation value in nanoseconds. */
273 xhci->imod_interval = 40000;
274 device_property_read_u32(sysdev, "imod-interval-ns",
275 &xhci->imod_interval);
277 hcd->usb_phy = devm_usb_get_phy_by_phandle(sysdev, "usb-phy", 0);
278 if (IS_ERR(hcd->usb_phy)) {
279 ret = PTR_ERR(hcd->usb_phy);
280 if (ret == -EPROBE_DEFER)
281 goto put_usb3_hcd;
282 hcd->usb_phy = NULL;
283 } else {
284 ret = usb_phy_init(hcd->usb_phy);
285 if (ret)
286 goto put_usb3_hcd;
289 ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
290 if (ret)
291 goto disable_usb_phy;
293 if (HCC_MAX_PSA(xhci->hcc_params) >= 4)
294 xhci->shared_hcd->can_do_streams = 1;
296 ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
297 if (ret)
298 goto dealloc_usb2_hcd;
300 device_enable_async_suspend(&pdev->dev);
301 pm_runtime_put_noidle(&pdev->dev);
304 * Prevent runtime pm from being on as default, users should enable
305 * runtime pm using power/control in sysfs.
307 pm_runtime_forbid(&pdev->dev);
309 return 0;
312 dealloc_usb2_hcd:
313 usb_remove_hcd(hcd);
315 disable_usb_phy:
316 usb_phy_shutdown(hcd->usb_phy);
318 put_usb3_hcd:
319 usb_put_hcd(xhci->shared_hcd);
321 disable_clk:
322 if (!IS_ERR(clk))
323 clk_disable_unprepare(clk);
325 put_hcd:
326 usb_put_hcd(hcd);
328 disable_runtime:
329 pm_runtime_put_noidle(&pdev->dev);
330 pm_runtime_disable(&pdev->dev);
332 return ret;
335 static int xhci_plat_remove(struct platform_device *dev)
337 struct usb_hcd *hcd = platform_get_drvdata(dev);
338 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
339 struct clk *clk = xhci->clk;
341 xhci->xhc_state |= XHCI_STATE_REMOVING;
343 usb_remove_hcd(xhci->shared_hcd);
344 usb_phy_shutdown(hcd->usb_phy);
346 usb_remove_hcd(hcd);
347 usb_put_hcd(xhci->shared_hcd);
349 if (!IS_ERR(clk))
350 clk_disable_unprepare(clk);
351 usb_put_hcd(hcd);
353 pm_runtime_set_suspended(&dev->dev);
354 pm_runtime_disable(&dev->dev);
356 return 0;
359 static int __maybe_unused xhci_plat_suspend(struct device *dev)
361 struct usb_hcd *hcd = dev_get_drvdata(dev);
362 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
365 * xhci_suspend() needs `do_wakeup` to know whether host is allowed
366 * to do wakeup during suspend. Since xhci_plat_suspend is currently
367 * only designed for system suspend, device_may_wakeup() is enough
368 * to dertermine whether host is allowed to do wakeup. Need to
369 * reconsider this when xhci_plat_suspend enlarges its scope, e.g.,
370 * also applies to runtime suspend.
372 return xhci_suspend(xhci, device_may_wakeup(dev));
375 static int __maybe_unused xhci_plat_resume(struct device *dev)
377 struct usb_hcd *hcd = dev_get_drvdata(dev);
378 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
379 int ret;
381 ret = xhci_priv_resume_quirk(hcd);
382 if (ret)
383 return ret;
385 return xhci_resume(xhci, 0);
388 static int __maybe_unused xhci_plat_runtime_suspend(struct device *dev)
390 struct usb_hcd *hcd = dev_get_drvdata(dev);
391 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
393 return xhci_suspend(xhci, true);
396 static int __maybe_unused xhci_plat_runtime_resume(struct device *dev)
398 struct usb_hcd *hcd = dev_get_drvdata(dev);
399 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
401 return xhci_resume(xhci, 0);
404 static const struct dev_pm_ops xhci_plat_pm_ops = {
405 SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume)
407 SET_RUNTIME_PM_OPS(xhci_plat_runtime_suspend,
408 xhci_plat_runtime_resume,
409 NULL)
412 static const struct acpi_device_id usb_xhci_acpi_match[] = {
413 /* XHCI-compliant USB Controller */
414 { "PNP0D10", },
417 MODULE_DEVICE_TABLE(acpi, usb_xhci_acpi_match);
419 static struct platform_driver usb_xhci_driver = {
420 .probe = xhci_plat_probe,
421 .remove = xhci_plat_remove,
422 .driver = {
423 .name = "xhci-hcd",
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");