xref: /linux/drivers/usb/host/xhci-plat.c (revision c5d3cdad688ed75fb311a3a671eb30ba7106d7d3) 
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * xhci-plat.c - xHCI host controller driver platform Bus Glue.
4  *
5  * Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com
6  * Author: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
7  *
8  * A lot of code borrowed from the Linux xHCI driver.
9  */
10 
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>
21 #include <linux/usb/of.h>
22 
23 #include "xhci.h"
24 #include "xhci-plat.h"
25 #include "xhci-mvebu.h"
26 #include "xhci-rcar.h"
27 
28 static struct hc_driver __read_mostly xhci_plat_hc_driver;
29 
30 static int xhci_plat_setup(struct usb_hcd *hcd);
31 static int xhci_plat_start(struct usb_hcd *hcd);
32 
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,
37 };
38 
39 static void xhci_priv_plat_start(struct usb_hcd *hcd)
40 {
41 	struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
42 
43 	if (priv->plat_start)
44 		priv->plat_start(hcd);
45 }
46 
47 static int xhci_priv_init_quirk(struct usb_hcd *hcd)
48 {
49 	struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
50 
51 	if (!priv->init_quirk)
52 		return 0;
53 
54 	return priv->init_quirk(hcd);
55 }
56 
57 static int xhci_priv_resume_quirk(struct usb_hcd *hcd)
58 {
59 	struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
60 
61 	if (!priv->resume_quirk)
62 		return 0;
63 
64 	return priv->resume_quirk(hcd);
65 }
66 
67 static void xhci_plat_quirks(struct device *dev, struct xhci_hcd *xhci)
68 {
69 	struct xhci_plat_priv *priv = xhci_to_priv(xhci);
70 
71 	/*
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
75 	 */
76 	xhci->quirks |= XHCI_PLAT | priv->quirks;
77 }
78 
79 /* called during probe() after chip reset completes */
80 static int xhci_plat_setup(struct usb_hcd *hcd)
81 {
82 	int ret;
83 
84 
85 	ret = xhci_priv_init_quirk(hcd);
86 	if (ret)
87 		return ret;
88 
89 	return xhci_gen_setup(hcd, xhci_plat_quirks);
90 }
91 
92 static int xhci_plat_start(struct usb_hcd *hcd)
93 {
94 	xhci_priv_plat_start(hcd);
95 	return xhci_run(hcd);
96 }
97 
98 #ifdef CONFIG_OF
99 static const struct xhci_plat_priv xhci_plat_marvell_armada = {
100 	.init_quirk = xhci_mvebu_mbus_init_quirk,
101 };
102 
103 static const struct xhci_plat_priv xhci_plat_marvell_armada3700 = {
104 	.init_quirk = xhci_mvebu_a3700_init_quirk,
105 };
106 
107 static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen2 = {
108 	SET_XHCI_PLAT_PRIV_FOR_RCAR(XHCI_RCAR_FIRMWARE_NAME_V1)
109 };
110 
111 static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen3 = {
112 	SET_XHCI_PLAT_PRIV_FOR_RCAR(XHCI_RCAR_FIRMWARE_NAME_V3)
113 };
114 
115 static const struct of_device_id usb_xhci_of_match[] = {
116 	{
117 		.compatible = "generic-xhci",
118 	}, {
119 		.compatible = "xhci-platform",
120 	}, {
121 		.compatible = "marvell,armada-375-xhci",
122 		.data = &xhci_plat_marvell_armada,
123 	}, {
124 		.compatible = "marvell,armada-380-xhci",
125 		.data = &xhci_plat_marvell_armada,
126 	}, {
127 		.compatible = "marvell,armada3700-xhci",
128 		.data = &xhci_plat_marvell_armada3700,
129 	}, {
130 		.compatible = "renesas,xhci-r8a7790",
131 		.data = &xhci_plat_renesas_rcar_gen2,
132 	}, {
133 		.compatible = "renesas,xhci-r8a7791",
134 		.data = &xhci_plat_renesas_rcar_gen2,
135 	}, {
136 		.compatible = "renesas,xhci-r8a7793",
137 		.data = &xhci_plat_renesas_rcar_gen2,
138 	}, {
139 		.compatible = "renesas,xhci-r8a7795",
140 		.data = &xhci_plat_renesas_rcar_gen3,
141 	}, {
142 		.compatible = "renesas,xhci-r8a7796",
143 		.data = &xhci_plat_renesas_rcar_gen3,
144 	}, {
145 		.compatible = "renesas,rcar-gen2-xhci",
146 		.data = &xhci_plat_renesas_rcar_gen2,
147 	}, {
148 		.compatible = "renesas,rcar-gen3-xhci",
149 		.data = &xhci_plat_renesas_rcar_gen3,
150 	},
151 	{},
152 };
153 MODULE_DEVICE_TABLE(of, usb_xhci_of_match);
154 #endif
155 
156 static int xhci_plat_probe(struct platform_device *pdev)
157 {
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;
163 	struct usb_hcd		*hcd;
164 	int			ret;
165 	int			irq;
166 
167 	if (usb_disabled())
168 		return -ENODEV;
169 
170 	driver = &xhci_plat_hc_driver;
171 
172 	irq = platform_get_irq(pdev, 0);
173 	if (irq < 0)
174 		return irq;
175 
176 	/*
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)
182 	 */
183 	for (sysdev = &pdev->dev; sysdev; sysdev = sysdev->parent) {
184 		if (is_of_node(sysdev->fwnode) ||
185 			is_acpi_device_node(sysdev->fwnode))
186 			break;
187 #ifdef CONFIG_PCI
188 		else if (sysdev->bus == &pci_bus_type)
189 			break;
190 #endif
191 	}
192 
193 	if (!sysdev)
194 		sysdev = &pdev->dev;
195 
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,
200 						   DMA_BIT_MASK(64));
201 	else
202 		ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(64));
203 
204 	/* If seting 64-bit DMA mask fails, fall back to 32-bit DMA mask */
205 	if (ret) {
206 		ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(32));
207 		if (ret)
208 			return ret;
209 	}
210 
211 	pm_runtime_set_active(&pdev->dev);
212 	pm_runtime_enable(&pdev->dev);
213 	pm_runtime_get_noresume(&pdev->dev);
214 
215 	hcd = __usb_create_hcd(driver, sysdev, &pdev->dev,
216 			       dev_name(&pdev->dev), NULL);
217 	if (!hcd) {
218 		ret = -ENOMEM;
219 		goto disable_runtime;
220 	}
221 
222 	hcd->regs = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
223 	if (IS_ERR(hcd->regs)) {
224 		ret = PTR_ERR(hcd->regs);
225 		goto put_hcd;
226 	}
227 
228 	hcd->rsrc_start = res->start;
229 	hcd->rsrc_len = resource_size(res);
230 
231 	xhci = hcd_to_xhci(hcd);
232 
233 	/*
234 	 * Not all platforms have clks so it is not an error if the
235 	 * clock do not exist.
236 	 */
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);
240 		goto put_hcd;
241 	}
242 
243 	ret = clk_prepare_enable(xhci->reg_clk);
244 	if (ret)
245 		goto put_hcd;
246 
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;
251 	}
252 
253 	ret = clk_prepare_enable(xhci->clk);
254 	if (ret)
255 		goto disable_reg_clk;
256 
257 	priv_match = of_device_get_match_data(&pdev->dev);
258 	if (priv_match) {
259 		struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
260 
261 		/* Just copy data for now */
262 		if (priv_match)
263 			*priv = *priv_match;
264 	}
265 
266 	device_wakeup_enable(hcd->self.controller);
267 
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) {
272 		ret = -ENOMEM;
273 		goto disable_clk;
274 	}
275 
276 	/* imod_interval is the interrupt moderation value in nanoseconds. */
277 	xhci->imod_interval = 40000;
278 
279 	/* Iterate over all parent nodes for finding quirks */
280 	for (tmpdev = &pdev->dev; tmpdev; tmpdev = tmpdev->parent) {
281 
282 		if (device_property_read_bool(tmpdev, "usb2-lpm-disable"))
283 			xhci->quirks |= XHCI_HW_LPM_DISABLE;
284 
285 		if (device_property_read_bool(tmpdev, "usb3-lpm-capable"))
286 			xhci->quirks |= XHCI_LPM_SUPPORT;
287 
288 		if (device_property_read_bool(tmpdev, "quirk-broken-port-ped"))
289 			xhci->quirks |= XHCI_BROKEN_PORT_PED;
290 
291 		device_property_read_u32(tmpdev, "imod-interval-ns",
292 					 &xhci->imod_interval);
293 	}
294 
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)
299 			goto put_usb3_hcd;
300 		hcd->usb_phy = NULL;
301 	} else {
302 		ret = usb_phy_init(hcd->usb_phy);
303 		if (ret)
304 			goto put_usb3_hcd;
305 	}
306 
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);
310 	if (ret)
311 		goto disable_usb_phy;
312 
313 	if (HCC_MAX_PSA(xhci->hcc_params) >= 4)
314 		xhci->shared_hcd->can_do_streams = 1;
315 
316 	ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
317 	if (ret)
318 		goto dealloc_usb2_hcd;
319 
320 	device_enable_async_suspend(&pdev->dev);
321 	pm_runtime_put_noidle(&pdev->dev);
322 
323 	/*
324 	 * Prevent runtime pm from being on as default, users should enable
325 	 * runtime pm using power/control in sysfs.
326 	 */
327 	pm_runtime_forbid(&pdev->dev);
328 
329 	return 0;
330 
331 
332 dealloc_usb2_hcd:
333 	usb_remove_hcd(hcd);
334 
335 disable_usb_phy:
336 	usb_phy_shutdown(hcd->usb_phy);
337 
338 put_usb3_hcd:
339 	usb_put_hcd(xhci->shared_hcd);
340 
341 disable_clk:
342 	clk_disable_unprepare(xhci->clk);
343 
344 disable_reg_clk:
345 	clk_disable_unprepare(xhci->reg_clk);
346 
347 put_hcd:
348 	usb_put_hcd(hcd);
349 
350 disable_runtime:
351 	pm_runtime_put_noidle(&pdev->dev);
352 	pm_runtime_disable(&pdev->dev);
353 
354 	return ret;
355 }
356 
357 static int xhci_plat_remove(struct platform_device *dev)
358 {
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;
364 
365 	xhci->xhc_state |= XHCI_STATE_REMOVING;
366 
367 	usb_remove_hcd(shared_hcd);
368 	xhci->shared_hcd = NULL;
369 	usb_phy_shutdown(hcd->usb_phy);
370 
371 	usb_remove_hcd(hcd);
372 	usb_put_hcd(shared_hcd);
373 
374 	clk_disable_unprepare(clk);
375 	clk_disable_unprepare(reg_clk);
376 	usb_put_hcd(hcd);
377 
378 	pm_runtime_set_suspended(&dev->dev);
379 	pm_runtime_disable(&dev->dev);
380 
381 	return 0;
382 }
383 
384 static int __maybe_unused xhci_plat_suspend(struct device *dev)
385 {
386 	struct usb_hcd	*hcd = dev_get_drvdata(dev);
387 	struct xhci_hcd	*xhci = hcd_to_xhci(hcd);
388 
389 	/*
390 	 * xhci_suspend() needs `do_wakeup` to know whether host is allowed
391 	 * to do wakeup during suspend. Since xhci_plat_suspend is currently
392 	 * only designed for system suspend, device_may_wakeup() is enough
393 	 * to dertermine whether host is allowed to do wakeup. Need to
394 	 * reconsider this when xhci_plat_suspend enlarges its scope, e.g.,
395 	 * also applies to runtime suspend.
396 	 */
397 	return xhci_suspend(xhci, device_may_wakeup(dev));
398 }
399 
400 static int __maybe_unused xhci_plat_resume(struct device *dev)
401 {
402 	struct usb_hcd	*hcd = dev_get_drvdata(dev);
403 	struct xhci_hcd	*xhci = hcd_to_xhci(hcd);
404 	int ret;
405 
406 	ret = xhci_priv_resume_quirk(hcd);
407 	if (ret)
408 		return ret;
409 
410 	return xhci_resume(xhci, 0);
411 }
412 
413 static int __maybe_unused xhci_plat_runtime_suspend(struct device *dev)
414 {
415 	struct usb_hcd  *hcd = dev_get_drvdata(dev);
416 	struct xhci_hcd *xhci = hcd_to_xhci(hcd);
417 
418 	return xhci_suspend(xhci, true);
419 }
420 
421 static int __maybe_unused xhci_plat_runtime_resume(struct device *dev)
422 {
423 	struct usb_hcd  *hcd = dev_get_drvdata(dev);
424 	struct xhci_hcd *xhci = hcd_to_xhci(hcd);
425 
426 	return xhci_resume(xhci, 0);
427 }
428 
429 static const struct dev_pm_ops xhci_plat_pm_ops = {
430 	SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume)
431 
432 	SET_RUNTIME_PM_OPS(xhci_plat_runtime_suspend,
433 			   xhci_plat_runtime_resume,
434 			   NULL)
435 };
436 
437 static const struct acpi_device_id usb_xhci_acpi_match[] = {
438 	/* XHCI-compliant USB Controller */
439 	{ "PNP0D10", },
440 	{ }
441 };
442 MODULE_DEVICE_TABLE(acpi, usb_xhci_acpi_match);
443 
444 static struct platform_driver usb_xhci_driver = {
445 	.probe	= xhci_plat_probe,
446 	.remove	= xhci_plat_remove,
447 	.shutdown = usb_hcd_platform_shutdown,
448 	.driver	= {
449 		.name = "xhci-hcd",
450 		.pm = &xhci_plat_pm_ops,
451 		.of_match_table = of_match_ptr(usb_xhci_of_match),
452 		.acpi_match_table = ACPI_PTR(usb_xhci_acpi_match),
453 	},
454 };
455 MODULE_ALIAS("platform:xhci-hcd");
456 
457 static int __init xhci_plat_init(void)
458 {
459 	xhci_init_driver(&xhci_plat_hc_driver, &xhci_plat_overrides);
460 	return platform_driver_register(&usb_xhci_driver);
461 }
462 module_init(xhci_plat_init);
463 
464 static void __exit xhci_plat_exit(void)
465 {
466 	platform_driver_unregister(&usb_xhci_driver);
467 }
468 module_exit(xhci_plat_exit);
469 
470 MODULE_DESCRIPTION("xHCI Platform Host Controller Driver");
471 MODULE_LICENSE("GPL");
472