blob: 2ac266d692a2960acb400773738014eb728933b8 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * OHCI HCD (Host Controller Driver) for USB.
3 *
4 * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
5 * (C) Copyright 2000-2002 David Brownell <dbrownell@users.sourceforge.net>
6 * (C) Copyright 2002 Hewlett-Packard Company
David Brownelldd9048a2006-12-05 03:18:31 -08007 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 * SA1111 Bus Glue
9 *
10 * Written by Christopher Hoover <ch@hpl.hp.com>
Uwe Kleine-Königac310bb2008-07-10 17:30:46 -070011 * Based on fragments of previous driver by Russell King et al.
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 *
13 * This file is licenced under the GPL.
14 */
David Brownelldd9048a2006-12-05 03:18:31 -080015
Russell Kinga09e64f2008-08-05 16:14:15 +010016#include <mach/hardware.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <asm/mach-types.h>
Russell Kinga09e64f2008-08-05 16:14:15 +010018#include <mach/assabet.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <asm/hardware/sa1111.h>
20
21#ifndef CONFIG_SA1111
22#error "This file is SA-1111 bus glue. CONFIG_SA1111 must be defined."
23#endif
24
Russell King22135362012-01-16 11:37:03 +000025#define USB_STATUS 0x0118
26#define USB_RESET 0x011c
27#define USB_IRQTEST 0x0120
28
29#define USB_RESET_FORCEIFRESET (1 << 0)
30#define USB_RESET_FORCEHCRESET (1 << 1)
31#define USB_RESET_CLKGENRESET (1 << 2)
32#define USB_RESET_SIMSCALEDOWN (1 << 3)
33#define USB_RESET_USBINTTEST (1 << 4)
34#define USB_RESET_SLEEPSTBYEN (1 << 5)
35#define USB_RESET_PWRSENSELOW (1 << 6)
36#define USB_RESET_PWRCTRLLOW (1 << 7)
37
38#define USB_STATUS_IRQHCIRMTWKUP (1 << 7)
39#define USB_STATUS_IRQHCIBUFFACC (1 << 8)
40#define USB_STATUS_NIRQHCIM (1 << 9)
41#define USB_STATUS_NHCIMFCLR (1 << 10)
42#define USB_STATUS_USBPWRSENSE (1 << 11)
43
Russell King132db992012-01-26 10:52:34 +000044#if 0
45static void dump_hci_status(struct usb_hcd *hcd, const char *label)
46{
47 unsigned long status = sa1111_readl(hcd->regs + USB_STATUS);
48
Greg Kroah-Hartman3879e302012-05-01 21:33:39 -070049 printk(KERN_DEBUG "%s USB_STATUS = { %s%s%s%s%s}\n", label,
Russell King132db992012-01-26 10:52:34 +000050 ((status & USB_STATUS_IRQHCIRMTWKUP) ? "IRQHCIRMTWKUP " : ""),
51 ((status & USB_STATUS_IRQHCIBUFFACC) ? "IRQHCIBUFFACC " : ""),
52 ((status & USB_STATUS_NIRQHCIM) ? "" : "IRQHCIM "),
53 ((status & USB_STATUS_NHCIMFCLR) ? "" : "HCIMFCLR "),
54 ((status & USB_STATUS_USBPWRSENSE) ? "USBPWRSENSE " : ""));
55}
56#endif
57
Russell King81e6ca32012-01-26 11:45:27 +000058static int ohci_sa1111_reset(struct usb_hcd *hcd)
59{
60 struct ohci_hcd *ohci = hcd_to_ohci(hcd);
61
62 ohci_hcd_init(ohci);
63 return ohci_init(ohci);
64}
65
Bill Pemberton41ac7b32012-11-19 13:21:48 -050066static int ohci_sa1111_start(struct usb_hcd *hcd)
Russell King132db992012-01-26 10:52:34 +000067{
68 struct ohci_hcd *ohci = hcd_to_ohci(hcd);
69 int ret;
70
Russell King132db992012-01-26 10:52:34 +000071 ret = ohci_run(ohci);
72 if (ret < 0) {
Russell King81e6ca32012-01-26 11:45:27 +000073 ohci_err(ohci, "can't start\n");
Russell King132db992012-01-26 10:52:34 +000074 ohci_stop(hcd);
Russell King132db992012-01-26 10:52:34 +000075 }
Russell King81e6ca32012-01-26 11:45:27 +000076 return ret;
Russell King132db992012-01-26 10:52:34 +000077}
78
79static const struct hc_driver ohci_sa1111_hc_driver = {
80 .description = hcd_name,
81 .product_desc = "SA-1111 OHCI",
82 .hcd_priv_size = sizeof(struct ohci_hcd),
83
84 /*
85 * generic hardware linkage
86 */
87 .irq = ohci_irq,
88 .flags = HCD_USB11 | HCD_MEMORY,
89
90 /*
91 * basic lifecycle operations
92 */
Russell King81e6ca32012-01-26 11:45:27 +000093 .reset = ohci_sa1111_reset,
Russell King132db992012-01-26 10:52:34 +000094 .start = ohci_sa1111_start,
95 .stop = ohci_stop,
Russell King846a7042012-01-26 11:10:20 +000096 .shutdown = ohci_shutdown,
Russell King132db992012-01-26 10:52:34 +000097
98 /*
99 * managing i/o requests and associated device resources
100 */
101 .urb_enqueue = ohci_urb_enqueue,
102 .urb_dequeue = ohci_urb_dequeue,
103 .endpoint_disable = ohci_endpoint_disable,
104
105 /*
106 * scheduling support
107 */
108 .get_frame_number = ohci_get_frame,
109
110 /*
111 * root hub support
112 */
113 .hub_status_data = ohci_hub_status_data,
114 .hub_control = ohci_hub_control,
115#ifdef CONFIG_PM
116 .bus_suspend = ohci_bus_suspend,
117 .bus_resume = ohci_bus_resume,
118#endif
119 .start_port_reset = ohci_start_port_reset,
120};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121
Russell Kingae99ddb2012-01-26 13:25:47 +0000122static int sa1111_start_hc(struct sa1111_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123{
124 unsigned int usb_rst = 0;
Russell Kingae99ddb2012-01-26 13:25:47 +0000125 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
Russell King3f878db2012-01-26 10:39:57 +0000127 dev_dbg(&dev->dev, "starting SA-1111 OHCI USB Controller\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 if (machine_is_xp860() ||
130 machine_has_neponset() ||
131 machine_is_pfs168() ||
132 machine_is_badge4())
133 usb_rst = USB_RESET_PWRSENSELOW | USB_RESET_PWRCTRLLOW;
134
135 /*
136 * Configure the power sense and control lines. Place the USB
137 * host controller in reset.
138 */
139 sa1111_writel(usb_rst | USB_RESET_FORCEIFRESET | USB_RESET_FORCEHCRESET,
Russell King22135362012-01-16 11:37:03 +0000140 dev->mapbase + USB_RESET);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
142 /*
143 * Now, carefully enable the USB clock, and take
144 * the USB host controller out of reset.
145 */
Russell Kingae99ddb2012-01-26 13:25:47 +0000146 ret = sa1111_enable_device(dev);
147 if (ret == 0) {
148 udelay(11);
Russell King22135362012-01-16 11:37:03 +0000149 sa1111_writel(usb_rst, dev->mapbase + USB_RESET);
Russell Kingae99ddb2012-01-26 13:25:47 +0000150 }
151
152 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153}
154
155static void sa1111_stop_hc(struct sa1111_dev *dev)
156{
157 unsigned int usb_rst;
Russell King9cb0f812012-01-26 10:37:46 +0000158
Russell King3f878db2012-01-26 10:39:57 +0000159 dev_dbg(&dev->dev, "stopping SA-1111 OHCI USB Controller\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
161 /*
162 * Put the USB host controller into reset.
163 */
Russell King22135362012-01-16 11:37:03 +0000164 usb_rst = sa1111_readl(dev->mapbase + USB_RESET);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 sa1111_writel(usb_rst | USB_RESET_FORCEIFRESET | USB_RESET_FORCEHCRESET,
Russell King22135362012-01-16 11:37:03 +0000166 dev->mapbase + USB_RESET);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
168 /*
169 * Stop the USB clock.
170 */
171 sa1111_disable_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172}
173
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174/**
Russell King132db992012-01-26 10:52:34 +0000175 * ohci_hcd_sa1111_probe - initialize SA-1111-based HCDs
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 *
177 * Allocates basic resources for this USB host controller, and
Russell King132db992012-01-26 10:52:34 +0000178 * then invokes the start() method for the HCD associated with it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 */
Russell King132db992012-01-26 10:52:34 +0000180static int ohci_hcd_sa1111_probe(struct sa1111_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181{
182 struct usb_hcd *hcd;
Russell King132db992012-01-26 10:52:34 +0000183 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
Russell King132db992012-01-26 10:52:34 +0000185 if (usb_disabled())
186 return -ENODEV;
187
Russell King4ffb4312013-06-27 11:10:40 +0100188 /*
189 * We don't call dma_set_mask_and_coherent() here because the
190 * DMA mask has already been appropraitely setup by the core
191 * SA-1111 bus code (which includes bug workarounds.)
192 */
193
Russell King132db992012-01-26 10:52:34 +0000194 hcd = usb_create_hcd(&ohci_sa1111_hc_driver, &dev->dev, "sa1111");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 if (!hcd)
196 return -ENOMEM;
Russell King9cb0f812012-01-26 10:37:46 +0000197
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 hcd->rsrc_start = dev->res.start;
Joe Perches28f65c112011-06-09 09:13:32 -0700199 hcd->rsrc_len = resource_size(&dev->res);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
201 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
Greg Kroah-Hartman3879e302012-05-01 21:33:39 -0700202 dev_dbg(&dev->dev, "request_mem_region failed\n");
Russell King132db992012-01-26 10:52:34 +0000203 ret = -EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 goto err1;
205 }
Russell King9cb0f812012-01-26 10:37:46 +0000206
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 hcd->regs = dev->mapbase;
208
Russell Kingae99ddb2012-01-26 13:25:47 +0000209 ret = sa1111_start_hc(dev);
210 if (ret)
211 goto err2;
212
Russell King132db992012-01-26 10:52:34 +0000213 ret = usb_add_hcd(hcd, dev->irq[1], 0);
Peter Chen3c9740a2013-11-05 10:46:02 +0800214 if (ret == 0) {
215 device_wakeup_enable(hcd->self.controller);
Russell King132db992012-01-26 10:52:34 +0000216 return ret;
Peter Chen3c9740a2013-11-05 10:46:02 +0800217 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
219 sa1111_stop_hc(dev);
Russell Kingae99ddb2012-01-26 13:25:47 +0000220 err2:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
222 err1:
223 usb_put_hcd(hcd);
Russell King132db992012-01-26 10:52:34 +0000224 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225}
226
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227/**
Russell King132db992012-01-26 10:52:34 +0000228 * ohci_hcd_sa1111_remove - shutdown processing for SA-1111-based HCDs
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 * @dev: USB Host Controller being removed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 *
Russell King132db992012-01-26 10:52:34 +0000231 * Reverses the effect of ohci_hcd_sa1111_probe(), first invoking
232 * the HCD's stop() method.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 */
Russell King132db992012-01-26 10:52:34 +0000234static int ohci_hcd_sa1111_remove(struct sa1111_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235{
Russell King132db992012-01-26 10:52:34 +0000236 struct usb_hcd *hcd = sa1111_get_drvdata(dev);
237
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 usb_remove_hcd(hcd);
239 sa1111_stop_hc(dev);
240 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
241 usb_put_hcd(hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 return 0;
244}
245
Russell King846a7042012-01-26 11:10:20 +0000246static void ohci_hcd_sa1111_shutdown(struct sa1111_dev *dev)
247{
248 struct usb_hcd *hcd = sa1111_get_drvdata(dev);
249
250 if (test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)) {
251 hcd->driver->shutdown(hcd);
252 sa1111_stop_hc(dev);
253 }
254}
255
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256static struct sa1111_driver ohci_hcd_sa1111_driver = {
257 .drv = {
258 .name = "sa1111-ohci",
Russell King1ebcd762012-01-26 11:19:48 +0000259 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 },
261 .devid = SA1111_DEVID_USB,
Russell King132db992012-01-26 10:52:34 +0000262 .probe = ohci_hcd_sa1111_probe,
263 .remove = ohci_hcd_sa1111_remove,
Russell King846a7042012-01-26 11:10:20 +0000264 .shutdown = ohci_hcd_sa1111_shutdown,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265};