[mirror_ubuntu-bionic-kernel.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;
static int clocked;

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

static void atmel_start_clock(void)
{
	clk_enable(iclk);
	clk_enable(fclk);
	clocked = 1;
}

static void atmel_stop_clock(void)
{
	clk_disable(fclk);
	clk_disable(iclk);
	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.
	 */
	if (!pdev->dev.dma_mask)
		pdev->dev.dma_mask = &pdev->dev.coherent_dma_mask;
	if (!pdev->dev.coherent_dma_mask)
		pdev->dev.coherent_dma_mask = DMA_BIT_MASK(32);

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

	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;

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