[mirror_ubuntu-bionic-kernel.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/slab.h>
#include <linux/usb/xhci_pdriver.h>

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

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)
{
	return xhci_gen_setup(hcd, xhci_plat_quirks);
}

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

static const struct hc_driver xhci_plat_xhci_driver = {
	.description =		"xhci-hcd",
	.product_desc =		"xHCI Host Controller",
	.hcd_priv_size =	sizeof(struct xhci_hcd *),

	/*
	 * generic hardware linkage
	 */
	.irq =			xhci_irq,
	.flags =		HCD_MEMORY | HCD_USB3 | HCD_SHARED,

	/*
	 * basic lifecycle operations
	 */
	.reset =		xhci_plat_setup,
	.start =		xhci_plat_start,
	.stop =			xhci_stop,
	.shutdown =		xhci_shutdown,

	/*
	 * managing i/o requests and associated device resources
	 */
	.urb_enqueue =		xhci_urb_enqueue,
	.urb_dequeue =		xhci_urb_dequeue,
	.alloc_dev =		xhci_alloc_dev,
	.free_dev =		xhci_free_dev,
	.alloc_streams =	xhci_alloc_streams,
	.free_streams =		xhci_free_streams,
	.add_endpoint =		xhci_add_endpoint,
	.drop_endpoint =	xhci_drop_endpoint,
	.endpoint_reset =	xhci_endpoint_reset,
	.check_bandwidth =	xhci_check_bandwidth,
	.reset_bandwidth =	xhci_reset_bandwidth,
	.address_device =	xhci_address_device,
	.enable_device =	xhci_enable_device,
	.update_hub_device =	xhci_update_hub_device,
	.reset_device =		xhci_discover_or_reset_device,

	/*
	 * scheduling support
	 */
	.get_frame_number =	xhci_get_frame,

	/* Root hub support */
	.hub_control =		xhci_hub_control,
	.hub_status_data =	xhci_hub_status_data,
	.bus_suspend =		xhci_bus_suspend,
	.bus_resume =		xhci_bus_resume,

	.enable_usb3_lpm_timeout =	xhci_enable_usb3_lpm_timeout,
	.disable_usb3_lpm_timeout =	xhci_disable_usb3_lpm_timeout,
};

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

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

	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	if (!res)
		return -ENODEV;

	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)
			return ret;
	}

	/* 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;

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

	if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len,
				driver->description)) {
		dev_dbg(&pdev->dev, "controller already in use\n");
		ret = -EBUSY;
		goto put_hcd;
	}

	hcd->regs = ioremap_nocache(hcd->rsrc_start, hcd->rsrc_len);
	if (!hcd->regs) {
		dev_dbg(&pdev->dev, "error mapping memory\n");
		ret = -EFAULT;
		goto release_mem_region;
	}

	/*
	 * 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 unmap_registers;
	}

	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;

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

	return 0;

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

unmap_registers:
	iounmap(hcd->regs);

release_mem_region:
	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);

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_put_hcd(xhci->shared_hcd);

	usb_remove_hcd(hcd);
	if (!IS_ERR(clk))
		clk_disable_unprepare(clk);
	iounmap(hcd->regs);
	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
	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);

	return xhci_suspend(xhci);
}

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"},
	{ },
};
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");

int xhci_register_plat(void)
{
	return platform_driver_register(&usb_xhci_driver);
}

void xhci_unregister_plat(void)
{
	platform_driver_unregister(&usb_xhci_driver);
}
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 GC	18	#include <linux/platform_device.h>
48157bb9 GC	19	#include <linux/slab.h>
20f6fdd0	20	#include <linux/usb/xhci_pdriver.h>
3429e91a SAS	21
3429e91a SAS	22	#include "xhci.h"
97374792	23	#include "xhci-mvebu.h"
3429e91a SAS	24
	25	static void xhci_plat_quirks(struct device dev, struct xhci_hcd xhci)
	26	{
	27	/*
	28	* As of now platform drivers don't provide MSI support so we ensure
	29	* here that the generic code does not try to make a pci_dev from our
	30	* dev struct in order to setup MSI
	31	*/
52fb6125	32	xhci->quirks \|= XHCI_PLAT;
3429e91a SAS	33	}
	34
	35	/* called during probe() after chip reset completes */
	36	static int xhci_plat_setup(struct usb_hcd *hcd)
	37	{
	38	return xhci_gen_setup(hcd, xhci_plat_quirks);
	39	}
	40
94adcdce YS	41	static int xhci_plat_start(struct usb_hcd *hcd)
	42	{
	43	return xhci_run(hcd);
	44	}
	45
