[deliverable/linux.git] / drivers / usb / host / ehci-atmel.c

/*
 * Driver for EHCI UHP on Atmel chips
 *
 *  Copyright (C) 2009 Atmel Corporation,
 *                     Nicolas Ferre <nicolas.ferre@atmel.com>
 *
 *  Based on various ehci-*.c drivers
 *
 * This file is subject to the terms and conditions of the GNU General Public
 * License.  See the file COPYING in the main directory of this archive for
 * more details.
 */

#include <linux/clk.h>
#include <linux/dma-mapping.h>
#include <linux/io.h>
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/of_platform.h>
#include <linux/platform_device.h>
#include <linux/usb.h>
#include <linux/usb/hcd.h>

#include "ehci.h"

#define DRIVER_DESC "EHCI Atmel driver"

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

/* interface and function clocks */
#define hcd_to_atmel_ehci_priv(h) \
	((struct atmel_ehci_priv *)hcd_to_ehci(h)->priv)

struct atmel_ehci_priv {
	struct clk *iclk;
	struct clk *uclk;
	bool clocked;
};

static struct hc_driver __read_mostly ehci_atmel_hc_driver;

static const struct ehci_driver_overrides ehci_atmel_drv_overrides __initconst = {
	.extra_priv_size = sizeof(struct atmel_ehci_priv),
};

/*-------------------------------------------------------------------------*/

static void atmel_start_clock(struct atmel_ehci_priv *atmel_ehci)
{
	if (atmel_ehci->clocked)
		return;

	clk_prepare_enable(atmel_ehci->uclk);
	clk_prepare_enable(atmel_ehci->iclk);
	atmel_ehci->clocked = true;
}

static void atmel_stop_clock(struct atmel_ehci_priv *atmel_ehci)
{
	if (!atmel_ehci->clocked)
		return;

	clk_disable_unprepare(atmel_ehci->iclk);
	clk_disable_unprepare(atmel_ehci->uclk);
	atmel_ehci->clocked = false;
}

static void atmel_start_ehci(struct platform_device *pdev)
{
	struct usb_hcd *hcd = platform_get_drvdata(pdev);
	struct atmel_ehci_priv *atmel_ehci = hcd_to_atmel_ehci_priv(hcd);

	dev_dbg(&pdev->dev, "start\n");
	atmel_start_clock(atmel_ehci);
}

static void atmel_stop_ehci(struct platform_device *pdev)
{
	struct usb_hcd *hcd = platform_get_drvdata(pdev);
	struct atmel_ehci_priv *atmel_ehci = hcd_to_atmel_ehci_priv(hcd);

	dev_dbg(&pdev->dev, "stop\n");
	atmel_stop_clock(atmel_ehci);
}

/*-------------------------------------------------------------------------*/

static int ehci_atmel_drv_probe(struct platform_device *pdev)
{
	struct usb_hcd *hcd;
	const struct hc_driver *driver = &ehci_atmel_hc_driver;
	struct resource *res;
	struct ehci_hcd *ehci;
	struct atmel_ehci_priv *atmel_ehci;
	int irq;
	int retval;

	if (usb_disabled())
		return -ENODEV;

	pr_debug("Initializing Atmel-SoC USB Host Controller\n");

	irq = platform_get_irq(pdev, 0);
	if (irq <= 0) {
		dev_err(&pdev->dev,
			"Found HC with no IRQ. Check %s setup!\n",
			dev_name(&pdev->dev));
		retval = -ENODEV;
		goto fail_create_hcd;
	}

	/* Right now device-tree probed devices don't get dma_mask set.
	 * Since shared usb code relies on it, set it here for now.
	 * Once we have dma capability bindings this can go away.
	 */
	retval = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
	if (retval)
		goto fail_create_hcd;

	hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev));
	if (!hcd) {
		retval = -ENOMEM;
		goto fail_create_hcd;
	}
	atmel_ehci = hcd_to_atmel_ehci_priv(hcd);

	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	hcd->regs = devm_ioremap_resource(&pdev->dev, res);
	if (IS_ERR(hcd->regs)) {
		retval = PTR_ERR(hcd->regs);
		goto fail_request_resource;
	}

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

	atmel_ehci->iclk = devm_clk_get(&pdev->dev, "ehci_clk");
	if (IS_ERR(atmel_ehci->iclk)) {
		dev_err(&pdev->dev, "Error getting interface clock\n");
		retval = -ENOENT;
		goto fail_request_resource;
	}

	atmel_ehci->uclk = devm_clk_get(&pdev->dev, "usb_clk");
	if (IS_ERR(atmel_ehci->uclk)) {
		dev_err(&pdev->dev, "failed to get uclk\n");
		retval = PTR_ERR(atmel_ehci->uclk);
		goto fail_request_resource;
	}

	ehci = hcd_to_ehci(hcd);
	/* registers start at offset 0x0 */
	ehci->caps = hcd->regs;

	atmel_start_ehci(pdev);

	retval = usb_add_hcd(hcd, irq, IRQF_SHARED);
	if (retval)
		goto fail_add_hcd;
	device_wakeup_enable(hcd->self.controller);

	return retval;

