[mirror_ubuntu-bionic-kernel.git] / drivers / usb / host / ehci-platform.c

/*
 * Generic platform ehci driver
 *
 * Copyright 2007 Steven Brown <sbrown@cortland.com>
 * Copyright 2010-2012 Hauke Mehrtens <hauke@hauke-m.de>
 *
 * Derived from the ohci-ssb driver
 * Copyright 2007 Michael Buesch <m@bues.ch>
 *
 * Derived from the EHCI-PCI driver
 * Copyright (c) 2000-2004 by David Brownell
 *
 * Derived from the ohci-pci driver
 * Copyright 1999 Roman Weissgaerber
 * Copyright 2000-2002 David Brownell
 * Copyright 1999 Linus Torvalds
 * Copyright 1999 Gregory P. Smith
 *
 * Licensed under the GNU/GPL. See COPYING for details.
 */
#include <linux/dma-mapping.h>
#include <linux/err.h>
#include <linux/kernel.h>
#include <linux/hrtimer.h>
#include <linux/io.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/platform_device.h>
#include <linux/usb.h>
#include <linux/usb/hcd.h>
#include <linux/usb/ehci_pdriver.h>

#include "ehci.h"

#define DRIVER_DESC "EHCI generic platform driver"

static const char hcd_name[] = "ehci-platform";

static int ehci_platform_reset(struct usb_hcd *hcd)
{
	struct platform_device *pdev = to_platform_device(hcd->self.controller);
	struct usb_ehci_pdata *pdata = pdev->dev.platform_data;
	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
	int retval;

	hcd->has_tt = pdata->has_tt;
	ehci->has_synopsys_hc_bug = pdata->has_synopsys_hc_bug;
	ehci->big_endian_desc = pdata->big_endian_desc;
	ehci->big_endian_mmio = pdata->big_endian_mmio;

	ehci->caps = hcd->regs + pdata->caps_offset;
	retval = ehci_setup(hcd);
	if (retval)
		return retval;

	if (pdata->no_io_watchdog)
		ehci->need_io_watchdog = 0;
	return 0;
}

static struct hc_driver __read_mostly ehci_platform_hc_driver;

static const struct ehci_driver_overrides platform_overrides __initconst = {
	.reset =	ehci_platform_reset,
};

static struct usb_ehci_pdata ehci_platform_defaults;

static int ehci_platform_probe(struct platform_device *dev)
{
	struct usb_hcd *hcd;
	struct resource *res_mem;
	struct usb_ehci_pdata *pdata;
	int irq;
	int err = -ENOMEM;

	if (usb_disabled())
		return -ENODEV;

	/*
	 * use reasonable defaults so platforms don't have to provide these.
	 * with DT probing on ARM, none of these are set.
	 */
	if (!dev->dev.platform_data)
		dev->dev.platform_data = &ehci_platform_defaults;
	if (!dev->dev.dma_mask)
		dev->dev.dma_mask = &dev->dev.coherent_dma_mask;
	if (!dev->dev.coherent_dma_mask)
		dev->dev.coherent_dma_mask = DMA_BIT_MASK(32);

	pdata = dev->dev.platform_data;

	irq = platform_get_irq(dev, 0);
	if (irq < 0) {
		dev_err(&dev->dev, "no irq provided");
		return irq;
	}
	res_mem = platform_get_resource(dev, IORESOURCE_MEM, 0);
	if (!res_mem) {
		dev_err(&dev->dev, "no memory resource provided");
		return -ENXIO;
	}

	if (pdata->power_on) {
		err = pdata->power_on(dev);
		if (err < 0)
			return err;
	}

	hcd = usb_create_hcd(&ehci_platform_hc_driver, &dev->dev,
			     dev_name(&dev->dev));
	if (!hcd) {
		err = -ENOMEM;
		goto err_power;
	}

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

	hcd->regs = devm_ioremap_resource(&dev->dev, res_mem);
	if (IS_ERR(hcd->regs)) {
		err = PTR_ERR(hcd->regs);
		goto err_put_hcd;
	}
	err = usb_add_hcd(hcd, irq, IRQF_SHARED);
	if (err)
		goto err_put_hcd;

	platform_set_drvdata(dev, hcd);

	return err;

err_put_hcd:
	usb_put_hcd(hcd);
err_power:
	if (pdata->power_off)
		pdata->power_off(dev);

	return err;
}

static int ehci_platform_remove(struct platform_device *dev)
{
	struct usb_hcd *hcd = platform_get_drvdata(dev);
	struct usb_ehci_pdata *pdata = dev->dev.platform_data;

	usb_remove_hcd(hcd);
	usb_put_hcd(hcd);
	platform_set_drvdata(dev, NULL);

	if (pdata->power_off)
		pdata->power_off(dev);

	if (pdata == &ehci_platform_defaults)
		dev->dev.platform_data = NULL;

	return 0;
}

