blob: bb5e6f67157837691f4b22130133c4dc1283469e [file] [log] [blame]
Andrew Victor39a269c2006-01-22 10:32:13 -08001/*
2 * OHCI HCD (Host Controller Driver) for USB.
3 *
4 * Copyright (C) 2004 SAN People (Pty) Ltd.
5 * Copyright (C) 2005 Thibaut VARENE <varenet@parisc-linux.org>
6 *
David Brownell0365ee02006-06-19 14:27:20 -07007 * AT91 Bus Glue
Andrew Victor39a269c2006-01-22 10:32:13 -08008 *
9 * Based on fragments of 2.4 driver by Rick Bronson.
10 * Based on ohci-omap.c
11 *
12 * This file is licenced under the GPL.
13 */
14
15#include <linux/clk.h>
16#include <linux/platform_device.h>
17
Russell Kinga09e64f2008-08-05 16:14:15 +010018#include <mach/hardware.h>
David Brownell4bde4a42007-12-27 11:19:49 -080019#include <asm/gpio.h>
20
Russell Kinga09e64f2008-08-05 16:14:15 +010021#include <mach/board.h>
22#include <mach/cpu.h>
Andrew Victor39a269c2006-01-22 10:32:13 -080023
David Brownell0365ee02006-06-19 14:27:20 -070024#ifndef CONFIG_ARCH_AT91
25#error "CONFIG_ARCH_AT91 must be defined."
Andrew Victor39a269c2006-01-22 10:32:13 -080026#endif
27
Andrew Victored077bb2007-02-16 10:18:58 -080028/* interface and function clocks; sometimes also an AHB clock */
29static struct clk *iclk, *fclk, *hclk;
David Brownell0365ee02006-06-19 14:27:20 -070030static int clocked;
Andrew Victor39a269c2006-01-22 10:32:13 -080031
32extern int usb_disabled(void);
33
34/*-------------------------------------------------------------------------*/
35
Andrew Victored077bb2007-02-16 10:18:58 -080036static void at91_start_clock(void)
37{
38 if (cpu_is_at91sam9261())
39 clk_enable(hclk);
40 clk_enable(iclk);
41 clk_enable(fclk);
42 clocked = 1;
43}
44
45static void at91_stop_clock(void)
46{
47 clk_disable(fclk);
48 clk_disable(iclk);
49 if (cpu_is_at91sam9261())
50 clk_disable(hclk);
51 clocked = 0;
52}
53
Andrew Victor39a269c2006-01-22 10:32:13 -080054static void at91_start_hc(struct platform_device *pdev)
55{
56 struct usb_hcd *hcd = platform_get_drvdata(pdev);
57 struct ohci_regs __iomem *regs = hcd->regs;
58
David Brownell0365ee02006-06-19 14:27:20 -070059 dev_dbg(&pdev->dev, "start\n");
Andrew Victor39a269c2006-01-22 10:32:13 -080060
61 /*
62 * Start the USB clocks.
63 */
Andrew Victored077bb2007-02-16 10:18:58 -080064 at91_start_clock();
Andrew Victor39a269c2006-01-22 10:32:13 -080065
66 /*
67 * The USB host controller must remain in reset.
68 */
69 writel(0, &regs->control);
70}
71
72static void at91_stop_hc(struct platform_device *pdev)
73{
74 struct usb_hcd *hcd = platform_get_drvdata(pdev);
75 struct ohci_regs __iomem *regs = hcd->regs;
76
David Brownell0365ee02006-06-19 14:27:20 -070077 dev_dbg(&pdev->dev, "stop\n");
Andrew Victor39a269c2006-01-22 10:32:13 -080078
79 /*
80 * Put the USB host controller into reset.
81 */
82 writel(0, &regs->control);
83
84 /*
85 * Stop the USB clocks.
86 */
Andrew Victored077bb2007-02-16 10:18:58 -080087 at91_stop_clock();
Andrew Victor39a269c2006-01-22 10:32:13 -080088}
89
90
91/*-------------------------------------------------------------------------*/
92
Pete Zaitcev421b4bf2008-06-01 14:38:43 -070093static void usb_hcd_at91_remove (struct usb_hcd *, struct platform_device *);
Andrew Victor39a269c2006-01-22 10:32:13 -080094
95/* configure so an HC device and id are always provided */
96/* always called with process context; sleeping is OK */
97
98
99/**
David Brownell0365ee02006-06-19 14:27:20 -0700100 * usb_hcd_at91_probe - initialize AT91-based HCDs
Andrew Victor39a269c2006-01-22 10:32:13 -0800101 * Context: !in_interrupt()
102 *
103 * Allocates basic resources for this USB host controller, and
104 * then invokes the start() method for the HCD associated with it
105 * through the hotplug entry's driver_data.
Andrew Victor39a269c2006-01-22 10:32:13 -0800106 */
David Brownell0365ee02006-06-19 14:27:20 -0700107static int usb_hcd_at91_probe(const struct hc_driver *driver,
108 struct platform_device *pdev)
Andrew Victor39a269c2006-01-22 10:32:13 -0800109{
110 int retval;
111 struct usb_hcd *hcd = NULL;
112
113 if (pdev->num_resources != 2) {
114 pr_debug("hcd probe: invalid num_resources");
115 return -ENODEV;
116 }
117
David Brownell0365ee02006-06-19 14:27:20 -0700118 if ((pdev->resource[0].flags != IORESOURCE_MEM)
119 || (pdev->resource[1].flags != IORESOURCE_IRQ)) {
Andrew Victor39a269c2006-01-22 10:32:13 -0800120 pr_debug("hcd probe: invalid resource type\n");
121 return -ENODEV;
122 }
123
David Brownell0365ee02006-06-19 14:27:20 -0700124 hcd = usb_create_hcd(driver, &pdev->dev, "at91");
Andrew Victor39a269c2006-01-22 10:32:13 -0800125 if (!hcd)
126 return -ENOMEM;
127 hcd->rsrc_start = pdev->resource[0].start;
128 hcd->rsrc_len = pdev->resource[0].end - pdev->resource[0].start + 1;
129
130 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
131 pr_debug("request_mem_region failed\n");
132 retval = -EBUSY;
133 goto err1;
134 }
135
136 hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
137 if (!hcd->regs) {
138 pr_debug("ioremap failed\n");
139 retval = -EIO;
140 goto err2;
141 }
142
143 iclk = clk_get(&pdev->dev, "ohci_clk");
144 fclk = clk_get(&pdev->dev, "uhpck");
Andrew Victored077bb2007-02-16 10:18:58 -0800145 if (cpu_is_at91sam9261())
146 hclk = clk_get(&pdev->dev, "hck0");
Andrew Victor39a269c2006-01-22 10:32:13 -0800147
148 at91_start_hc(pdev);
149 ohci_hcd_init(hcd_to_ohci(hcd));
150
Thomas Gleixnerd54b5ca2006-07-01 19:29:44 -0700151 retval = usb_add_hcd(hcd, pdev->resource[1].start, IRQF_DISABLED);
Andrew Victor39a269c2006-01-22 10:32:13 -0800152 if (retval == 0)
153 return retval;
154
155 /* Error handling */
156 at91_stop_hc(pdev);
157
Andrew Victored077bb2007-02-16 10:18:58 -0800158 if (cpu_is_at91sam9261())
159 clk_put(hclk);
Andrew Victor39a269c2006-01-22 10:32:13 -0800160 clk_put(fclk);
161 clk_put(iclk);
162
163 iounmap(hcd->regs);
164
165 err2:
166 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
167
168 err1:
169 usb_put_hcd(hcd);
170 return retval;
171}
172
173
Andrew Victor39a269c2006-01-22 10:32:13 -0800174/* may be called with controller, bus, and devices active */
175
176/**
David Brownell0365ee02006-06-19 14:27:20 -0700177 * usb_hcd_at91_remove - shutdown processing for AT91-based HCDs
Andrew Victor39a269c2006-01-22 10:32:13 -0800178 * @dev: USB Host Controller being removed
179 * Context: !in_interrupt()
180 *
181 * Reverses the effect of usb_hcd_at91_probe(), first invoking
182 * the HCD's stop() method. It is always called from a thread
David Brownell0365ee02006-06-19 14:27:20 -0700183 * context, "rmmod" or something similar.
Andrew Victor39a269c2006-01-22 10:32:13 -0800184 *
185 */
Pete Zaitcev421b4bf2008-06-01 14:38:43 -0700186static void usb_hcd_at91_remove(struct usb_hcd *hcd,
David Brownell0365ee02006-06-19 14:27:20 -0700187 struct platform_device *pdev)
Andrew Victor39a269c2006-01-22 10:32:13 -0800188{
189 usb_remove_hcd(hcd);
190 at91_stop_hc(pdev);
191 iounmap(hcd->regs);
David Brownell68ba61b2006-04-02 20:26:21 -0800192 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
Pete Zaitcev421b4bf2008-06-01 14:38:43 -0700193 usb_put_hcd(hcd);
Andrew Victor39a269c2006-01-22 10:32:13 -0800194
Andrew Victored077bb2007-02-16 10:18:58 -0800195 if (cpu_is_at91sam9261())
196 clk_put(hclk);
David Brownell68ba61b2006-04-02 20:26:21 -0800197 clk_put(fclk);
198 clk_put(iclk);
Andrew Victored077bb2007-02-16 10:18:58 -0800199 fclk = iclk = hclk = NULL;
Andrew Victor39a269c2006-01-22 10:32:13 -0800200
201 dev_set_drvdata(&pdev->dev, NULL);
Andrew Victor39a269c2006-01-22 10:32:13 -0800202}
203
204/*-------------------------------------------------------------------------*/
205
206static int __devinit
207ohci_at91_start (struct usb_hcd *hcd)
208{
David Brownell0365ee02006-06-19 14:27:20 -0700209 struct at91_usbh_data *board = hcd->self.controller->platform_data;
Andrew Victor39a269c2006-01-22 10:32:13 -0800210 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
211 int ret;
212
213 if ((ret = ohci_init(ohci)) < 0)
214 return ret;
215
David Brownellcd22afd2006-09-03 12:21:50 -0700216 ohci->num_ports = board->ports;
David Brownell0365ee02006-06-19 14:27:20 -0700217
Andrew Victor39a269c2006-01-22 10:32:13 -0800218 if ((ret = ohci_run(ohci)) < 0) {
219 err("can't start %s", hcd->self.bus_name);
220 ohci_stop(hcd);
221 return ret;
222 }
Andrew Victor39a269c2006-01-22 10:32:13 -0800223 return 0;
224}
225
226/*-------------------------------------------------------------------------*/
227
228static const struct hc_driver ohci_at91_hc_driver = {
229 .description = hcd_name,
David Brownell0365ee02006-06-19 14:27:20 -0700230 .product_desc = "AT91 OHCI",
Andrew Victor39a269c2006-01-22 10:32:13 -0800231 .hcd_priv_size = sizeof(struct ohci_hcd),
232
233 /*
234 * generic hardware linkage
235 */
236 .irq = ohci_irq,
237 .flags = HCD_USB11 | HCD_MEMORY,
238
239 /*
240 * basic lifecycle operations
241 */
242 .start = ohci_at91_start,
243 .stop = ohci_stop,
David Brownelldd9048a2006-12-05 03:18:31 -0800244 .shutdown = ohci_shutdown,
Andrew Victor39a269c2006-01-22 10:32:13 -0800245
246 /*
247 * managing i/o requests and associated device resources
248 */
249 .urb_enqueue = ohci_urb_enqueue,
250 .urb_dequeue = ohci_urb_dequeue,
251 .endpoint_disable = ohci_endpoint_disable,
252
253 /*
254 * scheduling support
255 */
256 .get_frame_number = ohci_get_frame,
257
258 /*
259 * root hub support
260 */
261 .hub_status_data = ohci_hub_status_data,
262 .hub_control = ohci_hub_control,
Andrew Victor39a269c2006-01-22 10:32:13 -0800263#ifdef CONFIG_PM
David Brownell68ba61b2006-04-02 20:26:21 -0800264 .bus_suspend = ohci_bus_suspend,
265 .bus_resume = ohci_bus_resume,
Andrew Victor39a269c2006-01-22 10:32:13 -0800266#endif
267 .start_port_reset = ohci_start_port_reset,
268};
269
270/*-------------------------------------------------------------------------*/
271
David Brownell0365ee02006-06-19 14:27:20 -0700272static int ohci_hcd_at91_drv_probe(struct platform_device *pdev)
Andrew Victor39a269c2006-01-22 10:32:13 -0800273{
David Brownell4bde4a42007-12-27 11:19:49 -0800274 struct at91_usbh_data *pdata = pdev->dev.platform_data;
275 int i;
276
277 if (pdata) {
278 /* REVISIT make the driver support per-port power switching,
279 * and also overcurrent detection. Here we assume the ports
280 * are always powered while this driver is active, and use
281 * active-low power switches.
282 */
Justin Waters3d6fdf72009-04-03 21:06:53 +0100283 for (i = 0; i < ARRAY_SIZE(pdata->vbus_pin); i++) {
David Brownell4bde4a42007-12-27 11:19:49 -0800284 if (pdata->vbus_pin[i] <= 0)
285 continue;
286 gpio_request(pdata->vbus_pin[i], "ohci_vbus");
287 gpio_direction_output(pdata->vbus_pin[i], 0);
288 }
289 }
290
David Brownell0365ee02006-06-19 14:27:20 -0700291 device_init_wakeup(&pdev->dev, 1);
292 return usb_hcd_at91_probe(&ohci_at91_hc_driver, pdev);
Andrew Victor39a269c2006-01-22 10:32:13 -0800293}
294
David Brownell0365ee02006-06-19 14:27:20 -0700295static int ohci_hcd_at91_drv_remove(struct platform_device *pdev)
Andrew Victor39a269c2006-01-22 10:32:13 -0800296{
David Brownell4bde4a42007-12-27 11:19:49 -0800297 struct at91_usbh_data *pdata = pdev->dev.platform_data;
298 int i;
299
300 if (pdata) {
Justin Waters3d6fdf72009-04-03 21:06:53 +0100301 for (i = 0; i < ARRAY_SIZE(pdata->vbus_pin); i++) {
David Brownell4bde4a42007-12-27 11:19:49 -0800302 if (pdata->vbus_pin[i] <= 0)
303 continue;
304 gpio_direction_output(pdata->vbus_pin[i], 1);
305 gpio_free(pdata->vbus_pin[i]);
306 }
307 }
308
David Brownell0365ee02006-06-19 14:27:20 -0700309 device_init_wakeup(&pdev->dev, 0);
Pete Zaitcev421b4bf2008-06-01 14:38:43 -0700310 usb_hcd_at91_remove(platform_get_drvdata(pdev), pdev);
311 return 0;
Andrew Victor39a269c2006-01-22 10:32:13 -0800312}
313
314#ifdef CONFIG_PM
Andrew Victor39a269c2006-01-22 10:32:13 -0800315
David Brownell68ba61b2006-04-02 20:26:21 -0800316static int
David Brownell0365ee02006-06-19 14:27:20 -0700317ohci_hcd_at91_drv_suspend(struct platform_device *pdev, pm_message_t mesg)
David Brownell68ba61b2006-04-02 20:26:21 -0800318{
David Brownell0365ee02006-06-19 14:27:20 -0700319 struct usb_hcd *hcd = platform_get_drvdata(pdev);
320 struct ohci_hcd *ohci = hcd_to_ohci(hcd);
321
322 if (device_may_wakeup(&pdev->dev))
323 enable_irq_wake(hcd->irq);
David Brownell0365ee02006-06-19 14:27:20 -0700324
325 /*
326 * The integrated transceivers seem unable to notice disconnect,
327 * reconnect, or wakeup without the 48 MHz clock active. so for
328 * correctness, always discard connection state (using reset).
329 *
330 * REVISIT: some boards will be able to turn VBUS off...
331 */
332 if (at91_suspend_entering_slow_clock()) {
333 ohci_usb_reset (ohci);
Andrew Victored077bb2007-02-16 10:18:58 -0800334 at91_stop_clock();
David Brownell0365ee02006-06-19 14:27:20 -0700335 }
Andrew Victor39a269c2006-01-22 10:32:13 -0800336
337 return 0;
338}
339
David Brownell0365ee02006-06-19 14:27:20 -0700340static int ohci_hcd_at91_drv_resume(struct platform_device *pdev)
Andrew Victor39a269c2006-01-22 10:32:13 -0800341{
Marc Pignat6dde8962007-01-09 14:00:11 -0800342 struct usb_hcd *hcd = platform_get_drvdata(pdev);
343
344 if (device_may_wakeup(&pdev->dev))
345 disable_irq_wake(hcd->irq);
346
Andrew Victored077bb2007-02-16 10:18:58 -0800347 if (!clocked)
348 at91_start_clock();
Andrew Victor39a269c2006-01-22 10:32:13 -0800349
Alan Stern43bbb7e2008-04-03 18:03:17 -0400350 ohci_finish_controller_resume(hcd);
Andrew Victor39a269c2006-01-22 10:32:13 -0800351 return 0;
352}
353#else
354#define ohci_hcd_at91_drv_suspend NULL
355#define ohci_hcd_at91_drv_resume NULL
356#endif
357
Kay Sieversf4fce612008-04-10 21:29:22 -0700358MODULE_ALIAS("platform:at91_ohci");
David Brownell68ba61b2006-04-02 20:26:21 -0800359
Andrew Victor39a269c2006-01-22 10:32:13 -0800360static struct platform_driver ohci_hcd_at91_driver = {
361 .probe = ohci_hcd_at91_drv_probe,
362 .remove = ohci_hcd_at91_drv_remove,
Aleksey Gorelov64a21d02006-08-08 17:24:08 -0700363 .shutdown = usb_hcd_platform_shutdown,
Andrew Victor39a269c2006-01-22 10:32:13 -0800364 .suspend = ohci_hcd_at91_drv_suspend,
365 .resume = ohci_hcd_at91_drv_resume,
366 .driver = {
David Brownell0365ee02006-06-19 14:27:20 -0700367 .name = "at91_ohci",
Andrew Victor39a269c2006-01-22 10:32:13 -0800368 .owner = THIS_MODULE,
369 },
370};