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

/*
 * 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.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation.
 */

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

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

static struct hc_driver __read_mostly xhci_plat_hc_driver;

static void xhci_plat_quirks(struct device *dev, struct xhci_hcd *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;
}

/* called during probe() after chip reset completes */
static int xhci_plat_setup(struct usb_hcd *hcd)
{
	struct device_node *of_node = hcd->self.controller->of_node;
	int ret;

	if (of_device_is_compatible(of_node, "renesas,xhci-r8a7790") ||
	    of_device_is_compatible(of_node, "renesas,xhci-r8a7791")) {
		ret = xhci_rcar_init_quirk(hcd);
		if (ret)
			return ret;
	}

	return xhci_gen_setup(hcd, xhci_plat_quirks);
}

static int xhci_plat_start(struct usb_hcd *hcd)
{
	struct device_node *of_node = hcd->self.controller->of_node;

	if (of_device_is_compatible(of_node, "renesas,xhci-r8a7790") ||
	    of_device_is_compatible(of_node, "renesas,xhci-r8a7791"))
		xhci_rcar_start(hcd);

	return xhci_run(hcd);
}

static int xhci_plat_probe(struct platform_device *pdev)
{
	struct device_node	*node = pdev->dev.of_node;
	struct usb_xhci_pdata	*pdata = dev_get_platdata(&pdev->dev);
	const struct hc_driver	*driver;
	struct xhci_hcd		*xhci;
	struct resource         *res;
	struct usb_hcd		*hcd;
	struct clk              *clk;
	int			ret;
	int			irq;

	if (usb_disabled())
		return -ENODEV;

	driver = &xhci_plat_hc_driver;

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

	/* Initialize dma_mask and coherent_dma_mask to 32-bits */
	ret = dma_set_coherent_mask(&pdev->dev, DMA_BIT_MASK(32));
	if (ret)
		return ret;
	if (!pdev->dev.dma_mask)
		pdev->dev.dma_mask = &pdev->dev.coherent_dma_mask;
	else
		dma_set_mask(&pdev->dev, DMA_BIT_MASK(32));

	hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev));
	if (!hcd)
		return -ENOMEM;

	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	hcd->regs = devm_ioremap_resource(&pdev->dev, 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);

	/*
	 * Not all platforms have a clk so it is not an error if the
	 * clock does not exists.
	 */
	clk = devm_clk_get(&pdev->dev, NULL);
	if (!IS_ERR(clk)) {
		ret = clk_prepare_enable(clk);
		if (ret)
			goto put_hcd;
	}

	if (of_device_is_compatible(pdev->dev.of_node,
				    "marvell,armada-375-xhci") ||
	    of_device_is_compatible(pdev->dev.of_node,
				    "marvell,armada-380-xhci")) {
		ret = xhci_mvebu_mbus_init_quirk(pdev);
		if (ret)
			goto disable_clk;
	}

	ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
	if (ret)
		goto disable_clk;

	device_wakeup_enable(hcd->self.controller);

	/* USB 2.0 roothub is stored in the platform_device now. */
	hcd = platform_get_drvdata(pdev);
	xhci = hcd_to_xhci(hcd);
	xhci->clk = clk;
	xhci->shared_hcd = usb_create_shared_hcd(driver, &pdev->dev,
			dev_name(&pdev->dev), hcd);
	if (!xhci->shared_hcd) {
		ret = -ENOMEM;
		goto dealloc_usb2_hcd;
	}

	if ((node && of_property_read_bool(node, "usb3-lpm-capable")) ||
			(pdata && pdata->usb3_lpm_capable))
		xhci->quirks |= XHCI_LPM_SUPPORT;
	/*
	 * Set the xHCI pointer before xhci_plat_setup() (aka hcd_driver.reset)
	 * is called by usb_add_hcd().
	 */
	*((struct xhci_hcd **) xhci->shared_hcd->hcd_priv) = xhci;

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

	hcd->usb_phy = devm_usb_get_phy_by_phandle(&pdev->dev, "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;
	}

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

	return 0;

disable_usb_phy:
	usb_phy_shutdown(hcd->usb_phy);

put_usb3_hcd:
	usb_put_hcd(xhci->shared_hcd);

dealloc_usb2_hcd:
	usb_remove_hcd(hcd);

disable_clk:
	if (!IS_ERR(clk))
		clk_disable_unprepare(clk);

put_hcd:
	usb_put_hcd(hcd);

	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;

	usb_remove_hcd(xhci->shared_hcd);
	usb_phy_shutdown(hcd->usb_phy);
	usb_put_hcd(xhci->shared_hcd);

	usb_remove_hcd(hcd);
	if (!IS_ERR(clk))
		clk_disable_unprepare(clk);
	usb_put_hcd(hcd);
	kfree(xhci);

	return 0;
}

