[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";
static struct hc_driver __read_mostly ehci_atmel_hc_driver;

/* interface and function clocks */
static struct clk *iclk, *fclk, *uclk;
static int clocked;

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

static void atmel_start_clock(void)
{
	if (IS_ENABLED(CONFIG_COMMON_CLK)) {
		clk_set_rate(uclk, 48000000);
		clk_prepare_enable(uclk);
	}
	clk_prepare_enable(iclk);
	clk_prepare_enable(fclk);
	clocked = 1;
}

static void atmel_stop_clock(void)
{
	clk_disable_unprepare(fclk);
	clk_disable_unprepare(iclk);
	if (IS_ENABLED(CONFIG_COMMON_CLK))
		clk_disable_unprepare(uclk);
	clocked = 0;
}

static void atmel_start_ehci(struct platform_device *pdev)
{
	dev_dbg(&pdev->dev, "start\n");
	atmel_start_clock();
}

static void atmel_stop_ehci(struct platform_device *pdev)
{
	dev_dbg(&pdev->dev, "stop\n");
	atmel_stop_clock();
}

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

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

	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	if (!res) {
		dev_err(&pdev->dev,
			"Found HC with no register addr. Check %s setup!\n",
			dev_name(&pdev->dev));
		retval = -ENODEV;
		goto fail_request_resource;
	}
	hcd->rsrc_start = res->start;
	hcd->rsrc_len = resource_size(res);

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

	iclk = devm_clk_get(&pdev->dev, "ehci_clk");
	if (IS_ERR(iclk)) {
		dev_err(&pdev->dev, "Error getting interface clock\n");
		retval = -ENOENT;
		goto fail_request_resource;
	}
	fclk = devm_clk_get(&pdev->dev, "uhpck");
	if (IS_ERR(fclk)) {
		dev_err(&pdev->dev, "Error getting function clock\n");
		retval = -ENOENT;
		goto fail_request_resource;
	}
	if (IS_ENABLED(CONFIG_COMMON_CLK)) {
		uclk = devm_clk_get(&pdev->dev, "usb_clk");
		if (IS_ERR(uclk)) {
			dev_err(&pdev->dev, "failed to get uclk\n");
			retval = PTR_ERR(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);
	fclk = iclk = NULL;

	return 0;
}

#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 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",
		.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, NULL);
	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";
	30	static struct hc_driver __read_mostly ehci_atmel_hc_driver;
501c9c08 NF	31
501c9c08 NF	32	/* interface and function clocks */
0d768fcf	33	static struct clk iclk, fclk, *uclk;
501c9c08 NF	34	static int clocked;
	35
	36	/-------------------------------------------------------------------------/
	37
	38	static void atmel_start_clock(void)
	39	{
0d768fcf BB	40	if (IS_ENABLED(CONFIG_COMMON_CLK)) {
	41	clk_set_rate(uclk, 48000000);
	42	clk_prepare_enable(uclk);
	43	}
cfafb62f BB	44	clk_prepare_enable(iclk);
cfafb62f BB	45	clk_prepare_enable(fclk);
501c9c08 NF	46	clocked = 1;
	47	}
	48
	49	static void atmel_stop_clock(void)
	50	{
cfafb62f BB	51	clk_disable_unprepare(fclk);
cfafb62f BB	52	clk_disable_unprepare(iclk);
0d768fcf BB	53	if (IS_ENABLED(CONFIG_COMMON_CLK))
0d768fcf BB	54	clk_disable_unprepare(uclk);
501c9c08 NF	55	clocked = 0;
	56	}
	57
	58	static void atmel_start_ehci(struct platform_device *pdev)
	59	{
	60	dev_dbg(&pdev->dev, "start\n");
	61	atmel_start_clock();
	62	}
	63
	64	static void atmel_stop_ehci(struct platform_device *pdev)
	65	{
	66	dev_dbg(&pdev->dev, "stop\n");
	67	atmel_stop_clock();
	68	}
	69
	70	/-------------------------------------------------------------------------/
	71
41ac7b3a	72	static int ehci_atmel_drv_probe(struct platform_device *pdev)
501c9c08 NF	73	{
	74	struct usb_hcd *hcd;
	75	const struct hc_driver *driver = &ehci_atmel_hc_driver;
	76	struct resource *res;
97736961	77	struct ehci_hcd *ehci;
501c9c08 NF	78	int irq;
	79	int retval;
	80
	81	if (usb_disabled())
	82	return -ENODEV;
	83
	84	pr_debug("Initializing Atmel-SoC USB Host Controller\n");
	85
	86	irq = platform_get_irq(pdev, 0);
	87	if (irq <= 0) {
	88	dev_err(&pdev->dev,
	89	"Found HC with no IRQ. Check %s setup!\n",
	90	dev_name(&pdev->dev));
	91	retval = -ENODEV;
	92	goto fail_create_hcd;
	93	}
	94
9d843003 JCPV	95	/* Right now device-tree probed devices don't get dma_mask set.
	96	* Since shared usb code relies on it, set it here for now.
	97	* Once we have dma capability bindings this can go away.
	98	*/
e1fd7341	99	retval = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
22d9d8e8 RK	100	if (retval)
22d9d8e8 RK	101	goto fail_create_hcd;
9d843003	102
501c9c08 NF	103	hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev));
	104	if (!hcd) {
	105	retval = -ENOMEM;
	106	goto fail_create_hcd;
	107	}
	108
	109	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	110	if (!res) {
	111	dev_err(&pdev->dev,
	112	"Found HC with no register addr. Check %s setup!\n",
	113	dev_name(&pdev->dev));
	114	retval = -ENODEV;
	115	goto fail_request_resource;
	116	}
	117	hcd->rsrc_start = res->start;
