[linux-block.git] / drivers / usb / host / xhci-plat.c

// SPDX-License-Identifier: GPL-2.0
/*
 * xhci-plat.c - xHCI host controller driver platform Bus Glue.
 *
 * Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com
 * Author: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
 *
 * A lot of code borrowed from the Linux xHCI driver.
 */

#include <linux/clk.h>
#include <linux/dma-mapping.h>
#include <linux/module.h>
#include <linux/pci.h>
#include <linux/of.h>
#include <linux/of_device.h>
#include <linux/platform_device.h>
#include <linux/usb/phy.h>
#include <linux/slab.h>
#include <linux/acpi.h>
#include <linux/usb/of.h>

#include "xhci.h"
#include "xhci-plat.h"
#include "xhci-mvebu.h"
#include "xhci-rcar.h"

static struct hc_driver __read_mostly xhci_plat_hc_driver;

static int xhci_plat_setup(struct usb_hcd *hcd);
static int xhci_plat_start(struct usb_hcd *hcd);

static const struct xhci_driver_overrides xhci_plat_overrides __initconst = {
	.extra_priv_size = sizeof(struct xhci_plat_priv),
	.reset = xhci_plat_setup,
	.start = xhci_plat_start,
};

static void xhci_priv_plat_start(struct usb_hcd *hcd)
{
	struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);

	if (priv->plat_start)
		priv->plat_start(hcd);
}

static int xhci_priv_init_quirk(struct usb_hcd *hcd)
{
	struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);

	if (!priv->init_quirk)
		return 0;

	return priv->init_quirk(hcd);
}

static int xhci_priv_resume_quirk(struct usb_hcd *hcd)
{
	struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);

	if (!priv->resume_quirk)
		return 0;

	return priv->resume_quirk(hcd);
}

static void xhci_plat_quirks(struct device *dev, struct xhci_hcd *xhci)
{
	struct xhci_plat_priv *priv = xhci_to_priv(xhci);

	/*
	 * As of now platform drivers don't provide MSI support so we ensure
	 * here that the generic code does not try to make a pci_dev from our
	 * dev struct in order to setup MSI
	 */
	xhci->quirks |= XHCI_PLAT | priv->quirks;
}

/* called during probe() after chip reset completes */
static int xhci_plat_setup(struct usb_hcd *hcd)
{
	int ret;


	ret = xhci_priv_init_quirk(hcd);
	if (ret)
		return ret;

	return xhci_gen_setup(hcd, xhci_plat_quirks);
}

static int xhci_plat_start(struct usb_hcd *hcd)
{
	xhci_priv_plat_start(hcd);
	return xhci_run(hcd);
}

#ifdef CONFIG_OF
static const struct xhci_plat_priv xhci_plat_marvell_armada = {
	.init_quirk = xhci_mvebu_mbus_init_quirk,
};

static const struct xhci_plat_priv xhci_plat_marvell_armada3700 = {
	.init_quirk = xhci_mvebu_a3700_init_quirk,
};

static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen2 = {
	SET_XHCI_PLAT_PRIV_FOR_RCAR(XHCI_RCAR_FIRMWARE_NAME_V1)
};

static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen3 = {
	SET_XHCI_PLAT_PRIV_FOR_RCAR(XHCI_RCAR_FIRMWARE_NAME_V3)
};

