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 - https://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 
xhci_priv_plat_start(struct usb_hcd * hcd)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 
xhci_priv_init_quirk(struct usb_hcd * hcd)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 
xhci_priv_suspend_quirk(struct usb_hcd * hcd)57 static int xhci_priv_suspend_quirk(struct usb_hcd *hcd)
58 {
59 	struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
60 
61 	if (!priv->suspend_quirk)
62 		return 0;
63 
64 	return priv->suspend_quirk(hcd);
65 }
66 
xhci_priv_resume_quirk(struct usb_hcd * hcd)67 static int xhci_priv_resume_quirk(struct usb_hcd *hcd)
68 {
69 	struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
70 
71 	if (!priv->resume_quirk)
72 		return 0;
73 
74 	return priv->resume_quirk(hcd);
75 }
76 
xhci_plat_quirks(struct device * dev,struct xhci_hcd * xhci)77 static void xhci_plat_quirks(struct device *dev, struct xhci_hcd *xhci)
78 {
79 	struct xhci_plat_priv *priv = xhci_to_priv(xhci);
80 
81 	/*
82 	 * As of now platform drivers don't provide MSI support so we ensure
83 	 * here that the generic code does not try to make a pci_dev from our
84 	 * dev struct in order to setup MSI
85 	 */
86 	xhci->quirks |= XHCI_PLAT | priv->quirks;
87 }
88 
89 /* called during probe() after chip reset completes */
xhci_plat_setup(struct usb_hcd * hcd)90 static int xhci_plat_setup(struct usb_hcd *hcd)
91 {
92 	int ret;
93 
94 
95 	ret = xhci_priv_init_quirk(hcd);
96 	if (ret)
97 		return ret;
98 
99 	return xhci_gen_setup(hcd, xhci_plat_quirks);
100 }
101 
xhci_plat_start(struct usb_hcd * hcd)102 static int xhci_plat_start(struct usb_hcd *hcd)
103 {
104 	xhci_priv_plat_start(hcd);
105 	return xhci_run(hcd);
106 }
107 
108 #ifdef CONFIG_OF
109 static const struct xhci_plat_priv xhci_plat_marvell_armada = {
110 	.init_quirk = xhci_mvebu_mbus_init_quirk,
111 };
112 
113 static const struct xhci_plat_priv xhci_plat_marvell_armada3700 = {
114 	.init_quirk = xhci_mvebu_a3700_init_quirk,
115 };
116 
117 static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen2 = {
118 	SET_XHCI_PLAT_PRIV_FOR_RCAR(XHCI_RCAR_FIRMWARE_NAME_V1)
119 };
120 
121 static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen3 = {
122 	SET_XHCI_PLAT_PRIV_FOR_RCAR(XHCI_RCAR_FIRMWARE_NAME_V3)
123 };
124 
125 static const struct xhci_plat_priv xhci_plat_brcm = {
126 	.quirks = XHCI_RESET_ON_RESUME,
127 };
128 
129 static const struct of_device_id usb_xhci_of_match[] = {
130 	{
131 		.compatible = "generic-xhci",
132 	}, {
133 		.compatible = "xhci-platform",
134 	}, {
135 		.compatible = "marvell,armada-375-xhci",
136 		.data = &xhci_plat_marvell_armada,
137 	}, {
138 		.compatible = "marvell,armada-380-xhci",
139 		.data = &xhci_plat_marvell_armada,
140 	}, {
141 		.compatible = "marvell,armada3700-xhci",
142 		.data = &xhci_plat_marvell_armada3700,
143 	}, {
144 		.compatible = "renesas,xhci-r8a7790",
145 		.data = &xhci_plat_renesas_rcar_gen2,
146 	}, {
147 		.compatible = "renesas,xhci-r8a7791",
148 		.data = &xhci_plat_renesas_rcar_gen2,
149 	}, {
150 		.compatible = "renesas,xhci-r8a7793",
151 		.data = &xhci_plat_renesas_rcar_gen2,
152 	}, {
153 		.compatible = "renesas,xhci-r8a7795",
154 		.data = &xhci_plat_renesas_rcar_gen3,
155 	}, {
156 		.compatible = "renesas,xhci-r8a7796",
157 		.data = &xhci_plat_renesas_rcar_gen3,
158 	}, {
159 		.compatible = "renesas,rcar-gen2-xhci",
160 		.data = &xhci_plat_renesas_rcar_gen2,
161 	}, {
162 		.compatible = "renesas,rcar-gen3-xhci",
163 		.data = &xhci_plat_renesas_rcar_gen3,
164 	}, {
165 		.compatible = "brcm,xhci-brcm-v2",
166 		.data = &xhci_plat_brcm,
167 	}, {
168 		.compatible = "brcm,bcm7445-xhci",
169 		.data = &xhci_plat_brcm,
170 	},
171 	{},
172 };
173 MODULE_DEVICE_TABLE(of, usb_xhci_of_match);
174 #endif
175 
xhci_plat_probe(struct platform_device * pdev)176 static int xhci_plat_probe(struct platform_device *pdev)
177 {
178 	const struct xhci_plat_priv *priv_match;
179 	const struct hc_driver	*driver;
180 	struct device		*sysdev, *tmpdev;
181 	struct xhci_hcd		*xhci;
182 	struct resource         *res;
183 	struct usb_hcd		*hcd;
184 	int			ret;
185 	int			irq;
186 	struct xhci_plat_priv	*priv = NULL;
187 
188 
189 	if (usb_disabled())
190 		return -ENODEV;
191 
192 	driver = &xhci_plat_hc_driver;
193 
194 	irq = platform_get_irq(pdev, 0);
195 	if (irq < 0)
196 		return irq;
197 
198 	/*
199 	 * sysdev must point to a device that is known to the system firmware
200 	 * or PCI hardware. We handle these three cases here:
201 	 * 1. xhci_plat comes from firmware
202 	 * 2. xhci_plat is child of a device from firmware (dwc3-plat)
203 	 * 3. xhci_plat is grandchild of a pci device (dwc3-pci)
204 	 */
205 	for (sysdev = &pdev->dev; sysdev; sysdev = sysdev->parent) {
206 		if (is_of_node(sysdev->fwnode) ||
207 			is_acpi_device_node(sysdev->fwnode))
208 			break;
209 #ifdef CONFIG_PCI
210 		else if (sysdev->bus == &pci_bus_type)
211 			break;
212 #endif
213 	}
214 
215 	if (!sysdev)
216 		sysdev = &pdev->dev;
217 
218 	/* Try to set 64-bit DMA first */
219 	if (WARN_ON(!sysdev->dma_mask))
220 		/* Platform did not initialize dma_mask */
221 		ret = dma_coerce_mask_and_coherent(sysdev,
222 						   DMA_BIT_MASK(64));
223 	else
224 		ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(64));
225 
226 	/* If seting 64-bit DMA mask fails, fall back to 32-bit DMA mask */
227 	if (ret) {
228 		ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(32));
229 		if (ret)
230 			return ret;
231 	}
232 
233 	pm_runtime_set_active(&pdev->dev);
234 	pm_runtime_enable(&pdev->dev);
235 	pm_runtime_get_noresume(&pdev->dev);
236 
237 	hcd = __usb_create_hcd(driver, sysdev, &pdev->dev,
238 			       dev_name(&pdev->dev), NULL);
239 	if (!hcd) {
240 		ret = -ENOMEM;
241 		goto disable_runtime;
242 	}
243 
244 	hcd->regs = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
245 	if (IS_ERR(hcd->regs)) {
246 		ret = PTR_ERR(hcd->regs);
247 		goto put_hcd;
248 	}
249 
250 	hcd->rsrc_start = res->start;
251 	hcd->rsrc_len = resource_size(res);
252 
253 	xhci = hcd_to_xhci(hcd);
254 
255 	/*
256 	 * Not all platforms have clks so it is not an error if the
257 	 * clock do not exist.
258 	 */
259 	xhci->reg_clk = devm_clk_get_optional(&pdev->dev, "reg");
260 	if (IS_ERR(xhci->reg_clk)) {
261 		ret = PTR_ERR(xhci->reg_clk);
262 		goto put_hcd;
263 	}
264 
265 	ret = clk_prepare_enable(xhci->reg_clk);
266 	if (ret)
267 		goto put_hcd;
268 
269 	xhci->clk = devm_clk_get_optional(&pdev->dev, NULL);
270 	if (IS_ERR(xhci->clk)) {
271 		ret = PTR_ERR(xhci->clk);
272 		goto disable_reg_clk;
273 	}
274 
275 	ret = clk_prepare_enable(xhci->clk);
276 	if (ret)
277 		goto disable_reg_clk;
278 
279 	if (pdev->dev.of_node)
280 		priv_match = of_device_get_match_data(&pdev->dev);
281 	else
282 		priv_match = dev_get_platdata(&pdev->dev);
283 
284 	if (priv_match) {
285 		priv = hcd_to_xhci_priv(hcd);
286 		/* Just copy data for now */
287 		*priv = *priv_match;
288 	}
289 
290 	device_set_wakeup_capable(&pdev->dev, true);
291 
292 	xhci->main_hcd = hcd;
293 	xhci->shared_hcd = __usb_create_hcd(driver, sysdev, &pdev->dev,
294 			dev_name(&pdev->dev), hcd);
295 	if (!xhci->shared_hcd) {
296 		ret = -ENOMEM;
297 		goto disable_clk;
298 	}
299 
300 	/* imod_interval is the interrupt moderation value in nanoseconds. */
301 	xhci->imod_interval = 40000;
302 
303 	/* Iterate over all parent nodes for finding quirks */
304 	for (tmpdev = &pdev->dev; tmpdev; tmpdev = tmpdev->parent) {
305 
306 		if (device_property_read_bool(tmpdev, "usb2-lpm-disable"))
307 			xhci->quirks |= XHCI_HW_LPM_DISABLE;
308 
309 		if (device_property_read_bool(tmpdev, "usb3-lpm-capable"))
310 			xhci->quirks |= XHCI_LPM_SUPPORT;
311 
312 		if (device_property_read_bool(tmpdev, "quirk-broken-port-ped"))
313 			xhci->quirks |= XHCI_BROKEN_PORT_PED;
314 
315 		device_property_read_u32(tmpdev, "imod-interval-ns",
316 					 &xhci->imod_interval);
317 	}
318 
319 	hcd->usb_phy = devm_usb_get_phy_by_phandle(sysdev, "usb-phy", 0);
320 	if (IS_ERR(hcd->usb_phy)) {
321 		ret = PTR_ERR(hcd->usb_phy);
322 		if (ret == -EPROBE_DEFER)
323 			goto put_usb3_hcd;
324 		hcd->usb_phy = NULL;
325 	} else {
326 		ret = usb_phy_init(hcd->usb_phy);
327 		if (ret)
328 			goto put_usb3_hcd;
329 	}
330 
331 	hcd->tpl_support = of_usb_host_tpl_support(sysdev->of_node);
332 	xhci->shared_hcd->tpl_support = hcd->tpl_support;
333 	if (priv && (priv->quirks & XHCI_SKIP_PHY_INIT))
334 		hcd->skip_phy_initialization = 1;
335 
336 	ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
337 	if (ret)
338 		goto disable_usb_phy;
339 
340 	if (HCC_MAX_PSA(xhci->hcc_params) >= 4)
341 		xhci->shared_hcd->can_do_streams = 1;
342 
343 	ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
344 	if (ret)
345 		goto dealloc_usb2_hcd;
346 
347 	device_enable_async_suspend(&pdev->dev);
348 	pm_runtime_put_noidle(&pdev->dev);
349 
350 	/*
351 	 * Prevent runtime pm from being on as default, users should enable
352 	 * runtime pm using power/control in sysfs.
353 	 */
354 	pm_runtime_forbid(&pdev->dev);
355 
356 	return 0;
357 
358 
359 dealloc_usb2_hcd:
360 	usb_remove_hcd(hcd);
361 
362 disable_usb_phy:
363 	usb_phy_shutdown(hcd->usb_phy);
364 
365 put_usb3_hcd:
366 	usb_put_hcd(xhci->shared_hcd);
367 
368 disable_clk:
369 	clk_disable_unprepare(xhci->clk);
370 
371 disable_reg_clk:
372 	clk_disable_unprepare(xhci->reg_clk);
373 
374 put_hcd:
375 	usb_put_hcd(hcd);
376 
377 disable_runtime:
378 	pm_runtime_put_noidle(&pdev->dev);
379 	pm_runtime_disable(&pdev->dev);
380 
381 	return ret;
382 }
383 
xhci_plat_remove(struct platform_device * dev)384 static int xhci_plat_remove(struct platform_device *dev)
385 {
386 	struct usb_hcd	*hcd = platform_get_drvdata(dev);
387 	struct xhci_hcd	*xhci = hcd_to_xhci(hcd);
388 	struct clk *clk = xhci->clk;
389 	struct clk *reg_clk = xhci->reg_clk;
390 	struct usb_hcd *shared_hcd = xhci->shared_hcd;
391 
392 	pm_runtime_get_sync(&dev->dev);
393 	xhci->xhc_state |= XHCI_STATE_REMOVING;
394 
395 	usb_remove_hcd(shared_hcd);
396 	xhci->shared_hcd = NULL;
397 	usb_phy_shutdown(hcd->usb_phy);
398 
399 	usb_remove_hcd(hcd);
400 	usb_put_hcd(shared_hcd);
401 
402 	clk_disable_unprepare(clk);
403 	clk_disable_unprepare(reg_clk);
404 	usb_put_hcd(hcd);
405 
406 	pm_runtime_disable(&dev->dev);
407 	pm_runtime_put_noidle(&dev->dev);
408 	pm_runtime_set_suspended(&dev->dev);
409 
410 	return 0;
411 }
412 
xhci_plat_suspend(struct device * dev)413 static int __maybe_unused xhci_plat_suspend(struct device *dev)
414 {
415 	struct usb_hcd	*hcd = dev_get_drvdata(dev);
416 	struct xhci_hcd	*xhci = hcd_to_xhci(hcd);
417 	int ret;
418 
419 	ret = xhci_priv_suspend_quirk(hcd);
420 	if (ret)
421 		return ret;
422 	/*
423 	 * xhci_suspend() needs `do_wakeup` to know whether host is allowed
424 	 * to do wakeup during suspend.
425 	 */
426 	return xhci_suspend(xhci, device_may_wakeup(dev));
427 }
428 
xhci_plat_resume(struct device * dev)429 static int __maybe_unused xhci_plat_resume(struct device *dev)
430 {
431 	struct usb_hcd	*hcd = dev_get_drvdata(dev);
432 	struct xhci_hcd	*xhci = hcd_to_xhci(hcd);
433 	int ret;
434 
435 	ret = xhci_priv_resume_quirk(hcd);
436 	if (ret)
437 		return ret;
438 
439 	ret = xhci_resume(xhci, 0);
440 	if (ret)
441 		return ret;
442 
443 	pm_runtime_disable(dev);
444 	pm_runtime_set_active(dev);
445 	pm_runtime_enable(dev);
446 
447 	return 0;
448 }
449 
xhci_plat_runtime_suspend(struct device * dev)450 static int __maybe_unused xhci_plat_runtime_suspend(struct device *dev)
451 {
452 	struct usb_hcd  *hcd = dev_get_drvdata(dev);
453 	struct xhci_hcd *xhci = hcd_to_xhci(hcd);
454 	int ret;
455 
456 	ret = xhci_priv_suspend_quirk(hcd);
457 	if (ret)
458 		return ret;
459 
460 	return xhci_suspend(xhci, true);
461 }
462 
xhci_plat_runtime_resume(struct device * dev)463 static int __maybe_unused xhci_plat_runtime_resume(struct device *dev)
464 {
465 	struct usb_hcd  *hcd = dev_get_drvdata(dev);
466 	struct xhci_hcd *xhci = hcd_to_xhci(hcd);
467 
468 	return xhci_resume(xhci, 0);
469 }
470 
471 static const struct dev_pm_ops xhci_plat_pm_ops = {
472 	SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume)
473 
474 	SET_RUNTIME_PM_OPS(xhci_plat_runtime_suspend,
475 			   xhci_plat_runtime_resume,
476 			   NULL)
477 };
478 
479 #ifdef CONFIG_ACPI
480 static const struct acpi_device_id usb_xhci_acpi_match[] = {
481 	/* XHCI-compliant USB Controller */
482 	{ "PNP0D10", },
483 	{ }
484 };
485 MODULE_DEVICE_TABLE(acpi, usb_xhci_acpi_match);
486 #endif
487 
488 static struct platform_driver usb_xhci_driver = {
489 	.probe	= xhci_plat_probe,
490 	.remove	= xhci_plat_remove,
491 	.shutdown = usb_hcd_platform_shutdown,
492 	.driver	= {
493 		.name = "xhci-hcd",
494 		.pm = &xhci_plat_pm_ops,
495 		.of_match_table = of_match_ptr(usb_xhci_of_match),
496 		.acpi_match_table = ACPI_PTR(usb_xhci_acpi_match),
497 	},
498 };
499 MODULE_ALIAS("platform:xhci-hcd");
500 
xhci_plat_init(void)501 static int __init xhci_plat_init(void)
502 {
503 	xhci_init_driver(&xhci_plat_hc_driver, &xhci_plat_overrides);
504 	return platform_driver_register(&usb_xhci_driver);
505 }
506 module_init(xhci_plat_init);
507 
xhci_plat_exit(void)508 static void __exit xhci_plat_exit(void)
509 {
510 	platform_driver_unregister(&usb_xhci_driver);
511 }
512 module_exit(xhci_plat_exit);
513 
514 MODULE_DESCRIPTION("xHCI Platform Host Controller Driver");
515 MODULE_LICENSE("GPL");
516