#ifdef CONFIG_PM

static int ehci_platform_suspend(struct device *dev)
{
	struct usb_hcd *hcd = dev_get_drvdata(dev);
	struct usb_ehci_pdata *pdata = dev->platform_data;
	struct platform_device *pdev =
		container_of(dev, struct platform_device, dev);
	bool do_wakeup = device_may_wakeup(dev);
	int ret;

	ret = ehci_suspend(hcd, do_wakeup);

	if (pdata->power_suspend)
		pdata->power_suspend(pdev);

	return ret;
}

static int ehci_platform_resume(struct device *dev)
{
	struct usb_hcd *hcd = dev_get_drvdata(dev);
	struct usb_ehci_pdata *pdata = dev->platform_data;
	struct platform_device *pdev =
		container_of(dev, struct platform_device, dev);

	if (pdata->power_on) {
		int err = pdata->power_on(pdev);
		if (err < 0)
			return err;
	}

	ehci_resume(hcd, false);
	return 0;
}

#else /* !CONFIG_PM */
#define ehci_platform_suspend	NULL
#define ehci_platform_resume	NULL
#endif /* CONFIG_PM */

static const struct of_device_id vt8500_ehci_ids[] = {
	{ .compatible = "via,vt8500-ehci", },
	{ .compatible = "wm,prizm-ehci", },
	{}
};

static const struct platform_device_id ehci_platform_table[] = {
	{ "ehci-platform", 0 },
	{ }
};
MODULE_DEVICE_TABLE(platform, ehci_platform_table);

static const struct dev_pm_ops ehci_platform_pm_ops = {
	.suspend	= ehci_platform_suspend,
	.resume		= ehci_platform_resume,
};

static struct platform_driver ehci_platform_driver = {
	.id_table	= ehci_platform_table,
	.probe		= ehci_platform_probe,
	.remove		= ehci_platform_remove,
	.shutdown	= usb_hcd_platform_shutdown,
	.driver		= {
		.owner	= THIS_MODULE,
		.name	= "ehci-platform",
		.pm	= &ehci_platform_pm_ops,
		.of_match_table = of_match_ptr(vt8500_ehci_ids),
	}
};

static int __init ehci_platform_init(void)
{
	if (usb_disabled())
		return -ENODEV;

	pr_info("%s: " DRIVER_DESC "\n", hcd_name);

	ehci_init_driver(&ehci_platform_hc_driver, &platform_overrides);
	return platform_driver_register(&ehci_platform_driver);
}
module_init(ehci_platform_init);

static void __exit ehci_platform_cleanup(void)
{
	platform_driver_unregister(&ehci_platform_driver);
}
module_exit(ehci_platform_cleanup);

MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_AUTHOR("Hauke Mehrtens");
MODULE_AUTHOR("Alan Stern");
MODULE_LICENSE("GPL");
Commit	Line	Data
7a7a4a59 HM	1	/*
	2	* Generic platform ehci driver
	3	*
	4	* Copyright 2007 Steven Brown <sbrown@cortland.com>
	5	* Copyright 2010-2012 Hauke Mehrtens <hauke@hauke-m.de>
	6	*
	7	* Derived from the ohci-ssb driver
	8	* Copyright 2007 Michael Buesch <m@bues.ch>
	9	*
	10	* Derived from the EHCI-PCI driver
	11	* Copyright (c) 2000-2004 by David Brownell
	12	*
	13	* Derived from the ohci-pci driver
	14	* Copyright 1999 Roman Weissgaerber
	15	* Copyright 2000-2002 David Brownell
	16	* Copyright 1999 Linus Torvalds
	17	* Copyright 1999 Gregory P. Smith
	18	*
	19	* Licensed under the GNU/GPL. See COPYING for details.
	20	*/
f3bc64d6	21	#include <linux/dma-mapping.h>
148e1134	22	#include <linux/err.h>
99f91934	23	#include <linux/kernel.h>
d1bb67a7 AS	24	#include <linux/hrtimer.h>
d1bb67a7 AS	25	#include <linux/io.h>
99f91934	26	#include <linux/module.h>
f3bc64d6	27	#include <linux/of.h>
7a7a4a59	28	#include <linux/platform_device.h>
99f91934 AS	29	#include <linux/usb.h>
99f91934 AS	30	#include <linux/usb/hcd.h>
7a7a4a59 HM	31	#include <linux/usb/ehci_pdriver.h>
7a7a4a59 HM	32
99f91934 AS	33	#include "ehci.h"
	34
	35	#define DRIVER_DESC "EHCI generic platform driver"
	36
	37	static const char hcd_name[] = "ehci-platform";
	38