static const struct of_device_id usb_xhci_of_match[] = {
	{
		.compatible = "generic-xhci",
	}, {
		.compatible = "xhci-platform",
	}, {
		.compatible = "marvell,armada-375-xhci",
		.data = &xhci_plat_marvell_armada,
	}, {
		.compatible = "marvell,armada-380-xhci",
		.data = &xhci_plat_marvell_armada,
	}, {
		.compatible = "marvell,armada3700-xhci",
		.data = &xhci_plat_marvell_armada3700,
	}, {
		.compatible = "renesas,xhci-r8a7790",
		.data = &xhci_plat_renesas_rcar_gen2,
	}, {
		.compatible = "renesas,xhci-r8a7791",
		.data = &xhci_plat_renesas_rcar_gen2,
	}, {
		.compatible = "renesas,xhci-r8a7793",
		.data = &xhci_plat_renesas_rcar_gen2,
	}, {
		.compatible = "renesas,xhci-r8a7795",
		.data = &xhci_plat_renesas_rcar_gen3,
	}, {
		.compatible = "renesas,xhci-r8a7796",
		.data = &xhci_plat_renesas_rcar_gen3,
	}, {
		.compatible = "renesas,rcar-gen2-xhci",
		.data = &xhci_plat_renesas_rcar_gen2,
	}, {
		.compatible = "renesas,rcar-gen3-xhci",
		.data = &xhci_plat_renesas_rcar_gen3,
	},
	{},
};
MODULE_DEVICE_TABLE(of, usb_xhci_of_match);
#endif

static int xhci_plat_probe(struct platform_device *pdev)
{
	const struct xhci_plat_priv *priv_match;
	const struct hc_driver	*driver;
	struct device		*sysdev, *tmpdev;
	struct xhci_hcd		*xhci;
	struct resource         *res;
	struct usb_hcd		*hcd;
	int			ret;
	int			irq;

	if (usb_disabled())
		return -ENODEV;

	driver = &xhci_plat_hc_driver;

	irq = platform_get_irq(pdev, 0);
	if (irq < 0)
		return irq;

	/*
	 * sysdev must point to a device that is known to the system firmware
	 * or PCI hardware. We handle these three cases here:
	 * 1. xhci_plat comes from firmware
	 * 2. xhci_plat is child of a device from firmware (dwc3-plat)
	 * 3. xhci_plat is grandchild of a pci device (dwc3-pci)
	 */
	for (sysdev = &pdev->dev; sysdev; sysdev = sysdev->parent) {
		if (is_of_node(sysdev->fwnode) ||
			is_acpi_device_node(sysdev->fwnode))
			break;
#ifdef CONFIG_PCI
		else if (sysdev->bus == &pci_bus_type)
			break;
#endif
	}

	if (!sysdev)
		sysdev = &pdev->dev;

	/* Try to set 64-bit DMA first */
	if (WARN_ON(!sysdev->dma_mask))
		/* Platform did not initialize dma_mask */
		ret = dma_coerce_mask_and_coherent(sysdev,
						   DMA_BIT_MASK(64));
	else
		ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(64));

	/* If seting 64-bit DMA mask fails, fall back to 32-bit DMA mask */
	if (ret) {
		ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(32));
		if (ret)
			return ret;
	}

	pm_runtime_set_active(&pdev->dev);
	pm_runtime_enable(&pdev->dev);
	pm_runtime_get_noresume(&pdev->dev);

	hcd = __usb_create_hcd(driver, sysdev, &pdev->dev,
			       dev_name(&pdev->dev), NULL);
	if (!hcd) {
		ret = -ENOMEM;
		goto disable_runtime;
	}

	hcd->regs = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
	if (IS_ERR(hcd->regs)) {
		ret = PTR_ERR(hcd->regs);
		goto put_hcd;
	}

	hcd->rsrc_start = res->start;
	hcd->rsrc_len = resource_size(res);

	xhci = hcd_to_xhci(hcd);

	/*
	 * Not all platforms have clks so it is not an error if the
	 * clock do not exist.
	 */
	xhci->reg_clk = devm_clk_get_optional(&pdev->dev, "reg");
	if (IS_ERR(xhci->reg_clk)) {
		ret = PTR_ERR(xhci->reg_clk);
		goto put_hcd;
	}

	ret = clk_prepare_enable(xhci->reg_clk);
	if (ret)
		goto put_hcd;

	xhci->clk = devm_clk_get_optional(&pdev->dev, NULL);
	if (IS_ERR(xhci->clk)) {
		ret = PTR_ERR(xhci->clk);
		goto disable_reg_clk;
	}

	ret = clk_prepare_enable(xhci->clk);
	if (ret)
		goto disable_reg_clk;

	priv_match = of_device_get_match_data(&pdev->dev);
	if (priv_match) {
		struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);

		/* Just copy data for now */
		if (priv_match)
			*priv = *priv_match;
	}

	device_wakeup_enable(hcd->self.controller);

	xhci->main_hcd = hcd;
	xhci->shared_hcd = __usb_create_hcd(driver, sysdev, &pdev->dev,
			dev_name(&pdev->dev), hcd);
	if (!xhci->shared_hcd) {
		ret = -ENOMEM;
		goto disable_clk;
	}

	/* imod_interval is the interrupt moderation value in nanoseconds. */
	xhci->imod_interval = 40000;

	/* Iterate over all parent nodes for finding quirks */
	for (tmpdev = &pdev->dev; tmpdev; tmpdev = tmpdev->parent) {

		if (device_property_read_bool(tmpdev, "usb2-lpm-disable"))
			xhci->quirks |= XHCI_HW_LPM_DISABLE;

		if (device_property_read_bool(tmpdev, "usb3-lpm-capable"))
			xhci->quirks |= XHCI_LPM_SUPPORT;

		if (device_property_read_bool(tmpdev, "quirk-broken-port-ped"))
			xhci->quirks |= XHCI_BROKEN_PORT_PED;

		device_property_read_u32(tmpdev, "imod-interval-ns",
					 &xhci->imod_interval);
	}

	hcd->usb_phy = devm_usb_get_phy_by_phandle(sysdev, "usb-phy", 0);
	if (IS_ERR(hcd->usb_phy)) {
		ret = PTR_ERR(hcd->usb_phy);
		if (ret == -EPROBE_DEFER)
			goto put_usb3_hcd;
		hcd->usb_phy = NULL;
	} else {
		ret = usb_phy_init(hcd->usb_phy);
		if (ret)
			goto put_usb3_hcd;
	}

	hcd->tpl_support = of_usb_host_tpl_support(sysdev->of_node);
	xhci->shared_hcd->tpl_support = hcd->tpl_support;
	ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
	if (ret)
		goto disable_usb_phy;

	if (HCC_MAX_PSA(xhci->hcc_params) >= 4)
		xhci->shared_hcd->can_do_streams = 1;

	ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
	if (ret)
		goto dealloc_usb2_hcd;

	device_enable_async_suspend(&pdev->dev);
	pm_runtime_put_noidle(&pdev->dev);

	/*
	 * Prevent runtime pm from being on as default, users should enable
	 * runtime pm using power/control in sysfs.
	 */
	pm_runtime_forbid(&pdev->dev);

	return 0;