#ifdef CONFIG_PM_SLEEP
static int 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 xhci_plat_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)
};
#define DEV_PM_OPS	(&xhci_plat_pm_ops)
#else
#define DEV_PM_OPS	NULL
#endif /* CONFIG_PM */

#ifdef CONFIG_OF
static const struct of_device_id usb_xhci_of_match[] = {
	{ .compatible = "generic-xhci" },
	{ .compatible = "xhci-platform" },
	{ .compatible = "marvell,armada-375-xhci"},
	{ .compatible = "marvell,armada-380-xhci"},
	{ .compatible = "renesas,xhci-r8a7790"},
	{ .compatible = "renesas,xhci-r8a7791"},
	{ },
};
MODULE_DEVICE_TABLE(of, usb_xhci_of_match);
#endif

static struct platform_driver usb_xhci_driver = {
	.probe	= xhci_plat_probe,
	.remove	= xhci_plat_remove,
	.driver	= {
		.name = "xhci-hcd",
		.pm = DEV_PM_OPS,
		.of_match_table = of_match_ptr(usb_xhci_of_match),
	},
};
MODULE_ALIAS("platform:xhci-hcd");

static int __init xhci_plat_init(void)
{
	xhci_init_driver(&xhci_plat_hc_driver, xhci_plat_setup);
	xhci_plat_hc_driver.start = xhci_plat_start;
	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
3429e91a SAS	1	/*
	2	* xhci-plat.c - xHCI host controller driver platform Bus Glue.
	3	*
	4	* Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com
	5	* Author: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
	6	*
	7	* A lot of code borrowed from the Linux xHCI driver.
	8	*
	9	* This program is free software; you can redistribute it and/or
	10	* modify it under the terms of the GNU General Public License
	11	* version 2 as published by the Free Software Foundation.
	12	*/
	13
4718c177	14	#include <linux/clk.h>
48157bb9	15	#include <linux/dma-mapping.h>
3429e91a	16	#include <linux/module.h>
1fe6c452	17	#include <linux/of.h>
48157bb9	18	#include <linux/platform_device.h>
7b8ef22e	19	#include <linux/usb/phy.h>
48157bb9	20	#include <linux/slab.h>
20f6fdd0	21	#include <linux/usb/xhci_pdriver.h>
3429e91a SAS	22
3429e91a SAS	23	#include "xhci.h"
97374792	24	#include "xhci-mvebu.h"
4ac8918f	25	#include "xhci-rcar.h"
3429e91a	26
1885d9a3 AB	27	static struct hc_driver __read_mostly xhci_plat_hc_driver;
1885d9a3 AB	28
3429e91a SAS	29	static void xhci_plat_quirks(struct device dev, struct xhci_hcd xhci)
	30	{
	31	/*
	32	* As of now platform drivers don't provide MSI support so we ensure
	33	* here that the generic code does not try to make a pci_dev from our
	34	* dev struct in order to setup MSI
	35	*/
52fb6125	36	xhci->quirks \|= XHCI_PLAT;
3429e91a SAS	37	}
	38
	39	/* called during probe() after chip reset completes */
	40	static int xhci_plat_setup(struct usb_hcd *hcd)
	41	{
4ac8918f YS	42	struct device_node *of_node = hcd->self.controller->of_node;
	43	int ret;
	44
	45	if (of_device_is_compatible(of_node, "renesas,xhci-r8a7790") \|\|
	46	of_device_is_compatible(of_node, "renesas,xhci-r8a7791")) {
	47	ret = xhci_rcar_init_quirk(hcd);
	48	if (ret)
	49	return ret;
	50	}
	51
3429e91a SAS	52	return xhci_gen_setup(hcd, xhci_plat_quirks);
	53	}
	54
94adcdce YS	55	static int xhci_plat_start(struct usb_hcd *hcd)
94adcdce YS	56	{
4ac8918f YS	57	struct device_node *of_node = hcd->self.controller->of_node;
	58
	59	if (of_device_is_compatible(of_node, "renesas,xhci-r8a7790") \|\|
	60	of_device_is_compatible(of_node, "renesas,xhci-r8a7791"))
	61	xhci_rcar_start(hcd);
	62
94adcdce YS	63	return xhci_run(hcd);
	64	}
	65
3429e91a SAS	66	static int xhci_plat_probe(struct platform_device *pdev)
3429e91a SAS	67	{
20f6fdd0 PA	68	struct device_node *node = pdev->dev.of_node;
20f6fdd0 PA	69	struct usb_xhci_pdata *pdata = dev_get_platdata(&pdev->dev);
3429e91a SAS	70	const struct hc_driver *driver;
	71	struct xhci_hcd *xhci;
	72	struct resource *res;
	73	struct usb_hcd *hcd;
4718c177	74	struct clk *clk;
3429e91a SAS	75	int ret;
	76	int irq;
	77
	78	if (usb_disabled())
	79	return -ENODEV;
	80
1885d9a3	81	driver = &xhci_plat_hc_driver;
3429e91a SAS	82
	83	irq = platform_get_irq(pdev, 0);
	84	if (irq < 0)
	85	return -ENODEV;
	86
c10cf118 XR	87	/* Initialize dma_mask and coherent_dma_mask to 32-bits */
	88	ret = dma_set_coherent_mask(&pdev->dev, DMA_BIT_MASK(32));
	89	if (ret)
	90	return ret;
	91	if (!pdev->dev.dma_mask)
	92	pdev->dev.dma_mask = &pdev->dev.coherent_dma_mask;
	93	else
	94	dma_set_mask(&pdev->dev, DMA_BIT_MASK(32));
	95
3429e91a SAS	96	hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev));
	97	if (!hcd)
	98	return -ENOMEM;
	99