3429e91a SAS	46	static const struct hc_driver xhci_plat_xhci_driver = {
	47	.description = "xhci-hcd",
	48	.product_desc = "xHCI Host Controller",
	49	.hcd_priv_size = sizeof(struct xhci_hcd *),
	50
	51	/*
	52	* generic hardware linkage
	53	*/
	54	.irq = xhci_irq,
	55	.flags = HCD_MEMORY \| HCD_USB3 \| HCD_SHARED,
	56
	57	/*
	58	* basic lifecycle operations
	59	*/
	60	.reset = xhci_plat_setup,
94adcdce	61	.start = xhci_plat_start,
3429e91a SAS	62	.stop = xhci_stop,
	63	.shutdown = xhci_shutdown,
	64
	65	/*
	66	* managing i/o requests and associated device resources
	67	*/
	68	.urb_enqueue = xhci_urb_enqueue,
	69	.urb_dequeue = xhci_urb_dequeue,
	70	.alloc_dev = xhci_alloc_dev,
	71	.free_dev = xhci_free_dev,
	72	.alloc_streams = xhci_alloc_streams,
	73	.free_streams = xhci_free_streams,
	74	.add_endpoint = xhci_add_endpoint,
	75	.drop_endpoint = xhci_drop_endpoint,
	76	.endpoint_reset = xhci_endpoint_reset,
	77	.check_bandwidth = xhci_check_bandwidth,
	78	.reset_bandwidth = xhci_reset_bandwidth,
	79	.address_device = xhci_address_device,
48fc7dbd	80	.enable_device = xhci_enable_device,
3429e91a SAS	81	.update_hub_device = xhci_update_hub_device,
	82	.reset_device = xhci_discover_or_reset_device,
	83
	84	/*
	85	* scheduling support
	86	*/
	87	.get_frame_number = xhci_get_frame,
	88
	89	/* Root hub support */
	90	.hub_control = xhci_hub_control,
	91	.hub_status_data = xhci_hub_status_data,
	92	.bus_suspend = xhci_bus_suspend,
	93	.bus_resume = xhci_bus_resume,
94ef3d50 PA	94
	95	.enable_usb3_lpm_timeout = xhci_enable_usb3_lpm_timeout,
	96	.disable_usb3_lpm_timeout = xhci_disable_usb3_lpm_timeout,
3429e91a SAS	97	};
	98
	99	static int xhci_plat_probe(struct platform_device *pdev)
	100	{
20f6fdd0 PA	101	struct device_node *node = pdev->dev.of_node;
20f6fdd0 PA	102	struct usb_xhci_pdata *pdata = dev_get_platdata(&pdev->dev);
3429e91a SAS	103	const struct hc_driver *driver;
	104	struct xhci_hcd *xhci;
	105	struct resource *res;
	106	struct usb_hcd *hcd;
4718c177	107	struct clk *clk;
3429e91a SAS	108	int ret;
	109	int irq;
	110
	111	if (usb_disabled())
	112	return -ENODEV;
	113
	114	driver = &xhci_plat_xhci_driver;
	115
	116	irq = platform_get_irq(pdev, 0);
	117	if (irq < 0)
	118	return -ENODEV;
	119
	120	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	121	if (!res)
	122	return -ENODEV;
	123
97374792 GC	124	if (of_device_is_compatible(pdev->dev.of_node,
	125	"marvell,armada-375-xhci") \|\|
	126	of_device_is_compatible(pdev->dev.of_node,
	127	"marvell,armada-380-xhci")) {
	128	ret = xhci_mvebu_mbus_init_quirk(pdev);
	129	if (ret)
	130	return ret;
	131	}
	132
c10cf118 XR	133	/* Initialize dma_mask and coherent_dma_mask to 32-bits */
	134	ret = dma_set_coherent_mask(&pdev->dev, DMA_BIT_MASK(32));
	135	if (ret)
	136	return ret;
	137	if (!pdev->dev.dma_mask)
	138	pdev->dev.dma_mask = &pdev->dev.coherent_dma_mask;
	139	else
	140	dma_set_mask(&pdev->dev, DMA_BIT_MASK(32));
	141
3429e91a SAS	142	hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev));
	143	if (!hcd)
	144	return -ENOMEM;
	145
	146	hcd->rsrc_start = res->start;
	147	hcd->rsrc_len = resource_size(res);
	148
	149	if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len,
	150	driver->description)) {
	151	dev_dbg(&pdev->dev, "controller already in use\n");
	152	ret = -EBUSY;
	153	goto put_hcd;
	154	}
	155
319acdfc	156	hcd->regs = ioremap_nocache(hcd->rsrc_start, hcd->rsrc_len);
3429e91a SAS	157	if (!hcd->regs) {
	158	dev_dbg(&pdev->dev, "error mapping memory\n");
	159	ret = -EFAULT;
	160	goto release_mem_region;
	161	}
	162
4718c177 GC	163	/*
	164	* Not all platforms have a clk so it is not an error if the
	165	* clock does not exists.
	166	*/
	167	clk = devm_clk_get(&pdev->dev, NULL);
	168	if (!IS_ERR(clk)) {
	169	ret = clk_prepare_enable(clk);
	170	if (ret)
	171	goto unmap_registers;
	172	}
	173