dealloc_usb2_hcd:
	usb_remove_hcd(hcd);

disable_usb_phy:
	usb_phy_shutdown(hcd->usb_phy);

put_usb3_hcd:
	usb_put_hcd(xhci->shared_hcd);

disable_clk:
	clk_disable_unprepare(xhci->clk);

disable_reg_clk:
	clk_disable_unprepare(xhci->reg_clk);

put_hcd:
	usb_put_hcd(hcd);

disable_runtime:
	pm_runtime_put_noidle(&pdev->dev);
	pm_runtime_disable(&pdev->dev);

	return ret;
}

static int xhci_plat_remove(struct platform_device *dev)
{
	struct usb_hcd	*hcd = platform_get_drvdata(dev);
	struct xhci_hcd	*xhci = hcd_to_xhci(hcd);
	struct clk *clk = xhci->clk;
	struct clk *reg_clk = xhci->reg_clk;
	struct usb_hcd *shared_hcd = xhci->shared_hcd;

	xhci->xhc_state |= XHCI_STATE_REMOVING;

	usb_remove_hcd(shared_hcd);
	xhci->shared_hcd = NULL;
	usb_phy_shutdown(hcd->usb_phy);

	usb_remove_hcd(hcd);
	usb_put_hcd(shared_hcd);

	clk_disable_unprepare(clk);
	clk_disable_unprepare(reg_clk);
	usb_put_hcd(hcd);

	pm_runtime_set_suspended(&dev->dev);
	pm_runtime_disable(&dev->dev);

	return 0;
}

