[linux-2.6-block.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 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_hcd),
	.reset = xhci_plat_setup,
	.start = xhci_plat_start,
};

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;
	}

	device_wakeup_enable(hcd->self.controller);

	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 disable_clk;
	}

	if ((node && of_property_read_bool(node, "usb3-lpm-capable")) ||
			(pdata && pdata->usb3_lpm_capable))
		xhci->quirks |= XHCI_LPM_SUPPORT;

	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(hcd, irq, IRQF_SHARED);
	if (ret)
		goto disable_usb_phy;

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

	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:
	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_remove_hcd(hcd);
	usb_put_hcd(xhci->shared_hcd);

	if (!IS_ERR(clk))
		clk_disable_unprepare(clk);
	usb_put_hcd(hcd);

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