7a7a4a59 HM	39	static int ehci_platform_reset(struct usb_hcd *hcd)
	40	{
	41	struct platform_device *pdev = to_platform_device(hcd->self.controller);
	42	struct usb_ehci_pdata *pdata = pdev->dev.platform_data;
	43	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
	44	int retval;
	45
	46	hcd->has_tt = pdata->has_tt;
	47	ehci->has_synopsys_hc_bug = pdata->has_synopsys_hc_bug;
	48	ehci->big_endian_desc = pdata->big_endian_desc;
	49	ehci->big_endian_mmio = pdata->big_endian_mmio;
	50
	51	ehci->caps = hcd->regs + pdata->caps_offset;
	52	retval = ehci_setup(hcd);
	53	if (retval)
	54	return retval;
	55
4534874a FF	56	if (pdata->no_io_watchdog)
4534874a FF	57	ehci->need_io_watchdog = 0;
7a7a4a59 HM	58	return 0;
	59	}
	60
99f91934	61	static struct hc_driver __read_mostly ehci_platform_hc_driver;
7a7a4a59	62
62d08a11	63	static const struct ehci_driver_overrides platform_overrides __initconst = {
99f91934	64	.reset = ehci_platform_reset,
7a7a4a59 HM	65	};
7a7a4a59 HM	66
f3bc64d6 AB	67	static struct usb_ehci_pdata ehci_platform_defaults;
f3bc64d6 AB	68
41ac7b3a	69	static int ehci_platform_probe(struct platform_device *dev)
7a7a4a59 HM	70	{
	71	struct usb_hcd *hcd;
	72	struct resource *res_mem;
f3bc64d6	73	struct usb_ehci_pdata *pdata;
7a7a4a59 HM	74	int irq;
	75	int err = -ENOMEM;
	76
7a7a4a59 HM	77	if (usb_disabled())
	78	return -ENODEV;
	79
f3bc64d6 AB	80	/*
	81	* use reasonable defaults so platforms don't have to provide these.
	82	* with DT probing on ARM, none of these are set.
	83	*/
	84	if (!dev->dev.platform_data)
	85	dev->dev.platform_data = &ehci_platform_defaults;
	86	if (!dev->dev.dma_mask)
	87	dev->dev.dma_mask = &dev->dev.coherent_dma_mask;
	88	if (!dev->dev.coherent_dma_mask)
	89	dev->dev.coherent_dma_mask = DMA_BIT_MASK(32);
	90
	91	pdata = dev->dev.platform_data;
	92
7a7a4a59 HM	93	irq = platform_get_irq(dev, 0);
7a7a4a59 HM	94	if (irq < 0) {
2350cb0c	95	dev_err(&dev->dev, "no irq provided");
7a7a4a59 HM	96	return irq;
	97	}
	98	res_mem = platform_get_resource(dev, IORESOURCE_MEM, 0);
	99	if (!res_mem) {
5c9b2b28	100	dev_err(&dev->dev, "no memory resource provided");
7a7a4a59 HM	101	return -ENXIO;
	102	}
	103
04216bed KM	104	if (pdata->power_on) {
	105	err = pdata->power_on(dev);
	106	if (err < 0)
	107	return err;
	108	}
	109
7a7a4a59 HM	110	hcd = usb_create_hcd(&ehci_platform_hc_driver, &dev->dev,
7a7a4a59 HM	111	dev_name(&dev->dev));
04216bed KM	112	if (!hcd) {
	113	err = -ENOMEM;
	114	goto err_power;
	115	}
7a7a4a59 HM	116
	117	hcd->rsrc_start = res_mem->start;
	118	hcd->rsrc_len = resource_size(res_mem);
	119
148e1134 TR	120	hcd->regs = devm_ioremap_resource(&dev->dev, res_mem);
	121	if (IS_ERR(hcd->regs)) {
	122	err = PTR_ERR(hcd->regs);
61ff2745	123	goto err_put_hcd;
ec03ad85	124	}
7a7a4a59 HM	125	err = usb_add_hcd(hcd, irq, IRQF_SHARED);
7a7a4a59 HM	126	if (err)
61ff2745	127	goto err_put_hcd;
7a7a4a59 HM	128
	129	platform_set_drvdata(dev, hcd);
	130
	131	return err;
	132
7a7a4a59 HM	133	err_put_hcd:
7a7a4a59 HM	134	usb_put_hcd(hcd);
04216bed KM	135	err_power:
	136	if (pdata->power_off)
	137	pdata->power_off(dev);
	138
7a7a4a59 HM	139	return err;
	140	}
	141