static int __maybe_unused xhci_plat_suspend(struct device *dev)
{
	struct usb_hcd	*hcd = dev_get_drvdata(dev);
	struct xhci_hcd	*xhci = hcd_to_xhci(hcd);

	/*
	 * xhci_suspend() needs `do_wakeup` to know whether host is allowed
	 * to do wakeup during suspend. Since xhci_plat_suspend is currently
	 * only designed for system suspend, device_may_wakeup() is enough
	 * to dertermine whether host is allowed to do wakeup. Need to
	 * reconsider this when xhci_plat_suspend enlarges its scope, e.g.,
	 * also applies to runtime suspend.
	 */
	return xhci_suspend(xhci, device_may_wakeup(dev));
}

static int __maybe_unused xhci_plat_resume(struct device *dev)
{
	struct usb_hcd	*hcd = dev_get_drvdata(dev);
	struct xhci_hcd	*xhci = hcd_to_xhci(hcd);
	int ret;

	ret = xhci_priv_resume_quirk(hcd);
	if (ret)
		return ret;

	return xhci_resume(xhci, 0);
}

static int __maybe_unused xhci_plat_runtime_suspend(struct device *dev)
{
	struct usb_hcd  *hcd = dev_get_drvdata(dev);
	struct xhci_hcd *xhci = hcd_to_xhci(hcd);

	return xhci_suspend(xhci, true);
}

static int __maybe_unused xhci_plat_runtime_resume(struct device *dev)
{
	struct usb_hcd  *hcd = dev_get_drvdata(dev);
	struct xhci_hcd *xhci = hcd_to_xhci(hcd);

	return xhci_resume(xhci, 0);
}

static const struct dev_pm_ops xhci_plat_pm_ops = {
	SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume)

	SET_RUNTIME_PM_OPS(xhci_plat_runtime_suspend,
			   xhci_plat_runtime_resume,
			   NULL)
};

static const struct acpi_device_id usb_xhci_acpi_match[] = {
	/* XHCI-compliant USB Controller */
	{ "PNP0D10", },
	{ }
};
MODULE_DEVICE_TABLE(acpi, usb_xhci_acpi_match);

static struct platform_driver usb_xhci_driver = {
	.probe	= xhci_plat_probe,
	.remove	= xhci_plat_remove,
	.shutdown = usb_hcd_platform_shutdown,
	.driver	= {
		.name = "xhci-hcd",
		.pm = &xhci_plat_pm_ops,
		.of_match_table = of_match_ptr(usb_xhci_of_match),
		.acpi_match_table = ACPI_PTR(usb_xhci_acpi_match),
	},
};
MODULE_ALIAS("platform:xhci-hcd");

static int __init xhci_plat_init(void)
{
	xhci_init_driver(&xhci_plat_hc_driver, &xhci_plat_overrides);
	return platform_driver_register(&usb_xhci_driver);
}
module_init(xhci_plat_init);

static void __exit xhci_plat_exit(void)
{
	platform_driver_unregister(&usb_xhci_driver);
}
module_exit(xhci_plat_exit);

