blob: e534f9de0f05f9bbfc20c4f9938cb29c66a31f7a [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
18#include <asm/mach-types.h>
19#include <asm/hardware.h>
David Brownell4bde4a42007-12-27 11:19:49 -080020#include <asm/gpio.h>
21
Andrew Victor39a269c2006-01-22 10:32:13 -080022#include <asm/arch/board.h>
Andrew Victored077bb2007-02-16 10:18:58 -080023#include <asm/arch/cpu.h>
Andrew Victor39a269c2006-01-22 10:32:13 -080024
David Brownell0365ee02006-06-19 14:27:20 -070025#ifndef CONFIG_ARCH_AT91
26#error "CONFIG_ARCH_AT91 must be defined."
Andrew Victor39a269c2006-01-22 10:32:13 -080027#endif
28
Andrew Victored077bb2007-02-16 10:18:58 -080029/* interface and function clocks; sometimes also an AHB clock */
30static struct clk *iclk, *fclk, *hclk;
David Brownell0365ee02006-06-19 14:27:20 -070031static int clocked;
Andrew Victor39a269c2006-01-22 10:32:13 -080032
33extern int usb_disabled(void);
34
35/*-------------------------------------------------------------------------*/
36
Andrew Victored077bb2007-02-16 10:18:58 -080037static void at91_start_clock(void)
38{
39 if (cpu_is_at91sam9261())
40 clk_enable(hclk);
41 clk_enable(iclk);
42 clk_enable(fclk);
43 clocked = 1;
44}
45
46static void at91_stop_clock(void)
47{
48 clk_disable(fclk);
49 clk_disable(iclk);
50 if (cpu_is_at91sam9261())
51 clk_disable(hclk);
52 clocked = 0;
53}
54
Andrew Victor39a269c2006-01-22 10:32:13 -080055static void at91_start_hc(struct platform_device *pdev)
56{
57 struct usb_hcd *hcd = platform_get_drvdata(pdev);
58 struct ohci_regs __iomem *regs = hcd->regs;
59
David Brownell0365ee02006-06-19 14:27:20 -070060 dev_dbg(&pdev->dev, "start\n");
Andrew Victor39a269c2006-01-22 10:32:13 -080061
62 /*
63 * Start the USB clocks.
64 */
Andrew Victored077bb2007-02-16 10:18:58 -080065 at91_start_clock();
Andrew Victor39a269c2006-01-22 10:32:13 -080066
67 /*
68 * The USB host controller must remain in reset.
69 */
70 writel(0, &regs->control);
71}
72
73static void at91_stop_hc(struct platform_device *pdev)
74{
75 struct usb_hcd *hcd = platform_get_drvdata(pdev);
76 struct ohci_regs __iomem *regs = hcd->regs;
77
David Brownell0365ee02006-06-19 14:27:20 -070078 dev_dbg(&pdev->dev, "stop\n");
Andrew Victor39a269c2006-01-22 10:32:13 -080079
80 /*
81 * Put the USB host controller into reset.
82 */
83 writel(0, &regs->control);
84
85 /*
86 * Stop the USB clocks.
87 */
Andrew Victored077bb2007-02-16 10:18:58 -080088 at91_stop_clock();
Andrew Victor39a269c2006-01-22 10:32:13 -080089}
90
91
92/*-------------------------------------------------------------------------*/
93
94static int usb_hcd_at91_remove (struct usb_hcd *, struct platform_device *);
95
96/* configure so an HC device and id are always provided */
97/* always called with process context; sleeping is OK */
98
99
100/**
David Brownell0365ee02006-06-19 14:27:20 -0700101 * usb_hcd_at91_probe - initialize AT91-based HCDs
Andrew Victor39a269c2006-01-22 10:32:13 -0800102 * Context: !in_interrupt()
103 *
104 * Allocates basic resources for this USB host controller, and
105 * then invokes the start() method for the HCD associated with it
106 * through the hotplug entry's driver_data.
Andrew Victor39a269c2006-01-22 10:32:13 -0800107 */
David Brownell0365ee02006-06-19 14:27:20 -0700108static int usb_hcd_at91_probe(const struct hc_driver *driver,
109 struct platform_device *pdev)
Andrew Victor39a269c2006-01-22 10:32:13 -0800110{
111 int retval;
112 struct usb_hcd *hcd = NULL;
113
114 if (pdev->num_resources != 2) {
115 pr_debug("hcd probe: invalid num_resources");
116 return -ENODEV;
117 }
118
David Brownell0365ee02006-06-19 14:27:20 -0700119 if ((pdev->resource[0].flags != IORESOURCE_MEM)
120 || (pdev->resource[1].flags != IORESOURCE_IRQ)) {
Andrew Victor39a269c2006-01-22 10:32:13 -0800121 pr_debug("hcd probe: invalid resource type\n");
122 return -ENODEV;
123 }
124
David Brownell0365ee02006-06-19 14:27:20 -0700125 hcd = usb_create_hcd(driver, &pdev->dev, "at91");
Andrew Victor39a269c2006-01-22 10:32:13 -0800126 if (!hcd)
127 return -ENOMEM;
128 hcd->rsrc_start = pdev->resource[0].start;
129 hcd->rsrc_len = pdev->resource[0].end - pdev->resource[0].start + 1;
130
131 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
132 pr_debug("request_mem_region failed\n");
133 retval = -EBUSY;
134 goto err1;
135 }
136
137 hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
138 if (!hcd->regs) {
139 pr_debug("ioremap failed\n");
140 retval = -EIO;
141 goto err2;
142 }
143
144 iclk = clk_get(&pdev->dev, "ohci_clk");
145 fclk = clk_get(&pdev->dev, "uhpck");
Andrew Victored077bb2007-02-16 10:18:58 -0800146 if (cpu_is_at91sam9261())
147 hclk = clk_get(&pdev->dev, "hck0");
Andrew Victor39a269c2006-01-22 10:32:13 -0800148
149 at91_start_hc(pdev);
150 ohci_hcd_init(hcd_to_ohci(hcd));
151
Thomas Gleixnerd54b5ca2006-07-01 19:29:44 -0700152 retval = usb_add_hcd(hcd, pdev->resource[1].start, IRQF_DISABLED);
Andrew Victor39a269c2006-01-22 10:32:13 -0800153 if (retval == 0)
154 return retval;
155
156 /* Error handling */
157 at91_stop_hc(pdev);
158
Andrew Victored077bb2007-02-16 10:18:58 -0800159 if (cpu_is_at91sam9261())
160 clk_put(hclk);
Andrew Victor39a269c2006-01-22 10:32:13 -0800161 clk_put(fclk);
162 clk_put(iclk);
163
164 iounmap(hcd->regs);
165
166 err2:
167 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
168
169 err1:
170 usb_put_hcd(hcd);
171 return retval;
172}
173
174
Andrew Victor39a269c2006-01-22 10:32:13 -0800175/* may be called with controller, bus, and devices active */
176
177/**
David Brownell0365ee02006-06-19 14:27:20 -0700178 * usb_hcd_at91_remove - shutdown processing for AT91-based HCDs
Andrew Victor39a269c2006-01-22 10:32:13 -0800179 * @dev: USB Host Controller being removed
180 * Context: !in_interrupt()
181 *
182 * Reverses the effect of usb_hcd_at91_probe(), first invoking
183 * the HCD's stop() method. It is always called from a thread
David Brownell0365ee02006-06-19 14:27:20 -0700184 * context, "rmmod" or something similar.
Andrew Victor39a269c2006-01-22 10:32:13 -0800185 *
186 */
David Brownell0365ee02006-06-19 14:27:20 -0700187static int usb_hcd_at91_remove(struct usb_hcd *hcd,
188 struct platform_device *pdev)
Andrew Victor39a269c2006-01-22 10:32:13 -0800189{
190 usb_remove_hcd(hcd);
191 at91_stop_hc(pdev);
192 iounmap(hcd->regs);
David Brownell68ba61b2006-04-02 20:26:21 -0800193 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
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);
202 return 0;
203}
204
205/*-------------------------------------------------------------------------*/
206
207static int __devinit
208ohci_at91_start (struct usb_hcd *hcd)
209{
David Brownell0365ee02006-06-19 14:27:20 -0700210 struct at91_usbh_data *board = hcd->self.controller->platform_data;
Andrew Victor39a269c2006-01-22 10:32:13 -0800211 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
212 int ret;
213
214 if ((ret = ohci_init(ohci)) < 0)
215 return ret;
216
David Brownellcd22afd2006-09-03 12:21:50 -0700217 ohci->num_ports = board->ports;
David Brownell0365ee02006-06-19 14:27:20 -0700218
Andrew Victor39a269c2006-01-22 10:32:13 -0800219 if ((ret = ohci_run(ohci)) < 0) {
220 err("can't start %s", hcd->self.bus_name);
221 ohci_stop(hcd);
222 return ret;
223 }
Andrew Victor39a269c2006-01-22 10:32:13 -0800224 return 0;
225}
226
227/*-------------------------------------------------------------------------*/
228
229static const struct hc_driver ohci_at91_hc_driver = {
230 .description = hcd_name,
David Brownell0365ee02006-06-19 14:27:20 -0700231 .product_desc = "AT91 OHCI",
Andrew Victor39a269c2006-01-22 10:32:13 -0800232 .hcd_priv_size = sizeof(struct ohci_hcd),
233
234 /*
235 * generic hardware linkage
236 */
237 .irq = ohci_irq,
238 .flags = HCD_USB11 | HCD_MEMORY,
239
240 /*
241 * basic lifecycle operations
242 */
243 .start = ohci_at91_start,
244 .stop = ohci_stop,
David Brownelldd9048a2006-12-05 03:18:31 -0800245 .shutdown = ohci_shutdown,
Andrew Victor39a269c2006-01-22 10:32:13 -0800246
247 /*
248 * managing i/o requests and associated device resources
249 */
250 .urb_enqueue = ohci_urb_enqueue,
251 .urb_dequeue = ohci_urb_dequeue,
252 .endpoint_disable = ohci_endpoint_disable,
253
254 /*
255 * scheduling support
256 */
257 .get_frame_number = ohci_get_frame,
258
259 /*
260 * root hub support
261 */
262 .hub_status_data = ohci_hub_status_data,
263 .hub_control = ohci_hub_control,
Linus Torvalds09ca8ad2008-07-06 10:27:25 -0700264 .hub_irq_enable = ohci_rhsc_enable,
Andrew Victor39a269c2006-01-22 10:32:13 -0800265#ifdef CONFIG_PM
David Brownell68ba61b2006-04-02 20:26:21 -0800266 .bus_suspend = ohci_bus_suspend,
267 .bus_resume = ohci_bus_resume,
Andrew Victor39a269c2006-01-22 10:32:13 -0800268#endif
269 .start_port_reset = ohci_start_port_reset,
270};
271
272/*-------------------------------------------------------------------------*/
273
David Brownell0365ee02006-06-19 14:27:20 -0700274static int ohci_hcd_at91_drv_probe(struct platform_device *pdev)
Andrew Victor39a269c2006-01-22 10:32:13 -0800275{
David Brownell4bde4a42007-12-27 11:19:49 -0800276 struct at91_usbh_data *pdata = pdev->dev.platform_data;
277 int i;
278
279 if (pdata) {
280 /* REVISIT make the driver support per-port power switching,
281 * and also overcurrent detection. Here we assume the ports
282 * are always powered while this driver is active, and use
283 * active-low power switches.
284 */
285 for (i = 0; i < pdata->ports; i++) {
286 if (pdata->vbus_pin[i] <= 0)
287 continue;
288 gpio_request(pdata->vbus_pin[i], "ohci_vbus");
289 gpio_direction_output(pdata->vbus_pin[i], 0);
290 }
291 }
292
David Brownell0365ee02006-06-19 14:27:20 -0700293 device_init_wakeup(&pdev->dev, 1);
294 return usb_hcd_at91_probe(&ohci_at91_hc_driver, pdev);
Andrew Victor39a269c2006-01-22 10:32:13 -0800295}
296
David Brownell0365ee02006-06-19 14:27:20 -0700297static int ohci_hcd_at91_drv_remove(struct platform_device *pdev)
Andrew Victor39a269c2006-01-22 10:32:13 -0800298{
David Brownell4bde4a42007-12-27 11:19:49 -0800299 struct at91_usbh_data *pdata = pdev->dev.platform_data;
300 int i;
301
302 if (pdata) {
303 for (i = 0; i < pdata->ports; i++) {
304 if (pdata->vbus_pin[i] <= 0)
305 continue;
306 gpio_direction_output(pdata->vbus_pin[i], 1);
307 gpio_free(pdata->vbus_pin[i]);
308 }
309 }
310
David Brownell0365ee02006-06-19 14:27:20 -0700311 device_init_wakeup(&pdev->dev, 0);
312 return usb_hcd_at91_remove(platform_get_drvdata(pdev), pdev);
Andrew Victor39a269c2006-01-22 10:32:13 -0800313}
314
315#ifdef CONFIG_PM
Andrew Victor39a269c2006-01-22 10:32:13 -0800316
David Brownell68ba61b2006-04-02 20:26:21 -0800317static int
David Brownell0365ee02006-06-19 14:27:20 -0700318ohci_hcd_at91_drv_suspend(struct platform_device *pdev, pm_message_t mesg)
David Brownell68ba61b2006-04-02 20:26:21 -0800319{
David Brownell0365ee02006-06-19 14:27:20 -0700320 struct usb_hcd *hcd = platform_get_drvdata(pdev);
321 struct ohci_hcd *ohci = hcd_to_ohci(hcd);
322
323 if (device_may_wakeup(&pdev->dev))
324 enable_irq_wake(hcd->irq);
David Brownell0365ee02006-06-19 14:27:20 -0700325
326 /*
327 * The integrated transceivers seem unable to notice disconnect,
328 * reconnect, or wakeup without the 48 MHz clock active. so for
329 * correctness, always discard connection state (using reset).
330 *
331 * REVISIT: some boards will be able to turn VBUS off...
332 */
333 if (at91_suspend_entering_slow_clock()) {
334 ohci_usb_reset (ohci);
Andrew Victored077bb2007-02-16 10:18:58 -0800335 at91_stop_clock();
David Brownell0365ee02006-06-19 14:27:20 -0700336 }
Andrew Victor39a269c2006-01-22 10:32:13 -0800337
338 return 0;
339}
340
David Brownell0365ee02006-06-19 14:27:20 -0700341static int ohci_hcd_at91_drv_resume(struct platform_device *pdev)
Andrew Victor39a269c2006-01-22 10:32:13 -0800342{
Marc Pignat6dde8962007-01-09 14:00:11 -0800343 struct usb_hcd *hcd = platform_get_drvdata(pdev);
344
345 if (device_may_wakeup(&pdev->dev))
346 disable_irq_wake(hcd->irq);
347
Andrew Victored077bb2007-02-16 10:18:58 -0800348 if (!clocked)
349 at91_start_clock();
Andrew Victor39a269c2006-01-22 10:32:13 -0800350
Alan Stern43bbb7e2008-04-03 18:03:17 -0400351 ohci_finish_controller_resume(hcd);
Andrew Victor39a269c2006-01-22 10:32:13 -0800352 return 0;
353}
354#else
355#define ohci_hcd_at91_drv_suspend NULL
356#define ohci_hcd_at91_drv_resume NULL
357#endif
358
Kay Sieversf4fce612008-04-10 21:29:22 -0700359MODULE_ALIAS("platform:at91_ohci");
David Brownell68ba61b2006-04-02 20:26:21 -0800360
Andrew Victor39a269c2006-01-22 10:32:13 -0800361static struct platform_driver ohci_hcd_at91_driver = {
362 .probe = ohci_hcd_at91_drv_probe,
363 .remove = ohci_hcd_at91_drv_remove,
Aleksey Gorelov64a21d02006-08-08 17:24:08 -0700364 .shutdown = usb_hcd_platform_shutdown,
Andrew Victor39a269c2006-01-22 10:32:13 -0800365 .suspend = ohci_hcd_at91_drv_suspend,
366 .resume = ohci_hcd_at91_drv_resume,
367 .driver = {
David Brownell0365ee02006-06-19 14:27:20 -0700368 .name = "at91_ohci",
Andrew Victor39a269c2006-01-22 10:32:13 -0800369 .owner = THIS_MODULE,
370 },
371};