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