MODULE_DESCRIPTION("xHCI Platform Host Controller Driver");
MODULE_LICENSE("GPL");
Commit	Line	Data
5fd54ace	1	// SPDX-License-Identifier: GPL-2.0
3429e91a SAS	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.
3429e91a SAS	9	*/
3429e91a SAS	10
4718c177	11	#include <linux/clk.h>
48157bb9	12	#include <linux/dma-mapping.h>
3429e91a	13	#include <linux/module.h>
4c39d4b9	14	#include <linux/pci.h>
1fe6c452	15	#include <linux/of.h>
2847d242	16	#include <linux/of_device.h>
48157bb9	17	#include <linux/platform_device.h>
7b8ef22e	18	#include <linux/usb/phy.h>
48157bb9	19	#include <linux/slab.h>
579085b5	20	#include <linux/acpi.h>
c94d41e9	21	#include <linux/usb/of.h>
3429e91a SAS	22
3429e91a SAS	23	#include "xhci.h"
4efb2f69	24	#include "xhci-plat.h"
97374792	25	#include "xhci-mvebu.h"
4ac8918f	26	#include "xhci-rcar.h"
3429e91a	27
1885d9a3 AB	28	static struct hc_driver __read_mostly xhci_plat_hc_driver;
1885d9a3 AB	29
cd33a321 RQ	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 = {
4efb2f69	34	.extra_priv_size = sizeof(struct xhci_plat_priv),
cd33a321 RQ	35	.reset = xhci_plat_setup,
	36	.start = xhci_plat_start,
	37	};
	38
b1c127ae	39	static void xhci_priv_plat_start(struct usb_hcd *hcd)
3429e91a	40	{
b1c127ae FB	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	}
5ad3b03e	56
98c0a3ff YS	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
b1c127ae FB	67	static void xhci_plat_quirks(struct device dev, struct xhci_hcd xhci)
b1c127ae FB	68	{
77d8f110 YS	69	struct xhci_plat_priv *priv = xhci_to_priv(xhci);
77d8f110 YS	70
3429e91a SAS	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	*/
77d8f110	76	xhci->quirks \|= XHCI_PLAT \| priv->quirks;
3429e91a SAS	77	}
	78
	79	/* called during probe() after chip reset completes */
	80	static int xhci_plat_setup(struct usb_hcd *hcd)
	81	{
4ac8918f YS	82	int ret;
4ac8918f YS	83
4ac8918f	84
b1c127ae FB	85	ret = xhci_priv_init_quirk(hcd);
	86	if (ret)
	87	return ret;
3bdb263d	88
3429e91a SAS	89	return xhci_gen_setup(hcd, xhci_plat_quirks);
	90	}
	91
94adcdce YS	92	static int xhci_plat_start(struct usb_hcd *hcd)
94adcdce YS	93	{
b1c127ae	94	xhci_priv_plat_start(hcd);
94adcdce YS	95	return xhci_run(hcd);
	96	}
	97
4efb2f69 YS	98	#ifdef CONFIG_OF
4efb2f69 YS	99	static const struct xhci_plat_priv xhci_plat_marvell_armada = {
b1c127ae	100	.init_quirk = xhci_mvebu_mbus_init_quirk,
4efb2f69 YS	101	};
4efb2f69 YS	102
12453a89 OH	103	static const struct xhci_plat_priv xhci_plat_marvell_armada3700 = {
	104	.init_quirk = xhci_mvebu_a3700_init_quirk,
	105	};
	106
4efb2f69	107	static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen2 = {
ed056203	108	SET_XHCI_PLAT_PRIV_FOR_RCAR(XHCI_RCAR_FIRMWARE_NAME_V1)
4efb2f69 YS	109	};
4efb2f69 YS	110
526a240f	111	static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen3 = {
ed056203	112	SET_XHCI_PLAT_PRIV_FOR_RCAR(XHCI_RCAR_FIRMWARE_NAME_V3)
3f1dae6b YS	113	};
3f1dae6b YS	114
4efb2f69 YS	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,
12453a89 OH	126	}, {
	127	.compatible = "marvell,armada3700-xhci",
	128	.data = &xhci_plat_marvell_armada3700,
4efb2f69 YS	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,
82487b71 YS	135	}, {
	136	.compatible = "renesas,xhci-r8a7793",
	137	.data = &xhci_plat_renesas_rcar_gen2,
526a240f YS	138	}, {
	139	.compatible = "renesas,xhci-r8a7795",
	140	.data = &xhci_plat_renesas_rcar_gen3,
3f1dae6b YS	141	}, {
3f1dae6b YS	142	.compatible = "renesas,xhci-r8a7796",
4dd51864	143	.data = &xhci_plat_renesas_rcar_gen3,
4efb2f69	144	}, {
f1bbdc3b SH	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,
4efb2f69	150	},
ff075d67	151	{},
4efb2f69 YS	152	};
	153	MODULE_DEVICE_TABLE(of, usb_xhci_of_match);
	154	#endif
	155