fail_add_hcd:
	atmel_stop_ehci(pdev);
fail_request_resource:
	usb_put_hcd(hcd);
fail_create_hcd:
	dev_err(&pdev->dev, "init %s fail, %d\n",
		dev_name(&pdev->dev), retval);

	return retval;
}

static int ehci_atmel_drv_remove(struct platform_device *pdev)
{
	struct usb_hcd *hcd = platform_get_drvdata(pdev);

	usb_remove_hcd(hcd);
	usb_put_hcd(hcd);

	atmel_stop_ehci(pdev);

	return 0;
}

static int __maybe_unused ehci_atmel_drv_suspend(struct device *dev)
{
	struct usb_hcd *hcd = dev_get_drvdata(dev);
	struct atmel_ehci_priv *atmel_ehci = hcd_to_atmel_ehci_priv(hcd);
	int ret;

	ret = ehci_suspend(hcd, false);
	if (ret)
		return ret;

	atmel_stop_clock(atmel_ehci);
	return 0;
}

static int __maybe_unused ehci_atmel_drv_resume(struct device *dev)
{
	struct usb_hcd *hcd = dev_get_drvdata(dev);
	struct atmel_ehci_priv *atmel_ehci = hcd_to_atmel_ehci_priv(hcd);

	atmel_start_clock(atmel_ehci);
	return ehci_resume(hcd, false);
}

#ifdef CONFIG_OF
static const struct of_device_id atmel_ehci_dt_ids[] = {
	{ .compatible = "atmel,at91sam9g45-ehci" },
	{ /* sentinel */ }
};

MODULE_DEVICE_TABLE(of, atmel_ehci_dt_ids);
#endif

static SIMPLE_DEV_PM_OPS(ehci_atmel_pm_ops, ehci_atmel_drv_suspend,
					ehci_atmel_drv_resume);

static struct platform_driver ehci_atmel_driver = {
	.probe		= ehci_atmel_drv_probe,
	.remove		= ehci_atmel_drv_remove,
	.shutdown	= usb_hcd_platform_shutdown,
	.driver		= {
		.name	= "atmel-ehci",
		.pm	= &ehci_atmel_pm_ops,
		.of_match_table	= of_match_ptr(atmel_ehci_dt_ids),
	},
};

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

	pr_info("%s: " DRIVER_DESC "\n", hcd_name);
	ehci_init_driver(&ehci_atmel_hc_driver, &ehci_atmel_drv_overrides);
	return platform_driver_register(&ehci_atmel_driver);
}
module_init(ehci_atmel_init);

static void __exit ehci_atmel_cleanup(void)
{
	platform_driver_unregister(&ehci_atmel_driver);
}
module_exit(ehci_atmel_cleanup);

MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_ALIAS("platform:atmel-ehci");
MODULE_AUTHOR("Nicolas Ferre");
MODULE_LICENSE("GPL");
Commit	Line	Data
501c9c08 NF	1	/*
	2	* Driver for EHCI UHP on Atmel chips
	3	*
	4	* Copyright (C) 2009 Atmel Corporation,
	5	* Nicolas Ferre <nicolas.ferre@atmel.com>
	6	*
	7	* Based on various ehci-*.c drivers
	8	*
	9	* This file is subject to the terms and conditions of the GNU General Public
	10	* License. See the file COPYING in the main directory of this archive for
	11	* more details.
	12	*/
	13
	14	#include <linux/clk.h>
97736961 MG	15	#include <linux/dma-mapping.h>
	16	#include <linux/io.h>
	17	#include <linux/kernel.h>
	18	#include <linux/module.h>
9475375a	19	#include <linux/of.h>
9d843003	20	#include <linux/of_platform.h>
97736961 MG	21	#include <linux/platform_device.h>
	22	#include <linux/usb.h>
	23	#include <linux/usb/hcd.h>
	24
	25	#include "ehci.h"
	26
	27	#define DRIVER_DESC "EHCI Atmel driver"
	28
	29	static const char hcd_name[] = "ehci-atmel";
501c9c08 NF	30
501c9c08 NF	31	/* interface and function clocks */
7baddacb SR	32	#define hcd_to_atmel_ehci_priv(h) \
	33	((struct atmel_ehci_priv *)hcd_to_ehci(h)->priv)
	34
	35	struct atmel_ehci_priv {
	36	struct clk *iclk;
7baddacb SR	37	struct clk *uclk;
	38	bool clocked;
	39	};
	40
	41	static struct hc_driver __read_mostly ehci_atmel_hc_driver;
	42
	43	static const struct ehci_driver_overrides ehci_atmel_drv_overrides __initconst = {
	44	.extra_priv_size = sizeof(struct atmel_ehci_priv),
	45	};
501c9c08 NF	46
	47	/-------------------------------------------------------------------------/
	48
7baddacb	49	static void atmel_start_clock(struct atmel_ehci_priv *atmel_ehci)
501c9c08	50	{
7baddacb	51	if (atmel_ehci->clocked)
ca2c1dc0	52	return;
e32643a7 BB	53
e32643a7 BB	54	clk_prepare_enable(atmel_ehci->uclk);
7baddacb	55	clk_prepare_enable(atmel_ehci->iclk);
7baddacb	56	atmel_ehci->clocked = true;
501c9c08 NF	57	}
501c9c08 NF	58
7baddacb	59	static void atmel_stop_clock(struct atmel_ehci_priv *atmel_ehci)
501c9c08	60	{
7baddacb	61	if (!atmel_ehci->clocked)
ca2c1dc0	62	return;
e32643a7	63
7baddacb	64	clk_disable_unprepare(atmel_ehci->iclk);
e32643a7	65	clk_disable_unprepare(atmel_ehci->uclk);
7baddacb	66	atmel_ehci->clocked = false;
501c9c08 NF	67	}
	68
	69	static void atmel_start_ehci(struct platform_device *pdev)
	70	{
7baddacb SR	71	struct usb_hcd *hcd = platform_get_drvdata(pdev);
	72	struct atmel_ehci_priv *atmel_ehci = hcd_to_atmel_ehci_priv(hcd);
	73
501c9c08	74	dev_dbg(&pdev->dev, "start\n");
7baddacb	75	atmel_start_clock(atmel_ehci);
501c9c08 NF	76	}
	77
	78	static void atmel_stop_ehci(struct platform_device *pdev)
	79	{
7baddacb SR	80	struct usb_hcd *hcd = platform_get_drvdata(pdev);
	81	struct atmel_ehci_priv *atmel_ehci = hcd_to_atmel_ehci_priv(hcd);
	82
501c9c08	83	dev_dbg(&pdev->dev, "stop\n");
7baddacb	84	atmel_stop_clock(atmel_ehci);
501c9c08 NF	85	}
	86
	87	/-------------------------------------------------------------------------/
	88