e7020f19	100	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
fd666348 HS	101	hcd->regs = devm_ioremap_resource(&pdev->dev, res);
	102	if (IS_ERR(hcd->regs)) {
	103	ret = PTR_ERR(hcd->regs);
3429e91a SAS	104	goto put_hcd;
	105	}
	106
e7020f19 VB	107	hcd->rsrc_start = res->start;
	108	hcd->rsrc_len = resource_size(res);
	109
4718c177 GC	110	/*
	111	* Not all platforms have a clk so it is not an error if the
	112	* clock does not exists.
	113	*/
	114	clk = devm_clk_get(&pdev->dev, NULL);
	115	if (!IS_ERR(clk)) {
	116	ret = clk_prepare_enable(clk);
	117	if (ret)
fd666348	118	goto put_hcd;
4718c177 GC	119	}
4718c177 GC	120
1e7e4fb6 MR	121	if (of_device_is_compatible(pdev->dev.of_node,
	122	"marvell,armada-375-xhci") \|\|
	123	of_device_is_compatible(pdev->dev.of_node,
	124	"marvell,armada-380-xhci")) {
	125	ret = xhci_mvebu_mbus_init_quirk(pdev);
	126	if (ret)
	127	goto disable_clk;
	128	}
	129
3429e91a SAS	130	ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
3429e91a SAS	131	if (ret)
4718c177 GC	132	goto disable_clk;
4718c177 GC	133
3c9740a1	134	device_wakeup_enable(hcd->self.controller);
3429e91a SAS	135
3429e91a SAS	136	/* USB 2.0 roothub is stored in the platform_device now. */
477527ba	137	hcd = platform_get_drvdata(pdev);
3429e91a	138	xhci = hcd_to_xhci(hcd);
4718c177	139	xhci->clk = clk;
3429e91a SAS	140	xhci->shared_hcd = usb_create_shared_hcd(driver, &pdev->dev,
	141	dev_name(&pdev->dev), hcd);
	142	if (!xhci->shared_hcd) {
	143	ret = -ENOMEM;
	144	goto dealloc_usb2_hcd;
	145	}
	146
20f6fdd0 PA	147	if ((node && of_property_read_bool(node, "usb3-lpm-capable")) \|\|
	148	(pdata && pdata->usb3_lpm_capable))
	149	xhci->quirks \|= XHCI_LPM_SUPPORT;
3429e91a SAS	150	/*
	151	* Set the xHCI pointer before xhci_plat_setup() (aka hcd_driver.reset)
	152	* is called by usb_add_hcd().
	153	*/
	154	((struct xhci_hcd *) xhci->shared_hcd->hcd_priv) = xhci;
	155
14aec589 ON	156	if (HCC_MAX_PSA(xhci->hcc_params) >= 4)
	157	xhci->shared_hcd->can_do_streams = 1;
	158
7b8ef22e MR	159	hcd->usb_phy = devm_usb_get_phy_by_phandle(&pdev->dev, "usb-phy", 0);
	160	if (IS_ERR(hcd->usb_phy)) {
	161	ret = PTR_ERR(hcd->usb_phy);
	162	if (ret == -EPROBE_DEFER)
	163	goto put_usb3_hcd;
	164	hcd->usb_phy = NULL;
	165	} else {
	166	ret = usb_phy_init(hcd->usb_phy);
	167	if (ret)
	168	goto put_usb3_hcd;
	169	}
	170
3429e91a SAS	171	ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
3429e91a SAS	172	if (ret)
7b8ef22e	173	goto disable_usb_phy;
3429e91a SAS	174
	175	return 0;
	176
7b8ef22e MR	177	disable_usb_phy:
	178	usb_phy_shutdown(hcd->usb_phy);
	179
3429e91a SAS	180	put_usb3_hcd:
	181	usb_put_hcd(xhci->shared_hcd);
	182
	183	dealloc_usb2_hcd:
	184	usb_remove_hcd(hcd);
	185