3429e91a SAS	156	static int xhci_plat_probe(struct platform_device *pdev)
3429e91a SAS	157	{
2847d242	158	const struct xhci_plat_priv *priv_match;
3429e91a	159	const struct hc_driver *driver;
222471f7	160	struct device sysdev, tmpdev;
3429e91a SAS	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
1885d9a3	170	driver = &xhci_plat_hc_driver;
3429e91a SAS	171
	172	irq = platform_get_irq(pdev, 0);
	173	if (irq < 0)
4b148d51	174	return irq;
3429e91a	175
4c39d4b9 AB	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	*/
c6b8e793 AW	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;
4c39d4b9	187	#ifdef CONFIG_PCI
c6b8e793 AW	188	else if (sysdev->bus == &pci_bus_type)
c6b8e793 AW	189	break;
4c39d4b9	190	#endif
c6b8e793 AW	191	}
	192
	193	if (!sysdev)
	194	sysdev = &pdev->dev;
4c39d4b9	195
0ebbe398	196	/* Try to set 64-bit DMA first */
4c39d4b9	197	if (WARN_ON(!sysdev->dma_mask))
0ebbe398	198	/* Platform did not initialize dma_mask */
4c39d4b9	199	ret = dma_coerce_mask_and_coherent(sysdev,
0ebbe398	200	DMA_BIT_MASK(64));
c10cf118	201	else
4c39d4b9	202	ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(64));
0ebbe398 DD	203
	204	/* If seting 64-bit DMA mask fails, fall back to 32-bit DMA mask */
	205	if (ret) {
4c39d4b9	206	ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(32));
0ebbe398 DD	207	if (ret)
	208	return ret;
	209	}
c10cf118	210
b0c69b4b BW	211	pm_runtime_set_active(&pdev->dev);
	212	pm_runtime_enable(&pdev->dev);
	213	pm_runtime_get_noresume(&pdev->dev);
	214
4c39d4b9 AB	215	hcd = __usb_create_hcd(driver, sysdev, &pdev->dev,
4c39d4b9 AB	216	dev_name(&pdev->dev), NULL);
b0c69b4b BW	217	if (!hcd) {
	218	ret = -ENOMEM;
	219	goto disable_runtime;
	220	}
3429e91a	221
fb222273	222	hcd->regs = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
fd666348 HS	223	if (IS_ERR(hcd->regs)) {
fd666348 HS	224	ret = PTR_ERR(hcd->regs);
3429e91a SAS	225	goto put_hcd;
	226	}
	227
e7020f19 VB	228	hcd->rsrc_start = res->start;
	229	hcd->rsrc_len = resource_size(res);
	230
08048c04 CY	231	xhci = hcd_to_xhci(hcd);
08048c04 CY	232
4718c177	233	/*
3ae2da7b GC	234	* Not all platforms have clks so it is not an error if the
3ae2da7b GC	235	* clock do not exist.
4718c177	236	*/
08048c04 CY	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);
3ae2da7b GC	240	goto put_hcd;
	241	}
	242
08048c04 CY	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);
3ae2da7b	250	goto disable_reg_clk;
4718c177 GC	251	}
4718c177 GC	252
08048c04 CY	253	ret = clk_prepare_enable(xhci->clk);
	254	if (ret)
	255	goto disable_reg_clk;
	256