41ac7b3a	89	static int ehci_atmel_drv_probe(struct platform_device *pdev)
501c9c08 NF	90	{
	91	struct usb_hcd *hcd;
	92	const struct hc_driver *driver = &ehci_atmel_hc_driver;
	93	struct resource *res;
97736961	94	struct ehci_hcd *ehci;
7baddacb	95	struct atmel_ehci_priv *atmel_ehci;
501c9c08 NF	96	int irq;
	97	int retval;
	98
	99	if (usb_disabled())
	100	return -ENODEV;
	101
	102	pr_debug("Initializing Atmel-SoC USB Host Controller\n");
	103
	104	irq = platform_get_irq(pdev, 0);
	105	if (irq <= 0) {
	106	dev_err(&pdev->dev,
	107	"Found HC with no IRQ. Check %s setup!\n",
	108	dev_name(&pdev->dev));
	109	retval = -ENODEV;
	110	goto fail_create_hcd;
	111	}
	112
9d843003 JCPV	113	/* Right now device-tree probed devices don't get dma_mask set.
	114	* Since shared usb code relies on it, set it here for now.
	115	* Once we have dma capability bindings this can go away.
	116	*/
e1fd7341	117	retval = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
22d9d8e8 RK	118	if (retval)
22d9d8e8 RK	119	goto fail_create_hcd;
9d843003	120
501c9c08 NF	121	hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev));
	122	if (!hcd) {
	123	retval = -ENOMEM;
	124	goto fail_create_hcd;
	125	}
7baddacb	126	atmel_ehci = hcd_to_atmel_ehci_priv(hcd);
501c9c08 NF	127
501c9c08 NF	128	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
148e1134 TR	129	hcd->regs = devm_ioremap_resource(&pdev->dev, res);
	130	if (IS_ERR(hcd->regs)) {
	131	retval = PTR_ERR(hcd->regs);
97983431	132	goto fail_request_resource;
501c9c08 NF	133	}
501c9c08 NF	134
0fb5f700 VB	135	hcd->rsrc_start = res->start;
	136	hcd->rsrc_len = resource_size(res);
	137
7baddacb SR	138	atmel_ehci->iclk = devm_clk_get(&pdev->dev, "ehci_clk");
7baddacb SR	139	if (IS_ERR(atmel_ehci->iclk)) {
501c9c08 NF	140	dev_err(&pdev->dev, "Error getting interface clock\n");
501c9c08 NF	141	retval = -ENOENT;
97983431	142	goto fail_request_resource;
501c9c08	143	}
e32643a7 BB	144
	145	atmel_ehci->uclk = devm_clk_get(&pdev->dev, "usb_clk");
	146	if (IS_ERR(atmel_ehci->uclk)) {
	147	dev_err(&pdev->dev, "failed to get uclk\n");
	148	retval = PTR_ERR(atmel_ehci->uclk);
97983431	149	goto fail_request_resource;
501c9c08 NF	150	}
501c9c08 NF	151
97736961 MG	152	ehci = hcd_to_ehci(hcd);
	153	/* registers start at offset 0x0 */
	154	ehci->caps = hcd->regs;
	155
501c9c08 NF	156	atmel_start_ehci(pdev);
	157
	158	retval = usb_add_hcd(hcd, irq, IRQF_SHARED);
	159	if (retval)
	160	goto fail_add_hcd;
3c9740a1	161	device_wakeup_enable(hcd->self.controller);
501c9c08 NF	162
	163	return retval;
	164
	165	fail_add_hcd:
	166	atmel_stop_ehci(pdev);
501c9c08 NF	167	fail_request_resource:
	168	usb_put_hcd(hcd);
	169	fail_create_hcd:
	170	dev_err(&pdev->dev, "init %s fail, %d\n",
	171	dev_name(&pdev->dev), retval);
	172
	173	return retval;
	174	}
	175
