xref: /linux/drivers/usb/host/ehci-atmel.c (revision 22d9d8e8316d7f69046c8805ce9aa8d9c43d4e5b)
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>
15 #include <linux/dma-mapping.h>
16 #include <linux/io.h>
17 #include <linux/kernel.h>
18 #include <linux/module.h>
19 #include <linux/of.h>
20 #include <linux/of_platform.h>
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;
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_prepare_enable(iclk);
41 	clk_prepare_enable(fclk);
42 	clocked = 1;
43 }
44 
45 static void atmel_stop_clock(void)
46 {
47 	clk_disable_unprepare(fclk);
48 	clk_disable_unprepare(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 
66 static int ehci_atmel_drv_probe(struct platform_device *pdev)
67 {
68 	struct usb_hcd *hcd;
69 	const struct hc_driver *driver = &ehci_atmel_hc_driver;
70 	struct resource *res;
71 	struct ehci_hcd *ehci;
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 
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)
94 		pdev->dev.dma_mask = &pdev->dev.coherent_dma_mask;
95 	retval = dma_set_coherent_mask(&pdev->dev, DMA_BIT_MASK(32));
96 	if (retval)
97 		goto fail_create_hcd;
98 
99 	hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev));
100 	if (!hcd) {
101 		retval = -ENOMEM;
102 		goto fail_create_hcd;
103 	}
104 
105 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
106 	if (!res) {
107 		dev_err(&pdev->dev,
108 			"Found HC with no register addr. Check %s setup!\n",
109 			dev_name(&pdev->dev));
110 		retval = -ENODEV;
111 		goto fail_request_resource;
112 	}
113 	hcd->rsrc_start = res->start;
114 	hcd->rsrc_len = resource_size(res);
115 
116 	hcd->regs = devm_ioremap_resource(&pdev->dev, res);
117 	if (IS_ERR(hcd->regs)) {
118 		retval = PTR_ERR(hcd->regs);
119 		goto fail_request_resource;
120 	}
121 
122 	iclk = devm_clk_get(&pdev->dev, "ehci_clk");
123 	if (IS_ERR(iclk)) {
124 		dev_err(&pdev->dev, "Error getting interface clock\n");
125 		retval = -ENOENT;
126 		goto fail_request_resource;
127 	}
128 	fclk = devm_clk_get(&pdev->dev, "uhpck");
129 	if (IS_ERR(fclk)) {
130 		dev_err(&pdev->dev, "Error getting function clock\n");
131 		retval = -ENOENT;
132 		goto fail_request_resource;
133 	}
134 
135 	ehci = hcd_to_ehci(hcd);
136 	/* registers start at offset 0x0 */
137 	ehci->caps = hcd->regs;
138 
139 	atmel_start_ehci(pdev);
140 
141 	retval = usb_add_hcd(hcd, irq, IRQF_SHARED);
142 	if (retval)
143 		goto fail_add_hcd;
144 
145 	return retval;
146 
147 fail_add_hcd:
148 	atmel_stop_ehci(pdev);
149 fail_request_resource:
150 	usb_put_hcd(hcd);
151 fail_create_hcd:
152 	dev_err(&pdev->dev, "init %s fail, %d\n",
153 		dev_name(&pdev->dev), retval);
154 
155 	return retval;
156 }
157 
158 static int ehci_atmel_drv_remove(struct platform_device *pdev)
159 {
160 	struct usb_hcd *hcd = platform_get_drvdata(pdev);
161 
162 	usb_remove_hcd(hcd);
163 	usb_put_hcd(hcd);
164 
165 	atmel_stop_ehci(pdev);
166 	fclk = iclk = NULL;
167 
168 	return 0;
169 }
170 
171 #ifdef CONFIG_OF
172 static const struct of_device_id atmel_ehci_dt_ids[] = {
173 	{ .compatible = "atmel,at91sam9g45-ehci" },
174 	{ /* sentinel */ }
175 };
176 
177 MODULE_DEVICE_TABLE(of, atmel_ehci_dt_ids);
178 #endif
179 
180 static struct platform_driver ehci_atmel_driver = {
181 	.probe		= ehci_atmel_drv_probe,
182 	.remove		= ehci_atmel_drv_remove,
183 	.shutdown	= usb_hcd_platform_shutdown,
184 	.driver		= {
185 		.name	= "atmel-ehci",
186 		.of_match_table	= of_match_ptr(atmel_ehci_dt_ids),
187 	},
188 };
189 
190 static int __init ehci_atmel_init(void)
191 {
192 	if (usb_disabled())
193 		return -ENODEV;
194 
195 	pr_info("%s: " DRIVER_DESC "\n", hcd_name);
196 	ehci_init_driver(&ehci_atmel_hc_driver, NULL);
197 	return platform_driver_register(&ehci_atmel_driver);
198 }
199 module_init(ehci_atmel_init);
200 
201 static void __exit ehci_atmel_cleanup(void)
202 {
203 	platform_driver_unregister(&ehci_atmel_driver);
204 }
205 module_exit(ehci_atmel_cleanup);
206 
207 MODULE_DESCRIPTION(DRIVER_DESC);
208 MODULE_ALIAS("platform:atmel-ehci");
209 MODULE_AUTHOR("Nicolas Ferre");
210 MODULE_LICENSE("GPL");
211