2847d242 GU	257	priv_match = of_device_get_match_data(&pdev->dev);
2847d242 GU	258	if (priv_match) {
4efb2f69 YS	259	struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
	260
	261	/* Just copy data for now */
2ad294d5 GC	262	if (priv_match)
2ad294d5 GC	263	priv = priv_match;
4efb2f69 YS	264	}
4efb2f69 YS	265
3c9740a1	266	device_wakeup_enable(hcd->self.controller);
3429e91a	267
9fa733f2	268	xhci->main_hcd = hcd;
4c39d4b9	269	xhci->shared_hcd = __usb_create_hcd(driver, sysdev, &pdev->dev,
3429e91a SAS	270	dev_name(&pdev->dev), hcd);
	271	if (!xhci->shared_hcd) {
	272	ret = -ENOMEM;
4ac53087	273	goto disable_clk;
3429e91a SAS	274	}
3429e91a SAS	275
222471f7 AKV	276	/* imod_interval is the interrupt moderation value in nanoseconds. */
222471f7 AKV	277	xhci->imod_interval = 40000;
4750bc78	278
222471f7 AKV	279	/* Iterate over all parent nodes for finding quirks */
222471f7 AKV	280	for (tmpdev = &pdev->dev; tmpdev; tmpdev = tmpdev->parent) {
3429e91a	281
222471f7 AKV	282	if (device_property_read_bool(tmpdev, "usb2-lpm-disable"))
222471f7 AKV	283	xhci->quirks \|= XHCI_HW_LPM_DISABLE;
21939f00	284
222471f7 AKV	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	}
ab725cbe	294
4c39d4b9	295	hcd->usb_phy = devm_usb_get_phy_by_phandle(sysdev, "usb-phy", 0);
7b8ef22e MR	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
c94d41e9 PC	307	hcd->tpl_support = of_usb_host_tpl_support(sysdev->of_node);
c94d41e9 PC	308	xhci->shared_hcd->tpl_support = hcd->tpl_support;
4ac53087	309	ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
3429e91a	310	if (ret)
7b8ef22e	311	goto disable_usb_phy;
3429e91a	312
5de4e1ea W	313	if (HCC_MAX_PSA(xhci->hcc_params) >= 4)
	314	xhci->shared_hcd->can_do_streams = 1;
	315
4ac53087 RQ	316	ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
	317	if (ret)
	318	goto dealloc_usb2_hcd;
	319
c70a1529	320	device_enable_async_suspend(&pdev->dev);
b0c69b4b BW	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);
c70a1529	328
3429e91a SAS	329	return 0;
3429e91a SAS	330
4ac53087 RQ	331
	332	dealloc_usb2_hcd:
	333	usb_remove_hcd(hcd);
	334
7b8ef22e MR	335	disable_usb_phy:
	336	usb_phy_shutdown(hcd->usb_phy);
	337
3429e91a SAS	338	put_usb3_hcd:
	339	usb_put_hcd(xhci->shared_hcd);
	340
4718c177	341	disable_clk:
08048c04	342	clk_disable_unprepare(xhci->clk);
4718c177	343
3ae2da7b	344	disable_reg_clk:
08048c04	345	clk_disable_unprepare(xhci->reg_clk);
3ae2da7b	346
3429e91a SAS	347	put_hcd:
	348	usb_put_hcd(hcd);
	349
b0c69b4b BW	350	disable_runtime:
	351	pm_runtime_put_noidle(&pdev->dev);
	352	pm_runtime_disable(&pdev->dev);
	353