fb4e98ab	176	static int ehci_atmel_drv_remove(struct platform_device *pdev)
501c9c08 NF	177	{
	178	struct usb_hcd *hcd = platform_get_drvdata(pdev);
	179
501c9c08	180	usb_remove_hcd(hcd);
501c9c08 NF	181	usb_put_hcd(hcd);
	182
	183	atmel_stop_ehci(pdev);
501c9c08 NF	184
	185	return 0;
	186	}
	187
9fc7c85d	188	static int __maybe_unused ehci_atmel_drv_suspend(struct device *dev)
ca2c1dc0 SR	189	{
ca2c1dc0 SR	190	struct usb_hcd *hcd = dev_get_drvdata(dev);
7baddacb	191	struct atmel_ehci_priv *atmel_ehci = hcd_to_atmel_ehci_priv(hcd);
ca2c1dc0 SR	192	int ret;
	193
	194	ret = ehci_suspend(hcd, false);
	195	if (ret)
	196	return ret;
	197
7baddacb	198	atmel_stop_clock(atmel_ehci);
ca2c1dc0 SR	199	return 0;
	200	}
	201
9fc7c85d	202	static int __maybe_unused ehci_atmel_drv_resume(struct device *dev)
ca2c1dc0 SR	203	{
ca2c1dc0 SR	204	struct usb_hcd *hcd = dev_get_drvdata(dev);
7baddacb	205	struct atmel_ehci_priv *atmel_ehci = hcd_to_atmel_ehci_priv(hcd);
ca2c1dc0	206
7baddacb	207	atmel_start_clock(atmel_ehci);
ca2c1dc0 SR	208	return ehci_resume(hcd, false);
ca2c1dc0 SR	209	}
ca2c1dc0	210
9d843003 JCPV	211	#ifdef CONFIG_OF
	212	static const struct of_device_id atmel_ehci_dt_ids[] = {
	213	{ .compatible = "atmel,at91sam9g45-ehci" },
	214	{ /* sentinel */ }
	215	};
	216
	217	MODULE_DEVICE_TABLE(of, atmel_ehci_dt_ids);
	218	#endif
	219
ca2c1dc0 SR	220	static SIMPLE_DEV_PM_OPS(ehci_atmel_pm_ops, ehci_atmel_drv_suspend,
	221	ehci_atmel_drv_resume);
	222
501c9c08 NF	223	static struct platform_driver ehci_atmel_driver = {
501c9c08 NF	224	.probe = ehci_atmel_drv_probe,
7690417d	225	.remove = ehci_atmel_drv_remove,
501c9c08	226	.shutdown = usb_hcd_platform_shutdown,
9d843003 JCPV	227	.driver = {
9d843003 JCPV	228	.name = "atmel-ehci",
ca2c1dc0	229	.pm = &ehci_atmel_pm_ops,
9d843003 JCPV	230	.of_match_table = of_match_ptr(atmel_ehci_dt_ids),
9d843003 JCPV	231	},
501c9c08	232	};
97736961 MG	233
	234	static int __init ehci_atmel_init(void)
	235	{
	236	if (usb_disabled())
	237	return -ENODEV;
	238
	239	pr_info("%s: " DRIVER_DESC "\n", hcd_name);
7baddacb	240	ehci_init_driver(&ehci_atmel_hc_driver, &ehci_atmel_drv_overrides);
97736961 MG	241	return platform_driver_register(&ehci_atmel_driver);
	242	}
	243	module_init(ehci_atmel_init);
	244
	245	static void __exit ehci_atmel_cleanup(void)
	246	{
	247	platform_driver_unregister(&ehci_atmel_driver);
	248	}
	249	module_exit(ehci_atmel_cleanup);
	250
	251	MODULE_DESCRIPTION(DRIVER_DESC);
	252	MODULE_ALIAS("platform:atmel-ehci");
	253	MODULE_AUTHOR("Nicolas Ferre");
	254	MODULE_LICENSE("GPL");