3429e91a SAS	174	ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
3429e91a SAS	175	if (ret)
4718c177 GC	176	goto disable_clk;
4718c177 GC	177
3c9740a1	178	device_wakeup_enable(hcd->self.controller);
3429e91a SAS	179
3429e91a SAS	180	/* USB 2.0 roothub is stored in the platform_device now. */
477527ba	181	hcd = platform_get_drvdata(pdev);
3429e91a	182	xhci = hcd_to_xhci(hcd);
4718c177	183	xhci->clk = clk;
3429e91a SAS	184	xhci->shared_hcd = usb_create_shared_hcd(driver, &pdev->dev,
	185	dev_name(&pdev->dev), hcd);
	186	if (!xhci->shared_hcd) {
	187	ret = -ENOMEM;
	188	goto dealloc_usb2_hcd;
	189	}
	190
20f6fdd0 PA	191	if ((node && of_property_read_bool(node, "usb3-lpm-capable")) \|\|
	192	(pdata && pdata->usb3_lpm_capable))
	193	xhci->quirks \|= XHCI_LPM_SUPPORT;
3429e91a SAS	194	/*
	195	* Set the xHCI pointer before xhci_plat_setup() (aka hcd_driver.reset)
	196	* is called by usb_add_hcd().
	197	*/
	198	((struct xhci_hcd *) xhci->shared_hcd->hcd_priv) = xhci;
	199
14aec589 ON	200	if (HCC_MAX_PSA(xhci->hcc_params) >= 4)
	201	xhci->shared_hcd->can_do_streams = 1;
	202
3429e91a SAS	203	ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
	204	if (ret)
	205	goto put_usb3_hcd;
	206
	207	return 0;
	208
	209	put_usb3_hcd:
	210	usb_put_hcd(xhci->shared_hcd);
	211
	212	dealloc_usb2_hcd:
	213	usb_remove_hcd(hcd);
	214
4718c177 GC	215	disable_clk:
	216	if (!IS_ERR(clk))
	217	clk_disable_unprepare(clk);
	218
3429e91a SAS	219	unmap_registers:
	220	iounmap(hcd->regs);
	221
	222	release_mem_region:
	223	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
	224
	225	put_hcd:
	226	usb_put_hcd(hcd);
	227
	228	return ret;
	229	}
	230
	231	static int xhci_plat_remove(struct platform_device *dev)
	232	{
	233	struct usb_hcd *hcd = platform_get_drvdata(dev);
	234	struct xhci_hcd *xhci = hcd_to_xhci(hcd);
4718c177	235	struct clk *clk = xhci->clk;
3429e91a SAS	236
	237	usb_remove_hcd(xhci->shared_hcd);
	238	usb_put_hcd(xhci->shared_hcd);
	239
	240	usb_remove_hcd(hcd);
4718c177 GC	241	if (!IS_ERR(clk))
4718c177 GC	242	clk_disable_unprepare(clk);
3429e91a	243	iounmap(hcd->regs);
5388a3a5	244	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
3429e91a SAS	245	usb_put_hcd(hcd);
	246	kfree(xhci);
	247
	248	return 0;
	249	}
	250
274f6afa	251	#ifdef CONFIG_PM_SLEEP
57d04eb1 VS	252	static int xhci_plat_suspend(struct device *dev)
	253	{
	254	struct usb_hcd *hcd = dev_get_drvdata(dev);
	255	struct xhci_hcd *xhci = hcd_to_xhci(hcd);
	256
	257	return xhci_suspend(xhci);
	258	}
	259
	260	static int xhci_plat_resume(struct device *dev)
	261	{
	262	struct usb_hcd *hcd = dev_get_drvdata(dev);
	263	struct xhci_hcd *xhci = hcd_to_xhci(hcd);
	264
	265	return xhci_resume(xhci, 0);
	266	}
	267
	268	static const struct dev_pm_ops xhci_plat_pm_ops = {
	269	SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume)
	270	};
	271	#define DEV_PM_OPS (&xhci_plat_pm_ops)
	272	#else
	273	#define DEV_PM_OPS NULL
	274	#endif /* CONFIG_PM */
	275
1fe6c452 AC	276	#ifdef CONFIG_OF
1fe6c452 AC	277	static const struct of_device_id usb_xhci_of_match[] = {
0f94388b	278	{ .compatible = "generic-xhci" },
1fe6c452	279	{ .compatible = "xhci-platform" },
97374792 GC	280	{ .compatible = "marvell,armada-375-xhci"},
97374792 GC	281	{ .compatible = "marvell,armada-380-xhci"},
1fe6c452 AC	282	{ },
	283	};
	284	MODULE_DEVICE_TABLE(of, usb_xhci_of_match);
	285	#endif
	286
3429e91a SAS	287	static struct platform_driver usb_xhci_driver = {
	288	.probe = xhci_plat_probe,
	289	.remove = xhci_plat_remove,
	290	.driver = {
	291	.name = "xhci-hcd",
57d04eb1	292	.pm = DEV_PM_OPS,
1fe6c452	293	.of_match_table = of_match_ptr(usb_xhci_of_match),
3429e91a SAS	294	},
	295	};
	296	MODULE_ALIAS("platform:xhci-hcd");
	297
	298	int xhci_register_plat(void)
	299	{
	300	return platform_driver_register(&usb_xhci_driver);
	301	}
	302
	303	void xhci_unregister_plat(void)
	304	{
	305	platform_driver_unregister(&usb_xhci_driver);
	306	}