f65c3540	118	hcd->rsrc_len = resource_size(res);
501c9c08	119
148e1134 TR	120	hcd->regs = devm_ioremap_resource(&pdev->dev, res);
	121	if (IS_ERR(hcd->regs)) {
	122	retval = PTR_ERR(hcd->regs);
97983431	123	goto fail_request_resource;
501c9c08 NF	124	}
501c9c08 NF	125
97983431	126	iclk = devm_clk_get(&pdev->dev, "ehci_clk");
501c9c08 NF	127	if (IS_ERR(iclk)) {
	128	dev_err(&pdev->dev, "Error getting interface clock\n");
	129	retval = -ENOENT;
97983431	130	goto fail_request_resource;
501c9c08	131	}
97983431	132	fclk = devm_clk_get(&pdev->dev, "uhpck");
501c9c08 NF	133	if (IS_ERR(fclk)) {
	134	dev_err(&pdev->dev, "Error getting function clock\n");
	135	retval = -ENOENT;
97983431	136	goto fail_request_resource;
501c9c08	137	}
0d768fcf BB	138	if (IS_ENABLED(CONFIG_COMMON_CLK)) {
	139	uclk = devm_clk_get(&pdev->dev, "usb_clk");
	140	if (IS_ERR(uclk)) {
	141	dev_err(&pdev->dev, "failed to get uclk\n");
	142	retval = PTR_ERR(uclk);
	143	goto fail_request_resource;
	144	}
	145	}
501c9c08	146
97736961 MG	147	ehci = hcd_to_ehci(hcd);
	148	/* registers start at offset 0x0 */
	149	ehci->caps = hcd->regs;
	150
501c9c08 NF	151	atmel_start_ehci(pdev);
	152
	153	retval = usb_add_hcd(hcd, irq, IRQF_SHARED);
	154	if (retval)
	155	goto fail_add_hcd;
3c9740a1	156	device_wakeup_enable(hcd->self.controller);
501c9c08 NF	157
	158	return retval;
	159
	160	fail_add_hcd:
	161	atmel_stop_ehci(pdev);
501c9c08 NF	162	fail_request_resource:
	163	usb_put_hcd(hcd);
	164	fail_create_hcd:
	165	dev_err(&pdev->dev, "init %s fail, %d\n",
	166	dev_name(&pdev->dev), retval);
	167
	168	return retval;
	169	}
	170
fb4e98ab	171	static int ehci_atmel_drv_remove(struct platform_device *pdev)
501c9c08 NF	172	{
	173	struct usb_hcd *hcd = platform_get_drvdata(pdev);
	174
501c9c08	175	usb_remove_hcd(hcd);
501c9c08 NF	176	usb_put_hcd(hcd);
	177
	178	atmel_stop_ehci(pdev);
501c9c08 NF	179	fclk = iclk = NULL;
	180
	181	return 0;
	182	}
	183
9d843003 JCPV	184	#ifdef CONFIG_OF
	185	static const struct of_device_id atmel_ehci_dt_ids[] = {
	186	{ .compatible = "atmel,at91sam9g45-ehci" },
	187	{ /* sentinel */ }
	188	};
	189
	190	MODULE_DEVICE_TABLE(of, atmel_ehci_dt_ids);
	191	#endif
	192
501c9c08 NF	193	static struct platform_driver ehci_atmel_driver = {
501c9c08 NF	194	.probe = ehci_atmel_drv_probe,
7690417d	195	.remove = ehci_atmel_drv_remove,
501c9c08	196	.shutdown = usb_hcd_platform_shutdown,
9d843003 JCPV	197	.driver = {
	198	.name = "atmel-ehci",
	199	.of_match_table = of_match_ptr(atmel_ehci_dt_ids),
	200	},
501c9c08	201	};
97736961 MG	202
	203	static int __init ehci_atmel_init(void)
	204	{
	205	if (usb_disabled())
	206	return -ENODEV;
	207
	208	pr_info("%s: " DRIVER_DESC "\n", hcd_name);
	209	ehci_init_driver(&ehci_atmel_hc_driver, NULL);
	210	return platform_driver_register(&ehci_atmel_driver);
	211	}
	212	module_init(ehci_atmel_init);
	213
	214	static void __exit ehci_atmel_cleanup(void)
	215	{
	216	platform_driver_unregister(&ehci_atmel_driver);
	217	}
	218	module_exit(ehci_atmel_cleanup);
	219
	220	MODULE_DESCRIPTION(DRIVER_DESC);
	221	MODULE_ALIAS("platform:atmel-ehci");
	222	MODULE_AUTHOR("Nicolas Ferre");
	223	MODULE_LICENSE("GPL");