fb4e98ab	142	static int ehci_platform_remove(struct platform_device *dev)
7a7a4a59 HM	143	{
7a7a4a59 HM	144	struct usb_hcd *hcd = platform_get_drvdata(dev);
04216bed	145	struct usb_ehci_pdata *pdata = dev->dev.platform_data;
7a7a4a59 HM	146
7a7a4a59 HM	147	usb_remove_hcd(hcd);
7a7a4a59 HM	148	usb_put_hcd(hcd);
	149	platform_set_drvdata(dev, NULL);
	150
04216bed KM	151	if (pdata->power_off)
	152	pdata->power_off(dev);
	153
f3bc64d6 AB	154	if (pdata == &ehci_platform_defaults)
	155	dev->dev.platform_data = NULL;
	156
7a7a4a59 HM	157	return 0;
	158	}
	159
	160	#ifdef CONFIG_PM
	161
	162	static int ehci_platform_suspend(struct device *dev)
	163	{
	164	struct usb_hcd *hcd = dev_get_drvdata(dev);
04216bed KM	165	struct usb_ehci_pdata *pdata = dev->platform_data;
	166	struct platform_device *pdev =
	167	container_of(dev, struct platform_device, dev);
c5cf9212	168	bool do_wakeup = device_may_wakeup(dev);
04216bed KM	169	int ret;
	170
	171	ret = ehci_suspend(hcd, do_wakeup);
7a7a4a59	172
04216bed KM	173	if (pdata->power_suspend)
	174	pdata->power_suspend(pdev);
	175
	176	return ret;
7a7a4a59 HM	177	}
	178
	179	static int ehci_platform_resume(struct device *dev)
	180	{
	181	struct usb_hcd *hcd = dev_get_drvdata(dev);
04216bed KM	182	struct usb_ehci_pdata *pdata = dev->platform_data;
	183	struct platform_device *pdev =
	184	container_of(dev, struct platform_device, dev);
	185
	186	if (pdata->power_on) {
	187	int err = pdata->power_on(pdev);
	188	if (err < 0)
	189	return err;
	190	}
7a7a4a59	191
c5cf9212	192	ehci_resume(hcd, false);
7a7a4a59 HM	193	return 0;
	194	}
	195
	196	#else /* !CONFIG_PM */
	197	#define ehci_platform_suspend NULL
	198	#define ehci_platform_resume NULL
	199	#endif /* CONFIG_PM */
	200
f3bc64d6 AB	201	static const struct of_device_id vt8500_ehci_ids[] = {
	202	{ .compatible = "via,vt8500-ehci", },
	203	{ .compatible = "wm,prizm-ehci", },
	204	{}
	205	};
	206
7a7a4a59 HM	207	static const struct platform_device_id ehci_platform_table[] = {
	208	{ "ehci-platform", 0 },
	209	{ }
	210	};
	211	MODULE_DEVICE_TABLE(platform, ehci_platform_table);
	212
	213	static const struct dev_pm_ops ehci_platform_pm_ops = {
	214	.suspend = ehci_platform_suspend,
	215	.resume = ehci_platform_resume,
	216	};
	217
	218	static struct platform_driver ehci_platform_driver = {
	219	.id_table = ehci_platform_table,
	220	.probe = ehci_platform_probe,
7690417d	221	.remove = ehci_platform_remove,
7a7a4a59 HM	222	.shutdown = usb_hcd_platform_shutdown,
	223	.driver = {
	224	.owner = THIS_MODULE,
	225	.name = "ehci-platform",
	226	.pm = &ehci_platform_pm_ops,
f3bc64d6	227	.of_match_table = of_match_ptr(vt8500_ehci_ids),
7a7a4a59 HM	228	}
7a7a4a59 HM	229	};
99f91934 AS	230
	231	static int __init ehci_platform_init(void)
	232	{
	233	if (usb_disabled())
	234	return -ENODEV;
	235
	236	pr_info("%s: " DRIVER_DESC "\n", hcd_name);
	237
	238	ehci_init_driver(&ehci_platform_hc_driver, &platform_overrides);
	239	return platform_driver_register(&ehci_platform_driver);
	240	}
	241	module_init(ehci_platform_init);
	242
	243	static void __exit ehci_platform_cleanup(void)
	244	{
	245	platform_driver_unregister(&ehci_platform_driver);
	246	}
	247	module_exit(ehci_platform_cleanup);
	248
	249	MODULE_DESCRIPTION(DRIVER_DESC);
	250	MODULE_AUTHOR("Hauke Mehrtens");
	251	MODULE_AUTHOR("Alan Stern");
	252	MODULE_LICENSE("GPL");