4718c177 GC	186	disable_clk:
	187	if (!IS_ERR(clk))
	188	clk_disable_unprepare(clk);
	189
3429e91a SAS	190	put_hcd:
	191	usb_put_hcd(hcd);
	192
	193	return ret;
	194	}
	195
	196	static int xhci_plat_remove(struct platform_device *dev)
	197	{
	198	struct usb_hcd *hcd = platform_get_drvdata(dev);
	199	struct xhci_hcd *xhci = hcd_to_xhci(hcd);
4718c177	200	struct clk *clk = xhci->clk;
3429e91a SAS	201
3429e91a SAS	202	usb_remove_hcd(xhci->shared_hcd);
7b8ef22e	203	usb_phy_shutdown(hcd->usb_phy);
3429e91a SAS	204	usb_put_hcd(xhci->shared_hcd);
	205
	206	usb_remove_hcd(hcd);
4718c177 GC	207	if (!IS_ERR(clk))
4718c177 GC	208	clk_disable_unprepare(clk);
3429e91a SAS	209	usb_put_hcd(hcd);
	210	kfree(xhci);
	211
	212	return 0;
	213	}
	214
274f6afa	215	#ifdef CONFIG_PM_SLEEP
57d04eb1 VS	216	static int xhci_plat_suspend(struct device *dev)
	217	{
	218	struct usb_hcd *hcd = dev_get_drvdata(dev);
	219	struct xhci_hcd *xhci = hcd_to_xhci(hcd);
	220
a1377e53 LB	221	/*
	222	* xhci_suspend() needs `do_wakeup` to know whether host is allowed
	223	* to do wakeup during suspend. Since xhci_plat_suspend is currently
	224	* only designed for system suspend, device_may_wakeup() is enough
	225	* to dertermine whether host is allowed to do wakeup. Need to
	226	* reconsider this when xhci_plat_suspend enlarges its scope, e.g.,
	227	* also applies to runtime suspend.
	228	*/
	229	return xhci_suspend(xhci, device_may_wakeup(dev));
57d04eb1 VS	230	}
	231
	232	static int xhci_plat_resume(struct device *dev)
	233	{
	234	struct usb_hcd *hcd = dev_get_drvdata(dev);
	235	struct xhci_hcd *xhci = hcd_to_xhci(hcd);
	236
	237	return xhci_resume(xhci, 0);
	238	}
	239
	240	static const struct dev_pm_ops xhci_plat_pm_ops = {
	241	SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume)
	242	};
	243	#define DEV_PM_OPS (&xhci_plat_pm_ops)
	244	#else
	245	#define DEV_PM_OPS NULL
	246	#endif /* CONFIG_PM */
	247
1fe6c452 AC	248	#ifdef CONFIG_OF
1fe6c452 AC	249	static const struct of_device_id usb_xhci_of_match[] = {
0f94388b	250	{ .compatible = "generic-xhci" },
1fe6c452	251	{ .compatible = "xhci-platform" },
97374792 GC	252	{ .compatible = "marvell,armada-375-xhci"},
97374792 GC	253	{ .compatible = "marvell,armada-380-xhci"},
4ac8918f YS	254	{ .compatible = "renesas,xhci-r8a7790"},
4ac8918f YS	255	{ .compatible = "renesas,xhci-r8a7791"},
1fe6c452 AC	256	{ },
	257	};
	258	MODULE_DEVICE_TABLE(of, usb_xhci_of_match);
	259	#endif
	260
3429e91a SAS	261	static struct platform_driver usb_xhci_driver = {
	262	.probe = xhci_plat_probe,
	263	.remove = xhci_plat_remove,
	264	.driver = {
	265	.name = "xhci-hcd",
57d04eb1	266	.pm = DEV_PM_OPS,
1fe6c452	267	.of_match_table = of_match_ptr(usb_xhci_of_match),
3429e91a SAS	268	},
	269	};
	270	MODULE_ALIAS("platform:xhci-hcd");
	271
29e409f0	272	static int __init xhci_plat_init(void)
3429e91a	273	{
1885d9a3 AB	274	xhci_init_driver(&xhci_plat_hc_driver, xhci_plat_setup);
1885d9a3 AB	275	xhci_plat_hc_driver.start = xhci_plat_start;
3429e91a SAS	276	return platform_driver_register(&usb_xhci_driver);
3429e91a SAS	277	}
29e409f0	278	module_init(xhci_plat_init);
3429e91a	279
29e409f0	280	static void __exit xhci_plat_exit(void)
3429e91a SAS	281	{
	282	platform_driver_unregister(&usb_xhci_driver);
	283	}
29e409f0 AB	284	module_exit(xhci_plat_exit);
	285
	286	MODULE_DESCRIPTION("xHCI Platform Host Controller Driver");
	287	MODULE_LICENSE("GPL");