3429e91a SAS	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);
4718c177	361	struct clk *clk = xhci->clk;
3ae2da7b	362	struct clk *reg_clk = xhci->reg_clk;
f0680904	363	struct usb_hcd *shared_hcd = xhci->shared_hcd;
3429e91a	364
dcc7620c GR	365	xhci->xhc_state \|= XHCI_STATE_REMOVING;
dcc7620c GR	366
f0680904 MN	367	usb_remove_hcd(shared_hcd);
f0680904 MN	368	xhci->shared_hcd = NULL;
7b8ef22e	369	usb_phy_shutdown(hcd->usb_phy);
3429e91a SAS	370
3429e91a SAS	371	usb_remove_hcd(hcd);
f0680904	372	usb_put_hcd(shared_hcd);
4ac53087	373
2d79609b	374	clk_disable_unprepare(clk);
3ae2da7b	375	clk_disable_unprepare(reg_clk);
3429e91a	376	usb_put_hcd(hcd);
3429e91a	377
b0c69b4b BW	378	pm_runtime_set_suspended(&dev->dev);
	379	pm_runtime_disable(&dev->dev);
	380
3429e91a SAS	381	return 0;
	382	}
	383
d852ed98	384	static int __maybe_unused xhci_plat_suspend(struct device *dev)
57d04eb1 VS	385	{
	386	struct usb_hcd *hcd = dev_get_drvdata(dev);
	387	struct xhci_hcd *xhci = hcd_to_xhci(hcd);
	388
a1377e53 LB	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	*/
d56e57ca	397	return xhci_suspend(xhci, device_may_wakeup(dev));
57d04eb1 VS	398	}
57d04eb1 VS	399
d852ed98	400	static int __maybe_unused xhci_plat_resume(struct device *dev)
57d04eb1 VS	401	{
	402	struct usb_hcd *hcd = dev_get_drvdata(dev);
	403	struct xhci_hcd *xhci = hcd_to_xhci(hcd);
98c0a3ff	404	int ret;
57d04eb1	405
98c0a3ff YS	406	ret = xhci_priv_resume_quirk(hcd);
	407	if (ret)
	408	return ret;
	409
57d04eb1 VS	410	return xhci_resume(xhci, 0);
57d04eb1 VS	411	}
b0c69b4b	412
d852ed98	413	static int __maybe_unused xhci_plat_runtime_suspend(struct device *dev)
b0c69b4b BW	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
d852ed98	421	static int __maybe_unused xhci_plat_runtime_resume(struct device *dev)
b0c69b4b BW	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	}
57d04eb1 VS	428
	429	static const struct dev_pm_ops xhci_plat_pm_ops = {
	430	SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume)
b0c69b4b BW	431
	432	SET_RUNTIME_PM_OPS(xhci_plat_runtime_suspend,
	433	xhci_plat_runtime_resume,
	434	NULL)
57d04eb1	435	};
57d04eb1	436
579085b5 DD	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
3429e91a SAS	444	static struct platform_driver usb_xhci_driver = {
	445	.probe = xhci_plat_probe,
	446	.remove = xhci_plat_remove,
b433e340	447	.shutdown = usb_hcd_platform_shutdown,
3429e91a SAS	448	.driver = {
3429e91a SAS	449	.name = "xhci-hcd",
b0c69b4b	450	.pm = &xhci_plat_pm_ops,
1fe6c452	451	.of_match_table = of_match_ptr(usb_xhci_of_match),
579085b5	452	.acpi_match_table = ACPI_PTR(usb_xhci_acpi_match),
3429e91a SAS	453	},
	454	};
	455	MODULE_ALIAS("platform:xhci-hcd");
	456
29e409f0	457	static int __init xhci_plat_init(void)
3429e91a	458	{
cd33a321	459	xhci_init_driver(&xhci_plat_hc_driver, &xhci_plat_overrides);
3429e91a SAS	460	return platform_driver_register(&usb_xhci_driver);
3429e91a SAS	461	}
29e409f0	462	module_init(xhci_plat_init);
3429e91a	463
29e409f0	464	static void __exit xhci_plat_exit(void)
3429e91a SAS	465	{
	466	platform_driver_unregister(&usb_xhci_driver);
	467	}
29e409f0 AB	468	module_exit(xhci_plat_exit);
	469
	470	MODULE_DESCRIPTION("xHCI Platform Host Controller Driver");
	471	MODULE_LICENSE("GPL");