blob: f15c84ea28691178c721cb51657c65987b039a71 [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>
20#include <asm/arch/board.h>
21
David Brownell0365ee02006-06-19 14:27:20 -070022#ifndef CONFIG_ARCH_AT91
23#error "CONFIG_ARCH_AT91 must be defined."
Andrew Victor39a269c2006-01-22 10:32:13 -080024#endif
25
26/* interface and function clocks */
27static struct clk *iclk, *fclk;
David Brownell0365ee02006-06-19 14:27:20 -070028static int clocked;
Andrew Victor39a269c2006-01-22 10:32:13 -080029
30extern int usb_disabled(void);
31
32/*-------------------------------------------------------------------------*/
33
34static void at91_start_hc(struct platform_device *pdev)
35{
36 struct usb_hcd *hcd = platform_get_drvdata(pdev);
37 struct ohci_regs __iomem *regs = hcd->regs;
38
David Brownell0365ee02006-06-19 14:27:20 -070039 dev_dbg(&pdev->dev, "start\n");
Andrew Victor39a269c2006-01-22 10:32:13 -080040
41 /*
42 * Start the USB clocks.
43 */
44 clk_enable(iclk);
45 clk_enable(fclk);
David Brownell0365ee02006-06-19 14:27:20 -070046 clocked = 1;
Andrew Victor39a269c2006-01-22 10:32:13 -080047
48 /*
49 * The USB host controller must remain in reset.
50 */
51 writel(0, &regs->control);
52}
53
54static void at91_stop_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, "stop\n");
Andrew Victor39a269c2006-01-22 10:32:13 -080060
61 /*
62 * Put the USB host controller into reset.
63 */
64 writel(0, &regs->control);
65
66 /*
67 * Stop the USB clocks.
68 */
69 clk_disable(fclk);
70 clk_disable(iclk);
David Brownell0365ee02006-06-19 14:27:20 -070071 clocked = 0;
Andrew Victor39a269c2006-01-22 10:32:13 -080072}
73
74
75/*-------------------------------------------------------------------------*/
76
77static int usb_hcd_at91_remove (struct usb_hcd *, struct platform_device *);
78
79/* configure so an HC device and id are always provided */
80/* always called with process context; sleeping is OK */
81
82
83/**
David Brownell0365ee02006-06-19 14:27:20 -070084 * usb_hcd_at91_probe - initialize AT91-based HCDs
Andrew Victor39a269c2006-01-22 10:32:13 -080085 * Context: !in_interrupt()
86 *
87 * Allocates basic resources for this USB host controller, and
88 * then invokes the start() method for the HCD associated with it
89 * through the hotplug entry's driver_data.
Andrew Victor39a269c2006-01-22 10:32:13 -080090 */
David Brownell0365ee02006-06-19 14:27:20 -070091static int usb_hcd_at91_probe(const struct hc_driver *driver,
92 struct platform_device *pdev)
Andrew Victor39a269c2006-01-22 10:32:13 -080093{
94 int retval;
95 struct usb_hcd *hcd = NULL;
96
97 if (pdev->num_resources != 2) {
98 pr_debug("hcd probe: invalid num_resources");
99 return -ENODEV;
100 }
101
David Brownell0365ee02006-06-19 14:27:20 -0700102 if ((pdev->resource[0].flags != IORESOURCE_MEM)
103 || (pdev->resource[1].flags != IORESOURCE_IRQ)) {
Andrew Victor39a269c2006-01-22 10:32:13 -0800104 pr_debug("hcd probe: invalid resource type\n");
105 return -ENODEV;
106 }
107
David Brownell0365ee02006-06-19 14:27:20 -0700108 hcd = usb_create_hcd(driver, &pdev->dev, "at91");
Andrew Victor39a269c2006-01-22 10:32:13 -0800109 if (!hcd)
110 return -ENOMEM;
111 hcd->rsrc_start = pdev->resource[0].start;
112 hcd->rsrc_len = pdev->resource[0].end - pdev->resource[0].start + 1;
113
114 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
115 pr_debug("request_mem_region failed\n");
116 retval = -EBUSY;
117 goto err1;
118 }
119
120 hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
121 if (!hcd->regs) {
122 pr_debug("ioremap failed\n");
123 retval = -EIO;
124 goto err2;
125 }
126
127 iclk = clk_get(&pdev->dev, "ohci_clk");
128 fclk = clk_get(&pdev->dev, "uhpck");
129
130 at91_start_hc(pdev);
131 ohci_hcd_init(hcd_to_ohci(hcd));
132
Thomas Gleixnerd54b5ca2006-07-01 19:29:44 -0700133 retval = usb_add_hcd(hcd, pdev->resource[1].start, IRQF_DISABLED);
Andrew Victor39a269c2006-01-22 10:32:13 -0800134 if (retval == 0)
135 return retval;
136
137 /* Error handling */
138 at91_stop_hc(pdev);
139
140 clk_put(fclk);
141 clk_put(iclk);
142
143 iounmap(hcd->regs);
144
145 err2:
146 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
147
148 err1:
149 usb_put_hcd(hcd);
150 return retval;
151}
152
153
Andrew Victor39a269c2006-01-22 10:32:13 -0800154/* may be called with controller, bus, and devices active */
155
156/**
David Brownell0365ee02006-06-19 14:27:20 -0700157 * usb_hcd_at91_remove - shutdown processing for AT91-based HCDs
Andrew Victor39a269c2006-01-22 10:32:13 -0800158 * @dev: USB Host Controller being removed
159 * Context: !in_interrupt()
160 *
161 * Reverses the effect of usb_hcd_at91_probe(), first invoking
162 * the HCD's stop() method. It is always called from a thread
David Brownell0365ee02006-06-19 14:27:20 -0700163 * context, "rmmod" or something similar.
Andrew Victor39a269c2006-01-22 10:32:13 -0800164 *
165 */
David Brownell0365ee02006-06-19 14:27:20 -0700166static int usb_hcd_at91_remove(struct usb_hcd *hcd,
167 struct platform_device *pdev)
Andrew Victor39a269c2006-01-22 10:32:13 -0800168{
169 usb_remove_hcd(hcd);
170 at91_stop_hc(pdev);
171 iounmap(hcd->regs);
David Brownell68ba61b2006-04-02 20:26:21 -0800172 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
David Brownell0365ee02006-06-19 14:27:20 -0700173 disable_irq_wake(hcd->irq);
Andrew Victor39a269c2006-01-22 10:32:13 -0800174
David Brownell68ba61b2006-04-02 20:26:21 -0800175 clk_put(fclk);
176 clk_put(iclk);
177 fclk = iclk = NULL;
Andrew Victor39a269c2006-01-22 10:32:13 -0800178
179 dev_set_drvdata(&pdev->dev, NULL);
180 return 0;
181}
182
183/*-------------------------------------------------------------------------*/
184
185static int __devinit
186ohci_at91_start (struct usb_hcd *hcd)
187{
David Brownell0365ee02006-06-19 14:27:20 -0700188 struct at91_usbh_data *board = hcd->self.controller->platform_data;
Andrew Victor39a269c2006-01-22 10:32:13 -0800189 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
David Brownell0365ee02006-06-19 14:27:20 -0700190 struct usb_device *root = hcd->self.root_hub;
Andrew Victor39a269c2006-01-22 10:32:13 -0800191 int ret;
192
193 if ((ret = ohci_init(ohci)) < 0)
194 return ret;
195
David Brownellcd22afd2006-09-03 12:21:50 -0700196 ohci->num_ports = board->ports;
David Brownell0365ee02006-06-19 14:27:20 -0700197
Andrew Victor39a269c2006-01-22 10:32:13 -0800198 if ((ret = ohci_run(ohci)) < 0) {
199 err("can't start %s", hcd->self.bus_name);
200 ohci_stop(hcd);
201 return ret;
202 }
Andrew Victor39a269c2006-01-22 10:32:13 -0800203 return 0;
204}
205
206/*-------------------------------------------------------------------------*/
207
208static const struct hc_driver ohci_at91_hc_driver = {
209 .description = hcd_name,
David Brownell0365ee02006-06-19 14:27:20 -0700210 .product_desc = "AT91 OHCI",
Andrew Victor39a269c2006-01-22 10:32:13 -0800211 .hcd_priv_size = sizeof(struct ohci_hcd),
212
213 /*
214 * generic hardware linkage
215 */
216 .irq = ohci_irq,
217 .flags = HCD_USB11 | HCD_MEMORY,
218
219 /*
220 * basic lifecycle operations
221 */
222 .start = ohci_at91_start,
223 .stop = ohci_stop,
David Brownelldd9048a2006-12-05 03:18:31 -0800224 .shutdown = ohci_shutdown,
Andrew Victor39a269c2006-01-22 10:32:13 -0800225
226 /*
227 * managing i/o requests and associated device resources
228 */
229 .urb_enqueue = ohci_urb_enqueue,
230 .urb_dequeue = ohci_urb_dequeue,
231 .endpoint_disable = ohci_endpoint_disable,
232
233 /*
234 * scheduling support
235 */
236 .get_frame_number = ohci_get_frame,
237
238 /*
239 * root hub support
240 */
241 .hub_status_data = ohci_hub_status_data,
242 .hub_control = ohci_hub_control,
David Brownelld4139842006-08-04 11:31:55 -0700243 .hub_irq_enable = ohci_rhsc_enable,
Andrew Victor39a269c2006-01-22 10:32:13 -0800244#ifdef CONFIG_PM
David Brownell68ba61b2006-04-02 20:26:21 -0800245 .bus_suspend = ohci_bus_suspend,
246 .bus_resume = ohci_bus_resume,
Andrew Victor39a269c2006-01-22 10:32:13 -0800247#endif
248 .start_port_reset = ohci_start_port_reset,
249};
250
251/*-------------------------------------------------------------------------*/
252
David Brownell0365ee02006-06-19 14:27:20 -0700253static int ohci_hcd_at91_drv_probe(struct platform_device *pdev)
Andrew Victor39a269c2006-01-22 10:32:13 -0800254{
David Brownell0365ee02006-06-19 14:27:20 -0700255 device_init_wakeup(&pdev->dev, 1);
256 return usb_hcd_at91_probe(&ohci_at91_hc_driver, pdev);
Andrew Victor39a269c2006-01-22 10:32:13 -0800257}
258
David Brownell0365ee02006-06-19 14:27:20 -0700259static int ohci_hcd_at91_drv_remove(struct platform_device *pdev)
Andrew Victor39a269c2006-01-22 10:32:13 -0800260{
David Brownell0365ee02006-06-19 14:27:20 -0700261 device_init_wakeup(&pdev->dev, 0);
262 return usb_hcd_at91_remove(platform_get_drvdata(pdev), pdev);
Andrew Victor39a269c2006-01-22 10:32:13 -0800263}
264
265#ifdef CONFIG_PM
Andrew Victor39a269c2006-01-22 10:32:13 -0800266
David Brownell68ba61b2006-04-02 20:26:21 -0800267static int
David Brownell0365ee02006-06-19 14:27:20 -0700268ohci_hcd_at91_drv_suspend(struct platform_device *pdev, pm_message_t mesg)
David Brownell68ba61b2006-04-02 20:26:21 -0800269{
David Brownell0365ee02006-06-19 14:27:20 -0700270 struct usb_hcd *hcd = platform_get_drvdata(pdev);
271 struct ohci_hcd *ohci = hcd_to_ohci(hcd);
272
273 if (device_may_wakeup(&pdev->dev))
274 enable_irq_wake(hcd->irq);
275 else
276 disable_irq_wake(hcd->irq);
277
278 /*
279 * The integrated transceivers seem unable to notice disconnect,
280 * reconnect, or wakeup without the 48 MHz clock active. so for
281 * correctness, always discard connection state (using reset).
282 *
283 * REVISIT: some boards will be able to turn VBUS off...
284 */
285 if (at91_suspend_entering_slow_clock()) {
286 ohci_usb_reset (ohci);
287 clk_disable(fclk);
288 clk_disable(iclk);
289 clocked = 0;
290 }
Andrew Victor39a269c2006-01-22 10:32:13 -0800291
292 return 0;
293}
294
David Brownell0365ee02006-06-19 14:27:20 -0700295static int ohci_hcd_at91_drv_resume(struct platform_device *pdev)
Andrew Victor39a269c2006-01-22 10:32:13 -0800296{
David Brownell0365ee02006-06-19 14:27:20 -0700297 if (!clocked) {
298 clk_enable(iclk);
299 clk_enable(fclk);
David Brownellcd22afd2006-09-03 12:21:50 -0700300 clocked = 1;
David Brownell0365ee02006-06-19 14:27:20 -0700301 }
Andrew Victor39a269c2006-01-22 10:32:13 -0800302
303 return 0;
304}
305#else
306#define ohci_hcd_at91_drv_suspend NULL
307#define ohci_hcd_at91_drv_resume NULL
308#endif
309
David Brownell0365ee02006-06-19 14:27:20 -0700310MODULE_ALIAS("at91_ohci");
David Brownell68ba61b2006-04-02 20:26:21 -0800311
Andrew Victor39a269c2006-01-22 10:32:13 -0800312static struct platform_driver ohci_hcd_at91_driver = {
313 .probe = ohci_hcd_at91_drv_probe,
314 .remove = ohci_hcd_at91_drv_remove,
Aleksey Gorelov64a21d02006-08-08 17:24:08 -0700315 .shutdown = usb_hcd_platform_shutdown,
Andrew Victor39a269c2006-01-22 10:32:13 -0800316 .suspend = ohci_hcd_at91_drv_suspend,
317 .resume = ohci_hcd_at91_drv_resume,
318 .driver = {
David Brownell0365ee02006-06-19 14:27:20 -0700319 .name = "at91_ohci",
Andrew Victor39a269c2006-01-22 10:32:13 -0800320 .owner = THIS_MODULE,
321 },
322};
323
324static int __init ohci_hcd_at91_init (void)
325{
326 if (usb_disabled())
327 return -ENODEV;
328
329 return platform_driver_register(&ohci_hcd_at91_driver);
330}
331
332static void __exit ohci_hcd_at91_cleanup (void)
333{
334 platform_driver_unregister(&ohci_hcd_at91_driver);
335}
336
337module_init (ohci_hcd_at91_init);
338module_exit (ohci_hcd_at91_cleanup);